blob: 88e440ad092d76396298a5fcec3d5cd5d681c96a [file] [log] [blame]
Bram Moolenaar661b1822005-07-28 22:36:45 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Jul 28
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}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000603 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604 the keyboard map between Farsi and English, when 'allowrevins' set.
605
Bram Moolenaar582fd852005-03-28 20:58:01 +0000606 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 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:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000623 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 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,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000631 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000633 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 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}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000660 When on, Vim will change the current working directory whenever you
661 open a file, switch buffers, delete a buffer or open/close a window.
662 It will change to the directory containing the file which was opened
663 or selected.
664 This option is provided for backward compatibility with the Vim
665 released with Sun ONE Studio 4 Enterprise Edition.
666 Note: When this option is on some plugins may not work. The directory
667 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
669 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
670'arabic' 'arab' boolean (default off)
671 local to window
672 {not in Vi}
673 {only available when compiled with the |+arabic|
674 feature}
675 This option can be set to start editing Arabic text.
676 Setting this option will:
677 - Set the 'rightleft' option, unless 'termbidi' is set.
678 - Set the 'arabicshape' option, unless 'termbidi' is set.
679 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
680 between typing English and Arabic key mapping.
681 - Set the 'delcombine' option
682 Note that 'encoding' must be "utf-8" for working with Arabic text.
683
684 Resetting this option will:
685 - Reset the 'rightleft' option.
686 - Disable the use of 'keymap' (without changing its value).
687 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
688 option.
689 Also see |arabic.txt|.
690
691 *'arabicshape'* *'arshape'*
692 *'noarabicshape'* *'noarshape'*
693'arabicshape' 'arshape' boolean (default on)
694 global
695 {not in Vi}
696 {only available when compiled with the |+arabic|
697 feature}
698 When on and 'termbidi' is off, the required visual character
699 corrections that need to take place for displaying the Arabic language
700 take affect. Shaping, in essence, gets enabled; the term is a broad
701 one which encompasses:
702 a) the changing/morphing of characters based on their location
703 within a word (initial, medial, final and stand-alone).
704 b) the enabling of the ability to compose characters
705 c) the enabling of the required combining of some characters
706 When disabled the character display reverts back to each character's
707 true stand-alone form.
708 Arabic is a complex language which requires other settings, for
709 further details see |arabic.txt|.
710
711 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
712'autoindent' 'ai' boolean (default off)
713 local to buffer
714 Copy indent from current line when starting a new line (typing <CR>
715 in Insert mode or when using the "o" or "O" command). If you do not
716 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000717 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
718 another line has the same effect, unless the 'I' flag is included in
719 'cpoptions'.
720 When autoindent is on, formatting (with the "gq" command or when you
721 reach 'textwidth' in Insert mode) uses the indentation of the first
722 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 When 'smartindent' or 'cindent' is on the indent is changed in
724 a different way.
725 The 'autoindent' option is reset when the 'paste' option is set.
726 {small difference from Vi: After the indent is deleted when typing
727 <Esc> or <CR>, the cursor position when moving up or down is after the
728 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
729
730 *'autoread'* *'ar'* *'noautoread'* *'noar'*
731'autoread' 'ar' boolean (default off)
732 global or local to buffer |global-local|
733 {not in Vi}
734 When a file has been detected to have been changed outside of Vim and
735 it has not been changed inside of Vim, automatically read it again.
736 When the file has been deleted this is not done. |timestamp|
737 If this option has a local value, use this command to switch back to
738 using the global value: >
739 :set autoread<
740<
741 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
742'autowrite' 'aw' boolean (default off)
743 global
744 Write the contents of the file, if it has been modified, on each
745 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
746 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
747 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
748 Note that for some commands the 'autowrite' option is not used, see
749 'autowriteall' for that.
750
751 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
752'autowriteall' 'awa' boolean (default off)
753 global
754 {not in Vi}
755 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
756 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
757 Setting this option also implies that Vim behaves like 'autowrite' has
758 been set.
759
760 *'background'* *'bg'*
761'background' 'bg' string (default "dark" or "light")
762 global
763 {not in Vi}
764 When set to "dark", Vim will try to use colors that look good on a
765 dark background. When set to "light", Vim will try to use colors that
766 look good on a light background. Any other value is illegal.
767 Vim tries to set the default value according to the terminal used.
768 This will not always be correct.
769 Setting this option does not change the background color, it tells Vim
770 what the background color looks like. For changing the background
771 color, see |:hi-normal|.
772
773 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000774 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 change.
776 When a color scheme is loaded (the "colors_name" variable is set)
777 setting 'background' will cause the color scheme to be reloaded. If
778 the color scheme adjusts to the value of 'background' this will work.
779 However, if the color scheme sets 'background' itself the effect may
780 be undone. First delete the "colors_name" variable when needed.
781
782 When setting 'background' to the default value with: >
783 :set background&
784< Vim will guess the value. In the GUI this should work correctly,
785 in other cases Vim might not be able to guess the right value.
786
787 When starting the GUI, the default value for 'background' will be
788 "light". When the value is not set in the .gvimrc, and Vim detects
789 that the background is actually quite dark, 'background' is set to
790 "dark". But this happens only AFTER the .gvimrc file has been read
791 (because the window needs to be opened to find the actual background
792 color). To get around this, force the GUI window to be opened by
793 putting a ":gui" command in the .gvimrc file, before where the value
794 of 'background' is used (e.g., before ":syntax on").
795 Normally this option would be set in the .vimrc file. Possibly
796 depending on the terminal name. Example: >
797 :if &term == "pcterm"
798 : set background=dark
799 :endif
800< When this option is set, the default settings for the highlight groups
801 will change. To use other settings, place ":highlight" commands AFTER
802 the setting of the 'background' option.
803 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
804 to select the colors for syntax highlighting. After changing this
805 option, you must load syntax.vim again to see the result. This can be
806 done with ":syntax on".
807
808 *'backspace'* *'bs'*
809'backspace' 'bs' string (default "")
810 global
811 {not in Vi}
812 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
813 mode. This is a list of items, separated by commas. Each item allows
814 a way to backspace over something:
815 value effect ~
816 indent allow backspacing over autoindent
817 eol allow backspacing over line breaks (join lines)
818 start allow backspacing over the start of insert; CTRL-W and CTRL-U
819 stop once at the start of insert.
820
821 When the value is empty, Vi compatible backspacing is used.
822
823 For backwards compatibility with version 5.4 and earlier:
824 value effect ~
825 0 same as ":set backspace=" (Vi compatible)
826 1 same as ":set backspace=indent,eol"
827 2 same as ":set backspace=indent,eol,start"
828
829 See |:fixdel| if your <BS> or <Del> key does not do what you want.
830 NOTE: This option is set to "" when 'compatible' is set.
831
832 *'backup'* *'bk'* *'nobackup'* *'nobk'*
833'backup' 'bk' boolean (default off)
834 global
835 {not in Vi}
836 Make a backup before overwriting a file. Leave it around after the
837 file has been successfully written. If you do not want to keep the
838 backup file, but you do want a backup while the file is being
839 written, reset this option and set the 'writebackup' option (this is
840 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000841 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 |backup-table| for more explanations.
843 When the 'backupskip' pattern matches, a backup is not made anyway.
844 When 'patchmode' is set, the backup may be renamed to become the
845 oldest version of a file.
846 NOTE: This option is reset when 'compatible' is set.
847
848 *'backupcopy'* *'bkc'*
849'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
850 global
851 {not in Vi}
852 When writing a file and a backup is made, this option tells how it's
853 done. This is a comma separated list of words.
854
855 The main values are:
856 "yes" make a copy of the file and overwrite the original one
857 "no" rename the file and write a new one
858 "auto" one of the previous, what works best
859
860 Extra values that can be combined with the ones above are:
861 "breaksymlink" always break symlinks when writing
862 "breakhardlink" always break hardlinks when writing
863
864 Making a copy and overwriting the original file:
865 - Takes extra time to copy the file.
866 + When the file has special attributes, is a (hard/symbolic) link or
867 has a resource fork, all this is preserved.
868 - When the file is a link the backup will have the name of the link,
869 not of the real file.
870
871 Renaming the file and writing a new one:
872 + It's fast.
873 - Sometimes not all attributes of the file can be copied to the new
874 file.
875 - When the file is a link the new file will not be a link.
876
877 The "auto" value is the middle way: When Vim sees that renaming file
878 is possible without side effects (the attributes can be passed on and
879 and the file is not a link) that is used. When problems are expected,
880 a copy will be made.
881
882 The "breaksymlink" and "breakhardlink" values can be used in
883 combination with any of "yes", "no" and "auto". When included, they
884 force Vim to always break either symbolic or hard links by doing
885 exactly what the "no" option does, renaming the original file to
886 become the backup and writing a new file in its place. This can be
887 useful for example in source trees where all the files are symbolic or
888 hard links and any changes should stay in the local source tree, not
889 be propagated back to the original source.
890 *crontab*
891 One situation where "no" and "auto" will cause problems: A program
892 that opens a file, invokes Vim to edit that file, and then tests if
893 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 example.
896
897 When a copy is made, the original file is truncated and then filled
898 with the new text. This means that protection bits, owner and
899 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000900 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 group of the backup is set to the group of the original file. If this
902 fails, the protection bits for the group are made the same as for
903 others.
904
905 When the file is renamed this is the other way around: The backup has
906 the same attributes of the original file, and the newly written file
907 is owned by the current user. When the file was a (hard/symbolic)
908 link, the new file will not! That's why the "auto" value doesn't
909 rename when the file is a link. The owner and group of the newly
910 written file will be set to the same ones as the original file, but
911 the system may refuse to do this. In that case the "auto" value will
912 again not rename the file.
913
914 *'backupdir'* *'bdir'*
915'backupdir' 'bdir' string (default for Amiga: ".,t:",
916 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
917 for Unix: ".,~/tmp,~/")
918 global
919 {not in Vi}
920 List of directories for the backup file, separated with commas.
921 - The backup file will be created in the first directory in the list
922 where this is possible.
923 - Empty means that no backup file will be created ('patchmode' is
924 impossible!). Writing may fail because of this.
925 - A directory "." means to put the backup file in the same directory
926 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000927 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 put the backup file relative to where the edited file is. The
929 leading "." is replaced with the path name of the edited file.
930 ("." inside a directory name has no special meaning).
931 - Spaces after the comma are ignored, other spaces are considered part
932 of the directory name. To have a space at the start of a directory
933 name, precede it with a backslash.
934 - To include a comma in a directory name precede it with a backslash.
935 - A directory name may end in an '/'.
936 - Environment variables are expanded |:set_env|.
937 - Careful with '\' characters, type one before a space, type two to
938 get one in the option (see |option-backslash|), for example: >
939 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
940< - For backwards compatibility with Vim version 3.0 a '>' at the start
941 of the option is removed.
942 See also 'backup' and 'writebackup' options.
943 If you want to hide your backup files on Unix, consider this value: >
944 :set backupdir=./.backup,~/.backup,.,/tmp
945< You must create a ".backup" directory in each directory and in your
946 home directory for this to work properly.
947 The use of |:set+=| and |:set-=| is preferred when adding or removing
948 directories from the list. This avoids problems when a future version
949 uses another default.
950 This option cannot be set from a |modeline| or in the |sandbox|, for
951 security reasons.
952
953 *'backupext'* *'bex'* *E589*
954'backupext' 'bex' string (default "~", for VMS: "_")
955 global
956 {not in Vi}
957 String which is appended to a file name to make the name of the
958 backup file. The default is quite unusual, because this avoids
959 accidentally overwriting existing files with a backup file. You might
960 prefer using ".bak", but make sure that you don't have files with
961 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000962 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000964 If you like to keep a lot of backups, you could use a BufWritePre
965 autocommand to change 'backupext' just before writing the file to
966 include a timestamp. >
967 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
968< Use 'backupdir' to put the backup in a different directory.
969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 *'backupskip'* *'bsk'*
971'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
972 global
973 {not in Vi}
974 {not available when compiled without the |+wildignore|
975 feature}
976 A list of file patterns. When one of the patterns matches with the
977 name of the file which is written, no backup file is created. Both
978 the specified file name and the full path name of the file are used.
979 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
980 Watch out for special characters, see |option-backslash|.
981 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000982 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983
984 *'balloondelay'* *'bdlay'*
985'balloondelay' 'bdlay' number (default: 600)
986 global
987 {not in Vi}
988 {only available when compiled with the |+balloon_eval|
989 feature}
990 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
991
992 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
993'ballooneval' 'beval' boolean (default off)
994 global
995 {not in Vi}
996 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +0000997 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 Switch on the |balloon-eval| functionality.
999
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001000 *'balloonexpr'* *'bexpr'*
1001'balloonexpr' 'bexpr' string (default "")
1002 global
1003 {not in Vi}
1004 {only available when compiled with the |+balloon_eval|
1005 feature}
1006 Expression to show in evaluation balloon. It is only used when
1007 'ballooneval' is on. These variables can be used:
1008
1009 v:beval_bufnr number of the buffer in which balloon is going to show
1010 v:beval_winnr number of the window
1011 v:beval_lnum line number
1012 v:beval_col column number (byte index)
1013 v:beval_text word under or after the mouse pointer
1014
1015 The evaluation of the expression must not have side effects!
1016 Example: >
1017 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001018 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001019 \', column ' . v:beval_col .
1020 \ ' of file ' . bufname(v:beval_bufnr) .
1021 \ ' on word "' . v:beval_text . '"'
1022 endfunction
1023 set bexpr=MyBalloonExpr()
1024 set ballooneval
1025<
1026 NOTE: The balloon is displayed only if the cursor is on a text
1027 character. If the result of evaluating 'balloonexpr' is not empty,
1028 Vim does not try to send a message to an external debugger (Netbeans
1029 or Sun Workshop).
1030
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001031 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001032 if has("balloon_multiline")
1033<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1035'binary' 'bin' boolean (default off)
1036 local to buffer
1037 {not in Vi}
1038 This option should be set before editing a binary file. You can also
1039 use the |-b| Vim argument. When this option is switched on a few
1040 options will be changed (also when it already was on):
1041 'textwidth' will be set to 0
1042 'wrapmargin' will be set to 0
1043 'modeline' will be off
1044 'expandtab' will be off
1045 Also, 'fileformat' and 'fileformats' options will not be used, the
1046 file is read and written like 'fileformat' was "unix" (a single <NL>
1047 separates lines).
1048 The 'fileencoding' and 'fileencodings' options will not be used, the
1049 file is read without conversion.
1050 NOTE: When you start editing a(nother) file while the 'bin' option is
1051 on, settings from autocommands may change the settings again (e.g.,
1052 'textwidth'), causing trouble when editing. You might want to set
1053 'bin' again when the file has been loaded.
1054 The previous values of these options are remembered and restored when
1055 'bin' is switched from on to off. Each buffer has its own set of
1056 saved option values.
1057 To edit a file with 'binary' set you can use the |++bin| argument.
1058 This avoids you have to do ":set bin", which would have effect for all
1059 files you edit.
1060 When writing a file the <EOL> for the last line is only written if
1061 there was one in the original file (normally Vim appends an <EOL> to
1062 the last line if there is none; this would make the file longer). See
1063 the 'endofline' option.
1064
1065 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1066'bioskey' 'biosk' boolean (default on)
1067 global
1068 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001069 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 better to detect CTRL-C, but only works for the console. When using a
1071 terminal over a serial port reset this option.
1072 Also see |'conskey'|.
1073
1074 *'bomb'* *'nobomb'*
1075'bomb' boolean (default off)
1076 local to buffer
1077 {not in Vi}
1078 {only available when compiled with the |+multi_byte|
1079 feature}
1080 When writing a file and the following conditions are met, a BOM (Byte
1081 Order Mark) is prepended to the file:
1082 - this option is on
1083 - the 'binary' option is off
1084 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1085 endian variants.
1086 Some applications use the BOM to recognize the encoding of the file.
1087 Often used for UCS-2 files on MS-Windows. For other applications it
1088 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1089 appear halfway the resulting file.
1090 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1091 check for the presence of the BOM is done and 'bomb' set accordingly.
1092 Unless 'binary' is set, it is removed from the first line, so that you
1093 don't see it when editing. When you don't change the options, the BOM
1094 will be restored when writing the file.
1095
1096 *'breakat'* *'brk'*
1097'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1098 global
1099 {not in Vi}
1100 {not available when compiled without the |+linebreak|
1101 feature}
1102 This option lets you choose which characters might cause a line
1103 break if 'linebreak' is on.
1104
1105 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001106'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 global
1108 {not in Vi} {only for Motif and Win32 GUI}
1109 Which directory to use for the file browser:
1110 last Use same directory as with last file browser.
1111 buffer Use the directory of the related buffer.
1112 current Use the current directory.
1113 {path} Use the specified directory
1114
1115 *'bufhidden'* *'bh'*
1116'bufhidden' 'bh' string (default: "")
1117 local to buffer
1118 {not in Vi}
1119 {not available when compiled without the |+quickfix|
1120 feature}
1121 This option specifies what happens when a buffer is no longer
1122 displayed in a window:
1123 <empty> follow the global 'hidden' option
1124 hide hide the buffer (don't unload it), also when 'hidden'
1125 is not set
1126 unload unload the buffer, also when 'hidden' is set or using
1127 |:hide|
1128 delete delete the buffer from the buffer list, also when
1129 'hidden' is set or using |:hide|, like using
1130 |:bdelete|
1131 wipe wipe out the buffer from the buffer list, also when
1132 'hidden' is set or using |:hide|, like using
1133 |:bwipeout|
1134
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001135 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1136 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 This option is used together with 'buftype' and 'swapfile' to specify
1138 special kinds of buffers. See |special-buffers|.
1139
1140 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1141'buflisted' 'bl' boolean (default: on)
1142 local to buffer
1143 {not in Vi}
1144 When this option is set, the buffer shows up in the buffer list. If
1145 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1146 This option is reset by Vim for buffers that are only used to remember
1147 a file name or marks. Vim sets it when starting to edit a buffer.
1148 But not when moving to a buffer with ":buffer".
1149
1150 *'buftype'* *'bt'* *E382*
1151'buftype' 'bt' string (default: "")
1152 local to buffer
1153 {not in Vi}
1154 {not available when compiled without the |+quickfix|
1155 feature}
1156 The value of this option specifies the type of a buffer:
1157 <empty> normal buffer
1158 nofile buffer which is not related to a file and will not be
1159 written
1160 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001161 acwrite buffer which will always be written with BufWriteCmd
1162 autocommands. {not available when compiled without the
1163 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 quickfix quickfix buffer, contains list of errors |:cwindow|
1165 help help buffer (you are not supposed to set this
1166 manually)
1167
1168 This option is used together with 'bufhidden' and 'swapfile' to
1169 specify special kinds of buffers. See |special-buffers|.
1170
1171 Be careful with changing this option, it can have many side effects!
1172
1173 A "quickfix" buffer is only used for the error list. This value is
1174 set by the |:cwindow| command and you are not supposed to change it.
1175
1176 "nofile" and "nowrite" buffers are similar:
1177 both: The buffer is not to be written to disk, ":w" doesn't
1178 work (":w filename" does work though).
1179 both: The buffer is never considered to be |'modified'|.
1180 There is no warning when the changes will be lost, for
1181 example when you quit Vim.
1182 both: A swap file is only created when using too much memory
1183 (when 'swapfile' has been reset there is never a swap
1184 file).
1185 nofile only: The buffer name is fixed, it is not handled like a
1186 file name. It is not modified in response to a |:cd|
1187 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001188 *E676*
1189 "acwrite" implies that the buffer name is not related to a file, like
1190 "nofile", but it will be written. Thus, in contrast to "nofile" and
1191 "nowrite", ":w" does work and a modified buffer can't be abandoned
1192 without saving. For writing there must be matching |BufWriteCmd|,
1193 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194
1195 *'casemap'* *'cmp'*
1196'casemap' 'cmp' string (default: "internal,keepascii")
1197 global
1198 {not in Vi}
1199 Specifies details about changing the case of letters. It may contain
1200 these words, separated by a comma:
1201 internal Use internal case mapping functions, the current
1202 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001203 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 "internal" is omitted, the towupper() and towlower()
1205 system library functions are used when available.
1206 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1207 case mapping, the current locale is not effective.
1208 This probably only matters for Turkish.
1209
1210 *'cdpath'* *'cd'* *E344* *E346*
1211'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1212 global
1213 {not in Vi}
1214 {not available when compiled without the
1215 |+file_in_path| feature}
1216 This is a list of directories which will be searched when using the
1217 |:cd| and |:lcd| commands, provided that the directory being searched
1218 for has a relative path (not starting with "/", "./" or "../").
1219 The 'cdpath' option's value has the same form and semantics as
1220 |'path'|. Also see |file-searching|.
1221 The default value is taken from $CDPATH, with a "," prepended to look
1222 in the current directory first.
1223 If the default value taken from $CDPATH is not what you want, include
1224 a modified version of the following command in your vimrc file to
1225 override it: >
1226 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1227< This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229 (parts of 'cdpath' can be passed to the shell to expand file names).
1230
1231 *'cedit'*
1232'cedit' string (Vi default: "", Vim default: CTRL-F)
1233 global
1234 {not in Vi}
1235 {not available when compiled without the |+vertsplit|
1236 feature}
1237 The key used in Command-line Mode to open the command-line window.
1238 The default is CTRL-F when 'compatible' is off.
1239 Only non-printable keys are allowed.
1240 The key can be specified as a single character, but it is difficult to
1241 type. The preferred way is to use the <> notation. Examples: >
1242 :set cedit=<C-Y>
1243 :set cedit=<Esc>
1244< |Nvi| also has this option, but it only uses the first character.
1245 See |cmdwin|.
1246
1247 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1248'charconvert' 'ccv' string (default "")
1249 global
1250 {only available when compiled with the |+multi_byte|
1251 feature and the |+eval| feature}
1252 {not in Vi}
1253 An expression that is used for character encoding conversion. It is
1254 evaluated when a file that is to be read or has been written has a
1255 different encoding from what is desired.
1256 'charconvert' is not used when the internal iconv() function is
1257 supported and is able to do the conversion. Using iconv() is
1258 preferred, because it is much faster.
1259 'charconvert' is not used when reading stdin |--|, because there is no
1260 file to convert from. You will have to save the text in a file first.
1261 The expression must return zero or an empty string for success,
1262 non-zero for failure.
1263 The possible encoding names encountered are in 'encoding'.
1264 Additionally, names given in 'fileencodings' and 'fileencoding' are
1265 used.
1266 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1267 is done internally by Vim, 'charconvert' is not used for this.
1268 'charconvert' is also used to convert the viminfo file, if the 'c'
1269 flag is present in 'viminfo'. Also used for Unicode conversion.
1270 Example: >
1271 set charconvert=CharConvert()
1272 fun CharConvert()
1273 system("recode "
1274 \ . v:charconvert_from . ".." . v:charconvert_to
1275 \ . " <" . v:fname_in . " >" v:fname_out)
1276 return v:shell_error
1277 endfun
1278< The related Vim variables are:
1279 v:charconvert_from name of the current encoding
1280 v:charconvert_to name of the desired encoding
1281 v:fname_in name of the input file
1282 v:fname_out name of the output file
1283 Note that v:fname_in and v:fname_out will never be the same.
1284 Note that v:charconvert_from and v:charconvert_to may be different
1285 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1286 Encryption is not done by Vim when using 'charconvert'. If you want
1287 to encrypt the file after conversion, 'charconvert' should take care
1288 of this.
1289 This option cannot be set from a |modeline| or in the |sandbox|, for
1290 security reasons.
1291
1292 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1293'cindent' 'cin' boolean (default off)
1294 local to buffer
1295 {not in Vi}
1296 {not available when compiled without the |+cindent|
1297 feature}
1298 Enables automatic C program indenting See 'cinkeys' to set the keys
1299 that trigger reindenting in insert mode and 'cinoptions' to set your
1300 preferred indent style.
1301 If 'indentexpr' is not empty, it overrules 'cindent'.
1302 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1303 the "=" operator indents using this algorithm rather than calling an
1304 external program.
1305 See |C-indenting|.
1306 When you don't like the way 'cindent' works, try the 'smartindent'
1307 option or 'indentexpr'.
1308 This option is not used when 'paste' is set.
1309 NOTE: This option is reset when 'compatible' is set.
1310
1311 *'cinkeys'* *'cink'*
1312'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1313 local to buffer
1314 {not in Vi}
1315 {not available when compiled without the |+cindent|
1316 feature}
1317 A list of keys that, when typed in Insert mode, cause reindenting of
1318 the current line. Only used if 'cindent' is on and 'indentexpr' is
1319 empty.
1320 For the format of this option see |cinkeys-format|.
1321 See |C-indenting|.
1322
1323 *'cinoptions'* *'cino'*
1324'cinoptions' 'cino' string (default "")
1325 local to buffer
1326 {not in Vi}
1327 {not available when compiled without the |+cindent|
1328 feature}
1329 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1330 program. See |cinoptions-values| for the values of this option, and
1331 |C-indenting| for info on C indenting in general.
1332
1333
1334 *'cinwords'* *'cinw'*
1335'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1336 local to buffer
1337 {not in Vi}
1338 {not available when compiled without both the
1339 |+cindent| and the |+smartindent| features}
1340 These keywords start an extra indent in the next line when
1341 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1342 an appropriate place (inside {}).
1343 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1344 matter, include the keyword both the uppercase and lowercase:
1345 "if,If,IF".
1346
1347 *'clipboard'* *'cb'*
1348'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1349 for X-windows, "" otherwise)
1350 global
1351 {not in Vi}
1352 {only in GUI versions or when the |+xterm_clipboard|
1353 feature is included}
1354 This option is a list of comma separated names.
1355 These names are recognized:
1356
1357 unnamed When included, Vim will use the clipboard register '*'
1358 for all yank, delete, change and put operations which
1359 would normally go to the unnamed register. When a
1360 register is explicitly specified, it will always be
1361 used regardless of whether "unnamed" is in 'clipboard'
1362 or not. The clipboard register can always be
1363 explicitly accessed using the "* notation. Also see
1364 |gui-clipboard|.
1365
1366 autoselect Works like the 'a' flag in 'guioptions': If present,
1367 then whenever Visual mode is started, or the Visual
1368 area extended, Vim tries to become the owner of the
1369 windowing system's global selection or put the
1370 selected text on the clipboard used by the selection
1371 register "*. See |guioptions_a| and |quotestar| for
1372 details. When the GUI is active, the 'a' flag in
1373 'guioptions' is used, when the GUI is not active, this
1374 "autoselect" flag is used.
1375 Also applies to the modeless selection.
1376
1377 autoselectml Like "autoselect", but for the modeless selection
1378 only. Compare to the 'A' flag in 'guioptions'.
1379
1380 exclude:{pattern}
1381 Defines a pattern that is matched against the name of
1382 the terminal 'term'. If there is a match, no
1383 connection will be made to the X server. This is
1384 useful in this situation:
1385 - Running Vim in a console.
1386 - $DISPLAY is set to start applications on another
1387 display.
1388 - You do not want to connect to the X server in the
1389 console, but do want this in a terminal emulator.
1390 To never connect to the X server use: >
1391 exclude:.*
1392< This has the same effect as using the |-X| argument.
1393 Note that when there is no connection to the X server
1394 the window title won't be restored and the clipboard
1395 cannot be accessed.
1396 The value of 'magic' is ignored, {pattern} is
1397 interpreted as if 'magic' was on.
1398 The rest of the option value will be used for
1399 {pattern}, this must be the last entry.
1400
1401 *'cmdheight'* *'ch'*
1402'cmdheight' 'ch' number (default 1)
1403 global
1404 {not in Vi}
1405 Number of screen lines to use for the command-line. Helps avoiding
1406 |hit-enter| prompts.
1407
1408 *'cmdwinheight'* *'cwh'*
1409'cmdwinheight' 'cwh' number (default 7)
1410 global
1411 {not in Vi}
1412 {not available when compiled without the |+vertsplit|
1413 feature}
1414 Number of screen lines to use for the command-line window. |cmdwin|
1415
1416 *'columns'* *'co'* *E594*
1417'columns' 'co' number (default 80 or terminal width)
1418 global
1419 {not in Vi}
1420 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001421 initialization and does not have to be set by hand. Also see
1422 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 When Vim is running in the GUI or in a resizable window, setting this
1424 option will cause the window size to be changed. When you only want
1425 to use the size for the GUI, put the command in your |gvimrc| file.
1426 When you set this option and Vim is unable to change the physical
1427 number of columns of the display, the display may be messed up.
1428
1429 *'comments'* *'com'* *E524* *E525*
1430'comments' 'com' string (default
1431 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1432 local to buffer
1433 {not in Vi}
1434 {not available when compiled without the |+comments|
1435 feature}
1436 A comma separated list of strings that can start a comment line. See
1437 |format-comments|. See |option-backslash| about using backslashes to
1438 insert a space.
1439
1440 *'commentstring'* *'cms'* *E537*
1441'commentstring' 'cms' string (default "/*%s*/")
1442 local to buffer
1443 {not in Vi}
1444 {not available when compiled without the |+folding|
1445 feature}
1446 A template for a comment. The "%s" in the value is replaced with the
1447 comment text. Currently only used to add markers for folding, see
1448 |fold-marker|.
1449
1450 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001451'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1452 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 global
1454 {not in Vi}
1455 This option has the effect of making Vim either more Vi-compatible, or
1456 make Vim behave in a more useful way.
1457 This is a special kind of option, because when it's set or reset,
1458 other options are also changed as a side effect. CAREFUL: Setting or
1459 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001460 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 set this option in your vimrc file, you should probably put it at the
1462 very start.
1463 By default this option is on and the Vi defaults are used for the
1464 options. This default was chosen for those people who want to use Vim
1465 just like Vi, and don't even (want to) know about the 'compatible'
1466 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001467 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1468 this option is switched off, and all options that have not been
1469 modified will be set to the Vim defaults. Effectively, this means
1470 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1471 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1472 happen for the system-wide vimrc or gvimrc file). Also see
1473 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 You can also set this option with the "-C" argument, and reset it with
1475 "-N". See |-C| and |-N|.
1476 Switching this option off makes the Vim defaults be used for options
1477 that have a different Vi and Vim default value. See the options
1478 marked with a '+' below. Other options are not modified.
1479 At the moment this option is set, several other options will be set
1480 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001481 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 editing.
1483 See also 'cpoptions'.
1484
1485 option + set value effect ~
1486
1487 'allowrevins' off no CTRL-_ command
1488 'backupcopy' Unix: "yes" backup file is a copy
1489 others: "auto" copy or rename backup file
1490 'backspace' "" normal backspace
1491 'backup' off no backup file
1492 'cindent' off no C code indentation
1493 'cedit' + "" no key to open the |cmdwin|
1494 'cpoptions' + (all flags) Vi-compatible flags
1495 'cscopetag' off don't use cscope for ":tag"
1496 'cscopetagorder' 0 see |cscopetagorder|
1497 'cscopeverbose' off see |cscopeverbose|
1498 'digraph' off no digraphs
1499 'esckeys' + off no <Esc>-keys in Insert mode
1500 'expandtab' off tabs not expanded to spaces
1501 'fileformats' + "" no automatic file format detection,
1502 "dos,unix" except for DOS, Windows and OS/2
1503 'formatoptions' + "vt" Vi compatible formatting
1504 'gdefault' off no default 'g' flag for ":s"
1505 'history' + 0 no commandline history
1506 'hkmap' off no Hebrew keyboard mapping
1507 'hkmapp' off no phonetic Hebrew keyboard mapping
1508 'hlsearch' off no highlighting of search matches
1509 'incsearch' off no incremental searching
1510 'indentexpr' "" no indenting by expression
1511 'insertmode' off do not start in Insert mode
1512 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1513 characters and '_'
1514 'joinspaces' on insert 2 spaces after period
1515 'modeline' + off no modelines
1516 'more' + off no pauses in listings
1517 'revins' off no reverse insert
1518 'ruler' off no ruler
1519 'scrolljump' 1 no jump scroll
1520 'scrolloff' 0 no scroll offset
1521 'shiftround' off indent not rounded to shiftwidth
1522 'shortmess' + "" no shortening of messages
1523 'showcmd' + off command characters not shown
1524 'showmode' + off current mode not shown
1525 'smartcase' off no automatic ignore case switch
1526 'smartindent' off no smart indentation
1527 'smarttab' off no smart tab size
1528 'softtabstop' 0 tabs are always 'tabstop' positions
1529 'startofline' on goto startofline with some commands
1530 'tagrelative' + off tag file names are not relative
1531 'textauto' + off no automatic textmode detection
1532 'textwidth' 0 no automatic line wrap
1533 'tildeop' off tilde is not an operator
1534 'ttimeout' off no terminal timeout
1535 'whichwrap' + "" left-right movements don't wrap
1536 'wildchar' + CTRL-E only when the current value is <Tab>
1537 use CTRL-E for cmdline completion
1538 'writebackup' on or off depends on +writebackup feature
1539
1540 *'complete'* *'cpt'* *E535*
1541'complete' 'cpt' string (default: ".,w,b,u,t,i")
1542 local to buffer
1543 {not in Vi}
1544 This option specifies how keyword completion |ins-completion| works
1545 when CTRL-P or CTRL-N are used. It is also used for whole-line
1546 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1547 and the places to scan. It is a comma separated list of flags:
1548 . scan the current buffer ('wrapscan' is ignored)
1549 w scan buffers from other windows
1550 b scan other loaded buffers that are in the buffer list
1551 u scan the unloaded buffers that are in the buffer list
1552 U scan the buffers that are not in the buffer list
1553 k scan the files given with the 'dictionary' option
1554 k{dict} scan the file {dict}. Several "k" flags can be given,
1555 patterns are valid too. For example: >
1556 :set cpt=k/usr/dict/*,k~/spanish
1557< s scan the files given with the 'thesaurus' option
1558 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1559 are valid too.
1560 i scan current and included files
1561 d scan current and included files for defined name or macro
1562 |i_CTRL-X_CTRL-D|
1563 ] tag completion
1564 t same as "]"
1565
1566 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1567 not executed, this may lead to unexpected completions from some files
1568 (gzipped files for example). Unloaded buffers are not scanned for
1569 whole-line completion.
1570
1571 The default is ".,w,b,u,t,i", which means to scan:
1572 1. the current buffer
1573 2. buffers in other windows
1574 3. other loaded buffers
1575 4. unloaded buffers
1576 5. tags
1577 6. included files
1578
1579 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001580 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1581 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001583 *'completefunc'* *'cfu'*
1584'completefunc' 'cfu' string (default: empty)
1585 local to buffer
1586 {not in Vi}
1587 This option specifies a completion function to be used for CTRL-X
1588 CTRL-X. The function will be invoked with four arguments:
1589 a:line the text of the current line
1590 a:base the text with which matches should match
1591 a:col column in a:line where the cursor is, first column is
1592 zero
1593 a:findstart either 1 or 0
1594 When the a:findstart argument is 1, the function must return the
1595 column of where the completion starts. It must be a number between
1596 zero and "a:col". This involves looking at the characters in a:line
1597 before column a:col and include those characters that could be part of
1598 the completed item.
1599 When the a:findstart argument is 0 the function must return a string
1600 with the matching words, separated by newlines. When there are no
1601 matches return an empty string.
1602 An example that completes the names of the months: >
1603 fun! CompleteMonths(line, base, col, findstart)
1604 if a:findstart
1605 " locate start column of word
1606 let start = a:col
1607 while start > 0 && a:line[start - 1] =~ '\a'
1608 let start = start - 1
1609 endwhile
1610 return start
1611 else
1612 " find months matching with "a:base"
1613 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1614 if a:base != ''
1615 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1616 endif
1617 let res = substitute(res, ' \+', "\n", 'g')
1618 return res
1619 endif
1620 endfun
1621 set completefunc=CompleteMonths
1622< Note that a substitute() function is used to reduce the list of
1623 possible values and remove the ones that don't match the base. The
1624 part before the "\|" matches the base, the part after it is used
1625 when there is no match. The "\2" in the replacement is empty if the
1626 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001627
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1629'confirm' 'cf' boolean (default off)
1630 global
1631 {not in Vi}
1632 When 'confirm' is on, certain operations that would normally
1633 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1634 instead raise a |dialog| asking if you wish to save the current
1635 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1636 If 'confirm' is off you can still activate confirmation for one
1637 command only (this is most useful in mappings) with the |:confirm|
1638 command.
1639 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1640
1641 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1642'conskey' 'consk' boolean (default off)
1643 global
1644 {not in Vi} {only for MS-DOS}
1645 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001646 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 three methods of console input are available:
1648 'conskey' 'bioskey' action ~
1649 on on or off direct console input
1650 off on BIOS
1651 off off STDIN
1652
1653 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1654'copyindent' 'ci' boolean (default off)
1655 local to buffer
1656 {not in Vi}
1657 Copy the structure of the existing lines indent when autoindenting a
1658 new line. Normally the new indent is reconstructed by a series of
1659 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1660 in which case only spaces are used). Enabling this option makes the
1661 new line copy whatever characters were used for indenting on the
1662 existing line. If the new indent is greater than on the existing
1663 line, the remaining space is filled in the normal manner.
1664 NOTE: 'copyindent' is reset when 'compatible' is set.
1665 Also see 'preserveindent'.
1666
1667 *'cpoptions'* *'cpo'*
1668'cpoptions' 'cpo' string (Vim default: "aABceFs",
1669 Vi default: all flags)
1670 global
1671 {not in Vi}
1672 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001673 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 not being vi-compatible is mostly or sometimes preferred.
1675 'cpoptions' stands for "compatible-options".
1676 Commas can be added for readability.
1677 To avoid problems with flags that are added in the future, use the
1678 "+=" and "-=" feature of ":set" |add-option-flags|.
1679 NOTE: This option is set to the Vi default value when 'compatible' is
1680 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001681 NOTE: This option is set to the POSIX default value at startup when
1682 the Vi default value would be used and the $VIM_POSIX environment
1683 variable exists |posix|. This means tries to behave like the POSIX
1684 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685
1686 contains behavior ~
1687 *cpo-a*
1688 a When included, a ":read" command with a file name
1689 argument will set the alternate file name for the
1690 current window.
1691 *cpo-A*
1692 A When included, a ":write" command with a file name
1693 argument will set the alternate file name for the
1694 current window.
1695 *cpo-b*
1696 b "\|" in a ":map" command is recognized as the end of
1697 the map command. The '\' is included in the mapping,
1698 the text after the '|' is interpreted as the next
1699 command. Use a CTRL-V instead of a backslash to
1700 include the '|' in the mapping. Applies to all
1701 mapping, abbreviation, menu and autocmd commands.
1702 See also |map_bar|.
1703 *cpo-B*
1704 B A backslash has no special meaning in mappings,
1705 abbreviations and the "to" part of the menu commands.
1706 Remove this flag to be able to use a backslash like a
1707 CTRL-V. For example, the command ":map X \<Esc>"
1708 results in X being mapped to:
1709 'B' included: "\^[" (^[ is a real <Esc>)
1710 'B' excluded: "<Esc>" (5 characters)
1711 ('<' excluded in both cases)
1712 *cpo-c*
1713 c Searching continues at the end of any match at the
1714 cursor position, but not further than the start of the
1715 next line. When not present searching continues
1716 one character from the cursor position. With 'c'
1717 "abababababab" only gets three matches when repeating
1718 "/abab", without 'c' there are five matches.
1719 *cpo-C*
1720 C Do not concatenate sourced lines that start with a
1721 backslash. See |line-continuation|.
1722 *cpo-d*
1723 d Using "./" in the 'tags' option doesn't mean to use
1724 the tags file relative to the current file, but the
1725 tags file in the current directory.
1726 *cpo-D*
1727 D Can't use CTRL-K to enter a digraph after Normal mode
1728 commands with a character argument, like |r|, |f| and
1729 |t|.
1730 *cpo-e*
1731 e When executing a register with ":@r", always add a
1732 <CR> to the last line, also when the register is not
1733 linewise. If this flag is not present, the register
1734 is not linewise and the last line does not end in a
1735 <CR>, then the last line is put on the command-line
1736 and can be edited before hitting <CR>.
1737 *cpo-E*
1738 E It is an error when using "y", "d", "c", "g~", "gu" or
1739 "gU" on an Empty region. The operators only work when
1740 at least one character is to be operate on. Example:
1741 This makes "y0" fail in the first column.
1742 *cpo-f*
1743 f When included, a ":read" command with a file name
1744 argument will set the file name for the current buffer,
1745 if the current buffer doesn't have a file name yet.
1746 *cpo-F*
1747 F When included, a ":write" command with a file name
1748 argument will set the file name for the current
1749 buffer, if the current buffer doesn't have a file name
1750 yet.
1751 *cpo-g*
1752 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001753 *cpo-H*
1754 H When using "I" on a line with only blanks, insert
1755 before the last blank. Without this flag insert after
1756 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 *cpo-i*
1758 i When included, interrupting the reading of a file will
1759 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001760 *cpo-I*
1761 I When moving the cursor up or down just after inserting
1762 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 *cpo-j*
1764 j When joining lines, only add two spaces after a '.',
1765 not after '!' or '?'. Also see 'joinspaces'.
1766 *cpo-J*
1767 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001768 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 white space.
1770 *cpo-k*
1771 k Disable the recognition of raw key codes in
1772 mappings, abbreviations, and the "to" part of menu
1773 commands. For example, if <Key> sends ^[OA (where ^[
1774 is <Esc>), the command ":map X ^[OA" results in X
1775 being mapped to:
1776 'k' included: "^[OA" (3 characters)
1777 'k' excluded: "<Key>" (one key code)
1778 Also see the '<' flag below.
1779 *cpo-K*
1780 K Don't wait for a key code to complete when it is
1781 halfway a mapping. This breaks mapping <F1><F1> when
1782 only part of the second <F1> has been read. It
1783 enables cancelling the mapping by typing <F1><Esc>.
1784 *cpo-l*
1785 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001786 literally, only "\]", "\^", "\-" and "\\" are special.
1787 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1789 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001790 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 *cpo-L*
1792 L When the 'list' option is set, 'wrapmargin',
1793 'textwidth', 'softtabstop' and Virtual Replace mode
1794 (see |gR|) count a <Tab> as two characters, instead of
1795 the normal behavior of a <Tab>.
1796 *cpo-m*
1797 m When included, a showmatch will always wait half a
1798 second. When not included, a showmatch will wait half
1799 a second or until a character is typed. |'showmatch'|
1800 *cpo-M*
1801 M When excluded, "%" matching will take backslashes into
1802 account. Thus in "( \( )" and "\( ( \)" the outer
1803 parenthesis match. When included "%" ignores
1804 backslashes, which is Vi compatible.
1805 *cpo-n*
1806 n When included, the column used for 'number' will also
1807 be used for text of wrapped lines.
1808 *cpo-o*
1809 o Line offset to search command is not remembered for
1810 next search.
1811 *cpo-O*
1812 O Don't complain if a file is being overwritten, even
1813 when it didn't exist when editing it. This is a
1814 protection against a file unexpectedly created by
1815 someone else. Vi didn't complain about this.
1816 *cpo-p*
1817 p Vi compatible Lisp indenting. When not present, a
1818 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001819 *cpo-q*
1820 q When joining multiple lines leave the cursor at the
1821 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 *cpo-r*
1823 r Redo ("." command) uses "/" to repeat a search
1824 command, instead of the actually used search string.
1825 *cpo-R*
1826 R Remove marks from filtered lines. Without this flag
1827 marks are kept like |:keepmarks| was used.
1828 *cpo-s*
1829 s Set buffer options when entering the buffer for the
1830 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001831 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 set when the buffer is created.
1833 *cpo-S*
1834 S Set buffer options always when entering a buffer
1835 (except 'readonly', 'fileformat', 'filetype' and
1836 'syntax'). This is the (most) Vi compatible setting.
1837 The options are set to the values in the current
1838 buffer. When you change an option and go to another
1839 buffer, the value is copied. Effectively makes the
1840 buffer options global to all buffers.
1841
1842 's' 'S' copy buffer options
1843 no no when buffer created
1844 yes no when buffer first entered (default)
1845 X yes each time when buffer entered (vi comp.)
1846 *cpo-t*
1847 t Search pattern for the tag command is remembered for
1848 "n" command. Otherwise Vim only puts the pattern in
1849 the history for search pattern, but doesn't change the
1850 last used search pattern.
1851 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001852 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 *cpo-v*
1854 v Backspaced characters remain visible on the screen in
1855 Insert mode. Without this flag the characters are
1856 erased from the screen right away. With this flag the
1857 screen newly typed text overwrites backspaced
1858 characters.
1859 *cpo-w*
1860 w When using "cw" on a blank character, only change one
1861 character and not all blanks until the start of the
1862 next word.
1863 *cpo-W*
1864 W Don't overwrite a readonly file. When omitted, ":w!"
1865 overwrites a readonly file, if possible.
1866 *cpo-x*
1867 x <Esc> on the command-line executes the command-line.
1868 The default in Vim is to abandon the command-line,
1869 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001870 *cpo-X*
1871 X When using a count with "R" the replaced text is
1872 deleted only once. Also when repeating "R" with "."
1873 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 *cpo-y*
1875 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001876 *cpo-Z*
1877 Z When using "w!" while the 'readonly' option is set,
1878 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 *cpo-!*
1880 ! When redoing a filter command, use the last used
1881 external command, whatever it was. Otherwise the last
1882 used -filter- command is used.
1883 *cpo-$*
1884 $ When making a change to one line, don't redisplay the
1885 line, but put a '$' at the end of the changed text.
1886 The changed text will be overwritten when you type the
1887 new text. The line is redisplayed if you type any
1888 command that moves the cursor from the insertion
1889 point.
1890 *cpo-%*
1891 % Vi-compatible matching is done for the "%" command.
1892 Does not recognize "#if", "#endif", etc.
1893 Does not recognize "/*" and "*/".
1894 Parens inside single and double quotes are also
1895 counted, causing a string that contains a paren to
1896 disturb the matching. For example, in a line like
1897 "if (strcmp("foo(", s))" the first paren does not
1898 match the last one. When this flag is not included,
1899 parens inside single and double quotes are treated
1900 specially. When matching a paren outside of quotes,
1901 everything inside quotes is ignored. When matching a
1902 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001903 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001904 This flag is also used for other features, such as
1905 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001906 *cpo--*
1907 - When included, a vertical movement command fails when
1908 it would above the first line or below the last line.
1909 Without it the cursor moves to the first or last line,
1910 unless it already was in that line.
1911 Applies to the commands "-", "k", CTRL-P, "+", "j",
1912 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001913 *cpo-+*
1914 + When included, a ":write file" command will reset the
1915 'modified' flag of the buffer, even though the buffer
1916 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001917 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 * Use ":*" in the same way as ":@". When not included,
1919 ":*" is an alias for ":'<,'>", select the Visual area.
1920 *cpo-<*
1921 < Disable the recognition of special key codes in |<>|
1922 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001923 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 ":map X <Tab>" results in X being mapped to:
1925 '<' included: "<Tab>" (5 characters)
1926 '<' excluded: "^I" (^I is a real <Tab>)
1927 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001928 *cpo->*
1929 > When appending to a register, put a line break before
1930 the appended text.
1931
1932 POSIX flags. These are not included in the Vi default value, except
1933 when $VIM_POSIX was set on startup. |posix|
1934
1935 contains behavior ~
1936 *cpo-#*
1937 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001938 *cpo-&*
1939 & When ":preserve" was used keep the swap file when
1940 exiting normally while this buffer is still loaded.
1941 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001942 *cpo-\*
1943 \ Backslash in a [] range in a search pattern is taken
1944 literally, only "\]" is special See |/[]|
1945 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1946 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1947 Also see |cpo-\|.
1948 *cpo-/*
1949 / When "%" is used as the replacement string in a |:s|
1950 command, use the previous replacement string. |:s%|
1951 *cpo-{*
1952 { The |{| and |}| commands also stop at a "{" character
1953 at the start of a line.
1954 *cpo-.*
1955 . The ":chdir" and ":cd" commands fail if the current
1956 buffer is modified, unless ! is used. Vim doesn't
1957 need this, since it remembers the full path of an
1958 opened file.
1959 *cpo-bar*
1960 | The value of the $LINES and $COLUMNS environment
1961 variables overrule the terminal size values obtained
1962 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001963
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964
1965 *'cscopepathcomp'* *'cspc'*
1966'cscopepathcomp' 'cspc' number (default 0)
1967 global
1968 {not available when compiled without the |+cscope|
1969 feature}
1970 {not in Vi}
1971 Determines how many components of the path to show in a list of tags.
1972 See |cscopepathcomp|.
1973
1974 *'cscopeprg'* *'csprg'*
1975'cscopeprg' 'csprg' string (default "cscope")
1976 global
1977 {not available when compiled without the |+cscope|
1978 feature}
1979 {not in Vi}
1980 Specifies the command to execute cscope. See |cscopeprg|.
1981 This option cannot be set from a |modeline| or in the |sandbox|, for
1982 security reasons.
1983
1984 *'cscopequickfix'* *'csqf'*
1985'cscopequickfix' 'csqf' string (default "")
1986 global
1987 {not available when compiled without the |+cscope|
1988 or |+quickfix| features}
1989 {not in Vi}
1990 Specifies whether to use quickfix window to show cscope results.
1991 See |cscopequickfix|.
1992
1993 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1994'cscopetag' 'cst' boolean (default off)
1995 global
1996 {not available when compiled without the |+cscope|
1997 feature}
1998 {not in Vi}
1999 Use cscope for tag commands. See |cscope-options|.
2000 NOTE: This option is reset when 'compatible' is set.
2001
2002 *'cscopetagorder'* *'csto'*
2003'cscopetagorder' 'csto' number (default 0)
2004 global
2005 {not available when compiled without the |+cscope|
2006 feature}
2007 {not in Vi}
2008 Determines the order in which ":cstag" performs a search. See
2009 |cscopetagorder|.
2010 NOTE: This option is set to 0 when 'compatible' is set.
2011
2012 *'cscopeverbose'* *'csverb'*
2013 *'nocscopeverbose'* *'nocsverb'*
2014'cscopeverbose' 'csverb' boolean (default off)
2015 global
2016 {not available when compiled without the |+cscope|
2017 feature}
2018 {not in Vi}
2019 Give messages when adding a cscope database. See |cscopeverbose|.
2020 NOTE: This option is reset when 'compatible' is set.
2021
2022 *'debug'*
2023'debug' string (default "")
2024 global
2025 {not in Vi}
2026 When set to "msg", error messages that would otherwise be omitted will
2027 be given anyway. This is useful when debugging 'foldexpr' or
2028 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002029 When set to "beep", a message will be given when otherwise only a beep
2030 would be produced.
2031 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032
2033 *'define'* *'def'*
2034'define' 'def' string (default "^\s*#\s*define")
2035 global or local to buffer |global-local|
2036 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002037 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 pattern, just like for the "/" command. This option is used for the
2039 commands like "[i" and "[d" |include-search|. The 'isident' option is
2040 used to recognize the defined name after the match:
2041 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2042 See |option-backslash| about inserting backslashes to include a space
2043 or backslash.
2044 The default value is for C programs. For C++ this value would be
2045 useful, to include const type declarations: >
2046 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2047< When using the ":set" command, you need to double the backslashes!
2048
2049 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2050'delcombine' 'deco' boolean (default off)
2051 global
2052 {not in Vi}
2053 {only available when compiled with the |+multi_byte|
2054 feature}
2055 If editing Unicode and this option is set, backspace and Normal mode
2056 "x" delete each combining character on its own. When it is off (the
2057 default) the character along with its combining characters are
2058 deleted.
2059 Note: When 'delcombine' is set "xx" may work different from "2x"!
2060
2061 This is useful for Arabic, Hebrew and many other languages where one
2062 may have combining characters overtop of base characters, and want
2063 to remove only the combining ones.
2064
2065 *'dictionary'* *'dict'*
2066'dictionary' 'dict' string (default "")
2067 global or local to buffer |global-local|
2068 {not in Vi}
2069 List of file names, separated by commas, that are used to lookup words
2070 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2071 contain a list of words. This can be one word per line, or several
2072 words per line, separated by non-keyword characters (white space is
2073 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002074 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 after a comma are ignored, otherwise spaces are included in the file
2076 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002077 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 Where to find a list of words?
2079 - On FreeBSD, there is the file "/usr/share/dict/words".
2080 - In the Simtel archive, look in the "msdos/linguist" directory.
2081 - In "miscfiles" of the GNU collection.
2082 The use of |:set+=| and |:set-=| is preferred when adding or removing
2083 directories from the list. This avoids problems when a future version
2084 uses another default.
2085 Backticks cannot be used in this option for security reasons.
2086
2087 *'diff'* *'nodiff'*
2088'diff' boolean (default off)
2089 local to window
2090 {not in Vi}
2091 {not available when compiled without the |+diff|
2092 feature}
2093 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002094 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095
2096 *'dex'* *'diffexpr'*
2097'diffexpr' 'dex' string (default "")
2098 global
2099 {not in Vi}
2100 {not available when compiled without the |+diff|
2101 feature}
2102 Expression which is evaluated to obtain an ed-style diff file from two
2103 versions of a file. See |diff-diffexpr|.
2104 This option cannot be set from a |modeline| or in the |sandbox|, for
2105 security reasons.
2106
2107 *'dip'* *'diffopt'*
2108'diffopt' 'dip' string (default "filler")
2109 global
2110 {not in Vi}
2111 {not available when compiled without the |+diff|
2112 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002113 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 All are optional. Items must be separated by a comma.
2115
2116 filler Show filler lines, to keep the text
2117 synchronized with a window that has inserted
2118 lines at the same position. Mostly useful
2119 when windows are side-by-side and 'scrollbind'
2120 is set.
2121
2122 context:{n} Use a context of {n} lines between a change
2123 and a fold that contains unchanged lines.
2124 When omitted a context of six lines is used.
2125 See |fold-diff|.
2126
2127 icase Ignore changes in case of text. "a" and "A"
2128 are considered the same. Adds the "-i" flag
2129 to the "diff" command if 'diffexpr' is empty.
2130
2131 iwhite Ignore changes in amount of white space. Adds
2132 the "-b" flag to the "diff" command if
2133 'diffexpr' is empty. Check the documentation
2134 of the "diff" command for what this does
2135 exactly. It should ignore adding trailing
2136 white space, but not leading white space.
2137
2138 Examples: >
2139
2140 :set diffopt=filler,context:4
2141 :set diffopt=
2142 :set diffopt=filler
2143<
2144 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2145'digraph' 'dg' boolean (default off)
2146 global
2147 {not in Vi}
2148 {not available when compiled without the |+digraphs|
2149 feature}
2150 Enable the entering of digraphs in Insert mode with {char1} <BS>
2151 {char2}. See |digraphs|.
2152 NOTE: This option is reset when 'compatible' is set.
2153
2154 *'directory'* *'dir'*
2155'directory' 'dir' string (default for Amiga: ".,t:",
2156 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2157 for Unix: ".,~/tmp,/var/tmp,/tmp")
2158 global
2159 List of directory names for the swap file, separated with commas.
2160 - The swap file will be created in the first directory where this is
2161 possible.
2162 - Empty means that no swap file will be used (recovery is
2163 impossible!).
2164 - A directory "." means to put the swap file in the same directory as
2165 the edited file. On Unix, a dot is prepended to the file name, so
2166 it doesn't show in a directory listing. On MS-Windows the "hidden"
2167 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002168 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 put the swap file relative to where the edited file is. The leading
2170 "." is replaced with the path name of the edited file.
2171 - For Unix and Win32, if a directory ends in two path separators, the
2172 swap file name will be built from the complete path to the file
Bram Moolenaar582fd852005-03-28 20:58:01 +00002173 with all path separators substituted to percent '%' signs. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 ensure file name uniqueness in the preserve directory.
2175 - Spaces after the comma are ignored, other spaces are considered part
2176 of the directory name. To have a space at the start of a directory
2177 name, precede it with a backslash.
2178 - To include a comma in a directory name precede it with a backslash.
2179 - A directory name may end in an ':' or '/'.
2180 - Environment variables are expanded |:set_env|.
2181 - Careful with '\' characters, type one before a space, type two to
2182 get one in the option (see |option-backslash|), for example: >
2183 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2184< - For backwards compatibility with Vim version 3.0 a '>' at the start
2185 of the option is removed.
2186 Using "." first in the list is recommended. This means that editing
2187 the same file twice will result in a warning. Using "/tmp" on Unix is
2188 discouraged: When the system crashes you lose the swap file.
2189 "/var/tmp" is often not cleared when rebooting, thus is a better
2190 choice than "/tmp". But it can contain a lot of files, your swap
2191 files get lost in the crowd. That is why a "tmp" directory in your
2192 home directory is tried first.
2193 The use of |:set+=| and |:set-=| is preferred when adding or removing
2194 directories from the list. This avoids problems when a future version
2195 uses another default.
2196 This option cannot be set from a |modeline| or in the |sandbox|, for
2197 security reasons.
2198 {Vi: directory to put temp file in, defaults to "/tmp"}
2199
2200 *'display'* *'dy'*
2201'display' 'dy' string (default "")
2202 global
2203 {not in Vi}
2204 Change the way text is displayed. This is comma separated list of
2205 flags:
2206 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002207 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 last line that doesn't fit is replaced with "@" lines.
2209 uhex Show unprintable characters hexadecimal as <xx>
2210 instead of using ^C and ~C.
2211
2212 *'eadirection'* *'ead'*
2213'eadirection' 'ead' string (default "both")
2214 global
2215 {not in Vi}
2216 {not available when compiled without the +vertsplit
2217 feature}
2218 Tells when the 'equalalways' option applies:
2219 ver vertically, width of windows is not affected
2220 hor horizontally, height of windows is not affected
2221 both width and height of windows is affected
2222
2223 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2224'edcompatible' 'ed' boolean (default off)
2225 global
2226 Makes the 'g' and 'c' flags of the ":substitute" command to be
2227 toggled each time the flag is given. See |complex-change|. See
2228 also 'gdefault' option.
2229 Switching this option on is discouraged!
2230
2231 *'encoding'* *'enc'* *E543*
2232'encoding' 'enc' string (default: "latin1" or value from $LANG)
2233 global
2234 {only available when compiled with the |+multi_byte|
2235 feature}
2236 {not in Vi}
2237 Sets the character encoding used inside Vim. It applies to text in
2238 the buffers, registers, Strings in expressions, text stored in the
2239 viminfo file, etc. It sets the kind of characters which Vim can work
2240 with. See |encoding-names| for the possible values.
2241
2242 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002243 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 It should normally be kept at its default value, or set when Vim
2245 starts up. See |multibyte|.
2246
2247 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2248 "utf-8". Although care has been taken to allow different values of
2249 'encoding', "utf-8" is the natural choice for the environment and
2250 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002251 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 versions, and to avoid changing the encoding of newly created files
2253 without your knowledge (in case 'fileencodings' is empty).
2254
2255 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002256 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 iconv() or as specified with 'charconvert'.
2258
2259 Normally 'encoding' will be equal to your current locale. This will
2260 be the default if Vim recognizes your environment settings. If
2261 'encoding' is not set to the current locale, 'termencoding' must be
2262 set to convert typed and displayed text. See |encoding-table|.
2263
2264 When you set this option, it fires the |EncodingChanged| autocommand
2265 event so that you can set up fonts if necessary.
2266
2267 When the option is set, the value is converted to lowercase. Thus
2268 you can set it with uppercase values too. Underscores are translated
2269 to '-' signs.
2270 When the encoding is recognized, it is changed to the standard name.
2271 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2272 "iso-8859-2" and "utf8" becomes "utf-8".
2273
2274 Note: "latin1" is also used when the encoding could not be detected.
2275 This only works when editing files in the same encoding! When the
2276 actual character set is not latin1, make sure 'fileencoding' and
2277 'fileencodings' are empty. When conversion is needed, switch to using
2278 utf-8.
2279
2280 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2281 You don't notice this while editing, but it does matter for the
2282 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2283 setting 'encoding' to one of these values instead of utf-8 only has
2284 effect for encoding used for files when 'fileencoding' is empty.
Bram Moolenaar661b1822005-07-28 22:36:45 +00002285 "utf-16" is NOT supported (and probably never will be, since it's such
2286 an ugly encoding). *utf-16*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287
Bram Moolenaar661b1822005-07-28 22:36:45 +00002288 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2289 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002290
2291 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2292'endofline' 'eol' boolean (default on)
2293 local to buffer
2294 {not in Vi}
2295 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002296 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 option is automatically set when starting to edit a new file, unless
2298 the file does not have an <EOL> for the last line in the file, in
2299 which case it is reset. Normally you don't have to set or reset this
2300 option. When 'binary' is off the value is not used when writing the
2301 file. When 'binary' is on it is used to remember the presence of a
2302 <EOL> for the last line in the file, so that when you write the file
2303 the situation from the original file can be kept. But you can change
2304 it if you want to.
2305
2306 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2307'equalalways' 'ea' boolean (default on)
2308 global
2309 {not in Vi}
2310 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002311 splitting or closing a window. This also happens the moment the
2312 option is switched on. When off, splitting a window will reduce the
2313 size of the current window and leave the other windows the same. When
2314 closing a window the extra lines are given to the window next to it
2315 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 When mixing vertically and horizontally split windows, a minimal size
2317 is computed and some windows may be larger if there is room. The
2318 'eadirection' option tells in which direction the size is affected.
2319 Changing the height of a window can be avoided by setting
2320 'winfixheight'.
2321
2322 *'equalprg'* *'ep'*
2323'equalprg' 'ep' string (default "")
2324 global or local to buffer |global-local|
2325 {not in Vi}
2326 External program to use for "=" command. When this option is empty
2327 the internal formatting functions are used ('lisp', 'cindent' or
2328 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002329 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 about including spaces and backslashes.
2331 This option cannot be set from a |modeline| or in the |sandbox|, for
2332 security reasons.
2333
2334 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2335'errorbells' 'eb' boolean (default off)
2336 global
2337 Ring the bell (beep or screen flash) for error messages. This only
2338 makes a difference for error messages, the bell will be used always
2339 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002340 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 screen flash or do nothing.
2342
2343 *'errorfile'* *'ef'*
2344'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2345 others: "errors.err")
2346 global
2347 {not in Vi}
2348 {not available when compiled without the |+quickfix|
2349 feature}
2350 Name of the errorfile for the QuickFix mode (see |:cf|).
2351 When the "-q" command-line argument is used, 'errorfile' is set to the
2352 following argument. See |-q|.
2353 NOT used for the ":make" command. See 'makeef' for that.
2354 Environment variables are expanded |:set_env|.
2355 See |option-backslash| about including spaces and backslashes.
2356 This option cannot be set from a |modeline| or in the |sandbox|, for
2357 security reasons.
2358
2359 *'errorformat'* *'efm'*
2360'errorformat' 'efm' string (default is very long)
2361 global or local to buffer |global-local|
2362 {not in Vi}
2363 {not available when compiled without the |+quickfix|
2364 feature}
2365 Scanf-like description of the format for the lines in the error file
2366 (see |errorformat|).
2367
2368 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2369'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2370 global
2371 {not in Vi}
2372 Function keys that start with an <Esc> are recognized in Insert
2373 mode. When this option is off, the cursor and function keys cannot be
2374 used in Insert mode if they start with an <Esc>. The advantage of
2375 this is that the single <Esc> is recognized immediately, instead of
2376 after one second. Instead of resetting this option, you might want to
2377 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2378 when 'esckeys' is off, you can still map anything, but the cursor keys
2379 won't work by default.
2380 NOTE: This option is set to the Vi default value when 'compatible' is
2381 set and to the Vim default value when 'compatible' is reset.
2382
2383 *'eventignore'* *'ei'*
2384'eventignore' 'ei' string (default "")
2385 global
2386 {not in Vi}
2387 {not available when compiled without the |+autocmd|
2388 feature}
2389 A list of autocommand event names, which are to be ignored.
2390 When set to "all", all autocommand events are ignored, autocommands
2391 will not be executed.
2392 Otherwise this is a comma separated list of event names. Example: >
2393 :set ei=WinEnter,WinLeave
2394<
2395 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2396'expandtab' 'et' boolean (default off)
2397 local to buffer
2398 {not in Vi}
2399 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2402 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2403 NOTE: This option is reset when 'compatible' is set.
2404
2405 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2406'exrc' 'ex' boolean (default off)
2407 global
2408 {not in Vi}
2409 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2410 directory. If you switch this option on you should also consider
2411 setting the 'secure' option (see |initialization|). Using a local
2412 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2413 also see |.vimrc| and |gui-init|.
2414 This option cannot be set from a |modeline| or in the |sandbox|, for
2415 security reasons.
2416
2417 *'fileencoding'* *'fenc'* *E213*
2418'fileencoding' 'fenc' string (default: "")
2419 local to buffer
2420 {only available when compiled with the |+multi_byte|
2421 feature}
2422 {not in Vi}
2423 Sets the character encoding for the file of this buffer.
2424 When 'fileencoding' is different from 'encoding', conversion will be
2425 done when reading and writing the file.
2426 When 'fileencoding' is empty, the same value as 'encoding' will be
2427 used (no conversion when reading or writing a file).
2428 WARNING: Conversion can cause loss of information! When
2429 'encoding' is "utf-8" conversion is most likely done in a way
2430 that the reverse conversion results in the same text. When
2431 'encoding' is not "utf-8" some characters may be lost!
2432 See 'encoding' for the possible values. Additionally, values may be
2433 specified that can be handled by the converter, see
2434 |mbyte-conversion|.
2435 When reading a file 'fileencoding' will be set from 'fileencodings'.
2436 To read a file in a certain encoding it won't work by setting
2437 'fileencoding', use the |++enc| argument.
2438 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2439 When the option is set, the value is converted to lowercase. Thus
2440 you can set it with uppercase values too. '_' characters are
2441 replaced with '-'. If a name is recognized from the list for
2442 'encoding', it is replaced by the standard name. For example
2443 "ISO8859-2" becomes "iso-8859-2".
2444 When this option is set, after starting to edit a file, the 'modified'
2445 option is set, because the file would be different when written.
2446 If you do this in a modeline, you might want to set 'nomodified' to
2447 avoid this.
2448 This option can not be changed when 'modifiable' is off.
2449
2450 *'fe'*
2451 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002452 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 old short name was 'fe', which is no longer used.
2454
2455 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002456'fileencodings' 'fencs' string (default: "ucs-bom",
2457 "ucs-bom,utf-8,default,latin1" when
2458 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 global
2460 {only available when compiled with the |+multi_byte|
2461 feature}
2462 {not in Vi}
2463 This is a list of character encodings considered when starting to edit
2464 an existing file. When a file is read, Vim tries to use the first
2465 mentioned character encoding. If an error is detected, the next one
2466 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002467 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 an empty string, which means the value of 'encoding' is used.
2469 WARNING: Conversion can cause loss of information! When
2470 'encoding' is "utf-8" (or one of the other Unicode variants)
2471 conversion is most likely done in a way that the reverse
2472 conversion results in the same text. When 'encoding' is not
2473 "utf-8" special characters may be lost!
2474 For an empty file or a file with only ASCII characters most encodings
2475 will work and the first entry of 'fileencodings' will be used (except
2476 "ucs-bom", which requires the BOM to be present). If you prefer
2477 another encoding use an BufReadPost autocommand event to test if your
2478 preferred encoding is to be used. Example: >
2479 au BufReadPost * if search('\S', 'w') == 0 |
2480 \ set fenc=iso-2022-jp | endif
2481< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2482 non-blank characters.
2483 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2484 is always empty then. This means that a non-existing file may get a
2485 different encoding than an empty file.
2486 The special value "ucs-bom" can be used to check for a Unicode BOM
2487 (Byte Order Mark) at the start of the file. It must not be preceded
2488 by "utf-8" or another Unicode encoding for this to work properly.
2489 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2490 because Vim cannot detect an error, thus the encoding is always
2491 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002492 The special value "default" can be used for the encoding from the
2493 environment. This is the default value for 'encoding'. It is useful
2494 when 'encoding' is set to "utf-8" and your environment uses a
2495 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 WRONG VALUES: WHAT'S WRONG:
2497 latin1,utf-8 "latin1" will always be used
2498 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2499 file
2500 cp1250,latin1 "cp1250" will always be used
2501 If 'fileencodings' is empty, 'fileencoding' is not modified.
2502 See 'fileencoding' for the possible values.
2503 Setting this option does not have an effect until the next time a file
2504 is read.
2505
2506 *'fileformat'* *'ff'*
2507'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2508 Unix default: "unix",
2509 Macintosh default: "mac")
2510 local to buffer
2511 {not in Vi}
2512 This gives the <EOL> of the current buffer, which is used for
2513 reading/writing the buffer from/to a file:
2514 dos <CR> <NL>
2515 unix <NL>
2516 mac <CR>
2517 When "dos" is used, CTRL-Z at the end of a file is ignored.
2518 See |file-formats| and |file-read|.
2519 For the character encoding of the file see 'fileencoding'.
2520 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2521 works like it was set to "unix'.
2522 This option is set automatically when starting to edit a file and
2523 'fileformats' is not empty and 'binary' is off.
2524 When this option is set, after starting to edit a file, the 'modified'
2525 option is set, because the file would be different when written.
2526 This option can not be changed when 'modifiable' is off.
2527 For backwards compatibility: When this option is set to "dos",
2528 'textmode' is set, otherwise 'textmode' is reset.
2529
2530 *'fileformats'* *'ffs'*
2531'fileformats' 'ffs' string (default:
2532 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2533 Vim Unix: "unix,dos",
2534 Vim Mac: "mac,unix,dos",
2535 Vi Cygwin: "unix,dos",
2536 Vi others: "")
2537 global
2538 {not in Vi}
2539 This gives the end-of-line (<EOL>) formats that will be tried when
2540 starting to edit a new buffer and when reading a file into an existing
2541 buffer:
2542 - When empty, the format defined with 'fileformat' will be used
2543 always. It is not set automatically.
2544 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002545 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546 'fileformats' name will be used when a file is read into an existing
2547 buffer, no matter what 'fileformat' for that buffer is set to.
2548 - When more than one name is present, separated by commas, automatic
2549 <EOL> detection will be done when reading a file. When starting to
2550 edit a file, a check is done for the <EOL>:
2551 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2552 'fileformat' is set to "dos".
2553 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002554 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555 preceding <CR>, "unix" is preferred over "dos".
2556 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2557 This means that "mac" is only chosen when "unix" is not present,
2558 or when no <NL> is found in the file, and when "dos" is not
2559 present, or no <CR><NL> is present in the file.
2560 Also if "unix" was first chosen, but the first <CR> is before
2561 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2562 the file, then 'fileformat' is set to "mac".
2563 4. If 'fileformat' is still not set, the first name from
2564 'fileformats' is used.
2565 When reading a file into an existing buffer, the same is done, but
2566 this happens like 'fileformat' has been set appropriately for that
2567 file only, the option is not changed.
2568 When 'binary' is set, the value of 'fileformats' is not used.
2569
2570 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2571 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2572 done:
2573 - When 'fileformats' is empty, there is no automatic detection. Dos
2574 format will be used.
2575 - When 'fileformats' is set to one or more names, automatic detection
2576 is done. This is based on the first <NL> in the file: If there is a
2577 <CR> in front of it, Dos format is used, otherwise Unix format is
2578 used.
2579 Also see |file-formats|.
2580 For backwards compatibility: When this option is set to an empty
2581 string or one format (no comma is included), 'textauto' is reset,
2582 otherwise 'textauto' is set.
2583 NOTE: This option is set to the Vi default value when 'compatible' is
2584 set and to the Vim default value when 'compatible' is reset.
2585
2586 *'filetype'* *'ft'*
2587'filetype' 'ft' string (default: "")
2588 local to buffer
2589 {not in Vi}
2590 {not available when compiled without the |+autocmd|
2591 feature}
2592 When this option is set, the FileType autocommand event is triggered.
2593 All autocommands that match with the value of this option will be
2594 executed. Thus the value of 'filetype' is used in place of the file
2595 name.
2596 Otherwise this option does not always reflect the current file type.
2597 This option is normally set when the file type is detected. To enable
2598 this use the ":filetype on" command. |:filetype|
2599 Setting this option to a different value is most useful in a modeline,
2600 for a file for which the file type is not automatically recognized.
2601 Example, for in an IDL file: >
2602 /* vim: set filetype=idl : */
2603< |FileType| |filetypes|
2604 Do not confuse this option with 'osfiletype', which is for the file
2605 type that is actually stored with the file.
2606 This option is not copied to another buffer, independent of the 's' or
2607 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002608 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609
2610 *'fillchars'* *'fcs'*
2611'fillchars' 'fcs' string (default "vert:|,fold:-")
2612 global
2613 {not in Vi}
2614 {not available when compiled without the |+windows|
2615 and |+folding| features}
2616 Characters to fill the statuslines and vertical separators.
2617 It is a comma separated list of items:
2618
2619 item default Used for ~
2620 stl:c ' ' or '^' statusline of the current window
2621 stlnc:c ' ' or '-' statusline of the non-current windows
2622 vert:c '|' vertical separators |:vsplit|
2623 fold:c '-' filling 'foldtext'
2624 diff:c '-' deleted lines of the 'diff' option
2625
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002626 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002627 "stlnc" the space will be used when there is highlighting, '^' or '-'
2628 otherwise.
2629
2630 Example: >
2631 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2632< This is similar to the default, except that these characters will also
2633 be used when there is highlighting.
2634
2635 The highlighting used for these items:
2636 item highlight group ~
2637 stl:c StatusLine |hl-StatusLine|
2638 stlnc:c StatusLineNC |hl-StatusLineNC|
2639 vert:c VertSplit |hl-VertSplit|
2640 fold:c Folded |hl-Folded|
2641 diff:c DiffDelete |hl-DiffDelete|
2642
2643 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2644'fkmap' 'fk' boolean (default off) *E198*
2645 global
2646 {not in Vi}
2647 {only available when compiled with the |+rightleft|
2648 feature}
2649 When on, the keyboard is mapped for the Farsi character set.
2650 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002651 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652
2653 *'foldclose'* *'fcl'*
2654'foldclose' 'fcl' string (default "")
2655 global
2656 {not in Vi}
2657 {not available when compiled without the |+folding|
2658 feature}
2659 When set to "all", a fold is closed when the cursor isn't in it and
2660 its level is higher than 'foldlevel'. Useful if you want folds to
2661 automatically close when moving out of them.
2662
2663 *'foldcolumn'* *'fdc'*
2664'foldcolumn' 'fdc' number (default 0)
2665 local to window
2666 {not in Vi}
2667 {not available when compiled without the |+folding|
2668 feature}
2669 When non-zero, a column with the specified width is shown at the side
2670 of the window which indicates open and closed folds. The maximum
2671 value is 12.
2672 See |folding|.
2673
2674 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2675'foldenable' 'fen' boolean (default on)
2676 local to window
2677 {not in Vi}
2678 {not available when compiled without the |+folding|
2679 feature}
2680 When off, all folds are open. This option can be used to quickly
2681 switch between showing all text unfolded and viewing the text with
2682 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002683 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 'foldenable' is off.
2685 This option is set by commands that create a new fold or close a fold.
2686 See |folding|.
2687
2688 *'foldexpr'* *'fde'*
2689'foldexpr' 'fde' string (default: "0")
2690 local to window
2691 {not in Vi}
2692 {not available when compiled without the |+folding|
2693 or |+eval| feature}
2694 The expression used for when 'foldmethod' is "expr". It is evaluated
2695 for each line to obtain its fold level. See |fold-expr|. Also see
2696 |eval-sandbox|.
2697
2698 *'foldignore'* *'fdi'*
2699'foldignore' 'fdi' string (default: "#")
2700 local to window
2701 {not in Vi}
2702 {not available when compiled without the |+folding|
2703 feature}
2704 Used only when 'foldmethod' is "indent". Lines starting with
2705 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002706 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 The default "#" works well for C programs. See |fold-indent|.
2708
2709 *'foldlevel'* *'fdl'*
2710'foldlevel' 'fdl' number (default: 0)
2711 local to window
2712 {not in Vi}
2713 {not available when compiled without the |+folding|
2714 feature}
2715 Sets the fold level: Folds with a higher level will be closed.
2716 Setting this option to zero will close all folds. Higher numbers will
2717 close fewer folds.
2718 This option is set by commands like |zm|, |zM| and |zR|.
2719 See |fold-foldlevel|.
2720
2721 *'foldlevelstart'* *'fdls'*
2722'foldlevelstart' 'fdls' number (default: -1)
2723 global
2724 {not in Vi}
2725 {not available when compiled without the |+folding|
2726 feature}
2727 Sets 'foldlevel' when starting to edit another buffer in a window.
2728 Useful to always start editing with all folds closed (value zero),
2729 some folds closed (one) or no folds closed (99).
2730 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002731 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 ignores this option and closes all folds.
2733 It is also done before BufReadPre autocommands, to allow an autocmd to
2734 overrule the 'foldlevel' value for specific files.
2735 When the value is negative, it is not used.
2736
2737 *'foldmarker'* *'fmr'* *E536*
2738'foldmarker' 'fmr' string (default: "{{{,}}}")
2739 local to window
2740 {not in Vi}
2741 {not available when compiled without the |+folding|
2742 feature}
2743 The start and end marker used when 'foldmethod' is "marker". There
2744 must be one comma, which separates the start and end marker. The
2745 marker is a literal string (a regular expression would be too slow).
2746 See |fold-marker|.
2747
2748 *'foldmethod'* *'fdm'*
2749'foldmethod' 'fdm' string (default: "manual")
2750 local to window
2751 {not in Vi}
2752 {not available when compiled without the |+folding|
2753 feature}
2754 The kind of folding used for the current window. Possible values:
2755 |fold-manual| manual Folds are created manually.
2756 |fold-indent| indent Lines with equal indent form a fold.
2757 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2758 |fold-marker| marker Markers are used to specify folds.
2759 |fold-syntax| syntax Syntax highlighting items specify folds.
2760 |fold-diff| diff Fold text that is not changed.
2761
2762 *'foldminlines'* *'fml'*
2763'foldminlines' 'fml' number (default: 1)
2764 local to window
2765 {not in Vi}
2766 {not available when compiled without the |+folding|
2767 feature}
2768 Sets the minimum number of screen lines for a fold to be displayed
2769 closed. Also for manually closed folds.
2770 Note that this only has an effect of what is displayed. After using
2771 "zc" to close a fold, which is displayed open because it's smaller
2772 than 'foldminlines', a following "zc" may close a containing fold.
2773
2774 *'foldnestmax'* *'fdn'*
2775'foldnestmax' 'fdn' number (default: 20)
2776 local to window
2777 {not in Vi}
2778 {not available when compiled without the |+folding|
2779 feature}
2780 Sets the maximum nesting of folds for the "indent" and "syntax"
2781 methods. This avoids that too many folds will be created. Using more
2782 than 20 doesn't work, because the internal limit is 20.
2783
2784 *'foldopen'* *'fdo'*
2785'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2786 search,tag,undo")
2787 global
2788 {not in Vi}
2789 {not available when compiled without the |+folding|
2790 feature}
2791 Specifies for which type of commands folds will be opened, if the
2792 command moves the cursor into a closed fold. It is a comma separated
2793 list of items.
2794 item commands ~
2795 all any
2796 block "(", "{", "[[", "[{", etc.
2797 hor horizontal movements: "l", "w", "fx", etc.
2798 insert any command in Insert mode
2799 jump far jumps: "G", "gg", etc.
2800 mark jumping to a mark: "'m", CTRL-O, etc.
2801 percent "%"
2802 quickfix ":cn", ":crew", ":make", etc.
2803 search search for a pattern: "/", "n", "*", "gd", etc.
2804 (not for a search pattern in a ":" command)
2805 tag jumping to a tag: ":ta", CTRL-T, etc.
2806 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002807 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 the |zv| command to the mapping to get the same effect.
2809 When a movement command is used for an operator (e.g., "dl" or "y%")
2810 this option is not used. This means the operator will include the
2811 whole closed fold.
2812 Note that vertical movements are not here, because it would make it
2813 very difficult to move onto a closed fold.
2814 In insert mode the folds containing the cursor will always be open
2815 when text is inserted.
2816 To close folds you can re-apply 'foldlevel' with the |zx| command or
2817 set the 'foldclose' option to "all".
2818
2819 *'foldtext'* *'fdt'*
2820'foldtext' 'fdt' string (default: "foldtext()")
2821 local to window
2822 {not in Vi}
2823 {not available when compiled without the |+folding|
2824 feature}
2825 An expression which is used to specify the text displayed for a closed
2826 fold. See |fold-foldtext|.
2827
2828 *'formatoptions'* *'fo'*
2829'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2830 local to buffer
2831 {not in Vi}
2832 This is a sequence of letters which describes how automatic
2833 formatting is to be done. See |fo-table|. When the 'paste' option is
2834 on, no formatting is done (like 'formatoptions' is empty). Commas can
2835 be inserted for readability.
2836 To avoid problems with flags that are added in the future, use the
2837 "+=" and "-=" feature of ":set" |add-option-flags|.
2838 NOTE: This option is set to the Vi default value when 'compatible' is
2839 set and to the Vim default value when 'compatible' is reset.
2840
Bram Moolenaar86b68352004-12-27 21:59:20 +00002841 *'formatlistpat'* *'flp'*
2842'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2843 local to buffer
2844 {not in Vi}
2845 A pattern that is used to recognize a list header. This is used for
2846 the "n" flag in 'formatoptions'.
2847 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002848 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002849 while still checking more characters. There must be a character
2850 following the pattern, when it matches the whole line it is handled
2851 like there is no match.
2852 The default recognizes a number, followed by an optional punctuation
2853 character and white space.
2854
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 *'formatprg'* *'fp'*
2856'formatprg' 'fp' string (default "")
2857 global
2858 {not in Vi}
2859 The name of an external program that will be used to format the lines
2860 selected with the "gq" command. The program must take the input on
2861 stdin and produce the output on stdout. The Unix program "fmt" is
2862 such a program. If this option is an empty string, the internal
2863 format function will be used |C-indenting|. Environment variables are
2864 expanded |:set_env|. See |option-backslash| about including spaces
2865 and backslashes.
2866 This option cannot be set from a |modeline| or in the |sandbox|, for
2867 security reasons.
2868
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002869 *'fsync'* *'fs'*
2870'fsync' 'fs' boolean (default on)
2871 global
2872 {not in Vi}
2873 When on, the library function fsync() will be called after writing a
2874 file. This will flush a file to disk, ensuring that it is safely
2875 written even on filesystems which do metadata-only journaling. This
2876 will force the harddrive to spin up on Linux systems running in laptop
2877 mode, so it may be undesirable in some situations. Be warned that
2878 turning this off increases the chances of data loss after a crash. On
2879 systems without an fsync() implementation, this variable is always
2880 off.
2881 Also see 'swapsync' for controlling fsync() on swap files.
2882
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2884'gdefault' 'gd' boolean (default off)
2885 global
2886 {not in Vi}
2887 When on, the ":substitute" flag 'g' is default on. This means that
2888 all matches in a line are substituted instead of one. When a 'g' flag
2889 is given to a ":substitute" command, this will toggle the substitution
2890 of all or one match. See |complex-change|.
2891
2892 command 'gdefault' on 'gdefault' off ~
2893 :s/// subst. all subst. one
2894 :s///g subst. one subst. all
2895 :s///gg subst. all subst. one
2896
2897 NOTE: This option is reset when 'compatible' is set.
2898
2899 *'grepformat'* *'gfm'*
2900'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2901 global
2902 {not in Vi}
2903 Format to recognize for the ":grep" command output.
2904 This is a scanf-like string that uses the same format as the
2905 'errorformat' option: see |errorformat|.
2906
2907 *'grepprg'* *'gp'*
2908'grepprg' 'gp' string (default "grep -n ",
2909 Unix: "grep -n $* /dev/null",
2910 Win32: "findstr /n" or "grep -n",
2911 VMS: "SEARCH/NUMBERS ")
2912 global or local to buffer |global-local|
2913 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002914 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002915 and '#' characters, which are expanded like when used in a command-
2916 line. The placeholder "$*" is allowed to specify where the arguments
2917 will be included. Environment variables are expanded |:set_env|. See
2918 |option-backslash| about including spaces and backslashes.
2919 When your "grep" accepts the "-H" argument, use this to make ":grep"
2920 also work well with a single file: >
2921 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002922< Special value: When 'grepprg' is set to "internal" the |:grep| command
2923 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002924 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 apply equally to 'grepprg'.
2926 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2927 otherwise it's "grep -n".
2928 This option cannot be set from a |modeline| or in the |sandbox|, for
2929 security reasons.
2930
2931 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2932'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2933 ve:ver35-Cursor,
2934 o:hor50-Cursor,
2935 i-ci:ver25-Cursor/lCursor,
2936 r-cr:hor20-Cursor/lCursor,
2937 sm:block-Cursor
2938 -blinkwait175-blinkoff150-blinkon175",
2939 for MS-DOS and Win32 console:
2940 "n-v-c:block,o:hor50,i-ci:hor15,
2941 r-cr:hor30,sm:block")
2942 global
2943 {not in Vi}
2944 {only available when compiled with GUI enabled, and
2945 for MS-DOS and Win32 console}
2946 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002947 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 the height of the cursor can be changed. This can be done by
2949 specifying a block cursor, or a percentage for a vertical or
2950 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002951 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 mode-list and an argument-list:
2955 mode-list:argument-list,mode-list:argument-list,..
2956 The mode-list is a dash separated list of these modes:
2957 n Normal mode
2958 v Visual mode
2959 ve Visual mode with 'selection' "exclusive" (same as 'v',
2960 if not specified)
2961 o Operator-pending mode
2962 i Insert mode
2963 r Replace mode
2964 c Command-line Normal (append) mode
2965 ci Command-line Insert mode
2966 cr Command-line Replace mode
2967 sm showmatch in Insert mode
2968 a all modes
2969 The argument-list is a dash separated list of these arguments:
2970 hor{N} horizontal bar, {N} percent of the character height
2971 ver{N} vertical bar, {N} percent of the character width
2972 block block cursor, fills the whole character
2973 [only one of the above three should be present]
2974 blinkwait{N} *cursor-blinking*
2975 blinkon{N}
2976 blinkoff{N}
2977 blink times for cursor: blinkwait is the delay before
2978 the cursor starts blinking, blinkon is the time that
2979 the cursor is shown and blinkoff is the time that the
2980 cursor is not shown. The times are in msec. When one
2981 of the numbers is zero, there is no blinking. The
2982 default is: "blinkwait700-blinkon400-blinkoff250".
2983 These numbers are used for a missing entry. This
2984 means that blinking is enabled by default. To switch
2985 blinking off you can use "blinkon0". The cursor only
2986 blinks when Vim is waiting for input, not while
2987 executing a command.
2988 To make the cursor blink in an xterm, see
2989 |xterm-blink|.
2990 {group-name}
2991 a highlight group name, that sets the color and font
2992 for the cursor
2993 {group-name}/{group-name}
2994 Two highlight group names, the first is used when
2995 no language mappings are used, the other when they
2996 are. |language-mapping|
2997
2998 Examples of parts:
2999 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3000 block cursor with colors from the "nCursor"
3001 highlight group
3002 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3003 In Insert and Command-line Insert mode, use a
3004 30% vertical bar cursor with colors from the
3005 "iCursor" highlight group. Blink a bit
3006 faster.
3007
3008 The 'a' mode is different. It will set the given argument-list for
3009 all modes. It does not reset anything to defaults. This can be used
3010 to do a common setting for all modes. For example, to switch off
3011 blinking: "a:blinkon0"
3012
3013 Examples of cursor highlighting: >
3014 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3015 :highlight Cursor gui=NONE guifg=bg guibg=fg
3016<
3017 *'guifont'* *'gfn'*
3018 *E235* *E596* *E610* *E611*
3019'guifont' 'gfn' string (default "")
3020 global
3021 {not in Vi}
3022 {only available when compiled with GUI enabled}
3023 This is a list of fonts which will be used for the GUI version of Vim.
3024 In its simplest form the value is just one font name. When
3025 the font cannot be found you will get an error message. To try other
3026 font names a list can be specified, font names separated with commas.
3027 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003028
Bram Moolenaar05159a02005-02-26 23:04:13 +00003029 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3030 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003031
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 Spaces after a comma are ignored. To include a comma in a font name
3033 precede it with a backslash. Setting an option requires an extra
3034 backslash before a space and a backslash. See also
3035 |option-backslash|. For example: >
3036 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003037< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003039
3040 If none of the fonts can be loaded, Vim will keep the current setting.
3041 If an empty font list is given, Vim will try using other resource
3042 settings (for X, it will use the Vim.font resource), and finally it
3043 will try some builtin default which should always be there ("7x13" in
3044 the case of X). The font names given should be "normal" fonts. Vim
3045 will try to find the related bold and italic fonts.
3046
Bram Moolenaar05159a02005-02-26 23:04:13 +00003047 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003048 :set guifont=*
3049< will bring up a font requester, where you can pick the font you want.
3050
3051 The font name depends on the GUI used. See |setting-guifont| for a
3052 way to set 'guifont' for various systems.
3053
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 For the GTK+ 2 GUI the font name looks like this: >
3055 :set guifont=Andale\ Mono\ 11
3056< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003057
3058 For Mac OSX you can use something like this: >
3059 :set guifont=Monaco:h10
3060< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003062 width). An exception is GTK 2: all fonts are accepted, but
3063 mono-spaced fonts look best.
3064
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 To preview a font on X11, you might be able to use the "xfontsel"
3066 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003067
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068 For the Win32 GUI *E244* *E245*
3069 - takes these options in the font name:
3070 hXX - height is XX (points, can be floating-point)
3071 wXX - width is XX (points, can be floating-point)
3072 b - bold
3073 i - italic
3074 u - underline
3075 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003076 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3078 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3079 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003080 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081
3082 Use a ':' to separate the options.
3083 - A '_' can be used in the place of a space, so you don't need to use
3084 backslashes to escape the spaces.
3085 - Examples: >
3086 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3087 :set guifont=Andale_Mono:h7.5:w4.5
3088< See also |font-sizes|.
3089
3090 *'guifontset'* *'gfs'*
3091 *E250* *E252* *E234* *E597* *E598*
3092'guifontset' 'gfs' string (default "")
3093 global
3094 {not in Vi}
3095 {only available when compiled with GUI enabled and
3096 with the |+xfontset| feature}
3097 {not available in the GTK+ 2 GUI}
3098 When not empty, specifies two (or more) fonts to be used. The first
3099 one for normal English, the second one for your special language. See
3100 |xfontset|.
3101 Setting this option also means that all font names will be handled as
3102 a fontset name. Also the ones used for the "font" argument of the
3103 |:highlight| command.
3104 The fonts must match with the current locale. If fonts for the
3105 character sets that the current locale uses are not included, setting
3106 'guifontset' will fail.
3107 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3108 the comma-separated names are alternative names, one of which will be
3109 used. In 'guifontset' the whole string is one fontset name,
3110 including the commas. It is not possible to specify alternative
3111 fontset names.
3112 This example works on many X11 systems: >
3113 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3114<
3115 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3116'guifontwide' 'gfw' string (default "")
3117 global
3118 {not in Vi}
3119 {only available when compiled with GUI enabled}
3120 When not empty, specifies a comma-separated list of fonts to be used
3121 for double-width characters. The first font that can be loaded is
3122 used.
3123 Note: The size of these fonts must be exactly twice as wide as the one
3124 specified with 'guifont' and the same height.
3125
3126 All GUI versions but GTK+ 2:
3127
3128 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3129 'guifontset' is empty or invalid.
3130 When 'guifont' is set and a valid font is found in it and
3131 'guifontwide' is empty Vim will attempt to find a matching
3132 double-width font and set 'guifontwide' to it.
3133
3134 GTK+ 2 GUI only: *guifontwide_gtk2*
3135
3136 If set and valid, 'guifontwide' is always used for double width
3137 characters, even if 'encoding' is not set to "utf-8".
3138 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003139 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 font for characters not available in 'guifont'. Thus you do not need
3141 to set 'guifontwide' at all unless you want to override the choice
3142 made by Pango/Xft.
3143
3144 *'guiheadroom'* *'ghr'*
3145'guiheadroom' 'ghr' number (default 50)
3146 global
3147 {not in Vi} {only for GTK and X11 GUI}
3148 The number of pixels subtracted from the screen height when fitting
3149 the GUI window on the screen. Set this before the GUI is started,
3150 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003151 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 lines will be left for window decorations and other items on the
3153 screen. Set it to a negative value to allow windows taller than the
3154 screen.
3155
3156 *'guioptions'* *'go'*
3157'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003158 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 global
3160 {not in Vi}
3161 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003162 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 sequence of letters which describes what components and options of the
3164 GUI should be used.
3165 To avoid problems with flags that are added in the future, use the
3166 "+=" and "-=" feature of ":set" |add-option-flags|.
3167
3168 Valid letters are as follows:
3169 *guioptions_a*
3170 'a' Autoselect: If present, then whenever VISUAL mode is started,
3171 or the Visual area extended, Vim tries to become the owner of
3172 the windowing system's global selection. This means that the
3173 Visually highlighted text is available for pasting into other
3174 applications as well as into Vim itself. When the Visual mode
3175 ends, possibly due to an operation on the text, or when an
3176 application wants to paste the selection, the highlighted text
3177 is automatically yanked into the "* selection register.
3178 Thus the selection is still available for pasting into other
3179 applications after the VISUAL mode has ended.
3180 If not present, then Vim won't become the owner of the
3181 windowing system's global selection unless explicitly told to
3182 by a yank or delete operation for the "* register.
3183 The same applies to the modeless selection.
3184
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003185 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186 applies to the modeless selection.
3187
3188 'guioptions' autoselect Visual autoselect modeless ~
3189 "" - -
3190 "a" yes yes
3191 "A" - yes
3192 "aA" yes yes
3193
3194 'c' Use console dialogs instead of popup dialogs for simple
3195 choices.
3196
3197 'f' Foreground: Don't use fork() to detach the GUI from the shell
3198 where it was started. Use this for programs that wait for the
3199 editor to finish (e.g., an e-mail program). Alternatively you
3200 can use "gvim -f" or ":gui -f" to start the GUI in the
3201 foreground. |gui-fork|
3202 Note: Set this option in the vimrc file. The forking may have
3203 happened already when the gvimrc file is read.
3204
3205 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3206 corner of the window. It's black&white on non-GTK, because of
3207 limitations of X11. For a color icon, see |X11-icon|.
3208
3209 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003210 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 that this flag must be added in the .vimrc file, before
3212 switching on syntax or filetype recognition (when the .gvimrc
3213 file is sourced the system menu has already been loaded; the
3214 ":syntax on" and ":filetype on" commands load the menu too).
3215 'g' Grey menu items: Make menu items that are not active grey. If
3216 'g' is not included inactive menu items are not shown at all.
3217 Exception: Athena will always use grey menu items.
3218
3219 't' Include tearoff menu items. Currently only works for Win32,
3220 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003221 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3222 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223
3224 'r' Right-hand scrollbar is always present.
3225 'R' Right-hand scrollbar is present when there is a vertically
3226 split window.
3227 'l' Left-hand scrollbar is always present.
3228 'L' Left-hand scrollbar is present when there is a vertically
3229 split window.
3230 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3231 the longest visible line, or on the cursor line if the 'h'
3232 flag is included. |gui-horiz-scroll|
3233 'h' Limit horizontal scrollbar size to the length of the cursor
3234 line. Reduces computations. |gui-horiz-scroll|
3235
3236 And yes, you may even have scrollbars on the left AND the right if
3237 you really want to :-). See |gui-scrollbars| for more information.
3238
3239 'v' Use a vertical button layout for dialogs. When not included,
3240 a horizontal layout is preferred, but when it doesn't fit a
3241 vertical layout is used anyway.
3242 'p' Use Pointer callbacks for X11 GUI. This is required for some
3243 window managers. If the cursor is not blinking or hollow at
3244 the right moment, try adding this flag. This must be done
3245 before starting the GUI. Set it in your gvimrc. Adding or
3246 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003247 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248
3249 *'guipty'* *'noguipty'*
3250'guipty' boolean (default on)
3251 global
3252 {not in Vi}
3253 {only available when compiled with GUI enabled}
3254 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3255 I/O to/from shell commands. See |gui-pty|.
3256
3257 *'helpfile'* *'hf'*
3258'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3259 (others) "$VIMRUNTIME/doc/help.txt")
3260 global
3261 {not in Vi}
3262 Name of the main help file. All distributed help files should be
3263 placed together in one directory. Additionally, all "doc" directories
3264 in 'runtimepath' will be used.
3265 Environment variables are expanded |:set_env|. For example:
3266 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003267 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 spaces and backslashes.
3269 This option cannot be set from a |modeline| or in the |sandbox|, for
3270 security reasons.
3271
3272 *'helpheight'* *'hh'*
3273'helpheight' 'hh' number (default 20)
3274 global
3275 {not in Vi}
3276 {not available when compiled without the +windows
3277 feature}
3278 Minimal initial height of the help window when it is opened with the
3279 ":help" command. The initial height of the help window is half of the
3280 current window, or (when the 'ea' option is on) the same as other
3281 windows. When the height is less than 'helpheight', the height is
3282 set to 'helpheight'. Set to zero to disable.
3283
3284 *'helplang'* *'hlg'*
3285'helplang' 'hlg' string (default: messages language or empty)
3286 global
3287 {only available when compiled with the |+multi_lang|
3288 feature}
3289 {not in Vi}
3290 Comma separated list of languages. Vim will use the first language
3291 for which the desired help can be found. The English help will always
3292 be used as a last resort. You can add "en" to prefer English over
3293 another language, but that will only find tags that exist in that
3294 language and not in the English help.
3295 Example: >
3296 :set helplang=de,it
3297< This will first search German, then Italian and finally English help
3298 files.
3299 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3300 try to find the tag in the current language before using this option.
3301 See |help-translated|.
3302
3303 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3304'hidden' 'hid' boolean (default off)
3305 global
3306 {not in Vi}
3307 When off a buffer is unloaded when it is |abandon|ed. When on a
3308 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3309 displayed in another window, it does not become hidden, of course.
3310 The commands that move through the buffer list sometimes make a buffer
3311 hidden although the 'hidden' option is off: When the buffer is
3312 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003314 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 This option is set for one command with ":hide {command}" |:hide|.
3316 WARNING: It's easy to forget that you have changes in hidden buffers.
3317 Think twice when using ":q!" or ":qa!".
3318
3319 *'highlight'* *'hl'*
3320'highlight' 'hl' string (default (as a single string):
3321 "8:SpecialKey,@:NonText,d:Directory,
3322 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3323 M:ModeMsg,n:LineNr,r:Question,
3324 s:StatusLine,S:StatusLineNC,c:VertSplit
3325 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3326 f:Folded,F:FoldColumn,A:DiffAdd,
3327 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003328 >:SignColumn,B:SpellBad,P:SpellCap,
3329 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 global
3331 {not in Vi}
3332 This option can be used to set highlighting mode for various
3333 occasions. It is a comma separated list of character pairs. The
3334 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3337 |hl-NonText| @ '~' and '@' at the end of the window and
3338 characters from 'showbreak'
3339 |hl-Directory| d directories in CTRL-D listing and other special
3340 things in listings
3341 |hl-ErrorMsg| e error messages
3342 h (obsolete, ignored)
3343 |hl-IncSearch| i 'incsearch' highlighting
3344 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3345 |hl-MoreMsg| m |more-prompt|
3346 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3347 |hl-LineNr| n line number for ":number" and ":#" commands
3348 |hl-Question| r |hit-enter| prompt and yes/no questions
3349 |hl-StatusLine| s status line of current window |status-line|
3350 |hl-StatusLineNC| S status lines of not-current windows
3351 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3352 |hl-VertSplit| c column used to separate vertically split windows
3353 |hl-Visual| v Visual mode
3354 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3355 Selection" Only X11 Gui's |gui-x11| and
3356 |xterm-clipboard|.
3357 |hl-WarningMsg| w warning messages
3358 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3359 |hl-Folded| f line used for closed folds
3360 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003361 |hl-DiffAdd| A added line in diff mode
3362 |hl-DiffChange| C changed line in diff mode
3363 |hl-DiffDelete| D deleted line in diff mode
3364 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003366 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003367 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003368 |hl-SpellRare| R rare word |spell|
3369 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370
3371 The display modes are:
3372 r reverse (termcap entry "mr" and "me")
3373 i italic (termcap entry "ZH" and "ZR")
3374 b bold (termcap entry "md" and "me")
3375 s standout (termcap entry "so" and "se")
3376 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003377 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 n no highlighting
3379 - no highlighting
3380 : use a highlight group
3381 The default is used for occasions that are not included.
3382 If you want to change what the display modes do, see |dos-colors|
3383 for an example.
3384 When using the ':' display mode, this must be followed by the name of
3385 a highlight group. A highlight group can be used to define any type
3386 of highlighting, including using color. See |:highlight| on how to
3387 define one. The default uses a different group for each occasion.
3388 See |highlight-default| for the default highlight groups.
3389
3390 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3391'hlsearch' 'hls' boolean (default off)
3392 global
3393 {not in Vi}
3394 {not available when compiled without the
3395 |+extra_search| feature}
3396 When there is a previous search pattern, highlight all its matches.
3397 The type of highlighting used can be set with the 'l' occasion in the
3398 'highlight' option. This uses the "Search" highlight group by
3399 default. Note that only the matching text is highlighted, any offsets
3400 are not applied.
3401 See also: 'incsearch' and |:match|.
3402 When you get bored looking at the highlighted matches, you can turn it
3403 off with |:nohlsearch|. As soon as you use a search command, the
3404 highlighting comes back.
3405 When the search pattern can match an end-of-line, Vim will try to
3406 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003407 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003408 line below a closed fold. A match in a previous line which is not
3409 drawn may not continue in an newly drawn line.
3410 NOTE: This option is reset when 'compatible' is set.
3411
3412 *'history'* *'hi'*
3413'history' 'hi' number (Vim default: 20, Vi default: 0)
3414 global
3415 {not in Vi}
3416 A history of ":" commands, and a history of previous search patterns
3417 are remembered. This option decides how many entries may be stored in
3418 each of these histories (see |cmdline-editing|).
3419 NOTE: This option is set to the Vi default value when 'compatible' is
3420 set and to the Vim default value when 'compatible' is reset.
3421
3422 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3423'hkmap' 'hk' boolean (default off)
3424 global
3425 {not in Vi}
3426 {only available when compiled with the |+rightleft|
3427 feature}
3428 When on, the keyboard is mapped for the Hebrew character set.
3429 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3430 toggle this option. See |rileft.txt|.
3431 NOTE: This option is reset when 'compatible' is set.
3432
3433 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3434'hkmapp' 'hkp' boolean (default off)
3435 global
3436 {not in Vi}
3437 {only available when compiled with the |+rightleft|
3438 feature}
3439 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3440 This is useful if you have a non-Hebrew keyboard.
3441 See |rileft.txt|.
3442 NOTE: This option is reset when 'compatible' is set.
3443
3444 *'icon'* *'noicon'*
3445'icon' boolean (default off, on when title can be restored)
3446 global
3447 {not in Vi}
3448 {not available when compiled without the |+title|
3449 feature}
3450 When on, the icon text of the window will be set to the value of
3451 'iconstring' (if it is not empty), or to the name of the file
3452 currently being edited. Only the last part of the name is used.
3453 Overridden by the 'iconstring' option.
3454 Only works if the terminal supports setting window icons (currently
3455 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3456 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3457 builtin termcap).
3458 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003459 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 X11.
3461
3462 *'iconstring'*
3463'iconstring' string (default "")
3464 global
3465 {not in Vi}
3466 {not available when compiled without the |+title|
3467 feature}
3468 When this option is not empty, it will be used for the icon text of
3469 the window. This happens only when the 'icon' option is on.
3470 Only works if the terminal supports setting window icon text
3471 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3472 Does not work for MS Windows.
3473 When Vim was compiled with HAVE_X11 defined, the original icon will be
3474 restored if possible |X11|.
3475 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003476 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 'titlestring' for example settings.
3478 {not available when compiled without the |+statusline| feature}
3479
3480 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3481'ignorecase' 'ic' boolean (default off)
3482 global
3483 Ignore case in search patterns. Also used when searching in the tags
3484 file.
3485 Also see 'smartcase'.
3486 Can be overruled by using "\c" or "\C" in the pattern, see
3487 |/ignorecase|.
3488
3489 *'imactivatekey'* *'imak'*
3490'imactivatekey' 'imak' string (default "")
3491 global
3492 {not in Vi}
3493 {only available when compiled with |+xim| and
3494 |+GUI_GTK|}
3495 Specifies the key that your Input Method in X-Windows uses for
3496 activation. When this is specified correctly, vim can fully control
3497 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3498 You can't use this option to change the activation key, the option
3499 tells Vim what the key is.
3500 Format:
3501 [MODIFIER_FLAG-]KEY_STRING
3502
3503 These characters can be used for MODIFIER_FLAG (case is ignored):
3504 S Shift key
3505 L Lock key
3506 C Control key
3507 1 Mod1 key
3508 2 Mod2 key
3509 3 Mod3 key
3510 4 Mod4 key
3511 5 Mod5 key
3512 Combinations are allowed, for example "S-C-space" or "SC-space" are
3513 both shift+ctrl+space.
3514 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3515
3516 Example: >
3517 :set imactivatekey=S-space
3518< "S-space" means shift+space. This is the activation key for kinput2 +
3519 canna (Japanese), and ami (Korean).
3520
3521 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3522'imcmdline' 'imc' boolean (default off)
3523 global
3524 {not in Vi}
3525 {only available when compiled with the |+xim|
3526 |+multi_byte_ime| or |global-ime| feature}
3527 When set the Input Method is always on when starting to edit a command
3528 line, unless entering a search pattern (see 'imsearch' for that).
3529 Setting this option is useful when your input method allows entering
3530 English characters directly, e.g., when it's used to type accented
3531 characters with dead keys.
3532
3533 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3534'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3535 global
3536 {not in Vi}
3537 {only available when compiled with the |+xim|
3538 |+multi_byte_ime| or |global-ime| feature}
3539 When set the Input Method is never used. This is useful to disable
3540 the IM when it doesn't work properly.
3541 Currently this option is on by default for SGI/IRIX machines. This
3542 may change in later releases.
3543
3544 *'iminsert'* *'imi'*
3545'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3546 local to buffer
3547 {not in Vi}
3548 Specifies whether :lmap or an Input Method (IM) is to be used in
3549 Insert mode. Valid values:
3550 0 :lmap is off and IM is off
3551 1 :lmap is ON and IM is off
3552 2 :lmap is off and IM is ON
3553 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3554 or |global-ime|.
3555 To always reset the option to zero when leaving Insert mode with <Esc>
3556 this can be used: >
3557 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3558< This makes :lmap and IM turn off automatically when leaving Insert
3559 mode.
3560 Note that this option changes when using CTRL-^ in Insert mode
3561 |i_CTRL-^|.
3562 The value is set to 1 when setting 'keymap' to a valid keymap name.
3563 It is also used for the argument of commands like "r" and "f".
3564 The value 0 may not work correctly with Athena and Motif with some XIM
3565 methods. Use 'imdisable' to disable XIM then.
3566
3567 *'imsearch'* *'ims'*
3568'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3569 local to buffer
3570 {not in Vi}
3571 Specifies whether :lmap or an Input Method (IM) is to be used when
3572 entering a search pattern. Valid values:
3573 -1 the value of 'iminsert' is used, makes it look like
3574 'iminsert' is also used when typing a search pattern
3575 0 :lmap is off and IM is off
3576 1 :lmap is ON and IM is off
3577 2 :lmap is off and IM is ON
3578 Note that this option changes when using CTRL-^ in Command-line mode
3579 |c_CTRL-^|.
3580 The value is set to 1 when it is not -1 and setting the 'keymap'
3581 option to a valid keymap name.
3582 The value 0 may not work correctly with Athena and Motif with some XIM
3583 methods. Use 'imdisable' to disable XIM then.
3584
3585 *'include'* *'inc'*
3586'include' 'inc' string (default "^\s*#\s*include")
3587 global or local to buffer |global-local|
3588 {not in Vi}
3589 {not available when compiled without the
3590 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003591 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 pattern, just like for the "/" command (See |pattern|). The default
3593 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003594 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 name that comes after the matched pattern. See |option-backslash|
3596 about including spaces and backslashes.
3597
3598 *'includeexpr'* *'inex'*
3599'includeexpr' 'inex' string (default "")
3600 local to buffer
3601 {not in Vi}
3602 {not available when compiled without the
3603 |+find_in_path| or |+eval| feature}
3604 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003605 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 :set includeexpr=substitute(v:fname,'\\.','/','g')
3607< The "v:fname" variable will be set to the file name that was detected.
3608 Evaluated in the |sandbox|.
3609 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003610 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 Also used for |<cfile>|.
3612
3613 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3614'incsearch' 'is' boolean (default off)
3615 global
3616 {not in Vi}
3617 {not available when compiled without the
3618 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003619 While typing a search command, show where the pattern, as it was typed
3620 so far, matches. The matched string is highlighted. If the pattern
3621 is invalid or not found, nothing is shown. The screen will be updated
3622 often, this is only useful on fast terminals.
3623 Note that the match will be shown, but the cursor will return to its
3624 original position when no match is found and when pressing <Esc>. You
3625 still need to finish the search command with <Enter> to move the
3626 cursor to the match.
3627 The highlighting can be set with the 'i' flag in 'highlight'.
3628 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 NOTE: This option is reset when 'compatible' is set.
3630
3631 *'indentexpr'* *'inde'*
3632'indentexpr' 'inde' string (default "")
3633 local to buffer
3634 {not in Vi}
3635 {not available when compiled without the |+cindent|
3636 or |+eval| features}
3637 Expression which is evaluated to obtain the proper indent for a line.
3638 It is used when a new line is created, for the |=| operator and
3639 in Insert mode as specified with the 'indentkeys' option.
3640 When this option is not empty, it overrules the 'cindent' and
3641 'smartindent' indenting.
3642 When 'paste' is set this option is not used for indenting.
3643 The expression is evaluated with |v:lnum| set to the line number for
3644 which the indent is to be computed. The cursor is also as this line
3645 when the expression is evaluated (but it may be moved around).
3646 The expression must return the number of spaces worth of indent. It
3647 can return "-1" to keep the current indent (this means 'autoindent' is
3648 used for the indent).
3649 Functions useful for computing the indent are |indent()|, |cindent()|
3650 and |lispindent()|.
3651 The evaluation of the expression must not have side effects! It must
3652 not change the text, jump to another window, etc. Afterwards the
3653 cursor position is always restored, thus the cursor may be moved.
3654 Normally this option would be set to call a function: >
3655 :set indentexpr=GetMyIndent()
3656< Error messages will be suppressed, unless the 'debug' option contains
3657 "msg".
3658 See |indent-expression|. Also see |eval-sandbox|.
3659 NOTE: This option is made empty when 'compatible' is set.
3660
3661 *'indentkeys'* *'indk'*
3662'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3663 local to buffer
3664 {not in Vi}
3665 {not available when compiled without the |+cindent|
3666 feature}
3667 A list of keys that, when typed in Insert mode, cause reindenting of
3668 the current line. Only happens if 'indentexpr' isn't empty.
3669 The format is identical to 'cinkeys', see |indentkeys-format|.
3670 See |C-indenting| and |indent-expression|.
3671
3672 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3673'infercase' 'inf' boolean (default off)
3674 local to buffer
3675 {not in Vi}
3676 When doing keyword completion in insert mode |ins-completion|, and
3677 'ignorecase' is also on, the case of the match is adjusted. If the
3678 typed text contains a lowercase letter where the match has an upper
3679 case letter, the completed part is made lowercase. If the typed text
3680 has no lowercase letters and the match has a lowercase letter where
3681 the typed text has an uppercase letter, and there is a letter before
3682 it, the completed part is made uppercase.
3683
3684 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3685'insertmode' 'im' boolean (default off)
3686 global
3687 {not in Vi}
3688 Makes Vim work in a way that Insert mode is the default mode. Useful
3689 if you want to use Vim as a modeless editor. Used for |evim|.
3690 These Insert mode commands will be useful:
3691 - Use the cursor keys to move around.
3692 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3693 this is a mapping, it is executed as if 'insertmode' was off.
3694 Normal mode remains active until the mapping is finished.
3695 *i_CTRL-L*
3696 - Use CTRL-L to execute a number of Normal mode commands, then use
3697 <Esc> to get back to Insert mode.
3698
3699 These items change when 'insertmode' is set:
3700 - when starting to edit of a file, Vim goes to Insert mode.
3701 - <Esc> in Insert mode is a no-op and beeps.
3702 - <Esc> in Normal mode makes Vim go to Insert mode.
3703 - CTRL-L in Insert mode is a command, it is not inserted.
3704 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3705 However, when <Esc> is used inside a mapping, it behaves like
3706 'insertmode' was not set. This was done to be able to use the same
3707 mappings with 'insertmode' set or not set.
3708 When executing commands with |:normal| 'insertmode' is not used.
3709
3710 NOTE: This option is reset when 'compatible' is set.
3711
3712 *'isfname'* *'isf'*
3713'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3714 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3715 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3716 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3717 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3718 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3719 global
3720 {not in Vi}
3721 The characters specified by this option are included in file names and
3722 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003723 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 Multi-byte characters 256 and above are always included, only the
3725 characters up to 255 are specified with this option.
3726 For UTF-8 the characters 0xa0 to 0xff are included as well.
3727
3728 Note that on systems using a backslash as path separator, Vim tries to
3729 do its best to make it work as you would expect. That is a bit
3730 tricky, since Vi originally used the backslash to escape special
3731 characters. Vim will not remove a backslash in front of a normal file
3732 name character on these systems, but it will on Unix and alikes. The
3733 '&' and '^' are not included by default, because these are special for
3734 cmd.exe.
3735
3736 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003737 Each part can be a single character number or a range. A range is two
3738 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 decimal number between 0 and 255 or the ASCII character itself (does
3740 not work for digits). Example:
3741 "_,-,128-140,#-43" (include '_' and '-' and the range
3742 128 to 140 and '#' to 43)
3743 If a part starts with '^', the following character number or range
3744 will be excluded from the option. The option is interpreted from left
3745 to right. Put the excluded character after the range where it is
3746 included. To include '^' itself use it as the last character of the
3747 option or the end of a range. Example:
3748 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3749 If the character is '@', all characters where isalpha() returns TRUE
3750 are included. Normally these are the characters a to z and A to Z,
3751 plus accented characters. To include '@' itself use "@-@". Examples:
3752 "@,^a-z" All alphabetic characters, excluding lower
3753 case letters.
3754 "a-z,A-Z,@-@" All letters plus the '@' character.
3755 A comma can be included by using it where a character number is
3756 expected. Example:
3757 "48-57,,,_" Digits, comma and underscore.
3758 A comma can be excluded by prepending a '^'. Example:
3759 " -~,^,,9" All characters from space to '~', excluding
3760 comma, plus <Tab>.
3761 See |option-backslash| about including spaces and backslashes.
3762
3763 *'isident'* *'isi'*
3764'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3765 "@,48-57,_,128-167,224-235"
3766 otherwise: "@,48-57,_,192-255")
3767 global
3768 {not in Vi}
3769 The characters given by this option are included in identifiers.
3770 Identifiers are used in recognizing environment variables and after a
3771 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003772 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 option.
3774 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003775 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3777
3778 *'iskeyword'* *'isk'*
3779'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3780 "@,48-57,_,128-167,224-235"
3781 otherwise: "@,48-57,_,192-255"
3782 Vi default: "@,48-57,_")
3783 local to buffer
3784 {not in Vi}
3785 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003786 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'isfname' for a description of the format of this option. For C
3788 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3789 For a help file it is set to all non-blank printable characters except
3790 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3791 command).
3792 When the 'lisp' option is on the '-' character is always included.
3793 NOTE: This option is set to the Vi default value when 'compatible' is
3794 set and to the Vim default value when 'compatible' is reset.
3795
3796 *'isprint'* *'isp'*
3797'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3798 "@,~-255"; otherwise: "@,161-255")
3799 global
3800 {not in Vi}
3801 The characters given by this option are displayed directly on the
3802 screen. It is also used for "\p" in a |pattern|. The characters from
3803 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3804 even when they are not included in 'isprint' or excluded. See
3805 'isfname' for a description of the format of this option.
3806
3807 Non-printable characters are displayed with two characters:
3808 0 - 31 "^@" - "^_"
3809 32 - 126 always single characters
3810 127 "^?"
3811 128 - 159 "~@" - "~_"
3812 160 - 254 "| " - "|~"
3813 255 "~?"
3814 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3815 displayed as <xx>, with the hexadecimal value of the byte.
3816 When 'display' contains "uhex" all unprintable characters are
3817 displayed as <xx>.
3818 The NonText highlighting will be used for unprintable characters.
3819 |hl-NonText|
3820
3821 Multi-byte characters 256 and above are always included, only the
3822 characters up to 255 are specified with this option. When a character
3823 is printable but it is not available in the current font, a
3824 replacement character will be shown.
3825 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3826 There is no option to specify these characters.
3827
3828 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3829'joinspaces' 'js' boolean (default on)
3830 global
3831 {not in Vi}
3832 Insert two spaces after a '.', '?' and '!' with a join command.
3833 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3834 Otherwise only one space is inserted.
3835 NOTE: This option is set when 'compatible' is set.
3836
3837 *'key'*
3838'key' string (default "")
3839 local to buffer
3840 {not in Vi}
3841 The key that is used for encrypting and decrypting the current buffer.
3842 See |encryption|.
3843 Careful: Do not set the key value by hand, someone might see the typed
3844 key. Use the |:X| command. But you can make 'key' empty: >
3845 :set key=
3846< It is not possible to get the value of this option with ":set key" or
3847 "echo &key". This is to avoid showing it to someone who shouldn't
3848 know. It also means you cannot see it yourself once you have set it,
3849 be careful not to make a typing error!
3850
3851 *'keymap'* *'kmp'* *E544*
3852'keymap' 'kmp' string (default "")
3853 local to buffer
3854 {not in Vi}
3855 {only available when compiled with the |+keymap|
3856 feature}
3857 Name of a keyboard mapping. See |mbyte-keymap|.
3858 Setting this option to a valid keymap name has the side effect of
3859 setting 'iminsert' to one, so that the keymap becomes effective.
3860 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003861 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003862
3863 *'keymodel'* *'km'*
3864'keymodel' 'km' string (default "")
3865 global
3866 {not in Vi}
3867 List of comma separated words, which enable special things that keys
3868 can do. These values can be used:
3869 startsel Using a shifted special key starts selection (either
3870 Select mode or Visual mode, depending on "key" being
3871 present in 'selectmode').
3872 stopsel Using a not-shifted special key stops selection.
3873 Special keys in this context are the cursor keys, <End>, <Home>,
3874 <PageUp> and <PageDown>.
3875 The 'keymodel' option is set by the |:behave| command.
3876
3877 *'keywordprg'* *'kp'*
3878'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3879 OS/2: "view /", VMS: "help")
3880 global or local to buffer |global-local|
3881 {not in Vi}
3882 Program to use for the |K| command. Environment variables are
3883 expanded |:set_env|. ":help" may be used to access the Vim internal
3884 help. (Note that previously setting the global option to the empty
3885 value did this, which is now deprecated.)
3886 When "man" is used, Vim will automatically translate a count for the
3887 "K" command to a section number. Also for "man -s", in which case the
3888 "-s" is removed when there is no count.
3889 See |option-backslash| about including spaces and backslashes.
3890 Example: >
3891 :set keywordprg=man\ -s
3892< This option cannot be set from a |modeline| or in the |sandbox|, for
3893 security reasons.
3894
3895 *'langmap'* *'lmap'* *E357* *E358*
3896'langmap' 'lmap' string (default "")
3897 global
3898 {not in Vi}
3899 {only available when compiled with the |+langmap|
3900 feature}
3901 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003902 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 inserted directly. When in command mode the 'langmap' option takes
3904 care of translating these special characters to the original meaning
3905 of the key. This means you don't have to change the keyboard mode to
3906 be able to execute Normal mode commands.
3907 This is the opposite of the 'keymap' option, where characters are
3908 mapped in Insert mode.
3909 This only works for 8-bit characters. The value of 'langmap' may be
3910 specified with multi-byte characters (e.g., UTF-8), but only the lower
3911 8 bits of each character will be used.
3912
3913 Example (for Greek): *greek* >
3914 :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
3915< Example (exchanges meaning of z and y for commands): >
3916 :set langmap=zy,yz,ZY,YZ
3917<
3918 The 'langmap' option is a list of parts, separated with commas. Each
3919 part can be in one of two forms:
3920 1. A list of pairs. Each pair is a "from" character immediately
3921 followed by the "to" character. Examples: "aA", "aAbBcC".
3922 2. A list of "from" characters, a semi-colon and a list of "to"
3923 characters. Example: "abc;ABC"
3924 Example: "aA,fgh;FGH,cCdDeE"
3925 Special characters need to be preceded with a backslash. These are
3926 ";", ',' and backslash itself.
3927
3928 This will allow you to activate vim actions without having to switch
3929 back and forth between the languages. Your language characters will
3930 be understood as normal vim English characters (according to the
3931 langmap mappings) in the following cases:
3932 o Normal/Visual mode (commands, buffer/register names, user mappings)
3933 o Insert/Replace Mode: Register names after CTRL-R
3934 o Insert/Replace Mode: Mappings
3935 Characters entered in Command-line mode will NOT be affected by
3936 this option. Note that this option can be changed at any time
3937 allowing to switch between mappings for different languages/encodings.
3938 Use a mapping to avoid having to type it each time!
3939
3940 *'langmenu'* *'lm'*
3941'langmenu' 'lm' string (default "")
3942 global
3943 {not in Vi}
3944 {only available when compiled with the |+menu| and
3945 |+multi_lang| features}
3946 Language to use for menu translation. Tells which file is loaded
3947 from the "lang" directory in 'runtimepath': >
3948 "lang/menu_" . &langmenu . ".vim"
3949< (without the spaces). For example, to always use the Dutch menus, no
3950 matter what $LANG is set to: >
3951 :set langmenu=nl_NL.ISO_8859-1
3952< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003953 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 If your $LANG is set to a non-English language but you do want to use
3955 the English menus: >
3956 :set langmenu=none
3957< This option must be set before loading menus, switching on filetype
3958 detection or syntax highlighting. Once the menus are defined setting
3959 this option has no effect. But you could do this: >
3960 :source $VIMRUNTIME/delmenu.vim
3961 :set langmenu=de_DE.ISO_8859-1
3962 :source $VIMRUNTIME/menu.vim
3963< Warning: This deletes all menus that you defined yourself!
3964
3965 *'laststatus'* *'ls'*
3966'laststatus' 'ls' number (default 1)
3967 global
3968 {not in Vi}
3969 The value of this option influences when the last window will have a
3970 status line:
3971 0: never
3972 1: only if there are at least two windows
3973 2: always
3974 The screen looks nicer with a status line if you have several
3975 windows, but it takes another screen line. |status-line|
3976
3977 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3978'lazyredraw' 'lz' boolean (default off)
3979 global
3980 {not in Vi}
3981 When this option is set, the screen will not be redrawn while
3982 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003983 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 update use |:redraw|.
3985
3986 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3987'linebreak' 'lbr' boolean (default off)
3988 local to window
3989 {not in Vi}
3990 {not available when compiled without the |+linebreak|
3991 feature}
3992 If on Vim will wrap long lines at a character in 'breakat' rather
3993 than at the last character that fits on the screen. Unlike
3994 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3995 it only affects the way the file is displayed, not its contents. The
3996 value of 'showbreak' is used to put in front of wrapped lines.
3997 This option is not used when the 'wrap' option is off or 'list' is on.
3998 Note that <Tab> characters after an <EOL> are mostly not displayed
3999 with the right amount of white space.
4000
4001 *'lines'* *E593*
4002'lines' number (default 24 or terminal height)
4003 global
4004 Number of lines of the Vim window.
4005 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004006 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 When Vim is running in the GUI or in a resizable window, setting this
4008 option will cause the window size to be changed. When you only want
4009 to use the size for the GUI, put the command in your |gvimrc| file.
4010 Vim limits the number of lines to what fits on the screen. You can
4011 use this command to get the tallest window possible: >
4012 :set lines=999
4013< If you get less lines than expected, check the 'guiheadroom' option.
4014 When you set this option and Vim is unable to change the physical
4015 number of lines of the display, the display may be messed up.
4016
4017 *'linespace'* *'lsp'*
4018'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4019 global
4020 {not in Vi}
4021 {only in the GUI}
4022 Number of pixel lines inserted between characters. Useful if the font
4023 uses the full character cell height, making lines touch each other.
4024 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004025 With some fonts there can be too much room between lines (to have
4026 space for ascents and descents). Then it makes sense to set
4027 'linespace' to a negative value. This may cause display problems
4028 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029
4030 *'lisp'* *'nolisp'*
4031'lisp' boolean (default off)
4032 local to buffer
4033 {not available when compiled without the |+lispindent|
4034 feature}
4035 Lisp mode: When <Enter> is typed in insert mode set the indent for
4036 the next line to Lisp standards (well, sort of). Also happens with
4037 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4038 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4039 better. Also see 'lispwords'.
4040 The '-' character is included in keyword characters. Redefines the
4041 "=" operator to use this same indentation algorithm rather than
4042 calling an external program if 'equalprg' is empty.
4043 This option is not used when 'paste' is set.
4044 {Vi: Does it a little bit differently}
4045
4046 *'lispwords'* *'lw'*
4047'lispwords' 'lw' string (default is very long)
4048 global
4049 {not in Vi}
4050 {not available when compiled without the |+lispindent|
4051 feature}
4052 Comma separated list of words that influence the Lisp indenting.
4053 |'lisp'|
4054
4055 *'list'* *'nolist'*
4056'list' boolean (default off)
4057 local to window
4058 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4059 see the difference between tabs and spaces and for trailing blanks.
4060 Note that this will also affect formatting (set with 'textwidth' or
4061 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4062 changing the way tabs are displayed.
4063
4064 *'listchars'* *'lcs'*
4065'listchars' 'lcs' string (default "eol:$")
4066 global
4067 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004068 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069 settings.
4070 eol:c Character to show at the end of each line. When
4071 omitted, there is no extra character at the end of the
4072 line.
4073 tab:xy Two characters to be used to show a Tab. The first
4074 char is used once. The second char is repeated to
4075 fill the space that the Tab normally occupies.
4076 "tab:>-" will show a Tab that takes four spaces as
4077 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004078 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 trailing spaces are blank.
4080 extends:c Character to show in the last column, when 'wrap' is
4081 off and the line continues beyond the right of the
4082 screen.
4083 precedes:c Character to show in the first column, when 'wrap'
4084 is off and there is text preceding the character
4085 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004086 nbsp:c Character to show for a non-breakable space (character
4087 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004089 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 be used when 'encoding' is "utf-8", otherwise only printable
4091 characters are allowed.
4092
4093 Examples: >
4094 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004095 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 :set lcs=extends:>,precedes:<
4097< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004098 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099
4100 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4101'loadplugins' 'lpl' boolean (default on)
4102 global
4103 {not in Vi}
4104 When on the plugin scripts are loaded when starting up |load-plugins|.
4105 This option can be reset in your |vimrc| file to disable the loading
4106 of plugins.
4107 Note that using the "-u NONE" and "--noplugin" command line arguments
4108 reset this option. |-u| |--noplugin|
4109
4110 *'magic'* *'nomagic'*
4111'magic' boolean (default on)
4112 global
4113 Changes the special characters that can be used in search patterns.
4114 See |pattern|.
4115 NOTE: To avoid portability problems with using patterns, always keep
4116 this option at the default "on". Only switch it off when working with
4117 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004118 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119
4120 *'makeef'* *'mef'*
4121'makeef' 'mef' string (default: "")
4122 global
4123 {not in Vi}
4124 {not available when compiled without the |+quickfix|
4125 feature}
4126 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4127 and the |:grep| command.
4128 When it is empty, an internally generated temp file will be used.
4129 When "##" is included, it is replaced by a number to make the name
4130 unique. This makes sure that the ":make" command doesn't overwrite an
4131 existing file.
4132 NOT used for the ":cf" command. See 'errorfile' for that.
4133 Environment variables are expanded |:set_env|.
4134 See |option-backslash| about including spaces and backslashes.
4135 This option cannot be set from a |modeline| or in the |sandbox|, for
4136 security reasons.
4137
4138 *'makeprg'* *'mp'*
4139'makeprg' 'mp' string (default "make", VMS: "MMS")
4140 global or local to buffer |global-local|
4141 {not in Vi}
4142 Program to use for the ":make" command. See |:make_makeprg|. This
4143 option may contain '%' and '#' characters, which are expanded like
4144 when used in a command-line. Environment variables are expanded
4145 |:set_env|. See |option-backslash| about including spaces and
4146 backslashes. Note that a '|' must be escaped twice: once for ":set"
4147 and once for the interpretation of a command. When you use a filter
4148 called "myfilter" do it like this: >
4149 :set makeprg=gmake\ \\\|\ myfilter
4150< The placeholder "$*" can be given (even multiple times) to specify
4151 where the arguments will be included, for example: >
4152 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4153< This option cannot be set from a |modeline| or in the |sandbox|, for
4154 security reasons.
4155
4156 *'matchpairs'* *'mps'*
4157'matchpairs' 'mps' string (default "(:),{:},[:]")
4158 local to buffer
4159 {not in Vi}
4160 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 must be different. The characters must be separated by a colon. The
4163 pairs must be separated by a comma. Example for including '<' and '>'
4164 (HTML): >
4165 :set mps+=<:>
4166
4167< A more exotic example, to jump between the '=' and ';' in an
4168 assignment, useful for languages like C and Java: >
4169 :au FileType c,cpp,java set mps+==:;
4170
4171< For a more advanced way of using "%", see the matchit.vim plugin in
4172 the $VIMRUNTIME/macros directory. |add-local-help|
4173
4174 *'matchtime'* *'mat'*
4175'matchtime' 'mat' number (default 5)
4176 global
4177 {not in Vi}{in Nvi}
4178 Tenths of a second to show the matching paren, when 'showmatch' is
4179 set. Note that this is not in milliseconds, like other options that
4180 set a time. This is to be compatible with Nvi.
4181
4182 *'maxfuncdepth'* *'mfd'*
4183'maxfuncdepth' 'mfd' number (default 100)
4184 global
4185 {not in Vi}
4186 Maximum depth of function calls for user functions. This normally
4187 catches endless recursion. When using a recursive function with
4188 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4189 more memory, there is the danger of failing when memory is exhausted.
4190 See also |:function|.
4191
4192 *'maxmapdepth'* *'mmd'* *E223*
4193'maxmapdepth' 'mmd' number (default 1000)
4194 global
4195 {not in Vi}
4196 Maximum number of times a mapping is done without resulting in a
4197 character to be used. This normally catches endless mappings, like
4198 ":map x y" with ":map y x". It still does not catch ":map g wg",
4199 because the 'w' is used before the next mapping is done. See also
4200 |key-mapping|.
4201
4202 *'maxmem'* *'mm'*
4203'maxmem' 'mm' number (default between 256 to 5120 (system
4204 dependent) or half the amount of memory
4205 available)
4206 global
4207 {not in Vi}
4208 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4209 limit is reached allocating extra memory for a buffer will cause
4210 other memory to be freed. Maximum value 2000000. Use this to work
4211 without a limit. Also see 'maxmemtot'.
4212
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004213 *'maxmempattern'* *'mmp'*
4214'maxmempattern' 'mmp' number (default 1000)
4215 global
4216 {not in Vi}
4217 Maximum amount of memory (in Kbyte) to use for pattern matching.
4218 Maximum value 2000000. Use this to work without a limit.
4219 *E363*
4220 When Vim runs into the limit it gives an error message mostly behaves
4221 like CTRL-C was typed.
4222 Running into the limit often means that the pattern is very
4223 inefficient or too complex. This may already happen with the pattern
4224 "\(.\)*" on a very long line. ".*" works much better.
4225 Vim may run out of memory before hitting the 'maxmempattern' limit.
4226
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 *'maxmemtot'* *'mmt'*
4228'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4229 dependent) or half the amount of memory
4230 available)
4231 global
4232 {not in Vi}
4233 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004234 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235 'maxmem'.
4236
4237 *'menuitems'* *'mis'*
4238'menuitems' 'mis' number (default 25)
4239 global
4240 {not in Vi}
4241 {not available when compiled without the |+menu|
4242 feature}
4243 Maximum number of items to use in a menu. Used for menus that are
4244 generated from a list of items, e.g., the Buffers menu. Changing this
4245 option has no direct effect, the menu must be refreshed first.
4246
4247 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4248'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4249 local to buffer
4250 *'modelines'* *'mls'*
4251'modelines' 'mls' number (default 5)
4252 global
4253 {not in Vi}
4254 If 'modeline' is on 'modelines' gives the number of lines that is
4255 checked for set commands. If 'modeline' is off or 'modelines' is zero
4256 no lines are checked. See |modeline|.
4257 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4258 set and to the Vim default value when 'compatible' is reset.
4259
4260 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4261'modifiable' 'ma' boolean (default on)
4262 local to buffer
4263 {not in Vi} *E21*
4264 When off the buffer contents cannot be changed. The 'fileformat' and
4265 'fileencoding' options also can't be changed.
4266 Can be reset with the |-M| command line argument.
4267
4268 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4269'modified' 'mod' boolean (default off)
4270 local to buffer
4271 {not in Vi}
4272 When on, the buffer is considered to be modified. This option is set
4273 when:
4274 1. A change was made to the text since it was last written. Using the
4275 |undo| command to go back to the original text will reset the
4276 option. But undoing changes that were made before writing the
4277 buffer will set the option again, since the text is different from
4278 when it was written.
4279 2. 'fileformat' or 'fileencoding' is different from its original
4280 value. The original value is set when the buffer is read or
4281 written. A ":set nomodified" command also resets the original
4282 values to the current values and the 'modified' option will be
4283 reset.
4284 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4285 will be ignored.
4286
4287 *'more'* *'nomore'*
4288'more' boolean (Vim default: on, Vi default: off)
4289 global
4290 {not in Vi}
4291 When on, listings pause when the whole screen is filled. You will get
4292 the |more-prompt|. When this option is off there are no pauses, the
4293 listing continues until finished.
4294 NOTE: This option is set to the Vi default value when 'compatible' is
4295 set and to the Vim default value when 'compatible' is reset.
4296
4297 *'mouse'* *E538*
4298'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4299 global
4300 {not in Vi}
4301 Enable the use of the mouse. Only works for certain terminals
4302 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4303 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4304 The mouse can be enabled for different modes:
4305 n Normal mode
4306 v Visual mode
4307 i Insert mode
4308 c Command-line mode
4309 h all previous modes when editing a help file
4310 a all previous modes
4311 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 Normally you would enable the mouse in all four modes with: >
4313 :set mouse=a
4314< When the mouse is not enabled, the GUI will still use the mouse for
4315 modeless selection. This doesn't move the text cursor.
4316
4317 See |mouse-using|. Also see |'clipboard'|.
4318
4319 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004320 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321 the mouse buttons can still be used by keeping the shift key pressed.
4322 Also see the 'clipboard' option.
4323
4324 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4325'mousefocus' 'mousef' boolean (default off)
4326 global
4327 {not in Vi}
4328 {only works in the GUI}
4329 The window that the mouse pointer is on is automatically activated.
4330 When changing the window layout or window focus in another way, the
4331 mouse pointer is moved to the window with keyboard focus. Off is the
4332 default because it makes using the pull down menus a little goofy, as
4333 a pointer transit may activate a window unintentionally.
4334
4335 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4336'mousehide' 'mh' boolean (default on)
4337 global
4338 {not in Vi}
4339 {only works in the GUI}
4340 When on, the mouse pointer is hidden when characters are typed.
4341 The mouse pointer is restored when the mouse is moved.
4342
4343 *'mousemodel'* *'mousem'*
4344'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4345 global
4346 {not in Vi}
4347 Sets the model to use for the mouse. The name mostly specifies what
4348 the right mouse button is used for:
4349 extend Right mouse button extends a selection. This works
4350 like in an xterm.
4351 popup Right mouse button pops up a menu. The shifted left
4352 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004353 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 popup_setpos Like "popup", but the cursor will be moved to the
4355 position where the mouse was clicked, and thus the
4356 selected operation will act upon the clicked object.
4357 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004358 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 course, that right clicking outside a selection will
4360 end Visual mode.
4361 Overview of what button does what for each model:
4362 mouse extend popup(_setpos) ~
4363 left click place cursor place cursor
4364 left drag start selection start selection
4365 shift-left search word extend selection
4366 right click extend selection popup menu (place cursor)
4367 right drag extend selection -
4368 middle click paste paste
4369
4370 In the "popup" model the right mouse button produces a pop-up menu.
4371 You need to define this first, see |popup-menu|.
4372
4373 Note that you can further refine the meaning of buttons with mappings.
4374 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4375 selection (because that's handled in the GUI code directly).
4376
4377 The 'mousemodel' option is set by the |:behave| command.
4378
4379 *'mouseshape'* *'mouses'* *E547*
4380'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004381 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 global
4383 {not in Vi}
4384 {only available when compiled with the |+mouseshape|
4385 feature}
4386 This option tells Vim what the mouse pointer should look like in
4387 different modes. The option is a comma separated list of parts, much
4388 like used for 'guicursor'. Each part consist of a mode/location-list
4389 and an argument-list:
4390 mode-list:shape,mode-list:shape,..
4391 The mode-list is a dash separated list of these modes/locations:
4392 In a normal window: ~
4393 n Normal mode
4394 v Visual mode
4395 ve Visual mode with 'selection' "exclusive" (same as 'v',
4396 if not specified)
4397 o Operator-pending mode
4398 i Insert mode
4399 r Replace mode
4400
4401 Others: ~
4402 c appending to the command-line
4403 ci inserting in the command-line
4404 cr replacing in the command-line
4405 m at the 'Hit ENTER' or 'More' prompts
4406 ml idem, but cursor in the last line
4407 e any mode, pointer below last window
4408 s any mode, pointer on a status line
4409 sd any mode, while dragging a status line
4410 vs any mode, pointer on a vertical separator line
4411 vd any mode, while dragging a vertical separator line
4412 a everywhere
4413
4414 The shape is one of the following:
4415 avail name looks like ~
4416 w x arrow Normal mouse pointer
4417 w x blank no pointer at all (use with care!)
4418 w x beam I-beam
4419 w x updown up-down sizing arrows
4420 w x leftright left-right sizing arrows
4421 w x busy The system's usual busy pointer
4422 w x no The system's usual 'no input' pointer
4423 x udsizing indicates up-down resizing
4424 x lrsizing indicates left-right resizing
4425 x crosshair like a big thin +
4426 x hand1 black hand
4427 x hand2 white hand
4428 x pencil what you write with
4429 x question big ?
4430 x rightup-arrow arrow pointing right-up
4431 w x up-arrow arrow pointing up
4432 x <number> any X11 pointer number (see X11/cursorfont.h)
4433
4434 The "avail" column contains a 'w' if the shape is available for Win32,
4435 x for X11.
4436 Any modes not specified or shapes not available use the normal mouse
4437 pointer.
4438
4439 Example: >
4440 :set mouseshape=s:udsizing,m:no
4441< will make the mouse turn to a sizing arrow over the status lines and
4442 indicate no input when the hit-enter prompt is displayed (since
4443 clicking the mouse has no effect in this state.)
4444
4445 *'mousetime'* *'mouset'*
4446'mousetime' 'mouset' number (default 500)
4447 global
4448 {not in Vi}
4449 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4450 time in msec between two mouse clicks for the second click to be
4451 recognized as a multi click.
4452
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004453 *'mzquantum'* *'mzq'*
4454'mzquantum' 'mzq' number (default 100)
4455 global
4456 {not in Vi}
4457 {not available when compiled without the |+mzscheme|
4458 feature}
4459 The number of milliseconds between polls for MzScheme threads.
4460 Negative or zero value means no thread scheduling.
4461
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462 *'nrformats'* *'nf'*
4463'nrformats' 'nf' string (default "octal,hex")
4464 local to buffer
4465 {not in Vi}
4466 This defines what bases Vim will consider for numbers when using the
4467 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4468 respectively; see |CTRL-A| for more info on these commands.
4469 alpha if included, single alphabetical characters will be
4470 incremented or decremented. This is useful for a list with a
4471 letter index a), b), etc.
4472 octal if included, numbers that start with a zero will be considered
4473 to be octal. Example: Using CTRL-A on "007" results in "010".
4474 hex if included, numbers starting with "0x" or "0X" will be
4475 considered to be hexadecimal. Example: Using CTRL-X on
4476 "0x100" results in "0x0ff".
4477 Numbers which simply begin with a digit in the range 1-9 are always
4478 considered decimal. This also happens for numbers that are not
4479 recognized as octal or hex.
4480
4481 *'number'* *'nu'* *'nonumber'* *'nonu'*
4482'number' 'nu' boolean (default off)
4483 local to window
4484 Print the line number in front of each line. When the 'n' option is
4485 excluded from 'cpoptions' a wrapped line will not use the column of
4486 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004487 The 'numberwidth' option can be used to set the room used for the line
4488 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 When a long, wrapped line doesn't start with the first character, '-'
4490 characters are put before the number.
4491 See |hl-LineNr| for the highlighting used for the number.
4492
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004493 *'numberwidth'* *'nuw'*
4494'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4495 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004496 {not in Vi}
4497 {only available when compiled with the |+linebreak|
4498 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004499 Minimal number of columns to use for the line number. Only relevant
4500 when the 'number' option is set.
4501 Since one space is always between the number and the text, there is
4502 one less character for the number itself.
4503 The value is the minimum width. A bigger width is used when needed to
4504 fit the highest line number in the buffer. Thus with the Vim default
4505 of 4 there is room for a line number up to 999. When the buffer has
4506 1000 lines five columns will be used.
4507 The minimum value is 1, the maximum value is 10.
4508 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4509
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 *'osfiletype'* *'oft'* *E366*
4511'osfiletype' 'oft' string (RISC-OS default: "Text",
4512 others default: "")
4513 local to buffer
4514 {not in Vi}
4515 {only available when compiled with the |+osfiletype|
4516 feature}
4517 Some operating systems store extra information about files besides
4518 name, datestamp and permissions. This option contains the extra
4519 information, the nature of which will vary between systems.
4520 The value of this option is usually set when the file is loaded, and
4521 use to set the file type when file is written.
4522 It can affect the pattern matching of the automatic commands.
4523 |autocmd-osfiletypes|
4524
4525 *'paragraphs'* *'para'*
4526'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4527 global
4528 Specifies the nroff macros that separate paragraphs. These are pairs
4529 of two letters (see |object-motions|).
4530
4531 *'paste'* *'nopaste'*
4532'paste' boolean (default off)
4533 global
4534 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004535 Put Vim in Paste mode. This is useful if you want to cut or copy
4536 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004537 unexpected effects.
4538 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004539 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 knows about pasting and will mostly do the right thing without 'paste'
4541 being set. The same is true for a terminal where Vim handles the
4542 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004543 This option is reset when starting the GUI. Thus if you set it in
4544 your .vimrc it will work in a terminal, but not in the GUI. Setting
4545 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4546 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 When the 'paste' option is switched on (also when it was already on):
4548 - mapping in Insert mode and Command-line mode is disabled
4549 - abbreviations are disabled
4550 - 'textwidth' is set to 0
4551 - 'wrapmargin' is set to 0
4552 - 'autoindent' is reset
4553 - 'smartindent' is reset
4554 - 'softtabstop' is set to 0
4555 - 'revins' is reset
4556 - 'ruler' is reset
4557 - 'showmatch' is reset
4558 - 'formatoptions' is used like it is empty
4559 These options keep their value, but their effect is disabled:
4560 - 'lisp'
4561 - 'indentexpr'
4562 - 'cindent'
4563 NOTE: When you start editing another file while the 'paste' option is
4564 on, settings from the modelines or autocommands may change the
4565 settings again, causing trouble when pasting text. You might want to
4566 set the 'paste' option again.
4567 When the 'paste' option is reset the mentioned options are restored to
4568 the value before the moment 'paste' was switched from off to on.
4569 Resetting 'paste' before ever setting it does not have any effect.
4570 Since mapping doesn't work while 'paste' is active, you need to use
4571 the 'pastetoggle' option to toggle the 'paste' option with some key.
4572
4573 *'pastetoggle'* *'pt'*
4574'pastetoggle' 'pt' string (default "")
4575 global
4576 {not in Vi}
4577 When non-empty, specifies the key sequence that toggles the 'paste'
4578 option. This is like specifying a mapping: >
4579 :map {keys} :set invpaste<CR>
4580< Where {keys} is the value of 'pastetoggle'.
4581 The difference is that it will work even when 'paste' is set.
4582 'pastetoggle' works in Insert mode and Normal mode, but not in
4583 Command-line mode.
4584 Mappings are checked first, thus overrule 'pastetoggle'. However,
4585 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4586 this: >
4587 :map <F10> :set paste<CR>
4588 :map <F11> :set nopaste<CR>
4589 :imap <F10> <C-O>:set paste<CR>
4590 :imap <F11> <nop>
4591 :set pastetoggle=<F11>
4592< This will make <F10> start paste mode and <F11> stop paste mode.
4593 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4594 mode everything is inserted literally, except the 'pastetoggle' key
4595 sequence.
4596
4597 *'pex'* *'patchexpr'*
4598'patchexpr' 'pex' string (default "")
4599 global
4600 {not in Vi}
4601 {not available when compiled without the |+diff|
4602 feature}
4603 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605
4606 *'patchmode'* *'pm'* *E206*
4607'patchmode' 'pm' string (default "")
4608 global
4609 {not in Vi}
4610 When non-empty the oldest version of a file is kept. This can be used
4611 to keep the original version of a file if you are changing files in a
4612 source distribution. Only the first time that a file is written a
4613 copy of the original file will be kept. The name of the copy is the
4614 name of the original file with the string in the 'patchmode' option
4615 appended. This option should start with a dot. Use a string like
4616 ".org". 'backupdir' must not be empty for this to work (Detail: The
4617 backup file is renamed to the patchmode file after the new file has
4618 been successfully written, that's why it must be possible to write a
4619 backup file). If there was no file to be backed up, an empty file is
4620 created.
4621 When the 'backupskip' pattern matches, a patchmode file is not made.
4622 Using 'patchmode' for compressed files appends the extension at the
4623 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4624 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004625 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
4627 *'path'* *'pa'* *E343* *E345* *E347*
4628'path' 'pa' string (default on Unix: ".,/usr/include,,"
4629 on OS/2: ".,/emx/include,,"
4630 other systems: ".,,")
4631 global or local to buffer |global-local|
4632 {not in Vi}
4633 This is a list of directories which will be searched when using the
4634 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4635 being searched for has a relative path (not starting with '/'). The
4636 directories in the 'path' option may be relative or absolute.
4637 - Use commas to separate directory names: >
4638 :set path=.,/usr/local/include,/usr/include
4639< - Spaces can also be used to separate directory names (for backwards
4640 compatibility with version 3.0). To have a space in a directory
4641 name, precede it with an extra backslash, and escape the space: >
4642 :set path=.,/dir/with\\\ space
4643< - To include a comma in a directory name precede it with an extra
4644 backslash: >
4645 :set path=.,/dir/with\\,comma
4646< - To search relative to the directory of the current file, use: >
4647 :set path=.
4648< - To search in the current directory use an empty string between two
4649 commas: >
4650 :set path=,,
4651< - A directory name may end in a ':' or '/'.
4652 - Environment variables are expanded |:set_env|.
4653 - When using |netrw.vim| URLs can be used. For example, adding
4654 "http://www.vim.org" will make ":find index.html" work.
4655 - Search upwards and downwards in a directory tree:
4656 1) "*" matches a sequence of characters, e.g.: >
4657 :set path=/usr/include/*
4658< means all subdirectories in /usr/include (but not /usr/include
4659 itself). >
4660 :set path=/usr/*c
4661< matches /usr/doc and /usr/src.
4662 2) "**" matches a subtree, up to 100 directories deep. Example: >
4663 :set path=/home/user_x/src/**
4664< means search in the whole subtree under "/home/usr_x/src".
4665 3) If the path ends with a ';', this path is the startpoint
4666 for upward search.
4667 See |file-searching| for more info and exact syntax.
4668 {not available when compiled without the |+path_extra| feature}
4669 - Careful with '\' characters, type two to get one in the option: >
4670 :set path=.,c:\\include
4671< Or just use '/' instead: >
4672 :set path=.,c:/include
4673< Don't forget "." or files won't even be found in the same directory as
4674 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004675 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676 it is something like 256 or 1024 characters.
4677 You can check if all the include files are found, using the value of
4678 'path', see |:checkpath|.
4679 The use of |:set+=| and |:set-=| is preferred when adding or removing
4680 directories from the list. This avoids problems when a future version
4681 uses another default. To remove the current directory use: >
4682 :set path-=
4683< To add the current directory use: >
4684 :set path+=
4685< To use an environment variable, you probably need to replace the
4686 separator. Here is an example to append $INCL, in which directory
4687 names are separated with a semi-colon: >
4688 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4689< Replace the ';' with a ':' or whatever separator is used. Note that
4690 this doesn't work when $INCL contains a comma or white space.
4691
4692 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4693'preserveindent' 'pi' boolean (default off)
4694 local to buffer
4695 {not in Vi}
4696 When changing the indent of the current line, preserve as much of the
4697 indent structure as possible. Normally the indent is replaced by a
4698 series of tabs followed by spaces as required (unless |'expandtab'| is
4699 enabled, in which case only spaces are used). Enabling this option
4700 means the indent will preserve as many existing characters as possible
4701 for indenting, and only add additional tabs or spaces as required.
4702 NOTE: When using ">>" multiple times the resulting indent is a mix of
4703 tabs and spaces. You might not like this.
4704 NOTE: 'preserveindent' is reset when 'compatible' is set.
4705 Also see 'copyindent'.
4706 Use |:retab| to clean up white space.
4707
4708 *'previewheight'* *'pvh'*
4709'previewheight' 'pvh' number (default 12)
4710 global
4711 {not in Vi}
4712 {not available when compiled without the |+windows| or
4713 |+quickfix| feature}
4714 Default height for a preview window. Used for |:ptag| and associated
4715 commands. Used for |CTRL-W_}| when no count is given.
4716
4717 *'previewwindow'* *'nopreviewwindow'*
4718 *'pvw'* *'nopvw'* *E590*
4719'previewwindow' 'pvw' boolean (default off)
4720 local to window
4721 {not in Vi}
4722 {not available when compiled without the |+windows| or
4723 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004724 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725 set. It's normally not set directly, but by using one of the commands
4726 |:ptag|, |:pedit|, etc.
4727
4728 *'printdevice'* *'pdev'*
4729'printdevice' 'pdev' string (default empty)
4730 global
4731 {not in Vi}
4732 {only available when compiled with the |+printer|
4733 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004734 The name of the printer to be used for |:hardcopy|.
4735 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004736 This option cannot be set from a |modeline| or in the |sandbox|, for
4737 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738
Bram Moolenaar8299df92004-07-10 09:47:34 +00004739 *'printencoding'* *'penc'*
4740'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 global
4742 {not in Vi}
4743 {only available when compiled with the |+printer|
4744 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004745 Sets the character encoding used when printing.
4746 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747
4748 *'printexpr'* *'pexpr'*
4749'printexpr' 'pexpr' String (default: see below)
4750 global
4751 {not in Vi}
4752 {only available when compiled with the |+printer|
4753 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004754 Expression used to print the PostScript produced with |:hardcopy|.
4755 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756
Bram Moolenaar8299df92004-07-10 09:47:34 +00004757 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758'printfont' 'pfn' string (default "courier")
4759 global
4760 {not in Vi}
4761 {only available when compiled with the |+printer|
4762 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004763 The name of the font that will be used for |:hardcopy|.
4764 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765
4766 *'printheader'* *'pheader'*
4767'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4768 global
4769 {not in Vi}
4770 {only available when compiled with the |+printer|
4771 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004772 The format of the header produced in |:hardcopy| output.
4773 See |pheader-option|.
4774
4775 *'printmbcharset'* *'pmbcs'*
4776'printmbcharset' 'pmbcs' string (default "")
4777 global
4778 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004779 {only available when compiled with the |+printer|,
4780 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004781 The CJK character set to be used for CJK output from |:hardcopy|.
4782 See |pmbcs-option|.
4783
4784 *'printmbfont'* *'pmbfn'*
4785'printmbfont' 'pmbfn' string (default "")
4786 global
4787 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004788 {only available when compiled with the |+printer|,
4789 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004790 List of font names to be used for CJK output from |:hardcopy|.
4791 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004792
4793 *'printoptions'* *'popt'*
4794'printoptions' 'popt' string (default "")
4795 global
4796 {not in Vi}
4797 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004798 List of items that control the format of the output of |:hardcopy|.
4799 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004801 *'prompt'* *'noprompt'*
4802'prompt' boolean (default on)
4803 global
4804 When on a ":" prompt is used in Ex mode.
4805
Bram Moolenaar677ee682005-01-27 14:41:15 +00004806 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004807'quoteescape' 'qe' string (default "\")
4808 local to buffer
4809 {not in Vi}
4810 The characters that are used to escape quotes in a string. Used for
4811 objects like a', a" and a` |a'|.
4812 When one of the characters in this option is found inside a string,
4813 the following character will be skipped. The default value makes the
4814 text "foo\"bar\\" considered to be one string.
4815
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4817'readonly' 'ro' boolean (default off)
4818 local to buffer
4819 If on, writes fail unless you use a '!'. Protects you from
4820 accidentally overwriting a file. Default on when Vim is started
4821 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004822 When using ":w!" the 'readonly' option is reset for the current
4823 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004825 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826
4827 *'remap'* *'noremap'*
4828'remap' boolean (default on)
4829 global
4830 Allows for mappings to work recursively. If you do not want this for
4831 a single entry, use the :noremap[!] command.
4832
4833 *'report'*
4834'report' number (default 2)
4835 global
4836 Threshold for reporting number of lines changed. When the number of
4837 changed lines is more than 'report' a message will be given for most
4838 ":" commands. If you want it always, set 'report' to 0.
4839 For the ":substitute" command the number of substitutions is used
4840 instead of the number of lines.
4841
4842 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4843'restorescreen' 'rs' boolean (default on)
4844 global
4845 {not in Vi} {only in Windows 95/NT console version}
4846 When set, the screen contents is restored when exiting Vim. This also
4847 happens when executing external commands.
4848
4849 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4850 options in your .vimrc. To disable restoring:
4851 set t_ti= t_te=
4852 To enable restoring (for an xterm):
4853 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4854 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4855
4856 *'revins'* *'ri'* *'norevins'* *'nori'*
4857'revins' 'ri' boolean (default off)
4858 global
4859 {not in Vi}
4860 {only available when compiled with the |+rightleft|
4861 feature}
4862 Inserting characters in Insert mode will work backwards. See "typing
4863 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4864 command in Insert mode, when 'allowrevins' is set.
4865 NOTE: This option is reset when 'compatible' or 'paste' is set.
4866
4867 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4868'rightleft' 'rl' boolean (default off)
4869 local to window
4870 {not in Vi}
4871 {only available when compiled with the |+rightleft|
4872 feature}
4873 When on, display orientation becomes right-to-left, i.e., characters
4874 that are stored in the file appear from the right to the left.
4875 Using this option, it is possible to edit files for languages that
4876 are written from the right to the left such as Hebrew and Arabic.
4877 This option is per window, so it is possible to edit mixed files
4878 simultaneously, or to view the same file in both ways (this is
4879 useful whenever you have a mixed text file with both right-to-left
4880 and left-to-right strings so that both sets are displayed properly
4881 in different windows). Also see |rileft.txt|.
4882
4883 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4884'rightleftcmd' 'rlc' string (default "search")
4885 local to window
4886 {not in Vi}
4887 {only available when compiled with the |+rightleft|
4888 feature}
4889 Each word in this option enables the command line editing to work in
4890 right-to-left mode for a group of commands:
4891
4892 search "/" and "?" commands
4893
4894 This is useful for languages such as Hebrew, Arabic and Farsi.
4895 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4896
4897 *'ruler'* *'ru'* *'noruler'* *'noru'*
4898'ruler' 'ru' boolean (default off)
4899 global
4900 {not in Vi}
4901 {not available when compiled without the
4902 |+cmdline_info| feature}
4903 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004904 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 text in the file is shown on the far right:
4906 Top first line is visible
4907 Bot last line is visible
4908 All first and last line are visible
4909 45% relative position in the file
4910 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004911 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00004913 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914 this option takes precedence over 'ruler' and 'rulerformat'
4915 If the number of characters displayed is different from the number of
4916 bytes in the text (e.g., for a TAB or a multi-byte character), both
4917 the text column (byte number) and the screen column are shown,
4918 separated with a dash.
4919 For an empty line "0-1" is shown.
4920 For an empty buffer the line number will also be zero: "0,0-1".
4921 This option is reset when the 'paste' option is set.
4922 If you don't want to see the ruler all the time but want to know where
4923 you are, use "g CTRL-G" |g_CTRL-G|.
4924 NOTE: This option is reset when 'compatible' is set.
4925
4926 *'rulerformat'* *'ruf'*
4927'rulerformat' 'ruf' string (default empty)
4928 global
4929 {not in Vi}
4930 {not available when compiled without the |+statusline|
4931 feature}
4932 When this option is not empty, it determines the content of the ruler
4933 string, as displayed for the 'ruler' option.
4934 The format of this option, is like that of 'statusline'.
4935 The default ruler width is 17 characters. To make the ruler 15
4936 characters wide, put "%15(" at the start and "%)" at the end.
4937 Example: >
4938 :set rulerformat=%15(%c%V\ %p%%%)
4939<
4940 *'runtimepath'* *'rtp'* *vimfiles*
4941'runtimepath' 'rtp' string (default:
4942 Unix: "$HOME/.vim,
4943 $VIM/vimfiles,
4944 $VIMRUNTIME,
4945 $VIM/vimfiles/after,
4946 $HOME/.vim/after"
4947 Amiga: "home:vimfiles,
4948 $VIM/vimfiles,
4949 $VIMRUNTIME,
4950 $VIM/vimfiles/after,
4951 home:vimfiles/after"
4952 PC, OS/2: "$HOME/vimfiles,
4953 $VIM/vimfiles,
4954 $VIMRUNTIME,
4955 $VIM/vimfiles/after,
4956 $HOME/vimfiles/after"
4957 Macintosh: "$VIM:vimfiles,
4958 $VIMRUNTIME,
4959 $VIM:vimfiles:after"
4960 RISC-OS: "Choices:vimfiles,
4961 $VIMRUNTIME,
4962 Choices:vimfiles/after"
4963 VMS: "sys$login:vimfiles,
4964 $VIM/vimfiles,
4965 $VIMRUNTIME,
4966 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004967 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 global
4969 {not in Vi}
4970 This is a list of directories which will be searched for runtime
4971 files:
4972 filetype.vim filetypes by file name |new-filetype|
4973 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004974 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 colors/ color scheme files |:colorscheme|
4976 compiler/ compiler files |:compiler|
4977 doc/ documentation |write-local-help|
4978 ftplugin/ filetype plugins |write-filetype-plugin|
4979 indent/ indent scripts |indent-expression|
4980 keymap/ key mapping files |mbyte-keymap|
4981 lang/ menu translations |:menutrans|
4982 menu.vim GUI menus |menu.vim|
4983 plugin/ plugin scripts |write-plugin|
4984 print/ files for printing |postscript-print-encoding|
4985 syntax/ syntax files |mysyntaxfile|
4986 tutor/ files for vimtutor |tutor|
4987
4988 And any other file searched for with the |:runtime| command.
4989
4990 The defaults for most systems are setup to search five locations:
4991 1. In your home directory, for your personal preferences.
4992 2. In a system-wide Vim directory, for preferences from the system
4993 administrator.
4994 3. In $VIMRUNTIME, for files distributed with Vim.
4995 *after-directory*
4996 4. In the "after" directory in the system-wide Vim directory. This is
4997 for the system administrator to overrule or add to the distributed
4998 defaults (rarely needed)
4999 5. In the "after" directory in your home directory. This is for
5000 personal preferences to overrule or add to the distributed defaults
5001 or system-wide settings (rarely needed).
5002
5003 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5004 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005005 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006 wildcards.
5007 See |:runtime|.
5008 Example: >
5009 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5010< This will use the directory "~/vimruntime" first (containing your
5011 personal Vim runtime files), then "/mygroup/vim" (shared between a
5012 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5013 files).
5014 You probably should always include $VIMRUNTIME somewhere, to use the
5015 distributed runtime files. You can put a directory before $VIMRUNTIME
5016 to find files which replace a distributed runtime files. You can put
5017 a directory after $VIMRUNTIME to find files which add to distributed
5018 runtime files.
5019 This option cannot be set from a |modeline| or in the |sandbox|, for
5020 security reasons.
5021
5022 *'scroll'* *'scr'*
5023'scroll' 'scr' number (default: half the window height)
5024 local to window
5025 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5026 set to half the number of lines in the window when the window size
5027 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005028 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5030 the number of screen lines instead of file lines, makes a difference
5031 when lines wrap}
5032
5033 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5034'scrollbind' 'scb' boolean (default off)
5035 local to window
5036 {not in Vi}
5037 {not available when compiled without the |+scrollbind|
5038 feature}
5039 See also |scroll-binding|. When this option is set, the current
5040 window scrolls as other scrollbind windows (windows that also have
5041 this option set) scroll. This option is useful for viewing the
5042 differences between two versions of a file, see 'diff'.
5043 See |'scrollopt'| for options that determine how this option should be
5044 interpreted.
5045 This option is mostly reset when splitting a window to edit another
5046 file. This means that ":split | edit file" results in two windows
5047 with scroll-binding, but ":split file" does not.
5048
5049 *'scrolljump'* *'sj'*
5050'scrolljump' 'sj' number (default 1)
5051 global
5052 {not in Vi}
5053 Minimal number of lines to scroll when the cursor gets off the
5054 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5055 CTRL-D). Useful if your terminal scrolls very slowly.
5056 NOTE: This option is set to 1 when 'compatible' is set.
5057
5058 *'scrolloff'* *'so'*
5059'scrolloff' 'so' number (default 0)
5060 global
5061 {not in Vi}
5062 Minimal number of screen lines to keep above and below the cursor.
5063 This will make some context visible around where you are working. If
5064 you set it to a very large value (999) the cursor line will always be
5065 in the middle of the window (except at the start or end of the file or
5066 when long lines wrap).
5067 For scrolling horizontally see 'sidescrolloff'.
5068 NOTE: This option is set to 0 when 'compatible' is set.
5069
5070 *'scrollopt'* *'sbo'*
5071'scrollopt' 'sbo' string (default "ver,jump")
5072 global
5073 {not available when compiled without the |+scrollbind|
5074 feature}
5075 {not in Vi}
5076 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005077 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5078 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 The following words are available:
5080 ver Bind vertical scrolling for 'scrollbind' windows
5081 hor Bind horizontal scrolling for 'scrollbind' windows
5082 jump Applies to the offset between two windows for vertical
5083 scrolling. This offset is the difference in the first
5084 displayed line of the bound windows. When moving
5085 around in a window, another 'scrollbind' window may
5086 reach a position before the start or after the end of
5087 the buffer. The offset is not changed though, when
5088 moving back the 'scrollbind' window will try to scroll
5089 to the desired position when possible.
5090 When now making that window the current one, two
5091 things can be done with the relative offset:
5092 1. When "jump" is not included, the relative offset is
5093 adjusted for the scroll position in the new current
5094 window. When going back to the other window, the
5095 the new relative offset will be used.
5096 2. When "jump" is included, the other windows are
5097 scrolled to keep the same relative offset. When
5098 going back to the other window, it still uses the
5099 same relative offset.
5100 Also see |scroll-binding|.
5101
5102 *'sections'* *'sect'*
5103'sections' 'sect' string (default "SHNHH HUnhsh")
5104 global
5105 Specifies the nroff macros that separate sections. These are pairs of
5106 two letters (See |object-motions|). The default makes a section start
5107 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5108
5109 *'secure'* *'nosecure'* *E523*
5110'secure' boolean (default off)
5111 global
5112 {not in Vi}
5113 When on, ":autocmd", shell and write commands are not allowed in
5114 ".vimrc" and ".exrc" in the current directory and map commands are
5115 displayed. Switch it off only if you know that you will not run into
5116 problems, or when the 'exrc' option is off. On Unix this option is
5117 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005118 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 'secure' at the end of your ~/.vimrc then.
5120 This option cannot be set from a |modeline| or in the |sandbox|, for
5121 security reasons.
5122
5123 *'selection'* *'sel'*
5124'selection' 'sel' string (default "inclusive")
5125 global
5126 {not in Vi}
5127 This option defines the behavior of the selection. It is only used
5128 in Visual and Select mode.
5129 Possible values:
5130 value past line inclusive ~
5131 old no yes
5132 inclusive yes yes
5133 exclusive yes no
5134 "past line" means that the cursor is allowed to be positioned one
5135 character past the line.
5136 "inclusive" means that the last character of the selection is included
5137 in an operation. For example, when "x" is used to delete the
5138 selection.
5139 Note that when "exclusive" is used and selecting from the end
5140 backwards, you cannot include the last character of a line, when
5141 starting in Normal mode and 'virtualedit' empty.
5142
5143 The 'selection' option is set by the |:behave| command.
5144
5145 *'selectmode'* *'slm'*
5146'selectmode' 'slm' string (default "")
5147 global
5148 {not in Vi}
5149 This is a comma separated list of words, which specifies when to start
5150 Select mode instead of Visual mode, when a selection is started.
5151 Possible values:
5152 mouse when using the mouse
5153 key when using shifted special keys
5154 cmd when using "v", "V" or CTRL-V
5155 See |Select-mode|.
5156 The 'selectmode' option is set by the |:behave| command.
5157
5158 *'sessionoptions'* *'ssop'*
5159'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5160 help,options,winsize")
5161 global
5162 {not in Vi}
5163 {not available when compiled without the +mksession
5164 feature}
5165 Changes the effect of the |:mksession| command. It is a comma
5166 separated list of words. Each word enables saving and restoring
5167 something:
5168 word save and restore ~
5169 blank empty windows
5170 buffers hidden and unloaded buffers, not just those in windows
5171 curdir the current directory
5172 folds manually created folds, opened/closed folds and local
5173 fold options
5174 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005175 and contain at least one lowercase letter. Only
5176 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 help the help window
5178 localoptions options and mappings local to a window or buffer (not
5179 global values for local options)
5180 options all options and mappings (also global values for local
5181 options)
5182 resize size of the Vim window: 'lines' and 'columns'
5183 sesdir the directory in which the session file is located
5184 will become the current directory (useful with
5185 projects accessed over a network from different
5186 systems)
5187 slash backslashes in file names replaced with forward
5188 slashes
5189 unix with Unix end-of-line format (single <NL>), even when
5190 on Windows or DOS
5191 winpos position of the whole Vim window
5192 winsize window sizes
5193
5194 Don't include both "curdir" and "sesdir".
5195 When "curdir" nor "sesdir" is included, file names are stored with
5196 absolute paths.
5197 "slash" and "unix" are useful on Windows when sharing session files
5198 with Unix. The Unix version of Vim cannot source dos format scripts,
5199 but the Windows version of Vim can source unix format scripts.
5200
5201 *'shell'* *'sh'* *E91*
5202'shell' 'sh' string (default $SHELL or "sh",
5203 MS-DOS and Win32: "command.com" or
5204 "cmd.exe", OS/2: "cmd")
5205 global
5206 Name of the shell to use for ! and :! commands. When changing the
5207 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5208 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005209 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 See |option-backslash| about including spaces and backslashes.
5211 Environment variables are expanded |:set_env|.
5212 If the name of the shell contains a space, you might need to enclose
5213 it in quotes. Example: >
5214 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5215< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005216 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 "-f" is not inside the quotes, because it is not part of the command
5218 name. And Vim automagically recognizes the backslashes that are path
5219 separators.
5220 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5221 variable to change the way external commands are executed. See the
5222 libc.inf file of DJGPP.
5223 Under MS-Windows, when the executable ends in ".com" it must be
5224 included. Thus setting the shell to "command.com" or "4dos.com"
5225 works, but "command" and "4dos" do not work for all commands (e.g.,
5226 filtering).
5227 For unknown reasons, when using "4dos.com" the current directory is
5228 changed to "C:\". To avoid this set 'shell' like this: >
5229 :set shell=command.com\ /c\ 4dos
5230< This option cannot be set from a |modeline| or in the |sandbox|, for
5231 security reasons.
5232
5233 *'shellcmdflag'* *'shcf'*
5234'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5235 does not contain "sh" somewhere: "/c")
5236 global
5237 {not in Vi}
5238 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5239 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5240 systems, the default is set according to the value of 'shell', to
5241 reduce the need to set this option by the user. It's not used for
5242 OS/2 (EMX figures this out itself). See |option-backslash| about
5243 including spaces and backslashes. See |dos-shell|.
5244 This option cannot be set from a |modeline| or in the |sandbox|, for
5245 security reasons.
5246
5247 *'shellpipe'* *'sp'*
5248'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5249 global
5250 {not in Vi}
5251 {not available when compiled without the |+quickfix|
5252 feature}
5253 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005254 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005255 including spaces and backslashes.
5256 The name of the temporary file can be represented by "%s" if necessary
5257 (the file name is appended automatically if no %s appears in the value
5258 of this option).
5259 For the Amiga and MS-DOS the default is ">". The output is directly
5260 saved in a file and not echoed to the screen.
5261 For Unix the default it "| tee". The stdout of the compiler is saved
5262 in a file and echoed to the screen. If the 'shell' option is "csh" or
5263 "tcsh" after initializations, the default becomes "|& tee". If the
5264 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5265 "2>&1| tee". This means that stderr is also included.
5266 The initialization of this option is done after reading the ".vimrc"
5267 and the other initializations, so that when the 'shell' option is set
5268 there, the 'shellpipe' option changes automatically, unless it was
5269 explicitly set before.
5270 When 'shellpipe' is set to an empty string, no redirection of the
5271 ":make" output will be done. This is useful if you use a 'makeprg'
5272 that writes to 'makeef' by itself. If you want no piping, but do
5273 want to include the 'makeef', set 'shellpipe' to a single space.
5274 Don't forget to precede the space with a backslash: ":set sp=\ ".
5275 In the future pipes may be used for filtering and this option will
5276 become obsolete (at least for Unix).
5277 This option cannot be set from a |modeline| or in the |sandbox|, for
5278 security reasons.
5279
5280 *'shellquote'* *'shq'*
5281'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5282 contains "sh" somewhere: "\"")
5283 global
5284 {not in Vi}
5285 Quoting character(s), put around the command passed to the shell, for
5286 the "!" and ":!" commands. The redirection is kept outside of the
5287 quoting. See 'shellxquote' to include the redirection. It's
5288 probably not useful to set both options.
5289 This is an empty string by default. Only known to be useful for
5290 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5291 or bash, where it should be "\"". The default is adjusted according
5292 the value of 'shell', to reduce the need to set this option by the
5293 user. See |dos-shell|.
5294 This option cannot be set from a |modeline| or in the |sandbox|, for
5295 security reasons.
5296
5297 *'shellredir'* *'srr'*
5298'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5299 global
5300 {not in Vi}
5301 String to be used to put the output of a filter command in a temporary
5302 file. See also |:!|. See |option-backslash| about including spaces
5303 and backslashes.
5304 The name of the temporary file can be represented by "%s" if necessary
5305 (the file name is appended automatically if no %s appears in the value
5306 of this option).
5307 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5308 or "zsh" during initializations, the default becomes ">&". If the
5309 'shell' option is "sh", "ksh" or "bash" the default becomes
5310 ">%s 2>&1". This means that stderr is also included.
5311 For Win32, the Unix checks are done and additionally "cmd" is checked
5312 for, which makes the default ">%s 2>&1". Also, the same names with
5313 ".exe" appended are checked for.
5314 The initialization of this option is done after reading the ".vimrc"
5315 and the other initializations, so that when the 'shell' option is set
5316 there, the 'shellredir' option changes automatically unless it was
5317 explicitly set before.
5318 In the future pipes may be used for filtering and this option will
5319 become obsolete (at least for Unix).
5320 This option cannot be set from a |modeline| or in the |sandbox|, for
5321 security reasons.
5322
5323 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5324'shellslash' 'ssl' boolean (default off)
5325 global
5326 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5327 When set, a forward slash is used when expanding file names. This is
5328 useful when a Unix-like shell is used instead of command.com or
5329 cmd.exe. Backward slashes can still be typed, but they are changed to
5330 forward slashes by Vim.
5331 Note that setting or resetting this option has no effect for some
5332 existing file names, thus this option needs to be set before opening
5333 any file for best results. This might change in the future.
5334 'shellslash' only works when a backslash can be used as a path
5335 separator. To test if this is so use: >
5336 if exists('+shellslash')
5337<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005338 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5339'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5340 global
5341 {not in Vi}
5342 When on, use temp files for shell commands. When off use a pipe.
5343 When using a pipe is not possible temp files are used anyway.
5344 Currently a pipe is only supported on Unix. You can check it with: >
5345 :if has("filterpipe")
5346< The advantage of using a pipe is that nobody can read the temp file
5347 and the 'shell' command does not need to support redirection.
5348 The advantage of using a temp file is that the file type and encoding
5349 can be detected.
5350 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5351 |FilterWritePost| autocommands event are not triggered when
5352 'shelltemp' is off.
5353
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 *'shelltype'* *'st'*
5355'shelltype' 'st' number (default 0)
5356 global
5357 {not in Vi} {only for the Amiga}
5358 On the Amiga this option influences the way how the commands work
5359 which use a shell.
5360 0 and 1: always use the shell
5361 2 and 3: use the shell only to filter lines
5362 4 and 5: use shell only for ':sh' command
5363 When not using the shell, the command is executed directly.
5364
5365 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5366 1 and 3: use "shell cmd" to start external commands
5367
5368 *'shellxquote'* *'sxq'*
5369'shellxquote' 'sxq' string (default: "";
5370 for Win32, when 'shell' contains "sh"
5371 somewhere: "\""
5372 for Unix, when using system(): "\"")
5373 global
5374 {not in Vi}
5375 Quoting character(s), put around the command passed to the shell, for
5376 the "!" and ":!" commands. Includes the redirection. See
5377 'shellquote' to exclude the redirection. It's probably not useful
5378 to set both options.
5379 This is an empty string by default. Known to be useful for
5380 third-party shells when using the Win32 version, such as the MKS Korn
5381 Shell or bash, where it should be "\"". The default is adjusted
5382 according the value of 'shell', to reduce the need to set this option
5383 by the user. See |dos-shell|.
5384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
5386
5387 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5388'shiftround' 'sr' boolean (default off)
5389 global
5390 {not in Vi}
5391 Round indent to multiple of 'shiftwidth'. Applies to > and <
5392 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5393 a multiple of 'shiftwidth' (this is Vi compatible).
5394 NOTE: This option is reset when 'compatible' is set.
5395
5396 *'shiftwidth'* *'sw'*
5397'shiftwidth' 'sw' number (default 8)
5398 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005399 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005400 |'cindent'|, |>>|, |<<|, etc.
5401
5402 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005403'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5404 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 global
5406 {not in Vi}
5407 This option helps to avoid all the |hit-enter| prompts caused by file
5408 messages, for example with CTRL-G, and to avoid some other messages.
5409 It is a list of flags:
5410 flag meaning when present ~
5411 f use "(3 of 5)" instead of "(file 3 of 5)"
5412 i use "[noeol]" instead of "[Incomplete last line]"
5413 l use "999L, 888C" instead of "999 lines, 888 characters"
5414 m use "[+]" instead of "[Modified]"
5415 n use "[New]" instead of "[New File]"
5416 r use "[RO]" instead of "[readonly]"
5417 w use "[w]" instead of "written" for file write message
5418 and "[a]" instead of "appended" for ':w >> file' command
5419 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5420 "[unix format]" and "[mac]" instead of "[mac format]".
5421 a all of the above abbreviations
5422
5423 o overwrite message for writing a file with subsequent message
5424 for reading a file (useful for ":wn" or when 'autowrite' on)
5425 O message for reading a file overwrites any previous message.
5426 Also for quickfix message (e.g., ":cn").
5427 s don't give "search hit BOTTOM, continuing at TOP" or "search
5428 hit TOP, continuing at BOTTOM" messages
5429 t truncate file message at the start if it is too long to fit
5430 on the command-line, "<" will appear in the left most column.
5431 Ignored in Ex mode.
5432 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005433 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 Ignored in Ex mode.
5435 W don't give "written" or "[w]" when writing a file
5436 A don't give the "ATTENTION" message when an existing swap file
5437 is found.
5438 I don't give the intro message when starting Vim |:intro|.
5439
5440 This gives you the opportunity to avoid that a change between buffers
5441 requires you to hit <Enter>, but still gives as useful a message as
5442 possible for the space available. To get the whole message that you
5443 would have got with 'shm' empty, use ":file!"
5444 Useful values:
5445 shm= No abbreviation of message.
5446 shm=a Abbreviation, but no loss of information.
5447 shm=at Abbreviation, and truncate message when necessary.
5448
5449 NOTE: This option is set to the Vi default value when 'compatible' is
5450 set and to the Vim default value when 'compatible' is reset.
5451
5452 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5453'shortname' 'sn' boolean (default off)
5454 local to buffer
5455 {not in Vi, not in MS-DOS versions}
5456 Filenames are assumed to be 8 characters plus one extension of 3
5457 characters. Multiple dots in file names are not allowed. When this
5458 option is on, dots in file names are replaced with underscores when
5459 adding an extension (".~" or ".swp"). This option is not available
5460 for MS-DOS, because then it would always be on. This option is useful
5461 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5462 or crossdos. When running the Win32 GUI version under Win32s, this
5463 option is always on by default.
5464
5465 *'showbreak'* *'sbr'* *E595*
5466'showbreak' 'sbr' string (default "")
5467 global
5468 {not in Vi}
5469 {not available when compiled without the |+linebreak|
5470 feature}
5471 String to put at the start of lines that have been wrapped. Useful
5472 values are "> " or "+++ ".
5473 Only printable single-cell characters are allowed, excluding <Tab> and
5474 comma (in a future version the comma might be used to separate the
5475 part that is shown at the end and at the start of a line).
5476 The characters are highlighted according to the '@' flag in
5477 'highlight'.
5478 Note that tabs after the showbreak will be displayed differently.
5479 If you want the 'showbreak' to appear in between line numbers, add the
5480 "n" flag to 'cpoptions'.
5481
5482 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5483'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5484 off)
5485 global
5486 {not in Vi}
5487 {not available when compiled without the
5488 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005489 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 terminal is slow.
5491 In Visual mode the size of the selected area is shown:
5492 - When selecting characters within a line, the number of characters.
5493 - When selecting more than one line, the number of lines.
5494 - When selecting a block, the size in screen characters: linesxcolumns.
5495 NOTE: This option is set to the Vi default value when 'compatible' is
5496 set and to the Vim default value when 'compatible' is reset.
5497
5498 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5499'showfulltag' 'sft' boolean (default off)
5500 global
5501 {not in Vi}
5502 When completing a word in insert mode (see |ins-completion|) from the
5503 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005504 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 matched a C function, you can see a template for what arguments are
5506 required (coding style permitting).
5507
5508 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5509'showmatch' 'sm' boolean (default off)
5510 global
5511 When a bracket is inserted, briefly jump to the matching one. The
5512 jump is only done if the match can be seen on the screen. The time to
5513 show the match can be set with 'matchtime'.
5514 A Beep is given if there is no match (no matter if the match can be
5515 seen or not). This option is reset when the 'paste' option is set.
5516 When the 'm' flag is not included in 'cpoptions', typing a character
5517 will immediately move the cursor back to where it belongs.
5518 See the "sm" field in 'guicursor' for setting the cursor shape and
5519 blinking when showing the match.
5520 The 'matchpairs' option can be used to specify the characters to show
5521 matches for. 'rightleft' and 'revins' are used to look for opposite
5522 matches.
5523 Note: For the use of the short form parental guidance is advised.
5524
5525 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5526'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5527 global
5528 If in Insert, Replace or Visual mode put a message on the last line.
5529 Use the 'M' flag in 'highlight' to set the type of highlighting for
5530 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005531 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 doesn't mean XIM is really active, especially when 'imactivatekey' is
5533 not set.
5534 NOTE: This option is set to the Vi default value when 'compatible' is
5535 set and to the Vim default value when 'compatible' is reset.
5536
5537 *'sidescroll'* *'ss'*
5538'sidescroll' 'ss' number (default 0)
5539 global
5540 {not in Vi}
5541 The minimal number of columns to scroll horizontally. Used only when
5542 the 'wrap' option is off and the cursor is moved off of the screen.
5543 When it is zero the cursor will be put in the middle of the screen.
5544 When using a slow terminal set it to a large number or 0. When using
5545 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5546 commands.
5547
5548 *'sidescrolloff'* *'siso'*
5549'sidescrolloff' 'siso' number (default 0)
5550 global
5551 {not in Vi}
5552 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005553 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005554 greater than 0 while having |'sidescroll'| also at a non-zero value
5555 makes some context visible in the line you are scrolling in
5556 horizontally (except at the end and beginning of the line). Setting
5557 this option to a large value (like 999) has the effect of keeping the
5558 cursor horizontally centered in the window, as long as one does not
5559 come too close to the beginning or end of the line.
5560 NOTE: This option is set to 0 when 'compatible' is set.
5561
5562 Example: Try this together with 'sidescroll' and 'listchars' as
5563 in the following example to never allow the cursor to move
5564 onto the "extends" character:
5565
5566 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5567 :set sidescrolloff=1
5568
5569
5570 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5571'smartcase' 'scs' boolean (default off)
5572 global
5573 {not in Vi}
5574 Override the 'ignorecase' option if the search pattern contains upper
5575 case characters. Only used when the search pattern is typed and
5576 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005577 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5579 recalling the search pattern from history and hitting <Enter>.
5580 NOTE: This option is reset when 'compatible' is set.
5581
5582 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5583'smartindent' 'si' boolean (default off)
5584 local to buffer
5585 {not in Vi}
5586 {not available when compiled without the
5587 |+smartindent| feature}
5588 Do smart autoindenting when starting a new line. Works for C-like
5589 programs, but can also be used for other languages. 'cindent' does
5590 something like this, works better in most cases, but is more strict,
5591 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5592 'indentexpr' is a more advanced alternative.
5593 Normally 'autoindent' should also be on when using 'smartindent'.
5594 An indent is automatically inserted:
5595 - After a line ending in '{'.
5596 - After a line starting with a keyword from 'cinwords'.
5597 - Before a line starting with '}' (only with the "O" command).
5598 When typing '}' as the first character in a new line, that line is
5599 given the same indent as the matching '{'.
5600 When typing '#' as the first character in a new line, the indent for
5601 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5604 When using the ">>" command, lines starting with '#' are not shifted
5605 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005606 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 is set smart indenting is disabled.
5608
5609 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5610'smarttab' 'sta' boolean (default off)
5611 global
5612 {not in Vi}
5613 When on, a <Tab> in front of a line inserts blanks according to
5614 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5615 a 'shiftwidth' worth of space at the start of the line.
5616 When off a <Tab> always inserts blanks according to 'tabstop'.
5617 'shiftwidth' is only used for shifting text left or right
5618 |shift-left-right|.
5619 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5620 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005621 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 NOTE: This option is reset when 'compatible' is set.
5623
5624 *'softtabstop'* *'sts'*
5625'softtabstop' 'sts' number (default 0)
5626 local to buffer
5627 {not in Vi}
5628 Number of spaces that a <Tab> counts for while performing editing
5629 operations, like inserting a <Tab> or using <BS>. It "feels" like
5630 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5631 used. This is useful to keep the 'ts' setting at its standard value
5632 of 8, while being able to edit like it is set to 'sts'. However,
5633 commands like "x" still work on the actual characters.
5634 When 'sts' is zero, this feature is off.
5635 'softtabstop' is set to 0 when the 'paste' option is set.
5636 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5637 spaces is minimized by using <Tab>s.
5638 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5639 set.
5640 NOTE: This option is set to 0 when 'compatible' is set.
5641
Bram Moolenaar217ad922005-03-20 22:37:15 +00005642 *'spell'* *'nospell'*
5643'spell' boolean (default off)
5644 local to window
5645 {not in Vi}
5646 {not available when compiled without the |+syntax|
5647 feature}
5648 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005649 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005650
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005651 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005652'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005653 local to buffer
5654 {not in Vi}
5655 {not available when compiled without the |+syntax|
5656 feature}
5657 Pattern to locate the end of a sentence. The following word will be
5658 checked to start with a capital letter. If not then it is highlighted
5659 with SpellCap |hl-SpellCap|.
5660 When this check is not wanted make this option empty.
5661 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005662 Be careful with special characters, see |option-backslash| about
5663 including spaces and backslashes.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005664
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005665 *'spellfile'* *'spf'*
5666'spellfile' 'spf' string (default empty)
5667 local to buffer
5668 {not in Vi}
5669 {not available when compiled without the |+syntax|
5670 feature}
5671 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005672 commands. It must end in ".{encoding}.add". You need to include the
5673 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005674 *E765*
5675 It may also be a comma separated list of names. A count before the
5676 |zg| and |zw| commands can be used to access each. This allows using
5677 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005678 When a word is added while this option is empty Vim will set it for
5679 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005680 writable and the first language name that appears in 'spelllang',
5681 ignoring the region.
5682 The resulting ".spl" file will be used for spell checking, it does not
5683 have to appear in 'spelllang'.
5684 Normally one file is used for all regions, but you can add the region
5685 name if you want to. However, it will then only be used when
5686 'spellfile' is set to it, for entries in 'spelllang' only files
5687 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005688 This option cannot be set from a |modeline| or in the |sandbox|, for
5689 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005690
Bram Moolenaar217ad922005-03-20 22:37:15 +00005691 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005692'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005693 local to buffer
5694 {not in Vi}
5695 {not available when compiled without the |+syntax|
5696 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005697 A comma separated list of word list names. When the 'spell' option is
5698 on spellchecking will be done for these languages. Example: >
5699 set spelllang=en_us,nl,medical
5700< This means US English, Dutch and medical words are recognized. Words
5701 that are not recognized will be highlighted.
5702 The word list name must not include a comma or dot. Using a dash is
5703 recommended to separate the two letter language name from a
5704 specification. Thus "en-rare" is used for rare English words.
5705 A region name must come last and have the form "_xx", where "xx" is
5706 the two-letter, lower case region name. You can use more than one
5707 region by listing them: "en_us,en_ca" supports both US and Canadian
5708 English, but not words specific for Australia, New Zealand or Great
5709 Britain.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005710 As a special case the name of a .spl file can be given as-is. The
5711 first "_xx" in the name is removed and used as the region name
5712 (_xx is an underscore, two letters and followed by a non-letter).
5713 This is mainly for testing purposes. You must make sure the correct
5714 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005715 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005716 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5717 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005718 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005719
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005720 *'spellsuggest'* *'sps'*
5721'spellsuggest' 'sps' string (default "best")
5722 global
5723 {not in Vi}
5724 {not available when compiled without the |+syntax|
5725 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005726 Methods used for spelling suggestions. Both for the |z?| command and
5727 the |spellsuggest()| function. This is a comma-separated list of
5728 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005729
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005730 best Internal method that works best for English. Finds
5731 changes like "fast" and uses a bit of sound-a-like
5732 scoring to improve the ordering.
5733
5734 double Internal method that uses two methods and mixes the
5735 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005736 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005737 word. That only works when the language specifies
5738 sound folding. Can be slow and doesn't always give
5739 better results.
5740
5741 fast Internal method that only checks for simple changes:
5742 character inserts/deletes/swaps. Works well for
5743 simple typing mistakes.
5744
5745 file:{filename} Read file {filename}, which must have two columns,
5746 separated by a slash. The first column contains the
5747 bad word, the second column the suggested good word.
5748 Example:
5749 theribal/terrible ~
5750 Use this for common mistakes that do not appear at the
5751 top of the suggestion list with the internal methods.
5752 Lines without a slash are ignored, use this for
5753 comments.
5754 The file is used for all languages.
5755
5756 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5757 trouble with spaces. |v:val| holds the badly spelled
5758 word. The expression must evaluate to a List of
5759 Lists, each with a suggestion and a score.
5760 Example:
5761 [['the', 33], ['that', 44]]
5762 Set 'verbose' and use |z?| to see the scores that the
5763 internal methods use. A lower score is better.
5764 This may invoke |spellsuggest()| if you temporarily
5765 set 'spellsuggest' to exclude the "expr:" part.
5766 Errors are silently ignored, unless you set the
5767 'verbose' option to a non-zero value.
5768
5769 Only one of "best", "double" or "fast" may be used. The others may
5770 appear several times in any order. Example: >
5771 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5772<
5773 This option cannot be set from a |modeline| or in the |sandbox|, for
5774 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005775
5776
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5778'splitbelow' 'sb' boolean (default off)
5779 global
5780 {not in Vi}
5781 {not available when compiled without the +windows
5782 feature}
5783 When on, splitting a window will put the new window below the current
5784 one. |:split|
5785
5786 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5787'splitright' 'spr' boolean (default off)
5788 global
5789 {not in Vi}
5790 {not available when compiled without the +vertsplit
5791 feature}
5792 When on, splitting a window will put the new window right of the
5793 current one. |:vsplit|
5794
5795 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5796'startofline' 'sol' boolean (default on)
5797 global
5798 {not in Vi}
5799 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005800 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005801 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005802 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 with a linewise operator, with "%" with a count and to buffer changing
5804 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5805 only has a line number, e.g., ":25" or ":+".
5806 In case of buffer changing commands the cursor is placed at the column
5807 where it was the last time the buffer was edited.
5808 NOTE: This option is set when 'compatible' is set.
5809
5810 *'statusline'* *'stl'* *E540* *E541* *E542*
5811'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005812 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 {not in Vi}
5814 {not available when compiled without the |+statusline|
5815 feature}
5816 When nonempty, this option determines the content of the status line.
5817 Also see |status-line|.
5818
5819 The option consists of printf style '%' items interspersed with
5820 normal text. Each status line item is of the form:
5821 %-0{minwid}.{maxwid}{item}
5822 All fields except the {item} is optional. A single percent sign can
5823 be given as "%%". Up to 80 items can be specified.
5824
5825 Note that the only effect of 'ruler' when this option is set (and
5826 'laststatus' is 2) is controlling the output of |CTRL-G|.
5827
5828 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005829 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005830 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005831 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005832 minwid Minimum width of the item, padding as set by '-' & '0'.
5833 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005834 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 on the left for text items. Numeric items will be
5836 shifted down to maxwid-2 digits followed by '>'number
5837 where number is the amount of missing digits, much like
5838 an exponential notation.
5839 item A one letter code as described below.
5840
5841 Following is a description of the possible statusline items. The
5842 second character in "item" is the type:
5843 N for number
5844 S for string
5845 F for flags as described below
5846 - not applicable
5847
5848 item meaning ~
5849 f S Path to the file in the buffer, relative to current directory.
5850 F S Full path to the file in the buffer.
5851 t S File name (tail) of file in the buffer.
5852 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5853 M F Modified flag, text is ",+" or ",-".
5854 r F Readonly flag, text is " [RO]".
5855 R F Readonly flag, text is ",RO".
5856 h F Help buffer flag, text is " [help]".
5857 H F Help buffer flag, text is ",HLP".
5858 w F Preview window flag, text is " [Preview]".
5859 W F Preview window flag, text is ",PRV".
5860 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5861 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5862 {not available when compiled without |+autocmd| feature}
5863 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5864 being used: "<keymap>"
5865 n N Buffer number.
5866 b N Value of byte under cursor.
5867 B N As above, in hexadecimal.
5868 o N Byte number in file of byte under cursor, first byte is 1.
5869 Mnemonic: Offset from start of file (with one added)
5870 {not available when compiled without |+byte_offset| feature}
5871 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005872 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 l N Line number.
5874 L N Number of lines in buffer.
5875 c N Column number.
5876 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 p N Percentage through file in lines as in |CTRL-G|.
5879 P S Percentage through file of displayed window. This is like the
5880 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005881 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00005882 Empty if the argument file count is zero or one.
5883 { NF Evaluate expression between '{' and '}' and substitute result.
5884 ( - Start of item group. Can be used for setting the width and
5885 alignment of a section. Must be followed by %) somewhere.
5886 ) - End of item group. No width fields allowed.
5887 < - Where to truncate line if too long. Default is at the start.
5888 No width fields allowed.
5889 = - Separation point between left and right aligned items.
5890 No width fields allowed.
5891 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005892 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005893 The difference between User{N} and StatusLine will be applied
5894 to StatusLineNC for the statusline of non-current windows.
5895 The number N must be between 1 and 9. See |hl-User1..9|
5896
5897 Display of flags are controlled by the following heuristic:
5898 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005899 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 with a space it is assumed that it wants to separate itself from
5901 anything but other flags. That is: A leading comma is removed if the
5902 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00005903 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 make a nice display when flags are used like in the examples below.
5905
Bram Moolenaar582fd852005-03-28 20:58:01 +00005906 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 not set) and a minwid is not set for the group, the whole group will
5908 become empty. This will make a group like the following disappear
5909 completely from the statusline when none of the flags are set. >
5910 :set statusline=...%(\ [%M%R%H]%)...
5911<
5912 Beware that an expression is evaluated each and every time the status
5913 line is displayed. The current buffer and current window will be set
5914 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00005915 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005916 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5917 real current buffer. The expression is evaluated in the |sandbox|.
5918
5919 If the statusline is not updated when you want it (e.g., after setting
5920 a variable that's used in an expression), you can force an update by
5921 setting an option without changing its value. Example: >
5922 :let &ro = &ro
5923
5924< A result of all digits is regarded a number for display purposes.
5925 Otherwise the result is taken as flag text and applied to the rules
5926 described above.
5927
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00005928 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5930 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5931
5932 Examples:
5933 Emulate standard status line with 'ruler' set >
5934 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5935< Similar, but add ASCII value of char under the cursor (like "ga") >
5936 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5937< Display byte count and byte value, modified flag in red. >
5938 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5939 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5940< Display a ,GZ flag if a compressed file is loaded >
5941 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5942< In the |:autocmd|'s: >
5943 :let b:gzflag = 1
5944< And: >
5945 :unlet b:gzflag
5946< And define this function: >
5947 :function VarExists(var, val)
5948 : if exists(a:var) | return a:val | else | return '' | endif
5949 :endfunction
5950<
5951 *'suffixes'* *'su'*
5952'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5953 global
5954 {not in Vi}
5955 Files with these suffixes get a lower priority when multiple files
5956 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005957 suffixes. Spaces after the comma are ignored. A dot is also seen as
5958 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 separator, precede it with a backslash (see |option-backslash| about
5960 including spaces and backslashes).
5961 See 'wildignore' for completely ignoring files.
5962 The use of |:set+=| and |:set-=| is preferred when adding or removing
5963 suffixes from the list. This avoids problems when a future version
5964 uses another default.
5965
5966 *'suffixesadd'* *'sua'*
5967'suffixesadd' 'sua' string (default "")
5968 local to buffer
5969 {not in Vi}
5970 {not available when compiled without the
5971 |+file_in_path| feature}
5972 Comma separated list of suffixes, which are used when searching for a
5973 file for the "gf", "[I", etc. commands. Example: >
5974 :set suffixesadd=.java
5975<
5976 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5977'swapfile' 'swf' boolean (default on)
5978 local to buffer
5979 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005980 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 swapfile is not wanted for a specific buffer. For example, with
5982 confidential information that even root must not be able to access.
5983 Careful: All text will be in memory:
5984 - Don't use this for big files.
5985 - Recovery will be impossible!
5986 A swapfile will only be present when |'updatecount'| is non-zero and
5987 'swapfile' is set.
5988 When 'swapfile' is reset, the swap file for the current buffer is
5989 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5990 non-zero, a swap file is immediately created.
5991 Also see |swap-file| and |'swapsync'|.
5992
5993 This option is used together with 'bufhidden' and 'buftype' to
5994 specify special kinds of buffers. See |special-buffers|.
5995
5996 *'swapsync'* *'sws'*
5997'swapsync' 'sws' string (default "fsync")
5998 global
5999 {not in Vi}
6000 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006001 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 When this option is empty parts of the swap file may be in memory and
6003 not written to disk. When the system crashes you may lose more work.
6004 On Unix the system does a sync now and then without Vim asking for it,
6005 so the disadvantage of setting this option off is small. On some
6006 systems the swap file will not be written at all. For a unix system
6007 setting it to "sync" will use the sync() call instead of the default
6008 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006009 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010
6011 *'switchbuf'* *'swb'*
6012'switchbuf' 'swb' string (default "")
6013 global
6014 {not in Vi}
6015 This option controls the behavior when switching between buffers.
6016 Possible values (comma separated list):
6017 useopen If included, jump to the first open window that
6018 contains the specified buffer (if there is one).
6019 Otherwise: Do not examine other windows.
6020 This setting is checked with |quickfix| commands, when
6021 jumping to errors (":cc", ":cn", "cp", etc.). It is
6022 also used in all buffer related split commands, for
6023 example ":sbuffer", ":sbnext", or ":sbrewind".
6024 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006025 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006026 Supported in |quickfix| commands that display errors.
6027
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006028 *'synmaxcol'* *'smc'*
6029'synmaxcol' 'smc' number (default 3000)
6030 local to buffer
6031 {not in Vi}
6032 {not available when compiled without the |+syntax|
6033 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006034 Maximum column in which to search for syntax items. In long lines the
6035 text after this column is not highlighted and following lines may not
6036 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006037 This helps to avoid very slow redrawing for an XML file that is one
6038 long line.
6039 Set to zero to remove the limit.
6040
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 *'syntax'* *'syn'*
6042'syntax' 'syn' string (default empty)
6043 local to buffer
6044 {not in Vi}
6045 {not available when compiled without the |+syntax|
6046 feature}
6047 When this option is set, the syntax with this name is loaded, unless
6048 syntax highlighting has been switched off with ":syntax off".
6049 Otherwise this option does not always reflect the current syntax (the
6050 b:current_syntax variable does).
6051 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006052 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 /* vim: set syntax=idl : */
6054< To switch off syntax highlighting for the current file, use: >
6055 :set syntax=OFF
6056< To switch syntax highlighting on according to the current value of the
6057 'filetype' option: >
6058 :set syntax=ON
6059< What actually happens when setting the 'syntax' option is that the
6060 Syntax autocommand event is triggered with the value as argument.
6061 This option is not copied to another buffer, independent of the 's' or
6062 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006063 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064
6065 *'tabstop'* *'ts'*
6066'tabstop' 'ts' number (default 8)
6067 local to buffer
6068 Number of spaces that a <Tab> in the file counts for. Also see
6069 |:retab| command, and 'softtabstop' option.
6070
6071 Note: Setting 'tabstop' to any other value than 8 can make your file
6072 appear wrong in many places (e.g., when printing it).
6073
6074 There are four main ways to use tabs in Vim:
6075 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6076 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6077 will use a mix of tabs and spaces, but typing Tab and BS will
6078 behave like a tab appears every 4 (or 3) characters.
6079 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6080 'expandtab'. This way you will always insert spaces. The
6081 formatting will never be messed up when 'tabstop' is changed.
6082 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006083 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 works when using Vim to edit the file.
6085 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6086 'noexpandtab'. This should then work (for initial indents only)
6087 for any tabstop setting that people use. It might be nice to have
6088 tabs after the first non-blank inserted as spaces if you do this
6089 though. Otherwise aligned comments will be wrong when 'tabstop' is
6090 changed.
6091
6092 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6093'tagbsearch' 'tbs' boolean (default on)
6094 global
6095 {not in Vi}
6096 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006097 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 searching makes searching for a tag a LOT faster, but a linear search
6099 will find more tags if the tags file wasn't properly sorted.
6100 Vim normally assumes that your tags files are sorted, or indicate that
6101 they are not sorted. Only when this is not the case does the
6102 'tagbsearch' option need to be switched off.
6103
6104 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006105 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 certain files, or retry all files with a linear search. When
6107 'tagbsearch' is off, only a linear search is done.
6108
6109 Linear searching is done anyway, for one file, when Vim finds a line
6110 at the start of the file indicating that it's not sorted: >
6111 !_TAG_FILE_SORTED 0 /some command/
6112< [The whitespace before and after the '0' must be a single <Tab>]
6113
6114 When a binary search was done and no match was found in any of the
6115 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6116 instead of a normal tag name, a retry is done with a linear search.
6117 Tags in unsorted tags files, and matches with different case will only
6118 be found in the retry.
6119
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006120 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 linear search can be avoided for the 'ignorecase' case. Use a value
6122 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6123 case-fold sorted with the -f switch to "sort" in most unices, as in
6124 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6125 5.3 or higher the -f or --fold-case-sort switch can be used for this
6126 as well. Note that case must be folded to uppercase for this to work.
6127
6128 When 'tagbsearch' is off, tags searching is slower when a full match
6129 exists, but faster when no full match exists. Tags in unsorted tags
6130 files may only be found with 'tagbsearch' off.
6131 When the tags file is not sorted, or sorted in a wrong way (not on
6132 ASCII byte value), 'tagbsearch' should be off, or the line given above
6133 must be included in the tags file.
6134 This option doesn't affect commands that find all matching tags (e.g.,
6135 command-line completion and ":help").
6136 {Vi: always uses binary search in some versions}
6137
6138 *'taglength'* *'tl'*
6139'taglength' 'tl' number (default 0)
6140 global
6141 If non-zero, tags are significant up to this number of characters.
6142
6143 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6144'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6145 global
6146 {not in Vi}
6147 If on and using a tag file in another directory, file names in that
6148 tag file are relative to the directory where the tag file is.
6149 NOTE: This option is set to the Vi default value when 'compatible' is
6150 set and to the Vim default value when 'compatible' is reset.
6151
6152 *'tags'* *'tag'* *E433*
6153'tags' 'tag' string (default "./tags,tags", when compiled with
6154 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6155 global or local to buffer |global-local|
6156 Filenames for the tag command, separated by spaces or commas. To
6157 include a space or comma in a file name, precede it with a backslash
6158 (see |option-backslash| about including spaces and backslashes).
6159 When a file name starts with "./", the '.' is replaced with the path
6160 of the current file. But only when the 'd' flag is not included in
6161 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6162 |tags-option|.
6163 "*", "**" and other wildcards can be used to search for tags files in
6164 a directory tree. See |file-searching|. {not available when compiled
6165 without the |+path_extra| feature}
6166 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6167 files are also supported. They are automatically recognized. The
6168 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6169 differences are ignored (MS-Windows). |emacs-tags|
6170 The use of |:set+=| and |:set-=| is preferred when adding or removing
6171 file names from the list. This avoids problems when a future version
6172 uses another default.
6173 {Vi: default is "tags /usr/lib/tags"}
6174
6175 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6176'tagstack' 'tgst' boolean (default on)
6177 global
6178 {not in all versions of Vi}
6179 When on, the |tagstack| is used normally. When off, a ":tag" or
6180 ":tselect" command with an argument will not push the tag onto the
6181 tagstack. A following ":tag" without an argument, a ":pop" command or
6182 any other command that uses the tagstack will use the unmodified
6183 tagstack, but does change the pointer to the active entry.
6184 Resetting this option is useful when using a ":tag" command in a
6185 mapping which should not change the tagstack.
6186
6187 *'term'* *E529* *E530* *E531*
6188'term' string (default is $TERM, if that fails:
6189 in the GUI: "builtin_gui"
6190 on Amiga: "amiga"
6191 on BeOS: "beos-ansi"
6192 on Mac: "mac-ansi"
6193 on MiNT: "vt52"
6194 on MS-DOS: "pcterm"
6195 on OS/2: "os2ansi"
6196 on Unix: "ansi"
6197 on VMS: "ansi"
6198 on Win 32: "win32")
6199 global
6200 Name of the terminal. Used for choosing the terminal control
6201 characters. Environment variables are expanded |:set_env|.
6202 For example: >
6203 :set term=$TERM
6204< See |termcap|.
6205
6206 *'termbidi'* *'tbidi'*
6207 *'notermbidi'* *'notbidi'*
6208'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6209 global
6210 {not in Vi}
6211 {only available when compiled with the |+arabic|
6212 feature}
6213 The terminal is in charge of Bi-directionality of text (as specified
6214 by Unicode). The terminal is also expected to do the required shaping
6215 that some languages (such as Arabic) require.
6216 Setting this option implies that 'rightleft' will not be set when
6217 'arabic' is set and the value of 'arabicshape' will be ignored.
6218 Note that setting 'termbidi' has the immediate effect that
6219 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6220 This option is reset when the GUI is started.
6221 For further details see |arabic.txt|.
6222
6223 *'termencoding'* *'tenc'*
6224'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6225 Macintosh GUI: "macroman")
6226 global
6227 {only available when compiled with the |+multi_byte|
6228 feature}
6229 {not in Vi}
6230 Encoding used for the terminal. This specifies what character
6231 encoding the keyboard produces and the display will understand. For
6232 the GUI it only applies to the keyboard ('encoding' is used for the
6233 display).
6234 In the Win32 console version the default value is the console codepage
6235 when it differs from the ANSI codepage.
6236 *E617*
6237 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6238 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6239 Any attempts to set a different value will be rejected, and an error
6240 message is shown.
6241 For the Win32 GUI 'termencoding' is not used for typed characters,
6242 because the Win32 system always passes Unicode characters.
6243 When empty, the same encoding is used as for the 'encoding' option.
6244 This is the normal value.
6245 Not all combinations for 'termencoding' and 'encoding' are valid. See
6246 |encoding-table|.
6247 The value for this option must be supported by internal conversions or
6248 iconv(). When this is not possible no conversion will be done and you
6249 will probably experience problems with non-ASCII characters.
6250 Example: You are working with the locale set to euc-jp (Japanese) and
6251 want to edit a UTF-8 file: >
6252 :let &termencoding = &encoding
6253 :set encoding=utf-8
6254< You need to do this when your system has no locale support for UTF-8.
6255
6256 *'terse'* *'noterse'*
6257'terse' boolean (default off)
6258 global
6259 When set: Add 's' flag to 'shortmess' option (this makes the message
6260 for a search that hits the start or end of the file not being
6261 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6262 shortens a lot of messages}
6263
6264 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6265'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6266 global
6267 {not in Vi}
6268 This option is obsolete. Use 'fileformats'.
6269 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6270 set to the default value for the current system. When 'textauto' is
6271 reset, 'fileformats' is made empty.
6272 NOTE: This option is set to the Vi default value when 'compatible' is
6273 set and to the Vim default value when 'compatible' is reset.
6274
6275 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6276'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6277 others: default off)
6278 local to buffer
6279 {not in Vi}
6280 This option is obsolete. Use 'fileformat'.
6281 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6282 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6283 "unix".
6284
6285 *'textwidth'* *'tw'*
6286'textwidth' 'tw' number (default 0)
6287 local to buffer
6288 {not in Vi}
6289 Maximum width of text that is being inserted. A longer line will be
6290 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006291 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6292 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 'formatoptions' and |ins-textwidth|.
6294 NOTE: This option is set to 0 when 'compatible' is set.
6295
6296 *'thesaurus'* *'tsr'*
6297'thesaurus' 'tsr' string (default "")
6298 global or local to buffer |global-local|
6299 {not in Vi}
6300 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006301 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 the file should contain words with similar meaning, separated by
6303 non-keyword characters (white space is preferred). Maximum line
6304 length is 510 bytes.
6305 To obtain a file to be used here, check out the wordlist FAQ at
6306 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006307 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 after a comma are ignored, otherwise spaces are included in the file
6309 name. See |option-backslash| about using backslashes.
6310 The use of |:set+=| and |:set-=| is preferred when adding or removing
6311 directories from the list. This avoids problems when a future version
6312 uses another default.
6313 Backticks cannot be used in this option for security reasons.
6314
6315 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6316'tildeop' 'top' boolean (default off)
6317 global
6318 {not in Vi}
6319 When on: The tilde command "~" behaves like an operator.
6320 NOTE: This option is reset when 'compatible' is set.
6321
6322 *'timeout'* *'to'* *'notimeout'* *'noto'*
6323'timeout' 'to' boolean (default on)
6324 global
6325 *'ttimeout'* *'nottimeout'*
6326'ttimeout' boolean (default off)
6327 global
6328 {not in Vi}
6329 These two options together determine the behavior when part of a
6330 mapped key sequence or keyboard code has been received:
6331
6332 'timeout' 'ttimeout' action ~
6333 off off do not time out
6334 on on or off time out on :mappings and key codes
6335 off on time out on key codes
6336
6337 If both options are off, Vim will wait until either the complete
6338 mapping or key sequence has been received, or it is clear that there
6339 is no mapping or key sequence for the received characters. For
6340 example: if you have mapped "vl" and Vim has received 'v', the next
6341 character is needed to see if the 'v' is followed by an 'l'.
6342 When one of the options is on, Vim will wait for about 1 second for
6343 the next character to arrive. After that the already received
6344 characters are interpreted as single characters. The waiting time can
6345 be changed with the 'timeoutlen' option.
6346 On slow terminals or very busy systems timing out may cause
6347 malfunctioning cursor keys. If both options are off, Vim waits
6348 forever after an entered <Esc> if there are key codes that start
6349 with <Esc>. You will have to type <Esc> twice. If you do not have
6350 problems with key codes, but would like to have :mapped key
6351 sequences not timing out in 1 second, set the 'ttimeout' option and
6352 reset the 'timeout' option.
6353
6354 NOTE: 'ttimeout' is reset when 'compatible' is set.
6355
6356 *'timeoutlen'* *'tm'*
6357'timeoutlen' 'tm' number (default 1000)
6358 global
6359 {not in all versions of Vi}
6360 *'ttimeoutlen'* *'ttm'*
6361'ttimeoutlen' 'ttm' number (default -1)
6362 global
6363 {not in Vi}
6364 The time in milliseconds that is waited for a key code or mapped key
6365 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6366 when part of a command has been typed.
6367 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6368 different timeout value for key codes is desired set 'ttimeoutlen' to
6369 a non-negative number.
6370
6371 ttimeoutlen mapping delay key code delay ~
6372 < 0 'timeoutlen' 'timeoutlen'
6373 >= 0 'timeoutlen' 'ttimeoutlen'
6374
6375 The timeout only happens when the 'timeout' and 'ttimeout' options
6376 tell so. A useful setting would be >
6377 :set timeout timeoutlen=3000 ttimeoutlen=100
6378< (time out on mapping after three seconds, time out on key codes after
6379 a tenth of a second).
6380
6381 *'title'* *'notitle'*
6382'title' boolean (default off, on when title can be restored)
6383 global
6384 {not in Vi}
6385 {not available when compiled without the |+title|
6386 feature}
6387 When on, the title of the window will be set to the value of
6388 'titlestring' (if it is not empty), or to:
6389 filename [+=-] (path) - VIM
6390 Where:
6391 filename the name of the file being edited
6392 - indicates the file cannot be modified, 'ma' off
6393 + indicates the file was modified
6394 = indicates the file is read-only
6395 =+ indicates the file is read-only and modified
6396 (path) is the path of the file being edited
6397 - VIM the server name |v:servername| or "VIM"
6398 Only works if the terminal supports setting window titles
6399 (currently Amiga console, Win32 console, all GUI versions and
6400 terminals with a non- empty 't_ts' option - these are Unix xterm and
6401 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6402 *X11*
6403 When Vim was compiled with HAVE_X11 defined, the original title will
6404 be restored if possible. The output of ":version" will include "+X11"
6405 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6406 works for the icon name |'icon'|.
6407 But: When Vim was started with the |-X| argument, restoring the title
6408 will not work (except in the GUI).
6409 If the title cannot be restored, it is set to the value of 'titleold'.
6410 You might want to restore the title outside of Vim then.
6411 When using an xterm from a remote machine you can use this command:
6412 rsh machine_name xterm -display $DISPLAY &
6413 then the WINDOWID environment variable should be inherited and the
6414 title of the window should change back to what it should be after
6415 exiting Vim.
6416
6417 *'titlelen'*
6418'titlelen' number (default 85)
6419 global
6420 {not in Vi}
6421 {not available when compiled without the |+title|
6422 feature}
6423 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006424 title. When the title is longer, only the end of the path name is
6425 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 Using a percentage makes this adapt to the width of the window. But
6427 it won't work perfectly, because the actual number of characters
6428 available also depends on the font used and other things in the title
6429 bar. When 'titlelen' is zero the full path is used. Otherwise,
6430 values from 1 to 30000 percent can be used.
6431 'titlelen' is also used for the 'titlestring' option.
6432
6433 *'titleold'*
6434'titleold' string (default "Thanks for flying Vim")
6435 global
6436 {not in Vi}
6437 {only available when compiled with the |+title|
6438 feature}
6439 This option will be used for the window title when exiting Vim if the
6440 original title cannot be restored. Only happens if 'title' is on or
6441 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006442 This option cannot be set from a |modeline| or in the |sandbox|, for
6443 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 *'titlestring'*
6445'titlestring' string (default "")
6446 global
6447 {not in Vi}
6448 {not available when compiled without the |+title|
6449 feature}
6450 When this option is not empty, it will be used for the title of the
6451 window. This happens only when the 'title' option is on.
6452 Only works if the terminal supports setting window titles (currently
6453 Amiga console, Win32 console, all GUI versions and terminals with a
6454 non-empty 't_ts' option).
6455 When Vim was compiled with HAVE_X11 defined, the original title will
6456 be restored if possible |X11|.
6457 When this option contains printf-style '%' items, they will be
6458 expanded according to the rules used for 'statusline'.
6459 Example: >
6460 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6461 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6462< The value of 'titlelen' is used to align items in the middle or right
6463 of the available space.
6464 Some people prefer to have the file name first: >
6465 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6466< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006467 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 separating space only when needed.
6469 NOTE: Use of special characters in 'titlestring' may cause the display
6470 to be garbled (e.g., when it contains a CR or NL character).
6471 {not available when compiled without the |+statusline| feature}
6472
6473 *'toolbar'* *'tb'*
6474'toolbar' 'tb' string (default "icons,tooltips")
6475 global
6476 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6477 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 possible values are:
6480 icons Toolbar buttons are shown with icons.
6481 text Toolbar buttons shown with text.
6482 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006483 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 tooltips Tooltips are active for toolbar buttons.
6485 Tooltips refer to the popup help text which appears after the mouse
6486 cursor is placed over a toolbar button for a brief moment.
6487
6488 If you want the toolbar to be shown with icons as well as text, do the
6489 following: >
6490 :set tb=icons,text
6491< Motif and Athena cannot display icons and text at the same time. They
6492 will show icons if both are requested.
6493
6494 If none of the strings specified in 'toolbar' are valid or if
6495 'toolbar' is empty, this option is ignored. If you want to disable
6496 the toolbar, you need to set the 'guioptions' option. For example: >
6497 :set guioptions-=T
6498< Also see |gui-toolbar|.
6499
6500 *'toolbariconsize'* *'tbis'*
6501'toolbariconsize' 'tbis' string (default "small")
6502 global
6503 {not in Vi}
6504 {only in the GTK+ 2 GUI}
6505 Controls the size of toolbar icons. The possible values are:
6506 tiny Use tiny toolbar icons.
6507 small Use small toolbar icons (default).
6508 medium Use medium-sized toolbar icons.
6509 large Use large toolbar icons.
6510 The exact dimensions in pixels of the various icon sizes depend on
6511 the current theme. Common dimensions are large=32x32, medium=24x24,
6512 small=20x20 and tiny=16x16.
6513
6514 If 'toolbariconsize' is empty, the global default size as determined
6515 by user preferences or the current theme is used.
6516
6517 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6518'ttybuiltin' 'tbi' boolean (default on)
6519 global
6520 {not in Vi}
6521 When on, the builtin termcaps are searched before the external ones.
6522 When off the builtin termcaps are searched after the external ones.
6523 When this option is changed, you should set the 'term' option next for
6524 the change to take effect, for example: >
6525 :set notbi term=$TERM
6526< See also |termcap|.
6527 Rationale: The default for this option is "on", because the builtin
6528 termcap entries are generally better (many systems contain faulty
6529 xterm entries...).
6530
6531 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6532'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6533 sun-cmd, screen, rxvt, dtterm or
6534 iris-ansi; also on when running Vim in
6535 a DOS console)
6536 global
6537 {not in Vi}
6538 Indicates a fast terminal connection. More characters will be sent to
6539 the screen for redrawing, instead of using insert/delete line
6540 commands. Improves smoothness of redrawing when there are multiple
6541 windows and the terminal does not support a scrolling region.
6542 Also enables the extra writing of characters at the end of each screen
6543 line for lines that wrap. This helps when using copy/paste with the
6544 mouse in an xterm and other terminals.
6545
6546 *'ttymouse'* *'ttym'*
6547'ttymouse' 'ttym' string (default depends on 'term')
6548 global
6549 {not in Vi}
6550 {only in Unix and VMS, doesn't work in the GUI; not
6551 available when compiled without |+mouse|}
6552 Name of the terminal type for which mouse codes are to be recognized.
6553 Currently these three strings are valid:
6554 *xterm-mouse*
6555 xterm xterm-like mouse handling. The mouse generates
6556 "<Esc>[Mscr", where "scr" is three bytes:
6557 "s" = button state
6558 "c" = column plus 33
6559 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006560 This only works up to 223 columns! See "dec" for a
6561 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 xterm2 Works like "xterm", but with the xterm reporting the
6563 mouse position while the mouse is dragged. This works
6564 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006565 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 work. See below for how Vim detects this
6567 automatically.
6568 *netterm-mouse*
6569 netterm NetTerm mouse handling. The mouse generates
6570 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6571 for the row and column.
6572 *dec-mouse*
6573 dec DEC terminal mouse handling. The mouse generates a
6574 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006575 This is also available for an Xterm, if it was
6576 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006577 *jsbterm-mouse*
6578 jsbterm JSB term mouse handling.
6579 *pterm-mouse*
6580 pterm QNX pterm mouse handling.
6581
6582 The mouse handling must be enabled at compile time |+mouse_xterm|
6583 |+mouse_dec| |+mouse_netterm|.
6584 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6585 recognized, if enabled at compile time. DEC terminal mouse codes
6586 are recognized if enabled at compile time, and 'ttymouse' is not
6587 "xterm" (because the xterm and dec mouse codes conflict).
6588 This option is automatically set to "xterm", when the 'term' option is
6589 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6590 or "xterm2" already. The main use of this option is to set it to
6591 "xterm", when the terminal name doesn't start with "xterm", but it can
6592 handle xterm mouse codes.
6593 The "xterm2" value will be set if the xterm version is reported to be
6594 95 of higher. This only works when compiled with the |+termresponse|
6595 feature and if |t_RV| is set to the escape sequence to request the
6596 xterm version number. Otherwise "xterm2" must be set explicitly.
6597 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6598 t_RV to an empty string: >
6599 :set t_RV=
6600<
6601 *'ttyscroll'* *'tsl'*
6602'ttyscroll' 'tsl' number (default 999)
6603 global
6604 Maximum number of lines to scroll the screen. If there are more lines
6605 to scroll the window is redrawn. For terminals where scrolling is
6606 very slow and redrawing is not slow this can be set to a small number,
6607 e.g., 3, to speed up displaying.
6608
6609 *'ttytype'* *'tty'*
6610'ttytype' 'tty' string (default from $TERM)
6611 global
6612 Alias for 'term', see above.
6613
6614 *'undolevels'* *'ul'*
6615'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6616 Win32 and OS/2)
6617 global
6618 {not in Vi}
6619 Maximum number of changes that can be undone. Since undo information
6620 is kept in memory, higher numbers will cause more memory to be used
6621 (nevertheless, a single change can use an unlimited amount of memory).
6622 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6623 itself: >
6624 set ul=0
6625< But you can also get Vi compatibility by including the 'u' flag in
6626 'cpoptions', and still be able to use CTRL-R to repeat undo.
6627 Set to a negative number for no undo at all: >
6628 set ul=-1
6629< This helps when you run out of memory for a single change.
6630 Also see |undo-two-ways|.
6631
6632 *'updatecount'* *'uc'*
6633'updatecount' 'uc' number (default: 200)
6634 global
6635 {not in Vi}
6636 After typing this many characters the swap file will be written to
6637 disk. When zero, no swap file will be created at all (see chapter on
6638 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6639 Vim with the "-n" option, see |startup|. When editing in readonly
6640 mode this option will be initialized to 10000.
6641 The swapfile can be disabled per buffer with |'swapfile'|.
6642 When 'updatecount' is set from zero to non-zero, swap files are
6643 created for all buffers that have 'swapfile' set. When 'updatecount'
6644 is set to zero, existing swap files are not deleted.
6645 Also see |'swapsync'|.
6646 This option has no meaning in buffers where |'buftype'| is "nofile"
6647 or "nowrite".
6648
6649 *'updatetime'* *'ut'*
6650'updatetime' 'ut' number (default 4000)
6651 global
6652 {not in Vi}
6653 If this many milliseconds nothing is typed the swap file will be
6654 written to disk (see |crash-recovery|). Also used for the
6655 |CursorHold| autocommand event.
6656
6657 *'verbose'* *'vbs'*
6658'verbose' 'vbs' number (default 0)
6659 global
6660 {not in Vi, although some versions have a boolean
6661 verbose option}
6662 When bigger than zero, Vim will give messages about what it is doing.
6663 Currently, these messages are given:
6664 >= 1 When the viminfo file is read or written.
6665 >= 2 When a file is ":source"'ed.
6666 >= 5 Every searched tags file.
6667 >= 8 Files for which a group of autocommands is executed.
6668 >= 9 Every executed autocommand.
6669 >= 12 Every executed function.
6670 >= 13 When an exception is thrown, caught, finished, or discarded.
6671 >= 14 Anything pending in a ":finally" clause.
6672 >= 15 Every executed Ex command (truncated at 200 characters).
6673
6674 This option can also be set with the "-V" argument. See |-V|.
6675 This option is also set by the |:verbose| command.
6676
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006677 When the 'verbosefile' option is set then the verbose messages are not
6678 displayed.
6679
6680 *'verbosefile'* *'vfile'*
6681'verbosefile' 'vfile' string (default empty)
6682 global
6683 {not in Vi}
6684 When not empty all messages are written in a file with this name.
6685 When the file exists messages are appended.
6686 Writing to the file ends when Vim exits or when 'verbosefile' is made
6687 empty.
6688 Setting 'verbosefile' to a new value is like making it empty first.
6689 The difference with |:redir| is that verbose messages are not
6690 displayed when 'verbosefile' is set.
6691
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 *'viewdir'* *'vdir'*
6693'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6694 "$VIM/vimfiles/view",
6695 for Unix: "~/.vim/view",
6696 for Macintosh: "$VIM:vimfiles:view"
6697 for VMS: "sys$login:vimfiles/view"
6698 for RiscOS: "Choices:vimfiles/view")
6699 global
6700 {not in Vi}
6701 {not available when compiled without the +mksession
6702 feature}
6703 Name of the directory where to store files for |:mkview|.
6704 This option cannot be set from a |modeline| or in the |sandbox|, for
6705 security reasons.
6706
6707 *'viewoptions'* *'vop'*
6708'viewoptions' 'vop' string (default: "folds,options,cursor")
6709 global
6710 {not in Vi}
6711 {not available when compiled without the +mksession
6712 feature}
6713 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006714 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 word save and restore ~
6716 cursor cursor position in file and in window
6717 folds manually created folds, opened/closed folds and local
6718 fold options
6719 options options and mappings local to a window or buffer (not
6720 global values for local options)
6721 slash backslashes in file names replaced with forward
6722 slashes
6723 unix with Unix end-of-line format (single <NL>), even when
6724 on Windows or DOS
6725
6726 "slash" and "unix" are useful on Windows when sharing view files
6727 with Unix. The Unix version of Vim cannot source dos format scripts,
6728 but the Windows version of Vim can source unix format scripts.
6729
6730 *'viminfo'* *'vi'* *E526* *E527* *E528*
6731'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6732 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6733 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6734 for others: '20,<50,s10,h)
6735 global
6736 {not in Vi}
6737 {not available when compiled without the |+viminfo|
6738 feature}
6739 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006740 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 separated list of parameters, each consisting of a single character
6742 identifying the particular parameter, followed by a number or string
6743 which specifies the value of that parameter. If a particular
6744 character is left out, then the default value is used for that
6745 parameter. The following is a list of the identifying characters and
6746 the effect of their value.
6747 CHAR VALUE ~
6748 ! When included, save and restore global variables that start
6749 with an uppercase letter, and don't contain a lowercase
6750 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006751 and "_K_L_M" are not. Only String and Number types are
6752 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006753 " Maximum number of lines saved for each register. Old name of
6754 the '<' item, with the disadvantage that you need to put a
6755 backslash before the ", otherwise it will be recognized as the
6756 start of a comment!
6757 % When included, save and restore the buffer list. If Vim is
6758 started with a file name argument, the buffer list is not
6759 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006760 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006761 without a file name and buffers for help files are not written
6762 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006763 When followed by a number, the number specifies the maximum
6764 number of buffers that are stored. Without a number all
6765 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006766 ' Maximum number of previously edited files for which the marks
6767 are remembered. This parameter must always be included when
6768 'viminfo' is non-empty.
6769 Including this item also means that the |jumplist| and the
6770 |changelist| are stored in the viminfo file.
6771 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006772 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 patterns are also saved. When not included, the value of
6774 'history' is used.
6775 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006776 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 < Maximum number of lines saved for each register. If zero then
6778 registers are not saved. When not included, all lines are
6779 saved. '"' is the old name for this item.
6780 Also see the 's' item below: limit specified in Kbyte.
6781 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006782 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 c When included, convert the text in the viminfo file from the
6784 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006785 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 f Whether file marks need to be stored. If zero, file marks ('0
6787 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 cursor position (when exiting or when doing ":wviminfo").
6790 h Disable the effect of 'hlsearch' when loading the viminfo
6791 file. When not included, it depends on whether ":nohlsearch"
6792 has been used since the last search command.
6793 n Name of the viminfo file. The name must immediately follow
6794 the 'n'. Must be the last one! If the "-i" argument was
6795 given when starting Vim, that file name overrides the one
6796 given here with 'viminfo'. Environment variables are expanded
6797 when opening the file, not when setting the option.
6798 r Removable media. The argument is a string (up to the next
6799 ','). This parameter can be given several times. Each
6800 specifies the start of a path for which no marks will be
6801 stored. This is to avoid removable media. For MS-DOS you
6802 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6803 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6804 ignored. Maximum length of each 'r' argument is 50
6805 characters.
6806 s Maximum size of an item in Kbyte. If zero then registers are
6807 not saved. Currently only applies to registers. The default
6808 "s10" will exclude registers with more than 10 Kbyte of text.
6809 Also see the '<' item above: line count limit.
6810
6811 Example: >
6812 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6813<
6814 '50 Marks will be remembered for the last 50 files you
6815 edited.
6816 <1000 Contents of registers (up to 1000 lines each) will be
6817 remembered.
6818 s100 Registers with more than 100 Kbyte text are skipped.
6819 :0 Command-line history will not be saved.
6820 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6821 no / Since '/' is not specified, the default will be used,
6822 that is, save all of the search history, and also the
6823 previous search and substitute patterns.
6824 no % The buffer list will not be saved nor read back.
6825 no h 'hlsearch' highlighting will be restored.
6826
6827 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6828 load the contents of the file, this is not done automatically.
6829
6830 This option cannot be set from a |modeline| or in the |sandbox|, for
6831 security reasons.
6832
6833 *'virtualedit'* *'ve'*
6834'virtualedit' 've' string (default "")
6835 global
6836 {not in Vi}
6837 {not available when compiled without the
6838 |+virtualedit| feature}
6839 A comma separated list of these words:
6840 block Allow virtual editing in Visual block mode.
6841 insert Allow virtual editing in Insert mode.
6842 all Allow virtual editing in all modes.
6843 Virtual editing means that the cursor can be positioned where there is
6844 no actual character. This can be halfway into a Tab or beyond the end
6845 of the line. Useful for selecting a rectangle in Visual mode and
6846 editing a table.
6847
6848 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6849'visualbell' 'vb' boolean (default off)
6850 global
6851 {not in Vi}
6852 Use visual bell instead of beeping. The terminal code to display the
6853 visual bell is given with 't_vb'. When no beep or flash is wanted,
6854 use ":set vb t_vb=".
6855 Note: When the GUI starts, 't_vb' is reset to its default value. You
6856 might want to set it again in your |gvimrc|.
6857 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6858 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6859 where 40 is the time in msec.
6860 Does not work on the Amiga, you always get a screen flash.
6861 Also see 'errorbells'.
6862
6863 *'warn'* *'nowarn'*
6864'warn' boolean (default on)
6865 global
6866 Give a warning message when a shell command is used while the buffer
6867 has been changed.
6868
6869 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6870'weirdinvert' 'wiv' boolean (default off)
6871 global
6872 {not in Vi}
6873 This option has the same effect as the 't_xs' termcap option.
6874 It is provided for backwards compatibility with version 4.x.
6875 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6876 vice versa. Has no effect when the GUI is running.
6877
6878 *'whichwrap'* *'ww'*
6879'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6880 global
6881 {not in Vi}
6882 Allow specified keys that move the cursor left/right to move to the
6883 previous/next line when the cursor is on the first/last character in
6884 the line. Concatenate characters to allow this for these keys:
6885 char key mode ~
6886 b <BS> Normal and Visual
6887 s <Space> Normal and Visual
6888 h "h" Normal and Visual
6889 l "l" Normal and Visual
6890 < <Left> Normal and Visual
6891 > <Right> Normal and Visual
6892 ~ "~" Normal
6893 [ <Left> Insert and Replace
6894 ] <Right> Insert and Replace
6895 For example: >
6896 :set ww=<,>,[,]
6897< allows wrap only when cursor keys are used.
6898 When the movement keys are used in combination with a delete or change
6899 operator, the <EOL> also counts for a character. This makes "3h"
6900 different from "3dh" when the cursor crosses the end of a line. This
6901 is also true for "x" and "X", because they do the same as "dl" and
6902 "dh". If you use this, you may also want to use the mapping
6903 ":map <BS> X" to make backspace delete the character in front of the
6904 cursor.
6905 When 'l' is included, you get a side effect: "yl" on an empty line
6906 will include the <EOL>, so that "p" will insert a new line.
6907 NOTE: This option is set to the Vi default value when 'compatible' is
6908 set and to the Vim default value when 'compatible' is reset.
6909
6910 *'wildchar'* *'wc'*
6911'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6912 global
6913 {not in Vi}
6914 Character you have to type to start wildcard expansion in the
6915 command-line, as specified with 'wildmode'.
6916 The character is not recognized when used inside a macro. See
6917 'wildcharm' for that.
6918 Although 'wc' is a number option, you can set it to a special key: >
6919 :set wc=<Esc>
6920< NOTE: This option is set to the Vi default value when 'compatible' is
6921 set and to the Vim default value when 'compatible' is reset.
6922
6923 *'wildcharm'* *'wcm'*
6924'wildcharm' 'wcm' number (default: none (0))
6925 global
6926 {not in Vi}
6927 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006928 recognized when used inside a macro. You can find "spare" command-line
6929 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00006930 you'll never actually type 'wildcharm', just use it in mappings that
6931 automatically invoke completion mode, e.g.: >
6932 :set wcm=<C-Z>
6933 :cmap ss so $vim/sessions/*.vim<C-Z>
6934< Then after typing :ss you can use CTRL-P & CTRL-N.
6935
6936 *'wildignore'* *'wig'*
6937'wildignore' 'wig' string (default "")
6938 global
6939 {not in Vi}
6940 {not available when compiled without the |+wildignore|
6941 feature}
6942 A list of file patterns. A file that matches with one of these
6943 patterns is ignored when completing file or directory names.
6944 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6945 Also see 'suffixes'.
6946 Example: >
6947 :set wildignore=*.o,*.obj
6948< The use of |:set+=| and |:set-=| is preferred when adding or removing
6949 a pattern from the list. This avoids problems when a future version
6950 uses another default.
6951
6952 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6953'wildmenu' 'wmnu' boolean (default off)
6954 global
6955 {not in Vi}
6956 {not available if compiled without the |+wildmenu|
6957 feature}
6958 When 'wildmenu' is on, command-line completion operates in an enhanced
6959 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6960 the possible matches are shown just above the command line, with the
6961 first match highlighted (overwriting the status line, if there is
6962 one). Keys that show the previous/next match, such as <Tab> or
6963 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6964 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6965 specified. "longest" and "list" do not start "wildmenu" mode.
6966 If there are more matches than can fit in the line, a ">" is shown on
6967 the right and/or a "<" is shown on the left. The status line scrolls
6968 as needed.
6969 The "wildmenu" mode is abandoned when a key is hit that is not used
6970 for selecting a completion.
6971 While the "wildmenu" is active the following keys have special
6972 meanings:
6973
6974 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6975 <Down> - in filename/menu name completion: move into a
6976 subdirectory or submenu.
6977 <CR> - in menu completion, when the cursor is just after a
6978 dot: move into a submenu.
6979 <Up> - in filename/menu name completion: move up into
6980 parent directory or parent menu.
6981
6982 This makes the menus accessible from the console |console-menus|.
6983
6984 If you prefer the <Left> and <Right> keys to move the cursor instead
6985 of selecting a different match, use this: >
6986 :cnoremap <Left> <Space><BS><Left>
6987 :cnoremap <Right> <Space><BS><Right>
6988<
6989 The "WildMenu" highlighting is used for displaying the current match
6990 |hl-WildMenu|.
6991
6992 *'wildmode'* *'wim'*
6993'wildmode' 'wim' string (Vim default: "full")
6994 global
6995 {not in Vi}
6996 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006997 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 part specifies what to do for each consecutive use of 'wildchar. The
6999 first part specifies the behavior for the first use of 'wildchar',
7000 The second part for the second use, etc.
7001 These are the possible values for each part:
7002 "" Complete only the first match.
7003 "full" Complete the next full match. After the last match,
7004 the original string is used and then the first match
7005 again.
7006 "longest" Complete till longest common string. If this doesn't
7007 result in a longer string, use the next part.
7008 "longest:full" Like "longest", but also start 'wildmenu' if it is
7009 enabled.
7010 "list" When more than one match, list all matches.
7011 "list:full" When more than one match, list all matches and
7012 complete first match.
7013 "list:longest" When more than one match, list all matches and
7014 complete till longest common string.
7015 When there is only a single match, it is fully completed in all cases.
7016
7017 Examples: >
7018 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007019< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007020 :set wildmode=longest,full
7021< Complete longest common string, then each full match >
7022 :set wildmode=list:full
7023< List all matches and complete each full match >
7024 :set wildmode=list,full
7025< List all matches without completing, then each full match >
7026 :set wildmode=longest,list
7027< Complete longest common string, then list alternatives.
7028
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007029 *'wildoptions'* *'wop'*
7030'wildoptions' 'wop' string (default "")
7031 global
7032 {not in Vi}
7033 {not available when compiled without the |+wildignore|
7034 feature}
7035 A list of words that change how command line completion is done.
7036 Currently only one word is allowed:
7037 tagfile When using CTRL-D to list matching tags, the kind of
7038 tag and the file of the tag is listed. Only one match
7039 is displayed per line. Often used tag kinds are:
7040 d #define
7041 f function
7042 Also see |cmdline-completion|.
7043
Bram Moolenaar071d4272004-06-13 20:20:40 +00007044 *'winaltkeys'* *'wak'*
7045'winaltkeys' 'wak' string (default "menu")
7046 global
7047 {not in Vi}
7048 {only used in Win32, Motif, GTK and Photon GUI}
7049 Some GUI versions allow the access to menu entries by using the ALT
7050 key in combination with a character that appears underlined in the
7051 menu. This conflicts with the use of the ALT key for mappings and
7052 entering special characters. This option tells what to do:
7053 no Don't use ALT keys for menus. ALT key combinations can be
7054 mapped, but there is no automatic handling. This can then be
7055 done with the |:simalt| command.
7056 yes ALT key handling is done by the windowing system. ALT key
7057 combinations cannot be mapped.
7058 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007059 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 keys can be mapped.
7061 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7062 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007063 This option is not used for <F10>; on Win32 and with GTK <F10> will
7064 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007065
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007066 *'window'* *'wi'*
7067'window' 'wi' number (default screen height - 1)
7068 global
7069 Window height. Do not confuse this with the height of the Vim window,
7070 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007071 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7072 value is smaller than 'lines' minus one. The screen will scroll
7073 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007074 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7075 in a much smarter way, taking care of wrapping lines.
7076 When resizing the Vim window, the value is smaller than 1 or more than
7077 or equal to 'lines' it will be set to 'lines' minus 1.
7078 {Vi also uses the option to specify the number of displayed lines}
7079
Bram Moolenaar071d4272004-06-13 20:20:40 +00007080 *'winheight'* *'wh'* *E591*
7081'winheight' 'wh' number (default 1)
7082 global
7083 {not in Vi}
7084 {not available when compiled without the +windows
7085 feature}
7086 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007087 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 current window is smaller, its size is increased, at the cost of the
7089 height of other windows. Set it to 999 to make the current window
7090 always fill the screen (although this has the drawback that ":all"
7091 will create only two windows). Set it to a small number for normal
7092 editing.
7093 Minimum value is 1.
7094 The height is not adjusted after one of the commands to change the
7095 height of the current window.
7096 'winheight' applies to the current window. Use 'winminheight' to set
7097 the minimal height for other windows.
7098
7099 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7100'winfixheight' 'wfh' boolean (default off)
7101 local to window
7102 {not in Vi}
7103 {not available when compiled without the +windows
7104 feature}
7105 Keep the window height when windows are opened or closed and
7106 'equalalways' is set. Set by default for the |preview-window| and
7107 |quickfix-window|.
7108 The height may be changed anyway when running out of room.
7109
7110 *'winminheight'* *'wmh'*
7111'winminheight' 'wmh' number (default 1)
7112 global
7113 {not in Vi}
7114 {not available when compiled without the +windows
7115 feature}
7116 The minimal height of a window, when it's not the current window.
7117 This is a hard minimum, windows will never become smaller.
7118 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7119 status bar) if necessary. They will return to at least one line when
7120 they become active (since the cursor has to have somewhere to go.)
7121 Use 'winheight' to set the minimal height of the current window.
7122 This option is only checked when making a window smaller. Don't use a
7123 large number, it will cause errors when opening more than a few
7124 windows. A value of 0 to 3 is reasonable.
7125
7126 *'winminwidth'* *'wmw'*
7127'winminwidth' 'wmw' number (default 1)
7128 global
7129 {not in Vi}
7130 {not available when compiled without the +vertsplit
7131 feature}
7132 The minimal width of a window, when it's not the current window.
7133 This is a hard minimum, windows will never become smaller.
7134 When set to zero, windows may be "squashed" to zero columns (i.e. just
7135 a vertical separator) if necessary. They will return to at least one
7136 line when they become active (since the cursor has to have somewhere
7137 to go.)
7138 Use 'winwidth' to set the minimal width of the current window.
7139 This option is only checked when making a window smaller. Don't use a
7140 large number, it will cause errors when opening more than a few
7141 windows. A value of 0 to 12 is reasonable.
7142
7143 *'winwidth'* *'wiw'* *E592*
7144'winwidth' 'wiw' number (default 20)
7145 global
7146 {not in Vi}
7147 {not available when compiled without the +vertsplit
7148 feature}
7149 Minimal number of columns for the current window. This is not a hard
7150 minimum, Vim will use fewer columns if there is not enough room. If
7151 the current window is smaller, its size is increased, at the cost of
7152 the width of other windows. Set it to 999 to make the current window
7153 always fill the screen. Set it to a small number for normal editing.
7154 The width is not adjusted after one of the commands to change the
7155 width of the current window.
7156 'winwidth' applies to the current window. Use 'winminwidth' to set
7157 the minimal width for other windows.
7158
7159 *'wrap'* *'nowrap'*
7160'wrap' boolean (default on)
7161 local to window
7162 {not in Vi}
7163 This option changes how text is displayed. It doesn't change the text
7164 in the buffer, see 'textwidth' for that.
7165 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007166 displaying continues on the next line. When off lines will not wrap
7167 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 moved to a part that is not shown, the screen will scroll
7169 horizontally.
7170 The line will be broken in the middle of a word if necessary. See
7171 'linebreak' to get the break at a word boundary.
7172 To make scrolling horizontally a bit more useful, try this: >
7173 :set sidescroll=5
7174 :set listchars+=precedes:<,extends:>
7175< See 'sidescroll', 'listchars' and |wrap-off|.
7176
7177 *'wrapmargin'* *'wm'*
7178'wrapmargin' 'wm' number (default 0)
7179 local to buffer
7180 Number of characters from the right window border where wrapping
7181 starts. When typing text beyond this limit, an <EOL> will be inserted
7182 and inserting continues on the next line.
7183 Options that add a margin, such as 'number' and 'foldcolumn', cause
7184 the text width to be further reduced. This is Vi compatible.
7185 When 'textwidth' is non-zero, this option is not used.
7186 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7187 and less usefully}
7188
7189 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7190'wrapscan' 'ws' boolean (default on) *E384* *E385*
7191 global
7192 Searches wrap around the end of the file.
7193
7194 *'write'* *'nowrite'*
7195'write' boolean (default on)
7196 global
7197 {not in Vi}
7198 Allows writing files. When not set, writing a file is not allowed.
7199 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007200 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007201 argument. Filtering text is still possible, even though this requires
7202 writing a temporary file.
7203
7204 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7205'writeany' 'wa' boolean (default off)
7206 global
7207 Allows writing to any file with no need for "!" override.
7208
7209 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7210'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7211 otherwise)
7212 global
7213 {not in Vi}
7214 Make a backup before overwriting a file. The backup is removed after
7215 the file was successfully written, unless the 'backup' option is
7216 also on. Reset this option if your file system is almost full. See
7217 |backup-table| for another explanation.
7218 When the 'backupskip' pattern matches, a backup is not made anyway.
7219 NOTE: This option is set to the default value when 'compatible' is
7220 set.
7221
7222 *'writedelay'* *'wd'*
7223'writedelay' 'wd' number (default 0)
7224 global
7225 {not in Vi}
7226 The number of microseconds to wait for each character sent to the
7227 screen. When non-zero, characters are sent to the terminal one by
7228 one. For MS-DOS pcterm this does not work. For debugging purposes.
7229
7230 vim:tw=78:ts=8:ft=help:norl: