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