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