blob: 20d0e9f169380499a603c519e9b3dadd00f0f578 [file] [log] [blame]
Bram Moolenaare344bea2005-09-01 20:46:49 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Sep 01
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
Bram Moolenaare344bea2005-09-01 20:46:49 +00001594 The function will be invoked with two arguments. First the function
1595 is called to find the start of the text to be completed. Secondly the
1596 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001597
Bram Moolenaare344bea2005-09-01 20:46:49 +00001598 On the first invocation the arguments are:
1599 a:findstart 1
1600 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001601
Bram Moolenaare344bea2005-09-01 20:46:49 +00001602 The function must return the column of where the completion starts.
1603 It must be a number between zero and the cursor column "col('.')".
1604 This involves looking at the characters just before the cursor and
1605 including those characters that could be part of the completed item.
1606 The text between this column and the cursor column will be replaced
1607 with the matches. Return -1 if no completion can be done.
1608
1609 On the second invocation the arguments are:
1610 a:findstart 0
1611 a:base the text with which matches should match, what was
1612 located in the first call
1613
1614 The function must return a List with the matching words. These
1615 matches usually include the "a:base" text. When there are no matches
1616 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001617
Bram Moolenaar572cb562005-08-05 21:35:02 +00001618 When searching for matches takes some time call |complete_add()| to
1619 add each match to the total list. These matches should then not
1620 appear in the returned list! Call |complete_check()| now and then to
1621 allow the user to press a key while still searching for matches. Stop
1622 searching when it returns non-zero.
1623
Bram Moolenaare344bea2005-09-01 20:46:49 +00001624 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001625 This option cannot be set from a |modeline| or in the |sandbox|, for
1626 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001627
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001628 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001629 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001630 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001631 " locate the start of the word
1632 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001633 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001634 while start > 0 && line[start - 1] =~ '\a'
1635 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001636 endwhile
1637 return start
1638 else
1639 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001640 let res = []
1641 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1642 if m =~ '^' . a:base
1643 call add(res, m)
1644 endif
1645 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001646 return res
1647 endif
1648 endfun
1649 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001650<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001651 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001652 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001653 if a:findstart
1654 " locate the start of the word
1655 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001656 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001657 while start > 0 && line[start - 1] =~ '\a'
1658 let start -= 1
1659 endwhile
1660 return start
1661 else
1662 " find months matching with "a:base"
1663 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1664 if m =~ '^' . a:base
1665 call complete_add(m)
1666 endif
1667 sleep 300m " simulate searching for next match
1668 if complete_check()
1669 break
1670 endif
1671 endfor
1672 return []
1673 endif
1674 endfun
1675 set completefunc=CompleteMonths
1676<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001677
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1679'confirm' 'cf' boolean (default off)
1680 global
1681 {not in Vi}
1682 When 'confirm' is on, certain operations that would normally
1683 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1684 instead raise a |dialog| asking if you wish to save the current
1685 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1686 If 'confirm' is off you can still activate confirmation for one
1687 command only (this is most useful in mappings) with the |:confirm|
1688 command.
1689 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1690
1691 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1692'conskey' 'consk' boolean (default off)
1693 global
1694 {not in Vi} {only for MS-DOS}
1695 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001696 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 three methods of console input are available:
1698 'conskey' 'bioskey' action ~
1699 on on or off direct console input
1700 off on BIOS
1701 off off STDIN
1702
1703 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1704'copyindent' 'ci' boolean (default off)
1705 local to buffer
1706 {not in Vi}
1707 Copy the structure of the existing lines indent when autoindenting a
1708 new line. Normally the new indent is reconstructed by a series of
1709 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1710 in which case only spaces are used). Enabling this option makes the
1711 new line copy whatever characters were used for indenting on the
1712 existing line. If the new indent is greater than on the existing
1713 line, the remaining space is filled in the normal manner.
1714 NOTE: 'copyindent' is reset when 'compatible' is set.
1715 Also see 'preserveindent'.
1716
1717 *'cpoptions'* *'cpo'*
1718'cpoptions' 'cpo' string (Vim default: "aABceFs",
1719 Vi default: all flags)
1720 global
1721 {not in Vi}
1722 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001723 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 not being vi-compatible is mostly or sometimes preferred.
1725 'cpoptions' stands for "compatible-options".
1726 Commas can be added for readability.
1727 To avoid problems with flags that are added in the future, use the
1728 "+=" and "-=" feature of ":set" |add-option-flags|.
1729 NOTE: This option is set to the Vi default value when 'compatible' is
1730 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001731 NOTE: This option is set to the POSIX default value at startup when
1732 the Vi default value would be used and the $VIM_POSIX environment
1733 variable exists |posix|. This means tries to behave like the POSIX
1734 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735
1736 contains behavior ~
1737 *cpo-a*
1738 a When included, a ":read" command with a file name
1739 argument will set the alternate file name for the
1740 current window.
1741 *cpo-A*
1742 A When included, a ":write" command with a file name
1743 argument will set the alternate file name for the
1744 current window.
1745 *cpo-b*
1746 b "\|" in a ":map" command is recognized as the end of
1747 the map command. The '\' is included in the mapping,
1748 the text after the '|' is interpreted as the next
1749 command. Use a CTRL-V instead of a backslash to
1750 include the '|' in the mapping. Applies to all
1751 mapping, abbreviation, menu and autocmd commands.
1752 See also |map_bar|.
1753 *cpo-B*
1754 B A backslash has no special meaning in mappings,
1755 abbreviations and the "to" part of the menu commands.
1756 Remove this flag to be able to use a backslash like a
1757 CTRL-V. For example, the command ":map X \<Esc>"
1758 results in X being mapped to:
1759 'B' included: "\^[" (^[ is a real <Esc>)
1760 'B' excluded: "<Esc>" (5 characters)
1761 ('<' excluded in both cases)
1762 *cpo-c*
1763 c Searching continues at the end of any match at the
1764 cursor position, but not further than the start of the
1765 next line. When not present searching continues
1766 one character from the cursor position. With 'c'
1767 "abababababab" only gets three matches when repeating
1768 "/abab", without 'c' there are five matches.
1769 *cpo-C*
1770 C Do not concatenate sourced lines that start with a
1771 backslash. See |line-continuation|.
1772 *cpo-d*
1773 d Using "./" in the 'tags' option doesn't mean to use
1774 the tags file relative to the current file, but the
1775 tags file in the current directory.
1776 *cpo-D*
1777 D Can't use CTRL-K to enter a digraph after Normal mode
1778 commands with a character argument, like |r|, |f| and
1779 |t|.
1780 *cpo-e*
1781 e When executing a register with ":@r", always add a
1782 <CR> to the last line, also when the register is not
1783 linewise. If this flag is not present, the register
1784 is not linewise and the last line does not end in a
1785 <CR>, then the last line is put on the command-line
1786 and can be edited before hitting <CR>.
1787 *cpo-E*
1788 E It is an error when using "y", "d", "c", "g~", "gu" or
1789 "gU" on an Empty region. The operators only work when
1790 at least one character is to be operate on. Example:
1791 This makes "y0" fail in the first column.
1792 *cpo-f*
1793 f When included, a ":read" command with a file name
1794 argument will set the file name for the current buffer,
1795 if the current buffer doesn't have a file name yet.
1796 *cpo-F*
1797 F When included, a ":write" command with a file name
1798 argument will set the file name for the current
1799 buffer, if the current buffer doesn't have a file name
1800 yet.
1801 *cpo-g*
1802 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001803 *cpo-H*
1804 H When using "I" on a line with only blanks, insert
1805 before the last blank. Without this flag insert after
1806 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 *cpo-i*
1808 i When included, interrupting the reading of a file will
1809 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001810 *cpo-I*
1811 I When moving the cursor up or down just after inserting
1812 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001813 *cpo-j*
1814 j When joining lines, only add two spaces after a '.',
1815 not after '!' or '?'. Also see 'joinspaces'.
1816 *cpo-J*
1817 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001818 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 white space.
1820 *cpo-k*
1821 k Disable the recognition of raw key codes in
1822 mappings, abbreviations, and the "to" part of menu
1823 commands. For example, if <Key> sends ^[OA (where ^[
1824 is <Esc>), the command ":map X ^[OA" results in X
1825 being mapped to:
1826 'k' included: "^[OA" (3 characters)
1827 'k' excluded: "<Key>" (one key code)
1828 Also see the '<' flag below.
1829 *cpo-K*
1830 K Don't wait for a key code to complete when it is
1831 halfway a mapping. This breaks mapping <F1><F1> when
1832 only part of the second <F1> has been read. It
1833 enables cancelling the mapping by typing <F1><Esc>.
1834 *cpo-l*
1835 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001836 literally, only "\]", "\^", "\-" and "\\" are special.
1837 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1839 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001840 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 *cpo-L*
1842 L When the 'list' option is set, 'wrapmargin',
1843 'textwidth', 'softtabstop' and Virtual Replace mode
1844 (see |gR|) count a <Tab> as two characters, instead of
1845 the normal behavior of a <Tab>.
1846 *cpo-m*
1847 m When included, a showmatch will always wait half a
1848 second. When not included, a showmatch will wait half
1849 a second or until a character is typed. |'showmatch'|
1850 *cpo-M*
1851 M When excluded, "%" matching will take backslashes into
1852 account. Thus in "( \( )" and "\( ( \)" the outer
1853 parenthesis match. When included "%" ignores
1854 backslashes, which is Vi compatible.
1855 *cpo-n*
1856 n When included, the column used for 'number' will also
1857 be used for text of wrapped lines.
1858 *cpo-o*
1859 o Line offset to search command is not remembered for
1860 next search.
1861 *cpo-O*
1862 O Don't complain if a file is being overwritten, even
1863 when it didn't exist when editing it. This is a
1864 protection against a file unexpectedly created by
1865 someone else. Vi didn't complain about this.
1866 *cpo-p*
1867 p Vi compatible Lisp indenting. When not present, a
1868 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001869 *cpo-q*
1870 q When joining multiple lines leave the cursor at the
1871 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *cpo-r*
1873 r Redo ("." command) uses "/" to repeat a search
1874 command, instead of the actually used search string.
1875 *cpo-R*
1876 R Remove marks from filtered lines. Without this flag
1877 marks are kept like |:keepmarks| was used.
1878 *cpo-s*
1879 s Set buffer options when entering the buffer for the
1880 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001881 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 set when the buffer is created.
1883 *cpo-S*
1884 S Set buffer options always when entering a buffer
1885 (except 'readonly', 'fileformat', 'filetype' and
1886 'syntax'). This is the (most) Vi compatible setting.
1887 The options are set to the values in the current
1888 buffer. When you change an option and go to another
1889 buffer, the value is copied. Effectively makes the
1890 buffer options global to all buffers.
1891
1892 's' 'S' copy buffer options
1893 no no when buffer created
1894 yes no when buffer first entered (default)
1895 X yes each time when buffer entered (vi comp.)
1896 *cpo-t*
1897 t Search pattern for the tag command is remembered for
1898 "n" command. Otherwise Vim only puts the pattern in
1899 the history for search pattern, but doesn't change the
1900 last used search pattern.
1901 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001902 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903 *cpo-v*
1904 v Backspaced characters remain visible on the screen in
1905 Insert mode. Without this flag the characters are
1906 erased from the screen right away. With this flag the
1907 screen newly typed text overwrites backspaced
1908 characters.
1909 *cpo-w*
1910 w When using "cw" on a blank character, only change one
1911 character and not all blanks until the start of the
1912 next word.
1913 *cpo-W*
1914 W Don't overwrite a readonly file. When omitted, ":w!"
1915 overwrites a readonly file, if possible.
1916 *cpo-x*
1917 x <Esc> on the command-line executes the command-line.
1918 The default in Vim is to abandon the command-line,
1919 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001920 *cpo-X*
1921 X When using a count with "R" the replaced text is
1922 deleted only once. Also when repeating "R" with "."
1923 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 *cpo-y*
1925 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001926 *cpo-Z*
1927 Z When using "w!" while the 'readonly' option is set,
1928 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001929 *cpo-!*
1930 ! When redoing a filter command, use the last used
1931 external command, whatever it was. Otherwise the last
1932 used -filter- command is used.
1933 *cpo-$*
1934 $ When making a change to one line, don't redisplay the
1935 line, but put a '$' at the end of the changed text.
1936 The changed text will be overwritten when you type the
1937 new text. The line is redisplayed if you type any
1938 command that moves the cursor from the insertion
1939 point.
1940 *cpo-%*
1941 % Vi-compatible matching is done for the "%" command.
1942 Does not recognize "#if", "#endif", etc.
1943 Does not recognize "/*" and "*/".
1944 Parens inside single and double quotes are also
1945 counted, causing a string that contains a paren to
1946 disturb the matching. For example, in a line like
1947 "if (strcmp("foo(", s))" the first paren does not
1948 match the last one. When this flag is not included,
1949 parens inside single and double quotes are treated
1950 specially. When matching a paren outside of quotes,
1951 everything inside quotes is ignored. When matching a
1952 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001953 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001954 This flag is also used for other features, such as
1955 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001956 *cpo--*
1957 - When included, a vertical movement command fails when
1958 it would above the first line or below the last line.
1959 Without it the cursor moves to the first or last line,
1960 unless it already was in that line.
1961 Applies to the commands "-", "k", CTRL-P, "+", "j",
1962 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001963 *cpo-+*
1964 + When included, a ":write file" command will reset the
1965 'modified' flag of the buffer, even though the buffer
1966 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001967 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 * Use ":*" in the same way as ":@". When not included,
1969 ":*" is an alias for ":'<,'>", select the Visual area.
1970 *cpo-<*
1971 < Disable the recognition of special key codes in |<>|
1972 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001973 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 ":map X <Tab>" results in X being mapped to:
1975 '<' included: "<Tab>" (5 characters)
1976 '<' excluded: "^I" (^I is a real <Tab>)
1977 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001978 *cpo->*
1979 > When appending to a register, put a line break before
1980 the appended text.
1981
1982 POSIX flags. These are not included in the Vi default value, except
1983 when $VIM_POSIX was set on startup. |posix|
1984
1985 contains behavior ~
1986 *cpo-#*
1987 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001988 *cpo-&*
1989 & When ":preserve" was used keep the swap file when
1990 exiting normally while this buffer is still loaded.
1991 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001992 *cpo-\*
1993 \ Backslash in a [] range in a search pattern is taken
1994 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001995 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1996 '\' excluded: "/[ \-]" finds <Space> and '-'
1997 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001998 *cpo-/*
1999 / When "%" is used as the replacement string in a |:s|
2000 command, use the previous replacement string. |:s%|
2001 *cpo-{*
2002 { The |{| and |}| commands also stop at a "{" character
2003 at the start of a line.
2004 *cpo-.*
2005 . The ":chdir" and ":cd" commands fail if the current
2006 buffer is modified, unless ! is used. Vim doesn't
2007 need this, since it remembers the full path of an
2008 opened file.
2009 *cpo-bar*
2010 | The value of the $LINES and $COLUMNS environment
2011 variables overrule the terminal size values obtained
2012 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002013
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014
2015 *'cscopepathcomp'* *'cspc'*
2016'cscopepathcomp' 'cspc' number (default 0)
2017 global
2018 {not available when compiled without the |+cscope|
2019 feature}
2020 {not in Vi}
2021 Determines how many components of the path to show in a list of tags.
2022 See |cscopepathcomp|.
2023
2024 *'cscopeprg'* *'csprg'*
2025'cscopeprg' 'csprg' string (default "cscope")
2026 global
2027 {not available when compiled without the |+cscope|
2028 feature}
2029 {not in Vi}
2030 Specifies the command to execute cscope. See |cscopeprg|.
2031 This option cannot be set from a |modeline| or in the |sandbox|, for
2032 security reasons.
2033
2034 *'cscopequickfix'* *'csqf'*
2035'cscopequickfix' 'csqf' string (default "")
2036 global
2037 {not available when compiled without the |+cscope|
2038 or |+quickfix| features}
2039 {not in Vi}
2040 Specifies whether to use quickfix window to show cscope results.
2041 See |cscopequickfix|.
2042
2043 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2044'cscopetag' 'cst' boolean (default off)
2045 global
2046 {not available when compiled without the |+cscope|
2047 feature}
2048 {not in Vi}
2049 Use cscope for tag commands. See |cscope-options|.
2050 NOTE: This option is reset when 'compatible' is set.
2051
2052 *'cscopetagorder'* *'csto'*
2053'cscopetagorder' 'csto' number (default 0)
2054 global
2055 {not available when compiled without the |+cscope|
2056 feature}
2057 {not in Vi}
2058 Determines the order in which ":cstag" performs a search. See
2059 |cscopetagorder|.
2060 NOTE: This option is set to 0 when 'compatible' is set.
2061
2062 *'cscopeverbose'* *'csverb'*
2063 *'nocscopeverbose'* *'nocsverb'*
2064'cscopeverbose' 'csverb' boolean (default off)
2065 global
2066 {not available when compiled without the |+cscope|
2067 feature}
2068 {not in Vi}
2069 Give messages when adding a cscope database. See |cscopeverbose|.
2070 NOTE: This option is reset when 'compatible' is set.
2071
2072 *'debug'*
2073'debug' string (default "")
2074 global
2075 {not in Vi}
2076 When set to "msg", error messages that would otherwise be omitted will
2077 be given anyway. This is useful when debugging 'foldexpr' or
2078 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002079 When set to "beep", a message will be given when otherwise only a beep
2080 would be produced.
2081 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082
2083 *'define'* *'def'*
2084'define' 'def' string (default "^\s*#\s*define")
2085 global or local to buffer |global-local|
2086 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002087 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 pattern, just like for the "/" command. This option is used for the
2089 commands like "[i" and "[d" |include-search|. The 'isident' option is
2090 used to recognize the defined name after the match:
2091 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2092 See |option-backslash| about inserting backslashes to include a space
2093 or backslash.
2094 The default value is for C programs. For C++ this value would be
2095 useful, to include const type declarations: >
2096 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2097< When using the ":set" command, you need to double the backslashes!
2098
2099 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2100'delcombine' 'deco' boolean (default off)
2101 global
2102 {not in Vi}
2103 {only available when compiled with the |+multi_byte|
2104 feature}
2105 If editing Unicode and this option is set, backspace and Normal mode
2106 "x" delete each combining character on its own. When it is off (the
2107 default) the character along with its combining characters are
2108 deleted.
2109 Note: When 'delcombine' is set "xx" may work different from "2x"!
2110
2111 This is useful for Arabic, Hebrew and many other languages where one
2112 may have combining characters overtop of base characters, and want
2113 to remove only the combining ones.
2114
2115 *'dictionary'* *'dict'*
2116'dictionary' 'dict' string (default "")
2117 global or local to buffer |global-local|
2118 {not in Vi}
2119 List of file names, separated by commas, that are used to lookup words
2120 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2121 contain a list of words. This can be one word per line, or several
2122 words per line, separated by non-keyword characters (white space is
2123 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002124 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125 after a comma are ignored, otherwise spaces are included in the file
2126 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002127 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 Where to find a list of words?
2129 - On FreeBSD, there is the file "/usr/share/dict/words".
2130 - In the Simtel archive, look in the "msdos/linguist" directory.
2131 - In "miscfiles" of the GNU collection.
2132 The use of |:set+=| and |:set-=| is preferred when adding or removing
2133 directories from the list. This avoids problems when a future version
2134 uses another default.
2135 Backticks cannot be used in this option for security reasons.
2136
2137 *'diff'* *'nodiff'*
2138'diff' boolean (default off)
2139 local to window
2140 {not in Vi}
2141 {not available when compiled without the |+diff|
2142 feature}
2143 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002144 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145
2146 *'dex'* *'diffexpr'*
2147'diffexpr' 'dex' string (default "")
2148 global
2149 {not in Vi}
2150 {not available when compiled without the |+diff|
2151 feature}
2152 Expression which is evaluated to obtain an ed-style diff file from two
2153 versions of a file. See |diff-diffexpr|.
2154 This option cannot be set from a |modeline| or in the |sandbox|, for
2155 security reasons.
2156
2157 *'dip'* *'diffopt'*
2158'diffopt' 'dip' string (default "filler")
2159 global
2160 {not in Vi}
2161 {not available when compiled without the |+diff|
2162 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002163 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002164 All are optional. Items must be separated by a comma.
2165
2166 filler Show filler lines, to keep the text
2167 synchronized with a window that has inserted
2168 lines at the same position. Mostly useful
2169 when windows are side-by-side and 'scrollbind'
2170 is set.
2171
2172 context:{n} Use a context of {n} lines between a change
2173 and a fold that contains unchanged lines.
2174 When omitted a context of six lines is used.
2175 See |fold-diff|.
2176
2177 icase Ignore changes in case of text. "a" and "A"
2178 are considered the same. Adds the "-i" flag
2179 to the "diff" command if 'diffexpr' is empty.
2180
2181 iwhite Ignore changes in amount of white space. Adds
2182 the "-b" flag to the "diff" command if
2183 'diffexpr' is empty. Check the documentation
2184 of the "diff" command for what this does
2185 exactly. It should ignore adding trailing
2186 white space, but not leading white space.
2187
2188 Examples: >
2189
2190 :set diffopt=filler,context:4
2191 :set diffopt=
2192 :set diffopt=filler
2193<
2194 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2195'digraph' 'dg' boolean (default off)
2196 global
2197 {not in Vi}
2198 {not available when compiled without the |+digraphs|
2199 feature}
2200 Enable the entering of digraphs in Insert mode with {char1} <BS>
2201 {char2}. See |digraphs|.
2202 NOTE: This option is reset when 'compatible' is set.
2203
2204 *'directory'* *'dir'*
2205'directory' 'dir' string (default for Amiga: ".,t:",
2206 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2207 for Unix: ".,~/tmp,/var/tmp,/tmp")
2208 global
2209 List of directory names for the swap file, separated with commas.
2210 - The swap file will be created in the first directory where this is
2211 possible.
2212 - Empty means that no swap file will be used (recovery is
2213 impossible!).
2214 - A directory "." means to put the swap file in the same directory as
2215 the edited file. On Unix, a dot is prepended to the file name, so
2216 it doesn't show in a directory listing. On MS-Windows the "hidden"
2217 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002218 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 put the swap file relative to where the edited file is. The leading
2220 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002221 - For Unix and Win32, if a directory ends in two path separators "//"
2222 or "\\", the swap file name will be built from the complete path to
2223 the file with all path separators substituted to percent '%' signs.
2224 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002225 - Spaces after the comma are ignored, other spaces are considered part
2226 of the directory name. To have a space at the start of a directory
2227 name, precede it with a backslash.
2228 - To include a comma in a directory name precede it with a backslash.
2229 - A directory name may end in an ':' or '/'.
2230 - Environment variables are expanded |:set_env|.
2231 - Careful with '\' characters, type one before a space, type two to
2232 get one in the option (see |option-backslash|), for example: >
2233 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2234< - For backwards compatibility with Vim version 3.0 a '>' at the start
2235 of the option is removed.
2236 Using "." first in the list is recommended. This means that editing
2237 the same file twice will result in a warning. Using "/tmp" on Unix is
2238 discouraged: When the system crashes you lose the swap file.
2239 "/var/tmp" is often not cleared when rebooting, thus is a better
2240 choice than "/tmp". But it can contain a lot of files, your swap
2241 files get lost in the crowd. That is why a "tmp" directory in your
2242 home directory is tried first.
2243 The use of |:set+=| and |:set-=| is preferred when adding or removing
2244 directories from the list. This avoids problems when a future version
2245 uses another default.
2246 This option cannot be set from a |modeline| or in the |sandbox|, for
2247 security reasons.
2248 {Vi: directory to put temp file in, defaults to "/tmp"}
2249
2250 *'display'* *'dy'*
2251'display' 'dy' string (default "")
2252 global
2253 {not in Vi}
2254 Change the way text is displayed. This is comma separated list of
2255 flags:
2256 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002257 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 last line that doesn't fit is replaced with "@" lines.
2259 uhex Show unprintable characters hexadecimal as <xx>
2260 instead of using ^C and ~C.
2261
2262 *'eadirection'* *'ead'*
2263'eadirection' 'ead' string (default "both")
2264 global
2265 {not in Vi}
2266 {not available when compiled without the +vertsplit
2267 feature}
2268 Tells when the 'equalalways' option applies:
2269 ver vertically, width of windows is not affected
2270 hor horizontally, height of windows is not affected
2271 both width and height of windows is affected
2272
2273 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2274'edcompatible' 'ed' boolean (default off)
2275 global
2276 Makes the 'g' and 'c' flags of the ":substitute" command to be
2277 toggled each time the flag is given. See |complex-change|. See
2278 also 'gdefault' option.
2279 Switching this option on is discouraged!
2280
2281 *'encoding'* *'enc'* *E543*
2282'encoding' 'enc' string (default: "latin1" or value from $LANG)
2283 global
2284 {only available when compiled with the |+multi_byte|
2285 feature}
2286 {not in Vi}
2287 Sets the character encoding used inside Vim. It applies to text in
2288 the buffers, registers, Strings in expressions, text stored in the
2289 viminfo file, etc. It sets the kind of characters which Vim can work
2290 with. See |encoding-names| for the possible values.
2291
2292 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002293 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 It should normally be kept at its default value, or set when Vim
2295 starts up. See |multibyte|.
2296
2297 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2298 "utf-8". Although care has been taken to allow different values of
2299 'encoding', "utf-8" is the natural choice for the environment and
2300 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002301 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 versions, and to avoid changing the encoding of newly created files
2303 without your knowledge (in case 'fileencodings' is empty).
2304
2305 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002306 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002307 iconv() or as specified with 'charconvert'.
2308
2309 Normally 'encoding' will be equal to your current locale. This will
2310 be the default if Vim recognizes your environment settings. If
2311 'encoding' is not set to the current locale, 'termencoding' must be
2312 set to convert typed and displayed text. See |encoding-table|.
2313
2314 When you set this option, it fires the |EncodingChanged| autocommand
2315 event so that you can set up fonts if necessary.
2316
2317 When the option is set, the value is converted to lowercase. Thus
2318 you can set it with uppercase values too. Underscores are translated
2319 to '-' signs.
2320 When the encoding is recognized, it is changed to the standard name.
2321 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2322 "iso-8859-2" and "utf8" becomes "utf-8".
2323
2324 Note: "latin1" is also used when the encoding could not be detected.
2325 This only works when editing files in the same encoding! When the
2326 actual character set is not latin1, make sure 'fileencoding' and
2327 'fileencodings' are empty. When conversion is needed, switch to using
2328 utf-8.
2329
2330 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2331 You don't notice this while editing, but it does matter for the
2332 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2333 setting 'encoding' to one of these values instead of utf-8 only has
2334 effect for encoding used for files when 'fileencoding' is empty.
2335
Bram Moolenaar661b1822005-07-28 22:36:45 +00002336 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2337 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338
2339 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2340'endofline' 'eol' boolean (default on)
2341 local to buffer
2342 {not in Vi}
2343 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002344 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 option is automatically set when starting to edit a new file, unless
2346 the file does not have an <EOL> for the last line in the file, in
2347 which case it is reset. Normally you don't have to set or reset this
2348 option. When 'binary' is off the value is not used when writing the
2349 file. When 'binary' is on it is used to remember the presence of a
2350 <EOL> for the last line in the file, so that when you write the file
2351 the situation from the original file can be kept. But you can change
2352 it if you want to.
2353
2354 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2355'equalalways' 'ea' boolean (default on)
2356 global
2357 {not in Vi}
2358 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002359 splitting or closing a window. This also happens the moment the
2360 option is switched on. When off, splitting a window will reduce the
2361 size of the current window and leave the other windows the same. When
2362 closing a window the extra lines are given to the window next to it
2363 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 When mixing vertically and horizontally split windows, a minimal size
2365 is computed and some windows may be larger if there is room. The
2366 'eadirection' option tells in which direction the size is affected.
2367 Changing the height of a window can be avoided by setting
2368 'winfixheight'.
2369
2370 *'equalprg'* *'ep'*
2371'equalprg' 'ep' string (default "")
2372 global or local to buffer |global-local|
2373 {not in Vi}
2374 External program to use for "=" command. When this option is empty
2375 the internal formatting functions are used ('lisp', 'cindent' or
2376 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002377 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 about including spaces and backslashes.
2379 This option cannot be set from a |modeline| or in the |sandbox|, for
2380 security reasons.
2381
2382 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2383'errorbells' 'eb' boolean (default off)
2384 global
2385 Ring the bell (beep or screen flash) for error messages. This only
2386 makes a difference for error messages, the bell will be used always
2387 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002388 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 screen flash or do nothing.
2390
2391 *'errorfile'* *'ef'*
2392'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2393 others: "errors.err")
2394 global
2395 {not in Vi}
2396 {not available when compiled without the |+quickfix|
2397 feature}
2398 Name of the errorfile for the QuickFix mode (see |:cf|).
2399 When the "-q" command-line argument is used, 'errorfile' is set to the
2400 following argument. See |-q|.
2401 NOT used for the ":make" command. See 'makeef' for that.
2402 Environment variables are expanded |:set_env|.
2403 See |option-backslash| about including spaces and backslashes.
2404 This option cannot be set from a |modeline| or in the |sandbox|, for
2405 security reasons.
2406
2407 *'errorformat'* *'efm'*
2408'errorformat' 'efm' string (default is very long)
2409 global or local to buffer |global-local|
2410 {not in Vi}
2411 {not available when compiled without the |+quickfix|
2412 feature}
2413 Scanf-like description of the format for the lines in the error file
2414 (see |errorformat|).
2415
2416 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2417'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2418 global
2419 {not in Vi}
2420 Function keys that start with an <Esc> are recognized in Insert
2421 mode. When this option is off, the cursor and function keys cannot be
2422 used in Insert mode if they start with an <Esc>. The advantage of
2423 this is that the single <Esc> is recognized immediately, instead of
2424 after one second. Instead of resetting this option, you might want to
2425 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2426 when 'esckeys' is off, you can still map anything, but the cursor keys
2427 won't work by default.
2428 NOTE: This option is set to the Vi default value when 'compatible' is
2429 set and to the Vim default value when 'compatible' is reset.
2430
2431 *'eventignore'* *'ei'*
2432'eventignore' 'ei' string (default "")
2433 global
2434 {not in Vi}
2435 {not available when compiled without the |+autocmd|
2436 feature}
2437 A list of autocommand event names, which are to be ignored.
2438 When set to "all", all autocommand events are ignored, autocommands
2439 will not be executed.
2440 Otherwise this is a comma separated list of event names. Example: >
2441 :set ei=WinEnter,WinLeave
2442<
2443 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2444'expandtab' 'et' boolean (default off)
2445 local to buffer
2446 {not in Vi}
2447 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002448 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2450 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2451 NOTE: This option is reset when 'compatible' is set.
2452
2453 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2454'exrc' 'ex' boolean (default off)
2455 global
2456 {not in Vi}
2457 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2458 directory. If you switch this option on you should also consider
2459 setting the 'secure' option (see |initialization|). Using a local
2460 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2461 also see |.vimrc| and |gui-init|.
2462 This option cannot be set from a |modeline| or in the |sandbox|, for
2463 security reasons.
2464
2465 *'fileencoding'* *'fenc'* *E213*
2466'fileencoding' 'fenc' string (default: "")
2467 local to buffer
2468 {only available when compiled with the |+multi_byte|
2469 feature}
2470 {not in Vi}
2471 Sets the character encoding for the file of this buffer.
2472 When 'fileencoding' is different from 'encoding', conversion will be
2473 done when reading and writing the file.
2474 When 'fileencoding' is empty, the same value as 'encoding' will be
2475 used (no conversion when reading or writing a file).
2476 WARNING: Conversion can cause loss of information! When
2477 'encoding' is "utf-8" conversion is most likely done in a way
2478 that the reverse conversion results in the same text. When
2479 'encoding' is not "utf-8" some characters may be lost!
2480 See 'encoding' for the possible values. Additionally, values may be
2481 specified that can be handled by the converter, see
2482 |mbyte-conversion|.
2483 When reading a file 'fileencoding' will be set from 'fileencodings'.
2484 To read a file in a certain encoding it won't work by setting
2485 'fileencoding', use the |++enc| argument.
2486 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2487 When the option is set, the value is converted to lowercase. Thus
2488 you can set it with uppercase values too. '_' characters are
2489 replaced with '-'. If a name is recognized from the list for
2490 'encoding', it is replaced by the standard name. For example
2491 "ISO8859-2" becomes "iso-8859-2".
2492 When this option is set, after starting to edit a file, the 'modified'
2493 option is set, because the file would be different when written.
2494 If you do this in a modeline, you might want to set 'nomodified' to
2495 avoid this.
2496 This option can not be changed when 'modifiable' is off.
2497
2498 *'fe'*
2499 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002500 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 old short name was 'fe', which is no longer used.
2502
2503 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002504'fileencodings' 'fencs' string (default: "ucs-bom",
2505 "ucs-bom,utf-8,default,latin1" when
2506 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 global
2508 {only available when compiled with the |+multi_byte|
2509 feature}
2510 {not in Vi}
2511 This is a list of character encodings considered when starting to edit
2512 an existing file. When a file is read, Vim tries to use the first
2513 mentioned character encoding. If an error is detected, the next one
2514 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002515 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 an empty string, which means the value of 'encoding' is used.
2517 WARNING: Conversion can cause loss of information! When
2518 'encoding' is "utf-8" (or one of the other Unicode variants)
2519 conversion is most likely done in a way that the reverse
2520 conversion results in the same text. When 'encoding' is not
2521 "utf-8" special characters may be lost!
2522 For an empty file or a file with only ASCII characters most encodings
2523 will work and the first entry of 'fileencodings' will be used (except
2524 "ucs-bom", which requires the BOM to be present). If you prefer
2525 another encoding use an BufReadPost autocommand event to test if your
2526 preferred encoding is to be used. Example: >
2527 au BufReadPost * if search('\S', 'w') == 0 |
2528 \ set fenc=iso-2022-jp | endif
2529< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2530 non-blank characters.
2531 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2532 is always empty then. This means that a non-existing file may get a
2533 different encoding than an empty file.
2534 The special value "ucs-bom" can be used to check for a Unicode BOM
2535 (Byte Order Mark) at the start of the file. It must not be preceded
2536 by "utf-8" or another Unicode encoding for this to work properly.
2537 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2538 because Vim cannot detect an error, thus the encoding is always
2539 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002540 The special value "default" can be used for the encoding from the
2541 environment. This is the default value for 'encoding'. It is useful
2542 when 'encoding' is set to "utf-8" and your environment uses a
2543 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 WRONG VALUES: WHAT'S WRONG:
2545 latin1,utf-8 "latin1" will always be used
2546 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2547 file
2548 cp1250,latin1 "cp1250" will always be used
2549 If 'fileencodings' is empty, 'fileencoding' is not modified.
2550 See 'fileencoding' for the possible values.
2551 Setting this option does not have an effect until the next time a file
2552 is read.
2553
2554 *'fileformat'* *'ff'*
2555'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2556 Unix default: "unix",
2557 Macintosh default: "mac")
2558 local to buffer
2559 {not in Vi}
2560 This gives the <EOL> of the current buffer, which is used for
2561 reading/writing the buffer from/to a file:
2562 dos <CR> <NL>
2563 unix <NL>
2564 mac <CR>
2565 When "dos" is used, CTRL-Z at the end of a file is ignored.
2566 See |file-formats| and |file-read|.
2567 For the character encoding of the file see 'fileencoding'.
2568 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2569 works like it was set to "unix'.
2570 This option is set automatically when starting to edit a file and
2571 'fileformats' is not empty and 'binary' is off.
2572 When this option is set, after starting to edit a file, the 'modified'
2573 option is set, because the file would be different when written.
2574 This option can not be changed when 'modifiable' is off.
2575 For backwards compatibility: When this option is set to "dos",
2576 'textmode' is set, otherwise 'textmode' is reset.
2577
2578 *'fileformats'* *'ffs'*
2579'fileformats' 'ffs' string (default:
2580 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2581 Vim Unix: "unix,dos",
2582 Vim Mac: "mac,unix,dos",
2583 Vi Cygwin: "unix,dos",
2584 Vi others: "")
2585 global
2586 {not in Vi}
2587 This gives the end-of-line (<EOL>) formats that will be tried when
2588 starting to edit a new buffer and when reading a file into an existing
2589 buffer:
2590 - When empty, the format defined with 'fileformat' will be used
2591 always. It is not set automatically.
2592 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002593 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 'fileformats' name will be used when a file is read into an existing
2595 buffer, no matter what 'fileformat' for that buffer is set to.
2596 - When more than one name is present, separated by commas, automatic
2597 <EOL> detection will be done when reading a file. When starting to
2598 edit a file, a check is done for the <EOL>:
2599 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2600 'fileformat' is set to "dos".
2601 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002602 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 preceding <CR>, "unix" is preferred over "dos".
2604 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2605 This means that "mac" is only chosen when "unix" is not present,
2606 or when no <NL> is found in the file, and when "dos" is not
2607 present, or no <CR><NL> is present in the file.
2608 Also if "unix" was first chosen, but the first <CR> is before
2609 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2610 the file, then 'fileformat' is set to "mac".
2611 4. If 'fileformat' is still not set, the first name from
2612 'fileformats' is used.
2613 When reading a file into an existing buffer, the same is done, but
2614 this happens like 'fileformat' has been set appropriately for that
2615 file only, the option is not changed.
2616 When 'binary' is set, the value of 'fileformats' is not used.
2617
2618 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2619 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2620 done:
2621 - When 'fileformats' is empty, there is no automatic detection. Dos
2622 format will be used.
2623 - When 'fileformats' is set to one or more names, automatic detection
2624 is done. This is based on the first <NL> in the file: If there is a
2625 <CR> in front of it, Dos format is used, otherwise Unix format is
2626 used.
2627 Also see |file-formats|.
2628 For backwards compatibility: When this option is set to an empty
2629 string or one format (no comma is included), 'textauto' is reset,
2630 otherwise 'textauto' is set.
2631 NOTE: This option is set to the Vi default value when 'compatible' is
2632 set and to the Vim default value when 'compatible' is reset.
2633
2634 *'filetype'* *'ft'*
2635'filetype' 'ft' string (default: "")
2636 local to buffer
2637 {not in Vi}
2638 {not available when compiled without the |+autocmd|
2639 feature}
2640 When this option is set, the FileType autocommand event is triggered.
2641 All autocommands that match with the value of this option will be
2642 executed. Thus the value of 'filetype' is used in place of the file
2643 name.
2644 Otherwise this option does not always reflect the current file type.
2645 This option is normally set when the file type is detected. To enable
2646 this use the ":filetype on" command. |:filetype|
2647 Setting this option to a different value is most useful in a modeline,
2648 for a file for which the file type is not automatically recognized.
2649 Example, for in an IDL file: >
2650 /* vim: set filetype=idl : */
2651< |FileType| |filetypes|
2652 Do not confuse this option with 'osfiletype', which is for the file
2653 type that is actually stored with the file.
2654 This option is not copied to another buffer, independent of the 's' or
2655 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002656 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657
2658 *'fillchars'* *'fcs'*
2659'fillchars' 'fcs' string (default "vert:|,fold:-")
2660 global
2661 {not in Vi}
2662 {not available when compiled without the |+windows|
2663 and |+folding| features}
2664 Characters to fill the statuslines and vertical separators.
2665 It is a comma separated list of items:
2666
2667 item default Used for ~
2668 stl:c ' ' or '^' statusline of the current window
2669 stlnc:c ' ' or '-' statusline of the non-current windows
2670 vert:c '|' vertical separators |:vsplit|
2671 fold:c '-' filling 'foldtext'
2672 diff:c '-' deleted lines of the 'diff' option
2673
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002674 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 "stlnc" the space will be used when there is highlighting, '^' or '-'
2676 otherwise.
2677
2678 Example: >
2679 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2680< This is similar to the default, except that these characters will also
2681 be used when there is highlighting.
2682
2683 The highlighting used for these items:
2684 item highlight group ~
2685 stl:c StatusLine |hl-StatusLine|
2686 stlnc:c StatusLineNC |hl-StatusLineNC|
2687 vert:c VertSplit |hl-VertSplit|
2688 fold:c Folded |hl-Folded|
2689 diff:c DiffDelete |hl-DiffDelete|
2690
2691 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2692'fkmap' 'fk' boolean (default off) *E198*
2693 global
2694 {not in Vi}
2695 {only available when compiled with the |+rightleft|
2696 feature}
2697 When on, the keyboard is mapped for the Farsi character set.
2698 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002699 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700
2701 *'foldclose'* *'fcl'*
2702'foldclose' 'fcl' string (default "")
2703 global
2704 {not in Vi}
2705 {not available when compiled without the |+folding|
2706 feature}
2707 When set to "all", a fold is closed when the cursor isn't in it and
2708 its level is higher than 'foldlevel'. Useful if you want folds to
2709 automatically close when moving out of them.
2710
2711 *'foldcolumn'* *'fdc'*
2712'foldcolumn' 'fdc' number (default 0)
2713 local to window
2714 {not in Vi}
2715 {not available when compiled without the |+folding|
2716 feature}
2717 When non-zero, a column with the specified width is shown at the side
2718 of the window which indicates open and closed folds. The maximum
2719 value is 12.
2720 See |folding|.
2721
2722 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2723'foldenable' 'fen' boolean (default on)
2724 local to window
2725 {not in Vi}
2726 {not available when compiled without the |+folding|
2727 feature}
2728 When off, all folds are open. This option can be used to quickly
2729 switch between showing all text unfolded and viewing the text with
2730 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002731 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 'foldenable' is off.
2733 This option is set by commands that create a new fold or close a fold.
2734 See |folding|.
2735
2736 *'foldexpr'* *'fde'*
2737'foldexpr' 'fde' string (default: "0")
2738 local to window
2739 {not in Vi}
2740 {not available when compiled without the |+folding|
2741 or |+eval| feature}
2742 The expression used for when 'foldmethod' is "expr". It is evaluated
2743 for each line to obtain its fold level. See |fold-expr|. Also see
2744 |eval-sandbox|.
2745
2746 *'foldignore'* *'fdi'*
2747'foldignore' 'fdi' string (default: "#")
2748 local to window
2749 {not in Vi}
2750 {not available when compiled without the |+folding|
2751 feature}
2752 Used only when 'foldmethod' is "indent". Lines starting with
2753 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002754 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 The default "#" works well for C programs. See |fold-indent|.
2756
2757 *'foldlevel'* *'fdl'*
2758'foldlevel' 'fdl' number (default: 0)
2759 local to window
2760 {not in Vi}
2761 {not available when compiled without the |+folding|
2762 feature}
2763 Sets the fold level: Folds with a higher level will be closed.
2764 Setting this option to zero will close all folds. Higher numbers will
2765 close fewer folds.
2766 This option is set by commands like |zm|, |zM| and |zR|.
2767 See |fold-foldlevel|.
2768
2769 *'foldlevelstart'* *'fdls'*
2770'foldlevelstart' 'fdls' number (default: -1)
2771 global
2772 {not in Vi}
2773 {not available when compiled without the |+folding|
2774 feature}
2775 Sets 'foldlevel' when starting to edit another buffer in a window.
2776 Useful to always start editing with all folds closed (value zero),
2777 some folds closed (one) or no folds closed (99).
2778 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 ignores this option and closes all folds.
2781 It is also done before BufReadPre autocommands, to allow an autocmd to
2782 overrule the 'foldlevel' value for specific files.
2783 When the value is negative, it is not used.
2784
2785 *'foldmarker'* *'fmr'* *E536*
2786'foldmarker' 'fmr' string (default: "{{{,}}}")
2787 local to window
2788 {not in Vi}
2789 {not available when compiled without the |+folding|
2790 feature}
2791 The start and end marker used when 'foldmethod' is "marker". There
2792 must be one comma, which separates the start and end marker. The
2793 marker is a literal string (a regular expression would be too slow).
2794 See |fold-marker|.
2795
2796 *'foldmethod'* *'fdm'*
2797'foldmethod' 'fdm' string (default: "manual")
2798 local to window
2799 {not in Vi}
2800 {not available when compiled without the |+folding|
2801 feature}
2802 The kind of folding used for the current window. Possible values:
2803 |fold-manual| manual Folds are created manually.
2804 |fold-indent| indent Lines with equal indent form a fold.
2805 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2806 |fold-marker| marker Markers are used to specify folds.
2807 |fold-syntax| syntax Syntax highlighting items specify folds.
2808 |fold-diff| diff Fold text that is not changed.
2809
2810 *'foldminlines'* *'fml'*
2811'foldminlines' 'fml' number (default: 1)
2812 local to window
2813 {not in Vi}
2814 {not available when compiled without the |+folding|
2815 feature}
2816 Sets the minimum number of screen lines for a fold to be displayed
2817 closed. Also for manually closed folds.
2818 Note that this only has an effect of what is displayed. After using
2819 "zc" to close a fold, which is displayed open because it's smaller
2820 than 'foldminlines', a following "zc" may close a containing fold.
2821
2822 *'foldnestmax'* *'fdn'*
2823'foldnestmax' 'fdn' number (default: 20)
2824 local to window
2825 {not in Vi}
2826 {not available when compiled without the |+folding|
2827 feature}
2828 Sets the maximum nesting of folds for the "indent" and "syntax"
2829 methods. This avoids that too many folds will be created. Using more
2830 than 20 doesn't work, because the internal limit is 20.
2831
2832 *'foldopen'* *'fdo'*
2833'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2834 search,tag,undo")
2835 global
2836 {not in Vi}
2837 {not available when compiled without the |+folding|
2838 feature}
2839 Specifies for which type of commands folds will be opened, if the
2840 command moves the cursor into a closed fold. It is a comma separated
2841 list of items.
2842 item commands ~
2843 all any
2844 block "(", "{", "[[", "[{", etc.
2845 hor horizontal movements: "l", "w", "fx", etc.
2846 insert any command in Insert mode
2847 jump far jumps: "G", "gg", etc.
2848 mark jumping to a mark: "'m", CTRL-O, etc.
2849 percent "%"
2850 quickfix ":cn", ":crew", ":make", etc.
2851 search search for a pattern: "/", "n", "*", "gd", etc.
2852 (not for a search pattern in a ":" command)
2853 tag jumping to a tag: ":ta", CTRL-T, etc.
2854 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002855 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 the |zv| command to the mapping to get the same effect.
2857 When a movement command is used for an operator (e.g., "dl" or "y%")
2858 this option is not used. This means the operator will include the
2859 whole closed fold.
2860 Note that vertical movements are not here, because it would make it
2861 very difficult to move onto a closed fold.
2862 In insert mode the folds containing the cursor will always be open
2863 when text is inserted.
2864 To close folds you can re-apply 'foldlevel' with the |zx| command or
2865 set the 'foldclose' option to "all".
2866
2867 *'foldtext'* *'fdt'*
2868'foldtext' 'fdt' string (default: "foldtext()")
2869 local to window
2870 {not in Vi}
2871 {not available when compiled without the |+folding|
2872 feature}
2873 An expression which is used to specify the text displayed for a closed
2874 fold. See |fold-foldtext|.
2875
2876 *'formatoptions'* *'fo'*
2877'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2878 local to buffer
2879 {not in Vi}
2880 This is a sequence of letters which describes how automatic
2881 formatting is to be done. See |fo-table|. When the 'paste' option is
2882 on, no formatting is done (like 'formatoptions' is empty). Commas can
2883 be inserted for readability.
2884 To avoid problems with flags that are added in the future, use the
2885 "+=" and "-=" feature of ":set" |add-option-flags|.
2886 NOTE: This option is set to the Vi default value when 'compatible' is
2887 set and to the Vim default value when 'compatible' is reset.
2888
Bram Moolenaar86b68352004-12-27 21:59:20 +00002889 *'formatlistpat'* *'flp'*
2890'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2891 local to buffer
2892 {not in Vi}
2893 A pattern that is used to recognize a list header. This is used for
2894 the "n" flag in 'formatoptions'.
2895 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002896 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002897 while still checking more characters. There must be a character
2898 following the pattern, when it matches the whole line it is handled
2899 like there is no match.
2900 The default recognizes a number, followed by an optional punctuation
2901 character and white space.
2902
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 *'formatprg'* *'fp'*
2904'formatprg' 'fp' string (default "")
2905 global
2906 {not in Vi}
2907 The name of an external program that will be used to format the lines
2908 selected with the "gq" command. The program must take the input on
2909 stdin and produce the output on stdout. The Unix program "fmt" is
2910 such a program. If this option is an empty string, the internal
2911 format function will be used |C-indenting|. Environment variables are
2912 expanded |:set_env|. See |option-backslash| about including spaces
2913 and backslashes.
2914 This option cannot be set from a |modeline| or in the |sandbox|, for
2915 security reasons.
2916
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002917 *'fsync'* *'fs'*
2918'fsync' 'fs' boolean (default on)
2919 global
2920 {not in Vi}
2921 When on, the library function fsync() will be called after writing a
2922 file. This will flush a file to disk, ensuring that it is safely
2923 written even on filesystems which do metadata-only journaling. This
2924 will force the harddrive to spin up on Linux systems running in laptop
2925 mode, so it may be undesirable in some situations. Be warned that
2926 turning this off increases the chances of data loss after a crash. On
2927 systems without an fsync() implementation, this variable is always
2928 off.
2929 Also see 'swapsync' for controlling fsync() on swap files.
2930
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2932'gdefault' 'gd' boolean (default off)
2933 global
2934 {not in Vi}
2935 When on, the ":substitute" flag 'g' is default on. This means that
2936 all matches in a line are substituted instead of one. When a 'g' flag
2937 is given to a ":substitute" command, this will toggle the substitution
2938 of all or one match. See |complex-change|.
2939
2940 command 'gdefault' on 'gdefault' off ~
2941 :s/// subst. all subst. one
2942 :s///g subst. one subst. all
2943 :s///gg subst. all subst. one
2944
2945 NOTE: This option is reset when 'compatible' is set.
2946
2947 *'grepformat'* *'gfm'*
2948'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2949 global
2950 {not in Vi}
2951 Format to recognize for the ":grep" command output.
2952 This is a scanf-like string that uses the same format as the
2953 'errorformat' option: see |errorformat|.
2954
2955 *'grepprg'* *'gp'*
2956'grepprg' 'gp' string (default "grep -n ",
2957 Unix: "grep -n $* /dev/null",
2958 Win32: "findstr /n" or "grep -n",
2959 VMS: "SEARCH/NUMBERS ")
2960 global or local to buffer |global-local|
2961 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002962 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 and '#' characters, which are expanded like when used in a command-
2964 line. The placeholder "$*" is allowed to specify where the arguments
2965 will be included. Environment variables are expanded |:set_env|. See
2966 |option-backslash| about including spaces and backslashes.
2967 When your "grep" accepts the "-H" argument, use this to make ":grep"
2968 also work well with a single file: >
2969 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002970< Special value: When 'grepprg' is set to "internal" the |:grep| command
2971 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002972 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973 apply equally to 'grepprg'.
2974 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2975 otherwise it's "grep -n".
2976 This option cannot be set from a |modeline| or in the |sandbox|, for
2977 security reasons.
2978
2979 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2980'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2981 ve:ver35-Cursor,
2982 o:hor50-Cursor,
2983 i-ci:ver25-Cursor/lCursor,
2984 r-cr:hor20-Cursor/lCursor,
2985 sm:block-Cursor
2986 -blinkwait175-blinkoff150-blinkon175",
2987 for MS-DOS and Win32 console:
2988 "n-v-c:block,o:hor50,i-ci:hor15,
2989 r-cr:hor30,sm:block")
2990 global
2991 {not in Vi}
2992 {only available when compiled with GUI enabled, and
2993 for MS-DOS and Win32 console}
2994 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002995 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 the height of the cursor can be changed. This can be done by
2997 specifying a block cursor, or a percentage for a vertical or
2998 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002999 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003001 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 mode-list and an argument-list:
3003 mode-list:argument-list,mode-list:argument-list,..
3004 The mode-list is a dash separated list of these modes:
3005 n Normal mode
3006 v Visual mode
3007 ve Visual mode with 'selection' "exclusive" (same as 'v',
3008 if not specified)
3009 o Operator-pending mode
3010 i Insert mode
3011 r Replace mode
3012 c Command-line Normal (append) mode
3013 ci Command-line Insert mode
3014 cr Command-line Replace mode
3015 sm showmatch in Insert mode
3016 a all modes
3017 The argument-list is a dash separated list of these arguments:
3018 hor{N} horizontal bar, {N} percent of the character height
3019 ver{N} vertical bar, {N} percent of the character width
3020 block block cursor, fills the whole character
3021 [only one of the above three should be present]
3022 blinkwait{N} *cursor-blinking*
3023 blinkon{N}
3024 blinkoff{N}
3025 blink times for cursor: blinkwait is the delay before
3026 the cursor starts blinking, blinkon is the time that
3027 the cursor is shown and blinkoff is the time that the
3028 cursor is not shown. The times are in msec. When one
3029 of the numbers is zero, there is no blinking. The
3030 default is: "blinkwait700-blinkon400-blinkoff250".
3031 These numbers are used for a missing entry. This
3032 means that blinking is enabled by default. To switch
3033 blinking off you can use "blinkon0". The cursor only
3034 blinks when Vim is waiting for input, not while
3035 executing a command.
3036 To make the cursor blink in an xterm, see
3037 |xterm-blink|.
3038 {group-name}
3039 a highlight group name, that sets the color and font
3040 for the cursor
3041 {group-name}/{group-name}
3042 Two highlight group names, the first is used when
3043 no language mappings are used, the other when they
3044 are. |language-mapping|
3045
3046 Examples of parts:
3047 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3048 block cursor with colors from the "nCursor"
3049 highlight group
3050 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3051 In Insert and Command-line Insert mode, use a
3052 30% vertical bar cursor with colors from the
3053 "iCursor" highlight group. Blink a bit
3054 faster.
3055
3056 The 'a' mode is different. It will set the given argument-list for
3057 all modes. It does not reset anything to defaults. This can be used
3058 to do a common setting for all modes. For example, to switch off
3059 blinking: "a:blinkon0"
3060
3061 Examples of cursor highlighting: >
3062 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3063 :highlight Cursor gui=NONE guifg=bg guibg=fg
3064<
3065 *'guifont'* *'gfn'*
3066 *E235* *E596* *E610* *E611*
3067'guifont' 'gfn' string (default "")
3068 global
3069 {not in Vi}
3070 {only available when compiled with GUI enabled}
3071 This is a list of fonts which will be used for the GUI version of Vim.
3072 In its simplest form the value is just one font name. When
3073 the font cannot be found you will get an error message. To try other
3074 font names a list can be specified, font names separated with commas.
3075 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003076
Bram Moolenaar05159a02005-02-26 23:04:13 +00003077 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3078 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003079
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 Spaces after a comma are ignored. To include a comma in a font name
3081 precede it with a backslash. Setting an option requires an extra
3082 backslash before a space and a backslash. See also
3083 |option-backslash|. For example: >
3084 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003085< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003087
3088 If none of the fonts can be loaded, Vim will keep the current setting.
3089 If an empty font list is given, Vim will try using other resource
3090 settings (for X, it will use the Vim.font resource), and finally it
3091 will try some builtin default which should always be there ("7x13" in
3092 the case of X). The font names given should be "normal" fonts. Vim
3093 will try to find the related bold and italic fonts.
3094
Bram Moolenaar05159a02005-02-26 23:04:13 +00003095 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003096 :set guifont=*
3097< will bring up a font requester, where you can pick the font you want.
3098
3099 The font name depends on the GUI used. See |setting-guifont| for a
3100 way to set 'guifont' for various systems.
3101
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 For the GTK+ 2 GUI the font name looks like this: >
3103 :set guifont=Andale\ Mono\ 11
3104< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003105
3106 For Mac OSX you can use something like this: >
3107 :set guifont=Monaco:h10
3108< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003110 width). An exception is GTK 2: all fonts are accepted, but
3111 mono-spaced fonts look best.
3112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 To preview a font on X11, you might be able to use the "xfontsel"
3114 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003115
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 For the Win32 GUI *E244* *E245*
3117 - takes these options in the font name:
3118 hXX - height is XX (points, can be floating-point)
3119 wXX - width is XX (points, can be floating-point)
3120 b - bold
3121 i - italic
3122 u - underline
3123 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003124 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3126 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3127 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003128 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129
3130 Use a ':' to separate the options.
3131 - A '_' can be used in the place of a space, so you don't need to use
3132 backslashes to escape the spaces.
3133 - Examples: >
3134 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3135 :set guifont=Andale_Mono:h7.5:w4.5
3136< See also |font-sizes|.
3137
3138 *'guifontset'* *'gfs'*
3139 *E250* *E252* *E234* *E597* *E598*
3140'guifontset' 'gfs' string (default "")
3141 global
3142 {not in Vi}
3143 {only available when compiled with GUI enabled and
3144 with the |+xfontset| feature}
3145 {not available in the GTK+ 2 GUI}
3146 When not empty, specifies two (or more) fonts to be used. The first
3147 one for normal English, the second one for your special language. See
3148 |xfontset|.
3149 Setting this option also means that all font names will be handled as
3150 a fontset name. Also the ones used for the "font" argument of the
3151 |:highlight| command.
3152 The fonts must match with the current locale. If fonts for the
3153 character sets that the current locale uses are not included, setting
3154 'guifontset' will fail.
3155 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3156 the comma-separated names are alternative names, one of which will be
3157 used. In 'guifontset' the whole string is one fontset name,
3158 including the commas. It is not possible to specify alternative
3159 fontset names.
3160 This example works on many X11 systems: >
3161 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3162<
3163 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3164'guifontwide' 'gfw' string (default "")
3165 global
3166 {not in Vi}
3167 {only available when compiled with GUI enabled}
3168 When not empty, specifies a comma-separated list of fonts to be used
3169 for double-width characters. The first font that can be loaded is
3170 used.
3171 Note: The size of these fonts must be exactly twice as wide as the one
3172 specified with 'guifont' and the same height.
3173
3174 All GUI versions but GTK+ 2:
3175
3176 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3177 'guifontset' is empty or invalid.
3178 When 'guifont' is set and a valid font is found in it and
3179 'guifontwide' is empty Vim will attempt to find a matching
3180 double-width font and set 'guifontwide' to it.
3181
3182 GTK+ 2 GUI only: *guifontwide_gtk2*
3183
3184 If set and valid, 'guifontwide' is always used for double width
3185 characters, even if 'encoding' is not set to "utf-8".
3186 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003187 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 font for characters not available in 'guifont'. Thus you do not need
3189 to set 'guifontwide' at all unless you want to override the choice
3190 made by Pango/Xft.
3191
3192 *'guiheadroom'* *'ghr'*
3193'guiheadroom' 'ghr' number (default 50)
3194 global
3195 {not in Vi} {only for GTK and X11 GUI}
3196 The number of pixels subtracted from the screen height when fitting
3197 the GUI window on the screen. Set this before the GUI is started,
3198 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003199 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 lines will be left for window decorations and other items on the
3201 screen. Set it to a negative value to allow windows taller than the
3202 screen.
3203
3204 *'guioptions'* *'go'*
3205'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003206 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 global
3208 {not in Vi}
3209 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003210 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 sequence of letters which describes what components and options of the
3212 GUI should be used.
3213 To avoid problems with flags that are added in the future, use the
3214 "+=" and "-=" feature of ":set" |add-option-flags|.
3215
3216 Valid letters are as follows:
3217 *guioptions_a*
3218 'a' Autoselect: If present, then whenever VISUAL mode is started,
3219 or the Visual area extended, Vim tries to become the owner of
3220 the windowing system's global selection. This means that the
3221 Visually highlighted text is available for pasting into other
3222 applications as well as into Vim itself. When the Visual mode
3223 ends, possibly due to an operation on the text, or when an
3224 application wants to paste the selection, the highlighted text
3225 is automatically yanked into the "* selection register.
3226 Thus the selection is still available for pasting into other
3227 applications after the VISUAL mode has ended.
3228 If not present, then Vim won't become the owner of the
3229 windowing system's global selection unless explicitly told to
3230 by a yank or delete operation for the "* register.
3231 The same applies to the modeless selection.
3232
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003233 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 applies to the modeless selection.
3235
3236 'guioptions' autoselect Visual autoselect modeless ~
3237 "" - -
3238 "a" yes yes
3239 "A" - yes
3240 "aA" yes yes
3241
3242 'c' Use console dialogs instead of popup dialogs for simple
3243 choices.
3244
3245 'f' Foreground: Don't use fork() to detach the GUI from the shell
3246 where it was started. Use this for programs that wait for the
3247 editor to finish (e.g., an e-mail program). Alternatively you
3248 can use "gvim -f" or ":gui -f" to start the GUI in the
3249 foreground. |gui-fork|
3250 Note: Set this option in the vimrc file. The forking may have
3251 happened already when the gvimrc file is read.
3252
3253 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3254 corner of the window. It's black&white on non-GTK, because of
3255 limitations of X11. For a color icon, see |X11-icon|.
3256
3257 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003258 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 that this flag must be added in the .vimrc file, before
3260 switching on syntax or filetype recognition (when the .gvimrc
3261 file is sourced the system menu has already been loaded; the
3262 ":syntax on" and ":filetype on" commands load the menu too).
3263 'g' Grey menu items: Make menu items that are not active grey. If
3264 'g' is not included inactive menu items are not shown at all.
3265 Exception: Athena will always use grey menu items.
3266
3267 't' Include tearoff menu items. Currently only works for Win32,
3268 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003269 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3270 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271
3272 'r' Right-hand scrollbar is always present.
3273 'R' Right-hand scrollbar is present when there is a vertically
3274 split window.
3275 'l' Left-hand scrollbar is always present.
3276 'L' Left-hand scrollbar is present when there is a vertically
3277 split window.
3278 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3279 the longest visible line, or on the cursor line if the 'h'
3280 flag is included. |gui-horiz-scroll|
3281 'h' Limit horizontal scrollbar size to the length of the cursor
3282 line. Reduces computations. |gui-horiz-scroll|
3283
3284 And yes, you may even have scrollbars on the left AND the right if
3285 you really want to :-). See |gui-scrollbars| for more information.
3286
3287 'v' Use a vertical button layout for dialogs. When not included,
3288 a horizontal layout is preferred, but when it doesn't fit a
3289 vertical layout is used anyway.
3290 'p' Use Pointer callbacks for X11 GUI. This is required for some
3291 window managers. If the cursor is not blinking or hollow at
3292 the right moment, try adding this flag. This must be done
3293 before starting the GUI. Set it in your gvimrc. Adding or
3294 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003295 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296
3297 *'guipty'* *'noguipty'*
3298'guipty' boolean (default on)
3299 global
3300 {not in Vi}
3301 {only available when compiled with GUI enabled}
3302 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3303 I/O to/from shell commands. See |gui-pty|.
3304
3305 *'helpfile'* *'hf'*
3306'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3307 (others) "$VIMRUNTIME/doc/help.txt")
3308 global
3309 {not in Vi}
3310 Name of the main help file. All distributed help files should be
3311 placed together in one directory. Additionally, all "doc" directories
3312 in 'runtimepath' will be used.
3313 Environment variables are expanded |:set_env|. For example:
3314 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003315 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 spaces and backslashes.
3317 This option cannot be set from a |modeline| or in the |sandbox|, for
3318 security reasons.
3319
3320 *'helpheight'* *'hh'*
3321'helpheight' 'hh' number (default 20)
3322 global
3323 {not in Vi}
3324 {not available when compiled without the +windows
3325 feature}
3326 Minimal initial height of the help window when it is opened with the
3327 ":help" command. The initial height of the help window is half of the
3328 current window, or (when the 'ea' option is on) the same as other
3329 windows. When the height is less than 'helpheight', the height is
3330 set to 'helpheight'. Set to zero to disable.
3331
3332 *'helplang'* *'hlg'*
3333'helplang' 'hlg' string (default: messages language or empty)
3334 global
3335 {only available when compiled with the |+multi_lang|
3336 feature}
3337 {not in Vi}
3338 Comma separated list of languages. Vim will use the first language
3339 for which the desired help can be found. The English help will always
3340 be used as a last resort. You can add "en" to prefer English over
3341 another language, but that will only find tags that exist in that
3342 language and not in the English help.
3343 Example: >
3344 :set helplang=de,it
3345< This will first search German, then Italian and finally English help
3346 files.
3347 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3348 try to find the tag in the current language before using this option.
3349 See |help-translated|.
3350
3351 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3352'hidden' 'hid' boolean (default off)
3353 global
3354 {not in Vi}
3355 When off a buffer is unloaded when it is |abandon|ed. When on a
3356 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3357 displayed in another window, it does not become hidden, of course.
3358 The commands that move through the buffer list sometimes make a buffer
3359 hidden although the 'hidden' option is off: When the buffer is
3360 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003361 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003362 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 This option is set for one command with ":hide {command}" |:hide|.
3364 WARNING: It's easy to forget that you have changes in hidden buffers.
3365 Think twice when using ":q!" or ":qa!".
3366
3367 *'highlight'* *'hl'*
3368'highlight' 'hl' string (default (as a single string):
3369 "8:SpecialKey,@:NonText,d:Directory,
3370 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3371 M:ModeMsg,n:LineNr,r:Question,
3372 s:StatusLine,S:StatusLineNC,c:VertSplit
3373 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3374 f:Folded,F:FoldColumn,A:DiffAdd,
3375 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003376 >:SignColumn,B:SpellBad,P:SpellCap,
3377 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 global
3379 {not in Vi}
3380 This option can be used to set highlighting mode for various
3381 occasions. It is a comma separated list of character pairs. The
3382 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003383 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3385 |hl-NonText| @ '~' and '@' at the end of the window and
3386 characters from 'showbreak'
3387 |hl-Directory| d directories in CTRL-D listing and other special
3388 things in listings
3389 |hl-ErrorMsg| e error messages
3390 h (obsolete, ignored)
3391 |hl-IncSearch| i 'incsearch' highlighting
3392 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3393 |hl-MoreMsg| m |more-prompt|
3394 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3395 |hl-LineNr| n line number for ":number" and ":#" commands
3396 |hl-Question| r |hit-enter| prompt and yes/no questions
3397 |hl-StatusLine| s status line of current window |status-line|
3398 |hl-StatusLineNC| S status lines of not-current windows
3399 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3400 |hl-VertSplit| c column used to separate vertically split windows
3401 |hl-Visual| v Visual mode
3402 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3403 Selection" Only X11 Gui's |gui-x11| and
3404 |xterm-clipboard|.
3405 |hl-WarningMsg| w warning messages
3406 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3407 |hl-Folded| f line used for closed folds
3408 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003409 |hl-DiffAdd| A added line in diff mode
3410 |hl-DiffChange| C changed line in diff mode
3411 |hl-DiffDelete| D deleted line in diff mode
3412 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003414 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003415 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003416 |hl-SpellRare| R rare word |spell|
3417 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418
3419 The display modes are:
3420 r reverse (termcap entry "mr" and "me")
3421 i italic (termcap entry "ZH" and "ZR")
3422 b bold (termcap entry "md" and "me")
3423 s standout (termcap entry "so" and "se")
3424 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003425 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 n no highlighting
3427 - no highlighting
3428 : use a highlight group
3429 The default is used for occasions that are not included.
3430 If you want to change what the display modes do, see |dos-colors|
3431 for an example.
3432 When using the ':' display mode, this must be followed by the name of
3433 a highlight group. A highlight group can be used to define any type
3434 of highlighting, including using color. See |:highlight| on how to
3435 define one. The default uses a different group for each occasion.
3436 See |highlight-default| for the default highlight groups.
3437
3438 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3439'hlsearch' 'hls' boolean (default off)
3440 global
3441 {not in Vi}
3442 {not available when compiled without the
3443 |+extra_search| feature}
3444 When there is a previous search pattern, highlight all its matches.
3445 The type of highlighting used can be set with the 'l' occasion in the
3446 'highlight' option. This uses the "Search" highlight group by
3447 default. Note that only the matching text is highlighted, any offsets
3448 are not applied.
3449 See also: 'incsearch' and |:match|.
3450 When you get bored looking at the highlighted matches, you can turn it
3451 off with |:nohlsearch|. As soon as you use a search command, the
3452 highlighting comes back.
3453 When the search pattern can match an end-of-line, Vim will try to
3454 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003455 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 line below a closed fold. A match in a previous line which is not
3457 drawn may not continue in an newly drawn line.
3458 NOTE: This option is reset when 'compatible' is set.
3459
3460 *'history'* *'hi'*
3461'history' 'hi' number (Vim default: 20, Vi default: 0)
3462 global
3463 {not in Vi}
3464 A history of ":" commands, and a history of previous search patterns
3465 are remembered. This option decides how many entries may be stored in
3466 each of these histories (see |cmdline-editing|).
3467 NOTE: This option is set to the Vi default value when 'compatible' is
3468 set and to the Vim default value when 'compatible' is reset.
3469
3470 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3471'hkmap' 'hk' boolean (default off)
3472 global
3473 {not in Vi}
3474 {only available when compiled with the |+rightleft|
3475 feature}
3476 When on, the keyboard is mapped for the Hebrew character set.
3477 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3478 toggle this option. See |rileft.txt|.
3479 NOTE: This option is reset when 'compatible' is set.
3480
3481 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3482'hkmapp' 'hkp' boolean (default off)
3483 global
3484 {not in Vi}
3485 {only available when compiled with the |+rightleft|
3486 feature}
3487 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3488 This is useful if you have a non-Hebrew keyboard.
3489 See |rileft.txt|.
3490 NOTE: This option is reset when 'compatible' is set.
3491
3492 *'icon'* *'noicon'*
3493'icon' boolean (default off, on when title can be restored)
3494 global
3495 {not in Vi}
3496 {not available when compiled without the |+title|
3497 feature}
3498 When on, the icon text of the window will be set to the value of
3499 'iconstring' (if it is not empty), or to the name of the file
3500 currently being edited. Only the last part of the name is used.
3501 Overridden by the 'iconstring' option.
3502 Only works if the terminal supports setting window icons (currently
3503 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3504 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3505 builtin termcap).
3506 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003507 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003508 X11.
3509
3510 *'iconstring'*
3511'iconstring' string (default "")
3512 global
3513 {not in Vi}
3514 {not available when compiled without the |+title|
3515 feature}
3516 When this option is not empty, it will be used for the icon text of
3517 the window. This happens only when the 'icon' option is on.
3518 Only works if the terminal supports setting window icon text
3519 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3520 Does not work for MS Windows.
3521 When Vim was compiled with HAVE_X11 defined, the original icon will be
3522 restored if possible |X11|.
3523 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003524 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 'titlestring' for example settings.
3526 {not available when compiled without the |+statusline| feature}
3527
3528 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3529'ignorecase' 'ic' boolean (default off)
3530 global
3531 Ignore case in search patterns. Also used when searching in the tags
3532 file.
3533 Also see 'smartcase'.
3534 Can be overruled by using "\c" or "\C" in the pattern, see
3535 |/ignorecase|.
3536
3537 *'imactivatekey'* *'imak'*
3538'imactivatekey' 'imak' string (default "")
3539 global
3540 {not in Vi}
3541 {only available when compiled with |+xim| and
3542 |+GUI_GTK|}
3543 Specifies the key that your Input Method in X-Windows uses for
3544 activation. When this is specified correctly, vim can fully control
3545 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3546 You can't use this option to change the activation key, the option
3547 tells Vim what the key is.
3548 Format:
3549 [MODIFIER_FLAG-]KEY_STRING
3550
3551 These characters can be used for MODIFIER_FLAG (case is ignored):
3552 S Shift key
3553 L Lock key
3554 C Control key
3555 1 Mod1 key
3556 2 Mod2 key
3557 3 Mod3 key
3558 4 Mod4 key
3559 5 Mod5 key
3560 Combinations are allowed, for example "S-C-space" or "SC-space" are
3561 both shift+ctrl+space.
3562 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3563
3564 Example: >
3565 :set imactivatekey=S-space
3566< "S-space" means shift+space. This is the activation key for kinput2 +
3567 canna (Japanese), and ami (Korean).
3568
3569 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3570'imcmdline' 'imc' boolean (default off)
3571 global
3572 {not in Vi}
3573 {only available when compiled with the |+xim|
3574 |+multi_byte_ime| or |global-ime| feature}
3575 When set the Input Method is always on when starting to edit a command
3576 line, unless entering a search pattern (see 'imsearch' for that).
3577 Setting this option is useful when your input method allows entering
3578 English characters directly, e.g., when it's used to type accented
3579 characters with dead keys.
3580
3581 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3582'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3583 global
3584 {not in Vi}
3585 {only available when compiled with the |+xim|
3586 |+multi_byte_ime| or |global-ime| feature}
3587 When set the Input Method is never used. This is useful to disable
3588 the IM when it doesn't work properly.
3589 Currently this option is on by default for SGI/IRIX machines. This
3590 may change in later releases.
3591
3592 *'iminsert'* *'imi'*
3593'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3594 local to buffer
3595 {not in Vi}
3596 Specifies whether :lmap or an Input Method (IM) is to be used in
3597 Insert mode. Valid values:
3598 0 :lmap is off and IM is off
3599 1 :lmap is ON and IM is off
3600 2 :lmap is off and IM is ON
3601 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3602 or |global-ime|.
3603 To always reset the option to zero when leaving Insert mode with <Esc>
3604 this can be used: >
3605 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3606< This makes :lmap and IM turn off automatically when leaving Insert
3607 mode.
3608 Note that this option changes when using CTRL-^ in Insert mode
3609 |i_CTRL-^|.
3610 The value is set to 1 when setting 'keymap' to a valid keymap name.
3611 It is also used for the argument of commands like "r" and "f".
3612 The value 0 may not work correctly with Athena and Motif with some XIM
3613 methods. Use 'imdisable' to disable XIM then.
3614
3615 *'imsearch'* *'ims'*
3616'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3617 local to buffer
3618 {not in Vi}
3619 Specifies whether :lmap or an Input Method (IM) is to be used when
3620 entering a search pattern. Valid values:
3621 -1 the value of 'iminsert' is used, makes it look like
3622 'iminsert' is also used when typing a search pattern
3623 0 :lmap is off and IM is off
3624 1 :lmap is ON and IM is off
3625 2 :lmap is off and IM is ON
3626 Note that this option changes when using CTRL-^ in Command-line mode
3627 |c_CTRL-^|.
3628 The value is set to 1 when it is not -1 and setting the 'keymap'
3629 option to a valid keymap name.
3630 The value 0 may not work correctly with Athena and Motif with some XIM
3631 methods. Use 'imdisable' to disable XIM then.
3632
3633 *'include'* *'inc'*
3634'include' 'inc' string (default "^\s*#\s*include")
3635 global or local to buffer |global-local|
3636 {not in Vi}
3637 {not available when compiled without the
3638 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003639 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 pattern, just like for the "/" command (See |pattern|). The default
3641 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003642 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 name that comes after the matched pattern. See |option-backslash|
3644 about including spaces and backslashes.
3645
3646 *'includeexpr'* *'inex'*
3647'includeexpr' 'inex' string (default "")
3648 local to buffer
3649 {not in Vi}
3650 {not available when compiled without the
3651 |+find_in_path| or |+eval| feature}
3652 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003653 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 :set includeexpr=substitute(v:fname,'\\.','/','g')
3655< The "v:fname" variable will be set to the file name that was detected.
3656 Evaluated in the |sandbox|.
3657 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003658 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 Also used for |<cfile>|.
3660
3661 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3662'incsearch' 'is' boolean (default off)
3663 global
3664 {not in Vi}
3665 {not available when compiled without the
3666 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003667 While typing a search command, show where the pattern, as it was typed
3668 so far, matches. The matched string is highlighted. If the pattern
3669 is invalid or not found, nothing is shown. The screen will be updated
3670 often, this is only useful on fast terminals.
3671 Note that the match will be shown, but the cursor will return to its
3672 original position when no match is found and when pressing <Esc>. You
3673 still need to finish the search command with <Enter> to move the
3674 cursor to the match.
3675 The highlighting can be set with the 'i' flag in 'highlight'.
3676 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 NOTE: This option is reset when 'compatible' is set.
3678
3679 *'indentexpr'* *'inde'*
3680'indentexpr' 'inde' string (default "")
3681 local to buffer
3682 {not in Vi}
3683 {not available when compiled without the |+cindent|
3684 or |+eval| features}
3685 Expression which is evaluated to obtain the proper indent for a line.
3686 It is used when a new line is created, for the |=| operator and
3687 in Insert mode as specified with the 'indentkeys' option.
3688 When this option is not empty, it overrules the 'cindent' and
3689 'smartindent' indenting.
3690 When 'paste' is set this option is not used for indenting.
3691 The expression is evaluated with |v:lnum| set to the line number for
3692 which the indent is to be computed. The cursor is also as this line
3693 when the expression is evaluated (but it may be moved around).
3694 The expression must return the number of spaces worth of indent. It
3695 can return "-1" to keep the current indent (this means 'autoindent' is
3696 used for the indent).
3697 Functions useful for computing the indent are |indent()|, |cindent()|
3698 and |lispindent()|.
3699 The evaluation of the expression must not have side effects! It must
3700 not change the text, jump to another window, etc. Afterwards the
3701 cursor position is always restored, thus the cursor may be moved.
3702 Normally this option would be set to call a function: >
3703 :set indentexpr=GetMyIndent()
3704< Error messages will be suppressed, unless the 'debug' option contains
3705 "msg".
3706 See |indent-expression|. Also see |eval-sandbox|.
3707 NOTE: This option is made empty when 'compatible' is set.
3708
3709 *'indentkeys'* *'indk'*
3710'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3711 local to buffer
3712 {not in Vi}
3713 {not available when compiled without the |+cindent|
3714 feature}
3715 A list of keys that, when typed in Insert mode, cause reindenting of
3716 the current line. Only happens if 'indentexpr' isn't empty.
3717 The format is identical to 'cinkeys', see |indentkeys-format|.
3718 See |C-indenting| and |indent-expression|.
3719
3720 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3721'infercase' 'inf' boolean (default off)
3722 local to buffer
3723 {not in Vi}
3724 When doing keyword completion in insert mode |ins-completion|, and
3725 'ignorecase' is also on, the case of the match is adjusted. If the
3726 typed text contains a lowercase letter where the match has an upper
3727 case letter, the completed part is made lowercase. If the typed text
3728 has no lowercase letters and the match has a lowercase letter where
3729 the typed text has an uppercase letter, and there is a letter before
3730 it, the completed part is made uppercase.
3731
3732 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3733'insertmode' 'im' boolean (default off)
3734 global
3735 {not in Vi}
3736 Makes Vim work in a way that Insert mode is the default mode. Useful
3737 if you want to use Vim as a modeless editor. Used for |evim|.
3738 These Insert mode commands will be useful:
3739 - Use the cursor keys to move around.
3740 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3741 this is a mapping, it is executed as if 'insertmode' was off.
3742 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003744 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3745 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746
3747 These items change when 'insertmode' is set:
3748 - when starting to edit of a file, Vim goes to Insert mode.
3749 - <Esc> in Insert mode is a no-op and beeps.
3750 - <Esc> in Normal mode makes Vim go to Insert mode.
3751 - CTRL-L in Insert mode is a command, it is not inserted.
3752 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3753 However, when <Esc> is used inside a mapping, it behaves like
3754 'insertmode' was not set. This was done to be able to use the same
3755 mappings with 'insertmode' set or not set.
3756 When executing commands with |:normal| 'insertmode' is not used.
3757
3758 NOTE: This option is reset when 'compatible' is set.
3759
3760 *'isfname'* *'isf'*
3761'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3762 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3763 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3764 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3765 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3766 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3767 global
3768 {not in Vi}
3769 The characters specified by this option are included in file names and
3770 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003771 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 Multi-byte characters 256 and above are always included, only the
3773 characters up to 255 are specified with this option.
3774 For UTF-8 the characters 0xa0 to 0xff are included as well.
3775
3776 Note that on systems using a backslash as path separator, Vim tries to
3777 do its best to make it work as you would expect. That is a bit
3778 tricky, since Vi originally used the backslash to escape special
3779 characters. Vim will not remove a backslash in front of a normal file
3780 name character on these systems, but it will on Unix and alikes. The
3781 '&' and '^' are not included by default, because these are special for
3782 cmd.exe.
3783
3784 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003785 Each part can be a single character number or a range. A range is two
3786 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 decimal number between 0 and 255 or the ASCII character itself (does
3788 not work for digits). Example:
3789 "_,-,128-140,#-43" (include '_' and '-' and the range
3790 128 to 140 and '#' to 43)
3791 If a part starts with '^', the following character number or range
3792 will be excluded from the option. The option is interpreted from left
3793 to right. Put the excluded character after the range where it is
3794 included. To include '^' itself use it as the last character of the
3795 option or the end of a range. Example:
3796 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3797 If the character is '@', all characters where isalpha() returns TRUE
3798 are included. Normally these are the characters a to z and A to Z,
3799 plus accented characters. To include '@' itself use "@-@". Examples:
3800 "@,^a-z" All alphabetic characters, excluding lower
3801 case letters.
3802 "a-z,A-Z,@-@" All letters plus the '@' character.
3803 A comma can be included by using it where a character number is
3804 expected. Example:
3805 "48-57,,,_" Digits, comma and underscore.
3806 A comma can be excluded by prepending a '^'. Example:
3807 " -~,^,,9" All characters from space to '~', excluding
3808 comma, plus <Tab>.
3809 See |option-backslash| about including spaces and backslashes.
3810
3811 *'isident'* *'isi'*
3812'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3813 "@,48-57,_,128-167,224-235"
3814 otherwise: "@,48-57,_,192-255")
3815 global
3816 {not in Vi}
3817 The characters given by this option are included in identifiers.
3818 Identifiers are used in recognizing environment variables and after a
3819 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003820 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 option.
3822 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003823 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3825
3826 *'iskeyword'* *'isk'*
3827'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3828 "@,48-57,_,128-167,224-235"
3829 otherwise: "@,48-57,_,192-255"
3830 Vi default: "@,48-57,_")
3831 local to buffer
3832 {not in Vi}
3833 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003834 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003835 'isfname' for a description of the format of this option. For C
3836 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3837 For a help file it is set to all non-blank printable characters except
3838 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3839 command).
3840 When the 'lisp' option is on the '-' character is always included.
3841 NOTE: This option is set to the Vi default value when 'compatible' is
3842 set and to the Vim default value when 'compatible' is reset.
3843
3844 *'isprint'* *'isp'*
3845'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3846 "@,~-255"; otherwise: "@,161-255")
3847 global
3848 {not in Vi}
3849 The characters given by this option are displayed directly on the
3850 screen. It is also used for "\p" in a |pattern|. The characters from
3851 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3852 even when they are not included in 'isprint' or excluded. See
3853 'isfname' for a description of the format of this option.
3854
3855 Non-printable characters are displayed with two characters:
3856 0 - 31 "^@" - "^_"
3857 32 - 126 always single characters
3858 127 "^?"
3859 128 - 159 "~@" - "~_"
3860 160 - 254 "| " - "|~"
3861 255 "~?"
3862 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3863 displayed as <xx>, with the hexadecimal value of the byte.
3864 When 'display' contains "uhex" all unprintable characters are
3865 displayed as <xx>.
3866 The NonText highlighting will be used for unprintable characters.
3867 |hl-NonText|
3868
3869 Multi-byte characters 256 and above are always included, only the
3870 characters up to 255 are specified with this option. When a character
3871 is printable but it is not available in the current font, a
3872 replacement character will be shown.
3873 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3874 There is no option to specify these characters.
3875
3876 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3877'joinspaces' 'js' boolean (default on)
3878 global
3879 {not in Vi}
3880 Insert two spaces after a '.', '?' and '!' with a join command.
3881 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3882 Otherwise only one space is inserted.
3883 NOTE: This option is set when 'compatible' is set.
3884
3885 *'key'*
3886'key' string (default "")
3887 local to buffer
3888 {not in Vi}
3889 The key that is used for encrypting and decrypting the current buffer.
3890 See |encryption|.
3891 Careful: Do not set the key value by hand, someone might see the typed
3892 key. Use the |:X| command. But you can make 'key' empty: >
3893 :set key=
3894< It is not possible to get the value of this option with ":set key" or
3895 "echo &key". This is to avoid showing it to someone who shouldn't
3896 know. It also means you cannot see it yourself once you have set it,
3897 be careful not to make a typing error!
3898
3899 *'keymap'* *'kmp'* *E544*
3900'keymap' 'kmp' string (default "")
3901 local to buffer
3902 {not in Vi}
3903 {only available when compiled with the |+keymap|
3904 feature}
3905 Name of a keyboard mapping. See |mbyte-keymap|.
3906 Setting this option to a valid keymap name has the side effect of
3907 setting 'iminsert' to one, so that the keymap becomes effective.
3908 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003909 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910
3911 *'keymodel'* *'km'*
3912'keymodel' 'km' string (default "")
3913 global
3914 {not in Vi}
3915 List of comma separated words, which enable special things that keys
3916 can do. These values can be used:
3917 startsel Using a shifted special key starts selection (either
3918 Select mode or Visual mode, depending on "key" being
3919 present in 'selectmode').
3920 stopsel Using a not-shifted special key stops selection.
3921 Special keys in this context are the cursor keys, <End>, <Home>,
3922 <PageUp> and <PageDown>.
3923 The 'keymodel' option is set by the |:behave| command.
3924
3925 *'keywordprg'* *'kp'*
3926'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3927 OS/2: "view /", VMS: "help")
3928 global or local to buffer |global-local|
3929 {not in Vi}
3930 Program to use for the |K| command. Environment variables are
3931 expanded |:set_env|. ":help" may be used to access the Vim internal
3932 help. (Note that previously setting the global option to the empty
3933 value did this, which is now deprecated.)
3934 When "man" is used, Vim will automatically translate a count for the
3935 "K" command to a section number. Also for "man -s", in which case the
3936 "-s" is removed when there is no count.
3937 See |option-backslash| about including spaces and backslashes.
3938 Example: >
3939 :set keywordprg=man\ -s
3940< This option cannot be set from a |modeline| or in the |sandbox|, for
3941 security reasons.
3942
3943 *'langmap'* *'lmap'* *E357* *E358*
3944'langmap' 'lmap' string (default "")
3945 global
3946 {not in Vi}
3947 {only available when compiled with the |+langmap|
3948 feature}
3949 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003950 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 inserted directly. When in command mode the 'langmap' option takes
3952 care of translating these special characters to the original meaning
3953 of the key. This means you don't have to change the keyboard mode to
3954 be able to execute Normal mode commands.
3955 This is the opposite of the 'keymap' option, where characters are
3956 mapped in Insert mode.
3957 This only works for 8-bit characters. The value of 'langmap' may be
3958 specified with multi-byte characters (e.g., UTF-8), but only the lower
3959 8 bits of each character will be used.
3960
3961 Example (for Greek): *greek* >
3962 :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
3963< Example (exchanges meaning of z and y for commands): >
3964 :set langmap=zy,yz,ZY,YZ
3965<
3966 The 'langmap' option is a list of parts, separated with commas. Each
3967 part can be in one of two forms:
3968 1. A list of pairs. Each pair is a "from" character immediately
3969 followed by the "to" character. Examples: "aA", "aAbBcC".
3970 2. A list of "from" characters, a semi-colon and a list of "to"
3971 characters. Example: "abc;ABC"
3972 Example: "aA,fgh;FGH,cCdDeE"
3973 Special characters need to be preceded with a backslash. These are
3974 ";", ',' and backslash itself.
3975
3976 This will allow you to activate vim actions without having to switch
3977 back and forth between the languages. Your language characters will
3978 be understood as normal vim English characters (according to the
3979 langmap mappings) in the following cases:
3980 o Normal/Visual mode (commands, buffer/register names, user mappings)
3981 o Insert/Replace Mode: Register names after CTRL-R
3982 o Insert/Replace Mode: Mappings
3983 Characters entered in Command-line mode will NOT be affected by
3984 this option. Note that this option can be changed at any time
3985 allowing to switch between mappings for different languages/encodings.
3986 Use a mapping to avoid having to type it each time!
3987
3988 *'langmenu'* *'lm'*
3989'langmenu' 'lm' string (default "")
3990 global
3991 {not in Vi}
3992 {only available when compiled with the |+menu| and
3993 |+multi_lang| features}
3994 Language to use for menu translation. Tells which file is loaded
3995 from the "lang" directory in 'runtimepath': >
3996 "lang/menu_" . &langmenu . ".vim"
3997< (without the spaces). For example, to always use the Dutch menus, no
3998 matter what $LANG is set to: >
3999 :set langmenu=nl_NL.ISO_8859-1
4000< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004001 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002 If your $LANG is set to a non-English language but you do want to use
4003 the English menus: >
4004 :set langmenu=none
4005< This option must be set before loading menus, switching on filetype
4006 detection or syntax highlighting. Once the menus are defined setting
4007 this option has no effect. But you could do this: >
4008 :source $VIMRUNTIME/delmenu.vim
4009 :set langmenu=de_DE.ISO_8859-1
4010 :source $VIMRUNTIME/menu.vim
4011< Warning: This deletes all menus that you defined yourself!
4012
4013 *'laststatus'* *'ls'*
4014'laststatus' 'ls' number (default 1)
4015 global
4016 {not in Vi}
4017 The value of this option influences when the last window will have a
4018 status line:
4019 0: never
4020 1: only if there are at least two windows
4021 2: always
4022 The screen looks nicer with a status line if you have several
4023 windows, but it takes another screen line. |status-line|
4024
4025 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4026'lazyredraw' 'lz' boolean (default off)
4027 global
4028 {not in Vi}
4029 When this option is set, the screen will not be redrawn while
4030 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004031 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 update use |:redraw|.
4033
4034 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4035'linebreak' 'lbr' boolean (default off)
4036 local to window
4037 {not in Vi}
4038 {not available when compiled without the |+linebreak|
4039 feature}
4040 If on Vim will wrap long lines at a character in 'breakat' rather
4041 than at the last character that fits on the screen. Unlike
4042 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4043 it only affects the way the file is displayed, not its contents. The
4044 value of 'showbreak' is used to put in front of wrapped lines.
4045 This option is not used when the 'wrap' option is off or 'list' is on.
4046 Note that <Tab> characters after an <EOL> are mostly not displayed
4047 with the right amount of white space.
4048
4049 *'lines'* *E593*
4050'lines' number (default 24 or terminal height)
4051 global
4052 Number of lines of the Vim window.
4053 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004054 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004055 When Vim is running in the GUI or in a resizable window, setting this
4056 option will cause the window size to be changed. When you only want
4057 to use the size for the GUI, put the command in your |gvimrc| file.
4058 Vim limits the number of lines to what fits on the screen. You can
4059 use this command to get the tallest window possible: >
4060 :set lines=999
4061< If you get less lines than expected, check the 'guiheadroom' option.
4062 When you set this option and Vim is unable to change the physical
4063 number of lines of the display, the display may be messed up.
4064
4065 *'linespace'* *'lsp'*
4066'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4067 global
4068 {not in Vi}
4069 {only in the GUI}
4070 Number of pixel lines inserted between characters. Useful if the font
4071 uses the full character cell height, making lines touch each other.
4072 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004073 With some fonts there can be too much room between lines (to have
4074 space for ascents and descents). Then it makes sense to set
4075 'linespace' to a negative value. This may cause display problems
4076 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077
4078 *'lisp'* *'nolisp'*
4079'lisp' boolean (default off)
4080 local to buffer
4081 {not available when compiled without the |+lispindent|
4082 feature}
4083 Lisp mode: When <Enter> is typed in insert mode set the indent for
4084 the next line to Lisp standards (well, sort of). Also happens with
4085 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4086 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4087 better. Also see 'lispwords'.
4088 The '-' character is included in keyword characters. Redefines the
4089 "=" operator to use this same indentation algorithm rather than
4090 calling an external program if 'equalprg' is empty.
4091 This option is not used when 'paste' is set.
4092 {Vi: Does it a little bit differently}
4093
4094 *'lispwords'* *'lw'*
4095'lispwords' 'lw' string (default is very long)
4096 global
4097 {not in Vi}
4098 {not available when compiled without the |+lispindent|
4099 feature}
4100 Comma separated list of words that influence the Lisp indenting.
4101 |'lisp'|
4102
4103 *'list'* *'nolist'*
4104'list' boolean (default off)
4105 local to window
4106 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4107 see the difference between tabs and spaces and for trailing blanks.
4108 Note that this will also affect formatting (set with 'textwidth' or
4109 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4110 changing the way tabs are displayed.
4111
4112 *'listchars'* *'lcs'*
4113'listchars' 'lcs' string (default "eol:$")
4114 global
4115 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004116 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 settings.
4118 eol:c Character to show at the end of each line. When
4119 omitted, there is no extra character at the end of the
4120 line.
4121 tab:xy Two characters to be used to show a Tab. The first
4122 char is used once. The second char is repeated to
4123 fill the space that the Tab normally occupies.
4124 "tab:>-" will show a Tab that takes four spaces as
4125 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004126 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 trailing spaces are blank.
4128 extends:c Character to show in the last column, when 'wrap' is
4129 off and the line continues beyond the right of the
4130 screen.
4131 precedes:c Character to show in the first column, when 'wrap'
4132 is off and there is text preceding the character
4133 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004134 nbsp:c Character to show for a non-breakable space (character
4135 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004137 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 be used when 'encoding' is "utf-8", otherwise only printable
4139 characters are allowed.
4140
4141 Examples: >
4142 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004143 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144 :set lcs=extends:>,precedes:<
4145< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004146 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147
4148 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4149'loadplugins' 'lpl' boolean (default on)
4150 global
4151 {not in Vi}
4152 When on the plugin scripts are loaded when starting up |load-plugins|.
4153 This option can be reset in your |vimrc| file to disable the loading
4154 of plugins.
4155 Note that using the "-u NONE" and "--noplugin" command line arguments
4156 reset this option. |-u| |--noplugin|
4157
4158 *'magic'* *'nomagic'*
4159'magic' boolean (default on)
4160 global
4161 Changes the special characters that can be used in search patterns.
4162 See |pattern|.
4163 NOTE: To avoid portability problems with using patterns, always keep
4164 this option at the default "on". Only switch it off when working with
4165 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004166 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167
4168 *'makeef'* *'mef'*
4169'makeef' 'mef' string (default: "")
4170 global
4171 {not in Vi}
4172 {not available when compiled without the |+quickfix|
4173 feature}
4174 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4175 and the |:grep| command.
4176 When it is empty, an internally generated temp file will be used.
4177 When "##" is included, it is replaced by a number to make the name
4178 unique. This makes sure that the ":make" command doesn't overwrite an
4179 existing file.
4180 NOT used for the ":cf" command. See 'errorfile' for that.
4181 Environment variables are expanded |:set_env|.
4182 See |option-backslash| about including spaces and backslashes.
4183 This option cannot be set from a |modeline| or in the |sandbox|, for
4184 security reasons.
4185
4186 *'makeprg'* *'mp'*
4187'makeprg' 'mp' string (default "make", VMS: "MMS")
4188 global or local to buffer |global-local|
4189 {not in Vi}
4190 Program to use for the ":make" command. See |:make_makeprg|. This
4191 option may contain '%' and '#' characters, which are expanded like
4192 when used in a command-line. Environment variables are expanded
4193 |:set_env|. See |option-backslash| about including spaces and
4194 backslashes. Note that a '|' must be escaped twice: once for ":set"
4195 and once for the interpretation of a command. When you use a filter
4196 called "myfilter" do it like this: >
4197 :set makeprg=gmake\ \\\|\ myfilter
4198< The placeholder "$*" can be given (even multiple times) to specify
4199 where the arguments will be included, for example: >
4200 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4201< This option cannot be set from a |modeline| or in the |sandbox|, for
4202 security reasons.
4203
4204 *'matchpairs'* *'mps'*
4205'matchpairs' 'mps' string (default "(:),{:},[:]")
4206 local to buffer
4207 {not in Vi}
4208 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004209 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 must be different. The characters must be separated by a colon. The
4211 pairs must be separated by a comma. Example for including '<' and '>'
4212 (HTML): >
4213 :set mps+=<:>
4214
4215< A more exotic example, to jump between the '=' and ';' in an
4216 assignment, useful for languages like C and Java: >
4217 :au FileType c,cpp,java set mps+==:;
4218
4219< For a more advanced way of using "%", see the matchit.vim plugin in
4220 the $VIMRUNTIME/macros directory. |add-local-help|
4221
4222 *'matchtime'* *'mat'*
4223'matchtime' 'mat' number (default 5)
4224 global
4225 {not in Vi}{in Nvi}
4226 Tenths of a second to show the matching paren, when 'showmatch' is
4227 set. Note that this is not in milliseconds, like other options that
4228 set a time. This is to be compatible with Nvi.
4229
4230 *'maxfuncdepth'* *'mfd'*
4231'maxfuncdepth' 'mfd' number (default 100)
4232 global
4233 {not in Vi}
4234 Maximum depth of function calls for user functions. This normally
4235 catches endless recursion. When using a recursive function with
4236 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4237 more memory, there is the danger of failing when memory is exhausted.
4238 See also |:function|.
4239
4240 *'maxmapdepth'* *'mmd'* *E223*
4241'maxmapdepth' 'mmd' number (default 1000)
4242 global
4243 {not in Vi}
4244 Maximum number of times a mapping is done without resulting in a
4245 character to be used. This normally catches endless mappings, like
4246 ":map x y" with ":map y x". It still does not catch ":map g wg",
4247 because the 'w' is used before the next mapping is done. See also
4248 |key-mapping|.
4249
4250 *'maxmem'* *'mm'*
4251'maxmem' 'mm' number (default between 256 to 5120 (system
4252 dependent) or half the amount of memory
4253 available)
4254 global
4255 {not in Vi}
4256 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4257 limit is reached allocating extra memory for a buffer will cause
4258 other memory to be freed. Maximum value 2000000. Use this to work
4259 without a limit. Also see 'maxmemtot'.
4260
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004261 *'maxmempattern'* *'mmp'*
4262'maxmempattern' 'mmp' number (default 1000)
4263 global
4264 {not in Vi}
4265 Maximum amount of memory (in Kbyte) to use for pattern matching.
4266 Maximum value 2000000. Use this to work without a limit.
4267 *E363*
4268 When Vim runs into the limit it gives an error message mostly behaves
4269 like CTRL-C was typed.
4270 Running into the limit often means that the pattern is very
4271 inefficient or too complex. This may already happen with the pattern
4272 "\(.\)*" on a very long line. ".*" works much better.
4273 Vim may run out of memory before hitting the 'maxmempattern' limit.
4274
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 *'maxmemtot'* *'mmt'*
4276'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4277 dependent) or half the amount of memory
4278 available)
4279 global
4280 {not in Vi}
4281 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004282 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 'maxmem'.
4284
4285 *'menuitems'* *'mis'*
4286'menuitems' 'mis' number (default 25)
4287 global
4288 {not in Vi}
4289 {not available when compiled without the |+menu|
4290 feature}
4291 Maximum number of items to use in a menu. Used for menus that are
4292 generated from a list of items, e.g., the Buffers menu. Changing this
4293 option has no direct effect, the menu must be refreshed first.
4294
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004295 *'mkspellmem'* *'msm'*
4296'mkspellmem' 'msm' string (default "460000,2000,500")
4297 global
4298 {not in Vi}
4299 {not available when compiled without the |+syntax|
4300 feature}
4301 Parameters for |:mkspell|. This tunes when to start compressing the
4302 word tree. Compression can be slow when there are many words, but
4303 it's needed to avoid running out of memory. The amount of memory used
4304 per word depends very much on how similar the words are, that's why
4305 this tuning is complicated.
4306
4307 There are three numbers, separated by commas:
4308 {start},{inc},{added}
4309
4310 For most languages the uncompressed word tree fits in memory. {start}
4311 gives the amount of memory in Kbyte that can be used before any
4312 compression is done. It should be a bit smaller than the amount of
4313 memory that is available to Vim.
4314
4315 When going over the {start} limit the {inc} number specifies the
4316 amount of memory in Kbyte that can be allocated before another
4317 compression is done. A low number means compression is done after
4318 less words are added, which is slow. A high number means more memory
4319 will be allocated.
4320
4321 After doing compression, {added} times 1024 words can be added before
4322 the {inc} limit is ignored and compression is done when any extra
4323 amount of memory is needed. A low number means there is a smaller
4324 chance of hitting the {inc} limit, less memory is used but it's
4325 slower.
4326
4327 The languages for which these numbers are important are Italian and
4328 Hungarian. The default works for when you have about 512 Mbyte. If
4329 you have 1 Gbyte you could use: >
4330 :set mkspellmem=900000,3000,800
4331< If you have less than 512 Mbyte |:mkspell| may fail for some
4332 languages, no matter what you set 'mkspellmem' to.
4333
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4335'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4336 local to buffer
4337 *'modelines'* *'mls'*
4338'modelines' 'mls' number (default 5)
4339 global
4340 {not in Vi}
4341 If 'modeline' is on 'modelines' gives the number of lines that is
4342 checked for set commands. If 'modeline' is off or 'modelines' is zero
4343 no lines are checked. See |modeline|.
4344 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4345 set and to the Vim default value when 'compatible' is reset.
4346
4347 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4348'modifiable' 'ma' boolean (default on)
4349 local to buffer
4350 {not in Vi} *E21*
4351 When off the buffer contents cannot be changed. The 'fileformat' and
4352 'fileencoding' options also can't be changed.
4353 Can be reset with the |-M| command line argument.
4354
4355 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4356'modified' 'mod' boolean (default off)
4357 local to buffer
4358 {not in Vi}
4359 When on, the buffer is considered to be modified. This option is set
4360 when:
4361 1. A change was made to the text since it was last written. Using the
4362 |undo| command to go back to the original text will reset the
4363 option. But undoing changes that were made before writing the
4364 buffer will set the option again, since the text is different from
4365 when it was written.
4366 2. 'fileformat' or 'fileencoding' is different from its original
4367 value. The original value is set when the buffer is read or
4368 written. A ":set nomodified" command also resets the original
4369 values to the current values and the 'modified' option will be
4370 reset.
4371 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4372 will be ignored.
4373
4374 *'more'* *'nomore'*
4375'more' boolean (Vim default: on, Vi default: off)
4376 global
4377 {not in Vi}
4378 When on, listings pause when the whole screen is filled. You will get
4379 the |more-prompt|. When this option is off there are no pauses, the
4380 listing continues until finished.
4381 NOTE: This option is set to the Vi default value when 'compatible' is
4382 set and to the Vim default value when 'compatible' is reset.
4383
4384 *'mouse'* *E538*
4385'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4386 global
4387 {not in Vi}
4388 Enable the use of the mouse. Only works for certain terminals
4389 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4390 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4391 The mouse can be enabled for different modes:
4392 n Normal mode
4393 v Visual mode
4394 i Insert mode
4395 c Command-line mode
4396 h all previous modes when editing a help file
4397 a all previous modes
4398 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 Normally you would enable the mouse in all four modes with: >
4400 :set mouse=a
4401< When the mouse is not enabled, the GUI will still use the mouse for
4402 modeless selection. This doesn't move the text cursor.
4403
4404 See |mouse-using|. Also see |'clipboard'|.
4405
4406 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004407 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 the mouse buttons can still be used by keeping the shift key pressed.
4409 Also see the 'clipboard' option.
4410
4411 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4412'mousefocus' 'mousef' boolean (default off)
4413 global
4414 {not in Vi}
4415 {only works in the GUI}
4416 The window that the mouse pointer is on is automatically activated.
4417 When changing the window layout or window focus in another way, the
4418 mouse pointer is moved to the window with keyboard focus. Off is the
4419 default because it makes using the pull down menus a little goofy, as
4420 a pointer transit may activate a window unintentionally.
4421
4422 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4423'mousehide' 'mh' boolean (default on)
4424 global
4425 {not in Vi}
4426 {only works in the GUI}
4427 When on, the mouse pointer is hidden when characters are typed.
4428 The mouse pointer is restored when the mouse is moved.
4429
4430 *'mousemodel'* *'mousem'*
4431'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4432 global
4433 {not in Vi}
4434 Sets the model to use for the mouse. The name mostly specifies what
4435 the right mouse button is used for:
4436 extend Right mouse button extends a selection. This works
4437 like in an xterm.
4438 popup Right mouse button pops up a menu. The shifted left
4439 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004440 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441 popup_setpos Like "popup", but the cursor will be moved to the
4442 position where the mouse was clicked, and thus the
4443 selected operation will act upon the clicked object.
4444 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004445 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 course, that right clicking outside a selection will
4447 end Visual mode.
4448 Overview of what button does what for each model:
4449 mouse extend popup(_setpos) ~
4450 left click place cursor place cursor
4451 left drag start selection start selection
4452 shift-left search word extend selection
4453 right click extend selection popup menu (place cursor)
4454 right drag extend selection -
4455 middle click paste paste
4456
4457 In the "popup" model the right mouse button produces a pop-up menu.
4458 You need to define this first, see |popup-menu|.
4459
4460 Note that you can further refine the meaning of buttons with mappings.
4461 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4462 selection (because that's handled in the GUI code directly).
4463
4464 The 'mousemodel' option is set by the |:behave| command.
4465
4466 *'mouseshape'* *'mouses'* *E547*
4467'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004468 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 global
4470 {not in Vi}
4471 {only available when compiled with the |+mouseshape|
4472 feature}
4473 This option tells Vim what the mouse pointer should look like in
4474 different modes. The option is a comma separated list of parts, much
4475 like used for 'guicursor'. Each part consist of a mode/location-list
4476 and an argument-list:
4477 mode-list:shape,mode-list:shape,..
4478 The mode-list is a dash separated list of these modes/locations:
4479 In a normal window: ~
4480 n Normal mode
4481 v Visual mode
4482 ve Visual mode with 'selection' "exclusive" (same as 'v',
4483 if not specified)
4484 o Operator-pending mode
4485 i Insert mode
4486 r Replace mode
4487
4488 Others: ~
4489 c appending to the command-line
4490 ci inserting in the command-line
4491 cr replacing in the command-line
4492 m at the 'Hit ENTER' or 'More' prompts
4493 ml idem, but cursor in the last line
4494 e any mode, pointer below last window
4495 s any mode, pointer on a status line
4496 sd any mode, while dragging a status line
4497 vs any mode, pointer on a vertical separator line
4498 vd any mode, while dragging a vertical separator line
4499 a everywhere
4500
4501 The shape is one of the following:
4502 avail name looks like ~
4503 w x arrow Normal mouse pointer
4504 w x blank no pointer at all (use with care!)
4505 w x beam I-beam
4506 w x updown up-down sizing arrows
4507 w x leftright left-right sizing arrows
4508 w x busy The system's usual busy pointer
4509 w x no The system's usual 'no input' pointer
4510 x udsizing indicates up-down resizing
4511 x lrsizing indicates left-right resizing
4512 x crosshair like a big thin +
4513 x hand1 black hand
4514 x hand2 white hand
4515 x pencil what you write with
4516 x question big ?
4517 x rightup-arrow arrow pointing right-up
4518 w x up-arrow arrow pointing up
4519 x <number> any X11 pointer number (see X11/cursorfont.h)
4520
4521 The "avail" column contains a 'w' if the shape is available for Win32,
4522 x for X11.
4523 Any modes not specified or shapes not available use the normal mouse
4524 pointer.
4525
4526 Example: >
4527 :set mouseshape=s:udsizing,m:no
4528< will make the mouse turn to a sizing arrow over the status lines and
4529 indicate no input when the hit-enter prompt is displayed (since
4530 clicking the mouse has no effect in this state.)
4531
4532 *'mousetime'* *'mouset'*
4533'mousetime' 'mouset' number (default 500)
4534 global
4535 {not in Vi}
4536 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4537 time in msec between two mouse clicks for the second click to be
4538 recognized as a multi click.
4539
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004540 *'mzquantum'* *'mzq'*
4541'mzquantum' 'mzq' number (default 100)
4542 global
4543 {not in Vi}
4544 {not available when compiled without the |+mzscheme|
4545 feature}
4546 The number of milliseconds between polls for MzScheme threads.
4547 Negative or zero value means no thread scheduling.
4548
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 *'nrformats'* *'nf'*
4550'nrformats' 'nf' string (default "octal,hex")
4551 local to buffer
4552 {not in Vi}
4553 This defines what bases Vim will consider for numbers when using the
4554 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4555 respectively; see |CTRL-A| for more info on these commands.
4556 alpha if included, single alphabetical characters will be
4557 incremented or decremented. This is useful for a list with a
4558 letter index a), b), etc.
4559 octal if included, numbers that start with a zero will be considered
4560 to be octal. Example: Using CTRL-A on "007" results in "010".
4561 hex if included, numbers starting with "0x" or "0X" will be
4562 considered to be hexadecimal. Example: Using CTRL-X on
4563 "0x100" results in "0x0ff".
4564 Numbers which simply begin with a digit in the range 1-9 are always
4565 considered decimal. This also happens for numbers that are not
4566 recognized as octal or hex.
4567
4568 *'number'* *'nu'* *'nonumber'* *'nonu'*
4569'number' 'nu' boolean (default off)
4570 local to window
4571 Print the line number in front of each line. When the 'n' option is
4572 excluded from 'cpoptions' a wrapped line will not use the column of
4573 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004574 The 'numberwidth' option can be used to set the room used for the line
4575 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 When a long, wrapped line doesn't start with the first character, '-'
4577 characters are put before the number.
4578 See |hl-LineNr| for the highlighting used for the number.
4579
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004580 *'numberwidth'* *'nuw'*
4581'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4582 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004583 {not in Vi}
4584 {only available when compiled with the |+linebreak|
4585 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004586 Minimal number of columns to use for the line number. Only relevant
4587 when the 'number' option is set.
4588 Since one space is always between the number and the text, there is
4589 one less character for the number itself.
4590 The value is the minimum width. A bigger width is used when needed to
4591 fit the highest line number in the buffer. Thus with the Vim default
4592 of 4 there is room for a line number up to 999. When the buffer has
4593 1000 lines five columns will be used.
4594 The minimum value is 1, the maximum value is 10.
4595 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4596
Bram Moolenaare344bea2005-09-01 20:46:49 +00004597 *'occultfunc'* *'ofu'*
4598'occultfunc' 'ofu' string (default: empty)
4599 local to buffer
4600 {not in Vi}
4601 {not available when compiled without the +eval
4602 or +insert_expand feature}
4603 This option specifies a function to be used for CTRL-X CTRL-O
4604 completion. |i_CTRL-X_CTRL-O|
4605
4606 For the use of the function see 'completefunc'.
4607
4608
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 *'osfiletype'* *'oft'* *E366*
4610'osfiletype' 'oft' string (RISC-OS default: "Text",
4611 others default: "")
4612 local to buffer
4613 {not in Vi}
4614 {only available when compiled with the |+osfiletype|
4615 feature}
4616 Some operating systems store extra information about files besides
4617 name, datestamp and permissions. This option contains the extra
4618 information, the nature of which will vary between systems.
4619 The value of this option is usually set when the file is loaded, and
4620 use to set the file type when file is written.
4621 It can affect the pattern matching of the automatic commands.
4622 |autocmd-osfiletypes|
4623
4624 *'paragraphs'* *'para'*
4625'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4626 global
4627 Specifies the nroff macros that separate paragraphs. These are pairs
4628 of two letters (see |object-motions|).
4629
4630 *'paste'* *'nopaste'*
4631'paste' boolean (default off)
4632 global
4633 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004634 Put Vim in Paste mode. This is useful if you want to cut or copy
4635 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 unexpected effects.
4637 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004638 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 knows about pasting and will mostly do the right thing without 'paste'
4640 being set. The same is true for a terminal where Vim handles the
4641 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004642 This option is reset when starting the GUI. Thus if you set it in
4643 your .vimrc it will work in a terminal, but not in the GUI. Setting
4644 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4645 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 When the 'paste' option is switched on (also when it was already on):
4647 - mapping in Insert mode and Command-line mode is disabled
4648 - abbreviations are disabled
4649 - 'textwidth' is set to 0
4650 - 'wrapmargin' is set to 0
4651 - 'autoindent' is reset
4652 - 'smartindent' is reset
4653 - 'softtabstop' is set to 0
4654 - 'revins' is reset
4655 - 'ruler' is reset
4656 - 'showmatch' is reset
4657 - 'formatoptions' is used like it is empty
4658 These options keep their value, but their effect is disabled:
4659 - 'lisp'
4660 - 'indentexpr'
4661 - 'cindent'
4662 NOTE: When you start editing another file while the 'paste' option is
4663 on, settings from the modelines or autocommands may change the
4664 settings again, causing trouble when pasting text. You might want to
4665 set the 'paste' option again.
4666 When the 'paste' option is reset the mentioned options are restored to
4667 the value before the moment 'paste' was switched from off to on.
4668 Resetting 'paste' before ever setting it does not have any effect.
4669 Since mapping doesn't work while 'paste' is active, you need to use
4670 the 'pastetoggle' option to toggle the 'paste' option with some key.
4671
4672 *'pastetoggle'* *'pt'*
4673'pastetoggle' 'pt' string (default "")
4674 global
4675 {not in Vi}
4676 When non-empty, specifies the key sequence that toggles the 'paste'
4677 option. This is like specifying a mapping: >
4678 :map {keys} :set invpaste<CR>
4679< Where {keys} is the value of 'pastetoggle'.
4680 The difference is that it will work even when 'paste' is set.
4681 'pastetoggle' works in Insert mode and Normal mode, but not in
4682 Command-line mode.
4683 Mappings are checked first, thus overrule 'pastetoggle'. However,
4684 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4685 this: >
4686 :map <F10> :set paste<CR>
4687 :map <F11> :set nopaste<CR>
4688 :imap <F10> <C-O>:set paste<CR>
4689 :imap <F11> <nop>
4690 :set pastetoggle=<F11>
4691< This will make <F10> start paste mode and <F11> stop paste mode.
4692 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4693 mode everything is inserted literally, except the 'pastetoggle' key
4694 sequence.
4695
4696 *'pex'* *'patchexpr'*
4697'patchexpr' 'pex' string (default "")
4698 global
4699 {not in Vi}
4700 {not available when compiled without the |+diff|
4701 feature}
4702 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004703 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704
4705 *'patchmode'* *'pm'* *E206*
4706'patchmode' 'pm' string (default "")
4707 global
4708 {not in Vi}
4709 When non-empty the oldest version of a file is kept. This can be used
4710 to keep the original version of a file if you are changing files in a
4711 source distribution. Only the first time that a file is written a
4712 copy of the original file will be kept. The name of the copy is the
4713 name of the original file with the string in the 'patchmode' option
4714 appended. This option should start with a dot. Use a string like
4715 ".org". 'backupdir' must not be empty for this to work (Detail: The
4716 backup file is renamed to the patchmode file after the new file has
4717 been successfully written, that's why it must be possible to write a
4718 backup file). If there was no file to be backed up, an empty file is
4719 created.
4720 When the 'backupskip' pattern matches, a patchmode file is not made.
4721 Using 'patchmode' for compressed files appends the extension at the
4722 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4723 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004724 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725
4726 *'path'* *'pa'* *E343* *E345* *E347*
4727'path' 'pa' string (default on Unix: ".,/usr/include,,"
4728 on OS/2: ".,/emx/include,,"
4729 other systems: ".,,")
4730 global or local to buffer |global-local|
4731 {not in Vi}
4732 This is a list of directories which will be searched when using the
4733 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4734 being searched for has a relative path (not starting with '/'). The
4735 directories in the 'path' option may be relative or absolute.
4736 - Use commas to separate directory names: >
4737 :set path=.,/usr/local/include,/usr/include
4738< - Spaces can also be used to separate directory names (for backwards
4739 compatibility with version 3.0). To have a space in a directory
4740 name, precede it with an extra backslash, and escape the space: >
4741 :set path=.,/dir/with\\\ space
4742< - To include a comma in a directory name precede it with an extra
4743 backslash: >
4744 :set path=.,/dir/with\\,comma
4745< - To search relative to the directory of the current file, use: >
4746 :set path=.
4747< - To search in the current directory use an empty string between two
4748 commas: >
4749 :set path=,,
4750< - A directory name may end in a ':' or '/'.
4751 - Environment variables are expanded |:set_env|.
4752 - When using |netrw.vim| URLs can be used. For example, adding
4753 "http://www.vim.org" will make ":find index.html" work.
4754 - Search upwards and downwards in a directory tree:
4755 1) "*" matches a sequence of characters, e.g.: >
4756 :set path=/usr/include/*
4757< means all subdirectories in /usr/include (but not /usr/include
4758 itself). >
4759 :set path=/usr/*c
4760< matches /usr/doc and /usr/src.
4761 2) "**" matches a subtree, up to 100 directories deep. Example: >
4762 :set path=/home/user_x/src/**
4763< means search in the whole subtree under "/home/usr_x/src".
4764 3) If the path ends with a ';', this path is the startpoint
4765 for upward search.
4766 See |file-searching| for more info and exact syntax.
4767 {not available when compiled without the |+path_extra| feature}
4768 - Careful with '\' characters, type two to get one in the option: >
4769 :set path=.,c:\\include
4770< Or just use '/' instead: >
4771 :set path=.,c:/include
4772< Don't forget "." or files won't even be found in the same directory as
4773 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004774 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 it is something like 256 or 1024 characters.
4776 You can check if all the include files are found, using the value of
4777 'path', see |:checkpath|.
4778 The use of |:set+=| and |:set-=| is preferred when adding or removing
4779 directories from the list. This avoids problems when a future version
4780 uses another default. To remove the current directory use: >
4781 :set path-=
4782< To add the current directory use: >
4783 :set path+=
4784< To use an environment variable, you probably need to replace the
4785 separator. Here is an example to append $INCL, in which directory
4786 names are separated with a semi-colon: >
4787 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4788< Replace the ';' with a ':' or whatever separator is used. Note that
4789 this doesn't work when $INCL contains a comma or white space.
4790
4791 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4792'preserveindent' 'pi' boolean (default off)
4793 local to buffer
4794 {not in Vi}
4795 When changing the indent of the current line, preserve as much of the
4796 indent structure as possible. Normally the indent is replaced by a
4797 series of tabs followed by spaces as required (unless |'expandtab'| is
4798 enabled, in which case only spaces are used). Enabling this option
4799 means the indent will preserve as many existing characters as possible
4800 for indenting, and only add additional tabs or spaces as required.
4801 NOTE: When using ">>" multiple times the resulting indent is a mix of
4802 tabs and spaces. You might not like this.
4803 NOTE: 'preserveindent' is reset when 'compatible' is set.
4804 Also see 'copyindent'.
4805 Use |:retab| to clean up white space.
4806
4807 *'previewheight'* *'pvh'*
4808'previewheight' 'pvh' number (default 12)
4809 global
4810 {not in Vi}
4811 {not available when compiled without the |+windows| or
4812 |+quickfix| feature}
4813 Default height for a preview window. Used for |:ptag| and associated
4814 commands. Used for |CTRL-W_}| when no count is given.
4815
4816 *'previewwindow'* *'nopreviewwindow'*
4817 *'pvw'* *'nopvw'* *E590*
4818'previewwindow' 'pvw' boolean (default off)
4819 local to window
4820 {not in Vi}
4821 {not available when compiled without the |+windows| or
4822 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004823 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 set. It's normally not set directly, but by using one of the commands
4825 |:ptag|, |:pedit|, etc.
4826
4827 *'printdevice'* *'pdev'*
4828'printdevice' 'pdev' string (default empty)
4829 global
4830 {not in Vi}
4831 {only available when compiled with the |+printer|
4832 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004833 The name of the printer to be used for |:hardcopy|.
4834 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004835 This option cannot be set from a |modeline| or in the |sandbox|, for
4836 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004837
Bram Moolenaar8299df92004-07-10 09:47:34 +00004838 *'printencoding'* *'penc'*
4839'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 global
4841 {not in Vi}
4842 {only available when compiled with the |+printer|
4843 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004844 Sets the character encoding used when printing.
4845 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846
4847 *'printexpr'* *'pexpr'*
4848'printexpr' 'pexpr' String (default: see below)
4849 global
4850 {not in Vi}
4851 {only available when compiled with the |+printer|
4852 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004853 Expression used to print the PostScript produced with |:hardcopy|.
4854 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
Bram Moolenaar8299df92004-07-10 09:47:34 +00004856 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857'printfont' 'pfn' string (default "courier")
4858 global
4859 {not in Vi}
4860 {only available when compiled with the |+printer|
4861 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004862 The name of the font that will be used for |:hardcopy|.
4863 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864
4865 *'printheader'* *'pheader'*
4866'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4867 global
4868 {not in Vi}
4869 {only available when compiled with the |+printer|
4870 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004871 The format of the header produced in |:hardcopy| output.
4872 See |pheader-option|.
4873
4874 *'printmbcharset'* *'pmbcs'*
4875'printmbcharset' 'pmbcs' string (default "")
4876 global
4877 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004878 {only available when compiled with the |+printer|,
4879 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004880 The CJK character set to be used for CJK output from |:hardcopy|.
4881 See |pmbcs-option|.
4882
4883 *'printmbfont'* *'pmbfn'*
4884'printmbfont' 'pmbfn' string (default "")
4885 global
4886 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004887 {only available when compiled with the |+printer|,
4888 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004889 List of font names to be used for CJK output from |:hardcopy|.
4890 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
4892 *'printoptions'* *'popt'*
4893'printoptions' 'popt' string (default "")
4894 global
4895 {not in Vi}
4896 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004897 List of items that control the format of the output of |:hardcopy|.
4898 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004900 *'prompt'* *'noprompt'*
4901'prompt' boolean (default on)
4902 global
4903 When on a ":" prompt is used in Ex mode.
4904
Bram Moolenaar677ee682005-01-27 14:41:15 +00004905 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004906'quoteescape' 'qe' string (default "\")
4907 local to buffer
4908 {not in Vi}
4909 The characters that are used to escape quotes in a string. Used for
4910 objects like a', a" and a` |a'|.
4911 When one of the characters in this option is found inside a string,
4912 the following character will be skipped. The default value makes the
4913 text "foo\"bar\\" considered to be one string.
4914
Bram Moolenaar071d4272004-06-13 20:20:40 +00004915 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4916'readonly' 'ro' boolean (default off)
4917 local to buffer
4918 If on, writes fail unless you use a '!'. Protects you from
4919 accidentally overwriting a file. Default on when Vim is started
4920 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004921 When using ":w!" the 'readonly' option is reset for the current
4922 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004924 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925
4926 *'remap'* *'noremap'*
4927'remap' boolean (default on)
4928 global
4929 Allows for mappings to work recursively. If you do not want this for
4930 a single entry, use the :noremap[!] command.
4931
4932 *'report'*
4933'report' number (default 2)
4934 global
4935 Threshold for reporting number of lines changed. When the number of
4936 changed lines is more than 'report' a message will be given for most
4937 ":" commands. If you want it always, set 'report' to 0.
4938 For the ":substitute" command the number of substitutions is used
4939 instead of the number of lines.
4940
4941 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4942'restorescreen' 'rs' boolean (default on)
4943 global
4944 {not in Vi} {only in Windows 95/NT console version}
4945 When set, the screen contents is restored when exiting Vim. This also
4946 happens when executing external commands.
4947
4948 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4949 options in your .vimrc. To disable restoring:
4950 set t_ti= t_te=
4951 To enable restoring (for an xterm):
4952 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4953 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4954
4955 *'revins'* *'ri'* *'norevins'* *'nori'*
4956'revins' 'ri' boolean (default off)
4957 global
4958 {not in Vi}
4959 {only available when compiled with the |+rightleft|
4960 feature}
4961 Inserting characters in Insert mode will work backwards. See "typing
4962 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4963 command in Insert mode, when 'allowrevins' is set.
4964 NOTE: This option is reset when 'compatible' or 'paste' is set.
4965
4966 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4967'rightleft' 'rl' boolean (default off)
4968 local to window
4969 {not in Vi}
4970 {only available when compiled with the |+rightleft|
4971 feature}
4972 When on, display orientation becomes right-to-left, i.e., characters
4973 that are stored in the file appear from the right to the left.
4974 Using this option, it is possible to edit files for languages that
4975 are written from the right to the left such as Hebrew and Arabic.
4976 This option is per window, so it is possible to edit mixed files
4977 simultaneously, or to view the same file in both ways (this is
4978 useful whenever you have a mixed text file with both right-to-left
4979 and left-to-right strings so that both sets are displayed properly
4980 in different windows). Also see |rileft.txt|.
4981
4982 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4983'rightleftcmd' 'rlc' string (default "search")
4984 local to window
4985 {not in Vi}
4986 {only available when compiled with the |+rightleft|
4987 feature}
4988 Each word in this option enables the command line editing to work in
4989 right-to-left mode for a group of commands:
4990
4991 search "/" and "?" commands
4992
4993 This is useful for languages such as Hebrew, Arabic and Farsi.
4994 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4995
4996 *'ruler'* *'ru'* *'noruler'* *'noru'*
4997'ruler' 'ru' boolean (default off)
4998 global
4999 {not in Vi}
5000 {not available when compiled without the
5001 |+cmdline_info| feature}
5002 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005003 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 text in the file is shown on the far right:
5005 Top first line is visible
5006 Bot last line is visible
5007 All first and last line are visible
5008 45% relative position in the file
5009 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005010 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005012 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 this option takes precedence over 'ruler' and 'rulerformat'
5014 If the number of characters displayed is different from the number of
5015 bytes in the text (e.g., for a TAB or a multi-byte character), both
5016 the text column (byte number) and the screen column are shown,
5017 separated with a dash.
5018 For an empty line "0-1" is shown.
5019 For an empty buffer the line number will also be zero: "0,0-1".
5020 This option is reset when the 'paste' option is set.
5021 If you don't want to see the ruler all the time but want to know where
5022 you are, use "g CTRL-G" |g_CTRL-G|.
5023 NOTE: This option is reset when 'compatible' is set.
5024
5025 *'rulerformat'* *'ruf'*
5026'rulerformat' 'ruf' string (default empty)
5027 global
5028 {not in Vi}
5029 {not available when compiled without the |+statusline|
5030 feature}
5031 When this option is not empty, it determines the content of the ruler
5032 string, as displayed for the 'ruler' option.
5033 The format of this option, is like that of 'statusline'.
5034 The default ruler width is 17 characters. To make the ruler 15
5035 characters wide, put "%15(" at the start and "%)" at the end.
5036 Example: >
5037 :set rulerformat=%15(%c%V\ %p%%%)
5038<
5039 *'runtimepath'* *'rtp'* *vimfiles*
5040'runtimepath' 'rtp' string (default:
5041 Unix: "$HOME/.vim,
5042 $VIM/vimfiles,
5043 $VIMRUNTIME,
5044 $VIM/vimfiles/after,
5045 $HOME/.vim/after"
5046 Amiga: "home:vimfiles,
5047 $VIM/vimfiles,
5048 $VIMRUNTIME,
5049 $VIM/vimfiles/after,
5050 home:vimfiles/after"
5051 PC, OS/2: "$HOME/vimfiles,
5052 $VIM/vimfiles,
5053 $VIMRUNTIME,
5054 $VIM/vimfiles/after,
5055 $HOME/vimfiles/after"
5056 Macintosh: "$VIM:vimfiles,
5057 $VIMRUNTIME,
5058 $VIM:vimfiles:after"
5059 RISC-OS: "Choices:vimfiles,
5060 $VIMRUNTIME,
5061 Choices:vimfiles/after"
5062 VMS: "sys$login:vimfiles,
5063 $VIM/vimfiles,
5064 $VIMRUNTIME,
5065 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005066 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 global
5068 {not in Vi}
5069 This is a list of directories which will be searched for runtime
5070 files:
5071 filetype.vim filetypes by file name |new-filetype|
5072 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005073 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 colors/ color scheme files |:colorscheme|
5075 compiler/ compiler files |:compiler|
5076 doc/ documentation |write-local-help|
5077 ftplugin/ filetype plugins |write-filetype-plugin|
5078 indent/ indent scripts |indent-expression|
5079 keymap/ key mapping files |mbyte-keymap|
5080 lang/ menu translations |:menutrans|
5081 menu.vim GUI menus |menu.vim|
5082 plugin/ plugin scripts |write-plugin|
5083 print/ files for printing |postscript-print-encoding|
5084 syntax/ syntax files |mysyntaxfile|
5085 tutor/ files for vimtutor |tutor|
5086
5087 And any other file searched for with the |:runtime| command.
5088
5089 The defaults for most systems are setup to search five locations:
5090 1. In your home directory, for your personal preferences.
5091 2. In a system-wide Vim directory, for preferences from the system
5092 administrator.
5093 3. In $VIMRUNTIME, for files distributed with Vim.
5094 *after-directory*
5095 4. In the "after" directory in the system-wide Vim directory. This is
5096 for the system administrator to overrule or add to the distributed
5097 defaults (rarely needed)
5098 5. In the "after" directory in your home directory. This is for
5099 personal preferences to overrule or add to the distributed defaults
5100 or system-wide settings (rarely needed).
5101
5102 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5103 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 wildcards.
5106 See |:runtime|.
5107 Example: >
5108 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5109< This will use the directory "~/vimruntime" first (containing your
5110 personal Vim runtime files), then "/mygroup/vim" (shared between a
5111 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5112 files).
5113 You probably should always include $VIMRUNTIME somewhere, to use the
5114 distributed runtime files. You can put a directory before $VIMRUNTIME
5115 to find files which replace a distributed runtime files. You can put
5116 a directory after $VIMRUNTIME to find files which add to distributed
5117 runtime files.
5118 This option cannot be set from a |modeline| or in the |sandbox|, for
5119 security reasons.
5120
5121 *'scroll'* *'scr'*
5122'scroll' 'scr' number (default: half the window height)
5123 local to window
5124 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5125 set to half the number of lines in the window when the window size
5126 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005127 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5129 the number of screen lines instead of file lines, makes a difference
5130 when lines wrap}
5131
5132 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5133'scrollbind' 'scb' boolean (default off)
5134 local to window
5135 {not in Vi}
5136 {not available when compiled without the |+scrollbind|
5137 feature}
5138 See also |scroll-binding|. When this option is set, the current
5139 window scrolls as other scrollbind windows (windows that also have
5140 this option set) scroll. This option is useful for viewing the
5141 differences between two versions of a file, see 'diff'.
5142 See |'scrollopt'| for options that determine how this option should be
5143 interpreted.
5144 This option is mostly reset when splitting a window to edit another
5145 file. This means that ":split | edit file" results in two windows
5146 with scroll-binding, but ":split file" does not.
5147
5148 *'scrolljump'* *'sj'*
5149'scrolljump' 'sj' number (default 1)
5150 global
5151 {not in Vi}
5152 Minimal number of lines to scroll when the cursor gets off the
5153 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5154 CTRL-D). Useful if your terminal scrolls very slowly.
5155 NOTE: This option is set to 1 when 'compatible' is set.
5156
5157 *'scrolloff'* *'so'*
5158'scrolloff' 'so' number (default 0)
5159 global
5160 {not in Vi}
5161 Minimal number of screen lines to keep above and below the cursor.
5162 This will make some context visible around where you are working. If
5163 you set it to a very large value (999) the cursor line will always be
5164 in the middle of the window (except at the start or end of the file or
5165 when long lines wrap).
5166 For scrolling horizontally see 'sidescrolloff'.
5167 NOTE: This option is set to 0 when 'compatible' is set.
5168
5169 *'scrollopt'* *'sbo'*
5170'scrollopt' 'sbo' string (default "ver,jump")
5171 global
5172 {not available when compiled without the |+scrollbind|
5173 feature}
5174 {not in Vi}
5175 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005176 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5177 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 The following words are available:
5179 ver Bind vertical scrolling for 'scrollbind' windows
5180 hor Bind horizontal scrolling for 'scrollbind' windows
5181 jump Applies to the offset between two windows for vertical
5182 scrolling. This offset is the difference in the first
5183 displayed line of the bound windows. When moving
5184 around in a window, another 'scrollbind' window may
5185 reach a position before the start or after the end of
5186 the buffer. The offset is not changed though, when
5187 moving back the 'scrollbind' window will try to scroll
5188 to the desired position when possible.
5189 When now making that window the current one, two
5190 things can be done with the relative offset:
5191 1. When "jump" is not included, the relative offset is
5192 adjusted for the scroll position in the new current
5193 window. When going back to the other window, the
5194 the new relative offset will be used.
5195 2. When "jump" is included, the other windows are
5196 scrolled to keep the same relative offset. When
5197 going back to the other window, it still uses the
5198 same relative offset.
5199 Also see |scroll-binding|.
5200
5201 *'sections'* *'sect'*
5202'sections' 'sect' string (default "SHNHH HUnhsh")
5203 global
5204 Specifies the nroff macros that separate sections. These are pairs of
5205 two letters (See |object-motions|). The default makes a section start
5206 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5207
5208 *'secure'* *'nosecure'* *E523*
5209'secure' boolean (default off)
5210 global
5211 {not in Vi}
5212 When on, ":autocmd", shell and write commands are not allowed in
5213 ".vimrc" and ".exrc" in the current directory and map commands are
5214 displayed. Switch it off only if you know that you will not run into
5215 problems, or when the 'exrc' option is off. On Unix this option is
5216 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005217 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218 'secure' at the end of your ~/.vimrc then.
5219 This option cannot be set from a |modeline| or in the |sandbox|, for
5220 security reasons.
5221
5222 *'selection'* *'sel'*
5223'selection' 'sel' string (default "inclusive")
5224 global
5225 {not in Vi}
5226 This option defines the behavior of the selection. It is only used
5227 in Visual and Select mode.
5228 Possible values:
5229 value past line inclusive ~
5230 old no yes
5231 inclusive yes yes
5232 exclusive yes no
5233 "past line" means that the cursor is allowed to be positioned one
5234 character past the line.
5235 "inclusive" means that the last character of the selection is included
5236 in an operation. For example, when "x" is used to delete the
5237 selection.
5238 Note that when "exclusive" is used and selecting from the end
5239 backwards, you cannot include the last character of a line, when
5240 starting in Normal mode and 'virtualedit' empty.
5241
5242 The 'selection' option is set by the |:behave| command.
5243
5244 *'selectmode'* *'slm'*
5245'selectmode' 'slm' string (default "")
5246 global
5247 {not in Vi}
5248 This is a comma separated list of words, which specifies when to start
5249 Select mode instead of Visual mode, when a selection is started.
5250 Possible values:
5251 mouse when using the mouse
5252 key when using shifted special keys
5253 cmd when using "v", "V" or CTRL-V
5254 See |Select-mode|.
5255 The 'selectmode' option is set by the |:behave| command.
5256
5257 *'sessionoptions'* *'ssop'*
5258'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5259 help,options,winsize")
5260 global
5261 {not in Vi}
5262 {not available when compiled without the +mksession
5263 feature}
5264 Changes the effect of the |:mksession| command. It is a comma
5265 separated list of words. Each word enables saving and restoring
5266 something:
5267 word save and restore ~
5268 blank empty windows
5269 buffers hidden and unloaded buffers, not just those in windows
5270 curdir the current directory
5271 folds manually created folds, opened/closed folds and local
5272 fold options
5273 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005274 and contain at least one lowercase letter. Only
5275 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 help the help window
5277 localoptions options and mappings local to a window or buffer (not
5278 global values for local options)
5279 options all options and mappings (also global values for local
5280 options)
5281 resize size of the Vim window: 'lines' and 'columns'
5282 sesdir the directory in which the session file is located
5283 will become the current directory (useful with
5284 projects accessed over a network from different
5285 systems)
5286 slash backslashes in file names replaced with forward
5287 slashes
5288 unix with Unix end-of-line format (single <NL>), even when
5289 on Windows or DOS
5290 winpos position of the whole Vim window
5291 winsize window sizes
5292
5293 Don't include both "curdir" and "sesdir".
5294 When "curdir" nor "sesdir" is included, file names are stored with
5295 absolute paths.
5296 "slash" and "unix" are useful on Windows when sharing session files
5297 with Unix. The Unix version of Vim cannot source dos format scripts,
5298 but the Windows version of Vim can source unix format scripts.
5299
5300 *'shell'* *'sh'* *E91*
5301'shell' 'sh' string (default $SHELL or "sh",
5302 MS-DOS and Win32: "command.com" or
5303 "cmd.exe", OS/2: "cmd")
5304 global
5305 Name of the shell to use for ! and :! commands. When changing the
5306 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5307 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005308 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 See |option-backslash| about including spaces and backslashes.
5310 Environment variables are expanded |:set_env|.
5311 If the name of the shell contains a space, you might need to enclose
5312 it in quotes. Example: >
5313 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5314< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005315 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 "-f" is not inside the quotes, because it is not part of the command
5317 name. And Vim automagically recognizes the backslashes that are path
5318 separators.
5319 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5320 variable to change the way external commands are executed. See the
5321 libc.inf file of DJGPP.
5322 Under MS-Windows, when the executable ends in ".com" it must be
5323 included. Thus setting the shell to "command.com" or "4dos.com"
5324 works, but "command" and "4dos" do not work for all commands (e.g.,
5325 filtering).
5326 For unknown reasons, when using "4dos.com" the current directory is
5327 changed to "C:\". To avoid this set 'shell' like this: >
5328 :set shell=command.com\ /c\ 4dos
5329< This option cannot be set from a |modeline| or in the |sandbox|, for
5330 security reasons.
5331
5332 *'shellcmdflag'* *'shcf'*
5333'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5334 does not contain "sh" somewhere: "/c")
5335 global
5336 {not in Vi}
5337 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5338 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5339 systems, the default is set according to the value of 'shell', to
5340 reduce the need to set this option by the user. It's not used for
5341 OS/2 (EMX figures this out itself). See |option-backslash| about
5342 including spaces and backslashes. See |dos-shell|.
5343 This option cannot be set from a |modeline| or in the |sandbox|, for
5344 security reasons.
5345
5346 *'shellpipe'* *'sp'*
5347'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5348 global
5349 {not in Vi}
5350 {not available when compiled without the |+quickfix|
5351 feature}
5352 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005353 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 including spaces and backslashes.
5355 The name of the temporary file can be represented by "%s" if necessary
5356 (the file name is appended automatically if no %s appears in the value
5357 of this option).
5358 For the Amiga and MS-DOS the default is ">". The output is directly
5359 saved in a file and not echoed to the screen.
5360 For Unix the default it "| tee". The stdout of the compiler is saved
5361 in a file and echoed to the screen. If the 'shell' option is "csh" or
5362 "tcsh" after initializations, the default becomes "|& tee". If the
5363 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5364 "2>&1| tee". This means that stderr is also included.
5365 The initialization of this option is done after reading the ".vimrc"
5366 and the other initializations, so that when the 'shell' option is set
5367 there, the 'shellpipe' option changes automatically, unless it was
5368 explicitly set before.
5369 When 'shellpipe' is set to an empty string, no redirection of the
5370 ":make" output will be done. This is useful if you use a 'makeprg'
5371 that writes to 'makeef' by itself. If you want no piping, but do
5372 want to include the 'makeef', set 'shellpipe' to a single space.
5373 Don't forget to precede the space with a backslash: ":set sp=\ ".
5374 In the future pipes may be used for filtering and this option will
5375 become obsolete (at least for Unix).
5376 This option cannot be set from a |modeline| or in the |sandbox|, for
5377 security reasons.
5378
5379 *'shellquote'* *'shq'*
5380'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5381 contains "sh" somewhere: "\"")
5382 global
5383 {not in Vi}
5384 Quoting character(s), put around the command passed to the shell, for
5385 the "!" and ":!" commands. The redirection is kept outside of the
5386 quoting. See 'shellxquote' to include the redirection. It's
5387 probably not useful to set both options.
5388 This is an empty string by default. Only known to be useful for
5389 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5390 or bash, where it should be "\"". The default is adjusted according
5391 the value of 'shell', to reduce the need to set this option by the
5392 user. See |dos-shell|.
5393 This option cannot be set from a |modeline| or in the |sandbox|, for
5394 security reasons.
5395
5396 *'shellredir'* *'srr'*
5397'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5398 global
5399 {not in Vi}
5400 String to be used to put the output of a filter command in a temporary
5401 file. See also |:!|. See |option-backslash| about including spaces
5402 and backslashes.
5403 The name of the temporary file can be represented by "%s" if necessary
5404 (the file name is appended automatically if no %s appears in the value
5405 of this option).
5406 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5407 or "zsh" during initializations, the default becomes ">&". If the
5408 'shell' option is "sh", "ksh" or "bash" the default becomes
5409 ">%s 2>&1". This means that stderr is also included.
5410 For Win32, the Unix checks are done and additionally "cmd" is checked
5411 for, which makes the default ">%s 2>&1". Also, the same names with
5412 ".exe" appended are checked for.
5413 The initialization of this option is done after reading the ".vimrc"
5414 and the other initializations, so that when the 'shell' option is set
5415 there, the 'shellredir' option changes automatically unless it was
5416 explicitly set before.
5417 In the future pipes may be used for filtering and this option will
5418 become obsolete (at least for Unix).
5419 This option cannot be set from a |modeline| or in the |sandbox|, for
5420 security reasons.
5421
5422 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5423'shellslash' 'ssl' boolean (default off)
5424 global
5425 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5426 When set, a forward slash is used when expanding file names. This is
5427 useful when a Unix-like shell is used instead of command.com or
5428 cmd.exe. Backward slashes can still be typed, but they are changed to
5429 forward slashes by Vim.
5430 Note that setting or resetting this option has no effect for some
5431 existing file names, thus this option needs to be set before opening
5432 any file for best results. This might change in the future.
5433 'shellslash' only works when a backslash can be used as a path
5434 separator. To test if this is so use: >
5435 if exists('+shellslash')
5436<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005437 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5438'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5439 global
5440 {not in Vi}
5441 When on, use temp files for shell commands. When off use a pipe.
5442 When using a pipe is not possible temp files are used anyway.
5443 Currently a pipe is only supported on Unix. You can check it with: >
5444 :if has("filterpipe")
5445< The advantage of using a pipe is that nobody can read the temp file
5446 and the 'shell' command does not need to support redirection.
5447 The advantage of using a temp file is that the file type and encoding
5448 can be detected.
5449 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5450 |FilterWritePost| autocommands event are not triggered when
5451 'shelltemp' is off.
5452
Bram Moolenaar071d4272004-06-13 20:20:40 +00005453 *'shelltype'* *'st'*
5454'shelltype' 'st' number (default 0)
5455 global
5456 {not in Vi} {only for the Amiga}
5457 On the Amiga this option influences the way how the commands work
5458 which use a shell.
5459 0 and 1: always use the shell
5460 2 and 3: use the shell only to filter lines
5461 4 and 5: use shell only for ':sh' command
5462 When not using the shell, the command is executed directly.
5463
5464 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5465 1 and 3: use "shell cmd" to start external commands
5466
5467 *'shellxquote'* *'sxq'*
5468'shellxquote' 'sxq' string (default: "";
5469 for Win32, when 'shell' contains "sh"
5470 somewhere: "\""
5471 for Unix, when using system(): "\"")
5472 global
5473 {not in Vi}
5474 Quoting character(s), put around the command passed to the shell, for
5475 the "!" and ":!" commands. Includes the redirection. See
5476 'shellquote' to exclude the redirection. It's probably not useful
5477 to set both options.
5478 This is an empty string by default. Known to be useful for
5479 third-party shells when using the Win32 version, such as the MKS Korn
5480 Shell or bash, where it should be "\"". The default is adjusted
5481 according the value of 'shell', to reduce the need to set this option
5482 by the user. See |dos-shell|.
5483 This option cannot be set from a |modeline| or in the |sandbox|, for
5484 security reasons.
5485
5486 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5487'shiftround' 'sr' boolean (default off)
5488 global
5489 {not in Vi}
5490 Round indent to multiple of 'shiftwidth'. Applies to > and <
5491 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5492 a multiple of 'shiftwidth' (this is Vi compatible).
5493 NOTE: This option is reset when 'compatible' is set.
5494
5495 *'shiftwidth'* *'sw'*
5496'shiftwidth' 'sw' number (default 8)
5497 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005498 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 |'cindent'|, |>>|, |<<|, etc.
5500
5501 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005502'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5503 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 global
5505 {not in Vi}
5506 This option helps to avoid all the |hit-enter| prompts caused by file
5507 messages, for example with CTRL-G, and to avoid some other messages.
5508 It is a list of flags:
5509 flag meaning when present ~
5510 f use "(3 of 5)" instead of "(file 3 of 5)"
5511 i use "[noeol]" instead of "[Incomplete last line]"
5512 l use "999L, 888C" instead of "999 lines, 888 characters"
5513 m use "[+]" instead of "[Modified]"
5514 n use "[New]" instead of "[New File]"
5515 r use "[RO]" instead of "[readonly]"
5516 w use "[w]" instead of "written" for file write message
5517 and "[a]" instead of "appended" for ':w >> file' command
5518 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5519 "[unix format]" and "[mac]" instead of "[mac format]".
5520 a all of the above abbreviations
5521
5522 o overwrite message for writing a file with subsequent message
5523 for reading a file (useful for ":wn" or when 'autowrite' on)
5524 O message for reading a file overwrites any previous message.
5525 Also for quickfix message (e.g., ":cn").
5526 s don't give "search hit BOTTOM, continuing at TOP" or "search
5527 hit TOP, continuing at BOTTOM" messages
5528 t truncate file message at the start if it is too long to fit
5529 on the command-line, "<" will appear in the left most column.
5530 Ignored in Ex mode.
5531 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005532 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 Ignored in Ex mode.
5534 W don't give "written" or "[w]" when writing a file
5535 A don't give the "ATTENTION" message when an existing swap file
5536 is found.
5537 I don't give the intro message when starting Vim |:intro|.
5538
5539 This gives you the opportunity to avoid that a change between buffers
5540 requires you to hit <Enter>, but still gives as useful a message as
5541 possible for the space available. To get the whole message that you
5542 would have got with 'shm' empty, use ":file!"
5543 Useful values:
5544 shm= No abbreviation of message.
5545 shm=a Abbreviation, but no loss of information.
5546 shm=at Abbreviation, and truncate message when necessary.
5547
5548 NOTE: This option is set to the Vi default value when 'compatible' is
5549 set and to the Vim default value when 'compatible' is reset.
5550
5551 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5552'shortname' 'sn' boolean (default off)
5553 local to buffer
5554 {not in Vi, not in MS-DOS versions}
5555 Filenames are assumed to be 8 characters plus one extension of 3
5556 characters. Multiple dots in file names are not allowed. When this
5557 option is on, dots in file names are replaced with underscores when
5558 adding an extension (".~" or ".swp"). This option is not available
5559 for MS-DOS, because then it would always be on. This option is useful
5560 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5561 or crossdos. When running the Win32 GUI version under Win32s, this
5562 option is always on by default.
5563
5564 *'showbreak'* *'sbr'* *E595*
5565'showbreak' 'sbr' string (default "")
5566 global
5567 {not in Vi}
5568 {not available when compiled without the |+linebreak|
5569 feature}
5570 String to put at the start of lines that have been wrapped. Useful
5571 values are "> " or "+++ ".
5572 Only printable single-cell characters are allowed, excluding <Tab> and
5573 comma (in a future version the comma might be used to separate the
5574 part that is shown at the end and at the start of a line).
5575 The characters are highlighted according to the '@' flag in
5576 'highlight'.
5577 Note that tabs after the showbreak will be displayed differently.
5578 If you want the 'showbreak' to appear in between line numbers, add the
5579 "n" flag to 'cpoptions'.
5580
5581 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5582'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5583 off)
5584 global
5585 {not in Vi}
5586 {not available when compiled without the
5587 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005588 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 terminal is slow.
5590 In Visual mode the size of the selected area is shown:
5591 - When selecting characters within a line, the number of characters.
5592 - When selecting more than one line, the number of lines.
5593 - When selecting a block, the size in screen characters: linesxcolumns.
5594 NOTE: This option is set to the Vi default value when 'compatible' is
5595 set and to the Vim default value when 'compatible' is reset.
5596
5597 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5598'showfulltag' 'sft' boolean (default off)
5599 global
5600 {not in Vi}
5601 When completing a word in insert mode (see |ins-completion|) from the
5602 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005603 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005604 matched a C function, you can see a template for what arguments are
5605 required (coding style permitting).
5606
5607 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5608'showmatch' 'sm' boolean (default off)
5609 global
5610 When a bracket is inserted, briefly jump to the matching one. The
5611 jump is only done if the match can be seen on the screen. The time to
5612 show the match can be set with 'matchtime'.
5613 A Beep is given if there is no match (no matter if the match can be
5614 seen or not). This option is reset when the 'paste' option is set.
5615 When the 'm' flag is not included in 'cpoptions', typing a character
5616 will immediately move the cursor back to where it belongs.
5617 See the "sm" field in 'guicursor' for setting the cursor shape and
5618 blinking when showing the match.
5619 The 'matchpairs' option can be used to specify the characters to show
5620 matches for. 'rightleft' and 'revins' are used to look for opposite
5621 matches.
5622 Note: For the use of the short form parental guidance is advised.
5623
5624 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5625'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5626 global
5627 If in Insert, Replace or Visual mode put a message on the last line.
5628 Use the 'M' flag in 'highlight' to set the type of highlighting for
5629 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005630 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 doesn't mean XIM is really active, especially when 'imactivatekey' is
5632 not set.
5633 NOTE: This option is set to the Vi default value when 'compatible' is
5634 set and to the Vim default value when 'compatible' is reset.
5635
5636 *'sidescroll'* *'ss'*
5637'sidescroll' 'ss' number (default 0)
5638 global
5639 {not in Vi}
5640 The minimal number of columns to scroll horizontally. Used only when
5641 the 'wrap' option is off and the cursor is moved off of the screen.
5642 When it is zero the cursor will be put in the middle of the screen.
5643 When using a slow terminal set it to a large number or 0. When using
5644 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5645 commands.
5646
5647 *'sidescrolloff'* *'siso'*
5648'sidescrolloff' 'siso' number (default 0)
5649 global
5650 {not in Vi}
5651 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005652 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 greater than 0 while having |'sidescroll'| also at a non-zero value
5654 makes some context visible in the line you are scrolling in
5655 horizontally (except at the end and beginning of the line). Setting
5656 this option to a large value (like 999) has the effect of keeping the
5657 cursor horizontally centered in the window, as long as one does not
5658 come too close to the beginning or end of the line.
5659 NOTE: This option is set to 0 when 'compatible' is set.
5660
5661 Example: Try this together with 'sidescroll' and 'listchars' as
5662 in the following example to never allow the cursor to move
5663 onto the "extends" character:
5664
5665 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5666 :set sidescrolloff=1
5667
5668
5669 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5670'smartcase' 'scs' boolean (default off)
5671 global
5672 {not in Vi}
5673 Override the 'ignorecase' option if the search pattern contains upper
5674 case characters. Only used when the search pattern is typed and
5675 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005676 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5678 recalling the search pattern from history and hitting <Enter>.
5679 NOTE: This option is reset when 'compatible' is set.
5680
5681 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5682'smartindent' 'si' boolean (default off)
5683 local to buffer
5684 {not in Vi}
5685 {not available when compiled without the
5686 |+smartindent| feature}
5687 Do smart autoindenting when starting a new line. Works for C-like
5688 programs, but can also be used for other languages. 'cindent' does
5689 something like this, works better in most cases, but is more strict,
5690 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5691 'indentexpr' is a more advanced alternative.
5692 Normally 'autoindent' should also be on when using 'smartindent'.
5693 An indent is automatically inserted:
5694 - After a line ending in '{'.
5695 - After a line starting with a keyword from 'cinwords'.
5696 - Before a line starting with '}' (only with the "O" command).
5697 When typing '}' as the first character in a new line, that line is
5698 given the same indent as the matching '{'.
5699 When typing '#' as the first character in a new line, the indent for
5700 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005701 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005702 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5703 When using the ">>" command, lines starting with '#' are not shifted
5704 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005705 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005706 is set smart indenting is disabled.
5707
5708 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5709'smarttab' 'sta' boolean (default off)
5710 global
5711 {not in Vi}
5712 When on, a <Tab> in front of a line inserts blanks according to
5713 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5714 a 'shiftwidth' worth of space at the start of the line.
5715 When off a <Tab> always inserts blanks according to 'tabstop'.
5716 'shiftwidth' is only used for shifting text left or right
5717 |shift-left-right|.
5718 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5719 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005720 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 NOTE: This option is reset when 'compatible' is set.
5722
5723 *'softtabstop'* *'sts'*
5724'softtabstop' 'sts' number (default 0)
5725 local to buffer
5726 {not in Vi}
5727 Number of spaces that a <Tab> counts for while performing editing
5728 operations, like inserting a <Tab> or using <BS>. It "feels" like
5729 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5730 used. This is useful to keep the 'ts' setting at its standard value
5731 of 8, while being able to edit like it is set to 'sts'. However,
5732 commands like "x" still work on the actual characters.
5733 When 'sts' is zero, this feature is off.
5734 'softtabstop' is set to 0 when the 'paste' option is set.
5735 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5736 spaces is minimized by using <Tab>s.
5737 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5738 set.
5739 NOTE: This option is set to 0 when 'compatible' is set.
5740
Bram Moolenaar217ad922005-03-20 22:37:15 +00005741 *'spell'* *'nospell'*
5742'spell' boolean (default off)
5743 local to window
5744 {not in Vi}
5745 {not available when compiled without the |+syntax|
5746 feature}
5747 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005748 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005749
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005750 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005751'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005752 local to buffer
5753 {not in Vi}
5754 {not available when compiled without the |+syntax|
5755 feature}
5756 Pattern to locate the end of a sentence. The following word will be
5757 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005758 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005759 When this check is not wanted make this option empty.
5760 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005761 Be careful with special characters, see |option-backslash| about
5762 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005763 To set this option automatically depending on the language, see
5764 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005765
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005766 *'spellfile'* *'spf'*
5767'spellfile' 'spf' string (default empty)
5768 local to buffer
5769 {not in Vi}
5770 {not available when compiled without the |+syntax|
5771 feature}
5772 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005773 commands. It must end in ".{encoding}.add". You need to include the
5774 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005775 *E765*
5776 It may also be a comma separated list of names. A count before the
5777 |zg| and |zw| commands can be used to access each. This allows using
5778 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005779 When a word is added while this option is empty Vim will set it for
5780 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005781 writable and the first language name that appears in 'spelllang',
5782 ignoring the region.
5783 The resulting ".spl" file will be used for spell checking, it does not
5784 have to appear in 'spelllang'.
5785 Normally one file is used for all regions, but you can add the region
5786 name if you want to. However, it will then only be used when
5787 'spellfile' is set to it, for entries in 'spelllang' only files
5788 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005789 This option cannot be set from a |modeline| or in the |sandbox|, for
5790 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005791
Bram Moolenaar217ad922005-03-20 22:37:15 +00005792 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005793'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005794 local to buffer
5795 {not in Vi}
5796 {not available when compiled without the |+syntax|
5797 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005798 A comma separated list of word list names. When the 'spell' option is
5799 on spellchecking will be done for these languages. Example: >
5800 set spelllang=en_us,nl,medical
5801< This means US English, Dutch and medical words are recognized. Words
5802 that are not recognized will be highlighted.
5803 The word list name must not include a comma or dot. Using a dash is
5804 recommended to separate the two letter language name from a
5805 specification. Thus "en-rare" is used for rare English words.
5806 A region name must come last and have the form "_xx", where "xx" is
5807 the two-letter, lower case region name. You can use more than one
5808 region by listing them: "en_us,en_ca" supports both US and Canadian
5809 English, but not words specific for Australia, New Zealand or Great
5810 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005811 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005812 As a special case the name of a .spl file can be given as-is. The
5813 first "_xx" in the name is removed and used as the region name
5814 (_xx is an underscore, two letters and followed by a non-letter).
5815 This is mainly for testing purposes. You must make sure the correct
5816 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005817 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005818 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5819 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005820 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005821
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005822 After this option has been set successfully, Vim will source the files
5823 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5824 up to the first comma, dot or underscore. See |set-spc-auto|.
5825
5826
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005827 *'spellsuggest'* *'sps'*
5828'spellsuggest' 'sps' string (default "best")
5829 global
5830 {not in Vi}
5831 {not available when compiled without the |+syntax|
5832 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005833 Methods used for spelling suggestions. Both for the |z?| command and
5834 the |spellsuggest()| function. This is a comma-separated list of
5835 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005836
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005837 best Internal method that works best for English. Finds
5838 changes like "fast" and uses a bit of sound-a-like
5839 scoring to improve the ordering.
5840
5841 double Internal method that uses two methods and mixes the
5842 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005843 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005844 word. That only works when the language specifies
5845 sound folding. Can be slow and doesn't always give
5846 better results.
5847
5848 fast Internal method that only checks for simple changes:
5849 character inserts/deletes/swaps. Works well for
5850 simple typing mistakes.
5851
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005852 {number} The maximum number of suggestions listed for |z?|.
5853 Not used for |spellsuggest()|. The number of
5854 suggestions is never more than the value of 'lines'
5855 minus two.
5856
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005857 file:{filename} Read file {filename}, which must have two columns,
5858 separated by a slash. The first column contains the
5859 bad word, the second column the suggested good word.
5860 Example:
5861 theribal/terrible ~
5862 Use this for common mistakes that do not appear at the
5863 top of the suggestion list with the internal methods.
5864 Lines without a slash are ignored, use this for
5865 comments.
5866 The file is used for all languages.
5867
5868 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5869 trouble with spaces. |v:val| holds the badly spelled
5870 word. The expression must evaluate to a List of
5871 Lists, each with a suggestion and a score.
5872 Example:
5873 [['the', 33], ['that', 44]]
5874 Set 'verbose' and use |z?| to see the scores that the
5875 internal methods use. A lower score is better.
5876 This may invoke |spellsuggest()| if you temporarily
5877 set 'spellsuggest' to exclude the "expr:" part.
5878 Errors are silently ignored, unless you set the
5879 'verbose' option to a non-zero value.
5880
5881 Only one of "best", "double" or "fast" may be used. The others may
5882 appear several times in any order. Example: >
5883 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5884<
5885 This option cannot be set from a |modeline| or in the |sandbox|, for
5886 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005887
5888
Bram Moolenaar071d4272004-06-13 20:20:40 +00005889 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5890'splitbelow' 'sb' boolean (default off)
5891 global
5892 {not in Vi}
5893 {not available when compiled without the +windows
5894 feature}
5895 When on, splitting a window will put the new window below the current
5896 one. |:split|
5897
5898 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5899'splitright' 'spr' boolean (default off)
5900 global
5901 {not in Vi}
5902 {not available when compiled without the +vertsplit
5903 feature}
5904 When on, splitting a window will put the new window right of the
5905 current one. |:vsplit|
5906
5907 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5908'startofline' 'sol' boolean (default on)
5909 global
5910 {not in Vi}
5911 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005912 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005913 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005914 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005915 with a linewise operator, with "%" with a count and to buffer changing
5916 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5917 only has a line number, e.g., ":25" or ":+".
5918 In case of buffer changing commands the cursor is placed at the column
5919 where it was the last time the buffer was edited.
5920 NOTE: This option is set when 'compatible' is set.
5921
5922 *'statusline'* *'stl'* *E540* *E541* *E542*
5923'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005924 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 {not in Vi}
5926 {not available when compiled without the |+statusline|
5927 feature}
5928 When nonempty, this option determines the content of the status line.
5929 Also see |status-line|.
5930
5931 The option consists of printf style '%' items interspersed with
5932 normal text. Each status line item is of the form:
5933 %-0{minwid}.{maxwid}{item}
5934 All fields except the {item} is optional. A single percent sign can
5935 be given as "%%". Up to 80 items can be specified.
5936
5937 Note that the only effect of 'ruler' when this option is set (and
5938 'laststatus' is 2) is controlling the output of |CTRL-G|.
5939
5940 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005941 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005943 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 minwid Minimum width of the item, padding as set by '-' & '0'.
5945 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005946 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 on the left for text items. Numeric items will be
5948 shifted down to maxwid-2 digits followed by '>'number
5949 where number is the amount of missing digits, much like
5950 an exponential notation.
5951 item A one letter code as described below.
5952
5953 Following is a description of the possible statusline items. The
5954 second character in "item" is the type:
5955 N for number
5956 S for string
5957 F for flags as described below
5958 - not applicable
5959
5960 item meaning ~
5961 f S Path to the file in the buffer, relative to current directory.
5962 F S Full path to the file in the buffer.
5963 t S File name (tail) of file in the buffer.
5964 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5965 M F Modified flag, text is ",+" or ",-".
5966 r F Readonly flag, text is " [RO]".
5967 R F Readonly flag, text is ",RO".
5968 h F Help buffer flag, text is " [help]".
5969 H F Help buffer flag, text is ",HLP".
5970 w F Preview window flag, text is " [Preview]".
5971 W F Preview window flag, text is ",PRV".
5972 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5973 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5974 {not available when compiled without |+autocmd| feature}
5975 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5976 being used: "<keymap>"
5977 n N Buffer number.
5978 b N Value of byte under cursor.
5979 B N As above, in hexadecimal.
5980 o N Byte number in file of byte under cursor, first byte is 1.
5981 Mnemonic: Offset from start of file (with one added)
5982 {not available when compiled without |+byte_offset| feature}
5983 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005984 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 l N Line number.
5986 L N Number of lines in buffer.
5987 c N Column number.
5988 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005989 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 p N Percentage through file in lines as in |CTRL-G|.
5991 P S Percentage through file of displayed window. This is like the
5992 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005993 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 Empty if the argument file count is zero or one.
5995 { NF Evaluate expression between '{' and '}' and substitute result.
5996 ( - Start of item group. Can be used for setting the width and
5997 alignment of a section. Must be followed by %) somewhere.
5998 ) - End of item group. No width fields allowed.
5999 < - Where to truncate line if too long. Default is at the start.
6000 No width fields allowed.
6001 = - Separation point between left and right aligned items.
6002 No width fields allowed.
6003 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006004 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 The difference between User{N} and StatusLine will be applied
6006 to StatusLineNC for the statusline of non-current windows.
6007 The number N must be between 1 and 9. See |hl-User1..9|
6008
6009 Display of flags are controlled by the following heuristic:
6010 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006011 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 with a space it is assumed that it wants to separate itself from
6013 anything but other flags. That is: A leading comma is removed if the
6014 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006015 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016 make a nice display when flags are used like in the examples below.
6017
Bram Moolenaar582fd852005-03-28 20:58:01 +00006018 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 not set) and a minwid is not set for the group, the whole group will
6020 become empty. This will make a group like the following disappear
6021 completely from the statusline when none of the flags are set. >
6022 :set statusline=...%(\ [%M%R%H]%)...
6023<
6024 Beware that an expression is evaluated each and every time the status
6025 line is displayed. The current buffer and current window will be set
6026 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006027 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6029 real current buffer. The expression is evaluated in the |sandbox|.
6030
6031 If the statusline is not updated when you want it (e.g., after setting
6032 a variable that's used in an expression), you can force an update by
6033 setting an option without changing its value. Example: >
6034 :let &ro = &ro
6035
6036< A result of all digits is regarded a number for display purposes.
6037 Otherwise the result is taken as flag text and applied to the rules
6038 described above.
6039
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006040 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6042 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6043
6044 Examples:
6045 Emulate standard status line with 'ruler' set >
6046 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6047< Similar, but add ASCII value of char under the cursor (like "ga") >
6048 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6049< Display byte count and byte value, modified flag in red. >
6050 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6051 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6052< Display a ,GZ flag if a compressed file is loaded >
6053 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6054< In the |:autocmd|'s: >
6055 :let b:gzflag = 1
6056< And: >
6057 :unlet b:gzflag
6058< And define this function: >
6059 :function VarExists(var, val)
6060 : if exists(a:var) | return a:val | else | return '' | endif
6061 :endfunction
6062<
6063 *'suffixes'* *'su'*
6064'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6065 global
6066 {not in Vi}
6067 Files with these suffixes get a lower priority when multiple files
6068 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006069 suffixes. Spaces after the comma are ignored. A dot is also seen as
6070 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 separator, precede it with a backslash (see |option-backslash| about
6072 including spaces and backslashes).
6073 See 'wildignore' for completely ignoring files.
6074 The use of |:set+=| and |:set-=| is preferred when adding or removing
6075 suffixes from the list. This avoids problems when a future version
6076 uses another default.
6077
6078 *'suffixesadd'* *'sua'*
6079'suffixesadd' 'sua' string (default "")
6080 local to buffer
6081 {not in Vi}
6082 {not available when compiled without the
6083 |+file_in_path| feature}
6084 Comma separated list of suffixes, which are used when searching for a
6085 file for the "gf", "[I", etc. commands. Example: >
6086 :set suffixesadd=.java
6087<
6088 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6089'swapfile' 'swf' boolean (default on)
6090 local to buffer
6091 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006092 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 swapfile is not wanted for a specific buffer. For example, with
6094 confidential information that even root must not be able to access.
6095 Careful: All text will be in memory:
6096 - Don't use this for big files.
6097 - Recovery will be impossible!
6098 A swapfile will only be present when |'updatecount'| is non-zero and
6099 'swapfile' is set.
6100 When 'swapfile' is reset, the swap file for the current buffer is
6101 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6102 non-zero, a swap file is immediately created.
6103 Also see |swap-file| and |'swapsync'|.
6104
6105 This option is used together with 'bufhidden' and 'buftype' to
6106 specify special kinds of buffers. See |special-buffers|.
6107
6108 *'swapsync'* *'sws'*
6109'swapsync' 'sws' string (default "fsync")
6110 global
6111 {not in Vi}
6112 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006113 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 When this option is empty parts of the swap file may be in memory and
6115 not written to disk. When the system crashes you may lose more work.
6116 On Unix the system does a sync now and then without Vim asking for it,
6117 so the disadvantage of setting this option off is small. On some
6118 systems the swap file will not be written at all. For a unix system
6119 setting it to "sync" will use the sync() call instead of the default
6120 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006121 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122
6123 *'switchbuf'* *'swb'*
6124'switchbuf' 'swb' string (default "")
6125 global
6126 {not in Vi}
6127 This option controls the behavior when switching between buffers.
6128 Possible values (comma separated list):
6129 useopen If included, jump to the first open window that
6130 contains the specified buffer (if there is one).
6131 Otherwise: Do not examine other windows.
6132 This setting is checked with |quickfix| commands, when
6133 jumping to errors (":cc", ":cn", "cp", etc.). It is
6134 also used in all buffer related split commands, for
6135 example ":sbuffer", ":sbnext", or ":sbrewind".
6136 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006137 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 Supported in |quickfix| commands that display errors.
6139
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006140 *'synmaxcol'* *'smc'*
6141'synmaxcol' 'smc' number (default 3000)
6142 local to buffer
6143 {not in Vi}
6144 {not available when compiled without the |+syntax|
6145 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006146 Maximum column in which to search for syntax items. In long lines the
6147 text after this column is not highlighted and following lines may not
6148 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006149 This helps to avoid very slow redrawing for an XML file that is one
6150 long line.
6151 Set to zero to remove the limit.
6152
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 *'syntax'* *'syn'*
6154'syntax' 'syn' string (default empty)
6155 local to buffer
6156 {not in Vi}
6157 {not available when compiled without the |+syntax|
6158 feature}
6159 When this option is set, the syntax with this name is loaded, unless
6160 syntax highlighting has been switched off with ":syntax off".
6161 Otherwise this option does not always reflect the current syntax (the
6162 b:current_syntax variable does).
6163 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006164 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 /* vim: set syntax=idl : */
6166< To switch off syntax highlighting for the current file, use: >
6167 :set syntax=OFF
6168< To switch syntax highlighting on according to the current value of the
6169 'filetype' option: >
6170 :set syntax=ON
6171< What actually happens when setting the 'syntax' option is that the
6172 Syntax autocommand event is triggered with the value as argument.
6173 This option is not copied to another buffer, independent of the 's' or
6174 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006175 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176
6177 *'tabstop'* *'ts'*
6178'tabstop' 'ts' number (default 8)
6179 local to buffer
6180 Number of spaces that a <Tab> in the file counts for. Also see
6181 |:retab| command, and 'softtabstop' option.
6182
6183 Note: Setting 'tabstop' to any other value than 8 can make your file
6184 appear wrong in many places (e.g., when printing it).
6185
6186 There are four main ways to use tabs in Vim:
6187 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6188 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6189 will use a mix of tabs and spaces, but typing Tab and BS will
6190 behave like a tab appears every 4 (or 3) characters.
6191 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6192 'expandtab'. This way you will always insert spaces. The
6193 formatting will never be messed up when 'tabstop' is changed.
6194 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006195 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 works when using Vim to edit the file.
6197 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6198 'noexpandtab'. This should then work (for initial indents only)
6199 for any tabstop setting that people use. It might be nice to have
6200 tabs after the first non-blank inserted as spaces if you do this
6201 though. Otherwise aligned comments will be wrong when 'tabstop' is
6202 changed.
6203
6204 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6205'tagbsearch' 'tbs' boolean (default on)
6206 global
6207 {not in Vi}
6208 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006209 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 searching makes searching for a tag a LOT faster, but a linear search
6211 will find more tags if the tags file wasn't properly sorted.
6212 Vim normally assumes that your tags files are sorted, or indicate that
6213 they are not sorted. Only when this is not the case does the
6214 'tagbsearch' option need to be switched off.
6215
6216 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006217 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 certain files, or retry all files with a linear search. When
6219 'tagbsearch' is off, only a linear search is done.
6220
6221 Linear searching is done anyway, for one file, when Vim finds a line
6222 at the start of the file indicating that it's not sorted: >
6223 !_TAG_FILE_SORTED 0 /some command/
6224< [The whitespace before and after the '0' must be a single <Tab>]
6225
6226 When a binary search was done and no match was found in any of the
6227 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6228 instead of a normal tag name, a retry is done with a linear search.
6229 Tags in unsorted tags files, and matches with different case will only
6230 be found in the retry.
6231
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006232 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 linear search can be avoided for the 'ignorecase' case. Use a value
6234 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6235 case-fold sorted with the -f switch to "sort" in most unices, as in
6236 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6237 5.3 or higher the -f or --fold-case-sort switch can be used for this
6238 as well. Note that case must be folded to uppercase for this to work.
6239
6240 When 'tagbsearch' is off, tags searching is slower when a full match
6241 exists, but faster when no full match exists. Tags in unsorted tags
6242 files may only be found with 'tagbsearch' off.
6243 When the tags file is not sorted, or sorted in a wrong way (not on
6244 ASCII byte value), 'tagbsearch' should be off, or the line given above
6245 must be included in the tags file.
6246 This option doesn't affect commands that find all matching tags (e.g.,
6247 command-line completion and ":help").
6248 {Vi: always uses binary search in some versions}
6249
6250 *'taglength'* *'tl'*
6251'taglength' 'tl' number (default 0)
6252 global
6253 If non-zero, tags are significant up to this number of characters.
6254
6255 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6256'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6257 global
6258 {not in Vi}
6259 If on and using a tag file in another directory, file names in that
6260 tag file are relative to the directory where the tag file is.
6261 NOTE: This option is set to the Vi default value when 'compatible' is
6262 set and to the Vim default value when 'compatible' is reset.
6263
6264 *'tags'* *'tag'* *E433*
6265'tags' 'tag' string (default "./tags,tags", when compiled with
6266 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6267 global or local to buffer |global-local|
6268 Filenames for the tag command, separated by spaces or commas. To
6269 include a space or comma in a file name, precede it with a backslash
6270 (see |option-backslash| about including spaces and backslashes).
6271 When a file name starts with "./", the '.' is replaced with the path
6272 of the current file. But only when the 'd' flag is not included in
6273 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6274 |tags-option|.
6275 "*", "**" and other wildcards can be used to search for tags files in
6276 a directory tree. See |file-searching|. {not available when compiled
6277 without the |+path_extra| feature}
6278 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6279 files are also supported. They are automatically recognized. The
6280 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6281 differences are ignored (MS-Windows). |emacs-tags|
6282 The use of |:set+=| and |:set-=| is preferred when adding or removing
6283 file names from the list. This avoids problems when a future version
6284 uses another default.
6285 {Vi: default is "tags /usr/lib/tags"}
6286
6287 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6288'tagstack' 'tgst' boolean (default on)
6289 global
6290 {not in all versions of Vi}
6291 When on, the |tagstack| is used normally. When off, a ":tag" or
6292 ":tselect" command with an argument will not push the tag onto the
6293 tagstack. A following ":tag" without an argument, a ":pop" command or
6294 any other command that uses the tagstack will use the unmodified
6295 tagstack, but does change the pointer to the active entry.
6296 Resetting this option is useful when using a ":tag" command in a
6297 mapping which should not change the tagstack.
6298
6299 *'term'* *E529* *E530* *E531*
6300'term' string (default is $TERM, if that fails:
6301 in the GUI: "builtin_gui"
6302 on Amiga: "amiga"
6303 on BeOS: "beos-ansi"
6304 on Mac: "mac-ansi"
6305 on MiNT: "vt52"
6306 on MS-DOS: "pcterm"
6307 on OS/2: "os2ansi"
6308 on Unix: "ansi"
6309 on VMS: "ansi"
6310 on Win 32: "win32")
6311 global
6312 Name of the terminal. Used for choosing the terminal control
6313 characters. Environment variables are expanded |:set_env|.
6314 For example: >
6315 :set term=$TERM
6316< See |termcap|.
6317
6318 *'termbidi'* *'tbidi'*
6319 *'notermbidi'* *'notbidi'*
6320'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6321 global
6322 {not in Vi}
6323 {only available when compiled with the |+arabic|
6324 feature}
6325 The terminal is in charge of Bi-directionality of text (as specified
6326 by Unicode). The terminal is also expected to do the required shaping
6327 that some languages (such as Arabic) require.
6328 Setting this option implies that 'rightleft' will not be set when
6329 'arabic' is set and the value of 'arabicshape' will be ignored.
6330 Note that setting 'termbidi' has the immediate effect that
6331 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6332 This option is reset when the GUI is started.
6333 For further details see |arabic.txt|.
6334
6335 *'termencoding'* *'tenc'*
6336'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6337 Macintosh GUI: "macroman")
6338 global
6339 {only available when compiled with the |+multi_byte|
6340 feature}
6341 {not in Vi}
6342 Encoding used for the terminal. This specifies what character
6343 encoding the keyboard produces and the display will understand. For
6344 the GUI it only applies to the keyboard ('encoding' is used for the
6345 display).
6346 In the Win32 console version the default value is the console codepage
6347 when it differs from the ANSI codepage.
6348 *E617*
6349 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6350 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6351 Any attempts to set a different value will be rejected, and an error
6352 message is shown.
6353 For the Win32 GUI 'termencoding' is not used for typed characters,
6354 because the Win32 system always passes Unicode characters.
6355 When empty, the same encoding is used as for the 'encoding' option.
6356 This is the normal value.
6357 Not all combinations for 'termencoding' and 'encoding' are valid. See
6358 |encoding-table|.
6359 The value for this option must be supported by internal conversions or
6360 iconv(). When this is not possible no conversion will be done and you
6361 will probably experience problems with non-ASCII characters.
6362 Example: You are working with the locale set to euc-jp (Japanese) and
6363 want to edit a UTF-8 file: >
6364 :let &termencoding = &encoding
6365 :set encoding=utf-8
6366< You need to do this when your system has no locale support for UTF-8.
6367
6368 *'terse'* *'noterse'*
6369'terse' boolean (default off)
6370 global
6371 When set: Add 's' flag to 'shortmess' option (this makes the message
6372 for a search that hits the start or end of the file not being
6373 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6374 shortens a lot of messages}
6375
6376 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6377'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6378 global
6379 {not in Vi}
6380 This option is obsolete. Use 'fileformats'.
6381 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6382 set to the default value for the current system. When 'textauto' is
6383 reset, 'fileformats' is made empty.
6384 NOTE: This option is set to the Vi default value when 'compatible' is
6385 set and to the Vim default value when 'compatible' is reset.
6386
6387 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6388'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6389 others: default off)
6390 local to buffer
6391 {not in Vi}
6392 This option is obsolete. Use 'fileformat'.
6393 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6394 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6395 "unix".
6396
6397 *'textwidth'* *'tw'*
6398'textwidth' 'tw' number (default 0)
6399 local to buffer
6400 {not in Vi}
6401 Maximum width of text that is being inserted. A longer line will be
6402 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006403 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6404 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006405 'formatoptions' and |ins-textwidth|.
6406 NOTE: This option is set to 0 when 'compatible' is set.
6407
6408 *'thesaurus'* *'tsr'*
6409'thesaurus' 'tsr' string (default "")
6410 global or local to buffer |global-local|
6411 {not in Vi}
6412 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006413 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414 the file should contain words with similar meaning, separated by
6415 non-keyword characters (white space is preferred). Maximum line
6416 length is 510 bytes.
6417 To obtain a file to be used here, check out the wordlist FAQ at
6418 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006419 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 after a comma are ignored, otherwise spaces are included in the file
6421 name. See |option-backslash| about using backslashes.
6422 The use of |:set+=| and |:set-=| is preferred when adding or removing
6423 directories from the list. This avoids problems when a future version
6424 uses another default.
6425 Backticks cannot be used in this option for security reasons.
6426
6427 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6428'tildeop' 'top' boolean (default off)
6429 global
6430 {not in Vi}
6431 When on: The tilde command "~" behaves like an operator.
6432 NOTE: This option is reset when 'compatible' is set.
6433
6434 *'timeout'* *'to'* *'notimeout'* *'noto'*
6435'timeout' 'to' boolean (default on)
6436 global
6437 *'ttimeout'* *'nottimeout'*
6438'ttimeout' boolean (default off)
6439 global
6440 {not in Vi}
6441 These two options together determine the behavior when part of a
6442 mapped key sequence or keyboard code has been received:
6443
6444 'timeout' 'ttimeout' action ~
6445 off off do not time out
6446 on on or off time out on :mappings and key codes
6447 off on time out on key codes
6448
6449 If both options are off, Vim will wait until either the complete
6450 mapping or key sequence has been received, or it is clear that there
6451 is no mapping or key sequence for the received characters. For
6452 example: if you have mapped "vl" and Vim has received 'v', the next
6453 character is needed to see if the 'v' is followed by an 'l'.
6454 When one of the options is on, Vim will wait for about 1 second for
6455 the next character to arrive. After that the already received
6456 characters are interpreted as single characters. The waiting time can
6457 be changed with the 'timeoutlen' option.
6458 On slow terminals or very busy systems timing out may cause
6459 malfunctioning cursor keys. If both options are off, Vim waits
6460 forever after an entered <Esc> if there are key codes that start
6461 with <Esc>. You will have to type <Esc> twice. If you do not have
6462 problems with key codes, but would like to have :mapped key
6463 sequences not timing out in 1 second, set the 'ttimeout' option and
6464 reset the 'timeout' option.
6465
6466 NOTE: 'ttimeout' is reset when 'compatible' is set.
6467
6468 *'timeoutlen'* *'tm'*
6469'timeoutlen' 'tm' number (default 1000)
6470 global
6471 {not in all versions of Vi}
6472 *'ttimeoutlen'* *'ttm'*
6473'ttimeoutlen' 'ttm' number (default -1)
6474 global
6475 {not in Vi}
6476 The time in milliseconds that is waited for a key code or mapped key
6477 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6478 when part of a command has been typed.
6479 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6480 different timeout value for key codes is desired set 'ttimeoutlen' to
6481 a non-negative number.
6482
6483 ttimeoutlen mapping delay key code delay ~
6484 < 0 'timeoutlen' 'timeoutlen'
6485 >= 0 'timeoutlen' 'ttimeoutlen'
6486
6487 The timeout only happens when the 'timeout' and 'ttimeout' options
6488 tell so. A useful setting would be >
6489 :set timeout timeoutlen=3000 ttimeoutlen=100
6490< (time out on mapping after three seconds, time out on key codes after
6491 a tenth of a second).
6492
6493 *'title'* *'notitle'*
6494'title' boolean (default off, on when title can be restored)
6495 global
6496 {not in Vi}
6497 {not available when compiled without the |+title|
6498 feature}
6499 When on, the title of the window will be set to the value of
6500 'titlestring' (if it is not empty), or to:
6501 filename [+=-] (path) - VIM
6502 Where:
6503 filename the name of the file being edited
6504 - indicates the file cannot be modified, 'ma' off
6505 + indicates the file was modified
6506 = indicates the file is read-only
6507 =+ indicates the file is read-only and modified
6508 (path) is the path of the file being edited
6509 - VIM the server name |v:servername| or "VIM"
6510 Only works if the terminal supports setting window titles
6511 (currently Amiga console, Win32 console, all GUI versions and
6512 terminals with a non- empty 't_ts' option - these are Unix xterm and
6513 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6514 *X11*
6515 When Vim was compiled with HAVE_X11 defined, the original title will
6516 be restored if possible. The output of ":version" will include "+X11"
6517 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6518 works for the icon name |'icon'|.
6519 But: When Vim was started with the |-X| argument, restoring the title
6520 will not work (except in the GUI).
6521 If the title cannot be restored, it is set to the value of 'titleold'.
6522 You might want to restore the title outside of Vim then.
6523 When using an xterm from a remote machine you can use this command:
6524 rsh machine_name xterm -display $DISPLAY &
6525 then the WINDOWID environment variable should be inherited and the
6526 title of the window should change back to what it should be after
6527 exiting Vim.
6528
6529 *'titlelen'*
6530'titlelen' number (default 85)
6531 global
6532 {not in Vi}
6533 {not available when compiled without the |+title|
6534 feature}
6535 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006536 title. When the title is longer, only the end of the path name is
6537 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 Using a percentage makes this adapt to the width of the window. But
6539 it won't work perfectly, because the actual number of characters
6540 available also depends on the font used and other things in the title
6541 bar. When 'titlelen' is zero the full path is used. Otherwise,
6542 values from 1 to 30000 percent can be used.
6543 'titlelen' is also used for the 'titlestring' option.
6544
6545 *'titleold'*
6546'titleold' string (default "Thanks for flying Vim")
6547 global
6548 {not in Vi}
6549 {only available when compiled with the |+title|
6550 feature}
6551 This option will be used for the window title when exiting Vim if the
6552 original title cannot be restored. Only happens if 'title' is on or
6553 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006554 This option cannot be set from a |modeline| or in the |sandbox|, for
6555 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 *'titlestring'*
6557'titlestring' string (default "")
6558 global
6559 {not in Vi}
6560 {not available when compiled without the |+title|
6561 feature}
6562 When this option is not empty, it will be used for the title of the
6563 window. This happens only when the 'title' option is on.
6564 Only works if the terminal supports setting window titles (currently
6565 Amiga console, Win32 console, all GUI versions and terminals with a
6566 non-empty 't_ts' option).
6567 When Vim was compiled with HAVE_X11 defined, the original title will
6568 be restored if possible |X11|.
6569 When this option contains printf-style '%' items, they will be
6570 expanded according to the rules used for 'statusline'.
6571 Example: >
6572 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6573 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6574< The value of 'titlelen' is used to align items in the middle or right
6575 of the available space.
6576 Some people prefer to have the file name first: >
6577 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6578< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006579 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006580 separating space only when needed.
6581 NOTE: Use of special characters in 'titlestring' may cause the display
6582 to be garbled (e.g., when it contains a CR or NL character).
6583 {not available when compiled without the |+statusline| feature}
6584
6585 *'toolbar'* *'tb'*
6586'toolbar' 'tb' string (default "icons,tooltips")
6587 global
6588 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6589 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006590 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 possible values are:
6592 icons Toolbar buttons are shown with icons.
6593 text Toolbar buttons shown with text.
6594 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006595 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 tooltips Tooltips are active for toolbar buttons.
6597 Tooltips refer to the popup help text which appears after the mouse
6598 cursor is placed over a toolbar button for a brief moment.
6599
6600 If you want the toolbar to be shown with icons as well as text, do the
6601 following: >
6602 :set tb=icons,text
6603< Motif and Athena cannot display icons and text at the same time. They
6604 will show icons if both are requested.
6605
6606 If none of the strings specified in 'toolbar' are valid or if
6607 'toolbar' is empty, this option is ignored. If you want to disable
6608 the toolbar, you need to set the 'guioptions' option. For example: >
6609 :set guioptions-=T
6610< Also see |gui-toolbar|.
6611
6612 *'toolbariconsize'* *'tbis'*
6613'toolbariconsize' 'tbis' string (default "small")
6614 global
6615 {not in Vi}
6616 {only in the GTK+ 2 GUI}
6617 Controls the size of toolbar icons. The possible values are:
6618 tiny Use tiny toolbar icons.
6619 small Use small toolbar icons (default).
6620 medium Use medium-sized toolbar icons.
6621 large Use large toolbar icons.
6622 The exact dimensions in pixels of the various icon sizes depend on
6623 the current theme. Common dimensions are large=32x32, medium=24x24,
6624 small=20x20 and tiny=16x16.
6625
6626 If 'toolbariconsize' is empty, the global default size as determined
6627 by user preferences or the current theme is used.
6628
6629 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6630'ttybuiltin' 'tbi' boolean (default on)
6631 global
6632 {not in Vi}
6633 When on, the builtin termcaps are searched before the external ones.
6634 When off the builtin termcaps are searched after the external ones.
6635 When this option is changed, you should set the 'term' option next for
6636 the change to take effect, for example: >
6637 :set notbi term=$TERM
6638< See also |termcap|.
6639 Rationale: The default for this option is "on", because the builtin
6640 termcap entries are generally better (many systems contain faulty
6641 xterm entries...).
6642
6643 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6644'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6645 sun-cmd, screen, rxvt, dtterm or
6646 iris-ansi; also on when running Vim in
6647 a DOS console)
6648 global
6649 {not in Vi}
6650 Indicates a fast terminal connection. More characters will be sent to
6651 the screen for redrawing, instead of using insert/delete line
6652 commands. Improves smoothness of redrawing when there are multiple
6653 windows and the terminal does not support a scrolling region.
6654 Also enables the extra writing of characters at the end of each screen
6655 line for lines that wrap. This helps when using copy/paste with the
6656 mouse in an xterm and other terminals.
6657
6658 *'ttymouse'* *'ttym'*
6659'ttymouse' 'ttym' string (default depends on 'term')
6660 global
6661 {not in Vi}
6662 {only in Unix and VMS, doesn't work in the GUI; not
6663 available when compiled without |+mouse|}
6664 Name of the terminal type for which mouse codes are to be recognized.
6665 Currently these three strings are valid:
6666 *xterm-mouse*
6667 xterm xterm-like mouse handling. The mouse generates
6668 "<Esc>[Mscr", where "scr" is three bytes:
6669 "s" = button state
6670 "c" = column plus 33
6671 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006672 This only works up to 223 columns! See "dec" for a
6673 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 xterm2 Works like "xterm", but with the xterm reporting the
6675 mouse position while the mouse is dragged. This works
6676 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006677 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 work. See below for how Vim detects this
6679 automatically.
6680 *netterm-mouse*
6681 netterm NetTerm mouse handling. The mouse generates
6682 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6683 for the row and column.
6684 *dec-mouse*
6685 dec DEC terminal mouse handling. The mouse generates a
6686 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006687 This is also available for an Xterm, if it was
6688 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 *jsbterm-mouse*
6690 jsbterm JSB term mouse handling.
6691 *pterm-mouse*
6692 pterm QNX pterm mouse handling.
6693
6694 The mouse handling must be enabled at compile time |+mouse_xterm|
6695 |+mouse_dec| |+mouse_netterm|.
6696 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6697 recognized, if enabled at compile time. DEC terminal mouse codes
6698 are recognized if enabled at compile time, and 'ttymouse' is not
6699 "xterm" (because the xterm and dec mouse codes conflict).
6700 This option is automatically set to "xterm", when the 'term' option is
6701 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6702 or "xterm2" already. The main use of this option is to set it to
6703 "xterm", when the terminal name doesn't start with "xterm", but it can
6704 handle xterm mouse codes.
6705 The "xterm2" value will be set if the xterm version is reported to be
6706 95 of higher. This only works when compiled with the |+termresponse|
6707 feature and if |t_RV| is set to the escape sequence to request the
6708 xterm version number. Otherwise "xterm2" must be set explicitly.
6709 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6710 t_RV to an empty string: >
6711 :set t_RV=
6712<
6713 *'ttyscroll'* *'tsl'*
6714'ttyscroll' 'tsl' number (default 999)
6715 global
6716 Maximum number of lines to scroll the screen. If there are more lines
6717 to scroll the window is redrawn. For terminals where scrolling is
6718 very slow and redrawing is not slow this can be set to a small number,
6719 e.g., 3, to speed up displaying.
6720
6721 *'ttytype'* *'tty'*
6722'ttytype' 'tty' string (default from $TERM)
6723 global
6724 Alias for 'term', see above.
6725
6726 *'undolevels'* *'ul'*
6727'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6728 Win32 and OS/2)
6729 global
6730 {not in Vi}
6731 Maximum number of changes that can be undone. Since undo information
6732 is kept in memory, higher numbers will cause more memory to be used
6733 (nevertheless, a single change can use an unlimited amount of memory).
6734 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6735 itself: >
6736 set ul=0
6737< But you can also get Vi compatibility by including the 'u' flag in
6738 'cpoptions', and still be able to use CTRL-R to repeat undo.
6739 Set to a negative number for no undo at all: >
6740 set ul=-1
6741< This helps when you run out of memory for a single change.
6742 Also see |undo-two-ways|.
6743
6744 *'updatecount'* *'uc'*
6745'updatecount' 'uc' number (default: 200)
6746 global
6747 {not in Vi}
6748 After typing this many characters the swap file will be written to
6749 disk. When zero, no swap file will be created at all (see chapter on
6750 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6751 Vim with the "-n" option, see |startup|. When editing in readonly
6752 mode this option will be initialized to 10000.
6753 The swapfile can be disabled per buffer with |'swapfile'|.
6754 When 'updatecount' is set from zero to non-zero, swap files are
6755 created for all buffers that have 'swapfile' set. When 'updatecount'
6756 is set to zero, existing swap files are not deleted.
6757 Also see |'swapsync'|.
6758 This option has no meaning in buffers where |'buftype'| is "nofile"
6759 or "nowrite".
6760
6761 *'updatetime'* *'ut'*
6762'updatetime' 'ut' number (default 4000)
6763 global
6764 {not in Vi}
6765 If this many milliseconds nothing is typed the swap file will be
6766 written to disk (see |crash-recovery|). Also used for the
6767 |CursorHold| autocommand event.
6768
6769 *'verbose'* *'vbs'*
6770'verbose' 'vbs' number (default 0)
6771 global
6772 {not in Vi, although some versions have a boolean
6773 verbose option}
6774 When bigger than zero, Vim will give messages about what it is doing.
6775 Currently, these messages are given:
6776 >= 1 When the viminfo file is read or written.
6777 >= 2 When a file is ":source"'ed.
6778 >= 5 Every searched tags file.
6779 >= 8 Files for which a group of autocommands is executed.
6780 >= 9 Every executed autocommand.
6781 >= 12 Every executed function.
6782 >= 13 When an exception is thrown, caught, finished, or discarded.
6783 >= 14 Anything pending in a ":finally" clause.
6784 >= 15 Every executed Ex command (truncated at 200 characters).
6785
6786 This option can also be set with the "-V" argument. See |-V|.
6787 This option is also set by the |:verbose| command.
6788
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006789 When the 'verbosefile' option is set then the verbose messages are not
6790 displayed.
6791
6792 *'verbosefile'* *'vfile'*
6793'verbosefile' 'vfile' string (default empty)
6794 global
6795 {not in Vi}
6796 When not empty all messages are written in a file with this name.
6797 When the file exists messages are appended.
6798 Writing to the file ends when Vim exits or when 'verbosefile' is made
6799 empty.
6800 Setting 'verbosefile' to a new value is like making it empty first.
6801 The difference with |:redir| is that verbose messages are not
6802 displayed when 'verbosefile' is set.
6803
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 *'viewdir'* *'vdir'*
6805'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6806 "$VIM/vimfiles/view",
6807 for Unix: "~/.vim/view",
6808 for Macintosh: "$VIM:vimfiles:view"
6809 for VMS: "sys$login:vimfiles/view"
6810 for RiscOS: "Choices:vimfiles/view")
6811 global
6812 {not in Vi}
6813 {not available when compiled without the +mksession
6814 feature}
6815 Name of the directory where to store files for |:mkview|.
6816 This option cannot be set from a |modeline| or in the |sandbox|, for
6817 security reasons.
6818
6819 *'viewoptions'* *'vop'*
6820'viewoptions' 'vop' string (default: "folds,options,cursor")
6821 global
6822 {not in Vi}
6823 {not available when compiled without the +mksession
6824 feature}
6825 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006826 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 word save and restore ~
6828 cursor cursor position in file and in window
6829 folds manually created folds, opened/closed folds and local
6830 fold options
6831 options options and mappings local to a window or buffer (not
6832 global values for local options)
6833 slash backslashes in file names replaced with forward
6834 slashes
6835 unix with Unix end-of-line format (single <NL>), even when
6836 on Windows or DOS
6837
6838 "slash" and "unix" are useful on Windows when sharing view files
6839 with Unix. The Unix version of Vim cannot source dos format scripts,
6840 but the Windows version of Vim can source unix format scripts.
6841
6842 *'viminfo'* *'vi'* *E526* *E527* *E528*
6843'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6844 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6845 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6846 for others: '20,<50,s10,h)
6847 global
6848 {not in Vi}
6849 {not available when compiled without the |+viminfo|
6850 feature}
6851 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006852 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006853 separated list of parameters, each consisting of a single character
6854 identifying the particular parameter, followed by a number or string
6855 which specifies the value of that parameter. If a particular
6856 character is left out, then the default value is used for that
6857 parameter. The following is a list of the identifying characters and
6858 the effect of their value.
6859 CHAR VALUE ~
6860 ! When included, save and restore global variables that start
6861 with an uppercase letter, and don't contain a lowercase
6862 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006863 and "_K_L_M" are not. Only String and Number types are
6864 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 " Maximum number of lines saved for each register. Old name of
6866 the '<' item, with the disadvantage that you need to put a
6867 backslash before the ", otherwise it will be recognized as the
6868 start of a comment!
6869 % When included, save and restore the buffer list. If Vim is
6870 started with a file name argument, the buffer list is not
6871 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006872 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006873 without a file name and buffers for help files are not written
6874 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006875 When followed by a number, the number specifies the maximum
6876 number of buffers that are stored. Without a number all
6877 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006878 ' Maximum number of previously edited files for which the marks
6879 are remembered. This parameter must always be included when
6880 'viminfo' is non-empty.
6881 Including this item also means that the |jumplist| and the
6882 |changelist| are stored in the viminfo file.
6883 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006884 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 patterns are also saved. When not included, the value of
6886 'history' is used.
6887 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006888 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 < Maximum number of lines saved for each register. If zero then
6890 registers are not saved. When not included, all lines are
6891 saved. '"' is the old name for this item.
6892 Also see the 's' item below: limit specified in Kbyte.
6893 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006894 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 c When included, convert the text in the viminfo file from the
6896 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006897 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 f Whether file marks need to be stored. If zero, file marks ('0
6899 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006900 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 cursor position (when exiting or when doing ":wviminfo").
6902 h Disable the effect of 'hlsearch' when loading the viminfo
6903 file. When not included, it depends on whether ":nohlsearch"
6904 has been used since the last search command.
6905 n Name of the viminfo file. The name must immediately follow
6906 the 'n'. Must be the last one! If the "-i" argument was
6907 given when starting Vim, that file name overrides the one
6908 given here with 'viminfo'. Environment variables are expanded
6909 when opening the file, not when setting the option.
6910 r Removable media. The argument is a string (up to the next
6911 ','). This parameter can be given several times. Each
6912 specifies the start of a path for which no marks will be
6913 stored. This is to avoid removable media. For MS-DOS you
6914 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6915 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6916 ignored. Maximum length of each 'r' argument is 50
6917 characters.
6918 s Maximum size of an item in Kbyte. If zero then registers are
6919 not saved. Currently only applies to registers. The default
6920 "s10" will exclude registers with more than 10 Kbyte of text.
6921 Also see the '<' item above: line count limit.
6922
6923 Example: >
6924 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6925<
6926 '50 Marks will be remembered for the last 50 files you
6927 edited.
6928 <1000 Contents of registers (up to 1000 lines each) will be
6929 remembered.
6930 s100 Registers with more than 100 Kbyte text are skipped.
6931 :0 Command-line history will not be saved.
6932 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6933 no / Since '/' is not specified, the default will be used,
6934 that is, save all of the search history, and also the
6935 previous search and substitute patterns.
6936 no % The buffer list will not be saved nor read back.
6937 no h 'hlsearch' highlighting will be restored.
6938
6939 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6940 load the contents of the file, this is not done automatically.
6941
6942 This option cannot be set from a |modeline| or in the |sandbox|, for
6943 security reasons.
6944
6945 *'virtualedit'* *'ve'*
6946'virtualedit' 've' string (default "")
6947 global
6948 {not in Vi}
6949 {not available when compiled without the
6950 |+virtualedit| feature}
6951 A comma separated list of these words:
6952 block Allow virtual editing in Visual block mode.
6953 insert Allow virtual editing in Insert mode.
6954 all Allow virtual editing in all modes.
6955 Virtual editing means that the cursor can be positioned where there is
6956 no actual character. This can be halfway into a Tab or beyond the end
6957 of the line. Useful for selecting a rectangle in Visual mode and
6958 editing a table.
6959
6960 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6961'visualbell' 'vb' boolean (default off)
6962 global
6963 {not in Vi}
6964 Use visual bell instead of beeping. The terminal code to display the
6965 visual bell is given with 't_vb'. When no beep or flash is wanted,
6966 use ":set vb t_vb=".
6967 Note: When the GUI starts, 't_vb' is reset to its default value. You
6968 might want to set it again in your |gvimrc|.
6969 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6970 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6971 where 40 is the time in msec.
6972 Does not work on the Amiga, you always get a screen flash.
6973 Also see 'errorbells'.
6974
6975 *'warn'* *'nowarn'*
6976'warn' boolean (default on)
6977 global
6978 Give a warning message when a shell command is used while the buffer
6979 has been changed.
6980
6981 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6982'weirdinvert' 'wiv' boolean (default off)
6983 global
6984 {not in Vi}
6985 This option has the same effect as the 't_xs' termcap option.
6986 It is provided for backwards compatibility with version 4.x.
6987 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6988 vice versa. Has no effect when the GUI is running.
6989
6990 *'whichwrap'* *'ww'*
6991'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6992 global
6993 {not in Vi}
6994 Allow specified keys that move the cursor left/right to move to the
6995 previous/next line when the cursor is on the first/last character in
6996 the line. Concatenate characters to allow this for these keys:
6997 char key mode ~
6998 b <BS> Normal and Visual
6999 s <Space> Normal and Visual
7000 h "h" Normal and Visual
7001 l "l" Normal and Visual
7002 < <Left> Normal and Visual
7003 > <Right> Normal and Visual
7004 ~ "~" Normal
7005 [ <Left> Insert and Replace
7006 ] <Right> Insert and Replace
7007 For example: >
7008 :set ww=<,>,[,]
7009< allows wrap only when cursor keys are used.
7010 When the movement keys are used in combination with a delete or change
7011 operator, the <EOL> also counts for a character. This makes "3h"
7012 different from "3dh" when the cursor crosses the end of a line. This
7013 is also true for "x" and "X", because they do the same as "dl" and
7014 "dh". If you use this, you may also want to use the mapping
7015 ":map <BS> X" to make backspace delete the character in front of the
7016 cursor.
7017 When 'l' is included, you get a side effect: "yl" on an empty line
7018 will include the <EOL>, so that "p" will insert a new line.
7019 NOTE: This option is set to the Vi default value when 'compatible' is
7020 set and to the Vim default value when 'compatible' is reset.
7021
7022 *'wildchar'* *'wc'*
7023'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7024 global
7025 {not in Vi}
7026 Character you have to type to start wildcard expansion in the
7027 command-line, as specified with 'wildmode'.
7028 The character is not recognized when used inside a macro. See
7029 'wildcharm' for that.
7030 Although 'wc' is a number option, you can set it to a special key: >
7031 :set wc=<Esc>
7032< NOTE: This option is set to the Vi default value when 'compatible' is
7033 set and to the Vim default value when 'compatible' is reset.
7034
7035 *'wildcharm'* *'wcm'*
7036'wildcharm' 'wcm' number (default: none (0))
7037 global
7038 {not in Vi}
7039 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007040 recognized when used inside a macro. You can find "spare" command-line
7041 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007042 you'll never actually type 'wildcharm', just use it in mappings that
7043 automatically invoke completion mode, e.g.: >
7044 :set wcm=<C-Z>
7045 :cmap ss so $vim/sessions/*.vim<C-Z>
7046< Then after typing :ss you can use CTRL-P & CTRL-N.
7047
7048 *'wildignore'* *'wig'*
7049'wildignore' 'wig' string (default "")
7050 global
7051 {not in Vi}
7052 {not available when compiled without the |+wildignore|
7053 feature}
7054 A list of file patterns. A file that matches with one of these
7055 patterns is ignored when completing file or directory names.
7056 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7057 Also see 'suffixes'.
7058 Example: >
7059 :set wildignore=*.o,*.obj
7060< The use of |:set+=| and |:set-=| is preferred when adding or removing
7061 a pattern from the list. This avoids problems when a future version
7062 uses another default.
7063
7064 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7065'wildmenu' 'wmnu' boolean (default off)
7066 global
7067 {not in Vi}
7068 {not available if compiled without the |+wildmenu|
7069 feature}
7070 When 'wildmenu' is on, command-line completion operates in an enhanced
7071 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7072 the possible matches are shown just above the command line, with the
7073 first match highlighted (overwriting the status line, if there is
7074 one). Keys that show the previous/next match, such as <Tab> or
7075 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7076 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7077 specified. "longest" and "list" do not start "wildmenu" mode.
7078 If there are more matches than can fit in the line, a ">" is shown on
7079 the right and/or a "<" is shown on the left. The status line scrolls
7080 as needed.
7081 The "wildmenu" mode is abandoned when a key is hit that is not used
7082 for selecting a completion.
7083 While the "wildmenu" is active the following keys have special
7084 meanings:
7085
7086 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7087 <Down> - in filename/menu name completion: move into a
7088 subdirectory or submenu.
7089 <CR> - in menu completion, when the cursor is just after a
7090 dot: move into a submenu.
7091 <Up> - in filename/menu name completion: move up into
7092 parent directory or parent menu.
7093
7094 This makes the menus accessible from the console |console-menus|.
7095
7096 If you prefer the <Left> and <Right> keys to move the cursor instead
7097 of selecting a different match, use this: >
7098 :cnoremap <Left> <Space><BS><Left>
7099 :cnoremap <Right> <Space><BS><Right>
7100<
7101 The "WildMenu" highlighting is used for displaying the current match
7102 |hl-WildMenu|.
7103
7104 *'wildmode'* *'wim'*
7105'wildmode' 'wim' string (Vim default: "full")
7106 global
7107 {not in Vi}
7108 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007109 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007110 part specifies what to do for each consecutive use of 'wildchar. The
7111 first part specifies the behavior for the first use of 'wildchar',
7112 The second part for the second use, etc.
7113 These are the possible values for each part:
7114 "" Complete only the first match.
7115 "full" Complete the next full match. After the last match,
7116 the original string is used and then the first match
7117 again.
7118 "longest" Complete till longest common string. If this doesn't
7119 result in a longer string, use the next part.
7120 "longest:full" Like "longest", but also start 'wildmenu' if it is
7121 enabled.
7122 "list" When more than one match, list all matches.
7123 "list:full" When more than one match, list all matches and
7124 complete first match.
7125 "list:longest" When more than one match, list all matches and
7126 complete till longest common string.
7127 When there is only a single match, it is fully completed in all cases.
7128
7129 Examples: >
7130 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007131< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007132 :set wildmode=longest,full
7133< Complete longest common string, then each full match >
7134 :set wildmode=list:full
7135< List all matches and complete each full match >
7136 :set wildmode=list,full
7137< List all matches without completing, then each full match >
7138 :set wildmode=longest,list
7139< Complete longest common string, then list alternatives.
7140
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007141 *'wildoptions'* *'wop'*
7142'wildoptions' 'wop' string (default "")
7143 global
7144 {not in Vi}
7145 {not available when compiled without the |+wildignore|
7146 feature}
7147 A list of words that change how command line completion is done.
7148 Currently only one word is allowed:
7149 tagfile When using CTRL-D to list matching tags, the kind of
7150 tag and the file of the tag is listed. Only one match
7151 is displayed per line. Often used tag kinds are:
7152 d #define
7153 f function
7154 Also see |cmdline-completion|.
7155
Bram Moolenaar071d4272004-06-13 20:20:40 +00007156 *'winaltkeys'* *'wak'*
7157'winaltkeys' 'wak' string (default "menu")
7158 global
7159 {not in Vi}
7160 {only used in Win32, Motif, GTK and Photon GUI}
7161 Some GUI versions allow the access to menu entries by using the ALT
7162 key in combination with a character that appears underlined in the
7163 menu. This conflicts with the use of the ALT key for mappings and
7164 entering special characters. This option tells what to do:
7165 no Don't use ALT keys for menus. ALT key combinations can be
7166 mapped, but there is no automatic handling. This can then be
7167 done with the |:simalt| command.
7168 yes ALT key handling is done by the windowing system. ALT key
7169 combinations cannot be mapped.
7170 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 keys can be mapped.
7173 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7174 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007175 This option is not used for <F10>; on Win32 and with GTK <F10> will
7176 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007178 *'window'* *'wi'*
7179'window' 'wi' number (default screen height - 1)
7180 global
7181 Window height. Do not confuse this with the height of the Vim window,
7182 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007183 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7184 value is smaller than 'lines' minus one. The screen will scroll
7185 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007186 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7187 in a much smarter way, taking care of wrapping lines.
7188 When resizing the Vim window, the value is smaller than 1 or more than
7189 or equal to 'lines' it will be set to 'lines' minus 1.
7190 {Vi also uses the option to specify the number of displayed lines}
7191
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 *'winheight'* *'wh'* *E591*
7193'winheight' 'wh' number (default 1)
7194 global
7195 {not in Vi}
7196 {not available when compiled without the +windows
7197 feature}
7198 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007199 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 current window is smaller, its size is increased, at the cost of the
7201 height of other windows. Set it to 999 to make the current window
7202 always fill the screen (although this has the drawback that ":all"
7203 will create only two windows). Set it to a small number for normal
7204 editing.
7205 Minimum value is 1.
7206 The height is not adjusted after one of the commands to change the
7207 height of the current window.
7208 'winheight' applies to the current window. Use 'winminheight' to set
7209 the minimal height for other windows.
7210
7211 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7212'winfixheight' 'wfh' boolean (default off)
7213 local to window
7214 {not in Vi}
7215 {not available when compiled without the +windows
7216 feature}
7217 Keep the window height when windows are opened or closed and
7218 'equalalways' is set. Set by default for the |preview-window| and
7219 |quickfix-window|.
7220 The height may be changed anyway when running out of room.
7221
7222 *'winminheight'* *'wmh'*
7223'winminheight' 'wmh' number (default 1)
7224 global
7225 {not in Vi}
7226 {not available when compiled without the +windows
7227 feature}
7228 The minimal height of a window, when it's not the current window.
7229 This is a hard minimum, windows will never become smaller.
7230 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7231 status bar) if necessary. They will return to at least one line when
7232 they become active (since the cursor has to have somewhere to go.)
7233 Use 'winheight' to set the minimal height of the current window.
7234 This option is only checked when making a window smaller. Don't use a
7235 large number, it will cause errors when opening more than a few
7236 windows. A value of 0 to 3 is reasonable.
7237
7238 *'winminwidth'* *'wmw'*
7239'winminwidth' 'wmw' number (default 1)
7240 global
7241 {not in Vi}
7242 {not available when compiled without the +vertsplit
7243 feature}
7244 The minimal width of a window, when it's not the current window.
7245 This is a hard minimum, windows will never become smaller.
7246 When set to zero, windows may be "squashed" to zero columns (i.e. just
7247 a vertical separator) if necessary. They will return to at least one
7248 line when they become active (since the cursor has to have somewhere
7249 to go.)
7250 Use 'winwidth' to set the minimal width of the current window.
7251 This option is only checked when making a window smaller. Don't use a
7252 large number, it will cause errors when opening more than a few
7253 windows. A value of 0 to 12 is reasonable.
7254
7255 *'winwidth'* *'wiw'* *E592*
7256'winwidth' 'wiw' number (default 20)
7257 global
7258 {not in Vi}
7259 {not available when compiled without the +vertsplit
7260 feature}
7261 Minimal number of columns for the current window. This is not a hard
7262 minimum, Vim will use fewer columns if there is not enough room. If
7263 the current window is smaller, its size is increased, at the cost of
7264 the width of other windows. Set it to 999 to make the current window
7265 always fill the screen. Set it to a small number for normal editing.
7266 The width is not adjusted after one of the commands to change the
7267 width of the current window.
7268 'winwidth' applies to the current window. Use 'winminwidth' to set
7269 the minimal width for other windows.
7270
7271 *'wrap'* *'nowrap'*
7272'wrap' boolean (default on)
7273 local to window
7274 {not in Vi}
7275 This option changes how text is displayed. It doesn't change the text
7276 in the buffer, see 'textwidth' for that.
7277 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007278 displaying continues on the next line. When off lines will not wrap
7279 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007280 moved to a part that is not shown, the screen will scroll
7281 horizontally.
7282 The line will be broken in the middle of a word if necessary. See
7283 'linebreak' to get the break at a word boundary.
7284 To make scrolling horizontally a bit more useful, try this: >
7285 :set sidescroll=5
7286 :set listchars+=precedes:<,extends:>
7287< See 'sidescroll', 'listchars' and |wrap-off|.
7288
7289 *'wrapmargin'* *'wm'*
7290'wrapmargin' 'wm' number (default 0)
7291 local to buffer
7292 Number of characters from the right window border where wrapping
7293 starts. When typing text beyond this limit, an <EOL> will be inserted
7294 and inserting continues on the next line.
7295 Options that add a margin, such as 'number' and 'foldcolumn', cause
7296 the text width to be further reduced. This is Vi compatible.
7297 When 'textwidth' is non-zero, this option is not used.
7298 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7299 and less usefully}
7300
7301 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7302'wrapscan' 'ws' boolean (default on) *E384* *E385*
7303 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007304 Searches wrap around the end of the file. Also applies to |]s| and
7305 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306
7307 *'write'* *'nowrite'*
7308'write' boolean (default on)
7309 global
7310 {not in Vi}
7311 Allows writing files. When not set, writing a file is not allowed.
7312 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007313 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 argument. Filtering text is still possible, even though this requires
7315 writing a temporary file.
7316
7317 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7318'writeany' 'wa' boolean (default off)
7319 global
7320 Allows writing to any file with no need for "!" override.
7321
7322 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7323'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7324 otherwise)
7325 global
7326 {not in Vi}
7327 Make a backup before overwriting a file. The backup is removed after
7328 the file was successfully written, unless the 'backup' option is
7329 also on. Reset this option if your file system is almost full. See
7330 |backup-table| for another explanation.
7331 When the 'backupskip' pattern matches, a backup is not made anyway.
7332 NOTE: This option is set to the default value when 'compatible' is
7333 set.
7334
7335 *'writedelay'* *'wd'*
7336'writedelay' 'wd' number (default 0)
7337 global
7338 {not in Vi}
7339 The number of microseconds to wait for each character sent to the
7340 screen. When non-zero, characters are sent to the terminal one by
7341 one. For MS-DOS pcterm this does not work. For debugging purposes.
7342
7343 vim:tw=78:ts=8:ft=help:norl: