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