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