blob: eb5a34a4da95e52420e8e8a86cd5e2a3bf8c8050 [file] [log] [blame]
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Aug 27
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
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001103 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1104 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105
1106 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001107'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 global
1109 {not in Vi} {only for Motif and Win32 GUI}
1110 Which directory to use for the file browser:
1111 last Use same directory as with last file browser.
1112 buffer Use the directory of the related buffer.
1113 current Use the current directory.
1114 {path} Use the specified directory
1115
1116 *'bufhidden'* *'bh'*
1117'bufhidden' 'bh' string (default: "")
1118 local to buffer
1119 {not in Vi}
1120 {not available when compiled without the |+quickfix|
1121 feature}
1122 This option specifies what happens when a buffer is no longer
1123 displayed in a window:
1124 <empty> follow the global 'hidden' option
1125 hide hide the buffer (don't unload it), also when 'hidden'
1126 is not set
1127 unload unload the buffer, also when 'hidden' is set or using
1128 |:hide|
1129 delete delete the buffer from the buffer list, also when
1130 'hidden' is set or using |:hide|, like using
1131 |:bdelete|
1132 wipe wipe out the buffer from the buffer list, also when
1133 'hidden' is set or using |:hide|, like using
1134 |:bwipeout|
1135
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001136 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1137 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 This option is used together with 'buftype' and 'swapfile' to specify
1139 special kinds of buffers. See |special-buffers|.
1140
1141 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1142'buflisted' 'bl' boolean (default: on)
1143 local to buffer
1144 {not in Vi}
1145 When this option is set, the buffer shows up in the buffer list. If
1146 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1147 This option is reset by Vim for buffers that are only used to remember
1148 a file name or marks. Vim sets it when starting to edit a buffer.
1149 But not when moving to a buffer with ":buffer".
1150
1151 *'buftype'* *'bt'* *E382*
1152'buftype' 'bt' string (default: "")
1153 local to buffer
1154 {not in Vi}
1155 {not available when compiled without the |+quickfix|
1156 feature}
1157 The value of this option specifies the type of a buffer:
1158 <empty> normal buffer
1159 nofile buffer which is not related to a file and will not be
1160 written
1161 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001162 acwrite buffer which will always be written with BufWriteCmd
1163 autocommands. {not available when compiled without the
1164 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 quickfix quickfix buffer, contains list of errors |:cwindow|
1166 help help buffer (you are not supposed to set this
1167 manually)
1168
1169 This option is used together with 'bufhidden' and 'swapfile' to
1170 specify special kinds of buffers. See |special-buffers|.
1171
1172 Be careful with changing this option, it can have many side effects!
1173
1174 A "quickfix" buffer is only used for the error list. This value is
1175 set by the |:cwindow| command and you are not supposed to change it.
1176
1177 "nofile" and "nowrite" buffers are similar:
1178 both: The buffer is not to be written to disk, ":w" doesn't
1179 work (":w filename" does work though).
1180 both: The buffer is never considered to be |'modified'|.
1181 There is no warning when the changes will be lost, for
1182 example when you quit Vim.
1183 both: A swap file is only created when using too much memory
1184 (when 'swapfile' has been reset there is never a swap
1185 file).
1186 nofile only: The buffer name is fixed, it is not handled like a
1187 file name. It is not modified in response to a |:cd|
1188 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001189 *E676*
1190 "acwrite" implies that the buffer name is not related to a file, like
1191 "nofile", but it will be written. Thus, in contrast to "nofile" and
1192 "nowrite", ":w" does work and a modified buffer can't be abandoned
1193 without saving. For writing there must be matching |BufWriteCmd|,
1194 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195
1196 *'casemap'* *'cmp'*
1197'casemap' 'cmp' string (default: "internal,keepascii")
1198 global
1199 {not in Vi}
1200 Specifies details about changing the case of letters. It may contain
1201 these words, separated by a comma:
1202 internal Use internal case mapping functions, the current
1203 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001204 matters when 'encoding' is a Unicode encoding,
1205 "latin1" or "iso-8859-15". When "internal" is
1206 omitted, the towupper() and towlower() system library
1207 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1209 case mapping, the current locale is not effective.
1210 This probably only matters for Turkish.
1211
1212 *'cdpath'* *'cd'* *E344* *E346*
1213'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1214 global
1215 {not in Vi}
1216 {not available when compiled without the
1217 |+file_in_path| feature}
1218 This is a list of directories which will be searched when using the
1219 |:cd| and |:lcd| commands, provided that the directory being searched
1220 for has a relative path (not starting with "/", "./" or "../").
1221 The 'cdpath' option's value has the same form and semantics as
1222 |'path'|. Also see |file-searching|.
1223 The default value is taken from $CDPATH, with a "," prepended to look
1224 in the current directory first.
1225 If the default value taken from $CDPATH is not what you want, include
1226 a modified version of the following command in your vimrc file to
1227 override it: >
1228 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1229< This option cannot be set from a |modeline| or in the |sandbox|, for
1230 security reasons.
1231 (parts of 'cdpath' can be passed to the shell to expand file names).
1232
1233 *'cedit'*
1234'cedit' string (Vi default: "", Vim default: CTRL-F)
1235 global
1236 {not in Vi}
1237 {not available when compiled without the |+vertsplit|
1238 feature}
1239 The key used in Command-line Mode to open the command-line window.
1240 The default is CTRL-F when 'compatible' is off.
1241 Only non-printable keys are allowed.
1242 The key can be specified as a single character, but it is difficult to
1243 type. The preferred way is to use the <> notation. Examples: >
1244 :set cedit=<C-Y>
1245 :set cedit=<Esc>
1246< |Nvi| also has this option, but it only uses the first character.
1247 See |cmdwin|.
1248
1249 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1250'charconvert' 'ccv' string (default "")
1251 global
1252 {only available when compiled with the |+multi_byte|
1253 feature and the |+eval| feature}
1254 {not in Vi}
1255 An expression that is used for character encoding conversion. It is
1256 evaluated when a file that is to be read or has been written has a
1257 different encoding from what is desired.
1258 'charconvert' is not used when the internal iconv() function is
1259 supported and is able to do the conversion. Using iconv() is
1260 preferred, because it is much faster.
1261 'charconvert' is not used when reading stdin |--|, because there is no
1262 file to convert from. You will have to save the text in a file first.
1263 The expression must return zero or an empty string for success,
1264 non-zero for failure.
1265 The possible encoding names encountered are in 'encoding'.
1266 Additionally, names given in 'fileencodings' and 'fileencoding' are
1267 used.
1268 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1269 is done internally by Vim, 'charconvert' is not used for this.
1270 'charconvert' is also used to convert the viminfo file, if the 'c'
1271 flag is present in 'viminfo'. Also used for Unicode conversion.
1272 Example: >
1273 set charconvert=CharConvert()
1274 fun CharConvert()
1275 system("recode "
1276 \ . v:charconvert_from . ".." . v:charconvert_to
1277 \ . " <" . v:fname_in . " >" v:fname_out)
1278 return v:shell_error
1279 endfun
1280< The related Vim variables are:
1281 v:charconvert_from name of the current encoding
1282 v:charconvert_to name of the desired encoding
1283 v:fname_in name of the input file
1284 v:fname_out name of the output file
1285 Note that v:fname_in and v:fname_out will never be the same.
1286 Note that v:charconvert_from and v:charconvert_to may be different
1287 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1288 Encryption is not done by Vim when using 'charconvert'. If you want
1289 to encrypt the file after conversion, 'charconvert' should take care
1290 of this.
1291 This option cannot be set from a |modeline| or in the |sandbox|, for
1292 security reasons.
1293
1294 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1295'cindent' 'cin' boolean (default off)
1296 local to buffer
1297 {not in Vi}
1298 {not available when compiled without the |+cindent|
1299 feature}
1300 Enables automatic C program indenting See 'cinkeys' to set the keys
1301 that trigger reindenting in insert mode and 'cinoptions' to set your
1302 preferred indent style.
1303 If 'indentexpr' is not empty, it overrules 'cindent'.
1304 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1305 the "=" operator indents using this algorithm rather than calling an
1306 external program.
1307 See |C-indenting|.
1308 When you don't like the way 'cindent' works, try the 'smartindent'
1309 option or 'indentexpr'.
1310 This option is not used when 'paste' is set.
1311 NOTE: This option is reset when 'compatible' is set.
1312
1313 *'cinkeys'* *'cink'*
1314'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1315 local to buffer
1316 {not in Vi}
1317 {not available when compiled without the |+cindent|
1318 feature}
1319 A list of keys that, when typed in Insert mode, cause reindenting of
1320 the current line. Only used if 'cindent' is on and 'indentexpr' is
1321 empty.
1322 For the format of this option see |cinkeys-format|.
1323 See |C-indenting|.
1324
1325 *'cinoptions'* *'cino'*
1326'cinoptions' 'cino' string (default "")
1327 local to buffer
1328 {not in Vi}
1329 {not available when compiled without the |+cindent|
1330 feature}
1331 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1332 program. See |cinoptions-values| for the values of this option, and
1333 |C-indenting| for info on C indenting in general.
1334
1335
1336 *'cinwords'* *'cinw'*
1337'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1338 local to buffer
1339 {not in Vi}
1340 {not available when compiled without both the
1341 |+cindent| and the |+smartindent| features}
1342 These keywords start an extra indent in the next line when
1343 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1344 an appropriate place (inside {}).
1345 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1346 matter, include the keyword both the uppercase and lowercase:
1347 "if,If,IF".
1348
1349 *'clipboard'* *'cb'*
1350'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1351 for X-windows, "" otherwise)
1352 global
1353 {not in Vi}
1354 {only in GUI versions or when the |+xterm_clipboard|
1355 feature is included}
1356 This option is a list of comma separated names.
1357 These names are recognized:
1358
1359 unnamed When included, Vim will use the clipboard register '*'
1360 for all yank, delete, change and put operations which
1361 would normally go to the unnamed register. When a
1362 register is explicitly specified, it will always be
1363 used regardless of whether "unnamed" is in 'clipboard'
1364 or not. The clipboard register can always be
1365 explicitly accessed using the "* notation. Also see
1366 |gui-clipboard|.
1367
1368 autoselect Works like the 'a' flag in 'guioptions': If present,
1369 then whenever Visual mode is started, or the Visual
1370 area extended, Vim tries to become the owner of the
1371 windowing system's global selection or put the
1372 selected text on the clipboard used by the selection
1373 register "*. See |guioptions_a| and |quotestar| for
1374 details. When the GUI is active, the 'a' flag in
1375 'guioptions' is used, when the GUI is not active, this
1376 "autoselect" flag is used.
1377 Also applies to the modeless selection.
1378
1379 autoselectml Like "autoselect", but for the modeless selection
1380 only. Compare to the 'A' flag in 'guioptions'.
1381
1382 exclude:{pattern}
1383 Defines a pattern that is matched against the name of
1384 the terminal 'term'. If there is a match, no
1385 connection will be made to the X server. This is
1386 useful in this situation:
1387 - Running Vim in a console.
1388 - $DISPLAY is set to start applications on another
1389 display.
1390 - You do not want to connect to the X server in the
1391 console, but do want this in a terminal emulator.
1392 To never connect to the X server use: >
1393 exclude:.*
1394< This has the same effect as using the |-X| argument.
1395 Note that when there is no connection to the X server
1396 the window title won't be restored and the clipboard
1397 cannot be accessed.
1398 The value of 'magic' is ignored, {pattern} is
1399 interpreted as if 'magic' was on.
1400 The rest of the option value will be used for
1401 {pattern}, this must be the last entry.
1402
1403 *'cmdheight'* *'ch'*
1404'cmdheight' 'ch' number (default 1)
1405 global
1406 {not in Vi}
1407 Number of screen lines to use for the command-line. Helps avoiding
1408 |hit-enter| prompts.
1409
1410 *'cmdwinheight'* *'cwh'*
1411'cmdwinheight' 'cwh' number (default 7)
1412 global
1413 {not in Vi}
1414 {not available when compiled without the |+vertsplit|
1415 feature}
1416 Number of screen lines to use for the command-line window. |cmdwin|
1417
1418 *'columns'* *'co'* *E594*
1419'columns' 'co' number (default 80 or terminal width)
1420 global
1421 {not in Vi}
1422 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001423 initialization and does not have to be set by hand. Also see
1424 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 When Vim is running in the GUI or in a resizable window, setting this
1426 option will cause the window size to be changed. When you only want
1427 to use the size for the GUI, put the command in your |gvimrc| file.
1428 When you set this option and Vim is unable to change the physical
1429 number of columns of the display, the display may be messed up.
1430
1431 *'comments'* *'com'* *E524* *E525*
1432'comments' 'com' string (default
1433 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1434 local to buffer
1435 {not in Vi}
1436 {not available when compiled without the |+comments|
1437 feature}
1438 A comma separated list of strings that can start a comment line. See
1439 |format-comments|. See |option-backslash| about using backslashes to
1440 insert a space.
1441
1442 *'commentstring'* *'cms'* *E537*
1443'commentstring' 'cms' string (default "/*%s*/")
1444 local to buffer
1445 {not in Vi}
1446 {not available when compiled without the |+folding|
1447 feature}
1448 A template for a comment. The "%s" in the value is replaced with the
1449 comment text. Currently only used to add markers for folding, see
1450 |fold-marker|.
1451
1452 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001453'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1454 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001455 global
1456 {not in Vi}
1457 This option has the effect of making Vim either more Vi-compatible, or
1458 make Vim behave in a more useful way.
1459 This is a special kind of option, because when it's set or reset,
1460 other options are also changed as a side effect. CAREFUL: Setting or
1461 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001462 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 set this option in your vimrc file, you should probably put it at the
1464 very start.
1465 By default this option is on and the Vi defaults are used for the
1466 options. This default was chosen for those people who want to use Vim
1467 just like Vi, and don't even (want to) know about the 'compatible'
1468 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001469 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1470 this option is switched off, and all options that have not been
1471 modified will be set to the Vim defaults. Effectively, this means
1472 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1473 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1474 happen for the system-wide vimrc or gvimrc file). Also see
1475 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 You can also set this option with the "-C" argument, and reset it with
1477 "-N". See |-C| and |-N|.
1478 Switching this option off makes the Vim defaults be used for options
1479 that have a different Vi and Vim default value. See the options
1480 marked with a '+' below. Other options are not modified.
1481 At the moment this option is set, several other options will be set
1482 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001483 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 editing.
1485 See also 'cpoptions'.
1486
1487 option + set value effect ~
1488
1489 'allowrevins' off no CTRL-_ command
1490 'backupcopy' Unix: "yes" backup file is a copy
1491 others: "auto" copy or rename backup file
1492 'backspace' "" normal backspace
1493 'backup' off no backup file
1494 'cindent' off no C code indentation
1495 'cedit' + "" no key to open the |cmdwin|
1496 'cpoptions' + (all flags) Vi-compatible flags
1497 'cscopetag' off don't use cscope for ":tag"
1498 'cscopetagorder' 0 see |cscopetagorder|
1499 'cscopeverbose' off see |cscopeverbose|
1500 'digraph' off no digraphs
1501 'esckeys' + off no <Esc>-keys in Insert mode
1502 'expandtab' off tabs not expanded to spaces
1503 'fileformats' + "" no automatic file format detection,
1504 "dos,unix" except for DOS, Windows and OS/2
1505 'formatoptions' + "vt" Vi compatible formatting
1506 'gdefault' off no default 'g' flag for ":s"
1507 'history' + 0 no commandline history
1508 'hkmap' off no Hebrew keyboard mapping
1509 'hkmapp' off no phonetic Hebrew keyboard mapping
1510 'hlsearch' off no highlighting of search matches
1511 'incsearch' off no incremental searching
1512 'indentexpr' "" no indenting by expression
1513 'insertmode' off do not start in Insert mode
1514 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1515 characters and '_'
1516 'joinspaces' on insert 2 spaces after period
1517 'modeline' + off no modelines
1518 'more' + off no pauses in listings
1519 'revins' off no reverse insert
1520 'ruler' off no ruler
1521 'scrolljump' 1 no jump scroll
1522 'scrolloff' 0 no scroll offset
1523 'shiftround' off indent not rounded to shiftwidth
1524 'shortmess' + "" no shortening of messages
1525 'showcmd' + off command characters not shown
1526 'showmode' + off current mode not shown
1527 'smartcase' off no automatic ignore case switch
1528 'smartindent' off no smart indentation
1529 'smarttab' off no smart tab size
1530 'softtabstop' 0 tabs are always 'tabstop' positions
1531 'startofline' on goto startofline with some commands
1532 'tagrelative' + off tag file names are not relative
1533 'textauto' + off no automatic textmode detection
1534 'textwidth' 0 no automatic line wrap
1535 'tildeop' off tilde is not an operator
1536 'ttimeout' off no terminal timeout
1537 'whichwrap' + "" left-right movements don't wrap
1538 'wildchar' + CTRL-E only when the current value is <Tab>
1539 use CTRL-E for cmdline completion
1540 'writebackup' on or off depends on +writebackup feature
1541
1542 *'complete'* *'cpt'* *E535*
1543'complete' 'cpt' string (default: ".,w,b,u,t,i")
1544 local to buffer
1545 {not in Vi}
1546 This option specifies how keyword completion |ins-completion| works
1547 when CTRL-P or CTRL-N are used. It is also used for whole-line
1548 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1549 and the places to scan. It is a comma separated list of flags:
1550 . scan the current buffer ('wrapscan' is ignored)
1551 w scan buffers from other windows
1552 b scan other loaded buffers that are in the buffer list
1553 u scan the unloaded buffers that are in the buffer list
1554 U scan the buffers that are not in the buffer list
1555 k scan the files given with the 'dictionary' option
1556 k{dict} scan the file {dict}. Several "k" flags can be given,
1557 patterns are valid too. For example: >
1558 :set cpt=k/usr/dict/*,k~/spanish
1559< s scan the files given with the 'thesaurus' option
1560 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1561 are valid too.
1562 i scan current and included files
1563 d scan current and included files for defined name or macro
1564 |i_CTRL-X_CTRL-D|
1565 ] tag completion
1566 t same as "]"
1567
1568 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1569 not executed, this may lead to unexpected completions from some files
1570 (gzipped files for example). Unloaded buffers are not scanned for
1571 whole-line completion.
1572
1573 The default is ".,w,b,u,t,i", which means to scan:
1574 1. the current buffer
1575 2. buffers in other windows
1576 3. other loaded buffers
1577 4. unloaded buffers
1578 5. tags
1579 6. included files
1580
1581 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001582 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1583 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001585 *'completefunc'* *'cfu'*
1586'completefunc' 'cfu' string (default: empty)
1587 local to buffer
1588 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001589 {not available when compiled without the +eval
1590 or +insert_expand feature}
1591 This option specifies a function to be used for CTRL-X CTRL-U
1592 completion. |i_CTRL-X_CTRL-U|
1593
1594 The function will be invoked with three arguments:
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001595 a:findstart either 1 or 0
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001596 a:col column in the cursor line where the completion ends,
1597 first column is zero
1598 a:base the text with which matches should match
1599
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001600 When the a:findstart argument is 1, the function must return the
1601 column of where the completion starts. It must be a number between
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001602 zero and "a:col". This involves looking at the characters in the
1603 cursor line before column a:col and include those characters that
1604 could be part of the completed item. The text between this column and
1605 a:col will be replaced with the matches. Return -1 if no completion
1606 can be done.
1607
1608 When the a:findstart argument is 0 the function must return a List
1609 with the matching words. These matches should include the "a:base"
1610 text. When there are no matches return an empty List.
1611
Bram Moolenaar572cb562005-08-05 21:35:02 +00001612 When searching for matches takes some time call |complete_add()| to
1613 add each match to the total list. These matches should then not
1614 appear in the returned list! Call |complete_check()| now and then to
1615 allow the user to press a key while still searching for matches. Stop
1616 searching when it returns non-zero.
1617
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001618 The function must not move the cursor!
Bram Moolenaar572cb562005-08-05 21:35:02 +00001619 This option cannot be set from a |modeline| or in the |sandbox|, for
1620 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001621
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001622 An example that completes the names of the months: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001623 fun! CompleteMonths(findstart, col, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001624 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001625 " locate the start of the word
1626 let line = getline('.')
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001627 let start = a:col
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001628 while start > 0 && line[start - 1] =~ '\a'
1629 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001630 endwhile
1631 return start
1632 else
1633 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001634 let res = []
1635 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1636 if m =~ '^' . a:base
1637 call add(res, m)
1638 endif
1639 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001640 return res
1641 endif
1642 endfun
1643 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001644<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001645 The same, but now pretending searching for matches is slow: >
1646 fun! CompleteMonths(findstart, col, base)
1647 if a:findstart
1648 " locate the start of the word
1649 let line = getline('.')
1650 let start = a:col
1651 while start > 0 && line[start - 1] =~ '\a'
1652 let start -= 1
1653 endwhile
1654 return start
1655 else
1656 " find months matching with "a:base"
1657 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1658 if m =~ '^' . a:base
1659 call complete_add(m)
1660 endif
1661 sleep 300m " simulate searching for next match
1662 if complete_check()
1663 break
1664 endif
1665 endfor
1666 return []
1667 endif
1668 endfun
1669 set completefunc=CompleteMonths
1670<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001671
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1673'confirm' 'cf' boolean (default off)
1674 global
1675 {not in Vi}
1676 When 'confirm' is on, certain operations that would normally
1677 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1678 instead raise a |dialog| asking if you wish to save the current
1679 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1680 If 'confirm' is off you can still activate confirmation for one
1681 command only (this is most useful in mappings) with the |:confirm|
1682 command.
1683 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1684
1685 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1686'conskey' 'consk' boolean (default off)
1687 global
1688 {not in Vi} {only for MS-DOS}
1689 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001690 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691 three methods of console input are available:
1692 'conskey' 'bioskey' action ~
1693 on on or off direct console input
1694 off on BIOS
1695 off off STDIN
1696
1697 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1698'copyindent' 'ci' boolean (default off)
1699 local to buffer
1700 {not in Vi}
1701 Copy the structure of the existing lines indent when autoindenting a
1702 new line. Normally the new indent is reconstructed by a series of
1703 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1704 in which case only spaces are used). Enabling this option makes the
1705 new line copy whatever characters were used for indenting on the
1706 existing line. If the new indent is greater than on the existing
1707 line, the remaining space is filled in the normal manner.
1708 NOTE: 'copyindent' is reset when 'compatible' is set.
1709 Also see 'preserveindent'.
1710
1711 *'cpoptions'* *'cpo'*
1712'cpoptions' 'cpo' string (Vim default: "aABceFs",
1713 Vi default: all flags)
1714 global
1715 {not in Vi}
1716 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001717 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001718 not being vi-compatible is mostly or sometimes preferred.
1719 'cpoptions' stands for "compatible-options".
1720 Commas can be added for readability.
1721 To avoid problems with flags that are added in the future, use the
1722 "+=" and "-=" feature of ":set" |add-option-flags|.
1723 NOTE: This option is set to the Vi default value when 'compatible' is
1724 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001725 NOTE: This option is set to the POSIX default value at startup when
1726 the Vi default value would be used and the $VIM_POSIX environment
1727 variable exists |posix|. This means tries to behave like the POSIX
1728 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729
1730 contains behavior ~
1731 *cpo-a*
1732 a When included, a ":read" command with a file name
1733 argument will set the alternate file name for the
1734 current window.
1735 *cpo-A*
1736 A When included, a ":write" command with a file name
1737 argument will set the alternate file name for the
1738 current window.
1739 *cpo-b*
1740 b "\|" in a ":map" command is recognized as the end of
1741 the map command. The '\' is included in the mapping,
1742 the text after the '|' is interpreted as the next
1743 command. Use a CTRL-V instead of a backslash to
1744 include the '|' in the mapping. Applies to all
1745 mapping, abbreviation, menu and autocmd commands.
1746 See also |map_bar|.
1747 *cpo-B*
1748 B A backslash has no special meaning in mappings,
1749 abbreviations and the "to" part of the menu commands.
1750 Remove this flag to be able to use a backslash like a
1751 CTRL-V. For example, the command ":map X \<Esc>"
1752 results in X being mapped to:
1753 'B' included: "\^[" (^[ is a real <Esc>)
1754 'B' excluded: "<Esc>" (5 characters)
1755 ('<' excluded in both cases)
1756 *cpo-c*
1757 c Searching continues at the end of any match at the
1758 cursor position, but not further than the start of the
1759 next line. When not present searching continues
1760 one character from the cursor position. With 'c'
1761 "abababababab" only gets three matches when repeating
1762 "/abab", without 'c' there are five matches.
1763 *cpo-C*
1764 C Do not concatenate sourced lines that start with a
1765 backslash. See |line-continuation|.
1766 *cpo-d*
1767 d Using "./" in the 'tags' option doesn't mean to use
1768 the tags file relative to the current file, but the
1769 tags file in the current directory.
1770 *cpo-D*
1771 D Can't use CTRL-K to enter a digraph after Normal mode
1772 commands with a character argument, like |r|, |f| and
1773 |t|.
1774 *cpo-e*
1775 e When executing a register with ":@r", always add a
1776 <CR> to the last line, also when the register is not
1777 linewise. If this flag is not present, the register
1778 is not linewise and the last line does not end in a
1779 <CR>, then the last line is put on the command-line
1780 and can be edited before hitting <CR>.
1781 *cpo-E*
1782 E It is an error when using "y", "d", "c", "g~", "gu" or
1783 "gU" on an Empty region. The operators only work when
1784 at least one character is to be operate on. Example:
1785 This makes "y0" fail in the first column.
1786 *cpo-f*
1787 f When included, a ":read" command with a file name
1788 argument will set the file name for the current buffer,
1789 if the current buffer doesn't have a file name yet.
1790 *cpo-F*
1791 F When included, a ":write" command with a file name
1792 argument will set the file name for the current
1793 buffer, if the current buffer doesn't have a file name
1794 yet.
1795 *cpo-g*
1796 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001797 *cpo-H*
1798 H When using "I" on a line with only blanks, insert
1799 before the last blank. Without this flag insert after
1800 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 *cpo-i*
1802 i When included, interrupting the reading of a file will
1803 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001804 *cpo-I*
1805 I When moving the cursor up or down just after inserting
1806 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 *cpo-j*
1808 j When joining lines, only add two spaces after a '.',
1809 not after '!' or '?'. Also see 'joinspaces'.
1810 *cpo-J*
1811 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001812 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 white space.
1814 *cpo-k*
1815 k Disable the recognition of raw key codes in
1816 mappings, abbreviations, and the "to" part of menu
1817 commands. For example, if <Key> sends ^[OA (where ^[
1818 is <Esc>), the command ":map X ^[OA" results in X
1819 being mapped to:
1820 'k' included: "^[OA" (3 characters)
1821 'k' excluded: "<Key>" (one key code)
1822 Also see the '<' flag below.
1823 *cpo-K*
1824 K Don't wait for a key code to complete when it is
1825 halfway a mapping. This breaks mapping <F1><F1> when
1826 only part of the second <F1> has been read. It
1827 enables cancelling the mapping by typing <F1><Esc>.
1828 *cpo-l*
1829 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001830 literally, only "\]", "\^", "\-" and "\\" are special.
1831 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1833 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001834 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 *cpo-L*
1836 L When the 'list' option is set, 'wrapmargin',
1837 'textwidth', 'softtabstop' and Virtual Replace mode
1838 (see |gR|) count a <Tab> as two characters, instead of
1839 the normal behavior of a <Tab>.
1840 *cpo-m*
1841 m When included, a showmatch will always wait half a
1842 second. When not included, a showmatch will wait half
1843 a second or until a character is typed. |'showmatch'|
1844 *cpo-M*
1845 M When excluded, "%" matching will take backslashes into
1846 account. Thus in "( \( )" and "\( ( \)" the outer
1847 parenthesis match. When included "%" ignores
1848 backslashes, which is Vi compatible.
1849 *cpo-n*
1850 n When included, the column used for 'number' will also
1851 be used for text of wrapped lines.
1852 *cpo-o*
1853 o Line offset to search command is not remembered for
1854 next search.
1855 *cpo-O*
1856 O Don't complain if a file is being overwritten, even
1857 when it didn't exist when editing it. This is a
1858 protection against a file unexpectedly created by
1859 someone else. Vi didn't complain about this.
1860 *cpo-p*
1861 p Vi compatible Lisp indenting. When not present, a
1862 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001863 *cpo-q*
1864 q When joining multiple lines leave the cursor at the
1865 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 *cpo-r*
1867 r Redo ("." command) uses "/" to repeat a search
1868 command, instead of the actually used search string.
1869 *cpo-R*
1870 R Remove marks from filtered lines. Without this flag
1871 marks are kept like |:keepmarks| was used.
1872 *cpo-s*
1873 s Set buffer options when entering the buffer for the
1874 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001875 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 set when the buffer is created.
1877 *cpo-S*
1878 S Set buffer options always when entering a buffer
1879 (except 'readonly', 'fileformat', 'filetype' and
1880 'syntax'). This is the (most) Vi compatible setting.
1881 The options are set to the values in the current
1882 buffer. When you change an option and go to another
1883 buffer, the value is copied. Effectively makes the
1884 buffer options global to all buffers.
1885
1886 's' 'S' copy buffer options
1887 no no when buffer created
1888 yes no when buffer first entered (default)
1889 X yes each time when buffer entered (vi comp.)
1890 *cpo-t*
1891 t Search pattern for the tag command is remembered for
1892 "n" command. Otherwise Vim only puts the pattern in
1893 the history for search pattern, but doesn't change the
1894 last used search pattern.
1895 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001896 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 *cpo-v*
1898 v Backspaced characters remain visible on the screen in
1899 Insert mode. Without this flag the characters are
1900 erased from the screen right away. With this flag the
1901 screen newly typed text overwrites backspaced
1902 characters.
1903 *cpo-w*
1904 w When using "cw" on a blank character, only change one
1905 character and not all blanks until the start of the
1906 next word.
1907 *cpo-W*
1908 W Don't overwrite a readonly file. When omitted, ":w!"
1909 overwrites a readonly file, if possible.
1910 *cpo-x*
1911 x <Esc> on the command-line executes the command-line.
1912 The default in Vim is to abandon the command-line,
1913 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001914 *cpo-X*
1915 X When using a count with "R" the replaced text is
1916 deleted only once. Also when repeating "R" with "."
1917 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 *cpo-y*
1919 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001920 *cpo-Z*
1921 Z When using "w!" while the 'readonly' option is set,
1922 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 *cpo-!*
1924 ! When redoing a filter command, use the last used
1925 external command, whatever it was. Otherwise the last
1926 used -filter- command is used.
1927 *cpo-$*
1928 $ When making a change to one line, don't redisplay the
1929 line, but put a '$' at the end of the changed text.
1930 The changed text will be overwritten when you type the
1931 new text. The line is redisplayed if you type any
1932 command that moves the cursor from the insertion
1933 point.
1934 *cpo-%*
1935 % Vi-compatible matching is done for the "%" command.
1936 Does not recognize "#if", "#endif", etc.
1937 Does not recognize "/*" and "*/".
1938 Parens inside single and double quotes are also
1939 counted, causing a string that contains a paren to
1940 disturb the matching. For example, in a line like
1941 "if (strcmp("foo(", s))" the first paren does not
1942 match the last one. When this flag is not included,
1943 parens inside single and double quotes are treated
1944 specially. When matching a paren outside of quotes,
1945 everything inside quotes is ignored. When matching a
1946 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001947 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001948 This flag is also used for other features, such as
1949 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001950 *cpo--*
1951 - When included, a vertical movement command fails when
1952 it would above the first line or below the last line.
1953 Without it the cursor moves to the first or last line,
1954 unless it already was in that line.
1955 Applies to the commands "-", "k", CTRL-P, "+", "j",
1956 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001957 *cpo-+*
1958 + When included, a ":write file" command will reset the
1959 'modified' flag of the buffer, even though the buffer
1960 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001961 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 * Use ":*" in the same way as ":@". When not included,
1963 ":*" is an alias for ":'<,'>", select the Visual area.
1964 *cpo-<*
1965 < Disable the recognition of special key codes in |<>|
1966 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001967 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 ":map X <Tab>" results in X being mapped to:
1969 '<' included: "<Tab>" (5 characters)
1970 '<' excluded: "^I" (^I is a real <Tab>)
1971 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001972 *cpo->*
1973 > When appending to a register, put a line break before
1974 the appended text.
1975
1976 POSIX flags. These are not included in the Vi default value, except
1977 when $VIM_POSIX was set on startup. |posix|
1978
1979 contains behavior ~
1980 *cpo-#*
1981 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001982 *cpo-&*
1983 & When ":preserve" was used keep the swap file when
1984 exiting normally while this buffer is still loaded.
1985 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001986 *cpo-\*
1987 \ Backslash in a [] range in a search pattern is taken
1988 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001989 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1990 '\' excluded: "/[ \-]" finds <Space> and '-'
1991 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001992 *cpo-/*
1993 / When "%" is used as the replacement string in a |:s|
1994 command, use the previous replacement string. |:s%|
1995 *cpo-{*
1996 { The |{| and |}| commands also stop at a "{" character
1997 at the start of a line.
1998 *cpo-.*
1999 . The ":chdir" and ":cd" commands fail if the current
2000 buffer is modified, unless ! is used. Vim doesn't
2001 need this, since it remembers the full path of an
2002 opened file.
2003 *cpo-bar*
2004 | The value of the $LINES and $COLUMNS environment
2005 variables overrule the terminal size values obtained
2006 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002007
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008
2009 *'cscopepathcomp'* *'cspc'*
2010'cscopepathcomp' 'cspc' number (default 0)
2011 global
2012 {not available when compiled without the |+cscope|
2013 feature}
2014 {not in Vi}
2015 Determines how many components of the path to show in a list of tags.
2016 See |cscopepathcomp|.
2017
2018 *'cscopeprg'* *'csprg'*
2019'cscopeprg' 'csprg' string (default "cscope")
2020 global
2021 {not available when compiled without the |+cscope|
2022 feature}
2023 {not in Vi}
2024 Specifies the command to execute cscope. See |cscopeprg|.
2025 This option cannot be set from a |modeline| or in the |sandbox|, for
2026 security reasons.
2027
2028 *'cscopequickfix'* *'csqf'*
2029'cscopequickfix' 'csqf' string (default "")
2030 global
2031 {not available when compiled without the |+cscope|
2032 or |+quickfix| features}
2033 {not in Vi}
2034 Specifies whether to use quickfix window to show cscope results.
2035 See |cscopequickfix|.
2036
2037 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2038'cscopetag' 'cst' boolean (default off)
2039 global
2040 {not available when compiled without the |+cscope|
2041 feature}
2042 {not in Vi}
2043 Use cscope for tag commands. See |cscope-options|.
2044 NOTE: This option is reset when 'compatible' is set.
2045
2046 *'cscopetagorder'* *'csto'*
2047'cscopetagorder' 'csto' number (default 0)
2048 global
2049 {not available when compiled without the |+cscope|
2050 feature}
2051 {not in Vi}
2052 Determines the order in which ":cstag" performs a search. See
2053 |cscopetagorder|.
2054 NOTE: This option is set to 0 when 'compatible' is set.
2055
2056 *'cscopeverbose'* *'csverb'*
2057 *'nocscopeverbose'* *'nocsverb'*
2058'cscopeverbose' 'csverb' boolean (default off)
2059 global
2060 {not available when compiled without the |+cscope|
2061 feature}
2062 {not in Vi}
2063 Give messages when adding a cscope database. See |cscopeverbose|.
2064 NOTE: This option is reset when 'compatible' is set.
2065
2066 *'debug'*
2067'debug' string (default "")
2068 global
2069 {not in Vi}
2070 When set to "msg", error messages that would otherwise be omitted will
2071 be given anyway. This is useful when debugging 'foldexpr' or
2072 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002073 When set to "beep", a message will be given when otherwise only a beep
2074 would be produced.
2075 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076
2077 *'define'* *'def'*
2078'define' 'def' string (default "^\s*#\s*define")
2079 global or local to buffer |global-local|
2080 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002081 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 pattern, just like for the "/" command. This option is used for the
2083 commands like "[i" and "[d" |include-search|. The 'isident' option is
2084 used to recognize the defined name after the match:
2085 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2086 See |option-backslash| about inserting backslashes to include a space
2087 or backslash.
2088 The default value is for C programs. For C++ this value would be
2089 useful, to include const type declarations: >
2090 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2091< When using the ":set" command, you need to double the backslashes!
2092
2093 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2094'delcombine' 'deco' boolean (default off)
2095 global
2096 {not in Vi}
2097 {only available when compiled with the |+multi_byte|
2098 feature}
2099 If editing Unicode and this option is set, backspace and Normal mode
2100 "x" delete each combining character on its own. When it is off (the
2101 default) the character along with its combining characters are
2102 deleted.
2103 Note: When 'delcombine' is set "xx" may work different from "2x"!
2104
2105 This is useful for Arabic, Hebrew and many other languages where one
2106 may have combining characters overtop of base characters, and want
2107 to remove only the combining ones.
2108
2109 *'dictionary'* *'dict'*
2110'dictionary' 'dict' string (default "")
2111 global or local to buffer |global-local|
2112 {not in Vi}
2113 List of file names, separated by commas, that are used to lookup words
2114 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2115 contain a list of words. This can be one word per line, or several
2116 words per line, separated by non-keyword characters (white space is
2117 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002118 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002119 after a comma are ignored, otherwise spaces are included in the file
2120 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002121 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 Where to find a list of words?
2123 - On FreeBSD, there is the file "/usr/share/dict/words".
2124 - In the Simtel archive, look in the "msdos/linguist" directory.
2125 - In "miscfiles" of the GNU collection.
2126 The use of |:set+=| and |:set-=| is preferred when adding or removing
2127 directories from the list. This avoids problems when a future version
2128 uses another default.
2129 Backticks cannot be used in this option for security reasons.
2130
2131 *'diff'* *'nodiff'*
2132'diff' boolean (default off)
2133 local to window
2134 {not in Vi}
2135 {not available when compiled without the |+diff|
2136 feature}
2137 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139
2140 *'dex'* *'diffexpr'*
2141'diffexpr' 'dex' string (default "")
2142 global
2143 {not in Vi}
2144 {not available when compiled without the |+diff|
2145 feature}
2146 Expression which is evaluated to obtain an ed-style diff file from two
2147 versions of a file. See |diff-diffexpr|.
2148 This option cannot be set from a |modeline| or in the |sandbox|, for
2149 security reasons.
2150
2151 *'dip'* *'diffopt'*
2152'diffopt' 'dip' string (default "filler")
2153 global
2154 {not in Vi}
2155 {not available when compiled without the |+diff|
2156 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002157 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 All are optional. Items must be separated by a comma.
2159
2160 filler Show filler lines, to keep the text
2161 synchronized with a window that has inserted
2162 lines at the same position. Mostly useful
2163 when windows are side-by-side and 'scrollbind'
2164 is set.
2165
2166 context:{n} Use a context of {n} lines between a change
2167 and a fold that contains unchanged lines.
2168 When omitted a context of six lines is used.
2169 See |fold-diff|.
2170
2171 icase Ignore changes in case of text. "a" and "A"
2172 are considered the same. Adds the "-i" flag
2173 to the "diff" command if 'diffexpr' is empty.
2174
2175 iwhite Ignore changes in amount of white space. Adds
2176 the "-b" flag to the "diff" command if
2177 'diffexpr' is empty. Check the documentation
2178 of the "diff" command for what this does
2179 exactly. It should ignore adding trailing
2180 white space, but not leading white space.
2181
2182 Examples: >
2183
2184 :set diffopt=filler,context:4
2185 :set diffopt=
2186 :set diffopt=filler
2187<
2188 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2189'digraph' 'dg' boolean (default off)
2190 global
2191 {not in Vi}
2192 {not available when compiled without the |+digraphs|
2193 feature}
2194 Enable the entering of digraphs in Insert mode with {char1} <BS>
2195 {char2}. See |digraphs|.
2196 NOTE: This option is reset when 'compatible' is set.
2197
2198 *'directory'* *'dir'*
2199'directory' 'dir' string (default for Amiga: ".,t:",
2200 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2201 for Unix: ".,~/tmp,/var/tmp,/tmp")
2202 global
2203 List of directory names for the swap file, separated with commas.
2204 - The swap file will be created in the first directory where this is
2205 possible.
2206 - Empty means that no swap file will be used (recovery is
2207 impossible!).
2208 - A directory "." means to put the swap file in the same directory as
2209 the edited file. On Unix, a dot is prepended to the file name, so
2210 it doesn't show in a directory listing. On MS-Windows the "hidden"
2211 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002212 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 put the swap file relative to where the edited file is. The leading
2214 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002215 - For Unix and Win32, if a directory ends in two path separators "//"
2216 or "\\", the swap file name will be built from the complete path to
2217 the file with all path separators substituted to percent '%' signs.
2218 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 - Spaces after the comma are ignored, other spaces are considered part
2220 of the directory name. To have a space at the start of a directory
2221 name, precede it with a backslash.
2222 - To include a comma in a directory name precede it with a backslash.
2223 - A directory name may end in an ':' or '/'.
2224 - Environment variables are expanded |:set_env|.
2225 - Careful with '\' characters, type one before a space, type two to
2226 get one in the option (see |option-backslash|), for example: >
2227 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2228< - For backwards compatibility with Vim version 3.0 a '>' at the start
2229 of the option is removed.
2230 Using "." first in the list is recommended. This means that editing
2231 the same file twice will result in a warning. Using "/tmp" on Unix is
2232 discouraged: When the system crashes you lose the swap file.
2233 "/var/tmp" is often not cleared when rebooting, thus is a better
2234 choice than "/tmp". But it can contain a lot of files, your swap
2235 files get lost in the crowd. That is why a "tmp" directory in your
2236 home directory is tried first.
2237 The use of |:set+=| and |:set-=| is preferred when adding or removing
2238 directories from the list. This avoids problems when a future version
2239 uses another default.
2240 This option cannot be set from a |modeline| or in the |sandbox|, for
2241 security reasons.
2242 {Vi: directory to put temp file in, defaults to "/tmp"}
2243
2244 *'display'* *'dy'*
2245'display' 'dy' string (default "")
2246 global
2247 {not in Vi}
2248 Change the way text is displayed. This is comma separated list of
2249 flags:
2250 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002251 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 last line that doesn't fit is replaced with "@" lines.
2253 uhex Show unprintable characters hexadecimal as <xx>
2254 instead of using ^C and ~C.
2255
2256 *'eadirection'* *'ead'*
2257'eadirection' 'ead' string (default "both")
2258 global
2259 {not in Vi}
2260 {not available when compiled without the +vertsplit
2261 feature}
2262 Tells when the 'equalalways' option applies:
2263 ver vertically, width of windows is not affected
2264 hor horizontally, height of windows is not affected
2265 both width and height of windows is affected
2266
2267 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2268'edcompatible' 'ed' boolean (default off)
2269 global
2270 Makes the 'g' and 'c' flags of the ":substitute" command to be
2271 toggled each time the flag is given. See |complex-change|. See
2272 also 'gdefault' option.
2273 Switching this option on is discouraged!
2274
2275 *'encoding'* *'enc'* *E543*
2276'encoding' 'enc' string (default: "latin1" or value from $LANG)
2277 global
2278 {only available when compiled with the |+multi_byte|
2279 feature}
2280 {not in Vi}
2281 Sets the character encoding used inside Vim. It applies to text in
2282 the buffers, registers, Strings in expressions, text stored in the
2283 viminfo file, etc. It sets the kind of characters which Vim can work
2284 with. See |encoding-names| for the possible values.
2285
2286 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002287 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 It should normally be kept at its default value, or set when Vim
2289 starts up. See |multibyte|.
2290
2291 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2292 "utf-8". Although care has been taken to allow different values of
2293 'encoding', "utf-8" is the natural choice for the environment and
2294 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002295 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296 versions, and to avoid changing the encoding of newly created files
2297 without your knowledge (in case 'fileencodings' is empty).
2298
2299 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002300 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 iconv() or as specified with 'charconvert'.
2302
2303 Normally 'encoding' will be equal to your current locale. This will
2304 be the default if Vim recognizes your environment settings. If
2305 'encoding' is not set to the current locale, 'termencoding' must be
2306 set to convert typed and displayed text. See |encoding-table|.
2307
2308 When you set this option, it fires the |EncodingChanged| autocommand
2309 event so that you can set up fonts if necessary.
2310
2311 When the option is set, the value is converted to lowercase. Thus
2312 you can set it with uppercase values too. Underscores are translated
2313 to '-' signs.
2314 When the encoding is recognized, it is changed to the standard name.
2315 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2316 "iso-8859-2" and "utf8" becomes "utf-8".
2317
2318 Note: "latin1" is also used when the encoding could not be detected.
2319 This only works when editing files in the same encoding! When the
2320 actual character set is not latin1, make sure 'fileencoding' and
2321 'fileencodings' are empty. When conversion is needed, switch to using
2322 utf-8.
2323
2324 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2325 You don't notice this while editing, but it does matter for the
2326 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2327 setting 'encoding' to one of these values instead of utf-8 only has
2328 effect for encoding used for files when 'fileencoding' is empty.
2329
Bram Moolenaar661b1822005-07-28 22:36:45 +00002330 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2331 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332
2333 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2334'endofline' 'eol' boolean (default on)
2335 local to buffer
2336 {not in Vi}
2337 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 option is automatically set when starting to edit a new file, unless
2340 the file does not have an <EOL> for the last line in the file, in
2341 which case it is reset. Normally you don't have to set or reset this
2342 option. When 'binary' is off the value is not used when writing the
2343 file. When 'binary' is on it is used to remember the presence of a
2344 <EOL> for the last line in the file, so that when you write the file
2345 the situation from the original file can be kept. But you can change
2346 it if you want to.
2347
2348 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2349'equalalways' 'ea' boolean (default on)
2350 global
2351 {not in Vi}
2352 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002353 splitting or closing a window. This also happens the moment the
2354 option is switched on. When off, splitting a window will reduce the
2355 size of the current window and leave the other windows the same. When
2356 closing a window the extra lines are given to the window next to it
2357 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 When mixing vertically and horizontally split windows, a minimal size
2359 is computed and some windows may be larger if there is room. The
2360 'eadirection' option tells in which direction the size is affected.
2361 Changing the height of a window can be avoided by setting
2362 'winfixheight'.
2363
2364 *'equalprg'* *'ep'*
2365'equalprg' 'ep' string (default "")
2366 global or local to buffer |global-local|
2367 {not in Vi}
2368 External program to use for "=" command. When this option is empty
2369 the internal formatting functions are used ('lisp', 'cindent' or
2370 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002371 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 about including spaces and backslashes.
2373 This option cannot be set from a |modeline| or in the |sandbox|, for
2374 security reasons.
2375
2376 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2377'errorbells' 'eb' boolean (default off)
2378 global
2379 Ring the bell (beep or screen flash) for error messages. This only
2380 makes a difference for error messages, the bell will be used always
2381 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002382 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 screen flash or do nothing.
2384
2385 *'errorfile'* *'ef'*
2386'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2387 others: "errors.err")
2388 global
2389 {not in Vi}
2390 {not available when compiled without the |+quickfix|
2391 feature}
2392 Name of the errorfile for the QuickFix mode (see |:cf|).
2393 When the "-q" command-line argument is used, 'errorfile' is set to the
2394 following argument. See |-q|.
2395 NOT used for the ":make" command. See 'makeef' for that.
2396 Environment variables are expanded |:set_env|.
2397 See |option-backslash| about including spaces and backslashes.
2398 This option cannot be set from a |modeline| or in the |sandbox|, for
2399 security reasons.
2400
2401 *'errorformat'* *'efm'*
2402'errorformat' 'efm' string (default is very long)
2403 global or local to buffer |global-local|
2404 {not in Vi}
2405 {not available when compiled without the |+quickfix|
2406 feature}
2407 Scanf-like description of the format for the lines in the error file
2408 (see |errorformat|).
2409
2410 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2411'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2412 global
2413 {not in Vi}
2414 Function keys that start with an <Esc> are recognized in Insert
2415 mode. When this option is off, the cursor and function keys cannot be
2416 used in Insert mode if they start with an <Esc>. The advantage of
2417 this is that the single <Esc> is recognized immediately, instead of
2418 after one second. Instead of resetting this option, you might want to
2419 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2420 when 'esckeys' is off, you can still map anything, but the cursor keys
2421 won't work by default.
2422 NOTE: This option is set to the Vi default value when 'compatible' is
2423 set and to the Vim default value when 'compatible' is reset.
2424
2425 *'eventignore'* *'ei'*
2426'eventignore' 'ei' string (default "")
2427 global
2428 {not in Vi}
2429 {not available when compiled without the |+autocmd|
2430 feature}
2431 A list of autocommand event names, which are to be ignored.
2432 When set to "all", all autocommand events are ignored, autocommands
2433 will not be executed.
2434 Otherwise this is a comma separated list of event names. Example: >
2435 :set ei=WinEnter,WinLeave
2436<
2437 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2438'expandtab' 'et' boolean (default off)
2439 local to buffer
2440 {not in Vi}
2441 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002442 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2444 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2445 NOTE: This option is reset when 'compatible' is set.
2446
2447 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2448'exrc' 'ex' boolean (default off)
2449 global
2450 {not in Vi}
2451 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2452 directory. If you switch this option on you should also consider
2453 setting the 'secure' option (see |initialization|). Using a local
2454 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2455 also see |.vimrc| and |gui-init|.
2456 This option cannot be set from a |modeline| or in the |sandbox|, for
2457 security reasons.
2458
2459 *'fileencoding'* *'fenc'* *E213*
2460'fileencoding' 'fenc' string (default: "")
2461 local to buffer
2462 {only available when compiled with the |+multi_byte|
2463 feature}
2464 {not in Vi}
2465 Sets the character encoding for the file of this buffer.
2466 When 'fileencoding' is different from 'encoding', conversion will be
2467 done when reading and writing the file.
2468 When 'fileencoding' is empty, the same value as 'encoding' will be
2469 used (no conversion when reading or writing a file).
2470 WARNING: Conversion can cause loss of information! When
2471 'encoding' is "utf-8" conversion is most likely done in a way
2472 that the reverse conversion results in the same text. When
2473 'encoding' is not "utf-8" some characters may be lost!
2474 See 'encoding' for the possible values. Additionally, values may be
2475 specified that can be handled by the converter, see
2476 |mbyte-conversion|.
2477 When reading a file 'fileencoding' will be set from 'fileencodings'.
2478 To read a file in a certain encoding it won't work by setting
2479 'fileencoding', use the |++enc| argument.
2480 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2481 When the option is set, the value is converted to lowercase. Thus
2482 you can set it with uppercase values too. '_' characters are
2483 replaced with '-'. If a name is recognized from the list for
2484 'encoding', it is replaced by the standard name. For example
2485 "ISO8859-2" becomes "iso-8859-2".
2486 When this option is set, after starting to edit a file, the 'modified'
2487 option is set, because the file would be different when written.
2488 If you do this in a modeline, you might want to set 'nomodified' to
2489 avoid this.
2490 This option can not be changed when 'modifiable' is off.
2491
2492 *'fe'*
2493 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002494 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 old short name was 'fe', which is no longer used.
2496
2497 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002498'fileencodings' 'fencs' string (default: "ucs-bom",
2499 "ucs-bom,utf-8,default,latin1" when
2500 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 global
2502 {only available when compiled with the |+multi_byte|
2503 feature}
2504 {not in Vi}
2505 This is a list of character encodings considered when starting to edit
2506 an existing file. When a file is read, Vim tries to use the first
2507 mentioned character encoding. If an error is detected, the next one
2508 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 an empty string, which means the value of 'encoding' is used.
2511 WARNING: Conversion can cause loss of information! When
2512 'encoding' is "utf-8" (or one of the other Unicode variants)
2513 conversion is most likely done in a way that the reverse
2514 conversion results in the same text. When 'encoding' is not
2515 "utf-8" special characters may be lost!
2516 For an empty file or a file with only ASCII characters most encodings
2517 will work and the first entry of 'fileencodings' will be used (except
2518 "ucs-bom", which requires the BOM to be present). If you prefer
2519 another encoding use an BufReadPost autocommand event to test if your
2520 preferred encoding is to be used. Example: >
2521 au BufReadPost * if search('\S', 'w') == 0 |
2522 \ set fenc=iso-2022-jp | endif
2523< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2524 non-blank characters.
2525 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2526 is always empty then. This means that a non-existing file may get a
2527 different encoding than an empty file.
2528 The special value "ucs-bom" can be used to check for a Unicode BOM
2529 (Byte Order Mark) at the start of the file. It must not be preceded
2530 by "utf-8" or another Unicode encoding for this to work properly.
2531 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2532 because Vim cannot detect an error, thus the encoding is always
2533 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002534 The special value "default" can be used for the encoding from the
2535 environment. This is the default value for 'encoding'. It is useful
2536 when 'encoding' is set to "utf-8" and your environment uses a
2537 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 WRONG VALUES: WHAT'S WRONG:
2539 latin1,utf-8 "latin1" will always be used
2540 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2541 file
2542 cp1250,latin1 "cp1250" will always be used
2543 If 'fileencodings' is empty, 'fileencoding' is not modified.
2544 See 'fileencoding' for the possible values.
2545 Setting this option does not have an effect until the next time a file
2546 is read.
2547
2548 *'fileformat'* *'ff'*
2549'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2550 Unix default: "unix",
2551 Macintosh default: "mac")
2552 local to buffer
2553 {not in Vi}
2554 This gives the <EOL> of the current buffer, which is used for
2555 reading/writing the buffer from/to a file:
2556 dos <CR> <NL>
2557 unix <NL>
2558 mac <CR>
2559 When "dos" is used, CTRL-Z at the end of a file is ignored.
2560 See |file-formats| and |file-read|.
2561 For the character encoding of the file see 'fileencoding'.
2562 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2563 works like it was set to "unix'.
2564 This option is set automatically when starting to edit a file and
2565 'fileformats' is not empty and 'binary' is off.
2566 When this option is set, after starting to edit a file, the 'modified'
2567 option is set, because the file would be different when written.
2568 This option can not be changed when 'modifiable' is off.
2569 For backwards compatibility: When this option is set to "dos",
2570 'textmode' is set, otherwise 'textmode' is reset.
2571
2572 *'fileformats'* *'ffs'*
2573'fileformats' 'ffs' string (default:
2574 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2575 Vim Unix: "unix,dos",
2576 Vim Mac: "mac,unix,dos",
2577 Vi Cygwin: "unix,dos",
2578 Vi others: "")
2579 global
2580 {not in Vi}
2581 This gives the end-of-line (<EOL>) formats that will be tried when
2582 starting to edit a new buffer and when reading a file into an existing
2583 buffer:
2584 - When empty, the format defined with 'fileformat' will be used
2585 always. It is not set automatically.
2586 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002587 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588 'fileformats' name will be used when a file is read into an existing
2589 buffer, no matter what 'fileformat' for that buffer is set to.
2590 - When more than one name is present, separated by commas, automatic
2591 <EOL> detection will be done when reading a file. When starting to
2592 edit a file, a check is done for the <EOL>:
2593 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2594 'fileformat' is set to "dos".
2595 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002596 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 preceding <CR>, "unix" is preferred over "dos".
2598 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2599 This means that "mac" is only chosen when "unix" is not present,
2600 or when no <NL> is found in the file, and when "dos" is not
2601 present, or no <CR><NL> is present in the file.
2602 Also if "unix" was first chosen, but the first <CR> is before
2603 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2604 the file, then 'fileformat' is set to "mac".
2605 4. If 'fileformat' is still not set, the first name from
2606 'fileformats' is used.
2607 When reading a file into an existing buffer, the same is done, but
2608 this happens like 'fileformat' has been set appropriately for that
2609 file only, the option is not changed.
2610 When 'binary' is set, the value of 'fileformats' is not used.
2611
2612 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2613 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2614 done:
2615 - When 'fileformats' is empty, there is no automatic detection. Dos
2616 format will be used.
2617 - When 'fileformats' is set to one or more names, automatic detection
2618 is done. This is based on the first <NL> in the file: If there is a
2619 <CR> in front of it, Dos format is used, otherwise Unix format is
2620 used.
2621 Also see |file-formats|.
2622 For backwards compatibility: When this option is set to an empty
2623 string or one format (no comma is included), 'textauto' is reset,
2624 otherwise 'textauto' is set.
2625 NOTE: This option is set to the Vi default value when 'compatible' is
2626 set and to the Vim default value when 'compatible' is reset.
2627
2628 *'filetype'* *'ft'*
2629'filetype' 'ft' string (default: "")
2630 local to buffer
2631 {not in Vi}
2632 {not available when compiled without the |+autocmd|
2633 feature}
2634 When this option is set, the FileType autocommand event is triggered.
2635 All autocommands that match with the value of this option will be
2636 executed. Thus the value of 'filetype' is used in place of the file
2637 name.
2638 Otherwise this option does not always reflect the current file type.
2639 This option is normally set when the file type is detected. To enable
2640 this use the ":filetype on" command. |:filetype|
2641 Setting this option to a different value is most useful in a modeline,
2642 for a file for which the file type is not automatically recognized.
2643 Example, for in an IDL file: >
2644 /* vim: set filetype=idl : */
2645< |FileType| |filetypes|
2646 Do not confuse this option with 'osfiletype', which is for the file
2647 type that is actually stored with the file.
2648 This option is not copied to another buffer, independent of the 's' or
2649 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002650 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651
2652 *'fillchars'* *'fcs'*
2653'fillchars' 'fcs' string (default "vert:|,fold:-")
2654 global
2655 {not in Vi}
2656 {not available when compiled without the |+windows|
2657 and |+folding| features}
2658 Characters to fill the statuslines and vertical separators.
2659 It is a comma separated list of items:
2660
2661 item default Used for ~
2662 stl:c ' ' or '^' statusline of the current window
2663 stlnc:c ' ' or '-' statusline of the non-current windows
2664 vert:c '|' vertical separators |:vsplit|
2665 fold:c '-' filling 'foldtext'
2666 diff:c '-' deleted lines of the 'diff' option
2667
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002668 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 "stlnc" the space will be used when there is highlighting, '^' or '-'
2670 otherwise.
2671
2672 Example: >
2673 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2674< This is similar to the default, except that these characters will also
2675 be used when there is highlighting.
2676
2677 The highlighting used for these items:
2678 item highlight group ~
2679 stl:c StatusLine |hl-StatusLine|
2680 stlnc:c StatusLineNC |hl-StatusLineNC|
2681 vert:c VertSplit |hl-VertSplit|
2682 fold:c Folded |hl-Folded|
2683 diff:c DiffDelete |hl-DiffDelete|
2684
2685 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2686'fkmap' 'fk' boolean (default off) *E198*
2687 global
2688 {not in Vi}
2689 {only available when compiled with the |+rightleft|
2690 feature}
2691 When on, the keyboard is mapped for the Farsi character set.
2692 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002693 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'foldclose'* *'fcl'*
2696'foldclose' 'fcl' string (default "")
2697 global
2698 {not in Vi}
2699 {not available when compiled without the |+folding|
2700 feature}
2701 When set to "all", a fold is closed when the cursor isn't in it and
2702 its level is higher than 'foldlevel'. Useful if you want folds to
2703 automatically close when moving out of them.
2704
2705 *'foldcolumn'* *'fdc'*
2706'foldcolumn' 'fdc' number (default 0)
2707 local to window
2708 {not in Vi}
2709 {not available when compiled without the |+folding|
2710 feature}
2711 When non-zero, a column with the specified width is shown at the side
2712 of the window which indicates open and closed folds. The maximum
2713 value is 12.
2714 See |folding|.
2715
2716 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2717'foldenable' 'fen' boolean (default on)
2718 local to window
2719 {not in Vi}
2720 {not available when compiled without the |+folding|
2721 feature}
2722 When off, all folds are open. This option can be used to quickly
2723 switch between showing all text unfolded and viewing the text with
2724 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002725 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 'foldenable' is off.
2727 This option is set by commands that create a new fold or close a fold.
2728 See |folding|.
2729
2730 *'foldexpr'* *'fde'*
2731'foldexpr' 'fde' string (default: "0")
2732 local to window
2733 {not in Vi}
2734 {not available when compiled without the |+folding|
2735 or |+eval| feature}
2736 The expression used for when 'foldmethod' is "expr". It is evaluated
2737 for each line to obtain its fold level. See |fold-expr|. Also see
2738 |eval-sandbox|.
2739
2740 *'foldignore'* *'fdi'*
2741'foldignore' 'fdi' string (default: "#")
2742 local to window
2743 {not in Vi}
2744 {not available when compiled without the |+folding|
2745 feature}
2746 Used only when 'foldmethod' is "indent". Lines starting with
2747 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002748 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 The default "#" works well for C programs. See |fold-indent|.
2750
2751 *'foldlevel'* *'fdl'*
2752'foldlevel' 'fdl' number (default: 0)
2753 local to window
2754 {not in Vi}
2755 {not available when compiled without the |+folding|
2756 feature}
2757 Sets the fold level: Folds with a higher level will be closed.
2758 Setting this option to zero will close all folds. Higher numbers will
2759 close fewer folds.
2760 This option is set by commands like |zm|, |zM| and |zR|.
2761 See |fold-foldlevel|.
2762
2763 *'foldlevelstart'* *'fdls'*
2764'foldlevelstart' 'fdls' number (default: -1)
2765 global
2766 {not in Vi}
2767 {not available when compiled without the |+folding|
2768 feature}
2769 Sets 'foldlevel' when starting to edit another buffer in a window.
2770 Useful to always start editing with all folds closed (value zero),
2771 some folds closed (one) or no folds closed (99).
2772 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002773 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 ignores this option and closes all folds.
2775 It is also done before BufReadPre autocommands, to allow an autocmd to
2776 overrule the 'foldlevel' value for specific files.
2777 When the value is negative, it is not used.
2778
2779 *'foldmarker'* *'fmr'* *E536*
2780'foldmarker' 'fmr' string (default: "{{{,}}}")
2781 local to window
2782 {not in Vi}
2783 {not available when compiled without the |+folding|
2784 feature}
2785 The start and end marker used when 'foldmethod' is "marker". There
2786 must be one comma, which separates the start and end marker. The
2787 marker is a literal string (a regular expression would be too slow).
2788 See |fold-marker|.
2789
2790 *'foldmethod'* *'fdm'*
2791'foldmethod' 'fdm' string (default: "manual")
2792 local to window
2793 {not in Vi}
2794 {not available when compiled without the |+folding|
2795 feature}
2796 The kind of folding used for the current window. Possible values:
2797 |fold-manual| manual Folds are created manually.
2798 |fold-indent| indent Lines with equal indent form a fold.
2799 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2800 |fold-marker| marker Markers are used to specify folds.
2801 |fold-syntax| syntax Syntax highlighting items specify folds.
2802 |fold-diff| diff Fold text that is not changed.
2803
2804 *'foldminlines'* *'fml'*
2805'foldminlines' 'fml' number (default: 1)
2806 local to window
2807 {not in Vi}
2808 {not available when compiled without the |+folding|
2809 feature}
2810 Sets the minimum number of screen lines for a fold to be displayed
2811 closed. Also for manually closed folds.
2812 Note that this only has an effect of what is displayed. After using
2813 "zc" to close a fold, which is displayed open because it's smaller
2814 than 'foldminlines', a following "zc" may close a containing fold.
2815
2816 *'foldnestmax'* *'fdn'*
2817'foldnestmax' 'fdn' number (default: 20)
2818 local to window
2819 {not in Vi}
2820 {not available when compiled without the |+folding|
2821 feature}
2822 Sets the maximum nesting of folds for the "indent" and "syntax"
2823 methods. This avoids that too many folds will be created. Using more
2824 than 20 doesn't work, because the internal limit is 20.
2825
2826 *'foldopen'* *'fdo'*
2827'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2828 search,tag,undo")
2829 global
2830 {not in Vi}
2831 {not available when compiled without the |+folding|
2832 feature}
2833 Specifies for which type of commands folds will be opened, if the
2834 command moves the cursor into a closed fold. It is a comma separated
2835 list of items.
2836 item commands ~
2837 all any
2838 block "(", "{", "[[", "[{", etc.
2839 hor horizontal movements: "l", "w", "fx", etc.
2840 insert any command in Insert mode
2841 jump far jumps: "G", "gg", etc.
2842 mark jumping to a mark: "'m", CTRL-O, etc.
2843 percent "%"
2844 quickfix ":cn", ":crew", ":make", etc.
2845 search search for a pattern: "/", "n", "*", "gd", etc.
2846 (not for a search pattern in a ":" command)
2847 tag jumping to a tag: ":ta", CTRL-T, etc.
2848 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002849 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 the |zv| command to the mapping to get the same effect.
2851 When a movement command is used for an operator (e.g., "dl" or "y%")
2852 this option is not used. This means the operator will include the
2853 whole closed fold.
2854 Note that vertical movements are not here, because it would make it
2855 very difficult to move onto a closed fold.
2856 In insert mode the folds containing the cursor will always be open
2857 when text is inserted.
2858 To close folds you can re-apply 'foldlevel' with the |zx| command or
2859 set the 'foldclose' option to "all".
2860
2861 *'foldtext'* *'fdt'*
2862'foldtext' 'fdt' string (default: "foldtext()")
2863 local to window
2864 {not in Vi}
2865 {not available when compiled without the |+folding|
2866 feature}
2867 An expression which is used to specify the text displayed for a closed
2868 fold. See |fold-foldtext|.
2869
2870 *'formatoptions'* *'fo'*
2871'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2872 local to buffer
2873 {not in Vi}
2874 This is a sequence of letters which describes how automatic
2875 formatting is to be done. See |fo-table|. When the 'paste' option is
2876 on, no formatting is done (like 'formatoptions' is empty). Commas can
2877 be inserted for readability.
2878 To avoid problems with flags that are added in the future, use the
2879 "+=" and "-=" feature of ":set" |add-option-flags|.
2880 NOTE: This option is set to the Vi default value when 'compatible' is
2881 set and to the Vim default value when 'compatible' is reset.
2882
Bram Moolenaar86b68352004-12-27 21:59:20 +00002883 *'formatlistpat'* *'flp'*
2884'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2885 local to buffer
2886 {not in Vi}
2887 A pattern that is used to recognize a list header. This is used for
2888 the "n" flag in 'formatoptions'.
2889 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002890 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002891 while still checking more characters. There must be a character
2892 following the pattern, when it matches the whole line it is handled
2893 like there is no match.
2894 The default recognizes a number, followed by an optional punctuation
2895 character and white space.
2896
Bram Moolenaar071d4272004-06-13 20:20:40 +00002897 *'formatprg'* *'fp'*
2898'formatprg' 'fp' string (default "")
2899 global
2900 {not in Vi}
2901 The name of an external program that will be used to format the lines
2902 selected with the "gq" command. The program must take the input on
2903 stdin and produce the output on stdout. The Unix program "fmt" is
2904 such a program. If this option is an empty string, the internal
2905 format function will be used |C-indenting|. Environment variables are
2906 expanded |:set_env|. See |option-backslash| about including spaces
2907 and backslashes.
2908 This option cannot be set from a |modeline| or in the |sandbox|, for
2909 security reasons.
2910
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002911 *'fsync'* *'fs'*
2912'fsync' 'fs' boolean (default on)
2913 global
2914 {not in Vi}
2915 When on, the library function fsync() will be called after writing a
2916 file. This will flush a file to disk, ensuring that it is safely
2917 written even on filesystems which do metadata-only journaling. This
2918 will force the harddrive to spin up on Linux systems running in laptop
2919 mode, so it may be undesirable in some situations. Be warned that
2920 turning this off increases the chances of data loss after a crash. On
2921 systems without an fsync() implementation, this variable is always
2922 off.
2923 Also see 'swapsync' for controlling fsync() on swap files.
2924
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2926'gdefault' 'gd' boolean (default off)
2927 global
2928 {not in Vi}
2929 When on, the ":substitute" flag 'g' is default on. This means that
2930 all matches in a line are substituted instead of one. When a 'g' flag
2931 is given to a ":substitute" command, this will toggle the substitution
2932 of all or one match. See |complex-change|.
2933
2934 command 'gdefault' on 'gdefault' off ~
2935 :s/// subst. all subst. one
2936 :s///g subst. one subst. all
2937 :s///gg subst. all subst. one
2938
2939 NOTE: This option is reset when 'compatible' is set.
2940
2941 *'grepformat'* *'gfm'*
2942'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2943 global
2944 {not in Vi}
2945 Format to recognize for the ":grep" command output.
2946 This is a scanf-like string that uses the same format as the
2947 'errorformat' option: see |errorformat|.
2948
2949 *'grepprg'* *'gp'*
2950'grepprg' 'gp' string (default "grep -n ",
2951 Unix: "grep -n $* /dev/null",
2952 Win32: "findstr /n" or "grep -n",
2953 VMS: "SEARCH/NUMBERS ")
2954 global or local to buffer |global-local|
2955 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002956 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957 and '#' characters, which are expanded like when used in a command-
2958 line. The placeholder "$*" is allowed to specify where the arguments
2959 will be included. Environment variables are expanded |:set_env|. See
2960 |option-backslash| about including spaces and backslashes.
2961 When your "grep" accepts the "-H" argument, use this to make ":grep"
2962 also work well with a single file: >
2963 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002964< Special value: When 'grepprg' is set to "internal" the |:grep| command
2965 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002966 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 apply equally to 'grepprg'.
2968 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2969 otherwise it's "grep -n".
2970 This option cannot be set from a |modeline| or in the |sandbox|, for
2971 security reasons.
2972
2973 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2974'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2975 ve:ver35-Cursor,
2976 o:hor50-Cursor,
2977 i-ci:ver25-Cursor/lCursor,
2978 r-cr:hor20-Cursor/lCursor,
2979 sm:block-Cursor
2980 -blinkwait175-blinkoff150-blinkon175",
2981 for MS-DOS and Win32 console:
2982 "n-v-c:block,o:hor50,i-ci:hor15,
2983 r-cr:hor30,sm:block")
2984 global
2985 {not in Vi}
2986 {only available when compiled with GUI enabled, and
2987 for MS-DOS and Win32 console}
2988 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002989 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 the height of the cursor can be changed. This can be done by
2991 specifying a block cursor, or a percentage for a vertical or
2992 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002993 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 mode-list and an argument-list:
2997 mode-list:argument-list,mode-list:argument-list,..
2998 The mode-list is a dash separated list of these modes:
2999 n Normal mode
3000 v Visual mode
3001 ve Visual mode with 'selection' "exclusive" (same as 'v',
3002 if not specified)
3003 o Operator-pending mode
3004 i Insert mode
3005 r Replace mode
3006 c Command-line Normal (append) mode
3007 ci Command-line Insert mode
3008 cr Command-line Replace mode
3009 sm showmatch in Insert mode
3010 a all modes
3011 The argument-list is a dash separated list of these arguments:
3012 hor{N} horizontal bar, {N} percent of the character height
3013 ver{N} vertical bar, {N} percent of the character width
3014 block block cursor, fills the whole character
3015 [only one of the above three should be present]
3016 blinkwait{N} *cursor-blinking*
3017 blinkon{N}
3018 blinkoff{N}
3019 blink times for cursor: blinkwait is the delay before
3020 the cursor starts blinking, blinkon is the time that
3021 the cursor is shown and blinkoff is the time that the
3022 cursor is not shown. The times are in msec. When one
3023 of the numbers is zero, there is no blinking. The
3024 default is: "blinkwait700-blinkon400-blinkoff250".
3025 These numbers are used for a missing entry. This
3026 means that blinking is enabled by default. To switch
3027 blinking off you can use "blinkon0". The cursor only
3028 blinks when Vim is waiting for input, not while
3029 executing a command.
3030 To make the cursor blink in an xterm, see
3031 |xterm-blink|.
3032 {group-name}
3033 a highlight group name, that sets the color and font
3034 for the cursor
3035 {group-name}/{group-name}
3036 Two highlight group names, the first is used when
3037 no language mappings are used, the other when they
3038 are. |language-mapping|
3039
3040 Examples of parts:
3041 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3042 block cursor with colors from the "nCursor"
3043 highlight group
3044 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3045 In Insert and Command-line Insert mode, use a
3046 30% vertical bar cursor with colors from the
3047 "iCursor" highlight group. Blink a bit
3048 faster.
3049
3050 The 'a' mode is different. It will set the given argument-list for
3051 all modes. It does not reset anything to defaults. This can be used
3052 to do a common setting for all modes. For example, to switch off
3053 blinking: "a:blinkon0"
3054
3055 Examples of cursor highlighting: >
3056 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3057 :highlight Cursor gui=NONE guifg=bg guibg=fg
3058<
3059 *'guifont'* *'gfn'*
3060 *E235* *E596* *E610* *E611*
3061'guifont' 'gfn' string (default "")
3062 global
3063 {not in Vi}
3064 {only available when compiled with GUI enabled}
3065 This is a list of fonts which will be used for the GUI version of Vim.
3066 In its simplest form the value is just one font name. When
3067 the font cannot be found you will get an error message. To try other
3068 font names a list can be specified, font names separated with commas.
3069 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003070
Bram Moolenaar05159a02005-02-26 23:04:13 +00003071 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3072 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003073
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 Spaces after a comma are ignored. To include a comma in a font name
3075 precede it with a backslash. Setting an option requires an extra
3076 backslash before a space and a backslash. See also
3077 |option-backslash|. For example: >
3078 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003079< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003081
3082 If none of the fonts can be loaded, Vim will keep the current setting.
3083 If an empty font list is given, Vim will try using other resource
3084 settings (for X, it will use the Vim.font resource), and finally it
3085 will try some builtin default which should always be there ("7x13" in
3086 the case of X). The font names given should be "normal" fonts. Vim
3087 will try to find the related bold and italic fonts.
3088
Bram Moolenaar05159a02005-02-26 23:04:13 +00003089 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003090 :set guifont=*
3091< will bring up a font requester, where you can pick the font you want.
3092
3093 The font name depends on the GUI used. See |setting-guifont| for a
3094 way to set 'guifont' for various systems.
3095
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 For the GTK+ 2 GUI the font name looks like this: >
3097 :set guifont=Andale\ Mono\ 11
3098< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003099
3100 For Mac OSX you can use something like this: >
3101 :set guifont=Monaco:h10
3102< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003104 width). An exception is GTK 2: all fonts are accepted, but
3105 mono-spaced fonts look best.
3106
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 To preview a font on X11, you might be able to use the "xfontsel"
3108 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 For the Win32 GUI *E244* *E245*
3111 - takes these options in the font name:
3112 hXX - height is XX (points, can be floating-point)
3113 wXX - width is XX (points, can be floating-point)
3114 b - bold
3115 i - italic
3116 u - underline
3117 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003118 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3120 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3121 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003122 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123
3124 Use a ':' to separate the options.
3125 - A '_' can be used in the place of a space, so you don't need to use
3126 backslashes to escape the spaces.
3127 - Examples: >
3128 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3129 :set guifont=Andale_Mono:h7.5:w4.5
3130< See also |font-sizes|.
3131
3132 *'guifontset'* *'gfs'*
3133 *E250* *E252* *E234* *E597* *E598*
3134'guifontset' 'gfs' string (default "")
3135 global
3136 {not in Vi}
3137 {only available when compiled with GUI enabled and
3138 with the |+xfontset| feature}
3139 {not available in the GTK+ 2 GUI}
3140 When not empty, specifies two (or more) fonts to be used. The first
3141 one for normal English, the second one for your special language. See
3142 |xfontset|.
3143 Setting this option also means that all font names will be handled as
3144 a fontset name. Also the ones used for the "font" argument of the
3145 |:highlight| command.
3146 The fonts must match with the current locale. If fonts for the
3147 character sets that the current locale uses are not included, setting
3148 'guifontset' will fail.
3149 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3150 the comma-separated names are alternative names, one of which will be
3151 used. In 'guifontset' the whole string is one fontset name,
3152 including the commas. It is not possible to specify alternative
3153 fontset names.
3154 This example works on many X11 systems: >
3155 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3156<
3157 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3158'guifontwide' 'gfw' string (default "")
3159 global
3160 {not in Vi}
3161 {only available when compiled with GUI enabled}
3162 When not empty, specifies a comma-separated list of fonts to be used
3163 for double-width characters. The first font that can be loaded is
3164 used.
3165 Note: The size of these fonts must be exactly twice as wide as the one
3166 specified with 'guifont' and the same height.
3167
3168 All GUI versions but GTK+ 2:
3169
3170 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3171 'guifontset' is empty or invalid.
3172 When 'guifont' is set and a valid font is found in it and
3173 'guifontwide' is empty Vim will attempt to find a matching
3174 double-width font and set 'guifontwide' to it.
3175
3176 GTK+ 2 GUI only: *guifontwide_gtk2*
3177
3178 If set and valid, 'guifontwide' is always used for double width
3179 characters, even if 'encoding' is not set to "utf-8".
3180 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003181 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 font for characters not available in 'guifont'. Thus you do not need
3183 to set 'guifontwide' at all unless you want to override the choice
3184 made by Pango/Xft.
3185
3186 *'guiheadroom'* *'ghr'*
3187'guiheadroom' 'ghr' number (default 50)
3188 global
3189 {not in Vi} {only for GTK and X11 GUI}
3190 The number of pixels subtracted from the screen height when fitting
3191 the GUI window on the screen. Set this before the GUI is started,
3192 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003193 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 lines will be left for window decorations and other items on the
3195 screen. Set it to a negative value to allow windows taller than the
3196 screen.
3197
3198 *'guioptions'* *'go'*
3199'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003200 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 global
3202 {not in Vi}
3203 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003204 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205 sequence of letters which describes what components and options of the
3206 GUI should be used.
3207 To avoid problems with flags that are added in the future, use the
3208 "+=" and "-=" feature of ":set" |add-option-flags|.
3209
3210 Valid letters are as follows:
3211 *guioptions_a*
3212 'a' Autoselect: If present, then whenever VISUAL mode is started,
3213 or the Visual area extended, Vim tries to become the owner of
3214 the windowing system's global selection. This means that the
3215 Visually highlighted text is available for pasting into other
3216 applications as well as into Vim itself. When the Visual mode
3217 ends, possibly due to an operation on the text, or when an
3218 application wants to paste the selection, the highlighted text
3219 is automatically yanked into the "* selection register.
3220 Thus the selection is still available for pasting into other
3221 applications after the VISUAL mode has ended.
3222 If not present, then Vim won't become the owner of the
3223 windowing system's global selection unless explicitly told to
3224 by a yank or delete operation for the "* register.
3225 The same applies to the modeless selection.
3226
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003227 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 applies to the modeless selection.
3229
3230 'guioptions' autoselect Visual autoselect modeless ~
3231 "" - -
3232 "a" yes yes
3233 "A" - yes
3234 "aA" yes yes
3235
3236 'c' Use console dialogs instead of popup dialogs for simple
3237 choices.
3238
3239 'f' Foreground: Don't use fork() to detach the GUI from the shell
3240 where it was started. Use this for programs that wait for the
3241 editor to finish (e.g., an e-mail program). Alternatively you
3242 can use "gvim -f" or ":gui -f" to start the GUI in the
3243 foreground. |gui-fork|
3244 Note: Set this option in the vimrc file. The forking may have
3245 happened already when the gvimrc file is read.
3246
3247 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3248 corner of the window. It's black&white on non-GTK, because of
3249 limitations of X11. For a color icon, see |X11-icon|.
3250
3251 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003252 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 that this flag must be added in the .vimrc file, before
3254 switching on syntax or filetype recognition (when the .gvimrc
3255 file is sourced the system menu has already been loaded; the
3256 ":syntax on" and ":filetype on" commands load the menu too).
3257 'g' Grey menu items: Make menu items that are not active grey. If
3258 'g' is not included inactive menu items are not shown at all.
3259 Exception: Athena will always use grey menu items.
3260
3261 't' Include tearoff menu items. Currently only works for Win32,
3262 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003263 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3264 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265
3266 'r' Right-hand scrollbar is always present.
3267 'R' Right-hand scrollbar is present when there is a vertically
3268 split window.
3269 'l' Left-hand scrollbar is always present.
3270 'L' Left-hand scrollbar is present when there is a vertically
3271 split window.
3272 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3273 the longest visible line, or on the cursor line if the 'h'
3274 flag is included. |gui-horiz-scroll|
3275 'h' Limit horizontal scrollbar size to the length of the cursor
3276 line. Reduces computations. |gui-horiz-scroll|
3277
3278 And yes, you may even have scrollbars on the left AND the right if
3279 you really want to :-). See |gui-scrollbars| for more information.
3280
3281 'v' Use a vertical button layout for dialogs. When not included,
3282 a horizontal layout is preferred, but when it doesn't fit a
3283 vertical layout is used anyway.
3284 'p' Use Pointer callbacks for X11 GUI. This is required for some
3285 window managers. If the cursor is not blinking or hollow at
3286 the right moment, try adding this flag. This must be done
3287 before starting the GUI. Set it in your gvimrc. Adding or
3288 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003289 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290
3291 *'guipty'* *'noguipty'*
3292'guipty' boolean (default on)
3293 global
3294 {not in Vi}
3295 {only available when compiled with GUI enabled}
3296 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3297 I/O to/from shell commands. See |gui-pty|.
3298
3299 *'helpfile'* *'hf'*
3300'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3301 (others) "$VIMRUNTIME/doc/help.txt")
3302 global
3303 {not in Vi}
3304 Name of the main help file. All distributed help files should be
3305 placed together in one directory. Additionally, all "doc" directories
3306 in 'runtimepath' will be used.
3307 Environment variables are expanded |:set_env|. For example:
3308 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003309 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 spaces and backslashes.
3311 This option cannot be set from a |modeline| or in the |sandbox|, for
3312 security reasons.
3313
3314 *'helpheight'* *'hh'*
3315'helpheight' 'hh' number (default 20)
3316 global
3317 {not in Vi}
3318 {not available when compiled without the +windows
3319 feature}
3320 Minimal initial height of the help window when it is opened with the
3321 ":help" command. The initial height of the help window is half of the
3322 current window, or (when the 'ea' option is on) the same as other
3323 windows. When the height is less than 'helpheight', the height is
3324 set to 'helpheight'. Set to zero to disable.
3325
3326 *'helplang'* *'hlg'*
3327'helplang' 'hlg' string (default: messages language or empty)
3328 global
3329 {only available when compiled with the |+multi_lang|
3330 feature}
3331 {not in Vi}
3332 Comma separated list of languages. Vim will use the first language
3333 for which the desired help can be found. The English help will always
3334 be used as a last resort. You can add "en" to prefer English over
3335 another language, but that will only find tags that exist in that
3336 language and not in the English help.
3337 Example: >
3338 :set helplang=de,it
3339< This will first search German, then Italian and finally English help
3340 files.
3341 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3342 try to find the tag in the current language before using this option.
3343 See |help-translated|.
3344
3345 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3346'hidden' 'hid' boolean (default off)
3347 global
3348 {not in Vi}
3349 When off a buffer is unloaded when it is |abandon|ed. When on a
3350 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3351 displayed in another window, it does not become hidden, of course.
3352 The commands that move through the buffer list sometimes make a buffer
3353 hidden although the 'hidden' option is off: When the buffer is
3354 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003356 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003357 This option is set for one command with ":hide {command}" |:hide|.
3358 WARNING: It's easy to forget that you have changes in hidden buffers.
3359 Think twice when using ":q!" or ":qa!".
3360
3361 *'highlight'* *'hl'*
3362'highlight' 'hl' string (default (as a single string):
3363 "8:SpecialKey,@:NonText,d:Directory,
3364 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3365 M:ModeMsg,n:LineNr,r:Question,
3366 s:StatusLine,S:StatusLineNC,c:VertSplit
3367 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3368 f:Folded,F:FoldColumn,A:DiffAdd,
3369 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003370 >:SignColumn,B:SpellBad,P:SpellCap,
3371 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 global
3373 {not in Vi}
3374 This option can be used to set highlighting mode for various
3375 occasions. It is a comma separated list of character pairs. The
3376 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003377 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3379 |hl-NonText| @ '~' and '@' at the end of the window and
3380 characters from 'showbreak'
3381 |hl-Directory| d directories in CTRL-D listing and other special
3382 things in listings
3383 |hl-ErrorMsg| e error messages
3384 h (obsolete, ignored)
3385 |hl-IncSearch| i 'incsearch' highlighting
3386 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3387 |hl-MoreMsg| m |more-prompt|
3388 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3389 |hl-LineNr| n line number for ":number" and ":#" commands
3390 |hl-Question| r |hit-enter| prompt and yes/no questions
3391 |hl-StatusLine| s status line of current window |status-line|
3392 |hl-StatusLineNC| S status lines of not-current windows
3393 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3394 |hl-VertSplit| c column used to separate vertically split windows
3395 |hl-Visual| v Visual mode
3396 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3397 Selection" Only X11 Gui's |gui-x11| and
3398 |xterm-clipboard|.
3399 |hl-WarningMsg| w warning messages
3400 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3401 |hl-Folded| f line used for closed folds
3402 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003403 |hl-DiffAdd| A added line in diff mode
3404 |hl-DiffChange| C changed line in diff mode
3405 |hl-DiffDelete| D deleted line in diff mode
3406 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003408 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003409 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003410 |hl-SpellRare| R rare word |spell|
3411 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412
3413 The display modes are:
3414 r reverse (termcap entry "mr" and "me")
3415 i italic (termcap entry "ZH" and "ZR")
3416 b bold (termcap entry "md" and "me")
3417 s standout (termcap entry "so" and "se")
3418 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003419 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 n no highlighting
3421 - no highlighting
3422 : use a highlight group
3423 The default is used for occasions that are not included.
3424 If you want to change what the display modes do, see |dos-colors|
3425 for an example.
3426 When using the ':' display mode, this must be followed by the name of
3427 a highlight group. A highlight group can be used to define any type
3428 of highlighting, including using color. See |:highlight| on how to
3429 define one. The default uses a different group for each occasion.
3430 See |highlight-default| for the default highlight groups.
3431
3432 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3433'hlsearch' 'hls' boolean (default off)
3434 global
3435 {not in Vi}
3436 {not available when compiled without the
3437 |+extra_search| feature}
3438 When there is a previous search pattern, highlight all its matches.
3439 The type of highlighting used can be set with the 'l' occasion in the
3440 'highlight' option. This uses the "Search" highlight group by
3441 default. Note that only the matching text is highlighted, any offsets
3442 are not applied.
3443 See also: 'incsearch' and |:match|.
3444 When you get bored looking at the highlighted matches, you can turn it
3445 off with |:nohlsearch|. As soon as you use a search command, the
3446 highlighting comes back.
3447 When the search pattern can match an end-of-line, Vim will try to
3448 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003449 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 line below a closed fold. A match in a previous line which is not
3451 drawn may not continue in an newly drawn line.
3452 NOTE: This option is reset when 'compatible' is set.
3453
3454 *'history'* *'hi'*
3455'history' 'hi' number (Vim default: 20, Vi default: 0)
3456 global
3457 {not in Vi}
3458 A history of ":" commands, and a history of previous search patterns
3459 are remembered. This option decides how many entries may be stored in
3460 each of these histories (see |cmdline-editing|).
3461 NOTE: This option is set to the Vi default value when 'compatible' is
3462 set and to the Vim default value when 'compatible' is reset.
3463
3464 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3465'hkmap' 'hk' boolean (default off)
3466 global
3467 {not in Vi}
3468 {only available when compiled with the |+rightleft|
3469 feature}
3470 When on, the keyboard is mapped for the Hebrew character set.
3471 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3472 toggle this option. See |rileft.txt|.
3473 NOTE: This option is reset when 'compatible' is set.
3474
3475 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3476'hkmapp' 'hkp' boolean (default off)
3477 global
3478 {not in Vi}
3479 {only available when compiled with the |+rightleft|
3480 feature}
3481 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3482 This is useful if you have a non-Hebrew keyboard.
3483 See |rileft.txt|.
3484 NOTE: This option is reset when 'compatible' is set.
3485
3486 *'icon'* *'noicon'*
3487'icon' boolean (default off, on when title can be restored)
3488 global
3489 {not in Vi}
3490 {not available when compiled without the |+title|
3491 feature}
3492 When on, the icon text of the window will be set to the value of
3493 'iconstring' (if it is not empty), or to the name of the file
3494 currently being edited. Only the last part of the name is used.
3495 Overridden by the 'iconstring' option.
3496 Only works if the terminal supports setting window icons (currently
3497 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3498 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3499 builtin termcap).
3500 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003501 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 X11.
3503
3504 *'iconstring'*
3505'iconstring' string (default "")
3506 global
3507 {not in Vi}
3508 {not available when compiled without the |+title|
3509 feature}
3510 When this option is not empty, it will be used for the icon text of
3511 the window. This happens only when the 'icon' option is on.
3512 Only works if the terminal supports setting window icon text
3513 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3514 Does not work for MS Windows.
3515 When Vim was compiled with HAVE_X11 defined, the original icon will be
3516 restored if possible |X11|.
3517 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003518 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 'titlestring' for example settings.
3520 {not available when compiled without the |+statusline| feature}
3521
3522 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3523'ignorecase' 'ic' boolean (default off)
3524 global
3525 Ignore case in search patterns. Also used when searching in the tags
3526 file.
3527 Also see 'smartcase'.
3528 Can be overruled by using "\c" or "\C" in the pattern, see
3529 |/ignorecase|.
3530
3531 *'imactivatekey'* *'imak'*
3532'imactivatekey' 'imak' string (default "")
3533 global
3534 {not in Vi}
3535 {only available when compiled with |+xim| and
3536 |+GUI_GTK|}
3537 Specifies the key that your Input Method in X-Windows uses for
3538 activation. When this is specified correctly, vim can fully control
3539 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3540 You can't use this option to change the activation key, the option
3541 tells Vim what the key is.
3542 Format:
3543 [MODIFIER_FLAG-]KEY_STRING
3544
3545 These characters can be used for MODIFIER_FLAG (case is ignored):
3546 S Shift key
3547 L Lock key
3548 C Control key
3549 1 Mod1 key
3550 2 Mod2 key
3551 3 Mod3 key
3552 4 Mod4 key
3553 5 Mod5 key
3554 Combinations are allowed, for example "S-C-space" or "SC-space" are
3555 both shift+ctrl+space.
3556 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3557
3558 Example: >
3559 :set imactivatekey=S-space
3560< "S-space" means shift+space. This is the activation key for kinput2 +
3561 canna (Japanese), and ami (Korean).
3562
3563 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3564'imcmdline' 'imc' boolean (default off)
3565 global
3566 {not in Vi}
3567 {only available when compiled with the |+xim|
3568 |+multi_byte_ime| or |global-ime| feature}
3569 When set the Input Method is always on when starting to edit a command
3570 line, unless entering a search pattern (see 'imsearch' for that).
3571 Setting this option is useful when your input method allows entering
3572 English characters directly, e.g., when it's used to type accented
3573 characters with dead keys.
3574
3575 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3576'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3577 global
3578 {not in Vi}
3579 {only available when compiled with the |+xim|
3580 |+multi_byte_ime| or |global-ime| feature}
3581 When set the Input Method is never used. This is useful to disable
3582 the IM when it doesn't work properly.
3583 Currently this option is on by default for SGI/IRIX machines. This
3584 may change in later releases.
3585
3586 *'iminsert'* *'imi'*
3587'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3588 local to buffer
3589 {not in Vi}
3590 Specifies whether :lmap or an Input Method (IM) is to be used in
3591 Insert mode. Valid values:
3592 0 :lmap is off and IM is off
3593 1 :lmap is ON and IM is off
3594 2 :lmap is off and IM is ON
3595 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3596 or |global-ime|.
3597 To always reset the option to zero when leaving Insert mode with <Esc>
3598 this can be used: >
3599 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3600< This makes :lmap and IM turn off automatically when leaving Insert
3601 mode.
3602 Note that this option changes when using CTRL-^ in Insert mode
3603 |i_CTRL-^|.
3604 The value is set to 1 when setting 'keymap' to a valid keymap name.
3605 It is also used for the argument of commands like "r" and "f".
3606 The value 0 may not work correctly with Athena and Motif with some XIM
3607 methods. Use 'imdisable' to disable XIM then.
3608
3609 *'imsearch'* *'ims'*
3610'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3611 local to buffer
3612 {not in Vi}
3613 Specifies whether :lmap or an Input Method (IM) is to be used when
3614 entering a search pattern. Valid values:
3615 -1 the value of 'iminsert' is used, makes it look like
3616 'iminsert' is also used when typing a search pattern
3617 0 :lmap is off and IM is off
3618 1 :lmap is ON and IM is off
3619 2 :lmap is off and IM is ON
3620 Note that this option changes when using CTRL-^ in Command-line mode
3621 |c_CTRL-^|.
3622 The value is set to 1 when it is not -1 and setting the 'keymap'
3623 option to a valid keymap name.
3624 The value 0 may not work correctly with Athena and Motif with some XIM
3625 methods. Use 'imdisable' to disable XIM then.
3626
3627 *'include'* *'inc'*
3628'include' 'inc' string (default "^\s*#\s*include")
3629 global or local to buffer |global-local|
3630 {not in Vi}
3631 {not available when compiled without the
3632 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003633 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003634 pattern, just like for the "/" command (See |pattern|). The default
3635 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003636 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637 name that comes after the matched pattern. See |option-backslash|
3638 about including spaces and backslashes.
3639
3640 *'includeexpr'* *'inex'*
3641'includeexpr' 'inex' string (default "")
3642 local to buffer
3643 {not in Vi}
3644 {not available when compiled without the
3645 |+find_in_path| or |+eval| feature}
3646 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003647 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 :set includeexpr=substitute(v:fname,'\\.','/','g')
3649< The "v:fname" variable will be set to the file name that was detected.
3650 Evaluated in the |sandbox|.
3651 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003652 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 Also used for |<cfile>|.
3654
3655 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3656'incsearch' 'is' boolean (default off)
3657 global
3658 {not in Vi}
3659 {not available when compiled without the
3660 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003661 While typing a search command, show where the pattern, as it was typed
3662 so far, matches. The matched string is highlighted. If the pattern
3663 is invalid or not found, nothing is shown. The screen will be updated
3664 often, this is only useful on fast terminals.
3665 Note that the match will be shown, but the cursor will return to its
3666 original position when no match is found and when pressing <Esc>. You
3667 still need to finish the search command with <Enter> to move the
3668 cursor to the match.
3669 The highlighting can be set with the 'i' flag in 'highlight'.
3670 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 NOTE: This option is reset when 'compatible' is set.
3672
3673 *'indentexpr'* *'inde'*
3674'indentexpr' 'inde' string (default "")
3675 local to buffer
3676 {not in Vi}
3677 {not available when compiled without the |+cindent|
3678 or |+eval| features}
3679 Expression which is evaluated to obtain the proper indent for a line.
3680 It is used when a new line is created, for the |=| operator and
3681 in Insert mode as specified with the 'indentkeys' option.
3682 When this option is not empty, it overrules the 'cindent' and
3683 'smartindent' indenting.
3684 When 'paste' is set this option is not used for indenting.
3685 The expression is evaluated with |v:lnum| set to the line number for
3686 which the indent is to be computed. The cursor is also as this line
3687 when the expression is evaluated (but it may be moved around).
3688 The expression must return the number of spaces worth of indent. It
3689 can return "-1" to keep the current indent (this means 'autoindent' is
3690 used for the indent).
3691 Functions useful for computing the indent are |indent()|, |cindent()|
3692 and |lispindent()|.
3693 The evaluation of the expression must not have side effects! It must
3694 not change the text, jump to another window, etc. Afterwards the
3695 cursor position is always restored, thus the cursor may be moved.
3696 Normally this option would be set to call a function: >
3697 :set indentexpr=GetMyIndent()
3698< Error messages will be suppressed, unless the 'debug' option contains
3699 "msg".
3700 See |indent-expression|. Also see |eval-sandbox|.
3701 NOTE: This option is made empty when 'compatible' is set.
3702
3703 *'indentkeys'* *'indk'*
3704'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3705 local to buffer
3706 {not in Vi}
3707 {not available when compiled without the |+cindent|
3708 feature}
3709 A list of keys that, when typed in Insert mode, cause reindenting of
3710 the current line. Only happens if 'indentexpr' isn't empty.
3711 The format is identical to 'cinkeys', see |indentkeys-format|.
3712 See |C-indenting| and |indent-expression|.
3713
3714 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3715'infercase' 'inf' boolean (default off)
3716 local to buffer
3717 {not in Vi}
3718 When doing keyword completion in insert mode |ins-completion|, and
3719 'ignorecase' is also on, the case of the match is adjusted. If the
3720 typed text contains a lowercase letter where the match has an upper
3721 case letter, the completed part is made lowercase. If the typed text
3722 has no lowercase letters and the match has a lowercase letter where
3723 the typed text has an uppercase letter, and there is a letter before
3724 it, the completed part is made uppercase.
3725
3726 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3727'insertmode' 'im' boolean (default off)
3728 global
3729 {not in Vi}
3730 Makes Vim work in a way that Insert mode is the default mode. Useful
3731 if you want to use Vim as a modeless editor. Used for |evim|.
3732 These Insert mode commands will be useful:
3733 - Use the cursor keys to move around.
3734 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3735 this is a mapping, it is executed as if 'insertmode' was off.
3736 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003738 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3739 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003740
3741 These items change when 'insertmode' is set:
3742 - when starting to edit of a file, Vim goes to Insert mode.
3743 - <Esc> in Insert mode is a no-op and beeps.
3744 - <Esc> in Normal mode makes Vim go to Insert mode.
3745 - CTRL-L in Insert mode is a command, it is not inserted.
3746 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3747 However, when <Esc> is used inside a mapping, it behaves like
3748 'insertmode' was not set. This was done to be able to use the same
3749 mappings with 'insertmode' set or not set.
3750 When executing commands with |:normal| 'insertmode' is not used.
3751
3752 NOTE: This option is reset when 'compatible' is set.
3753
3754 *'isfname'* *'isf'*
3755'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3756 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3757 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3758 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3759 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3760 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3761 global
3762 {not in Vi}
3763 The characters specified by this option are included in file names and
3764 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003765 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003766 Multi-byte characters 256 and above are always included, only the
3767 characters up to 255 are specified with this option.
3768 For UTF-8 the characters 0xa0 to 0xff are included as well.
3769
3770 Note that on systems using a backslash as path separator, Vim tries to
3771 do its best to make it work as you would expect. That is a bit
3772 tricky, since Vi originally used the backslash to escape special
3773 characters. Vim will not remove a backslash in front of a normal file
3774 name character on these systems, but it will on Unix and alikes. The
3775 '&' and '^' are not included by default, because these are special for
3776 cmd.exe.
3777
3778 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003779 Each part can be a single character number or a range. A range is two
3780 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 decimal number between 0 and 255 or the ASCII character itself (does
3782 not work for digits). Example:
3783 "_,-,128-140,#-43" (include '_' and '-' and the range
3784 128 to 140 and '#' to 43)
3785 If a part starts with '^', the following character number or range
3786 will be excluded from the option. The option is interpreted from left
3787 to right. Put the excluded character after the range where it is
3788 included. To include '^' itself use it as the last character of the
3789 option or the end of a range. Example:
3790 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3791 If the character is '@', all characters where isalpha() returns TRUE
3792 are included. Normally these are the characters a to z and A to Z,
3793 plus accented characters. To include '@' itself use "@-@". Examples:
3794 "@,^a-z" All alphabetic characters, excluding lower
3795 case letters.
3796 "a-z,A-Z,@-@" All letters plus the '@' character.
3797 A comma can be included by using it where a character number is
3798 expected. Example:
3799 "48-57,,,_" Digits, comma and underscore.
3800 A comma can be excluded by prepending a '^'. Example:
3801 " -~,^,,9" All characters from space to '~', excluding
3802 comma, plus <Tab>.
3803 See |option-backslash| about including spaces and backslashes.
3804
3805 *'isident'* *'isi'*
3806'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3807 "@,48-57,_,128-167,224-235"
3808 otherwise: "@,48-57,_,192-255")
3809 global
3810 {not in Vi}
3811 The characters given by this option are included in identifiers.
3812 Identifiers are used in recognizing environment variables and after a
3813 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003814 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 option.
3816 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003817 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3819
3820 *'iskeyword'* *'isk'*
3821'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3822 "@,48-57,_,128-167,224-235"
3823 otherwise: "@,48-57,_,192-255"
3824 Vi default: "@,48-57,_")
3825 local to buffer
3826 {not in Vi}
3827 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003828 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 'isfname' for a description of the format of this option. For C
3830 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3831 For a help file it is set to all non-blank printable characters except
3832 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3833 command).
3834 When the 'lisp' option is on the '-' character is always included.
3835 NOTE: This option is set to the Vi default value when 'compatible' is
3836 set and to the Vim default value when 'compatible' is reset.
3837
3838 *'isprint'* *'isp'*
3839'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3840 "@,~-255"; otherwise: "@,161-255")
3841 global
3842 {not in Vi}
3843 The characters given by this option are displayed directly on the
3844 screen. It is also used for "\p" in a |pattern|. The characters from
3845 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3846 even when they are not included in 'isprint' or excluded. See
3847 'isfname' for a description of the format of this option.
3848
3849 Non-printable characters are displayed with two characters:
3850 0 - 31 "^@" - "^_"
3851 32 - 126 always single characters
3852 127 "^?"
3853 128 - 159 "~@" - "~_"
3854 160 - 254 "| " - "|~"
3855 255 "~?"
3856 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3857 displayed as <xx>, with the hexadecimal value of the byte.
3858 When 'display' contains "uhex" all unprintable characters are
3859 displayed as <xx>.
3860 The NonText highlighting will be used for unprintable characters.
3861 |hl-NonText|
3862
3863 Multi-byte characters 256 and above are always included, only the
3864 characters up to 255 are specified with this option. When a character
3865 is printable but it is not available in the current font, a
3866 replacement character will be shown.
3867 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3868 There is no option to specify these characters.
3869
3870 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3871'joinspaces' 'js' boolean (default on)
3872 global
3873 {not in Vi}
3874 Insert two spaces after a '.', '?' and '!' with a join command.
3875 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3876 Otherwise only one space is inserted.
3877 NOTE: This option is set when 'compatible' is set.
3878
3879 *'key'*
3880'key' string (default "")
3881 local to buffer
3882 {not in Vi}
3883 The key that is used for encrypting and decrypting the current buffer.
3884 See |encryption|.
3885 Careful: Do not set the key value by hand, someone might see the typed
3886 key. Use the |:X| command. But you can make 'key' empty: >
3887 :set key=
3888< It is not possible to get the value of this option with ":set key" or
3889 "echo &key". This is to avoid showing it to someone who shouldn't
3890 know. It also means you cannot see it yourself once you have set it,
3891 be careful not to make a typing error!
3892
3893 *'keymap'* *'kmp'* *E544*
3894'keymap' 'kmp' string (default "")
3895 local to buffer
3896 {not in Vi}
3897 {only available when compiled with the |+keymap|
3898 feature}
3899 Name of a keyboard mapping. See |mbyte-keymap|.
3900 Setting this option to a valid keymap name has the side effect of
3901 setting 'iminsert' to one, so that the keymap becomes effective.
3902 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003903 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904
3905 *'keymodel'* *'km'*
3906'keymodel' 'km' string (default "")
3907 global
3908 {not in Vi}
3909 List of comma separated words, which enable special things that keys
3910 can do. These values can be used:
3911 startsel Using a shifted special key starts selection (either
3912 Select mode or Visual mode, depending on "key" being
3913 present in 'selectmode').
3914 stopsel Using a not-shifted special key stops selection.
3915 Special keys in this context are the cursor keys, <End>, <Home>,
3916 <PageUp> and <PageDown>.
3917 The 'keymodel' option is set by the |:behave| command.
3918
3919 *'keywordprg'* *'kp'*
3920'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3921 OS/2: "view /", VMS: "help")
3922 global or local to buffer |global-local|
3923 {not in Vi}
3924 Program to use for the |K| command. Environment variables are
3925 expanded |:set_env|. ":help" may be used to access the Vim internal
3926 help. (Note that previously setting the global option to the empty
3927 value did this, which is now deprecated.)
3928 When "man" is used, Vim will automatically translate a count for the
3929 "K" command to a section number. Also for "man -s", in which case the
3930 "-s" is removed when there is no count.
3931 See |option-backslash| about including spaces and backslashes.
3932 Example: >
3933 :set keywordprg=man\ -s
3934< This option cannot be set from a |modeline| or in the |sandbox|, for
3935 security reasons.
3936
3937 *'langmap'* *'lmap'* *E357* *E358*
3938'langmap' 'lmap' string (default "")
3939 global
3940 {not in Vi}
3941 {only available when compiled with the |+langmap|
3942 feature}
3943 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003944 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945 inserted directly. When in command mode the 'langmap' option takes
3946 care of translating these special characters to the original meaning
3947 of the key. This means you don't have to change the keyboard mode to
3948 be able to execute Normal mode commands.
3949 This is the opposite of the 'keymap' option, where characters are
3950 mapped in Insert mode.
3951 This only works for 8-bit characters. The value of 'langmap' may be
3952 specified with multi-byte characters (e.g., UTF-8), but only the lower
3953 8 bits of each character will be used.
3954
3955 Example (for Greek): *greek* >
3956 :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
3957< Example (exchanges meaning of z and y for commands): >
3958 :set langmap=zy,yz,ZY,YZ
3959<
3960 The 'langmap' option is a list of parts, separated with commas. Each
3961 part can be in one of two forms:
3962 1. A list of pairs. Each pair is a "from" character immediately
3963 followed by the "to" character. Examples: "aA", "aAbBcC".
3964 2. A list of "from" characters, a semi-colon and a list of "to"
3965 characters. Example: "abc;ABC"
3966 Example: "aA,fgh;FGH,cCdDeE"
3967 Special characters need to be preceded with a backslash. These are
3968 ";", ',' and backslash itself.
3969
3970 This will allow you to activate vim actions without having to switch
3971 back and forth between the languages. Your language characters will
3972 be understood as normal vim English characters (according to the
3973 langmap mappings) in the following cases:
3974 o Normal/Visual mode (commands, buffer/register names, user mappings)
3975 o Insert/Replace Mode: Register names after CTRL-R
3976 o Insert/Replace Mode: Mappings
3977 Characters entered in Command-line mode will NOT be affected by
3978 this option. Note that this option can be changed at any time
3979 allowing to switch between mappings for different languages/encodings.
3980 Use a mapping to avoid having to type it each time!
3981
3982 *'langmenu'* *'lm'*
3983'langmenu' 'lm' string (default "")
3984 global
3985 {not in Vi}
3986 {only available when compiled with the |+menu| and
3987 |+multi_lang| features}
3988 Language to use for menu translation. Tells which file is loaded
3989 from the "lang" directory in 'runtimepath': >
3990 "lang/menu_" . &langmenu . ".vim"
3991< (without the spaces). For example, to always use the Dutch menus, no
3992 matter what $LANG is set to: >
3993 :set langmenu=nl_NL.ISO_8859-1
3994< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003995 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 If your $LANG is set to a non-English language but you do want to use
3997 the English menus: >
3998 :set langmenu=none
3999< This option must be set before loading menus, switching on filetype
4000 detection or syntax highlighting. Once the menus are defined setting
4001 this option has no effect. But you could do this: >
4002 :source $VIMRUNTIME/delmenu.vim
4003 :set langmenu=de_DE.ISO_8859-1
4004 :source $VIMRUNTIME/menu.vim
4005< Warning: This deletes all menus that you defined yourself!
4006
4007 *'laststatus'* *'ls'*
4008'laststatus' 'ls' number (default 1)
4009 global
4010 {not in Vi}
4011 The value of this option influences when the last window will have a
4012 status line:
4013 0: never
4014 1: only if there are at least two windows
4015 2: always
4016 The screen looks nicer with a status line if you have several
4017 windows, but it takes another screen line. |status-line|
4018
4019 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4020'lazyredraw' 'lz' boolean (default off)
4021 global
4022 {not in Vi}
4023 When this option is set, the screen will not be redrawn while
4024 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004025 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 update use |:redraw|.
4027
4028 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4029'linebreak' 'lbr' boolean (default off)
4030 local to window
4031 {not in Vi}
4032 {not available when compiled without the |+linebreak|
4033 feature}
4034 If on Vim will wrap long lines at a character in 'breakat' rather
4035 than at the last character that fits on the screen. Unlike
4036 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4037 it only affects the way the file is displayed, not its contents. The
4038 value of 'showbreak' is used to put in front of wrapped lines.
4039 This option is not used when the 'wrap' option is off or 'list' is on.
4040 Note that <Tab> characters after an <EOL> are mostly not displayed
4041 with the right amount of white space.
4042
4043 *'lines'* *E593*
4044'lines' number (default 24 or terminal height)
4045 global
4046 Number of lines of the Vim window.
4047 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004048 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004049 When Vim is running in the GUI or in a resizable window, setting this
4050 option will cause the window size to be changed. When you only want
4051 to use the size for the GUI, put the command in your |gvimrc| file.
4052 Vim limits the number of lines to what fits on the screen. You can
4053 use this command to get the tallest window possible: >
4054 :set lines=999
4055< If you get less lines than expected, check the 'guiheadroom' option.
4056 When you set this option and Vim is unable to change the physical
4057 number of lines of the display, the display may be messed up.
4058
4059 *'linespace'* *'lsp'*
4060'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4061 global
4062 {not in Vi}
4063 {only in the GUI}
4064 Number of pixel lines inserted between characters. Useful if the font
4065 uses the full character cell height, making lines touch each other.
4066 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004067 With some fonts there can be too much room between lines (to have
4068 space for ascents and descents). Then it makes sense to set
4069 'linespace' to a negative value. This may cause display problems
4070 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071
4072 *'lisp'* *'nolisp'*
4073'lisp' boolean (default off)
4074 local to buffer
4075 {not available when compiled without the |+lispindent|
4076 feature}
4077 Lisp mode: When <Enter> is typed in insert mode set the indent for
4078 the next line to Lisp standards (well, sort of). Also happens with
4079 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4080 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4081 better. Also see 'lispwords'.
4082 The '-' character is included in keyword characters. Redefines the
4083 "=" operator to use this same indentation algorithm rather than
4084 calling an external program if 'equalprg' is empty.
4085 This option is not used when 'paste' is set.
4086 {Vi: Does it a little bit differently}
4087
4088 *'lispwords'* *'lw'*
4089'lispwords' 'lw' string (default is very long)
4090 global
4091 {not in Vi}
4092 {not available when compiled without the |+lispindent|
4093 feature}
4094 Comma separated list of words that influence the Lisp indenting.
4095 |'lisp'|
4096
4097 *'list'* *'nolist'*
4098'list' boolean (default off)
4099 local to window
4100 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4101 see the difference between tabs and spaces and for trailing blanks.
4102 Note that this will also affect formatting (set with 'textwidth' or
4103 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4104 changing the way tabs are displayed.
4105
4106 *'listchars'* *'lcs'*
4107'listchars' 'lcs' string (default "eol:$")
4108 global
4109 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004110 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 settings.
4112 eol:c Character to show at the end of each line. When
4113 omitted, there is no extra character at the end of the
4114 line.
4115 tab:xy Two characters to be used to show a Tab. The first
4116 char is used once. The second char is repeated to
4117 fill the space that the Tab normally occupies.
4118 "tab:>-" will show a Tab that takes four spaces as
4119 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004120 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 trailing spaces are blank.
4122 extends:c Character to show in the last column, when 'wrap' is
4123 off and the line continues beyond the right of the
4124 screen.
4125 precedes:c Character to show in the first column, when 'wrap'
4126 is off and there is text preceding the character
4127 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004128 nbsp:c Character to show for a non-breakable space (character
4129 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004131 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 be used when 'encoding' is "utf-8", otherwise only printable
4133 characters are allowed.
4134
4135 Examples: >
4136 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004137 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 :set lcs=extends:>,precedes:<
4139< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004140 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141
4142 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4143'loadplugins' 'lpl' boolean (default on)
4144 global
4145 {not in Vi}
4146 When on the plugin scripts are loaded when starting up |load-plugins|.
4147 This option can be reset in your |vimrc| file to disable the loading
4148 of plugins.
4149 Note that using the "-u NONE" and "--noplugin" command line arguments
4150 reset this option. |-u| |--noplugin|
4151
4152 *'magic'* *'nomagic'*
4153'magic' boolean (default on)
4154 global
4155 Changes the special characters that can be used in search patterns.
4156 See |pattern|.
4157 NOTE: To avoid portability problems with using patterns, always keep
4158 this option at the default "on". Only switch it off when working with
4159 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004160 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161
4162 *'makeef'* *'mef'*
4163'makeef' 'mef' string (default: "")
4164 global
4165 {not in Vi}
4166 {not available when compiled without the |+quickfix|
4167 feature}
4168 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4169 and the |:grep| command.
4170 When it is empty, an internally generated temp file will be used.
4171 When "##" is included, it is replaced by a number to make the name
4172 unique. This makes sure that the ":make" command doesn't overwrite an
4173 existing file.
4174 NOT used for the ":cf" command. See 'errorfile' for that.
4175 Environment variables are expanded |:set_env|.
4176 See |option-backslash| about including spaces and backslashes.
4177 This option cannot be set from a |modeline| or in the |sandbox|, for
4178 security reasons.
4179
4180 *'makeprg'* *'mp'*
4181'makeprg' 'mp' string (default "make", VMS: "MMS")
4182 global or local to buffer |global-local|
4183 {not in Vi}
4184 Program to use for the ":make" command. See |:make_makeprg|. This
4185 option may contain '%' and '#' characters, which are expanded like
4186 when used in a command-line. Environment variables are expanded
4187 |:set_env|. See |option-backslash| about including spaces and
4188 backslashes. Note that a '|' must be escaped twice: once for ":set"
4189 and once for the interpretation of a command. When you use a filter
4190 called "myfilter" do it like this: >
4191 :set makeprg=gmake\ \\\|\ myfilter
4192< The placeholder "$*" can be given (even multiple times) to specify
4193 where the arguments will be included, for example: >
4194 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4195< This option cannot be set from a |modeline| or in the |sandbox|, for
4196 security reasons.
4197
4198 *'matchpairs'* *'mps'*
4199'matchpairs' 'mps' string (default "(:),{:},[:]")
4200 local to buffer
4201 {not in Vi}
4202 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004203 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204 must be different. The characters must be separated by a colon. The
4205 pairs must be separated by a comma. Example for including '<' and '>'
4206 (HTML): >
4207 :set mps+=<:>
4208
4209< A more exotic example, to jump between the '=' and ';' in an
4210 assignment, useful for languages like C and Java: >
4211 :au FileType c,cpp,java set mps+==:;
4212
4213< For a more advanced way of using "%", see the matchit.vim plugin in
4214 the $VIMRUNTIME/macros directory. |add-local-help|
4215
4216 *'matchtime'* *'mat'*
4217'matchtime' 'mat' number (default 5)
4218 global
4219 {not in Vi}{in Nvi}
4220 Tenths of a second to show the matching paren, when 'showmatch' is
4221 set. Note that this is not in milliseconds, like other options that
4222 set a time. This is to be compatible with Nvi.
4223
4224 *'maxfuncdepth'* *'mfd'*
4225'maxfuncdepth' 'mfd' number (default 100)
4226 global
4227 {not in Vi}
4228 Maximum depth of function calls for user functions. This normally
4229 catches endless recursion. When using a recursive function with
4230 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4231 more memory, there is the danger of failing when memory is exhausted.
4232 See also |:function|.
4233
4234 *'maxmapdepth'* *'mmd'* *E223*
4235'maxmapdepth' 'mmd' number (default 1000)
4236 global
4237 {not in Vi}
4238 Maximum number of times a mapping is done without resulting in a
4239 character to be used. This normally catches endless mappings, like
4240 ":map x y" with ":map y x". It still does not catch ":map g wg",
4241 because the 'w' is used before the next mapping is done. See also
4242 |key-mapping|.
4243
4244 *'maxmem'* *'mm'*
4245'maxmem' 'mm' number (default between 256 to 5120 (system
4246 dependent) or half the amount of memory
4247 available)
4248 global
4249 {not in Vi}
4250 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4251 limit is reached allocating extra memory for a buffer will cause
4252 other memory to be freed. Maximum value 2000000. Use this to work
4253 without a limit. Also see 'maxmemtot'.
4254
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004255 *'maxmempattern'* *'mmp'*
4256'maxmempattern' 'mmp' number (default 1000)
4257 global
4258 {not in Vi}
4259 Maximum amount of memory (in Kbyte) to use for pattern matching.
4260 Maximum value 2000000. Use this to work without a limit.
4261 *E363*
4262 When Vim runs into the limit it gives an error message mostly behaves
4263 like CTRL-C was typed.
4264 Running into the limit often means that the pattern is very
4265 inefficient or too complex. This may already happen with the pattern
4266 "\(.\)*" on a very long line. ".*" works much better.
4267 Vim may run out of memory before hitting the 'maxmempattern' limit.
4268
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 *'maxmemtot'* *'mmt'*
4270'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4271 dependent) or half the amount of memory
4272 available)
4273 global
4274 {not in Vi}
4275 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 'maxmem'.
4278
4279 *'menuitems'* *'mis'*
4280'menuitems' 'mis' number (default 25)
4281 global
4282 {not in Vi}
4283 {not available when compiled without the |+menu|
4284 feature}
4285 Maximum number of items to use in a menu. Used for menus that are
4286 generated from a list of items, e.g., the Buffers menu. Changing this
4287 option has no direct effect, the menu must be refreshed first.
4288
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004289 *'mkspellmem'* *'msm'*
4290'mkspellmem' 'msm' string (default "460000,2000,500")
4291 global
4292 {not in Vi}
4293 {not available when compiled without the |+syntax|
4294 feature}
4295 Parameters for |:mkspell|. This tunes when to start compressing the
4296 word tree. Compression can be slow when there are many words, but
4297 it's needed to avoid running out of memory. The amount of memory used
4298 per word depends very much on how similar the words are, that's why
4299 this tuning is complicated.
4300
4301 There are three numbers, separated by commas:
4302 {start},{inc},{added}
4303
4304 For most languages the uncompressed word tree fits in memory. {start}
4305 gives the amount of memory in Kbyte that can be used before any
4306 compression is done. It should be a bit smaller than the amount of
4307 memory that is available to Vim.
4308
4309 When going over the {start} limit the {inc} number specifies the
4310 amount of memory in Kbyte that can be allocated before another
4311 compression is done. A low number means compression is done after
4312 less words are added, which is slow. A high number means more memory
4313 will be allocated.
4314
4315 After doing compression, {added} times 1024 words can be added before
4316 the {inc} limit is ignored and compression is done when any extra
4317 amount of memory is needed. A low number means there is a smaller
4318 chance of hitting the {inc} limit, less memory is used but it's
4319 slower.
4320
4321 The languages for which these numbers are important are Italian and
4322 Hungarian. The default works for when you have about 512 Mbyte. If
4323 you have 1 Gbyte you could use: >
4324 :set mkspellmem=900000,3000,800
4325< If you have less than 512 Mbyte |:mkspell| may fail for some
4326 languages, no matter what you set 'mkspellmem' to.
4327
Bram Moolenaar071d4272004-06-13 20:20:40 +00004328 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4329'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4330 local to buffer
4331 *'modelines'* *'mls'*
4332'modelines' 'mls' number (default 5)
4333 global
4334 {not in Vi}
4335 If 'modeline' is on 'modelines' gives the number of lines that is
4336 checked for set commands. If 'modeline' is off or 'modelines' is zero
4337 no lines are checked. See |modeline|.
4338 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4339 set and to the Vim default value when 'compatible' is reset.
4340
4341 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4342'modifiable' 'ma' boolean (default on)
4343 local to buffer
4344 {not in Vi} *E21*
4345 When off the buffer contents cannot be changed. The 'fileformat' and
4346 'fileencoding' options also can't be changed.
4347 Can be reset with the |-M| command line argument.
4348
4349 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4350'modified' 'mod' boolean (default off)
4351 local to buffer
4352 {not in Vi}
4353 When on, the buffer is considered to be modified. This option is set
4354 when:
4355 1. A change was made to the text since it was last written. Using the
4356 |undo| command to go back to the original text will reset the
4357 option. But undoing changes that were made before writing the
4358 buffer will set the option again, since the text is different from
4359 when it was written.
4360 2. 'fileformat' or 'fileencoding' is different from its original
4361 value. The original value is set when the buffer is read or
4362 written. A ":set nomodified" command also resets the original
4363 values to the current values and the 'modified' option will be
4364 reset.
4365 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4366 will be ignored.
4367
4368 *'more'* *'nomore'*
4369'more' boolean (Vim default: on, Vi default: off)
4370 global
4371 {not in Vi}
4372 When on, listings pause when the whole screen is filled. You will get
4373 the |more-prompt|. When this option is off there are no pauses, the
4374 listing continues until finished.
4375 NOTE: This option is set to the Vi default value when 'compatible' is
4376 set and to the Vim default value when 'compatible' is reset.
4377
4378 *'mouse'* *E538*
4379'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4380 global
4381 {not in Vi}
4382 Enable the use of the mouse. Only works for certain terminals
4383 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4384 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4385 The mouse can be enabled for different modes:
4386 n Normal mode
4387 v Visual mode
4388 i Insert mode
4389 c Command-line mode
4390 h all previous modes when editing a help file
4391 a all previous modes
4392 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 Normally you would enable the mouse in all four modes with: >
4394 :set mouse=a
4395< When the mouse is not enabled, the GUI will still use the mouse for
4396 modeless selection. This doesn't move the text cursor.
4397
4398 See |mouse-using|. Also see |'clipboard'|.
4399
4400 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004401 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 the mouse buttons can still be used by keeping the shift key pressed.
4403 Also see the 'clipboard' option.
4404
4405 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4406'mousefocus' 'mousef' boolean (default off)
4407 global
4408 {not in Vi}
4409 {only works in the GUI}
4410 The window that the mouse pointer is on is automatically activated.
4411 When changing the window layout or window focus in another way, the
4412 mouse pointer is moved to the window with keyboard focus. Off is the
4413 default because it makes using the pull down menus a little goofy, as
4414 a pointer transit may activate a window unintentionally.
4415
4416 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4417'mousehide' 'mh' boolean (default on)
4418 global
4419 {not in Vi}
4420 {only works in the GUI}
4421 When on, the mouse pointer is hidden when characters are typed.
4422 The mouse pointer is restored when the mouse is moved.
4423
4424 *'mousemodel'* *'mousem'*
4425'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4426 global
4427 {not in Vi}
4428 Sets the model to use for the mouse. The name mostly specifies what
4429 the right mouse button is used for:
4430 extend Right mouse button extends a selection. This works
4431 like in an xterm.
4432 popup Right mouse button pops up a menu. The shifted left
4433 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004434 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 popup_setpos Like "popup", but the cursor will be moved to the
4436 position where the mouse was clicked, and thus the
4437 selected operation will act upon the clicked object.
4438 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004439 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 course, that right clicking outside a selection will
4441 end Visual mode.
4442 Overview of what button does what for each model:
4443 mouse extend popup(_setpos) ~
4444 left click place cursor place cursor
4445 left drag start selection start selection
4446 shift-left search word extend selection
4447 right click extend selection popup menu (place cursor)
4448 right drag extend selection -
4449 middle click paste paste
4450
4451 In the "popup" model the right mouse button produces a pop-up menu.
4452 You need to define this first, see |popup-menu|.
4453
4454 Note that you can further refine the meaning of buttons with mappings.
4455 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4456 selection (because that's handled in the GUI code directly).
4457
4458 The 'mousemodel' option is set by the |:behave| command.
4459
4460 *'mouseshape'* *'mouses'* *E547*
4461'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004462 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 global
4464 {not in Vi}
4465 {only available when compiled with the |+mouseshape|
4466 feature}
4467 This option tells Vim what the mouse pointer should look like in
4468 different modes. The option is a comma separated list of parts, much
4469 like used for 'guicursor'. Each part consist of a mode/location-list
4470 and an argument-list:
4471 mode-list:shape,mode-list:shape,..
4472 The mode-list is a dash separated list of these modes/locations:
4473 In a normal window: ~
4474 n Normal mode
4475 v Visual mode
4476 ve Visual mode with 'selection' "exclusive" (same as 'v',
4477 if not specified)
4478 o Operator-pending mode
4479 i Insert mode
4480 r Replace mode
4481
4482 Others: ~
4483 c appending to the command-line
4484 ci inserting in the command-line
4485 cr replacing in the command-line
4486 m at the 'Hit ENTER' or 'More' prompts
4487 ml idem, but cursor in the last line
4488 e any mode, pointer below last window
4489 s any mode, pointer on a status line
4490 sd any mode, while dragging a status line
4491 vs any mode, pointer on a vertical separator line
4492 vd any mode, while dragging a vertical separator line
4493 a everywhere
4494
4495 The shape is one of the following:
4496 avail name looks like ~
4497 w x arrow Normal mouse pointer
4498 w x blank no pointer at all (use with care!)
4499 w x beam I-beam
4500 w x updown up-down sizing arrows
4501 w x leftright left-right sizing arrows
4502 w x busy The system's usual busy pointer
4503 w x no The system's usual 'no input' pointer
4504 x udsizing indicates up-down resizing
4505 x lrsizing indicates left-right resizing
4506 x crosshair like a big thin +
4507 x hand1 black hand
4508 x hand2 white hand
4509 x pencil what you write with
4510 x question big ?
4511 x rightup-arrow arrow pointing right-up
4512 w x up-arrow arrow pointing up
4513 x <number> any X11 pointer number (see X11/cursorfont.h)
4514
4515 The "avail" column contains a 'w' if the shape is available for Win32,
4516 x for X11.
4517 Any modes not specified or shapes not available use the normal mouse
4518 pointer.
4519
4520 Example: >
4521 :set mouseshape=s:udsizing,m:no
4522< will make the mouse turn to a sizing arrow over the status lines and
4523 indicate no input when the hit-enter prompt is displayed (since
4524 clicking the mouse has no effect in this state.)
4525
4526 *'mousetime'* *'mouset'*
4527'mousetime' 'mouset' number (default 500)
4528 global
4529 {not in Vi}
4530 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4531 time in msec between two mouse clicks for the second click to be
4532 recognized as a multi click.
4533
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004534 *'mzquantum'* *'mzq'*
4535'mzquantum' 'mzq' number (default 100)
4536 global
4537 {not in Vi}
4538 {not available when compiled without the |+mzscheme|
4539 feature}
4540 The number of milliseconds between polls for MzScheme threads.
4541 Negative or zero value means no thread scheduling.
4542
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 *'nrformats'* *'nf'*
4544'nrformats' 'nf' string (default "octal,hex")
4545 local to buffer
4546 {not in Vi}
4547 This defines what bases Vim will consider for numbers when using the
4548 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4549 respectively; see |CTRL-A| for more info on these commands.
4550 alpha if included, single alphabetical characters will be
4551 incremented or decremented. This is useful for a list with a
4552 letter index a), b), etc.
4553 octal if included, numbers that start with a zero will be considered
4554 to be octal. Example: Using CTRL-A on "007" results in "010".
4555 hex if included, numbers starting with "0x" or "0X" will be
4556 considered to be hexadecimal. Example: Using CTRL-X on
4557 "0x100" results in "0x0ff".
4558 Numbers which simply begin with a digit in the range 1-9 are always
4559 considered decimal. This also happens for numbers that are not
4560 recognized as octal or hex.
4561
4562 *'number'* *'nu'* *'nonumber'* *'nonu'*
4563'number' 'nu' boolean (default off)
4564 local to window
4565 Print the line number in front of each line. When the 'n' option is
4566 excluded from 'cpoptions' a wrapped line will not use the column of
4567 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004568 The 'numberwidth' option can be used to set the room used for the line
4569 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 When a long, wrapped line doesn't start with the first character, '-'
4571 characters are put before the number.
4572 See |hl-LineNr| for the highlighting used for the number.
4573
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004574 *'numberwidth'* *'nuw'*
4575'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4576 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004577 {not in Vi}
4578 {only available when compiled with the |+linebreak|
4579 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004580 Minimal number of columns to use for the line number. Only relevant
4581 when the 'number' option is set.
4582 Since one space is always between the number and the text, there is
4583 one less character for the number itself.
4584 The value is the minimum width. A bigger width is used when needed to
4585 fit the highest line number in the buffer. Thus with the Vim default
4586 of 4 there is room for a line number up to 999. When the buffer has
4587 1000 lines five columns will be used.
4588 The minimum value is 1, the maximum value is 10.
4589 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4590
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 *'osfiletype'* *'oft'* *E366*
4592'osfiletype' 'oft' string (RISC-OS default: "Text",
4593 others default: "")
4594 local to buffer
4595 {not in Vi}
4596 {only available when compiled with the |+osfiletype|
4597 feature}
4598 Some operating systems store extra information about files besides
4599 name, datestamp and permissions. This option contains the extra
4600 information, the nature of which will vary between systems.
4601 The value of this option is usually set when the file is loaded, and
4602 use to set the file type when file is written.
4603 It can affect the pattern matching of the automatic commands.
4604 |autocmd-osfiletypes|
4605
4606 *'paragraphs'* *'para'*
4607'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4608 global
4609 Specifies the nroff macros that separate paragraphs. These are pairs
4610 of two letters (see |object-motions|).
4611
4612 *'paste'* *'nopaste'*
4613'paste' boolean (default off)
4614 global
4615 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004616 Put Vim in Paste mode. This is useful if you want to cut or copy
4617 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 unexpected effects.
4619 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004620 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 knows about pasting and will mostly do the right thing without 'paste'
4622 being set. The same is true for a terminal where Vim handles the
4623 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004624 This option is reset when starting the GUI. Thus if you set it in
4625 your .vimrc it will work in a terminal, but not in the GUI. Setting
4626 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4627 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628 When the 'paste' option is switched on (also when it was already on):
4629 - mapping in Insert mode and Command-line mode is disabled
4630 - abbreviations are disabled
4631 - 'textwidth' is set to 0
4632 - 'wrapmargin' is set to 0
4633 - 'autoindent' is reset
4634 - 'smartindent' is reset
4635 - 'softtabstop' is set to 0
4636 - 'revins' is reset
4637 - 'ruler' is reset
4638 - 'showmatch' is reset
4639 - 'formatoptions' is used like it is empty
4640 These options keep their value, but their effect is disabled:
4641 - 'lisp'
4642 - 'indentexpr'
4643 - 'cindent'
4644 NOTE: When you start editing another file while the 'paste' option is
4645 on, settings from the modelines or autocommands may change the
4646 settings again, causing trouble when pasting text. You might want to
4647 set the 'paste' option again.
4648 When the 'paste' option is reset the mentioned options are restored to
4649 the value before the moment 'paste' was switched from off to on.
4650 Resetting 'paste' before ever setting it does not have any effect.
4651 Since mapping doesn't work while 'paste' is active, you need to use
4652 the 'pastetoggle' option to toggle the 'paste' option with some key.
4653
4654 *'pastetoggle'* *'pt'*
4655'pastetoggle' 'pt' string (default "")
4656 global
4657 {not in Vi}
4658 When non-empty, specifies the key sequence that toggles the 'paste'
4659 option. This is like specifying a mapping: >
4660 :map {keys} :set invpaste<CR>
4661< Where {keys} is the value of 'pastetoggle'.
4662 The difference is that it will work even when 'paste' is set.
4663 'pastetoggle' works in Insert mode and Normal mode, but not in
4664 Command-line mode.
4665 Mappings are checked first, thus overrule 'pastetoggle'. However,
4666 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4667 this: >
4668 :map <F10> :set paste<CR>
4669 :map <F11> :set nopaste<CR>
4670 :imap <F10> <C-O>:set paste<CR>
4671 :imap <F11> <nop>
4672 :set pastetoggle=<F11>
4673< This will make <F10> start paste mode and <F11> stop paste mode.
4674 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4675 mode everything is inserted literally, except the 'pastetoggle' key
4676 sequence.
4677
4678 *'pex'* *'patchexpr'*
4679'patchexpr' 'pex' string (default "")
4680 global
4681 {not in Vi}
4682 {not available when compiled without the |+diff|
4683 feature}
4684 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004685 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686
4687 *'patchmode'* *'pm'* *E206*
4688'patchmode' 'pm' string (default "")
4689 global
4690 {not in Vi}
4691 When non-empty the oldest version of a file is kept. This can be used
4692 to keep the original version of a file if you are changing files in a
4693 source distribution. Only the first time that a file is written a
4694 copy of the original file will be kept. The name of the copy is the
4695 name of the original file with the string in the 'patchmode' option
4696 appended. This option should start with a dot. Use a string like
4697 ".org". 'backupdir' must not be empty for this to work (Detail: The
4698 backup file is renamed to the patchmode file after the new file has
4699 been successfully written, that's why it must be possible to write a
4700 backup file). If there was no file to be backed up, an empty file is
4701 created.
4702 When the 'backupskip' pattern matches, a patchmode file is not made.
4703 Using 'patchmode' for compressed files appends the extension at the
4704 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4705 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004706 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707
4708 *'path'* *'pa'* *E343* *E345* *E347*
4709'path' 'pa' string (default on Unix: ".,/usr/include,,"
4710 on OS/2: ".,/emx/include,,"
4711 other systems: ".,,")
4712 global or local to buffer |global-local|
4713 {not in Vi}
4714 This is a list of directories which will be searched when using the
4715 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4716 being searched for has a relative path (not starting with '/'). The
4717 directories in the 'path' option may be relative or absolute.
4718 - Use commas to separate directory names: >
4719 :set path=.,/usr/local/include,/usr/include
4720< - Spaces can also be used to separate directory names (for backwards
4721 compatibility with version 3.0). To have a space in a directory
4722 name, precede it with an extra backslash, and escape the space: >
4723 :set path=.,/dir/with\\\ space
4724< - To include a comma in a directory name precede it with an extra
4725 backslash: >
4726 :set path=.,/dir/with\\,comma
4727< - To search relative to the directory of the current file, use: >
4728 :set path=.
4729< - To search in the current directory use an empty string between two
4730 commas: >
4731 :set path=,,
4732< - A directory name may end in a ':' or '/'.
4733 - Environment variables are expanded |:set_env|.
4734 - When using |netrw.vim| URLs can be used. For example, adding
4735 "http://www.vim.org" will make ":find index.html" work.
4736 - Search upwards and downwards in a directory tree:
4737 1) "*" matches a sequence of characters, e.g.: >
4738 :set path=/usr/include/*
4739< means all subdirectories in /usr/include (but not /usr/include
4740 itself). >
4741 :set path=/usr/*c
4742< matches /usr/doc and /usr/src.
4743 2) "**" matches a subtree, up to 100 directories deep. Example: >
4744 :set path=/home/user_x/src/**
4745< means search in the whole subtree under "/home/usr_x/src".
4746 3) If the path ends with a ';', this path is the startpoint
4747 for upward search.
4748 See |file-searching| for more info and exact syntax.
4749 {not available when compiled without the |+path_extra| feature}
4750 - Careful with '\' characters, type two to get one in the option: >
4751 :set path=.,c:\\include
4752< Or just use '/' instead: >
4753 :set path=.,c:/include
4754< Don't forget "." or files won't even be found in the same directory as
4755 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004756 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757 it is something like 256 or 1024 characters.
4758 You can check if all the include files are found, using the value of
4759 'path', see |:checkpath|.
4760 The use of |:set+=| and |:set-=| is preferred when adding or removing
4761 directories from the list. This avoids problems when a future version
4762 uses another default. To remove the current directory use: >
4763 :set path-=
4764< To add the current directory use: >
4765 :set path+=
4766< To use an environment variable, you probably need to replace the
4767 separator. Here is an example to append $INCL, in which directory
4768 names are separated with a semi-colon: >
4769 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4770< Replace the ';' with a ':' or whatever separator is used. Note that
4771 this doesn't work when $INCL contains a comma or white space.
4772
4773 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4774'preserveindent' 'pi' boolean (default off)
4775 local to buffer
4776 {not in Vi}
4777 When changing the indent of the current line, preserve as much of the
4778 indent structure as possible. Normally the indent is replaced by a
4779 series of tabs followed by spaces as required (unless |'expandtab'| is
4780 enabled, in which case only spaces are used). Enabling this option
4781 means the indent will preserve as many existing characters as possible
4782 for indenting, and only add additional tabs or spaces as required.
4783 NOTE: When using ">>" multiple times the resulting indent is a mix of
4784 tabs and spaces. You might not like this.
4785 NOTE: 'preserveindent' is reset when 'compatible' is set.
4786 Also see 'copyindent'.
4787 Use |:retab| to clean up white space.
4788
4789 *'previewheight'* *'pvh'*
4790'previewheight' 'pvh' number (default 12)
4791 global
4792 {not in Vi}
4793 {not available when compiled without the |+windows| or
4794 |+quickfix| feature}
4795 Default height for a preview window. Used for |:ptag| and associated
4796 commands. Used for |CTRL-W_}| when no count is given.
4797
4798 *'previewwindow'* *'nopreviewwindow'*
4799 *'pvw'* *'nopvw'* *E590*
4800'previewwindow' 'pvw' boolean (default off)
4801 local to window
4802 {not in Vi}
4803 {not available when compiled without the |+windows| or
4804 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004805 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 set. It's normally not set directly, but by using one of the commands
4807 |:ptag|, |:pedit|, etc.
4808
4809 *'printdevice'* *'pdev'*
4810'printdevice' 'pdev' string (default empty)
4811 global
4812 {not in Vi}
4813 {only available when compiled with the |+printer|
4814 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004815 The name of the printer to be used for |:hardcopy|.
4816 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004817 This option cannot be set from a |modeline| or in the |sandbox|, for
4818 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
Bram Moolenaar8299df92004-07-10 09:47:34 +00004820 *'printencoding'* *'penc'*
4821'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 global
4823 {not in Vi}
4824 {only available when compiled with the |+printer|
4825 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004826 Sets the character encoding used when printing.
4827 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 *'printexpr'* *'pexpr'*
4830'printexpr' 'pexpr' String (default: see below)
4831 global
4832 {not in Vi}
4833 {only available when compiled with the |+printer|
4834 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004835 Expression used to print the PostScript produced with |:hardcopy|.
4836 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
Bram Moolenaar8299df92004-07-10 09:47:34 +00004838 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839'printfont' 'pfn' string (default "courier")
4840 global
4841 {not in Vi}
4842 {only available when compiled with the |+printer|
4843 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004844 The name of the font that will be used for |:hardcopy|.
4845 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846
4847 *'printheader'* *'pheader'*
4848'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4849 global
4850 {not in Vi}
4851 {only available when compiled with the |+printer|
4852 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004853 The format of the header produced in |:hardcopy| output.
4854 See |pheader-option|.
4855
4856 *'printmbcharset'* *'pmbcs'*
4857'printmbcharset' 'pmbcs' string (default "")
4858 global
4859 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004860 {only available when compiled with the |+printer|,
4861 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004862 The CJK character set to be used for CJK output from |:hardcopy|.
4863 See |pmbcs-option|.
4864
4865 *'printmbfont'* *'pmbfn'*
4866'printmbfont' 'pmbfn' string (default "")
4867 global
4868 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004869 {only available when compiled with the |+printer|,
4870 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004871 List of font names to be used for CJK output from |:hardcopy|.
4872 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873
4874 *'printoptions'* *'popt'*
4875'printoptions' 'popt' string (default "")
4876 global
4877 {not in Vi}
4878 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004879 List of items that control the format of the output of |:hardcopy|.
4880 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004882 *'prompt'* *'noprompt'*
4883'prompt' boolean (default on)
4884 global
4885 When on a ":" prompt is used in Ex mode.
4886
Bram Moolenaar677ee682005-01-27 14:41:15 +00004887 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004888'quoteescape' 'qe' string (default "\")
4889 local to buffer
4890 {not in Vi}
4891 The characters that are used to escape quotes in a string. Used for
4892 objects like a', a" and a` |a'|.
4893 When one of the characters in this option is found inside a string,
4894 the following character will be skipped. The default value makes the
4895 text "foo\"bar\\" considered to be one string.
4896
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4898'readonly' 'ro' boolean (default off)
4899 local to buffer
4900 If on, writes fail unless you use a '!'. Protects you from
4901 accidentally overwriting a file. Default on when Vim is started
4902 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004903 When using ":w!" the 'readonly' option is reset for the current
4904 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004905 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004906 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907
4908 *'remap'* *'noremap'*
4909'remap' boolean (default on)
4910 global
4911 Allows for mappings to work recursively. If you do not want this for
4912 a single entry, use the :noremap[!] command.
4913
4914 *'report'*
4915'report' number (default 2)
4916 global
4917 Threshold for reporting number of lines changed. When the number of
4918 changed lines is more than 'report' a message will be given for most
4919 ":" commands. If you want it always, set 'report' to 0.
4920 For the ":substitute" command the number of substitutions is used
4921 instead of the number of lines.
4922
4923 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4924'restorescreen' 'rs' boolean (default on)
4925 global
4926 {not in Vi} {only in Windows 95/NT console version}
4927 When set, the screen contents is restored when exiting Vim. This also
4928 happens when executing external commands.
4929
4930 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4931 options in your .vimrc. To disable restoring:
4932 set t_ti= t_te=
4933 To enable restoring (for an xterm):
4934 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4935 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4936
4937 *'revins'* *'ri'* *'norevins'* *'nori'*
4938'revins' 'ri' boolean (default off)
4939 global
4940 {not in Vi}
4941 {only available when compiled with the |+rightleft|
4942 feature}
4943 Inserting characters in Insert mode will work backwards. See "typing
4944 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4945 command in Insert mode, when 'allowrevins' is set.
4946 NOTE: This option is reset when 'compatible' or 'paste' is set.
4947
4948 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4949'rightleft' 'rl' boolean (default off)
4950 local to window
4951 {not in Vi}
4952 {only available when compiled with the |+rightleft|
4953 feature}
4954 When on, display orientation becomes right-to-left, i.e., characters
4955 that are stored in the file appear from the right to the left.
4956 Using this option, it is possible to edit files for languages that
4957 are written from the right to the left such as Hebrew and Arabic.
4958 This option is per window, so it is possible to edit mixed files
4959 simultaneously, or to view the same file in both ways (this is
4960 useful whenever you have a mixed text file with both right-to-left
4961 and left-to-right strings so that both sets are displayed properly
4962 in different windows). Also see |rileft.txt|.
4963
4964 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4965'rightleftcmd' 'rlc' string (default "search")
4966 local to window
4967 {not in Vi}
4968 {only available when compiled with the |+rightleft|
4969 feature}
4970 Each word in this option enables the command line editing to work in
4971 right-to-left mode for a group of commands:
4972
4973 search "/" and "?" commands
4974
4975 This is useful for languages such as Hebrew, Arabic and Farsi.
4976 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4977
4978 *'ruler'* *'ru'* *'noruler'* *'noru'*
4979'ruler' 'ru' boolean (default off)
4980 global
4981 {not in Vi}
4982 {not available when compiled without the
4983 |+cmdline_info| feature}
4984 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004985 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004986 text in the file is shown on the far right:
4987 Top first line is visible
4988 Bot last line is visible
4989 All first and last line are visible
4990 45% relative position in the file
4991 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004992 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00004994 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 this option takes precedence over 'ruler' and 'rulerformat'
4996 If the number of characters displayed is different from the number of
4997 bytes in the text (e.g., for a TAB or a multi-byte character), both
4998 the text column (byte number) and the screen column are shown,
4999 separated with a dash.
5000 For an empty line "0-1" is shown.
5001 For an empty buffer the line number will also be zero: "0,0-1".
5002 This option is reset when the 'paste' option is set.
5003 If you don't want to see the ruler all the time but want to know where
5004 you are, use "g CTRL-G" |g_CTRL-G|.
5005 NOTE: This option is reset when 'compatible' is set.
5006
5007 *'rulerformat'* *'ruf'*
5008'rulerformat' 'ruf' string (default empty)
5009 global
5010 {not in Vi}
5011 {not available when compiled without the |+statusline|
5012 feature}
5013 When this option is not empty, it determines the content of the ruler
5014 string, as displayed for the 'ruler' option.
5015 The format of this option, is like that of 'statusline'.
5016 The default ruler width is 17 characters. To make the ruler 15
5017 characters wide, put "%15(" at the start and "%)" at the end.
5018 Example: >
5019 :set rulerformat=%15(%c%V\ %p%%%)
5020<
5021 *'runtimepath'* *'rtp'* *vimfiles*
5022'runtimepath' 'rtp' string (default:
5023 Unix: "$HOME/.vim,
5024 $VIM/vimfiles,
5025 $VIMRUNTIME,
5026 $VIM/vimfiles/after,
5027 $HOME/.vim/after"
5028 Amiga: "home:vimfiles,
5029 $VIM/vimfiles,
5030 $VIMRUNTIME,
5031 $VIM/vimfiles/after,
5032 home:vimfiles/after"
5033 PC, OS/2: "$HOME/vimfiles,
5034 $VIM/vimfiles,
5035 $VIMRUNTIME,
5036 $VIM/vimfiles/after,
5037 $HOME/vimfiles/after"
5038 Macintosh: "$VIM:vimfiles,
5039 $VIMRUNTIME,
5040 $VIM:vimfiles:after"
5041 RISC-OS: "Choices:vimfiles,
5042 $VIMRUNTIME,
5043 Choices:vimfiles/after"
5044 VMS: "sys$login:vimfiles,
5045 $VIM/vimfiles,
5046 $VIMRUNTIME,
5047 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005048 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 global
5050 {not in Vi}
5051 This is a list of directories which will be searched for runtime
5052 files:
5053 filetype.vim filetypes by file name |new-filetype|
5054 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005055 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 colors/ color scheme files |:colorscheme|
5057 compiler/ compiler files |:compiler|
5058 doc/ documentation |write-local-help|
5059 ftplugin/ filetype plugins |write-filetype-plugin|
5060 indent/ indent scripts |indent-expression|
5061 keymap/ key mapping files |mbyte-keymap|
5062 lang/ menu translations |:menutrans|
5063 menu.vim GUI menus |menu.vim|
5064 plugin/ plugin scripts |write-plugin|
5065 print/ files for printing |postscript-print-encoding|
5066 syntax/ syntax files |mysyntaxfile|
5067 tutor/ files for vimtutor |tutor|
5068
5069 And any other file searched for with the |:runtime| command.
5070
5071 The defaults for most systems are setup to search five locations:
5072 1. In your home directory, for your personal preferences.
5073 2. In a system-wide Vim directory, for preferences from the system
5074 administrator.
5075 3. In $VIMRUNTIME, for files distributed with Vim.
5076 *after-directory*
5077 4. In the "after" directory in the system-wide Vim directory. This is
5078 for the system administrator to overrule or add to the distributed
5079 defaults (rarely needed)
5080 5. In the "after" directory in your home directory. This is for
5081 personal preferences to overrule or add to the distributed defaults
5082 or system-wide settings (rarely needed).
5083
5084 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5085 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005086 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 wildcards.
5088 See |:runtime|.
5089 Example: >
5090 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5091< This will use the directory "~/vimruntime" first (containing your
5092 personal Vim runtime files), then "/mygroup/vim" (shared between a
5093 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5094 files).
5095 You probably should always include $VIMRUNTIME somewhere, to use the
5096 distributed runtime files. You can put a directory before $VIMRUNTIME
5097 to find files which replace a distributed runtime files. You can put
5098 a directory after $VIMRUNTIME to find files which add to distributed
5099 runtime files.
5100 This option cannot be set from a |modeline| or in the |sandbox|, for
5101 security reasons.
5102
5103 *'scroll'* *'scr'*
5104'scroll' 'scr' number (default: half the window height)
5105 local to window
5106 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5107 set to half the number of lines in the window when the window size
5108 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005109 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5111 the number of screen lines instead of file lines, makes a difference
5112 when lines wrap}
5113
5114 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5115'scrollbind' 'scb' boolean (default off)
5116 local to window
5117 {not in Vi}
5118 {not available when compiled without the |+scrollbind|
5119 feature}
5120 See also |scroll-binding|. When this option is set, the current
5121 window scrolls as other scrollbind windows (windows that also have
5122 this option set) scroll. This option is useful for viewing the
5123 differences between two versions of a file, see 'diff'.
5124 See |'scrollopt'| for options that determine how this option should be
5125 interpreted.
5126 This option is mostly reset when splitting a window to edit another
5127 file. This means that ":split | edit file" results in two windows
5128 with scroll-binding, but ":split file" does not.
5129
5130 *'scrolljump'* *'sj'*
5131'scrolljump' 'sj' number (default 1)
5132 global
5133 {not in Vi}
5134 Minimal number of lines to scroll when the cursor gets off the
5135 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5136 CTRL-D). Useful if your terminal scrolls very slowly.
5137 NOTE: This option is set to 1 when 'compatible' is set.
5138
5139 *'scrolloff'* *'so'*
5140'scrolloff' 'so' number (default 0)
5141 global
5142 {not in Vi}
5143 Minimal number of screen lines to keep above and below the cursor.
5144 This will make some context visible around where you are working. If
5145 you set it to a very large value (999) the cursor line will always be
5146 in the middle of the window (except at the start or end of the file or
5147 when long lines wrap).
5148 For scrolling horizontally see 'sidescrolloff'.
5149 NOTE: This option is set to 0 when 'compatible' is set.
5150
5151 *'scrollopt'* *'sbo'*
5152'scrollopt' 'sbo' string (default "ver,jump")
5153 global
5154 {not available when compiled without the |+scrollbind|
5155 feature}
5156 {not in Vi}
5157 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005158 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5159 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005160 The following words are available:
5161 ver Bind vertical scrolling for 'scrollbind' windows
5162 hor Bind horizontal scrolling for 'scrollbind' windows
5163 jump Applies to the offset between two windows for vertical
5164 scrolling. This offset is the difference in the first
5165 displayed line of the bound windows. When moving
5166 around in a window, another 'scrollbind' window may
5167 reach a position before the start or after the end of
5168 the buffer. The offset is not changed though, when
5169 moving back the 'scrollbind' window will try to scroll
5170 to the desired position when possible.
5171 When now making that window the current one, two
5172 things can be done with the relative offset:
5173 1. When "jump" is not included, the relative offset is
5174 adjusted for the scroll position in the new current
5175 window. When going back to the other window, the
5176 the new relative offset will be used.
5177 2. When "jump" is included, the other windows are
5178 scrolled to keep the same relative offset. When
5179 going back to the other window, it still uses the
5180 same relative offset.
5181 Also see |scroll-binding|.
5182
5183 *'sections'* *'sect'*
5184'sections' 'sect' string (default "SHNHH HUnhsh")
5185 global
5186 Specifies the nroff macros that separate sections. These are pairs of
5187 two letters (See |object-motions|). The default makes a section start
5188 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5189
5190 *'secure'* *'nosecure'* *E523*
5191'secure' boolean (default off)
5192 global
5193 {not in Vi}
5194 When on, ":autocmd", shell and write commands are not allowed in
5195 ".vimrc" and ".exrc" in the current directory and map commands are
5196 displayed. Switch it off only if you know that you will not run into
5197 problems, or when the 'exrc' option is off. On Unix this option is
5198 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005199 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 'secure' at the end of your ~/.vimrc then.
5201 This option cannot be set from a |modeline| or in the |sandbox|, for
5202 security reasons.
5203
5204 *'selection'* *'sel'*
5205'selection' 'sel' string (default "inclusive")
5206 global
5207 {not in Vi}
5208 This option defines the behavior of the selection. It is only used
5209 in Visual and Select mode.
5210 Possible values:
5211 value past line inclusive ~
5212 old no yes
5213 inclusive yes yes
5214 exclusive yes no
5215 "past line" means that the cursor is allowed to be positioned one
5216 character past the line.
5217 "inclusive" means that the last character of the selection is included
5218 in an operation. For example, when "x" is used to delete the
5219 selection.
5220 Note that when "exclusive" is used and selecting from the end
5221 backwards, you cannot include the last character of a line, when
5222 starting in Normal mode and 'virtualedit' empty.
5223
5224 The 'selection' option is set by the |:behave| command.
5225
5226 *'selectmode'* *'slm'*
5227'selectmode' 'slm' string (default "")
5228 global
5229 {not in Vi}
5230 This is a comma separated list of words, which specifies when to start
5231 Select mode instead of Visual mode, when a selection is started.
5232 Possible values:
5233 mouse when using the mouse
5234 key when using shifted special keys
5235 cmd when using "v", "V" or CTRL-V
5236 See |Select-mode|.
5237 The 'selectmode' option is set by the |:behave| command.
5238
5239 *'sessionoptions'* *'ssop'*
5240'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5241 help,options,winsize")
5242 global
5243 {not in Vi}
5244 {not available when compiled without the +mksession
5245 feature}
5246 Changes the effect of the |:mksession| command. It is a comma
5247 separated list of words. Each word enables saving and restoring
5248 something:
5249 word save and restore ~
5250 blank empty windows
5251 buffers hidden and unloaded buffers, not just those in windows
5252 curdir the current directory
5253 folds manually created folds, opened/closed folds and local
5254 fold options
5255 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005256 and contain at least one lowercase letter. Only
5257 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258 help the help window
5259 localoptions options and mappings local to a window or buffer (not
5260 global values for local options)
5261 options all options and mappings (also global values for local
5262 options)
5263 resize size of the Vim window: 'lines' and 'columns'
5264 sesdir the directory in which the session file is located
5265 will become the current directory (useful with
5266 projects accessed over a network from different
5267 systems)
5268 slash backslashes in file names replaced with forward
5269 slashes
5270 unix with Unix end-of-line format (single <NL>), even when
5271 on Windows or DOS
5272 winpos position of the whole Vim window
5273 winsize window sizes
5274
5275 Don't include both "curdir" and "sesdir".
5276 When "curdir" nor "sesdir" is included, file names are stored with
5277 absolute paths.
5278 "slash" and "unix" are useful on Windows when sharing session files
5279 with Unix. The Unix version of Vim cannot source dos format scripts,
5280 but the Windows version of Vim can source unix format scripts.
5281
5282 *'shell'* *'sh'* *E91*
5283'shell' 'sh' string (default $SHELL or "sh",
5284 MS-DOS and Win32: "command.com" or
5285 "cmd.exe", OS/2: "cmd")
5286 global
5287 Name of the shell to use for ! and :! commands. When changing the
5288 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5289 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005290 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 See |option-backslash| about including spaces and backslashes.
5292 Environment variables are expanded |:set_env|.
5293 If the name of the shell contains a space, you might need to enclose
5294 it in quotes. Example: >
5295 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5296< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005297 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 "-f" is not inside the quotes, because it is not part of the command
5299 name. And Vim automagically recognizes the backslashes that are path
5300 separators.
5301 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5302 variable to change the way external commands are executed. See the
5303 libc.inf file of DJGPP.
5304 Under MS-Windows, when the executable ends in ".com" it must be
5305 included. Thus setting the shell to "command.com" or "4dos.com"
5306 works, but "command" and "4dos" do not work for all commands (e.g.,
5307 filtering).
5308 For unknown reasons, when using "4dos.com" the current directory is
5309 changed to "C:\". To avoid this set 'shell' like this: >
5310 :set shell=command.com\ /c\ 4dos
5311< This option cannot be set from a |modeline| or in the |sandbox|, for
5312 security reasons.
5313
5314 *'shellcmdflag'* *'shcf'*
5315'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5316 does not contain "sh" somewhere: "/c")
5317 global
5318 {not in Vi}
5319 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5320 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5321 systems, the default is set according to the value of 'shell', to
5322 reduce the need to set this option by the user. It's not used for
5323 OS/2 (EMX figures this out itself). See |option-backslash| about
5324 including spaces and backslashes. See |dos-shell|.
5325 This option cannot be set from a |modeline| or in the |sandbox|, for
5326 security reasons.
5327
5328 *'shellpipe'* *'sp'*
5329'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5330 global
5331 {not in Vi}
5332 {not available when compiled without the |+quickfix|
5333 feature}
5334 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005335 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 including spaces and backslashes.
5337 The name of the temporary file can be represented by "%s" if necessary
5338 (the file name is appended automatically if no %s appears in the value
5339 of this option).
5340 For the Amiga and MS-DOS the default is ">". The output is directly
5341 saved in a file and not echoed to the screen.
5342 For Unix the default it "| tee". The stdout of the compiler is saved
5343 in a file and echoed to the screen. If the 'shell' option is "csh" or
5344 "tcsh" after initializations, the default becomes "|& tee". If the
5345 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5346 "2>&1| tee". This means that stderr is also included.
5347 The initialization of this option is done after reading the ".vimrc"
5348 and the other initializations, so that when the 'shell' option is set
5349 there, the 'shellpipe' option changes automatically, unless it was
5350 explicitly set before.
5351 When 'shellpipe' is set to an empty string, no redirection of the
5352 ":make" output will be done. This is useful if you use a 'makeprg'
5353 that writes to 'makeef' by itself. If you want no piping, but do
5354 want to include the 'makeef', set 'shellpipe' to a single space.
5355 Don't forget to precede the space with a backslash: ":set sp=\ ".
5356 In the future pipes may be used for filtering and this option will
5357 become obsolete (at least for Unix).
5358 This option cannot be set from a |modeline| or in the |sandbox|, for
5359 security reasons.
5360
5361 *'shellquote'* *'shq'*
5362'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5363 contains "sh" somewhere: "\"")
5364 global
5365 {not in Vi}
5366 Quoting character(s), put around the command passed to the shell, for
5367 the "!" and ":!" commands. The redirection is kept outside of the
5368 quoting. See 'shellxquote' to include the redirection. It's
5369 probably not useful to set both options.
5370 This is an empty string by default. Only known to be useful for
5371 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5372 or bash, where it should be "\"". The default is adjusted according
5373 the value of 'shell', to reduce the need to set this option by the
5374 user. See |dos-shell|.
5375 This option cannot be set from a |modeline| or in the |sandbox|, for
5376 security reasons.
5377
5378 *'shellredir'* *'srr'*
5379'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5380 global
5381 {not in Vi}
5382 String to be used to put the output of a filter command in a temporary
5383 file. See also |:!|. See |option-backslash| about including spaces
5384 and backslashes.
5385 The name of the temporary file can be represented by "%s" if necessary
5386 (the file name is appended automatically if no %s appears in the value
5387 of this option).
5388 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5389 or "zsh" during initializations, the default becomes ">&". If the
5390 'shell' option is "sh", "ksh" or "bash" the default becomes
5391 ">%s 2>&1". This means that stderr is also included.
5392 For Win32, the Unix checks are done and additionally "cmd" is checked
5393 for, which makes the default ">%s 2>&1". Also, the same names with
5394 ".exe" appended are checked for.
5395 The initialization of this option is done after reading the ".vimrc"
5396 and the other initializations, so that when the 'shell' option is set
5397 there, the 'shellredir' option changes automatically unless it was
5398 explicitly set before.
5399 In the future pipes may be used for filtering and this option will
5400 become obsolete (at least for Unix).
5401 This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
5403
5404 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5405'shellslash' 'ssl' boolean (default off)
5406 global
5407 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5408 When set, a forward slash is used when expanding file names. This is
5409 useful when a Unix-like shell is used instead of command.com or
5410 cmd.exe. Backward slashes can still be typed, but they are changed to
5411 forward slashes by Vim.
5412 Note that setting or resetting this option has no effect for some
5413 existing file names, thus this option needs to be set before opening
5414 any file for best results. This might change in the future.
5415 'shellslash' only works when a backslash can be used as a path
5416 separator. To test if this is so use: >
5417 if exists('+shellslash')
5418<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005419 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5420'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5421 global
5422 {not in Vi}
5423 When on, use temp files for shell commands. When off use a pipe.
5424 When using a pipe is not possible temp files are used anyway.
5425 Currently a pipe is only supported on Unix. You can check it with: >
5426 :if has("filterpipe")
5427< The advantage of using a pipe is that nobody can read the temp file
5428 and the 'shell' command does not need to support redirection.
5429 The advantage of using a temp file is that the file type and encoding
5430 can be detected.
5431 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5432 |FilterWritePost| autocommands event are not triggered when
5433 'shelltemp' is off.
5434
Bram Moolenaar071d4272004-06-13 20:20:40 +00005435 *'shelltype'* *'st'*
5436'shelltype' 'st' number (default 0)
5437 global
5438 {not in Vi} {only for the Amiga}
5439 On the Amiga this option influences the way how the commands work
5440 which use a shell.
5441 0 and 1: always use the shell
5442 2 and 3: use the shell only to filter lines
5443 4 and 5: use shell only for ':sh' command
5444 When not using the shell, the command is executed directly.
5445
5446 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5447 1 and 3: use "shell cmd" to start external commands
5448
5449 *'shellxquote'* *'sxq'*
5450'shellxquote' 'sxq' string (default: "";
5451 for Win32, when 'shell' contains "sh"
5452 somewhere: "\""
5453 for Unix, when using system(): "\"")
5454 global
5455 {not in Vi}
5456 Quoting character(s), put around the command passed to the shell, for
5457 the "!" and ":!" commands. Includes the redirection. See
5458 'shellquote' to exclude the redirection. It's probably not useful
5459 to set both options.
5460 This is an empty string by default. Known to be useful for
5461 third-party shells when using the Win32 version, such as the MKS Korn
5462 Shell or bash, where it should be "\"". The default is adjusted
5463 according the value of 'shell', to reduce the need to set this option
5464 by the user. See |dos-shell|.
5465 This option cannot be set from a |modeline| or in the |sandbox|, for
5466 security reasons.
5467
5468 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5469'shiftround' 'sr' boolean (default off)
5470 global
5471 {not in Vi}
5472 Round indent to multiple of 'shiftwidth'. Applies to > and <
5473 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5474 a multiple of 'shiftwidth' (this is Vi compatible).
5475 NOTE: This option is reset when 'compatible' is set.
5476
5477 *'shiftwidth'* *'sw'*
5478'shiftwidth' 'sw' number (default 8)
5479 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005480 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005481 |'cindent'|, |>>|, |<<|, etc.
5482
5483 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005484'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5485 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 global
5487 {not in Vi}
5488 This option helps to avoid all the |hit-enter| prompts caused by file
5489 messages, for example with CTRL-G, and to avoid some other messages.
5490 It is a list of flags:
5491 flag meaning when present ~
5492 f use "(3 of 5)" instead of "(file 3 of 5)"
5493 i use "[noeol]" instead of "[Incomplete last line]"
5494 l use "999L, 888C" instead of "999 lines, 888 characters"
5495 m use "[+]" instead of "[Modified]"
5496 n use "[New]" instead of "[New File]"
5497 r use "[RO]" instead of "[readonly]"
5498 w use "[w]" instead of "written" for file write message
5499 and "[a]" instead of "appended" for ':w >> file' command
5500 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5501 "[unix format]" and "[mac]" instead of "[mac format]".
5502 a all of the above abbreviations
5503
5504 o overwrite message for writing a file with subsequent message
5505 for reading a file (useful for ":wn" or when 'autowrite' on)
5506 O message for reading a file overwrites any previous message.
5507 Also for quickfix message (e.g., ":cn").
5508 s don't give "search hit BOTTOM, continuing at TOP" or "search
5509 hit TOP, continuing at BOTTOM" messages
5510 t truncate file message at the start if it is too long to fit
5511 on the command-line, "<" will appear in the left most column.
5512 Ignored in Ex mode.
5513 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005514 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 Ignored in Ex mode.
5516 W don't give "written" or "[w]" when writing a file
5517 A don't give the "ATTENTION" message when an existing swap file
5518 is found.
5519 I don't give the intro message when starting Vim |:intro|.
5520
5521 This gives you the opportunity to avoid that a change between buffers
5522 requires you to hit <Enter>, but still gives as useful a message as
5523 possible for the space available. To get the whole message that you
5524 would have got with 'shm' empty, use ":file!"
5525 Useful values:
5526 shm= No abbreviation of message.
5527 shm=a Abbreviation, but no loss of information.
5528 shm=at Abbreviation, and truncate message when necessary.
5529
5530 NOTE: This option is set to the Vi default value when 'compatible' is
5531 set and to the Vim default value when 'compatible' is reset.
5532
5533 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5534'shortname' 'sn' boolean (default off)
5535 local to buffer
5536 {not in Vi, not in MS-DOS versions}
5537 Filenames are assumed to be 8 characters plus one extension of 3
5538 characters. Multiple dots in file names are not allowed. When this
5539 option is on, dots in file names are replaced with underscores when
5540 adding an extension (".~" or ".swp"). This option is not available
5541 for MS-DOS, because then it would always be on. This option is useful
5542 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5543 or crossdos. When running the Win32 GUI version under Win32s, this
5544 option is always on by default.
5545
5546 *'showbreak'* *'sbr'* *E595*
5547'showbreak' 'sbr' string (default "")
5548 global
5549 {not in Vi}
5550 {not available when compiled without the |+linebreak|
5551 feature}
5552 String to put at the start of lines that have been wrapped. Useful
5553 values are "> " or "+++ ".
5554 Only printable single-cell characters are allowed, excluding <Tab> and
5555 comma (in a future version the comma might be used to separate the
5556 part that is shown at the end and at the start of a line).
5557 The characters are highlighted according to the '@' flag in
5558 'highlight'.
5559 Note that tabs after the showbreak will be displayed differently.
5560 If you want the 'showbreak' to appear in between line numbers, add the
5561 "n" flag to 'cpoptions'.
5562
5563 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5564'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5565 off)
5566 global
5567 {not in Vi}
5568 {not available when compiled without the
5569 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005570 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 terminal is slow.
5572 In Visual mode the size of the selected area is shown:
5573 - When selecting characters within a line, the number of characters.
5574 - When selecting more than one line, the number of lines.
5575 - When selecting a block, the size in screen characters: linesxcolumns.
5576 NOTE: This option is set to the Vi default value when 'compatible' is
5577 set and to the Vim default value when 'compatible' is reset.
5578
5579 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5580'showfulltag' 'sft' boolean (default off)
5581 global
5582 {not in Vi}
5583 When completing a word in insert mode (see |ins-completion|) from the
5584 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005585 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 matched a C function, you can see a template for what arguments are
5587 required (coding style permitting).
5588
5589 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5590'showmatch' 'sm' boolean (default off)
5591 global
5592 When a bracket is inserted, briefly jump to the matching one. The
5593 jump is only done if the match can be seen on the screen. The time to
5594 show the match can be set with 'matchtime'.
5595 A Beep is given if there is no match (no matter if the match can be
5596 seen or not). This option is reset when the 'paste' option is set.
5597 When the 'm' flag is not included in 'cpoptions', typing a character
5598 will immediately move the cursor back to where it belongs.
5599 See the "sm" field in 'guicursor' for setting the cursor shape and
5600 blinking when showing the match.
5601 The 'matchpairs' option can be used to specify the characters to show
5602 matches for. 'rightleft' and 'revins' are used to look for opposite
5603 matches.
5604 Note: For the use of the short form parental guidance is advised.
5605
5606 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5607'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5608 global
5609 If in Insert, Replace or Visual mode put a message on the last line.
5610 Use the 'M' flag in 'highlight' to set the type of highlighting for
5611 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 doesn't mean XIM is really active, especially when 'imactivatekey' is
5614 not set.
5615 NOTE: This option is set to the Vi default value when 'compatible' is
5616 set and to the Vim default value when 'compatible' is reset.
5617
5618 *'sidescroll'* *'ss'*
5619'sidescroll' 'ss' number (default 0)
5620 global
5621 {not in Vi}
5622 The minimal number of columns to scroll horizontally. Used only when
5623 the 'wrap' option is off and the cursor is moved off of the screen.
5624 When it is zero the cursor will be put in the middle of the screen.
5625 When using a slow terminal set it to a large number or 0. When using
5626 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5627 commands.
5628
5629 *'sidescrolloff'* *'siso'*
5630'sidescrolloff' 'siso' number (default 0)
5631 global
5632 {not in Vi}
5633 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005634 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 greater than 0 while having |'sidescroll'| also at a non-zero value
5636 makes some context visible in the line you are scrolling in
5637 horizontally (except at the end and beginning of the line). Setting
5638 this option to a large value (like 999) has the effect of keeping the
5639 cursor horizontally centered in the window, as long as one does not
5640 come too close to the beginning or end of the line.
5641 NOTE: This option is set to 0 when 'compatible' is set.
5642
5643 Example: Try this together with 'sidescroll' and 'listchars' as
5644 in the following example to never allow the cursor to move
5645 onto the "extends" character:
5646
5647 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5648 :set sidescrolloff=1
5649
5650
5651 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5652'smartcase' 'scs' boolean (default off)
5653 global
5654 {not in Vi}
5655 Override the 'ignorecase' option if the search pattern contains upper
5656 case characters. Only used when the search pattern is typed and
5657 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005658 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5660 recalling the search pattern from history and hitting <Enter>.
5661 NOTE: This option is reset when 'compatible' is set.
5662
5663 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5664'smartindent' 'si' boolean (default off)
5665 local to buffer
5666 {not in Vi}
5667 {not available when compiled without the
5668 |+smartindent| feature}
5669 Do smart autoindenting when starting a new line. Works for C-like
5670 programs, but can also be used for other languages. 'cindent' does
5671 something like this, works better in most cases, but is more strict,
5672 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5673 'indentexpr' is a more advanced alternative.
5674 Normally 'autoindent' should also be on when using 'smartindent'.
5675 An indent is automatically inserted:
5676 - After a line ending in '{'.
5677 - After a line starting with a keyword from 'cinwords'.
5678 - Before a line starting with '}' (only with the "O" command).
5679 When typing '}' as the first character in a new line, that line is
5680 given the same indent as the matching '{'.
5681 When typing '#' as the first character in a new line, the indent for
5682 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005683 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5685 When using the ">>" command, lines starting with '#' are not shifted
5686 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 is set smart indenting is disabled.
5689
5690 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5691'smarttab' 'sta' boolean (default off)
5692 global
5693 {not in Vi}
5694 When on, a <Tab> in front of a line inserts blanks according to
5695 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5696 a 'shiftwidth' worth of space at the start of the line.
5697 When off a <Tab> always inserts blanks according to 'tabstop'.
5698 'shiftwidth' is only used for shifting text left or right
5699 |shift-left-right|.
5700 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5701 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005702 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 NOTE: This option is reset when 'compatible' is set.
5704
5705 *'softtabstop'* *'sts'*
5706'softtabstop' 'sts' number (default 0)
5707 local to buffer
5708 {not in Vi}
5709 Number of spaces that a <Tab> counts for while performing editing
5710 operations, like inserting a <Tab> or using <BS>. It "feels" like
5711 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5712 used. This is useful to keep the 'ts' setting at its standard value
5713 of 8, while being able to edit like it is set to 'sts'. However,
5714 commands like "x" still work on the actual characters.
5715 When 'sts' is zero, this feature is off.
5716 'softtabstop' is set to 0 when the 'paste' option is set.
5717 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5718 spaces is minimized by using <Tab>s.
5719 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5720 set.
5721 NOTE: This option is set to 0 when 'compatible' is set.
5722
Bram Moolenaar217ad922005-03-20 22:37:15 +00005723 *'spell'* *'nospell'*
5724'spell' boolean (default off)
5725 local to window
5726 {not in Vi}
5727 {not available when compiled without the |+syntax|
5728 feature}
5729 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005730 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005731
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005732 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005733'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005734 local to buffer
5735 {not in Vi}
5736 {not available when compiled without the |+syntax|
5737 feature}
5738 Pattern to locate the end of a sentence. The following word will be
5739 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005740 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005741 When this check is not wanted make this option empty.
5742 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005743 Be careful with special characters, see |option-backslash| about
5744 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005745 To set this option automatically depending on the language, see
5746 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005747
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005748 *'spellfile'* *'spf'*
5749'spellfile' 'spf' string (default empty)
5750 local to buffer
5751 {not in Vi}
5752 {not available when compiled without the |+syntax|
5753 feature}
5754 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005755 commands. It must end in ".{encoding}.add". You need to include the
5756 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005757 *E765*
5758 It may also be a comma separated list of names. A count before the
5759 |zg| and |zw| commands can be used to access each. This allows using
5760 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005761 When a word is added while this option is empty Vim will set it for
5762 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005763 writable and the first language name that appears in 'spelllang',
5764 ignoring the region.
5765 The resulting ".spl" file will be used for spell checking, it does not
5766 have to appear in 'spelllang'.
5767 Normally one file is used for all regions, but you can add the region
5768 name if you want to. However, it will then only be used when
5769 'spellfile' is set to it, for entries in 'spelllang' only files
5770 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005771 This option cannot be set from a |modeline| or in the |sandbox|, for
5772 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005773
Bram Moolenaar217ad922005-03-20 22:37:15 +00005774 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005775'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005776 local to buffer
5777 {not in Vi}
5778 {not available when compiled without the |+syntax|
5779 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005780 A comma separated list of word list names. When the 'spell' option is
5781 on spellchecking will be done for these languages. Example: >
5782 set spelllang=en_us,nl,medical
5783< This means US English, Dutch and medical words are recognized. Words
5784 that are not recognized will be highlighted.
5785 The word list name must not include a comma or dot. Using a dash is
5786 recommended to separate the two letter language name from a
5787 specification. Thus "en-rare" is used for rare English words.
5788 A region name must come last and have the form "_xx", where "xx" is
5789 the two-letter, lower case region name. You can use more than one
5790 region by listing them: "en_us,en_ca" supports both US and Canadian
5791 English, but not words specific for Australia, New Zealand or Great
5792 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005793 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005794 As a special case the name of a .spl file can be given as-is. The
5795 first "_xx" in the name is removed and used as the region name
5796 (_xx is an underscore, two letters and followed by a non-letter).
5797 This is mainly for testing purposes. You must make sure the correct
5798 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005799 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005800 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5801 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005802 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005803
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005804 After this option has been set successfully, Vim will source the files
5805 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5806 up to the first comma, dot or underscore. See |set-spc-auto|.
5807
5808
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005809 *'spellsuggest'* *'sps'*
5810'spellsuggest' 'sps' string (default "best")
5811 global
5812 {not in Vi}
5813 {not available when compiled without the |+syntax|
5814 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005815 Methods used for spelling suggestions. Both for the |z?| command and
5816 the |spellsuggest()| function. This is a comma-separated list of
5817 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005818
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005819 best Internal method that works best for English. Finds
5820 changes like "fast" and uses a bit of sound-a-like
5821 scoring to improve the ordering.
5822
5823 double Internal method that uses two methods and mixes the
5824 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005825 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005826 word. That only works when the language specifies
5827 sound folding. Can be slow and doesn't always give
5828 better results.
5829
5830 fast Internal method that only checks for simple changes:
5831 character inserts/deletes/swaps. Works well for
5832 simple typing mistakes.
5833
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005834 {number} The maximum number of suggestions listed for |z?|.
5835 Not used for |spellsuggest()|. The number of
5836 suggestions is never more than the value of 'lines'
5837 minus two.
5838
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005839 file:{filename} Read file {filename}, which must have two columns,
5840 separated by a slash. The first column contains the
5841 bad word, the second column the suggested good word.
5842 Example:
5843 theribal/terrible ~
5844 Use this for common mistakes that do not appear at the
5845 top of the suggestion list with the internal methods.
5846 Lines without a slash are ignored, use this for
5847 comments.
5848 The file is used for all languages.
5849
5850 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5851 trouble with spaces. |v:val| holds the badly spelled
5852 word. The expression must evaluate to a List of
5853 Lists, each with a suggestion and a score.
5854 Example:
5855 [['the', 33], ['that', 44]]
5856 Set 'verbose' and use |z?| to see the scores that the
5857 internal methods use. A lower score is better.
5858 This may invoke |spellsuggest()| if you temporarily
5859 set 'spellsuggest' to exclude the "expr:" part.
5860 Errors are silently ignored, unless you set the
5861 'verbose' option to a non-zero value.
5862
5863 Only one of "best", "double" or "fast" may be used. The others may
5864 appear several times in any order. Example: >
5865 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5866<
5867 This option cannot be set from a |modeline| or in the |sandbox|, for
5868 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005869
5870
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5872'splitbelow' 'sb' boolean (default off)
5873 global
5874 {not in Vi}
5875 {not available when compiled without the +windows
5876 feature}
5877 When on, splitting a window will put the new window below the current
5878 one. |:split|
5879
5880 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5881'splitright' 'spr' boolean (default off)
5882 global
5883 {not in Vi}
5884 {not available when compiled without the +vertsplit
5885 feature}
5886 When on, splitting a window will put the new window right of the
5887 current one. |:vsplit|
5888
5889 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5890'startofline' 'sol' boolean (default on)
5891 global
5892 {not in Vi}
5893 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005894 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005895 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005896 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 with a linewise operator, with "%" with a count and to buffer changing
5898 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5899 only has a line number, e.g., ":25" or ":+".
5900 In case of buffer changing commands the cursor is placed at the column
5901 where it was the last time the buffer was edited.
5902 NOTE: This option is set when 'compatible' is set.
5903
5904 *'statusline'* *'stl'* *E540* *E541* *E542*
5905'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005906 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 {not in Vi}
5908 {not available when compiled without the |+statusline|
5909 feature}
5910 When nonempty, this option determines the content of the status line.
5911 Also see |status-line|.
5912
5913 The option consists of printf style '%' items interspersed with
5914 normal text. Each status line item is of the form:
5915 %-0{minwid}.{maxwid}{item}
5916 All fields except the {item} is optional. A single percent sign can
5917 be given as "%%". Up to 80 items can be specified.
5918
5919 Note that the only effect of 'ruler' when this option is set (and
5920 'laststatus' is 2) is controlling the output of |CTRL-G|.
5921
5922 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005923 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005925 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 minwid Minimum width of the item, padding as set by '-' & '0'.
5927 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005928 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005929 on the left for text items. Numeric items will be
5930 shifted down to maxwid-2 digits followed by '>'number
5931 where number is the amount of missing digits, much like
5932 an exponential notation.
5933 item A one letter code as described below.
5934
5935 Following is a description of the possible statusline items. The
5936 second character in "item" is the type:
5937 N for number
5938 S for string
5939 F for flags as described below
5940 - not applicable
5941
5942 item meaning ~
5943 f S Path to the file in the buffer, relative to current directory.
5944 F S Full path to the file in the buffer.
5945 t S File name (tail) of file in the buffer.
5946 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5947 M F Modified flag, text is ",+" or ",-".
5948 r F Readonly flag, text is " [RO]".
5949 R F Readonly flag, text is ",RO".
5950 h F Help buffer flag, text is " [help]".
5951 H F Help buffer flag, text is ",HLP".
5952 w F Preview window flag, text is " [Preview]".
5953 W F Preview window flag, text is ",PRV".
5954 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5955 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5956 {not available when compiled without |+autocmd| feature}
5957 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5958 being used: "<keymap>"
5959 n N Buffer number.
5960 b N Value of byte under cursor.
5961 B N As above, in hexadecimal.
5962 o N Byte number in file of byte under cursor, first byte is 1.
5963 Mnemonic: Offset from start of file (with one added)
5964 {not available when compiled without |+byte_offset| feature}
5965 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005966 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 l N Line number.
5968 L N Number of lines in buffer.
5969 c N Column number.
5970 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005971 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 p N Percentage through file in lines as in |CTRL-G|.
5973 P S Percentage through file of displayed window. This is like the
5974 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005975 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 Empty if the argument file count is zero or one.
5977 { NF Evaluate expression between '{' and '}' and substitute result.
5978 ( - Start of item group. Can be used for setting the width and
5979 alignment of a section. Must be followed by %) somewhere.
5980 ) - End of item group. No width fields allowed.
5981 < - Where to truncate line if too long. Default is at the start.
5982 No width fields allowed.
5983 = - Separation point between left and right aligned items.
5984 No width fields allowed.
5985 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005986 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 The difference between User{N} and StatusLine will be applied
5988 to StatusLineNC for the statusline of non-current windows.
5989 The number N must be between 1 and 9. See |hl-User1..9|
5990
5991 Display of flags are controlled by the following heuristic:
5992 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005993 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 with a space it is assumed that it wants to separate itself from
5995 anything but other flags. That is: A leading comma is removed if the
5996 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00005997 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 make a nice display when flags are used like in the examples below.
5999
Bram Moolenaar582fd852005-03-28 20:58:01 +00006000 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 not set) and a minwid is not set for the group, the whole group will
6002 become empty. This will make a group like the following disappear
6003 completely from the statusline when none of the flags are set. >
6004 :set statusline=...%(\ [%M%R%H]%)...
6005<
6006 Beware that an expression is evaluated each and every time the status
6007 line is displayed. The current buffer and current window will be set
6008 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006009 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6011 real current buffer. The expression is evaluated in the |sandbox|.
6012
6013 If the statusline is not updated when you want it (e.g., after setting
6014 a variable that's used in an expression), you can force an update by
6015 setting an option without changing its value. Example: >
6016 :let &ro = &ro
6017
6018< A result of all digits is regarded a number for display purposes.
6019 Otherwise the result is taken as flag text and applied to the rules
6020 described above.
6021
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006022 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6024 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6025
6026 Examples:
6027 Emulate standard status line with 'ruler' set >
6028 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6029< Similar, but add ASCII value of char under the cursor (like "ga") >
6030 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6031< Display byte count and byte value, modified flag in red. >
6032 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6033 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6034< Display a ,GZ flag if a compressed file is loaded >
6035 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6036< In the |:autocmd|'s: >
6037 :let b:gzflag = 1
6038< And: >
6039 :unlet b:gzflag
6040< And define this function: >
6041 :function VarExists(var, val)
6042 : if exists(a:var) | return a:val | else | return '' | endif
6043 :endfunction
6044<
6045 *'suffixes'* *'su'*
6046'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6047 global
6048 {not in Vi}
6049 Files with these suffixes get a lower priority when multiple files
6050 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006051 suffixes. Spaces after the comma are ignored. A dot is also seen as
6052 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 separator, precede it with a backslash (see |option-backslash| about
6054 including spaces and backslashes).
6055 See 'wildignore' for completely ignoring files.
6056 The use of |:set+=| and |:set-=| is preferred when adding or removing
6057 suffixes from the list. This avoids problems when a future version
6058 uses another default.
6059
6060 *'suffixesadd'* *'sua'*
6061'suffixesadd' 'sua' string (default "")
6062 local to buffer
6063 {not in Vi}
6064 {not available when compiled without the
6065 |+file_in_path| feature}
6066 Comma separated list of suffixes, which are used when searching for a
6067 file for the "gf", "[I", etc. commands. Example: >
6068 :set suffixesadd=.java
6069<
6070 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6071'swapfile' 'swf' boolean (default on)
6072 local to buffer
6073 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006074 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 swapfile is not wanted for a specific buffer. For example, with
6076 confidential information that even root must not be able to access.
6077 Careful: All text will be in memory:
6078 - Don't use this for big files.
6079 - Recovery will be impossible!
6080 A swapfile will only be present when |'updatecount'| is non-zero and
6081 'swapfile' is set.
6082 When 'swapfile' is reset, the swap file for the current buffer is
6083 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6084 non-zero, a swap file is immediately created.
6085 Also see |swap-file| and |'swapsync'|.
6086
6087 This option is used together with 'bufhidden' and 'buftype' to
6088 specify special kinds of buffers. See |special-buffers|.
6089
6090 *'swapsync'* *'sws'*
6091'swapsync' 'sws' string (default "fsync")
6092 global
6093 {not in Vi}
6094 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006095 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 When this option is empty parts of the swap file may be in memory and
6097 not written to disk. When the system crashes you may lose more work.
6098 On Unix the system does a sync now and then without Vim asking for it,
6099 so the disadvantage of setting this option off is small. On some
6100 systems the swap file will not be written at all. For a unix system
6101 setting it to "sync" will use the sync() call instead of the default
6102 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006103 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
6105 *'switchbuf'* *'swb'*
6106'switchbuf' 'swb' string (default "")
6107 global
6108 {not in Vi}
6109 This option controls the behavior when switching between buffers.
6110 Possible values (comma separated list):
6111 useopen If included, jump to the first open window that
6112 contains the specified buffer (if there is one).
6113 Otherwise: Do not examine other windows.
6114 This setting is checked with |quickfix| commands, when
6115 jumping to errors (":cc", ":cn", "cp", etc.). It is
6116 also used in all buffer related split commands, for
6117 example ":sbuffer", ":sbnext", or ":sbrewind".
6118 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006119 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 Supported in |quickfix| commands that display errors.
6121
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006122 *'synmaxcol'* *'smc'*
6123'synmaxcol' 'smc' number (default 3000)
6124 local to buffer
6125 {not in Vi}
6126 {not available when compiled without the |+syntax|
6127 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006128 Maximum column in which to search for syntax items. In long lines the
6129 text after this column is not highlighted and following lines may not
6130 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006131 This helps to avoid very slow redrawing for an XML file that is one
6132 long line.
6133 Set to zero to remove the limit.
6134
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 *'syntax'* *'syn'*
6136'syntax' 'syn' string (default empty)
6137 local to buffer
6138 {not in Vi}
6139 {not available when compiled without the |+syntax|
6140 feature}
6141 When this option is set, the syntax with this name is loaded, unless
6142 syntax highlighting has been switched off with ":syntax off".
6143 Otherwise this option does not always reflect the current syntax (the
6144 b:current_syntax variable does).
6145 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006146 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147 /* vim: set syntax=idl : */
6148< To switch off syntax highlighting for the current file, use: >
6149 :set syntax=OFF
6150< To switch syntax highlighting on according to the current value of the
6151 'filetype' option: >
6152 :set syntax=ON
6153< What actually happens when setting the 'syntax' option is that the
6154 Syntax autocommand event is triggered with the value as argument.
6155 This option is not copied to another buffer, independent of the 's' or
6156 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006157 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158
6159 *'tabstop'* *'ts'*
6160'tabstop' 'ts' number (default 8)
6161 local to buffer
6162 Number of spaces that a <Tab> in the file counts for. Also see
6163 |:retab| command, and 'softtabstop' option.
6164
6165 Note: Setting 'tabstop' to any other value than 8 can make your file
6166 appear wrong in many places (e.g., when printing it).
6167
6168 There are four main ways to use tabs in Vim:
6169 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6170 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6171 will use a mix of tabs and spaces, but typing Tab and BS will
6172 behave like a tab appears every 4 (or 3) characters.
6173 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6174 'expandtab'. This way you will always insert spaces. The
6175 formatting will never be messed up when 'tabstop' is changed.
6176 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006177 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 works when using Vim to edit the file.
6179 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6180 'noexpandtab'. This should then work (for initial indents only)
6181 for any tabstop setting that people use. It might be nice to have
6182 tabs after the first non-blank inserted as spaces if you do this
6183 though. Otherwise aligned comments will be wrong when 'tabstop' is
6184 changed.
6185
6186 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6187'tagbsearch' 'tbs' boolean (default on)
6188 global
6189 {not in Vi}
6190 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006191 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 searching makes searching for a tag a LOT faster, but a linear search
6193 will find more tags if the tags file wasn't properly sorted.
6194 Vim normally assumes that your tags files are sorted, or indicate that
6195 they are not sorted. Only when this is not the case does the
6196 'tagbsearch' option need to be switched off.
6197
6198 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006199 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 certain files, or retry all files with a linear search. When
6201 'tagbsearch' is off, only a linear search is done.
6202
6203 Linear searching is done anyway, for one file, when Vim finds a line
6204 at the start of the file indicating that it's not sorted: >
6205 !_TAG_FILE_SORTED 0 /some command/
6206< [The whitespace before and after the '0' must be a single <Tab>]
6207
6208 When a binary search was done and no match was found in any of the
6209 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6210 instead of a normal tag name, a retry is done with a linear search.
6211 Tags in unsorted tags files, and matches with different case will only
6212 be found in the retry.
6213
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006214 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 linear search can be avoided for the 'ignorecase' case. Use a value
6216 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6217 case-fold sorted with the -f switch to "sort" in most unices, as in
6218 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6219 5.3 or higher the -f or --fold-case-sort switch can be used for this
6220 as well. Note that case must be folded to uppercase for this to work.
6221
6222 When 'tagbsearch' is off, tags searching is slower when a full match
6223 exists, but faster when no full match exists. Tags in unsorted tags
6224 files may only be found with 'tagbsearch' off.
6225 When the tags file is not sorted, or sorted in a wrong way (not on
6226 ASCII byte value), 'tagbsearch' should be off, or the line given above
6227 must be included in the tags file.
6228 This option doesn't affect commands that find all matching tags (e.g.,
6229 command-line completion and ":help").
6230 {Vi: always uses binary search in some versions}
6231
6232 *'taglength'* *'tl'*
6233'taglength' 'tl' number (default 0)
6234 global
6235 If non-zero, tags are significant up to this number of characters.
6236
6237 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6238'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6239 global
6240 {not in Vi}
6241 If on and using a tag file in another directory, file names in that
6242 tag file are relative to the directory where the tag file is.
6243 NOTE: This option is set to the Vi default value when 'compatible' is
6244 set and to the Vim default value when 'compatible' is reset.
6245
6246 *'tags'* *'tag'* *E433*
6247'tags' 'tag' string (default "./tags,tags", when compiled with
6248 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6249 global or local to buffer |global-local|
6250 Filenames for the tag command, separated by spaces or commas. To
6251 include a space or comma in a file name, precede it with a backslash
6252 (see |option-backslash| about including spaces and backslashes).
6253 When a file name starts with "./", the '.' is replaced with the path
6254 of the current file. But only when the 'd' flag is not included in
6255 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6256 |tags-option|.
6257 "*", "**" and other wildcards can be used to search for tags files in
6258 a directory tree. See |file-searching|. {not available when compiled
6259 without the |+path_extra| feature}
6260 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6261 files are also supported. They are automatically recognized. The
6262 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6263 differences are ignored (MS-Windows). |emacs-tags|
6264 The use of |:set+=| and |:set-=| is preferred when adding or removing
6265 file names from the list. This avoids problems when a future version
6266 uses another default.
6267 {Vi: default is "tags /usr/lib/tags"}
6268
6269 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6270'tagstack' 'tgst' boolean (default on)
6271 global
6272 {not in all versions of Vi}
6273 When on, the |tagstack| is used normally. When off, a ":tag" or
6274 ":tselect" command with an argument will not push the tag onto the
6275 tagstack. A following ":tag" without an argument, a ":pop" command or
6276 any other command that uses the tagstack will use the unmodified
6277 tagstack, but does change the pointer to the active entry.
6278 Resetting this option is useful when using a ":tag" command in a
6279 mapping which should not change the tagstack.
6280
6281 *'term'* *E529* *E530* *E531*
6282'term' string (default is $TERM, if that fails:
6283 in the GUI: "builtin_gui"
6284 on Amiga: "amiga"
6285 on BeOS: "beos-ansi"
6286 on Mac: "mac-ansi"
6287 on MiNT: "vt52"
6288 on MS-DOS: "pcterm"
6289 on OS/2: "os2ansi"
6290 on Unix: "ansi"
6291 on VMS: "ansi"
6292 on Win 32: "win32")
6293 global
6294 Name of the terminal. Used for choosing the terminal control
6295 characters. Environment variables are expanded |:set_env|.
6296 For example: >
6297 :set term=$TERM
6298< See |termcap|.
6299
6300 *'termbidi'* *'tbidi'*
6301 *'notermbidi'* *'notbidi'*
6302'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6303 global
6304 {not in Vi}
6305 {only available when compiled with the |+arabic|
6306 feature}
6307 The terminal is in charge of Bi-directionality of text (as specified
6308 by Unicode). The terminal is also expected to do the required shaping
6309 that some languages (such as Arabic) require.
6310 Setting this option implies that 'rightleft' will not be set when
6311 'arabic' is set and the value of 'arabicshape' will be ignored.
6312 Note that setting 'termbidi' has the immediate effect that
6313 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6314 This option is reset when the GUI is started.
6315 For further details see |arabic.txt|.
6316
6317 *'termencoding'* *'tenc'*
6318'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6319 Macintosh GUI: "macroman")
6320 global
6321 {only available when compiled with the |+multi_byte|
6322 feature}
6323 {not in Vi}
6324 Encoding used for the terminal. This specifies what character
6325 encoding the keyboard produces and the display will understand. For
6326 the GUI it only applies to the keyboard ('encoding' is used for the
6327 display).
6328 In the Win32 console version the default value is the console codepage
6329 when it differs from the ANSI codepage.
6330 *E617*
6331 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6332 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6333 Any attempts to set a different value will be rejected, and an error
6334 message is shown.
6335 For the Win32 GUI 'termencoding' is not used for typed characters,
6336 because the Win32 system always passes Unicode characters.
6337 When empty, the same encoding is used as for the 'encoding' option.
6338 This is the normal value.
6339 Not all combinations for 'termencoding' and 'encoding' are valid. See
6340 |encoding-table|.
6341 The value for this option must be supported by internal conversions or
6342 iconv(). When this is not possible no conversion will be done and you
6343 will probably experience problems with non-ASCII characters.
6344 Example: You are working with the locale set to euc-jp (Japanese) and
6345 want to edit a UTF-8 file: >
6346 :let &termencoding = &encoding
6347 :set encoding=utf-8
6348< You need to do this when your system has no locale support for UTF-8.
6349
6350 *'terse'* *'noterse'*
6351'terse' boolean (default off)
6352 global
6353 When set: Add 's' flag to 'shortmess' option (this makes the message
6354 for a search that hits the start or end of the file not being
6355 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6356 shortens a lot of messages}
6357
6358 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6359'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6360 global
6361 {not in Vi}
6362 This option is obsolete. Use 'fileformats'.
6363 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6364 set to the default value for the current system. When 'textauto' is
6365 reset, 'fileformats' is made empty.
6366 NOTE: This option is set to the Vi default value when 'compatible' is
6367 set and to the Vim default value when 'compatible' is reset.
6368
6369 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6370'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6371 others: default off)
6372 local to buffer
6373 {not in Vi}
6374 This option is obsolete. Use 'fileformat'.
6375 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6376 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6377 "unix".
6378
6379 *'textwidth'* *'tw'*
6380'textwidth' 'tw' number (default 0)
6381 local to buffer
6382 {not in Vi}
6383 Maximum width of text that is being inserted. A longer line will be
6384 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006385 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6386 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 'formatoptions' and |ins-textwidth|.
6388 NOTE: This option is set to 0 when 'compatible' is set.
6389
6390 *'thesaurus'* *'tsr'*
6391'thesaurus' 'tsr' string (default "")
6392 global or local to buffer |global-local|
6393 {not in Vi}
6394 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006395 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 the file should contain words with similar meaning, separated by
6397 non-keyword characters (white space is preferred). Maximum line
6398 length is 510 bytes.
6399 To obtain a file to be used here, check out the wordlist FAQ at
6400 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006401 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006402 after a comma are ignored, otherwise spaces are included in the file
6403 name. See |option-backslash| about using backslashes.
6404 The use of |:set+=| and |:set-=| is preferred when adding or removing
6405 directories from the list. This avoids problems when a future version
6406 uses another default.
6407 Backticks cannot be used in this option for security reasons.
6408
6409 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6410'tildeop' 'top' boolean (default off)
6411 global
6412 {not in Vi}
6413 When on: The tilde command "~" behaves like an operator.
6414 NOTE: This option is reset when 'compatible' is set.
6415
6416 *'timeout'* *'to'* *'notimeout'* *'noto'*
6417'timeout' 'to' boolean (default on)
6418 global
6419 *'ttimeout'* *'nottimeout'*
6420'ttimeout' boolean (default off)
6421 global
6422 {not in Vi}
6423 These two options together determine the behavior when part of a
6424 mapped key sequence or keyboard code has been received:
6425
6426 'timeout' 'ttimeout' action ~
6427 off off do not time out
6428 on on or off time out on :mappings and key codes
6429 off on time out on key codes
6430
6431 If both options are off, Vim will wait until either the complete
6432 mapping or key sequence has been received, or it is clear that there
6433 is no mapping or key sequence for the received characters. For
6434 example: if you have mapped "vl" and Vim has received 'v', the next
6435 character is needed to see if the 'v' is followed by an 'l'.
6436 When one of the options is on, Vim will wait for about 1 second for
6437 the next character to arrive. After that the already received
6438 characters are interpreted as single characters. The waiting time can
6439 be changed with the 'timeoutlen' option.
6440 On slow terminals or very busy systems timing out may cause
6441 malfunctioning cursor keys. If both options are off, Vim waits
6442 forever after an entered <Esc> if there are key codes that start
6443 with <Esc>. You will have to type <Esc> twice. If you do not have
6444 problems with key codes, but would like to have :mapped key
6445 sequences not timing out in 1 second, set the 'ttimeout' option and
6446 reset the 'timeout' option.
6447
6448 NOTE: 'ttimeout' is reset when 'compatible' is set.
6449
6450 *'timeoutlen'* *'tm'*
6451'timeoutlen' 'tm' number (default 1000)
6452 global
6453 {not in all versions of Vi}
6454 *'ttimeoutlen'* *'ttm'*
6455'ttimeoutlen' 'ttm' number (default -1)
6456 global
6457 {not in Vi}
6458 The time in milliseconds that is waited for a key code or mapped key
6459 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6460 when part of a command has been typed.
6461 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6462 different timeout value for key codes is desired set 'ttimeoutlen' to
6463 a non-negative number.
6464
6465 ttimeoutlen mapping delay key code delay ~
6466 < 0 'timeoutlen' 'timeoutlen'
6467 >= 0 'timeoutlen' 'ttimeoutlen'
6468
6469 The timeout only happens when the 'timeout' and 'ttimeout' options
6470 tell so. A useful setting would be >
6471 :set timeout timeoutlen=3000 ttimeoutlen=100
6472< (time out on mapping after three seconds, time out on key codes after
6473 a tenth of a second).
6474
6475 *'title'* *'notitle'*
6476'title' boolean (default off, on when title can be restored)
6477 global
6478 {not in Vi}
6479 {not available when compiled without the |+title|
6480 feature}
6481 When on, the title of the window will be set to the value of
6482 'titlestring' (if it is not empty), or to:
6483 filename [+=-] (path) - VIM
6484 Where:
6485 filename the name of the file being edited
6486 - indicates the file cannot be modified, 'ma' off
6487 + indicates the file was modified
6488 = indicates the file is read-only
6489 =+ indicates the file is read-only and modified
6490 (path) is the path of the file being edited
6491 - VIM the server name |v:servername| or "VIM"
6492 Only works if the terminal supports setting window titles
6493 (currently Amiga console, Win32 console, all GUI versions and
6494 terminals with a non- empty 't_ts' option - these are Unix xterm and
6495 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6496 *X11*
6497 When Vim was compiled with HAVE_X11 defined, the original title will
6498 be restored if possible. The output of ":version" will include "+X11"
6499 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6500 works for the icon name |'icon'|.
6501 But: When Vim was started with the |-X| argument, restoring the title
6502 will not work (except in the GUI).
6503 If the title cannot be restored, it is set to the value of 'titleold'.
6504 You might want to restore the title outside of Vim then.
6505 When using an xterm from a remote machine you can use this command:
6506 rsh machine_name xterm -display $DISPLAY &
6507 then the WINDOWID environment variable should be inherited and the
6508 title of the window should change back to what it should be after
6509 exiting Vim.
6510
6511 *'titlelen'*
6512'titlelen' number (default 85)
6513 global
6514 {not in Vi}
6515 {not available when compiled without the |+title|
6516 feature}
6517 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006518 title. When the title is longer, only the end of the path name is
6519 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 Using a percentage makes this adapt to the width of the window. But
6521 it won't work perfectly, because the actual number of characters
6522 available also depends on the font used and other things in the title
6523 bar. When 'titlelen' is zero the full path is used. Otherwise,
6524 values from 1 to 30000 percent can be used.
6525 'titlelen' is also used for the 'titlestring' option.
6526
6527 *'titleold'*
6528'titleold' string (default "Thanks for flying Vim")
6529 global
6530 {not in Vi}
6531 {only available when compiled with the |+title|
6532 feature}
6533 This option will be used for the window title when exiting Vim if the
6534 original title cannot be restored. Only happens if 'title' is on or
6535 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006536 This option cannot be set from a |modeline| or in the |sandbox|, for
6537 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 *'titlestring'*
6539'titlestring' string (default "")
6540 global
6541 {not in Vi}
6542 {not available when compiled without the |+title|
6543 feature}
6544 When this option is not empty, it will be used for the title of the
6545 window. This happens only when the 'title' option is on.
6546 Only works if the terminal supports setting window titles (currently
6547 Amiga console, Win32 console, all GUI versions and terminals with a
6548 non-empty 't_ts' option).
6549 When Vim was compiled with HAVE_X11 defined, the original title will
6550 be restored if possible |X11|.
6551 When this option contains printf-style '%' items, they will be
6552 expanded according to the rules used for 'statusline'.
6553 Example: >
6554 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6555 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6556< The value of 'titlelen' is used to align items in the middle or right
6557 of the available space.
6558 Some people prefer to have the file name first: >
6559 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6560< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006561 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 separating space only when needed.
6563 NOTE: Use of special characters in 'titlestring' may cause the display
6564 to be garbled (e.g., when it contains a CR or NL character).
6565 {not available when compiled without the |+statusline| feature}
6566
6567 *'toolbar'* *'tb'*
6568'toolbar' 'tb' string (default "icons,tooltips")
6569 global
6570 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6571 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006572 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 possible values are:
6574 icons Toolbar buttons are shown with icons.
6575 text Toolbar buttons shown with text.
6576 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006577 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 tooltips Tooltips are active for toolbar buttons.
6579 Tooltips refer to the popup help text which appears after the mouse
6580 cursor is placed over a toolbar button for a brief moment.
6581
6582 If you want the toolbar to be shown with icons as well as text, do the
6583 following: >
6584 :set tb=icons,text
6585< Motif and Athena cannot display icons and text at the same time. They
6586 will show icons if both are requested.
6587
6588 If none of the strings specified in 'toolbar' are valid or if
6589 'toolbar' is empty, this option is ignored. If you want to disable
6590 the toolbar, you need to set the 'guioptions' option. For example: >
6591 :set guioptions-=T
6592< Also see |gui-toolbar|.
6593
6594 *'toolbariconsize'* *'tbis'*
6595'toolbariconsize' 'tbis' string (default "small")
6596 global
6597 {not in Vi}
6598 {only in the GTK+ 2 GUI}
6599 Controls the size of toolbar icons. The possible values are:
6600 tiny Use tiny toolbar icons.
6601 small Use small toolbar icons (default).
6602 medium Use medium-sized toolbar icons.
6603 large Use large toolbar icons.
6604 The exact dimensions in pixels of the various icon sizes depend on
6605 the current theme. Common dimensions are large=32x32, medium=24x24,
6606 small=20x20 and tiny=16x16.
6607
6608 If 'toolbariconsize' is empty, the global default size as determined
6609 by user preferences or the current theme is used.
6610
6611 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6612'ttybuiltin' 'tbi' boolean (default on)
6613 global
6614 {not in Vi}
6615 When on, the builtin termcaps are searched before the external ones.
6616 When off the builtin termcaps are searched after the external ones.
6617 When this option is changed, you should set the 'term' option next for
6618 the change to take effect, for example: >
6619 :set notbi term=$TERM
6620< See also |termcap|.
6621 Rationale: The default for this option is "on", because the builtin
6622 termcap entries are generally better (many systems contain faulty
6623 xterm entries...).
6624
6625 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6626'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6627 sun-cmd, screen, rxvt, dtterm or
6628 iris-ansi; also on when running Vim in
6629 a DOS console)
6630 global
6631 {not in Vi}
6632 Indicates a fast terminal connection. More characters will be sent to
6633 the screen for redrawing, instead of using insert/delete line
6634 commands. Improves smoothness of redrawing when there are multiple
6635 windows and the terminal does not support a scrolling region.
6636 Also enables the extra writing of characters at the end of each screen
6637 line for lines that wrap. This helps when using copy/paste with the
6638 mouse in an xterm and other terminals.
6639
6640 *'ttymouse'* *'ttym'*
6641'ttymouse' 'ttym' string (default depends on 'term')
6642 global
6643 {not in Vi}
6644 {only in Unix and VMS, doesn't work in the GUI; not
6645 available when compiled without |+mouse|}
6646 Name of the terminal type for which mouse codes are to be recognized.
6647 Currently these three strings are valid:
6648 *xterm-mouse*
6649 xterm xterm-like mouse handling. The mouse generates
6650 "<Esc>[Mscr", where "scr" is three bytes:
6651 "s" = button state
6652 "c" = column plus 33
6653 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006654 This only works up to 223 columns! See "dec" for a
6655 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 xterm2 Works like "xterm", but with the xterm reporting the
6657 mouse position while the mouse is dragged. This works
6658 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006659 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 work. See below for how Vim detects this
6661 automatically.
6662 *netterm-mouse*
6663 netterm NetTerm mouse handling. The mouse generates
6664 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6665 for the row and column.
6666 *dec-mouse*
6667 dec DEC terminal mouse handling. The mouse generates a
6668 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006669 This is also available for an Xterm, if it was
6670 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 *jsbterm-mouse*
6672 jsbterm JSB term mouse handling.
6673 *pterm-mouse*
6674 pterm QNX pterm mouse handling.
6675
6676 The mouse handling must be enabled at compile time |+mouse_xterm|
6677 |+mouse_dec| |+mouse_netterm|.
6678 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6679 recognized, if enabled at compile time. DEC terminal mouse codes
6680 are recognized if enabled at compile time, and 'ttymouse' is not
6681 "xterm" (because the xterm and dec mouse codes conflict).
6682 This option is automatically set to "xterm", when the 'term' option is
6683 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6684 or "xterm2" already. The main use of this option is to set it to
6685 "xterm", when the terminal name doesn't start with "xterm", but it can
6686 handle xterm mouse codes.
6687 The "xterm2" value will be set if the xterm version is reported to be
6688 95 of higher. This only works when compiled with the |+termresponse|
6689 feature and if |t_RV| is set to the escape sequence to request the
6690 xterm version number. Otherwise "xterm2" must be set explicitly.
6691 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6692 t_RV to an empty string: >
6693 :set t_RV=
6694<
6695 *'ttyscroll'* *'tsl'*
6696'ttyscroll' 'tsl' number (default 999)
6697 global
6698 Maximum number of lines to scroll the screen. If there are more lines
6699 to scroll the window is redrawn. For terminals where scrolling is
6700 very slow and redrawing is not slow this can be set to a small number,
6701 e.g., 3, to speed up displaying.
6702
6703 *'ttytype'* *'tty'*
6704'ttytype' 'tty' string (default from $TERM)
6705 global
6706 Alias for 'term', see above.
6707
6708 *'undolevels'* *'ul'*
6709'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6710 Win32 and OS/2)
6711 global
6712 {not in Vi}
6713 Maximum number of changes that can be undone. Since undo information
6714 is kept in memory, higher numbers will cause more memory to be used
6715 (nevertheless, a single change can use an unlimited amount of memory).
6716 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6717 itself: >
6718 set ul=0
6719< But you can also get Vi compatibility by including the 'u' flag in
6720 'cpoptions', and still be able to use CTRL-R to repeat undo.
6721 Set to a negative number for no undo at all: >
6722 set ul=-1
6723< This helps when you run out of memory for a single change.
6724 Also see |undo-two-ways|.
6725
6726 *'updatecount'* *'uc'*
6727'updatecount' 'uc' number (default: 200)
6728 global
6729 {not in Vi}
6730 After typing this many characters the swap file will be written to
6731 disk. When zero, no swap file will be created at all (see chapter on
6732 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6733 Vim with the "-n" option, see |startup|. When editing in readonly
6734 mode this option will be initialized to 10000.
6735 The swapfile can be disabled per buffer with |'swapfile'|.
6736 When 'updatecount' is set from zero to non-zero, swap files are
6737 created for all buffers that have 'swapfile' set. When 'updatecount'
6738 is set to zero, existing swap files are not deleted.
6739 Also see |'swapsync'|.
6740 This option has no meaning in buffers where |'buftype'| is "nofile"
6741 or "nowrite".
6742
6743 *'updatetime'* *'ut'*
6744'updatetime' 'ut' number (default 4000)
6745 global
6746 {not in Vi}
6747 If this many milliseconds nothing is typed the swap file will be
6748 written to disk (see |crash-recovery|). Also used for the
6749 |CursorHold| autocommand event.
6750
6751 *'verbose'* *'vbs'*
6752'verbose' 'vbs' number (default 0)
6753 global
6754 {not in Vi, although some versions have a boolean
6755 verbose option}
6756 When bigger than zero, Vim will give messages about what it is doing.
6757 Currently, these messages are given:
6758 >= 1 When the viminfo file is read or written.
6759 >= 2 When a file is ":source"'ed.
6760 >= 5 Every searched tags file.
6761 >= 8 Files for which a group of autocommands is executed.
6762 >= 9 Every executed autocommand.
6763 >= 12 Every executed function.
6764 >= 13 When an exception is thrown, caught, finished, or discarded.
6765 >= 14 Anything pending in a ":finally" clause.
6766 >= 15 Every executed Ex command (truncated at 200 characters).
6767
6768 This option can also be set with the "-V" argument. See |-V|.
6769 This option is also set by the |:verbose| command.
6770
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006771 When the 'verbosefile' option is set then the verbose messages are not
6772 displayed.
6773
6774 *'verbosefile'* *'vfile'*
6775'verbosefile' 'vfile' string (default empty)
6776 global
6777 {not in Vi}
6778 When not empty all messages are written in a file with this name.
6779 When the file exists messages are appended.
6780 Writing to the file ends when Vim exits or when 'verbosefile' is made
6781 empty.
6782 Setting 'verbosefile' to a new value is like making it empty first.
6783 The difference with |:redir| is that verbose messages are not
6784 displayed when 'verbosefile' is set.
6785
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 *'viewdir'* *'vdir'*
6787'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6788 "$VIM/vimfiles/view",
6789 for Unix: "~/.vim/view",
6790 for Macintosh: "$VIM:vimfiles:view"
6791 for VMS: "sys$login:vimfiles/view"
6792 for RiscOS: "Choices:vimfiles/view")
6793 global
6794 {not in Vi}
6795 {not available when compiled without the +mksession
6796 feature}
6797 Name of the directory where to store files for |:mkview|.
6798 This option cannot be set from a |modeline| or in the |sandbox|, for
6799 security reasons.
6800
6801 *'viewoptions'* *'vop'*
6802'viewoptions' 'vop' string (default: "folds,options,cursor")
6803 global
6804 {not in Vi}
6805 {not available when compiled without the +mksession
6806 feature}
6807 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006808 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 word save and restore ~
6810 cursor cursor position in file and in window
6811 folds manually created folds, opened/closed folds and local
6812 fold options
6813 options options and mappings local to a window or buffer (not
6814 global values for local options)
6815 slash backslashes in file names replaced with forward
6816 slashes
6817 unix with Unix end-of-line format (single <NL>), even when
6818 on Windows or DOS
6819
6820 "slash" and "unix" are useful on Windows when sharing view files
6821 with Unix. The Unix version of Vim cannot source dos format scripts,
6822 but the Windows version of Vim can source unix format scripts.
6823
6824 *'viminfo'* *'vi'* *E526* *E527* *E528*
6825'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6826 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6827 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6828 for others: '20,<50,s10,h)
6829 global
6830 {not in Vi}
6831 {not available when compiled without the |+viminfo|
6832 feature}
6833 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006834 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 separated list of parameters, each consisting of a single character
6836 identifying the particular parameter, followed by a number or string
6837 which specifies the value of that parameter. If a particular
6838 character is left out, then the default value is used for that
6839 parameter. The following is a list of the identifying characters and
6840 the effect of their value.
6841 CHAR VALUE ~
6842 ! When included, save and restore global variables that start
6843 with an uppercase letter, and don't contain a lowercase
6844 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006845 and "_K_L_M" are not. Only String and Number types are
6846 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 " Maximum number of lines saved for each register. Old name of
6848 the '<' item, with the disadvantage that you need to put a
6849 backslash before the ", otherwise it will be recognized as the
6850 start of a comment!
6851 % When included, save and restore the buffer list. If Vim is
6852 started with a file name argument, the buffer list is not
6853 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006854 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855 without a file name and buffers for help files are not written
6856 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006857 When followed by a number, the number specifies the maximum
6858 number of buffers that are stored. Without a number all
6859 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 ' Maximum number of previously edited files for which the marks
6861 are remembered. This parameter must always be included when
6862 'viminfo' is non-empty.
6863 Including this item also means that the |jumplist| and the
6864 |changelist| are stored in the viminfo file.
6865 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006866 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 patterns are also saved. When not included, the value of
6868 'history' is used.
6869 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006870 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 < Maximum number of lines saved for each register. If zero then
6872 registers are not saved. When not included, all lines are
6873 saved. '"' is the old name for this item.
6874 Also see the 's' item below: limit specified in Kbyte.
6875 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006876 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 c When included, convert the text in the viminfo file from the
6878 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006879 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 f Whether file marks need to be stored. If zero, file marks ('0
6881 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006882 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 cursor position (when exiting or when doing ":wviminfo").
6884 h Disable the effect of 'hlsearch' when loading the viminfo
6885 file. When not included, it depends on whether ":nohlsearch"
6886 has been used since the last search command.
6887 n Name of the viminfo file. The name must immediately follow
6888 the 'n'. Must be the last one! If the "-i" argument was
6889 given when starting Vim, that file name overrides the one
6890 given here with 'viminfo'. Environment variables are expanded
6891 when opening the file, not when setting the option.
6892 r Removable media. The argument is a string (up to the next
6893 ','). This parameter can be given several times. Each
6894 specifies the start of a path for which no marks will be
6895 stored. This is to avoid removable media. For MS-DOS you
6896 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6897 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6898 ignored. Maximum length of each 'r' argument is 50
6899 characters.
6900 s Maximum size of an item in Kbyte. If zero then registers are
6901 not saved. Currently only applies to registers. The default
6902 "s10" will exclude registers with more than 10 Kbyte of text.
6903 Also see the '<' item above: line count limit.
6904
6905 Example: >
6906 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6907<
6908 '50 Marks will be remembered for the last 50 files you
6909 edited.
6910 <1000 Contents of registers (up to 1000 lines each) will be
6911 remembered.
6912 s100 Registers with more than 100 Kbyte text are skipped.
6913 :0 Command-line history will not be saved.
6914 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6915 no / Since '/' is not specified, the default will be used,
6916 that is, save all of the search history, and also the
6917 previous search and substitute patterns.
6918 no % The buffer list will not be saved nor read back.
6919 no h 'hlsearch' highlighting will be restored.
6920
6921 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6922 load the contents of the file, this is not done automatically.
6923
6924 This option cannot be set from a |modeline| or in the |sandbox|, for
6925 security reasons.
6926
6927 *'virtualedit'* *'ve'*
6928'virtualedit' 've' string (default "")
6929 global
6930 {not in Vi}
6931 {not available when compiled without the
6932 |+virtualedit| feature}
6933 A comma separated list of these words:
6934 block Allow virtual editing in Visual block mode.
6935 insert Allow virtual editing in Insert mode.
6936 all Allow virtual editing in all modes.
6937 Virtual editing means that the cursor can be positioned where there is
6938 no actual character. This can be halfway into a Tab or beyond the end
6939 of the line. Useful for selecting a rectangle in Visual mode and
6940 editing a table.
6941
6942 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6943'visualbell' 'vb' boolean (default off)
6944 global
6945 {not in Vi}
6946 Use visual bell instead of beeping. The terminal code to display the
6947 visual bell is given with 't_vb'. When no beep or flash is wanted,
6948 use ":set vb t_vb=".
6949 Note: When the GUI starts, 't_vb' is reset to its default value. You
6950 might want to set it again in your |gvimrc|.
6951 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6952 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6953 where 40 is the time in msec.
6954 Does not work on the Amiga, you always get a screen flash.
6955 Also see 'errorbells'.
6956
6957 *'warn'* *'nowarn'*
6958'warn' boolean (default on)
6959 global
6960 Give a warning message when a shell command is used while the buffer
6961 has been changed.
6962
6963 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6964'weirdinvert' 'wiv' boolean (default off)
6965 global
6966 {not in Vi}
6967 This option has the same effect as the 't_xs' termcap option.
6968 It is provided for backwards compatibility with version 4.x.
6969 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6970 vice versa. Has no effect when the GUI is running.
6971
6972 *'whichwrap'* *'ww'*
6973'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6974 global
6975 {not in Vi}
6976 Allow specified keys that move the cursor left/right to move to the
6977 previous/next line when the cursor is on the first/last character in
6978 the line. Concatenate characters to allow this for these keys:
6979 char key mode ~
6980 b <BS> Normal and Visual
6981 s <Space> Normal and Visual
6982 h "h" Normal and Visual
6983 l "l" Normal and Visual
6984 < <Left> Normal and Visual
6985 > <Right> Normal and Visual
6986 ~ "~" Normal
6987 [ <Left> Insert and Replace
6988 ] <Right> Insert and Replace
6989 For example: >
6990 :set ww=<,>,[,]
6991< allows wrap only when cursor keys are used.
6992 When the movement keys are used in combination with a delete or change
6993 operator, the <EOL> also counts for a character. This makes "3h"
6994 different from "3dh" when the cursor crosses the end of a line. This
6995 is also true for "x" and "X", because they do the same as "dl" and
6996 "dh". If you use this, you may also want to use the mapping
6997 ":map <BS> X" to make backspace delete the character in front of the
6998 cursor.
6999 When 'l' is included, you get a side effect: "yl" on an empty line
7000 will include the <EOL>, so that "p" will insert a new line.
7001 NOTE: This option is set to the Vi default value when 'compatible' is
7002 set and to the Vim default value when 'compatible' is reset.
7003
7004 *'wildchar'* *'wc'*
7005'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7006 global
7007 {not in Vi}
7008 Character you have to type to start wildcard expansion in the
7009 command-line, as specified with 'wildmode'.
7010 The character is not recognized when used inside a macro. See
7011 'wildcharm' for that.
7012 Although 'wc' is a number option, you can set it to a special key: >
7013 :set wc=<Esc>
7014< NOTE: This option is set to the Vi default value when 'compatible' is
7015 set and to the Vim default value when 'compatible' is reset.
7016
7017 *'wildcharm'* *'wcm'*
7018'wildcharm' 'wcm' number (default: none (0))
7019 global
7020 {not in Vi}
7021 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007022 recognized when used inside a macro. You can find "spare" command-line
7023 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007024 you'll never actually type 'wildcharm', just use it in mappings that
7025 automatically invoke completion mode, e.g.: >
7026 :set wcm=<C-Z>
7027 :cmap ss so $vim/sessions/*.vim<C-Z>
7028< Then after typing :ss you can use CTRL-P & CTRL-N.
7029
7030 *'wildignore'* *'wig'*
7031'wildignore' 'wig' string (default "")
7032 global
7033 {not in Vi}
7034 {not available when compiled without the |+wildignore|
7035 feature}
7036 A list of file patterns. A file that matches with one of these
7037 patterns is ignored when completing file or directory names.
7038 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7039 Also see 'suffixes'.
7040 Example: >
7041 :set wildignore=*.o,*.obj
7042< The use of |:set+=| and |:set-=| is preferred when adding or removing
7043 a pattern from the list. This avoids problems when a future version
7044 uses another default.
7045
7046 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7047'wildmenu' 'wmnu' boolean (default off)
7048 global
7049 {not in Vi}
7050 {not available if compiled without the |+wildmenu|
7051 feature}
7052 When 'wildmenu' is on, command-line completion operates in an enhanced
7053 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7054 the possible matches are shown just above the command line, with the
7055 first match highlighted (overwriting the status line, if there is
7056 one). Keys that show the previous/next match, such as <Tab> or
7057 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7058 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7059 specified. "longest" and "list" do not start "wildmenu" mode.
7060 If there are more matches than can fit in the line, a ">" is shown on
7061 the right and/or a "<" is shown on the left. The status line scrolls
7062 as needed.
7063 The "wildmenu" mode is abandoned when a key is hit that is not used
7064 for selecting a completion.
7065 While the "wildmenu" is active the following keys have special
7066 meanings:
7067
7068 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7069 <Down> - in filename/menu name completion: move into a
7070 subdirectory or submenu.
7071 <CR> - in menu completion, when the cursor is just after a
7072 dot: move into a submenu.
7073 <Up> - in filename/menu name completion: move up into
7074 parent directory or parent menu.
7075
7076 This makes the menus accessible from the console |console-menus|.
7077
7078 If you prefer the <Left> and <Right> keys to move the cursor instead
7079 of selecting a different match, use this: >
7080 :cnoremap <Left> <Space><BS><Left>
7081 :cnoremap <Right> <Space><BS><Right>
7082<
7083 The "WildMenu" highlighting is used for displaying the current match
7084 |hl-WildMenu|.
7085
7086 *'wildmode'* *'wim'*
7087'wildmode' 'wim' string (Vim default: "full")
7088 global
7089 {not in Vi}
7090 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 part specifies what to do for each consecutive use of 'wildchar. The
7093 first part specifies the behavior for the first use of 'wildchar',
7094 The second part for the second use, etc.
7095 These are the possible values for each part:
7096 "" Complete only the first match.
7097 "full" Complete the next full match. After the last match,
7098 the original string is used and then the first match
7099 again.
7100 "longest" Complete till longest common string. If this doesn't
7101 result in a longer string, use the next part.
7102 "longest:full" Like "longest", but also start 'wildmenu' if it is
7103 enabled.
7104 "list" When more than one match, list all matches.
7105 "list:full" When more than one match, list all matches and
7106 complete first match.
7107 "list:longest" When more than one match, list all matches and
7108 complete till longest common string.
7109 When there is only a single match, it is fully completed in all cases.
7110
7111 Examples: >
7112 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007113< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 :set wildmode=longest,full
7115< Complete longest common string, then each full match >
7116 :set wildmode=list:full
7117< List all matches and complete each full match >
7118 :set wildmode=list,full
7119< List all matches without completing, then each full match >
7120 :set wildmode=longest,list
7121< Complete longest common string, then list alternatives.
7122
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007123 *'wildoptions'* *'wop'*
7124'wildoptions' 'wop' string (default "")
7125 global
7126 {not in Vi}
7127 {not available when compiled without the |+wildignore|
7128 feature}
7129 A list of words that change how command line completion is done.
7130 Currently only one word is allowed:
7131 tagfile When using CTRL-D to list matching tags, the kind of
7132 tag and the file of the tag is listed. Only one match
7133 is displayed per line. Often used tag kinds are:
7134 d #define
7135 f function
7136 Also see |cmdline-completion|.
7137
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 *'winaltkeys'* *'wak'*
7139'winaltkeys' 'wak' string (default "menu")
7140 global
7141 {not in Vi}
7142 {only used in Win32, Motif, GTK and Photon GUI}
7143 Some GUI versions allow the access to menu entries by using the ALT
7144 key in combination with a character that appears underlined in the
7145 menu. This conflicts with the use of the ALT key for mappings and
7146 entering special characters. This option tells what to do:
7147 no Don't use ALT keys for menus. ALT key combinations can be
7148 mapped, but there is no automatic handling. This can then be
7149 done with the |:simalt| command.
7150 yes ALT key handling is done by the windowing system. ALT key
7151 combinations cannot be mapped.
7152 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007153 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007154 keys can be mapped.
7155 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7156 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007157 This option is not used for <F10>; on Win32 and with GTK <F10> will
7158 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007160 *'window'* *'wi'*
7161'window' 'wi' number (default screen height - 1)
7162 global
7163 Window height. Do not confuse this with the height of the Vim window,
7164 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007165 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7166 value is smaller than 'lines' minus one. The screen will scroll
7167 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007168 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7169 in a much smarter way, taking care of wrapping lines.
7170 When resizing the Vim window, the value is smaller than 1 or more than
7171 or equal to 'lines' it will be set to 'lines' minus 1.
7172 {Vi also uses the option to specify the number of displayed lines}
7173
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 *'winheight'* *'wh'* *E591*
7175'winheight' 'wh' number (default 1)
7176 global
7177 {not in Vi}
7178 {not available when compiled without the +windows
7179 feature}
7180 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007181 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 current window is smaller, its size is increased, at the cost of the
7183 height of other windows. Set it to 999 to make the current window
7184 always fill the screen (although this has the drawback that ":all"
7185 will create only two windows). Set it to a small number for normal
7186 editing.
7187 Minimum value is 1.
7188 The height is not adjusted after one of the commands to change the
7189 height of the current window.
7190 'winheight' applies to the current window. Use 'winminheight' to set
7191 the minimal height for other windows.
7192
7193 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7194'winfixheight' 'wfh' boolean (default off)
7195 local to window
7196 {not in Vi}
7197 {not available when compiled without the +windows
7198 feature}
7199 Keep the window height when windows are opened or closed and
7200 'equalalways' is set. Set by default for the |preview-window| and
7201 |quickfix-window|.
7202 The height may be changed anyway when running out of room.
7203
7204 *'winminheight'* *'wmh'*
7205'winminheight' 'wmh' number (default 1)
7206 global
7207 {not in Vi}
7208 {not available when compiled without the +windows
7209 feature}
7210 The minimal height of a window, when it's not the current window.
7211 This is a hard minimum, windows will never become smaller.
7212 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7213 status bar) if necessary. They will return to at least one line when
7214 they become active (since the cursor has to have somewhere to go.)
7215 Use 'winheight' to set the minimal height of the current window.
7216 This option is only checked when making a window smaller. Don't use a
7217 large number, it will cause errors when opening more than a few
7218 windows. A value of 0 to 3 is reasonable.
7219
7220 *'winminwidth'* *'wmw'*
7221'winminwidth' 'wmw' number (default 1)
7222 global
7223 {not in Vi}
7224 {not available when compiled without the +vertsplit
7225 feature}
7226 The minimal width of a window, when it's not the current window.
7227 This is a hard minimum, windows will never become smaller.
7228 When set to zero, windows may be "squashed" to zero columns (i.e. just
7229 a vertical separator) if necessary. They will return to at least one
7230 line when they become active (since the cursor has to have somewhere
7231 to go.)
7232 Use 'winwidth' to set the minimal width of the current window.
7233 This option is only checked when making a window smaller. Don't use a
7234 large number, it will cause errors when opening more than a few
7235 windows. A value of 0 to 12 is reasonable.
7236
7237 *'winwidth'* *'wiw'* *E592*
7238'winwidth' 'wiw' number (default 20)
7239 global
7240 {not in Vi}
7241 {not available when compiled without the +vertsplit
7242 feature}
7243 Minimal number of columns for the current window. This is not a hard
7244 minimum, Vim will use fewer columns if there is not enough room. If
7245 the current window is smaller, its size is increased, at the cost of
7246 the width of other windows. Set it to 999 to make the current window
7247 always fill the screen. Set it to a small number for normal editing.
7248 The width is not adjusted after one of the commands to change the
7249 width of the current window.
7250 'winwidth' applies to the current window. Use 'winminwidth' to set
7251 the minimal width for other windows.
7252
7253 *'wrap'* *'nowrap'*
7254'wrap' boolean (default on)
7255 local to window
7256 {not in Vi}
7257 This option changes how text is displayed. It doesn't change the text
7258 in the buffer, see 'textwidth' for that.
7259 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007260 displaying continues on the next line. When off lines will not wrap
7261 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007262 moved to a part that is not shown, the screen will scroll
7263 horizontally.
7264 The line will be broken in the middle of a word if necessary. See
7265 'linebreak' to get the break at a word boundary.
7266 To make scrolling horizontally a bit more useful, try this: >
7267 :set sidescroll=5
7268 :set listchars+=precedes:<,extends:>
7269< See 'sidescroll', 'listchars' and |wrap-off|.
7270
7271 *'wrapmargin'* *'wm'*
7272'wrapmargin' 'wm' number (default 0)
7273 local to buffer
7274 Number of characters from the right window border where wrapping
7275 starts. When typing text beyond this limit, an <EOL> will be inserted
7276 and inserting continues on the next line.
7277 Options that add a margin, such as 'number' and 'foldcolumn', cause
7278 the text width to be further reduced. This is Vi compatible.
7279 When 'textwidth' is non-zero, this option is not used.
7280 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7281 and less usefully}
7282
7283 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7284'wrapscan' 'ws' boolean (default on) *E384* *E385*
7285 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007286 Searches wrap around the end of the file. Also applies to |]s| and
7287 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288
7289 *'write'* *'nowrite'*
7290'write' boolean (default on)
7291 global
7292 {not in Vi}
7293 Allows writing files. When not set, writing a file is not allowed.
7294 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007295 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 argument. Filtering text is still possible, even though this requires
7297 writing a temporary file.
7298
7299 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7300'writeany' 'wa' boolean (default off)
7301 global
7302 Allows writing to any file with no need for "!" override.
7303
7304 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7305'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7306 otherwise)
7307 global
7308 {not in Vi}
7309 Make a backup before overwriting a file. The backup is removed after
7310 the file was successfully written, unless the 'backup' option is
7311 also on. Reset this option if your file system is almost full. See
7312 |backup-table| for another explanation.
7313 When the 'backupskip' pattern matches, a backup is not made anyway.
7314 NOTE: This option is set to the default value when 'compatible' is
7315 set.
7316
7317 *'writedelay'* *'wd'*
7318'writedelay' 'wd' number (default 0)
7319 global
7320 {not in Vi}
7321 The number of microseconds to wait for each character sent to the
7322 screen. When non-zero, characters are sent to the terminal one by
7323 one. For MS-DOS pcterm this does not work. For debugging purposes.
7324
7325 vim:tw=78:ts=8:ft=help:norl: