blob: 50bae207d8767a16c5f91ad66bb7b842fe537067 [file] [log] [blame]
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Oct 02
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==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
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 Moolenaar578b49e2005-09-10 19:22:57 +0000563Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000565Not all options are supported in all versions. This depends on the supported
566features and sometimes on the system. A remark about this is in curly braces
567below. When an option is not supported it may still be set without getting an
568error, this is called a hidden option. You can't get the value of a hidden
569option though, it is not stored.
570
571To test if option "foo" can be used with ":set" use something like this: >
572 if exists('&foo')
573This also returns true for a hidden option. To test if option "foo" is really
574supported use something like this: >
575 if exists('+foo')
576<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577 *E355*
578A jump table for the options with a short description can be found at |Q_op|.
579
580 *'aleph'* *'al'* *aleph* *Aleph*
581'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
582 global
583 {not in Vi}
584 {only available when compiled with the |+rightleft|
585 feature}
586 The ASCII code for the first letter of the Hebrew alphabet. The
587 routine that maps the keyboard in Hebrew mode, both in Insert mode
588 (when hkmap is set) and on the command-line (when hitting CTRL-_)
589 outputs the Hebrew characters in the range [aleph..aleph+26].
590 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
591 See |rileft.txt|.
592
593 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
594'allowrevins' 'ari' boolean (default off)
595 global
596 {not in Vi}
597 {only available when compiled with the |+rightleft|
598 feature}
599 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
600 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
601 into reverse Insert mode, and don't know how to get out. See
602 'revins'.
603 NOTE: This option is reset when 'compatible' is set.
604
605 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
606'altkeymap' 'akm' boolean (default off)
607 global
608 {not in Vi}
609 {only available when compiled with the |+farsi|
610 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000611 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 the keyboard map between Farsi and English, when 'allowrevins' set.
613
Bram Moolenaar582fd852005-03-28 20:58:01 +0000614 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 is useful to start the Vim in native mode i.e. English (left-to-right
616 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000617 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
619 *'ambiwidth'* *'ambw'*
620'ambiwidth' 'ambw' string (default: "single")
621 global
622 {not in Vi}
623 {only available when compiled with the |+multi_byte|
624 feature}
625 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
626 Tells Vim what to do with characters with East Asian Width Class
627 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
628 letters, Cyrillic letters).
629
630 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000631 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 expected by most users.
633 "double": Use twice the width of ASCII characters.
634
635 There are a number of CJK fonts for which the width of glyphs for
636 those characters are solely based on how many octets they take in
637 legacy/traditional CJK encodings. In those encodings, Euro,
638 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000639 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000641 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 Vim is running inside a terminal (emulators) that uses a CJK font
643 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
644 this option should be set to "double" to match the width perceived
645 by Vim with the width of glyphs in the font. Perhaps it also has
646 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
647 when the system locale is set to one of CJK locales. See Unicode
648 Standard Annex #11 (http://www.unicode.org/reports/tr11).
649
650 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
651'antialias' 'anti' boolean (default: off)
652 global
653 {not in Vi}
654 {only available when compiled with GUI enabled
655 on Mac OS X}
656 This option only has an effect in the GUI version of Vim on Mac OS X
657 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
658 which can be easier to read at certain sizes on certain displays.
659 Setting this option can sometimes cause problems if 'guifont' is set
660 to its default (empty string).
661
662 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
663'autochdir' 'acd' boolean (default off)
664 global
665 {not in Vi}
666 {only available when compiled with the
667 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000668 When on, Vim will change the current working directory whenever you
669 open a file, switch buffers, delete a buffer or open/close a window.
670 It will change to the directory containing the file which was opened
671 or selected.
672 This option is provided for backward compatibility with the Vim
673 released with Sun ONE Studio 4 Enterprise Edition.
674 Note: When this option is on some plugins may not work. The directory
675 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676
677 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
678'arabic' 'arab' boolean (default off)
679 local to window
680 {not in Vi}
681 {only available when compiled with the |+arabic|
682 feature}
683 This option can be set to start editing Arabic text.
684 Setting this option will:
685 - Set the 'rightleft' option, unless 'termbidi' is set.
686 - Set the 'arabicshape' option, unless 'termbidi' is set.
687 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
688 between typing English and Arabic key mapping.
689 - Set the 'delcombine' option
690 Note that 'encoding' must be "utf-8" for working with Arabic text.
691
692 Resetting this option will:
693 - Reset the 'rightleft' option.
694 - Disable the use of 'keymap' (without changing its value).
695 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
696 option.
697 Also see |arabic.txt|.
698
699 *'arabicshape'* *'arshape'*
700 *'noarabicshape'* *'noarshape'*
701'arabicshape' 'arshape' boolean (default on)
702 global
703 {not in Vi}
704 {only available when compiled with the |+arabic|
705 feature}
706 When on and 'termbidi' is off, the required visual character
707 corrections that need to take place for displaying the Arabic language
708 take affect. Shaping, in essence, gets enabled; the term is a broad
709 one which encompasses:
710 a) the changing/morphing of characters based on their location
711 within a word (initial, medial, final and stand-alone).
712 b) the enabling of the ability to compose characters
713 c) the enabling of the required combining of some characters
714 When disabled the character display reverts back to each character's
715 true stand-alone form.
716 Arabic is a complex language which requires other settings, for
717 further details see |arabic.txt|.
718
719 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
720'autoindent' 'ai' boolean (default off)
721 local to buffer
722 Copy indent from current line when starting a new line (typing <CR>
723 in Insert mode or when using the "o" or "O" command). If you do not
724 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000725 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
726 another line has the same effect, unless the 'I' flag is included in
727 'cpoptions'.
728 When autoindent is on, formatting (with the "gq" command or when you
729 reach 'textwidth' in Insert mode) uses the indentation of the first
730 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 When 'smartindent' or 'cindent' is on the indent is changed in
732 a different way.
733 The 'autoindent' option is reset when the 'paste' option is set.
734 {small difference from Vi: After the indent is deleted when typing
735 <Esc> or <CR>, the cursor position when moving up or down is after the
736 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
737
738 *'autoread'* *'ar'* *'noautoread'* *'noar'*
739'autoread' 'ar' boolean (default off)
740 global or local to buffer |global-local|
741 {not in Vi}
742 When a file has been detected to have been changed outside of Vim and
743 it has not been changed inside of Vim, automatically read it again.
744 When the file has been deleted this is not done. |timestamp|
745 If this option has a local value, use this command to switch back to
746 using the global value: >
747 :set autoread<
748<
749 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
750'autowrite' 'aw' boolean (default off)
751 global
752 Write the contents of the file, if it has been modified, on each
753 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
754 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
755 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
756 Note that for some commands the 'autowrite' option is not used, see
757 'autowriteall' for that.
758
759 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
760'autowriteall' 'awa' boolean (default off)
761 global
762 {not in Vi}
763 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
764 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
765 Setting this option also implies that Vim behaves like 'autowrite' has
766 been set.
767
768 *'background'* *'bg'*
769'background' 'bg' string (default "dark" or "light")
770 global
771 {not in Vi}
772 When set to "dark", Vim will try to use colors that look good on a
773 dark background. When set to "light", Vim will try to use colors that
774 look good on a light background. Any other value is illegal.
775 Vim tries to set the default value according to the terminal used.
776 This will not always be correct.
777 Setting this option does not change the background color, it tells Vim
778 what the background color looks like. For changing the background
779 color, see |:hi-normal|.
780
781 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000782 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 change.
784 When a color scheme is loaded (the "colors_name" variable is set)
785 setting 'background' will cause the color scheme to be reloaded. If
786 the color scheme adjusts to the value of 'background' this will work.
787 However, if the color scheme sets 'background' itself the effect may
788 be undone. First delete the "colors_name" variable when needed.
789
790 When setting 'background' to the default value with: >
791 :set background&
792< Vim will guess the value. In the GUI this should work correctly,
793 in other cases Vim might not be able to guess the right value.
794
795 When starting the GUI, the default value for 'background' will be
796 "light". When the value is not set in the .gvimrc, and Vim detects
797 that the background is actually quite dark, 'background' is set to
798 "dark". But this happens only AFTER the .gvimrc file has been read
799 (because the window needs to be opened to find the actual background
800 color). To get around this, force the GUI window to be opened by
801 putting a ":gui" command in the .gvimrc file, before where the value
802 of 'background' is used (e.g., before ":syntax on").
803 Normally this option would be set in the .vimrc file. Possibly
804 depending on the terminal name. Example: >
805 :if &term == "pcterm"
806 : set background=dark
807 :endif
808< When this option is set, the default settings for the highlight groups
809 will change. To use other settings, place ":highlight" commands AFTER
810 the setting of the 'background' option.
811 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
812 to select the colors for syntax highlighting. After changing this
813 option, you must load syntax.vim again to see the result. This can be
814 done with ":syntax on".
815
816 *'backspace'* *'bs'*
817'backspace' 'bs' string (default "")
818 global
819 {not in Vi}
820 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
821 mode. This is a list of items, separated by commas. Each item allows
822 a way to backspace over something:
823 value effect ~
824 indent allow backspacing over autoindent
825 eol allow backspacing over line breaks (join lines)
826 start allow backspacing over the start of insert; CTRL-W and CTRL-U
827 stop once at the start of insert.
828
829 When the value is empty, Vi compatible backspacing is used.
830
831 For backwards compatibility with version 5.4 and earlier:
832 value effect ~
833 0 same as ":set backspace=" (Vi compatible)
834 1 same as ":set backspace=indent,eol"
835 2 same as ":set backspace=indent,eol,start"
836
837 See |:fixdel| if your <BS> or <Del> key does not do what you want.
838 NOTE: This option is set to "" when 'compatible' is set.
839
840 *'backup'* *'bk'* *'nobackup'* *'nobk'*
841'backup' 'bk' boolean (default off)
842 global
843 {not in Vi}
844 Make a backup before overwriting a file. Leave it around after the
845 file has been successfully written. If you do not want to keep the
846 backup file, but you do want a backup while the file is being
847 written, reset this option and set the 'writebackup' option (this is
848 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 |backup-table| for more explanations.
851 When the 'backupskip' pattern matches, a backup is not made anyway.
852 When 'patchmode' is set, the backup may be renamed to become the
853 oldest version of a file.
854 NOTE: This option is reset when 'compatible' is set.
855
856 *'backupcopy'* *'bkc'*
857'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
858 global
859 {not in Vi}
860 When writing a file and a backup is made, this option tells how it's
861 done. This is a comma separated list of words.
862
863 The main values are:
864 "yes" make a copy of the file and overwrite the original one
865 "no" rename the file and write a new one
866 "auto" one of the previous, what works best
867
868 Extra values that can be combined with the ones above are:
869 "breaksymlink" always break symlinks when writing
870 "breakhardlink" always break hardlinks when writing
871
872 Making a copy and overwriting the original file:
873 - Takes extra time to copy the file.
874 + When the file has special attributes, is a (hard/symbolic) link or
875 has a resource fork, all this is preserved.
876 - When the file is a link the backup will have the name of the link,
877 not of the real file.
878
879 Renaming the file and writing a new one:
880 + It's fast.
881 - Sometimes not all attributes of the file can be copied to the new
882 file.
883 - When the file is a link the new file will not be a link.
884
885 The "auto" value is the middle way: When Vim sees that renaming file
886 is possible without side effects (the attributes can be passed on and
887 and the file is not a link) that is used. When problems are expected,
888 a copy will be made.
889
890 The "breaksymlink" and "breakhardlink" values can be used in
891 combination with any of "yes", "no" and "auto". When included, they
892 force Vim to always break either symbolic or hard links by doing
893 exactly what the "no" option does, renaming the original file to
894 become the backup and writing a new file in its place. This can be
895 useful for example in source trees where all the files are symbolic or
896 hard links and any changes should stay in the local source tree, not
897 be propagated back to the original source.
898 *crontab*
899 One situation where "no" and "auto" will cause problems: A program
900 that opens a file, invokes Vim to edit that file, and then tests if
901 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000902 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 example.
904
905 When a copy is made, the original file is truncated and then filled
906 with the new text. This means that protection bits, owner and
907 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000908 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 group of the backup is set to the group of the original file. If this
910 fails, the protection bits for the group are made the same as for
911 others.
912
913 When the file is renamed this is the other way around: The backup has
914 the same attributes of the original file, and the newly written file
915 is owned by the current user. When the file was a (hard/symbolic)
916 link, the new file will not! That's why the "auto" value doesn't
917 rename when the file is a link. The owner and group of the newly
918 written file will be set to the same ones as the original file, but
919 the system may refuse to do this. In that case the "auto" value will
920 again not rename the file.
921
922 *'backupdir'* *'bdir'*
923'backupdir' 'bdir' string (default for Amiga: ".,t:",
924 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
925 for Unix: ".,~/tmp,~/")
926 global
927 {not in Vi}
928 List of directories for the backup file, separated with commas.
929 - The backup file will be created in the first directory in the list
930 where this is possible.
931 - Empty means that no backup file will be created ('patchmode' is
932 impossible!). Writing may fail because of this.
933 - A directory "." means to put the backup file in the same directory
934 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000935 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 put the backup file relative to where the edited file is. The
937 leading "." is replaced with the path name of the edited file.
938 ("." inside a directory name has no special meaning).
939 - Spaces after the comma are ignored, other spaces are considered part
940 of the directory name. To have a space at the start of a directory
941 name, precede it with a backslash.
942 - To include a comma in a directory name precede it with a backslash.
943 - A directory name may end in an '/'.
944 - Environment variables are expanded |:set_env|.
945 - Careful with '\' characters, type one before a space, type two to
946 get one in the option (see |option-backslash|), for example: >
947 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
948< - For backwards compatibility with Vim version 3.0 a '>' at the start
949 of the option is removed.
950 See also 'backup' and 'writebackup' options.
951 If you want to hide your backup files on Unix, consider this value: >
952 :set backupdir=./.backup,~/.backup,.,/tmp
953< You must create a ".backup" directory in each directory and in your
954 home directory for this to work properly.
955 The use of |:set+=| and |:set-=| is preferred when adding or removing
956 directories from the list. This avoids problems when a future version
957 uses another default.
958 This option cannot be set from a |modeline| or in the |sandbox|, for
959 security reasons.
960
961 *'backupext'* *'bex'* *E589*
962'backupext' 'bex' string (default "~", for VMS: "_")
963 global
964 {not in Vi}
965 String which is appended to a file name to make the name of the
966 backup file. The default is quite unusual, because this avoids
967 accidentally overwriting existing files with a backup file. You might
968 prefer using ".bak", but make sure that you don't have files with
969 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000970 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000972 If you like to keep a lot of backups, you could use a BufWritePre
973 autocommand to change 'backupext' just before writing the file to
974 include a timestamp. >
975 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
976< Use 'backupdir' to put the backup in a different directory.
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 *'backupskip'* *'bsk'*
979'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
980 global
981 {not in Vi}
982 {not available when compiled without the |+wildignore|
983 feature}
984 A list of file patterns. When one of the patterns matches with the
985 name of the file which is written, no backup file is created. Both
986 the specified file name and the full path name of the file are used.
987 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
988 Watch out for special characters, see |option-backslash|.
989 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000990 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991
992 *'balloondelay'* *'bdlay'*
993'balloondelay' 'bdlay' number (default: 600)
994 global
995 {not in Vi}
996 {only available when compiled with the |+balloon_eval|
997 feature}
998 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
999
1000 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1001'ballooneval' 'beval' boolean (default off)
1002 global
1003 {not in Vi}
1004 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001005 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Switch on the |balloon-eval| functionality.
1007
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001008 *'balloonexpr'* *'bexpr'*
1009'balloonexpr' 'bexpr' string (default "")
1010 global
1011 {not in Vi}
1012 {only available when compiled with the |+balloon_eval|
1013 feature}
1014 Expression to show in evaluation balloon. It is only used when
1015 'ballooneval' is on. These variables can be used:
1016
1017 v:beval_bufnr number of the buffer in which balloon is going to show
1018 v:beval_winnr number of the window
1019 v:beval_lnum line number
1020 v:beval_col column number (byte index)
1021 v:beval_text word under or after the mouse pointer
1022
1023 The evaluation of the expression must not have side effects!
1024 Example: >
1025 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001026 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001027 \', column ' . v:beval_col .
1028 \ ' of file ' . bufname(v:beval_bufnr) .
1029 \ ' on word "' . v:beval_text . '"'
1030 endfunction
1031 set bexpr=MyBalloonExpr()
1032 set ballooneval
1033<
1034 NOTE: The balloon is displayed only if the cursor is on a text
1035 character. If the result of evaluating 'balloonexpr' is not empty,
1036 Vim does not try to send a message to an external debugger (Netbeans
1037 or Sun Workshop).
1038
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001039 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001040 if has("balloon_multiline")
1041<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1043'binary' 'bin' boolean (default off)
1044 local to buffer
1045 {not in Vi}
1046 This option should be set before editing a binary file. You can also
1047 use the |-b| Vim argument. When this option is switched on a few
1048 options will be changed (also when it already was on):
1049 'textwidth' will be set to 0
1050 'wrapmargin' will be set to 0
1051 'modeline' will be off
1052 'expandtab' will be off
1053 Also, 'fileformat' and 'fileformats' options will not be used, the
1054 file is read and written like 'fileformat' was "unix" (a single <NL>
1055 separates lines).
1056 The 'fileencoding' and 'fileencodings' options will not be used, the
1057 file is read without conversion.
1058 NOTE: When you start editing a(nother) file while the 'bin' option is
1059 on, settings from autocommands may change the settings again (e.g.,
1060 'textwidth'), causing trouble when editing. You might want to set
1061 'bin' again when the file has been loaded.
1062 The previous values of these options are remembered and restored when
1063 'bin' is switched from on to off. Each buffer has its own set of
1064 saved option values.
1065 To edit a file with 'binary' set you can use the |++bin| argument.
1066 This avoids you have to do ":set bin", which would have effect for all
1067 files you edit.
1068 When writing a file the <EOL> for the last line is only written if
1069 there was one in the original file (normally Vim appends an <EOL> to
1070 the last line if there is none; this would make the file longer). See
1071 the 'endofline' option.
1072
1073 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1074'bioskey' 'biosk' boolean (default on)
1075 global
1076 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001077 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 better to detect CTRL-C, but only works for the console. When using a
1079 terminal over a serial port reset this option.
1080 Also see |'conskey'|.
1081
1082 *'bomb'* *'nobomb'*
1083'bomb' boolean (default off)
1084 local to buffer
1085 {not in Vi}
1086 {only available when compiled with the |+multi_byte|
1087 feature}
1088 When writing a file and the following conditions are met, a BOM (Byte
1089 Order Mark) is prepended to the file:
1090 - this option is on
1091 - the 'binary' option is off
1092 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1093 endian variants.
1094 Some applications use the BOM to recognize the encoding of the file.
1095 Often used for UCS-2 files on MS-Windows. For other applications it
1096 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1097 appear halfway the resulting file.
1098 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1099 check for the presence of the BOM is done and 'bomb' set accordingly.
1100 Unless 'binary' is set, it is removed from the first line, so that you
1101 don't see it when editing. When you don't change the options, the BOM
1102 will be restored when writing the file.
1103
1104 *'breakat'* *'brk'*
1105'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1106 global
1107 {not in Vi}
1108 {not available when compiled without the |+linebreak|
1109 feature}
1110 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001111 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1112 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113
1114 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001115'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 global
1117 {not in Vi} {only for Motif and Win32 GUI}
1118 Which directory to use for the file browser:
1119 last Use same directory as with last file browser.
1120 buffer Use the directory of the related buffer.
1121 current Use the current directory.
1122 {path} Use the specified directory
1123
1124 *'bufhidden'* *'bh'*
1125'bufhidden' 'bh' string (default: "")
1126 local to buffer
1127 {not in Vi}
1128 {not available when compiled without the |+quickfix|
1129 feature}
1130 This option specifies what happens when a buffer is no longer
1131 displayed in a window:
1132 <empty> follow the global 'hidden' option
1133 hide hide the buffer (don't unload it), also when 'hidden'
1134 is not set
1135 unload unload the buffer, also when 'hidden' is set or using
1136 |:hide|
1137 delete delete the buffer from the buffer list, also when
1138 'hidden' is set or using |:hide|, like using
1139 |:bdelete|
1140 wipe wipe out the buffer from the buffer list, also when
1141 'hidden' is set or using |:hide|, like using
1142 |:bwipeout|
1143
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001144 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1145 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 This option is used together with 'buftype' and 'swapfile' to specify
1147 special kinds of buffers. See |special-buffers|.
1148
1149 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1150'buflisted' 'bl' boolean (default: on)
1151 local to buffer
1152 {not in Vi}
1153 When this option is set, the buffer shows up in the buffer list. If
1154 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1155 This option is reset by Vim for buffers that are only used to remember
1156 a file name or marks. Vim sets it when starting to edit a buffer.
1157 But not when moving to a buffer with ":buffer".
1158
1159 *'buftype'* *'bt'* *E382*
1160'buftype' 'bt' string (default: "")
1161 local to buffer
1162 {not in Vi}
1163 {not available when compiled without the |+quickfix|
1164 feature}
1165 The value of this option specifies the type of a buffer:
1166 <empty> normal buffer
1167 nofile buffer which is not related to a file and will not be
1168 written
1169 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001170 acwrite buffer which will always be written with BufWriteCmd
1171 autocommands. {not available when compiled without the
1172 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 quickfix quickfix buffer, contains list of errors |:cwindow|
1174 help help buffer (you are not supposed to set this
1175 manually)
1176
1177 This option is used together with 'bufhidden' and 'swapfile' to
1178 specify special kinds of buffers. See |special-buffers|.
1179
1180 Be careful with changing this option, it can have many side effects!
1181
1182 A "quickfix" buffer is only used for the error list. This value is
1183 set by the |:cwindow| command and you are not supposed to change it.
1184
1185 "nofile" and "nowrite" buffers are similar:
1186 both: The buffer is not to be written to disk, ":w" doesn't
1187 work (":w filename" does work though).
1188 both: The buffer is never considered to be |'modified'|.
1189 There is no warning when the changes will be lost, for
1190 example when you quit Vim.
1191 both: A swap file is only created when using too much memory
1192 (when 'swapfile' has been reset there is never a swap
1193 file).
1194 nofile only: The buffer name is fixed, it is not handled like a
1195 file name. It is not modified in response to a |:cd|
1196 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001197 *E676*
1198 "acwrite" implies that the buffer name is not related to a file, like
1199 "nofile", but it will be written. Thus, in contrast to "nofile" and
1200 "nowrite", ":w" does work and a modified buffer can't be abandoned
1201 without saving. For writing there must be matching |BufWriteCmd|,
1202 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
1204 *'casemap'* *'cmp'*
1205'casemap' 'cmp' string (default: "internal,keepascii")
1206 global
1207 {not in Vi}
1208 Specifies details about changing the case of letters. It may contain
1209 these words, separated by a comma:
1210 internal Use internal case mapping functions, the current
1211 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001212 matters when 'encoding' is a Unicode encoding,
1213 "latin1" or "iso-8859-15". When "internal" is
1214 omitted, the towupper() and towlower() system library
1215 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1217 case mapping, the current locale is not effective.
1218 This probably only matters for Turkish.
1219
1220 *'cdpath'* *'cd'* *E344* *E346*
1221'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1222 global
1223 {not in Vi}
1224 {not available when compiled without the
1225 |+file_in_path| feature}
1226 This is a list of directories which will be searched when using the
1227 |:cd| and |:lcd| commands, provided that the directory being searched
1228 for has a relative path (not starting with "/", "./" or "../").
1229 The 'cdpath' option's value has the same form and semantics as
1230 |'path'|. Also see |file-searching|.
1231 The default value is taken from $CDPATH, with a "," prepended to look
1232 in the current directory first.
1233 If the default value taken from $CDPATH is not what you want, include
1234 a modified version of the following command in your vimrc file to
1235 override it: >
1236 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1237< This option cannot be set from a |modeline| or in the |sandbox|, for
1238 security reasons.
1239 (parts of 'cdpath' can be passed to the shell to expand file names).
1240
1241 *'cedit'*
1242'cedit' string (Vi default: "", Vim default: CTRL-F)
1243 global
1244 {not in Vi}
1245 {not available when compiled without the |+vertsplit|
1246 feature}
1247 The key used in Command-line Mode to open the command-line window.
1248 The default is CTRL-F when 'compatible' is off.
1249 Only non-printable keys are allowed.
1250 The key can be specified as a single character, but it is difficult to
1251 type. The preferred way is to use the <> notation. Examples: >
1252 :set cedit=<C-Y>
1253 :set cedit=<Esc>
1254< |Nvi| also has this option, but it only uses the first character.
1255 See |cmdwin|.
1256
1257 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1258'charconvert' 'ccv' string (default "")
1259 global
1260 {only available when compiled with the |+multi_byte|
1261 feature and the |+eval| feature}
1262 {not in Vi}
1263 An expression that is used for character encoding conversion. It is
1264 evaluated when a file that is to be read or has been written has a
1265 different encoding from what is desired.
1266 'charconvert' is not used when the internal iconv() function is
1267 supported and is able to do the conversion. Using iconv() is
1268 preferred, because it is much faster.
1269 'charconvert' is not used when reading stdin |--|, because there is no
1270 file to convert from. You will have to save the text in a file first.
1271 The expression must return zero or an empty string for success,
1272 non-zero for failure.
1273 The possible encoding names encountered are in 'encoding'.
1274 Additionally, names given in 'fileencodings' and 'fileencoding' are
1275 used.
1276 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1277 is done internally by Vim, 'charconvert' is not used for this.
1278 'charconvert' is also used to convert the viminfo file, if the 'c'
1279 flag is present in 'viminfo'. Also used for Unicode conversion.
1280 Example: >
1281 set charconvert=CharConvert()
1282 fun CharConvert()
1283 system("recode "
1284 \ . v:charconvert_from . ".." . v:charconvert_to
1285 \ . " <" . v:fname_in . " >" v:fname_out)
1286 return v:shell_error
1287 endfun
1288< The related Vim variables are:
1289 v:charconvert_from name of the current encoding
1290 v:charconvert_to name of the desired encoding
1291 v:fname_in name of the input file
1292 v:fname_out name of the output file
1293 Note that v:fname_in and v:fname_out will never be the same.
1294 Note that v:charconvert_from and v:charconvert_to may be different
1295 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1296 Encryption is not done by Vim when using 'charconvert'. If you want
1297 to encrypt the file after conversion, 'charconvert' should take care
1298 of this.
1299 This option cannot be set from a |modeline| or in the |sandbox|, for
1300 security reasons.
1301
1302 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1303'cindent' 'cin' boolean (default off)
1304 local to buffer
1305 {not in Vi}
1306 {not available when compiled without the |+cindent|
1307 feature}
1308 Enables automatic C program indenting See 'cinkeys' to set the keys
1309 that trigger reindenting in insert mode and 'cinoptions' to set your
1310 preferred indent style.
1311 If 'indentexpr' is not empty, it overrules 'cindent'.
1312 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1313 the "=" operator indents using this algorithm rather than calling an
1314 external program.
1315 See |C-indenting|.
1316 When you don't like the way 'cindent' works, try the 'smartindent'
1317 option or 'indentexpr'.
1318 This option is not used when 'paste' is set.
1319 NOTE: This option is reset when 'compatible' is set.
1320
1321 *'cinkeys'* *'cink'*
1322'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1323 local to buffer
1324 {not in Vi}
1325 {not available when compiled without the |+cindent|
1326 feature}
1327 A list of keys that, when typed in Insert mode, cause reindenting of
1328 the current line. Only used if 'cindent' is on and 'indentexpr' is
1329 empty.
1330 For the format of this option see |cinkeys-format|.
1331 See |C-indenting|.
1332
1333 *'cinoptions'* *'cino'*
1334'cinoptions' 'cino' string (default "")
1335 local to buffer
1336 {not in Vi}
1337 {not available when compiled without the |+cindent|
1338 feature}
1339 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1340 program. See |cinoptions-values| for the values of this option, and
1341 |C-indenting| for info on C indenting in general.
1342
1343
1344 *'cinwords'* *'cinw'*
1345'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1346 local to buffer
1347 {not in Vi}
1348 {not available when compiled without both the
1349 |+cindent| and the |+smartindent| features}
1350 These keywords start an extra indent in the next line when
1351 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1352 an appropriate place (inside {}).
1353 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1354 matter, include the keyword both the uppercase and lowercase:
1355 "if,If,IF".
1356
1357 *'clipboard'* *'cb'*
1358'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1359 for X-windows, "" otherwise)
1360 global
1361 {not in Vi}
1362 {only in GUI versions or when the |+xterm_clipboard|
1363 feature is included}
1364 This option is a list of comma separated names.
1365 These names are recognized:
1366
1367 unnamed When included, Vim will use the clipboard register '*'
1368 for all yank, delete, change and put operations which
1369 would normally go to the unnamed register. When a
1370 register is explicitly specified, it will always be
1371 used regardless of whether "unnamed" is in 'clipboard'
1372 or not. The clipboard register can always be
1373 explicitly accessed using the "* notation. Also see
1374 |gui-clipboard|.
1375
1376 autoselect Works like the 'a' flag in 'guioptions': If present,
1377 then whenever Visual mode is started, or the Visual
1378 area extended, Vim tries to become the owner of the
1379 windowing system's global selection or put the
1380 selected text on the clipboard used by the selection
1381 register "*. See |guioptions_a| and |quotestar| for
1382 details. When the GUI is active, the 'a' flag in
1383 'guioptions' is used, when the GUI is not active, this
1384 "autoselect" flag is used.
1385 Also applies to the modeless selection.
1386
1387 autoselectml Like "autoselect", but for the modeless selection
1388 only. Compare to the 'A' flag in 'guioptions'.
1389
1390 exclude:{pattern}
1391 Defines a pattern that is matched against the name of
1392 the terminal 'term'. If there is a match, no
1393 connection will be made to the X server. This is
1394 useful in this situation:
1395 - Running Vim in a console.
1396 - $DISPLAY is set to start applications on another
1397 display.
1398 - You do not want to connect to the X server in the
1399 console, but do want this in a terminal emulator.
1400 To never connect to the X server use: >
1401 exclude:.*
1402< This has the same effect as using the |-X| argument.
1403 Note that when there is no connection to the X server
1404 the window title won't be restored and the clipboard
1405 cannot be accessed.
1406 The value of 'magic' is ignored, {pattern} is
1407 interpreted as if 'magic' was on.
1408 The rest of the option value will be used for
1409 {pattern}, this must be the last entry.
1410
1411 *'cmdheight'* *'ch'*
1412'cmdheight' 'ch' number (default 1)
1413 global
1414 {not in Vi}
1415 Number of screen lines to use for the command-line. Helps avoiding
1416 |hit-enter| prompts.
1417
1418 *'cmdwinheight'* *'cwh'*
1419'cmdwinheight' 'cwh' number (default 7)
1420 global
1421 {not in Vi}
1422 {not available when compiled without the |+vertsplit|
1423 feature}
1424 Number of screen lines to use for the command-line window. |cmdwin|
1425
1426 *'columns'* *'co'* *E594*
1427'columns' 'co' number (default 80 or terminal width)
1428 global
1429 {not in Vi}
1430 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001431 initialization and does not have to be set by hand. Also see
1432 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 When Vim is running in the GUI or in a resizable window, setting this
1434 option will cause the window size to be changed. When you only want
1435 to use the size for the GUI, put the command in your |gvimrc| file.
1436 When you set this option and Vim is unable to change the physical
1437 number of columns of the display, the display may be messed up.
1438
1439 *'comments'* *'com'* *E524* *E525*
1440'comments' 'com' string (default
1441 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1442 local to buffer
1443 {not in Vi}
1444 {not available when compiled without the |+comments|
1445 feature}
1446 A comma separated list of strings that can start a comment line. See
1447 |format-comments|. See |option-backslash| about using backslashes to
1448 insert a space.
1449
1450 *'commentstring'* *'cms'* *E537*
1451'commentstring' 'cms' string (default "/*%s*/")
1452 local to buffer
1453 {not in Vi}
1454 {not available when compiled without the |+folding|
1455 feature}
1456 A template for a comment. The "%s" in the value is replaced with the
1457 comment text. Currently only used to add markers for folding, see
1458 |fold-marker|.
1459
1460 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001461'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1462 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 global
1464 {not in Vi}
1465 This option has the effect of making Vim either more Vi-compatible, or
1466 make Vim behave in a more useful way.
1467 This is a special kind of option, because when it's set or reset,
1468 other options are also changed as a side effect. CAREFUL: Setting or
1469 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001470 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 set this option in your vimrc file, you should probably put it at the
1472 very start.
1473 By default this option is on and the Vi defaults are used for the
1474 options. This default was chosen for those people who want to use Vim
1475 just like Vi, and don't even (want to) know about the 'compatible'
1476 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001477 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1478 this option is switched off, and all options that have not been
1479 modified will be set to the Vim defaults. Effectively, this means
1480 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1481 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1482 happen for the system-wide vimrc or gvimrc file). Also see
1483 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 You can also set this option with the "-C" argument, and reset it with
1485 "-N". See |-C| and |-N|.
1486 Switching this option off makes the Vim defaults be used for options
1487 that have a different Vi and Vim default value. See the options
1488 marked with a '+' below. Other options are not modified.
1489 At the moment this option is set, several other options will be set
1490 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001491 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 editing.
1493 See also 'cpoptions'.
1494
1495 option + set value effect ~
1496
1497 'allowrevins' off no CTRL-_ command
1498 'backupcopy' Unix: "yes" backup file is a copy
1499 others: "auto" copy or rename backup file
1500 'backspace' "" normal backspace
1501 'backup' off no backup file
1502 'cindent' off no C code indentation
1503 'cedit' + "" no key to open the |cmdwin|
1504 'cpoptions' + (all flags) Vi-compatible flags
1505 'cscopetag' off don't use cscope for ":tag"
1506 'cscopetagorder' 0 see |cscopetagorder|
1507 'cscopeverbose' off see |cscopeverbose|
1508 'digraph' off no digraphs
1509 'esckeys' + off no <Esc>-keys in Insert mode
1510 'expandtab' off tabs not expanded to spaces
1511 'fileformats' + "" no automatic file format detection,
1512 "dos,unix" except for DOS, Windows and OS/2
1513 'formatoptions' + "vt" Vi compatible formatting
1514 'gdefault' off no default 'g' flag for ":s"
1515 'history' + 0 no commandline history
1516 'hkmap' off no Hebrew keyboard mapping
1517 'hkmapp' off no phonetic Hebrew keyboard mapping
1518 'hlsearch' off no highlighting of search matches
1519 'incsearch' off no incremental searching
1520 'indentexpr' "" no indenting by expression
1521 'insertmode' off do not start in Insert mode
1522 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1523 characters and '_'
1524 'joinspaces' on insert 2 spaces after period
1525 'modeline' + off no modelines
1526 'more' + off no pauses in listings
1527 'revins' off no reverse insert
1528 'ruler' off no ruler
1529 'scrolljump' 1 no jump scroll
1530 'scrolloff' 0 no scroll offset
1531 'shiftround' off indent not rounded to shiftwidth
1532 'shortmess' + "" no shortening of messages
1533 'showcmd' + off command characters not shown
1534 'showmode' + off current mode not shown
1535 'smartcase' off no automatic ignore case switch
1536 'smartindent' off no smart indentation
1537 'smarttab' off no smart tab size
1538 'softtabstop' 0 tabs are always 'tabstop' positions
1539 'startofline' on goto startofline with some commands
1540 'tagrelative' + off tag file names are not relative
1541 'textauto' + off no automatic textmode detection
1542 'textwidth' 0 no automatic line wrap
1543 'tildeop' off tilde is not an operator
1544 'ttimeout' off no terminal timeout
1545 'whichwrap' + "" left-right movements don't wrap
1546 'wildchar' + CTRL-E only when the current value is <Tab>
1547 use CTRL-E for cmdline completion
1548 'writebackup' on or off depends on +writebackup feature
1549
1550 *'complete'* *'cpt'* *E535*
1551'complete' 'cpt' string (default: ".,w,b,u,t,i")
1552 local to buffer
1553 {not in Vi}
1554 This option specifies how keyword completion |ins-completion| works
1555 when CTRL-P or CTRL-N are used. It is also used for whole-line
1556 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1557 and the places to scan. It is a comma separated list of flags:
1558 . scan the current buffer ('wrapscan' is ignored)
1559 w scan buffers from other windows
1560 b scan other loaded buffers that are in the buffer list
1561 u scan the unloaded buffers that are in the buffer list
1562 U scan the buffers that are not in the buffer list
1563 k scan the files given with the 'dictionary' option
1564 k{dict} scan the file {dict}. Several "k" flags can be given,
1565 patterns are valid too. For example: >
1566 :set cpt=k/usr/dict/*,k~/spanish
1567< s scan the files given with the 'thesaurus' option
1568 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1569 are valid too.
1570 i scan current and included files
1571 d scan current and included files for defined name or macro
1572 |i_CTRL-X_CTRL-D|
1573 ] tag completion
1574 t same as "]"
1575
1576 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1577 not executed, this may lead to unexpected completions from some files
1578 (gzipped files for example). Unloaded buffers are not scanned for
1579 whole-line completion.
1580
1581 The default is ".,w,b,u,t,i", which means to scan:
1582 1. the current buffer
1583 2. buffers in other windows
1584 3. other loaded buffers
1585 4. unloaded buffers
1586 5. tags
1587 6. included files
1588
1589 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001590 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1591 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001593 *'completefunc'* *'cfu'*
1594'completefunc' 'cfu' string (default: empty)
1595 local to buffer
1596 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001597 {not available when compiled without the +eval
1598 or +insert_expand feature}
1599 This option specifies a function to be used for CTRL-X CTRL-U
1600 completion. |i_CTRL-X_CTRL-U|
1601
Bram Moolenaare344bea2005-09-01 20:46:49 +00001602 The function will be invoked with two arguments. First the function
1603 is called to find the start of the text to be completed. Secondly the
1604 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001605
Bram Moolenaare344bea2005-09-01 20:46:49 +00001606 On the first invocation the arguments are:
1607 a:findstart 1
1608 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001609
Bram Moolenaare344bea2005-09-01 20:46:49 +00001610 The function must return the column of where the completion starts.
1611 It must be a number between zero and the cursor column "col('.')".
1612 This involves looking at the characters just before the cursor and
1613 including those characters that could be part of the completed item.
1614 The text between this column and the cursor column will be replaced
1615 with the matches. Return -1 if no completion can be done.
1616
1617 On the second invocation the arguments are:
1618 a:findstart 0
1619 a:base the text with which matches should match, what was
1620 located in the first call
1621
1622 The function must return a List with the matching words. These
1623 matches usually include the "a:base" text. When there are no matches
1624 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001625
Bram Moolenaar572cb562005-08-05 21:35:02 +00001626 When searching for matches takes some time call |complete_add()| to
1627 add each match to the total list. These matches should then not
1628 appear in the returned list! Call |complete_check()| now and then to
1629 allow the user to press a key while still searching for matches. Stop
1630 searching when it returns non-zero.
1631
Bram Moolenaare344bea2005-09-01 20:46:49 +00001632 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001633 This option cannot be set from a |modeline| or in the |sandbox|, for
1634 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001635
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001636 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001637 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001638 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001639 " locate the start of the word
1640 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001641 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001642 while start > 0 && line[start - 1] =~ '\a'
1643 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001644 endwhile
1645 return start
1646 else
1647 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001648 let res = []
1649 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1650 if m =~ '^' . a:base
1651 call add(res, m)
1652 endif
1653 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001654 return res
1655 endif
1656 endfun
1657 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001658<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001659 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001660 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001661 if a:findstart
1662 " locate the start of the word
1663 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001664 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001665 while start > 0 && line[start - 1] =~ '\a'
1666 let start -= 1
1667 endwhile
1668 return start
1669 else
1670 " find months matching with "a:base"
1671 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1672 if m =~ '^' . a:base
1673 call complete_add(m)
1674 endif
1675 sleep 300m " simulate searching for next match
1676 if complete_check()
1677 break
1678 endif
1679 endfor
1680 return []
1681 endif
1682 endfun
1683 set completefunc=CompleteMonths
1684<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001685
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001686 *'completeopt'* *'cot'*
1687'completeopt' 'cot' string (default: "menu")
1688 global
1689 {not in Vi}
1690 Options for Insert mode completion |ins-completion|.
1691 Currently the only supported value is:
1692
1693 menu Use a popup menu to show the possible completions. The
1694 menu is only shown when there is more than one match and
1695 sufficient colors are available. |ins-completion-menu|
1696
1697
Bram Moolenaar071d4272004-06-13 20:20:40 +00001698 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1699'confirm' 'cf' boolean (default off)
1700 global
1701 {not in Vi}
1702 When 'confirm' is on, certain operations that would normally
1703 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1704 instead raise a |dialog| asking if you wish to save the current
1705 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1706 If 'confirm' is off you can still activate confirmation for one
1707 command only (this is most useful in mappings) with the |:confirm|
1708 command.
1709 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1710
1711 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1712'conskey' 'consk' boolean (default off)
1713 global
1714 {not in Vi} {only for MS-DOS}
1715 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001716 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 three methods of console input are available:
1718 'conskey' 'bioskey' action ~
1719 on on or off direct console input
1720 off on BIOS
1721 off off STDIN
1722
1723 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1724'copyindent' 'ci' boolean (default off)
1725 local to buffer
1726 {not in Vi}
1727 Copy the structure of the existing lines indent when autoindenting a
1728 new line. Normally the new indent is reconstructed by a series of
1729 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1730 in which case only spaces are used). Enabling this option makes the
1731 new line copy whatever characters were used for indenting on the
1732 existing line. If the new indent is greater than on the existing
1733 line, the remaining space is filled in the normal manner.
1734 NOTE: 'copyindent' is reset when 'compatible' is set.
1735 Also see 'preserveindent'.
1736
1737 *'cpoptions'* *'cpo'*
1738'cpoptions' 'cpo' string (Vim default: "aABceFs",
1739 Vi default: all flags)
1740 global
1741 {not in Vi}
1742 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001743 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 not being vi-compatible is mostly or sometimes preferred.
1745 'cpoptions' stands for "compatible-options".
1746 Commas can be added for readability.
1747 To avoid problems with flags that are added in the future, use the
1748 "+=" and "-=" feature of ":set" |add-option-flags|.
1749 NOTE: This option is set to the Vi default value when 'compatible' is
1750 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001751 NOTE: This option is set to the POSIX default value at startup when
1752 the Vi default value would be used and the $VIM_POSIX environment
1753 variable exists |posix|. This means tries to behave like the POSIX
1754 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755
1756 contains behavior ~
1757 *cpo-a*
1758 a When included, a ":read" command with a file name
1759 argument will set the alternate file name for the
1760 current window.
1761 *cpo-A*
1762 A When included, a ":write" command with a file name
1763 argument will set the alternate file name for the
1764 current window.
1765 *cpo-b*
1766 b "\|" in a ":map" command is recognized as the end of
1767 the map command. The '\' is included in the mapping,
1768 the text after the '|' is interpreted as the next
1769 command. Use a CTRL-V instead of a backslash to
1770 include the '|' in the mapping. Applies to all
1771 mapping, abbreviation, menu and autocmd commands.
1772 See also |map_bar|.
1773 *cpo-B*
1774 B A backslash has no special meaning in mappings,
1775 abbreviations and the "to" part of the menu commands.
1776 Remove this flag to be able to use a backslash like a
1777 CTRL-V. For example, the command ":map X \<Esc>"
1778 results in X being mapped to:
1779 'B' included: "\^[" (^[ is a real <Esc>)
1780 'B' excluded: "<Esc>" (5 characters)
1781 ('<' excluded in both cases)
1782 *cpo-c*
1783 c Searching continues at the end of any match at the
1784 cursor position, but not further than the start of the
1785 next line. When not present searching continues
1786 one character from the cursor position. With 'c'
1787 "abababababab" only gets three matches when repeating
1788 "/abab", without 'c' there are five matches.
1789 *cpo-C*
1790 C Do not concatenate sourced lines that start with a
1791 backslash. See |line-continuation|.
1792 *cpo-d*
1793 d Using "./" in the 'tags' option doesn't mean to use
1794 the tags file relative to the current file, but the
1795 tags file in the current directory.
1796 *cpo-D*
1797 D Can't use CTRL-K to enter a digraph after Normal mode
1798 commands with a character argument, like |r|, |f| and
1799 |t|.
1800 *cpo-e*
1801 e When executing a register with ":@r", always add a
1802 <CR> to the last line, also when the register is not
1803 linewise. If this flag is not present, the register
1804 is not linewise and the last line does not end in a
1805 <CR>, then the last line is put on the command-line
1806 and can be edited before hitting <CR>.
1807 *cpo-E*
1808 E It is an error when using "y", "d", "c", "g~", "gu" or
1809 "gU" on an Empty region. The operators only work when
1810 at least one character is to be operate on. Example:
1811 This makes "y0" fail in the first column.
1812 *cpo-f*
1813 f When included, a ":read" command with a file name
1814 argument will set the file name for the current buffer,
1815 if the current buffer doesn't have a file name yet.
1816 *cpo-F*
1817 F When included, a ":write" command with a file name
1818 argument will set the file name for the current
1819 buffer, if the current buffer doesn't have a file name
1820 yet.
1821 *cpo-g*
1822 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001823 *cpo-H*
1824 H When using "I" on a line with only blanks, insert
1825 before the last blank. Without this flag insert after
1826 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 *cpo-i*
1828 i When included, interrupting the reading of a file will
1829 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001830 *cpo-I*
1831 I When moving the cursor up or down just after inserting
1832 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 *cpo-j*
1834 j When joining lines, only add two spaces after a '.',
1835 not after '!' or '?'. Also see 'joinspaces'.
1836 *cpo-J*
1837 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001838 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 white space.
1840 *cpo-k*
1841 k Disable the recognition of raw key codes in
1842 mappings, abbreviations, and the "to" part of menu
1843 commands. For example, if <Key> sends ^[OA (where ^[
1844 is <Esc>), the command ":map X ^[OA" results in X
1845 being mapped to:
1846 'k' included: "^[OA" (3 characters)
1847 'k' excluded: "<Key>" (one key code)
1848 Also see the '<' flag below.
1849 *cpo-K*
1850 K Don't wait for a key code to complete when it is
1851 halfway a mapping. This breaks mapping <F1><F1> when
1852 only part of the second <F1> has been read. It
1853 enables cancelling the mapping by typing <F1><Esc>.
1854 *cpo-l*
1855 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001856 literally, only "\]", "\^", "\-" and "\\" are special.
1857 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1859 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001860 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 *cpo-L*
1862 L When the 'list' option is set, 'wrapmargin',
1863 'textwidth', 'softtabstop' and Virtual Replace mode
1864 (see |gR|) count a <Tab> as two characters, instead of
1865 the normal behavior of a <Tab>.
1866 *cpo-m*
1867 m When included, a showmatch will always wait half a
1868 second. When not included, a showmatch will wait half
1869 a second or until a character is typed. |'showmatch'|
1870 *cpo-M*
1871 M When excluded, "%" matching will take backslashes into
1872 account. Thus in "( \( )" and "\( ( \)" the outer
1873 parenthesis match. When included "%" ignores
1874 backslashes, which is Vi compatible.
1875 *cpo-n*
1876 n When included, the column used for 'number' will also
1877 be used for text of wrapped lines.
1878 *cpo-o*
1879 o Line offset to search command is not remembered for
1880 next search.
1881 *cpo-O*
1882 O Don't complain if a file is being overwritten, even
1883 when it didn't exist when editing it. This is a
1884 protection against a file unexpectedly created by
1885 someone else. Vi didn't complain about this.
1886 *cpo-p*
1887 p Vi compatible Lisp indenting. When not present, a
1888 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001889 *cpo-q*
1890 q When joining multiple lines leave the cursor at the
1891 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 *cpo-r*
1893 r Redo ("." command) uses "/" to repeat a search
1894 command, instead of the actually used search string.
1895 *cpo-R*
1896 R Remove marks from filtered lines. Without this flag
1897 marks are kept like |:keepmarks| was used.
1898 *cpo-s*
1899 s Set buffer options when entering the buffer for the
1900 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001901 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 set when the buffer is created.
1903 *cpo-S*
1904 S Set buffer options always when entering a buffer
1905 (except 'readonly', 'fileformat', 'filetype' and
1906 'syntax'). This is the (most) Vi compatible setting.
1907 The options are set to the values in the current
1908 buffer. When you change an option and go to another
1909 buffer, the value is copied. Effectively makes the
1910 buffer options global to all buffers.
1911
1912 's' 'S' copy buffer options
1913 no no when buffer created
1914 yes no when buffer first entered (default)
1915 X yes each time when buffer entered (vi comp.)
1916 *cpo-t*
1917 t Search pattern for the tag command is remembered for
1918 "n" command. Otherwise Vim only puts the pattern in
1919 the history for search pattern, but doesn't change the
1920 last used search pattern.
1921 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001922 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 *cpo-v*
1924 v Backspaced characters remain visible on the screen in
1925 Insert mode. Without this flag the characters are
1926 erased from the screen right away. With this flag the
1927 screen newly typed text overwrites backspaced
1928 characters.
1929 *cpo-w*
1930 w When using "cw" on a blank character, only change one
1931 character and not all blanks until the start of the
1932 next word.
1933 *cpo-W*
1934 W Don't overwrite a readonly file. When omitted, ":w!"
1935 overwrites a readonly file, if possible.
1936 *cpo-x*
1937 x <Esc> on the command-line executes the command-line.
1938 The default in Vim is to abandon the command-line,
1939 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001940 *cpo-X*
1941 X When using a count with "R" the replaced text is
1942 deleted only once. Also when repeating "R" with "."
1943 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001944 *cpo-y*
1945 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001946 *cpo-Z*
1947 Z When using "w!" while the 'readonly' option is set,
1948 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 *cpo-!*
1950 ! When redoing a filter command, use the last used
1951 external command, whatever it was. Otherwise the last
1952 used -filter- command is used.
1953 *cpo-$*
1954 $ When making a change to one line, don't redisplay the
1955 line, but put a '$' at the end of the changed text.
1956 The changed text will be overwritten when you type the
1957 new text. The line is redisplayed if you type any
1958 command that moves the cursor from the insertion
1959 point.
1960 *cpo-%*
1961 % Vi-compatible matching is done for the "%" command.
1962 Does not recognize "#if", "#endif", etc.
1963 Does not recognize "/*" and "*/".
1964 Parens inside single and double quotes are also
1965 counted, causing a string that contains a paren to
1966 disturb the matching. For example, in a line like
1967 "if (strcmp("foo(", s))" the first paren does not
1968 match the last one. When this flag is not included,
1969 parens inside single and double quotes are treated
1970 specially. When matching a paren outside of quotes,
1971 everything inside quotes is ignored. When matching a
1972 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001973 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001974 This flag is also used for other features, such as
1975 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001976 *cpo--*
1977 - When included, a vertical movement command fails when
1978 it would above the first line or below the last line.
1979 Without it the cursor moves to the first or last line,
1980 unless it already was in that line.
1981 Applies to the commands "-", "k", CTRL-P, "+", "j",
1982 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001983 *cpo-+*
1984 + When included, a ":write file" command will reset the
1985 'modified' flag of the buffer, even though the buffer
1986 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001987 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 * Use ":*" in the same way as ":@". When not included,
1989 ":*" is an alias for ":'<,'>", select the Visual area.
1990 *cpo-<*
1991 < Disable the recognition of special key codes in |<>|
1992 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001993 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 ":map X <Tab>" results in X being mapped to:
1995 '<' included: "<Tab>" (5 characters)
1996 '<' excluded: "^I" (^I is a real <Tab>)
1997 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001998 *cpo->*
1999 > When appending to a register, put a line break before
2000 the appended text.
2001
2002 POSIX flags. These are not included in the Vi default value, except
2003 when $VIM_POSIX was set on startup. |posix|
2004
2005 contains behavior ~
2006 *cpo-#*
2007 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002008 *cpo-&*
2009 & When ":preserve" was used keep the swap file when
2010 exiting normally while this buffer is still loaded.
2011 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002012 *cpo-\*
2013 \ Backslash in a [] range in a search pattern is taken
2014 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002015 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2016 '\' excluded: "/[ \-]" finds <Space> and '-'
2017 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002018 *cpo-/*
2019 / When "%" is used as the replacement string in a |:s|
2020 command, use the previous replacement string. |:s%|
2021 *cpo-{*
2022 { The |{| and |}| commands also stop at a "{" character
2023 at the start of a line.
2024 *cpo-.*
2025 . The ":chdir" and ":cd" commands fail if the current
2026 buffer is modified, unless ! is used. Vim doesn't
2027 need this, since it remembers the full path of an
2028 opened file.
2029 *cpo-bar*
2030 | The value of the $LINES and $COLUMNS environment
2031 variables overrule the terminal size values obtained
2032 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002033
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034
2035 *'cscopepathcomp'* *'cspc'*
2036'cscopepathcomp' 'cspc' number (default 0)
2037 global
2038 {not available when compiled without the |+cscope|
2039 feature}
2040 {not in Vi}
2041 Determines how many components of the path to show in a list of tags.
2042 See |cscopepathcomp|.
2043
2044 *'cscopeprg'* *'csprg'*
2045'cscopeprg' 'csprg' string (default "cscope")
2046 global
2047 {not available when compiled without the |+cscope|
2048 feature}
2049 {not in Vi}
2050 Specifies the command to execute cscope. See |cscopeprg|.
2051 This option cannot be set from a |modeline| or in the |sandbox|, for
2052 security reasons.
2053
2054 *'cscopequickfix'* *'csqf'*
2055'cscopequickfix' 'csqf' string (default "")
2056 global
2057 {not available when compiled without the |+cscope|
2058 or |+quickfix| features}
2059 {not in Vi}
2060 Specifies whether to use quickfix window to show cscope results.
2061 See |cscopequickfix|.
2062
2063 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2064'cscopetag' 'cst' boolean (default off)
2065 global
2066 {not available when compiled without the |+cscope|
2067 feature}
2068 {not in Vi}
2069 Use cscope for tag commands. See |cscope-options|.
2070 NOTE: This option is reset when 'compatible' is set.
2071
2072 *'cscopetagorder'* *'csto'*
2073'cscopetagorder' 'csto' number (default 0)
2074 global
2075 {not available when compiled without the |+cscope|
2076 feature}
2077 {not in Vi}
2078 Determines the order in which ":cstag" performs a search. See
2079 |cscopetagorder|.
2080 NOTE: This option is set to 0 when 'compatible' is set.
2081
2082 *'cscopeverbose'* *'csverb'*
2083 *'nocscopeverbose'* *'nocsverb'*
2084'cscopeverbose' 'csverb' boolean (default off)
2085 global
2086 {not available when compiled without the |+cscope|
2087 feature}
2088 {not in Vi}
2089 Give messages when adding a cscope database. See |cscopeverbose|.
2090 NOTE: This option is reset when 'compatible' is set.
2091
2092 *'debug'*
2093'debug' string (default "")
2094 global
2095 {not in Vi}
2096 When set to "msg", error messages that would otherwise be omitted will
2097 be given anyway. This is useful when debugging 'foldexpr' or
2098 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002099 When set to "beep", a message will be given when otherwise only a beep
2100 would be produced.
2101 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102
2103 *'define'* *'def'*
2104'define' 'def' string (default "^\s*#\s*define")
2105 global or local to buffer |global-local|
2106 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002107 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 pattern, just like for the "/" command. This option is used for the
2109 commands like "[i" and "[d" |include-search|. The 'isident' option is
2110 used to recognize the defined name after the match:
2111 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2112 See |option-backslash| about inserting backslashes to include a space
2113 or backslash.
2114 The default value is for C programs. For C++ this value would be
2115 useful, to include const type declarations: >
2116 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2117< When using the ":set" command, you need to double the backslashes!
2118
2119 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2120'delcombine' 'deco' boolean (default off)
2121 global
2122 {not in Vi}
2123 {only available when compiled with the |+multi_byte|
2124 feature}
2125 If editing Unicode and this option is set, backspace and Normal mode
2126 "x" delete each combining character on its own. When it is off (the
2127 default) the character along with its combining characters are
2128 deleted.
2129 Note: When 'delcombine' is set "xx" may work different from "2x"!
2130
2131 This is useful for Arabic, Hebrew and many other languages where one
2132 may have combining characters overtop of base characters, and want
2133 to remove only the combining ones.
2134
2135 *'dictionary'* *'dict'*
2136'dictionary' 'dict' string (default "")
2137 global or local to buffer |global-local|
2138 {not in Vi}
2139 List of file names, separated by commas, that are used to lookup words
2140 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2141 contain a list of words. This can be one word per line, or several
2142 words per line, separated by non-keyword characters (white space is
2143 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002144 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 after a comma are ignored, otherwise spaces are included in the file
2146 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002147 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 Where to find a list of words?
2149 - On FreeBSD, there is the file "/usr/share/dict/words".
2150 - In the Simtel archive, look in the "msdos/linguist" directory.
2151 - In "miscfiles" of the GNU collection.
2152 The use of |:set+=| and |:set-=| is preferred when adding or removing
2153 directories from the list. This avoids problems when a future version
2154 uses another default.
2155 Backticks cannot be used in this option for security reasons.
2156
2157 *'diff'* *'nodiff'*
2158'diff' boolean (default off)
2159 local to window
2160 {not in Vi}
2161 {not available when compiled without the |+diff|
2162 feature}
2163 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002164 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165
2166 *'dex'* *'diffexpr'*
2167'diffexpr' 'dex' string (default "")
2168 global
2169 {not in Vi}
2170 {not available when compiled without the |+diff|
2171 feature}
2172 Expression which is evaluated to obtain an ed-style diff file from two
2173 versions of a file. See |diff-diffexpr|.
2174 This option cannot be set from a |modeline| or in the |sandbox|, for
2175 security reasons.
2176
2177 *'dip'* *'diffopt'*
2178'diffopt' 'dip' string (default "filler")
2179 global
2180 {not in Vi}
2181 {not available when compiled without the |+diff|
2182 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002183 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 All are optional. Items must be separated by a comma.
2185
2186 filler Show filler lines, to keep the text
2187 synchronized with a window that has inserted
2188 lines at the same position. Mostly useful
2189 when windows are side-by-side and 'scrollbind'
2190 is set.
2191
2192 context:{n} Use a context of {n} lines between a change
2193 and a fold that contains unchanged lines.
2194 When omitted a context of six lines is used.
2195 See |fold-diff|.
2196
2197 icase Ignore changes in case of text. "a" and "A"
2198 are considered the same. Adds the "-i" flag
2199 to the "diff" command if 'diffexpr' is empty.
2200
2201 iwhite Ignore changes in amount of white space. Adds
2202 the "-b" flag to the "diff" command if
2203 'diffexpr' is empty. Check the documentation
2204 of the "diff" command for what this does
2205 exactly. It should ignore adding trailing
2206 white space, but not leading white space.
2207
2208 Examples: >
2209
2210 :set diffopt=filler,context:4
2211 :set diffopt=
2212 :set diffopt=filler
2213<
2214 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2215'digraph' 'dg' boolean (default off)
2216 global
2217 {not in Vi}
2218 {not available when compiled without the |+digraphs|
2219 feature}
2220 Enable the entering of digraphs in Insert mode with {char1} <BS>
2221 {char2}. See |digraphs|.
2222 NOTE: This option is reset when 'compatible' is set.
2223
2224 *'directory'* *'dir'*
2225'directory' 'dir' string (default for Amiga: ".,t:",
2226 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2227 for Unix: ".,~/tmp,/var/tmp,/tmp")
2228 global
2229 List of directory names for the swap file, separated with commas.
2230 - The swap file will be created in the first directory where this is
2231 possible.
2232 - Empty means that no swap file will be used (recovery is
2233 impossible!).
2234 - A directory "." means to put the swap file in the same directory as
2235 the edited file. On Unix, a dot is prepended to the file name, so
2236 it doesn't show in a directory listing. On MS-Windows the "hidden"
2237 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002238 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 put the swap file relative to where the edited file is. The leading
2240 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002241 - For Unix and Win32, if a directory ends in two path separators "//"
2242 or "\\", the swap file name will be built from the complete path to
2243 the file with all path separators substituted to percent '%' signs.
2244 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 - Spaces after the comma are ignored, other spaces are considered part
2246 of the directory name. To have a space at the start of a directory
2247 name, precede it with a backslash.
2248 - To include a comma in a directory name precede it with a backslash.
2249 - A directory name may end in an ':' or '/'.
2250 - Environment variables are expanded |:set_env|.
2251 - Careful with '\' characters, type one before a space, type two to
2252 get one in the option (see |option-backslash|), for example: >
2253 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2254< - For backwards compatibility with Vim version 3.0 a '>' at the start
2255 of the option is removed.
2256 Using "." first in the list is recommended. This means that editing
2257 the same file twice will result in a warning. Using "/tmp" on Unix is
2258 discouraged: When the system crashes you lose the swap file.
2259 "/var/tmp" is often not cleared when rebooting, thus is a better
2260 choice than "/tmp". But it can contain a lot of files, your swap
2261 files get lost in the crowd. That is why a "tmp" directory in your
2262 home directory is tried first.
2263 The use of |:set+=| and |:set-=| is preferred when adding or removing
2264 directories from the list. This avoids problems when a future version
2265 uses another default.
2266 This option cannot be set from a |modeline| or in the |sandbox|, for
2267 security reasons.
2268 {Vi: directory to put temp file in, defaults to "/tmp"}
2269
2270 *'display'* *'dy'*
2271'display' 'dy' string (default "")
2272 global
2273 {not in Vi}
2274 Change the way text is displayed. This is comma separated list of
2275 flags:
2276 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002277 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 last line that doesn't fit is replaced with "@" lines.
2279 uhex Show unprintable characters hexadecimal as <xx>
2280 instead of using ^C and ~C.
2281
2282 *'eadirection'* *'ead'*
2283'eadirection' 'ead' string (default "both")
2284 global
2285 {not in Vi}
2286 {not available when compiled without the +vertsplit
2287 feature}
2288 Tells when the 'equalalways' option applies:
2289 ver vertically, width of windows is not affected
2290 hor horizontally, height of windows is not affected
2291 both width and height of windows is affected
2292
2293 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2294'edcompatible' 'ed' boolean (default off)
2295 global
2296 Makes the 'g' and 'c' flags of the ":substitute" command to be
2297 toggled each time the flag is given. See |complex-change|. See
2298 also 'gdefault' option.
2299 Switching this option on is discouraged!
2300
2301 *'encoding'* *'enc'* *E543*
2302'encoding' 'enc' string (default: "latin1" or value from $LANG)
2303 global
2304 {only available when compiled with the |+multi_byte|
2305 feature}
2306 {not in Vi}
2307 Sets the character encoding used inside Vim. It applies to text in
2308 the buffers, registers, Strings in expressions, text stored in the
2309 viminfo file, etc. It sets the kind of characters which Vim can work
2310 with. See |encoding-names| for the possible values.
2311
2312 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002313 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 It should normally be kept at its default value, or set when Vim
2315 starts up. See |multibyte|.
2316
2317 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2318 "utf-8". Although care has been taken to allow different values of
2319 'encoding', "utf-8" is the natural choice for the environment and
2320 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002321 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 versions, and to avoid changing the encoding of newly created files
2323 without your knowledge (in case 'fileencodings' is empty).
2324
2325 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002326 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 iconv() or as specified with 'charconvert'.
2328
2329 Normally 'encoding' will be equal to your current locale. This will
2330 be the default if Vim recognizes your environment settings. If
2331 'encoding' is not set to the current locale, 'termencoding' must be
2332 set to convert typed and displayed text. See |encoding-table|.
2333
2334 When you set this option, it fires the |EncodingChanged| autocommand
2335 event so that you can set up fonts if necessary.
2336
2337 When the option is set, the value is converted to lowercase. Thus
2338 you can set it with uppercase values too. Underscores are translated
2339 to '-' signs.
2340 When the encoding is recognized, it is changed to the standard name.
2341 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2342 "iso-8859-2" and "utf8" becomes "utf-8".
2343
2344 Note: "latin1" is also used when the encoding could not be detected.
2345 This only works when editing files in the same encoding! When the
2346 actual character set is not latin1, make sure 'fileencoding' and
2347 'fileencodings' are empty. When conversion is needed, switch to using
2348 utf-8.
2349
2350 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2351 You don't notice this while editing, but it does matter for the
2352 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2353 setting 'encoding' to one of these values instead of utf-8 only has
2354 effect for encoding used for files when 'fileencoding' is empty.
2355
Bram Moolenaar661b1822005-07-28 22:36:45 +00002356 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2357 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358
2359 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2360'endofline' 'eol' boolean (default on)
2361 local to buffer
2362 {not in Vi}
2363 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002364 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365 option is automatically set when starting to edit a new file, unless
2366 the file does not have an <EOL> for the last line in the file, in
2367 which case it is reset. Normally you don't have to set or reset this
2368 option. When 'binary' is off the value is not used when writing the
2369 file. When 'binary' is on it is used to remember the presence of a
2370 <EOL> for the last line in the file, so that when you write the file
2371 the situation from the original file can be kept. But you can change
2372 it if you want to.
2373
2374 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2375'equalalways' 'ea' boolean (default on)
2376 global
2377 {not in Vi}
2378 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002379 splitting or closing a window. This also happens the moment the
2380 option is switched on. When off, splitting a window will reduce the
2381 size of the current window and leave the other windows the same. When
2382 closing a window the extra lines are given to the window next to it
2383 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 When mixing vertically and horizontally split windows, a minimal size
2385 is computed and some windows may be larger if there is room. The
2386 'eadirection' option tells in which direction the size is affected.
2387 Changing the height of a window can be avoided by setting
2388 'winfixheight'.
2389
2390 *'equalprg'* *'ep'*
2391'equalprg' 'ep' string (default "")
2392 global or local to buffer |global-local|
2393 {not in Vi}
2394 External program to use for "=" command. When this option is empty
2395 the internal formatting functions are used ('lisp', 'cindent' or
2396 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398 about including spaces and backslashes.
2399 This option cannot be set from a |modeline| or in the |sandbox|, for
2400 security reasons.
2401
2402 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2403'errorbells' 'eb' boolean (default off)
2404 global
2405 Ring the bell (beep or screen flash) for error messages. This only
2406 makes a difference for error messages, the bell will be used always
2407 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002408 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 screen flash or do nothing.
2410
2411 *'errorfile'* *'ef'*
2412'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2413 others: "errors.err")
2414 global
2415 {not in Vi}
2416 {not available when compiled without the |+quickfix|
2417 feature}
2418 Name of the errorfile for the QuickFix mode (see |:cf|).
2419 When the "-q" command-line argument is used, 'errorfile' is set to the
2420 following argument. See |-q|.
2421 NOT used for the ":make" command. See 'makeef' for that.
2422 Environment variables are expanded |:set_env|.
2423 See |option-backslash| about including spaces and backslashes.
2424 This option cannot be set from a |modeline| or in the |sandbox|, for
2425 security reasons.
2426
2427 *'errorformat'* *'efm'*
2428'errorformat' 'efm' string (default is very long)
2429 global or local to buffer |global-local|
2430 {not in Vi}
2431 {not available when compiled without the |+quickfix|
2432 feature}
2433 Scanf-like description of the format for the lines in the error file
2434 (see |errorformat|).
2435
2436 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2437'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2438 global
2439 {not in Vi}
2440 Function keys that start with an <Esc> are recognized in Insert
2441 mode. When this option is off, the cursor and function keys cannot be
2442 used in Insert mode if they start with an <Esc>. The advantage of
2443 this is that the single <Esc> is recognized immediately, instead of
2444 after one second. Instead of resetting this option, you might want to
2445 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2446 when 'esckeys' is off, you can still map anything, but the cursor keys
2447 won't work by default.
2448 NOTE: This option is set to the Vi default value when 'compatible' is
2449 set and to the Vim default value when 'compatible' is reset.
2450
2451 *'eventignore'* *'ei'*
2452'eventignore' 'ei' string (default "")
2453 global
2454 {not in Vi}
2455 {not available when compiled without the |+autocmd|
2456 feature}
2457 A list of autocommand event names, which are to be ignored.
2458 When set to "all", all autocommand events are ignored, autocommands
2459 will not be executed.
2460 Otherwise this is a comma separated list of event names. Example: >
2461 :set ei=WinEnter,WinLeave
2462<
2463 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2464'expandtab' 'et' boolean (default off)
2465 local to buffer
2466 {not in Vi}
2467 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002468 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2470 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2471 NOTE: This option is reset when 'compatible' is set.
2472
2473 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2474'exrc' 'ex' boolean (default off)
2475 global
2476 {not in Vi}
2477 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2478 directory. If you switch this option on you should also consider
2479 setting the 'secure' option (see |initialization|). Using a local
2480 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2481 also see |.vimrc| and |gui-init|.
2482 This option cannot be set from a |modeline| or in the |sandbox|, for
2483 security reasons.
2484
2485 *'fileencoding'* *'fenc'* *E213*
2486'fileencoding' 'fenc' string (default: "")
2487 local to buffer
2488 {only available when compiled with the |+multi_byte|
2489 feature}
2490 {not in Vi}
2491 Sets the character encoding for the file of this buffer.
2492 When 'fileencoding' is different from 'encoding', conversion will be
2493 done when reading and writing the file.
2494 When 'fileencoding' is empty, the same value as 'encoding' will be
2495 used (no conversion when reading or writing a file).
2496 WARNING: Conversion can cause loss of information! When
2497 'encoding' is "utf-8" conversion is most likely done in a way
2498 that the reverse conversion results in the same text. When
2499 'encoding' is not "utf-8" some characters may be lost!
2500 See 'encoding' for the possible values. Additionally, values may be
2501 specified that can be handled by the converter, see
2502 |mbyte-conversion|.
2503 When reading a file 'fileencoding' will be set from 'fileencodings'.
2504 To read a file in a certain encoding it won't work by setting
2505 'fileencoding', use the |++enc| argument.
2506 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2507 When the option is set, the value is converted to lowercase. Thus
2508 you can set it with uppercase values too. '_' characters are
2509 replaced with '-'. If a name is recognized from the list for
2510 'encoding', it is replaced by the standard name. For example
2511 "ISO8859-2" becomes "iso-8859-2".
2512 When this option is set, after starting to edit a file, the 'modified'
2513 option is set, because the file would be different when written.
2514 If you do this in a modeline, you might want to set 'nomodified' to
2515 avoid this.
2516 This option can not be changed when 'modifiable' is off.
2517
2518 *'fe'*
2519 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002520 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 old short name was 'fe', which is no longer used.
2522
2523 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002524'fileencodings' 'fencs' string (default: "ucs-bom",
2525 "ucs-bom,utf-8,default,latin1" when
2526 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 global
2528 {only available when compiled with the |+multi_byte|
2529 feature}
2530 {not in Vi}
2531 This is a list of character encodings considered when starting to edit
2532 an existing file. When a file is read, Vim tries to use the first
2533 mentioned character encoding. If an error is detected, the next one
2534 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002535 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 an empty string, which means the value of 'encoding' is used.
2537 WARNING: Conversion can cause loss of information! When
2538 'encoding' is "utf-8" (or one of the other Unicode variants)
2539 conversion is most likely done in a way that the reverse
2540 conversion results in the same text. When 'encoding' is not
2541 "utf-8" special characters may be lost!
2542 For an empty file or a file with only ASCII characters most encodings
2543 will work and the first entry of 'fileencodings' will be used (except
2544 "ucs-bom", which requires the BOM to be present). If you prefer
2545 another encoding use an BufReadPost autocommand event to test if your
2546 preferred encoding is to be used. Example: >
2547 au BufReadPost * if search('\S', 'w') == 0 |
2548 \ set fenc=iso-2022-jp | endif
2549< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2550 non-blank characters.
2551 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2552 is always empty then. This means that a non-existing file may get a
2553 different encoding than an empty file.
2554 The special value "ucs-bom" can be used to check for a Unicode BOM
2555 (Byte Order Mark) at the start of the file. It must not be preceded
2556 by "utf-8" or another Unicode encoding for this to work properly.
2557 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2558 because Vim cannot detect an error, thus the encoding is always
2559 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002560 The special value "default" can be used for the encoding from the
2561 environment. This is the default value for 'encoding'. It is useful
2562 when 'encoding' is set to "utf-8" and your environment uses a
2563 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 WRONG VALUES: WHAT'S WRONG:
2565 latin1,utf-8 "latin1" will always be used
2566 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2567 file
2568 cp1250,latin1 "cp1250" will always be used
2569 If 'fileencodings' is empty, 'fileencoding' is not modified.
2570 See 'fileencoding' for the possible values.
2571 Setting this option does not have an effect until the next time a file
2572 is read.
2573
2574 *'fileformat'* *'ff'*
2575'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2576 Unix default: "unix",
2577 Macintosh default: "mac")
2578 local to buffer
2579 {not in Vi}
2580 This gives the <EOL> of the current buffer, which is used for
2581 reading/writing the buffer from/to a file:
2582 dos <CR> <NL>
2583 unix <NL>
2584 mac <CR>
2585 When "dos" is used, CTRL-Z at the end of a file is ignored.
2586 See |file-formats| and |file-read|.
2587 For the character encoding of the file see 'fileencoding'.
2588 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2589 works like it was set to "unix'.
2590 This option is set automatically when starting to edit a file and
2591 'fileformats' is not empty and 'binary' is off.
2592 When this option is set, after starting to edit a file, the 'modified'
2593 option is set, because the file would be different when written.
2594 This option can not be changed when 'modifiable' is off.
2595 For backwards compatibility: When this option is set to "dos",
2596 'textmode' is set, otherwise 'textmode' is reset.
2597
2598 *'fileformats'* *'ffs'*
2599'fileformats' 'ffs' string (default:
2600 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2601 Vim Unix: "unix,dos",
2602 Vim Mac: "mac,unix,dos",
2603 Vi Cygwin: "unix,dos",
2604 Vi others: "")
2605 global
2606 {not in Vi}
2607 This gives the end-of-line (<EOL>) formats that will be tried when
2608 starting to edit a new buffer and when reading a file into an existing
2609 buffer:
2610 - When empty, the format defined with 'fileformat' will be used
2611 always. It is not set automatically.
2612 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002613 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 'fileformats' name will be used when a file is read into an existing
2615 buffer, no matter what 'fileformat' for that buffer is set to.
2616 - When more than one name is present, separated by commas, automatic
2617 <EOL> detection will be done when reading a file. When starting to
2618 edit a file, a check is done for the <EOL>:
2619 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2620 'fileformat' is set to "dos".
2621 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002622 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 preceding <CR>, "unix" is preferred over "dos".
2624 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2625 This means that "mac" is only chosen when "unix" is not present,
2626 or when no <NL> is found in the file, and when "dos" is not
2627 present, or no <CR><NL> is present in the file.
2628 Also if "unix" was first chosen, but the first <CR> is before
2629 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2630 the file, then 'fileformat' is set to "mac".
2631 4. If 'fileformat' is still not set, the first name from
2632 'fileformats' is used.
2633 When reading a file into an existing buffer, the same is done, but
2634 this happens like 'fileformat' has been set appropriately for that
2635 file only, the option is not changed.
2636 When 'binary' is set, the value of 'fileformats' is not used.
2637
2638 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2639 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2640 done:
2641 - When 'fileformats' is empty, there is no automatic detection. Dos
2642 format will be used.
2643 - When 'fileformats' is set to one or more names, automatic detection
2644 is done. This is based on the first <NL> in the file: If there is a
2645 <CR> in front of it, Dos format is used, otherwise Unix format is
2646 used.
2647 Also see |file-formats|.
2648 For backwards compatibility: When this option is set to an empty
2649 string or one format (no comma is included), 'textauto' is reset,
2650 otherwise 'textauto' is set.
2651 NOTE: This option is set to the Vi default value when 'compatible' is
2652 set and to the Vim default value when 'compatible' is reset.
2653
2654 *'filetype'* *'ft'*
2655'filetype' 'ft' string (default: "")
2656 local to buffer
2657 {not in Vi}
2658 {not available when compiled without the |+autocmd|
2659 feature}
2660 When this option is set, the FileType autocommand event is triggered.
2661 All autocommands that match with the value of this option will be
2662 executed. Thus the value of 'filetype' is used in place of the file
2663 name.
2664 Otherwise this option does not always reflect the current file type.
2665 This option is normally set when the file type is detected. To enable
2666 this use the ":filetype on" command. |:filetype|
2667 Setting this option to a different value is most useful in a modeline,
2668 for a file for which the file type is not automatically recognized.
2669 Example, for in an IDL file: >
2670 /* vim: set filetype=idl : */
2671< |FileType| |filetypes|
2672 Do not confuse this option with 'osfiletype', which is for the file
2673 type that is actually stored with the file.
2674 This option is not copied to another buffer, independent of the 's' or
2675 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002676 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677
2678 *'fillchars'* *'fcs'*
2679'fillchars' 'fcs' string (default "vert:|,fold:-")
2680 global
2681 {not in Vi}
2682 {not available when compiled without the |+windows|
2683 and |+folding| features}
2684 Characters to fill the statuslines and vertical separators.
2685 It is a comma separated list of items:
2686
2687 item default Used for ~
2688 stl:c ' ' or '^' statusline of the current window
2689 stlnc:c ' ' or '-' statusline of the non-current windows
2690 vert:c '|' vertical separators |:vsplit|
2691 fold:c '-' filling 'foldtext'
2692 diff:c '-' deleted lines of the 'diff' option
2693
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002694 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 "stlnc" the space will be used when there is highlighting, '^' or '-'
2696 otherwise.
2697
2698 Example: >
2699 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2700< This is similar to the default, except that these characters will also
2701 be used when there is highlighting.
2702
2703 The highlighting used for these items:
2704 item highlight group ~
2705 stl:c StatusLine |hl-StatusLine|
2706 stlnc:c StatusLineNC |hl-StatusLineNC|
2707 vert:c VertSplit |hl-VertSplit|
2708 fold:c Folded |hl-Folded|
2709 diff:c DiffDelete |hl-DiffDelete|
2710
2711 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2712'fkmap' 'fk' boolean (default off) *E198*
2713 global
2714 {not in Vi}
2715 {only available when compiled with the |+rightleft|
2716 feature}
2717 When on, the keyboard is mapped for the Farsi character set.
2718 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002719 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720
2721 *'foldclose'* *'fcl'*
2722'foldclose' 'fcl' string (default "")
2723 global
2724 {not in Vi}
2725 {not available when compiled without the |+folding|
2726 feature}
2727 When set to "all", a fold is closed when the cursor isn't in it and
2728 its level is higher than 'foldlevel'. Useful if you want folds to
2729 automatically close when moving out of them.
2730
2731 *'foldcolumn'* *'fdc'*
2732'foldcolumn' 'fdc' number (default 0)
2733 local to window
2734 {not in Vi}
2735 {not available when compiled without the |+folding|
2736 feature}
2737 When non-zero, a column with the specified width is shown at the side
2738 of the window which indicates open and closed folds. The maximum
2739 value is 12.
2740 See |folding|.
2741
2742 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2743'foldenable' 'fen' boolean (default on)
2744 local to window
2745 {not in Vi}
2746 {not available when compiled without the |+folding|
2747 feature}
2748 When off, all folds are open. This option can be used to quickly
2749 switch between showing all text unfolded and viewing the text with
2750 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002751 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 'foldenable' is off.
2753 This option is set by commands that create a new fold or close a fold.
2754 See |folding|.
2755
2756 *'foldexpr'* *'fde'*
2757'foldexpr' 'fde' string (default: "0")
2758 local to window
2759 {not in Vi}
2760 {not available when compiled without the |+folding|
2761 or |+eval| feature}
2762 The expression used for when 'foldmethod' is "expr". It is evaluated
2763 for each line to obtain its fold level. See |fold-expr|. Also see
2764 |eval-sandbox|.
2765
2766 *'foldignore'* *'fdi'*
2767'foldignore' 'fdi' string (default: "#")
2768 local to window
2769 {not in Vi}
2770 {not available when compiled without the |+folding|
2771 feature}
2772 Used only when 'foldmethod' is "indent". Lines starting with
2773 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 The default "#" works well for C programs. See |fold-indent|.
2776
2777 *'foldlevel'* *'fdl'*
2778'foldlevel' 'fdl' number (default: 0)
2779 local to window
2780 {not in Vi}
2781 {not available when compiled without the |+folding|
2782 feature}
2783 Sets the fold level: Folds with a higher level will be closed.
2784 Setting this option to zero will close all folds. Higher numbers will
2785 close fewer folds.
2786 This option is set by commands like |zm|, |zM| and |zR|.
2787 See |fold-foldlevel|.
2788
2789 *'foldlevelstart'* *'fdls'*
2790'foldlevelstart' 'fdls' number (default: -1)
2791 global
2792 {not in Vi}
2793 {not available when compiled without the |+folding|
2794 feature}
2795 Sets 'foldlevel' when starting to edit another buffer in a window.
2796 Useful to always start editing with all folds closed (value zero),
2797 some folds closed (one) or no folds closed (99).
2798 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 ignores this option and closes all folds.
2801 It is also done before BufReadPre autocommands, to allow an autocmd to
2802 overrule the 'foldlevel' value for specific files.
2803 When the value is negative, it is not used.
2804
2805 *'foldmarker'* *'fmr'* *E536*
2806'foldmarker' 'fmr' string (default: "{{{,}}}")
2807 local to window
2808 {not in Vi}
2809 {not available when compiled without the |+folding|
2810 feature}
2811 The start and end marker used when 'foldmethod' is "marker". There
2812 must be one comma, which separates the start and end marker. The
2813 marker is a literal string (a regular expression would be too slow).
2814 See |fold-marker|.
2815
2816 *'foldmethod'* *'fdm'*
2817'foldmethod' 'fdm' string (default: "manual")
2818 local to window
2819 {not in Vi}
2820 {not available when compiled without the |+folding|
2821 feature}
2822 The kind of folding used for the current window. Possible values:
2823 |fold-manual| manual Folds are created manually.
2824 |fold-indent| indent Lines with equal indent form a fold.
2825 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2826 |fold-marker| marker Markers are used to specify folds.
2827 |fold-syntax| syntax Syntax highlighting items specify folds.
2828 |fold-diff| diff Fold text that is not changed.
2829
2830 *'foldminlines'* *'fml'*
2831'foldminlines' 'fml' number (default: 1)
2832 local to window
2833 {not in Vi}
2834 {not available when compiled without the |+folding|
2835 feature}
2836 Sets the minimum number of screen lines for a fold to be displayed
2837 closed. Also for manually closed folds.
2838 Note that this only has an effect of what is displayed. After using
2839 "zc" to close a fold, which is displayed open because it's smaller
2840 than 'foldminlines', a following "zc" may close a containing fold.
2841
2842 *'foldnestmax'* *'fdn'*
2843'foldnestmax' 'fdn' number (default: 20)
2844 local to window
2845 {not in Vi}
2846 {not available when compiled without the |+folding|
2847 feature}
2848 Sets the maximum nesting of folds for the "indent" and "syntax"
2849 methods. This avoids that too many folds will be created. Using more
2850 than 20 doesn't work, because the internal limit is 20.
2851
2852 *'foldopen'* *'fdo'*
2853'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2854 search,tag,undo")
2855 global
2856 {not in Vi}
2857 {not available when compiled without the |+folding|
2858 feature}
2859 Specifies for which type of commands folds will be opened, if the
2860 command moves the cursor into a closed fold. It is a comma separated
2861 list of items.
2862 item commands ~
2863 all any
2864 block "(", "{", "[[", "[{", etc.
2865 hor horizontal movements: "l", "w", "fx", etc.
2866 insert any command in Insert mode
2867 jump far jumps: "G", "gg", etc.
2868 mark jumping to a mark: "'m", CTRL-O, etc.
2869 percent "%"
2870 quickfix ":cn", ":crew", ":make", etc.
2871 search search for a pattern: "/", "n", "*", "gd", etc.
2872 (not for a search pattern in a ":" command)
2873 tag jumping to a tag: ":ta", CTRL-T, etc.
2874 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002875 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 the |zv| command to the mapping to get the same effect.
2877 When a movement command is used for an operator (e.g., "dl" or "y%")
2878 this option is not used. This means the operator will include the
2879 whole closed fold.
2880 Note that vertical movements are not here, because it would make it
2881 very difficult to move onto a closed fold.
2882 In insert mode the folds containing the cursor will always be open
2883 when text is inserted.
2884 To close folds you can re-apply 'foldlevel' with the |zx| command or
2885 set the 'foldclose' option to "all".
2886
2887 *'foldtext'* *'fdt'*
2888'foldtext' 'fdt' string (default: "foldtext()")
2889 local to window
2890 {not in Vi}
2891 {not available when compiled without the |+folding|
2892 feature}
2893 An expression which is used to specify the text displayed for a closed
2894 fold. See |fold-foldtext|.
2895
2896 *'formatoptions'* *'fo'*
2897'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2898 local to buffer
2899 {not in Vi}
2900 This is a sequence of letters which describes how automatic
2901 formatting is to be done. See |fo-table|. When the 'paste' option is
2902 on, no formatting is done (like 'formatoptions' is empty). Commas can
2903 be inserted for readability.
2904 To avoid problems with flags that are added in the future, use the
2905 "+=" and "-=" feature of ":set" |add-option-flags|.
2906 NOTE: This option is set to the Vi default value when 'compatible' is
2907 set and to the Vim default value when 'compatible' is reset.
2908
Bram Moolenaar86b68352004-12-27 21:59:20 +00002909 *'formatlistpat'* *'flp'*
2910'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2911 local to buffer
2912 {not in Vi}
2913 A pattern that is used to recognize a list header. This is used for
2914 the "n" flag in 'formatoptions'.
2915 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002916 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002917 while still checking more characters. There must be a character
2918 following the pattern, when it matches the whole line it is handled
2919 like there is no match.
2920 The default recognizes a number, followed by an optional punctuation
2921 character and white space.
2922
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 *'formatprg'* *'fp'*
2924'formatprg' 'fp' string (default "")
2925 global
2926 {not in Vi}
2927 The name of an external program that will be used to format the lines
2928 selected with the "gq" command. The program must take the input on
2929 stdin and produce the output on stdout. The Unix program "fmt" is
2930 such a program. If this option is an empty string, the internal
2931 format function will be used |C-indenting|. Environment variables are
2932 expanded |:set_env|. See |option-backslash| about including spaces
2933 and backslashes.
2934 This option cannot be set from a |modeline| or in the |sandbox|, for
2935 security reasons.
2936
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002937 *'fsync'* *'fs'*
2938'fsync' 'fs' boolean (default on)
2939 global
2940 {not in Vi}
2941 When on, the library function fsync() will be called after writing a
2942 file. This will flush a file to disk, ensuring that it is safely
2943 written even on filesystems which do metadata-only journaling. This
2944 will force the harddrive to spin up on Linux systems running in laptop
2945 mode, so it may be undesirable in some situations. Be warned that
2946 turning this off increases the chances of data loss after a crash. On
2947 systems without an fsync() implementation, this variable is always
2948 off.
2949 Also see 'swapsync' for controlling fsync() on swap files.
2950
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2952'gdefault' 'gd' boolean (default off)
2953 global
2954 {not in Vi}
2955 When on, the ":substitute" flag 'g' is default on. This means that
2956 all matches in a line are substituted instead of one. When a 'g' flag
2957 is given to a ":substitute" command, this will toggle the substitution
2958 of all or one match. See |complex-change|.
2959
2960 command 'gdefault' on 'gdefault' off ~
2961 :s/// subst. all subst. one
2962 :s///g subst. one subst. all
2963 :s///gg subst. all subst. one
2964
2965 NOTE: This option is reset when 'compatible' is set.
2966
2967 *'grepformat'* *'gfm'*
2968'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2969 global
2970 {not in Vi}
2971 Format to recognize for the ":grep" command output.
2972 This is a scanf-like string that uses the same format as the
2973 'errorformat' option: see |errorformat|.
2974
2975 *'grepprg'* *'gp'*
2976'grepprg' 'gp' string (default "grep -n ",
2977 Unix: "grep -n $* /dev/null",
2978 Win32: "findstr /n" or "grep -n",
2979 VMS: "SEARCH/NUMBERS ")
2980 global or local to buffer |global-local|
2981 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002982 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983 and '#' characters, which are expanded like when used in a command-
2984 line. The placeholder "$*" is allowed to specify where the arguments
2985 will be included. Environment variables are expanded |:set_env|. See
2986 |option-backslash| about including spaces and backslashes.
2987 When your "grep" accepts the "-H" argument, use this to make ":grep"
2988 also work well with a single file: >
2989 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002990< Special value: When 'grepprg' is set to "internal" the |:grep| command
2991 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002992 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002993 apply equally to 'grepprg'.
2994 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2995 otherwise it's "grep -n".
2996 This option cannot be set from a |modeline| or in the |sandbox|, for
2997 security reasons.
2998
2999 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3000'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3001 ve:ver35-Cursor,
3002 o:hor50-Cursor,
3003 i-ci:ver25-Cursor/lCursor,
3004 r-cr:hor20-Cursor/lCursor,
3005 sm:block-Cursor
3006 -blinkwait175-blinkoff150-blinkon175",
3007 for MS-DOS and Win32 console:
3008 "n-v-c:block,o:hor50,i-ci:hor15,
3009 r-cr:hor30,sm:block")
3010 global
3011 {not in Vi}
3012 {only available when compiled with GUI enabled, and
3013 for MS-DOS and Win32 console}
3014 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003015 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 the height of the cursor can be changed. This can be done by
3017 specifying a block cursor, or a percentage for a vertical or
3018 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003019 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003021 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 mode-list and an argument-list:
3023 mode-list:argument-list,mode-list:argument-list,..
3024 The mode-list is a dash separated list of these modes:
3025 n Normal mode
3026 v Visual mode
3027 ve Visual mode with 'selection' "exclusive" (same as 'v',
3028 if not specified)
3029 o Operator-pending mode
3030 i Insert mode
3031 r Replace mode
3032 c Command-line Normal (append) mode
3033 ci Command-line Insert mode
3034 cr Command-line Replace mode
3035 sm showmatch in Insert mode
3036 a all modes
3037 The argument-list is a dash separated list of these arguments:
3038 hor{N} horizontal bar, {N} percent of the character height
3039 ver{N} vertical bar, {N} percent of the character width
3040 block block cursor, fills the whole character
3041 [only one of the above three should be present]
3042 blinkwait{N} *cursor-blinking*
3043 blinkon{N}
3044 blinkoff{N}
3045 blink times for cursor: blinkwait is the delay before
3046 the cursor starts blinking, blinkon is the time that
3047 the cursor is shown and blinkoff is the time that the
3048 cursor is not shown. The times are in msec. When one
3049 of the numbers is zero, there is no blinking. The
3050 default is: "blinkwait700-blinkon400-blinkoff250".
3051 These numbers are used for a missing entry. This
3052 means that blinking is enabled by default. To switch
3053 blinking off you can use "blinkon0". The cursor only
3054 blinks when Vim is waiting for input, not while
3055 executing a command.
3056 To make the cursor blink in an xterm, see
3057 |xterm-blink|.
3058 {group-name}
3059 a highlight group name, that sets the color and font
3060 for the cursor
3061 {group-name}/{group-name}
3062 Two highlight group names, the first is used when
3063 no language mappings are used, the other when they
3064 are. |language-mapping|
3065
3066 Examples of parts:
3067 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3068 block cursor with colors from the "nCursor"
3069 highlight group
3070 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3071 In Insert and Command-line Insert mode, use a
3072 30% vertical bar cursor with colors from the
3073 "iCursor" highlight group. Blink a bit
3074 faster.
3075
3076 The 'a' mode is different. It will set the given argument-list for
3077 all modes. It does not reset anything to defaults. This can be used
3078 to do a common setting for all modes. For example, to switch off
3079 blinking: "a:blinkon0"
3080
3081 Examples of cursor highlighting: >
3082 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3083 :highlight Cursor gui=NONE guifg=bg guibg=fg
3084<
3085 *'guifont'* *'gfn'*
3086 *E235* *E596* *E610* *E611*
3087'guifont' 'gfn' string (default "")
3088 global
3089 {not in Vi}
3090 {only available when compiled with GUI enabled}
3091 This is a list of fonts which will be used for the GUI version of Vim.
3092 In its simplest form the value is just one font name. When
3093 the font cannot be found you will get an error message. To try other
3094 font names a list can be specified, font names separated with commas.
3095 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003096
Bram Moolenaar05159a02005-02-26 23:04:13 +00003097 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3098 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003099
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 Spaces after a comma are ignored. To include a comma in a font name
3101 precede it with a backslash. Setting an option requires an extra
3102 backslash before a space and a backslash. See also
3103 |option-backslash|. For example: >
3104 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003105< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003107
3108 If none of the fonts can be loaded, Vim will keep the current setting.
3109 If an empty font list is given, Vim will try using other resource
3110 settings (for X, it will use the Vim.font resource), and finally it
3111 will try some builtin default which should always be there ("7x13" in
3112 the case of X). The font names given should be "normal" fonts. Vim
3113 will try to find the related bold and italic fonts.
3114
Bram Moolenaar05159a02005-02-26 23:04:13 +00003115 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003116 :set guifont=*
3117< will bring up a font requester, where you can pick the font you want.
3118
3119 The font name depends on the GUI used. See |setting-guifont| for a
3120 way to set 'guifont' for various systems.
3121
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 For the GTK+ 2 GUI the font name looks like this: >
3123 :set guifont=Andale\ Mono\ 11
3124< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003125
3126 For Mac OSX you can use something like this: >
3127 :set guifont=Monaco:h10
3128< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003130 width). An exception is GTK 2: all fonts are accepted, but
3131 mono-spaced fonts look best.
3132
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 To preview a font on X11, you might be able to use the "xfontsel"
3134 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003135
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 For the Win32 GUI *E244* *E245*
3137 - takes these options in the font name:
3138 hXX - height is XX (points, can be floating-point)
3139 wXX - width is XX (points, can be floating-point)
3140 b - bold
3141 i - italic
3142 u - underline
3143 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003144 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3146 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3147 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003148 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149
3150 Use a ':' to separate the options.
3151 - A '_' can be used in the place of a space, so you don't need to use
3152 backslashes to escape the spaces.
3153 - Examples: >
3154 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3155 :set guifont=Andale_Mono:h7.5:w4.5
3156< See also |font-sizes|.
3157
3158 *'guifontset'* *'gfs'*
3159 *E250* *E252* *E234* *E597* *E598*
3160'guifontset' 'gfs' string (default "")
3161 global
3162 {not in Vi}
3163 {only available when compiled with GUI enabled and
3164 with the |+xfontset| feature}
3165 {not available in the GTK+ 2 GUI}
3166 When not empty, specifies two (or more) fonts to be used. The first
3167 one for normal English, the second one for your special language. See
3168 |xfontset|.
3169 Setting this option also means that all font names will be handled as
3170 a fontset name. Also the ones used for the "font" argument of the
3171 |:highlight| command.
3172 The fonts must match with the current locale. If fonts for the
3173 character sets that the current locale uses are not included, setting
3174 'guifontset' will fail.
3175 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3176 the comma-separated names are alternative names, one of which will be
3177 used. In 'guifontset' the whole string is one fontset name,
3178 including the commas. It is not possible to specify alternative
3179 fontset names.
3180 This example works on many X11 systems: >
3181 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3182<
3183 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3184'guifontwide' 'gfw' string (default "")
3185 global
3186 {not in Vi}
3187 {only available when compiled with GUI enabled}
3188 When not empty, specifies a comma-separated list of fonts to be used
3189 for double-width characters. The first font that can be loaded is
3190 used.
3191 Note: The size of these fonts must be exactly twice as wide as the one
3192 specified with 'guifont' and the same height.
3193
3194 All GUI versions but GTK+ 2:
3195
3196 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3197 'guifontset' is empty or invalid.
3198 When 'guifont' is set and a valid font is found in it and
3199 'guifontwide' is empty Vim will attempt to find a matching
3200 double-width font and set 'guifontwide' to it.
3201
3202 GTK+ 2 GUI only: *guifontwide_gtk2*
3203
3204 If set and valid, 'guifontwide' is always used for double width
3205 characters, even if 'encoding' is not set to "utf-8".
3206 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 font for characters not available in 'guifont'. Thus you do not need
3209 to set 'guifontwide' at all unless you want to override the choice
3210 made by Pango/Xft.
3211
3212 *'guiheadroom'* *'ghr'*
3213'guiheadroom' 'ghr' number (default 50)
3214 global
3215 {not in Vi} {only for GTK and X11 GUI}
3216 The number of pixels subtracted from the screen height when fitting
3217 the GUI window on the screen. Set this before the GUI is started,
3218 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003219 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 lines will be left for window decorations and other items on the
3221 screen. Set it to a negative value to allow windows taller than the
3222 screen.
3223
3224 *'guioptions'* *'go'*
3225'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003226 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 global
3228 {not in Vi}
3229 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003230 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 sequence of letters which describes what components and options of the
3232 GUI should be used.
3233 To avoid problems with flags that are added in the future, use the
3234 "+=" and "-=" feature of ":set" |add-option-flags|.
3235
3236 Valid letters are as follows:
3237 *guioptions_a*
3238 'a' Autoselect: If present, then whenever VISUAL mode is started,
3239 or the Visual area extended, Vim tries to become the owner of
3240 the windowing system's global selection. This means that the
3241 Visually highlighted text is available for pasting into other
3242 applications as well as into Vim itself. When the Visual mode
3243 ends, possibly due to an operation on the text, or when an
3244 application wants to paste the selection, the highlighted text
3245 is automatically yanked into the "* selection register.
3246 Thus the selection is still available for pasting into other
3247 applications after the VISUAL mode has ended.
3248 If not present, then Vim won't become the owner of the
3249 windowing system's global selection unless explicitly told to
3250 by a yank or delete operation for the "* register.
3251 The same applies to the modeless selection.
3252
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003253 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 applies to the modeless selection.
3255
3256 'guioptions' autoselect Visual autoselect modeless ~
3257 "" - -
3258 "a" yes yes
3259 "A" - yes
3260 "aA" yes yes
3261
3262 'c' Use console dialogs instead of popup dialogs for simple
3263 choices.
3264
3265 'f' Foreground: Don't use fork() to detach the GUI from the shell
3266 where it was started. Use this for programs that wait for the
3267 editor to finish (e.g., an e-mail program). Alternatively you
3268 can use "gvim -f" or ":gui -f" to start the GUI in the
3269 foreground. |gui-fork|
3270 Note: Set this option in the vimrc file. The forking may have
3271 happened already when the gvimrc file is read.
3272
3273 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3274 corner of the window. It's black&white on non-GTK, because of
3275 limitations of X11. For a color icon, see |X11-icon|.
3276
3277 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003278 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 that this flag must be added in the .vimrc file, before
3280 switching on syntax or filetype recognition (when the .gvimrc
3281 file is sourced the system menu has already been loaded; the
3282 ":syntax on" and ":filetype on" commands load the menu too).
3283 'g' Grey menu items: Make menu items that are not active grey. If
3284 'g' is not included inactive menu items are not shown at all.
3285 Exception: Athena will always use grey menu items.
3286
3287 't' Include tearoff menu items. Currently only works for Win32,
3288 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003289 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3290 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291
3292 'r' Right-hand scrollbar is always present.
3293 'R' Right-hand scrollbar is present when there is a vertically
3294 split window.
3295 'l' Left-hand scrollbar is always present.
3296 'L' Left-hand scrollbar is present when there is a vertically
3297 split window.
3298 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3299 the longest visible line, or on the cursor line if the 'h'
3300 flag is included. |gui-horiz-scroll|
3301 'h' Limit horizontal scrollbar size to the length of the cursor
3302 line. Reduces computations. |gui-horiz-scroll|
3303
3304 And yes, you may even have scrollbars on the left AND the right if
3305 you really want to :-). See |gui-scrollbars| for more information.
3306
3307 'v' Use a vertical button layout for dialogs. When not included,
3308 a horizontal layout is preferred, but when it doesn't fit a
3309 vertical layout is used anyway.
3310 'p' Use Pointer callbacks for X11 GUI. This is required for some
3311 window managers. If the cursor is not blinking or hollow at
3312 the right moment, try adding this flag. This must be done
3313 before starting the GUI. Set it in your gvimrc. Adding or
3314 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003315 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316
3317 *'guipty'* *'noguipty'*
3318'guipty' boolean (default on)
3319 global
3320 {not in Vi}
3321 {only available when compiled with GUI enabled}
3322 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3323 I/O to/from shell commands. See |gui-pty|.
3324
3325 *'helpfile'* *'hf'*
3326'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3327 (others) "$VIMRUNTIME/doc/help.txt")
3328 global
3329 {not in Vi}
3330 Name of the main help file. All distributed help files should be
3331 placed together in one directory. Additionally, all "doc" directories
3332 in 'runtimepath' will be used.
3333 Environment variables are expanded |:set_env|. For example:
3334 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 spaces and backslashes.
3337 This option cannot be set from a |modeline| or in the |sandbox|, for
3338 security reasons.
3339
3340 *'helpheight'* *'hh'*
3341'helpheight' 'hh' number (default 20)
3342 global
3343 {not in Vi}
3344 {not available when compiled without the +windows
3345 feature}
3346 Minimal initial height of the help window when it is opened with the
3347 ":help" command. The initial height of the help window is half of the
3348 current window, or (when the 'ea' option is on) the same as other
3349 windows. When the height is less than 'helpheight', the height is
3350 set to 'helpheight'. Set to zero to disable.
3351
3352 *'helplang'* *'hlg'*
3353'helplang' 'hlg' string (default: messages language or empty)
3354 global
3355 {only available when compiled with the |+multi_lang|
3356 feature}
3357 {not in Vi}
3358 Comma separated list of languages. Vim will use the first language
3359 for which the desired help can be found. The English help will always
3360 be used as a last resort. You can add "en" to prefer English over
3361 another language, but that will only find tags that exist in that
3362 language and not in the English help.
3363 Example: >
3364 :set helplang=de,it
3365< This will first search German, then Italian and finally English help
3366 files.
3367 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3368 try to find the tag in the current language before using this option.
3369 See |help-translated|.
3370
3371 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3372'hidden' 'hid' boolean (default off)
3373 global
3374 {not in Vi}
3375 When off a buffer is unloaded when it is |abandon|ed. When on a
3376 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3377 displayed in another window, it does not become hidden, of course.
3378 The commands that move through the buffer list sometimes make a buffer
3379 hidden although the 'hidden' option is off: When the buffer is
3380 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003381 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003382 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003383 This option is set for one command with ":hide {command}" |:hide|.
3384 WARNING: It's easy to forget that you have changes in hidden buffers.
3385 Think twice when using ":q!" or ":qa!".
3386
3387 *'highlight'* *'hl'*
3388'highlight' 'hl' string (default (as a single string):
3389 "8:SpecialKey,@:NonText,d:Directory,
3390 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3391 M:ModeMsg,n:LineNr,r:Question,
3392 s:StatusLine,S:StatusLineNC,c:VertSplit
3393 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3394 f:Folded,F:FoldColumn,A:DiffAdd,
3395 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003396 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003397 R:SpellRare,L:SpellLocal,
3398 +:Pmenu,=:PmenuSel,
3399 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 global
3401 {not in Vi}
3402 This option can be used to set highlighting mode for various
3403 occasions. It is a comma separated list of character pairs. The
3404 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003405 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3407 |hl-NonText| @ '~' and '@' at the end of the window and
3408 characters from 'showbreak'
3409 |hl-Directory| d directories in CTRL-D listing and other special
3410 things in listings
3411 |hl-ErrorMsg| e error messages
3412 h (obsolete, ignored)
3413 |hl-IncSearch| i 'incsearch' highlighting
3414 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3415 |hl-MoreMsg| m |more-prompt|
3416 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3417 |hl-LineNr| n line number for ":number" and ":#" commands
3418 |hl-Question| r |hit-enter| prompt and yes/no questions
3419 |hl-StatusLine| s status line of current window |status-line|
3420 |hl-StatusLineNC| S status lines of not-current windows
3421 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3422 |hl-VertSplit| c column used to separate vertically split windows
3423 |hl-Visual| v Visual mode
3424 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3425 Selection" Only X11 Gui's |gui-x11| and
3426 |xterm-clipboard|.
3427 |hl-WarningMsg| w warning messages
3428 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3429 |hl-Folded| f line used for closed folds
3430 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003431 |hl-DiffAdd| A added line in diff mode
3432 |hl-DiffChange| C changed line in diff mode
3433 |hl-DiffDelete| D deleted line in diff mode
3434 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003436 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003437 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003438 |hl-SpellRare| R rare word |spell|
3439 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003440 |hl-Pmenu| + popup menu normal line
3441 |hl-PmenuSel| = popup menu normal line
3442 |hl-PmenuSbar| x popup menu scrollbar
3443 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444
3445 The display modes are:
3446 r reverse (termcap entry "mr" and "me")
3447 i italic (termcap entry "ZH" and "ZR")
3448 b bold (termcap entry "md" and "me")
3449 s standout (termcap entry "so" and "se")
3450 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003451 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 n no highlighting
3453 - no highlighting
3454 : use a highlight group
3455 The default is used for occasions that are not included.
3456 If you want to change what the display modes do, see |dos-colors|
3457 for an example.
3458 When using the ':' display mode, this must be followed by the name of
3459 a highlight group. A highlight group can be used to define any type
3460 of highlighting, including using color. See |:highlight| on how to
3461 define one. The default uses a different group for each occasion.
3462 See |highlight-default| for the default highlight groups.
3463
3464 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3465'hlsearch' 'hls' boolean (default off)
3466 global
3467 {not in Vi}
3468 {not available when compiled without the
3469 |+extra_search| feature}
3470 When there is a previous search pattern, highlight all its matches.
3471 The type of highlighting used can be set with the 'l' occasion in the
3472 'highlight' option. This uses the "Search" highlight group by
3473 default. Note that only the matching text is highlighted, any offsets
3474 are not applied.
3475 See also: 'incsearch' and |:match|.
3476 When you get bored looking at the highlighted matches, you can turn it
3477 off with |:nohlsearch|. As soon as you use a search command, the
3478 highlighting comes back.
3479 When the search pattern can match an end-of-line, Vim will try to
3480 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003481 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 line below a closed fold. A match in a previous line which is not
3483 drawn may not continue in an newly drawn line.
3484 NOTE: This option is reset when 'compatible' is set.
3485
3486 *'history'* *'hi'*
3487'history' 'hi' number (Vim default: 20, Vi default: 0)
3488 global
3489 {not in Vi}
3490 A history of ":" commands, and a history of previous search patterns
3491 are remembered. This option decides how many entries may be stored in
3492 each of these histories (see |cmdline-editing|).
3493 NOTE: This option is set to the Vi default value when 'compatible' is
3494 set and to the Vim default value when 'compatible' is reset.
3495
3496 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3497'hkmap' 'hk' boolean (default off)
3498 global
3499 {not in Vi}
3500 {only available when compiled with the |+rightleft|
3501 feature}
3502 When on, the keyboard is mapped for the Hebrew character set.
3503 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3504 toggle this option. See |rileft.txt|.
3505 NOTE: This option is reset when 'compatible' is set.
3506
3507 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3508'hkmapp' 'hkp' boolean (default off)
3509 global
3510 {not in Vi}
3511 {only available when compiled with the |+rightleft|
3512 feature}
3513 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3514 This is useful if you have a non-Hebrew keyboard.
3515 See |rileft.txt|.
3516 NOTE: This option is reset when 'compatible' is set.
3517
3518 *'icon'* *'noicon'*
3519'icon' boolean (default off, on when title can be restored)
3520 global
3521 {not in Vi}
3522 {not available when compiled without the |+title|
3523 feature}
3524 When on, the icon text of the window will be set to the value of
3525 'iconstring' (if it is not empty), or to the name of the file
3526 currently being edited. Only the last part of the name is used.
3527 Overridden by the 'iconstring' option.
3528 Only works if the terminal supports setting window icons (currently
3529 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3530 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3531 builtin termcap).
3532 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003533 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 X11.
3535
3536 *'iconstring'*
3537'iconstring' string (default "")
3538 global
3539 {not in Vi}
3540 {not available when compiled without the |+title|
3541 feature}
3542 When this option is not empty, it will be used for the icon text of
3543 the window. This happens only when the 'icon' option is on.
3544 Only works if the terminal supports setting window icon text
3545 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3546 Does not work for MS Windows.
3547 When Vim was compiled with HAVE_X11 defined, the original icon will be
3548 restored if possible |X11|.
3549 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003550 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 'titlestring' for example settings.
3552 {not available when compiled without the |+statusline| feature}
3553
3554 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3555'ignorecase' 'ic' boolean (default off)
3556 global
3557 Ignore case in search patterns. Also used when searching in the tags
3558 file.
3559 Also see 'smartcase'.
3560 Can be overruled by using "\c" or "\C" in the pattern, see
3561 |/ignorecase|.
3562
3563 *'imactivatekey'* *'imak'*
3564'imactivatekey' 'imak' string (default "")
3565 global
3566 {not in Vi}
3567 {only available when compiled with |+xim| and
3568 |+GUI_GTK|}
3569 Specifies the key that your Input Method in X-Windows uses for
3570 activation. When this is specified correctly, vim can fully control
3571 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3572 You can't use this option to change the activation key, the option
3573 tells Vim what the key is.
3574 Format:
3575 [MODIFIER_FLAG-]KEY_STRING
3576
3577 These characters can be used for MODIFIER_FLAG (case is ignored):
3578 S Shift key
3579 L Lock key
3580 C Control key
3581 1 Mod1 key
3582 2 Mod2 key
3583 3 Mod3 key
3584 4 Mod4 key
3585 5 Mod5 key
3586 Combinations are allowed, for example "S-C-space" or "SC-space" are
3587 both shift+ctrl+space.
3588 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3589
3590 Example: >
3591 :set imactivatekey=S-space
3592< "S-space" means shift+space. This is the activation key for kinput2 +
3593 canna (Japanese), and ami (Korean).
3594
3595 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3596'imcmdline' 'imc' boolean (default off)
3597 global
3598 {not in Vi}
3599 {only available when compiled with the |+xim|
3600 |+multi_byte_ime| or |global-ime| feature}
3601 When set the Input Method is always on when starting to edit a command
3602 line, unless entering a search pattern (see 'imsearch' for that).
3603 Setting this option is useful when your input method allows entering
3604 English characters directly, e.g., when it's used to type accented
3605 characters with dead keys.
3606
3607 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3608'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3609 global
3610 {not in Vi}
3611 {only available when compiled with the |+xim|
3612 |+multi_byte_ime| or |global-ime| feature}
3613 When set the Input Method is never used. This is useful to disable
3614 the IM when it doesn't work properly.
3615 Currently this option is on by default for SGI/IRIX machines. This
3616 may change in later releases.
3617
3618 *'iminsert'* *'imi'*
3619'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3620 local to buffer
3621 {not in Vi}
3622 Specifies whether :lmap or an Input Method (IM) is to be used in
3623 Insert mode. Valid values:
3624 0 :lmap is off and IM is off
3625 1 :lmap is ON and IM is off
3626 2 :lmap is off and IM is ON
3627 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3628 or |global-ime|.
3629 To always reset the option to zero when leaving Insert mode with <Esc>
3630 this can be used: >
3631 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3632< This makes :lmap and IM turn off automatically when leaving Insert
3633 mode.
3634 Note that this option changes when using CTRL-^ in Insert mode
3635 |i_CTRL-^|.
3636 The value is set to 1 when setting 'keymap' to a valid keymap name.
3637 It is also used for the argument of commands like "r" and "f".
3638 The value 0 may not work correctly with Athena and Motif with some XIM
3639 methods. Use 'imdisable' to disable XIM then.
3640
3641 *'imsearch'* *'ims'*
3642'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3643 local to buffer
3644 {not in Vi}
3645 Specifies whether :lmap or an Input Method (IM) is to be used when
3646 entering a search pattern. Valid values:
3647 -1 the value of 'iminsert' is used, makes it look like
3648 'iminsert' is also used when typing a search pattern
3649 0 :lmap is off and IM is off
3650 1 :lmap is ON and IM is off
3651 2 :lmap is off and IM is ON
3652 Note that this option changes when using CTRL-^ in Command-line mode
3653 |c_CTRL-^|.
3654 The value is set to 1 when it is not -1 and setting the 'keymap'
3655 option to a valid keymap name.
3656 The value 0 may not work correctly with Athena and Motif with some XIM
3657 methods. Use 'imdisable' to disable XIM then.
3658
3659 *'include'* *'inc'*
3660'include' 'inc' string (default "^\s*#\s*include")
3661 global or local to buffer |global-local|
3662 {not in Vi}
3663 {not available when compiled without the
3664 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003665 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 pattern, just like for the "/" command (See |pattern|). The default
3667 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003668 "]I", "[d", etc.
3669 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003670 comes after the matched pattern. But if "\zs" appears in the pattern
3671 then the text matched from "\zs" to the end, or until "\ze" if it
3672 appears, is used as the file name. Use this to include characters
3673 that are not in 'isfname', such as a space. You can then use
3674 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003675 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676
3677 *'includeexpr'* *'inex'*
3678'includeexpr' 'inex' string (default "")
3679 local to buffer
3680 {not in Vi}
3681 {not available when compiled without the
3682 |+find_in_path| or |+eval| feature}
3683 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003684 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 :set includeexpr=substitute(v:fname,'\\.','/','g')
3686< The "v:fname" variable will be set to the file name that was detected.
3687 Evaluated in the |sandbox|.
3688 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003689 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 Also used for |<cfile>|.
3691
3692 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3693'incsearch' 'is' boolean (default off)
3694 global
3695 {not in Vi}
3696 {not available when compiled without the
3697 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003698 While typing a search command, show where the pattern, as it was typed
3699 so far, matches. The matched string is highlighted. If the pattern
3700 is invalid or not found, nothing is shown. The screen will be updated
3701 often, this is only useful on fast terminals.
3702 Note that the match will be shown, but the cursor will return to its
3703 original position when no match is found and when pressing <Esc>. You
3704 still need to finish the search command with <Enter> to move the
3705 cursor to the match.
3706 The highlighting can be set with the 'i' flag in 'highlight'.
3707 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003708 NOTE: This option is reset when 'compatible' is set.
3709
3710 *'indentexpr'* *'inde'*
3711'indentexpr' 'inde' string (default "")
3712 local to buffer
3713 {not in Vi}
3714 {not available when compiled without the |+cindent|
3715 or |+eval| features}
3716 Expression which is evaluated to obtain the proper indent for a line.
3717 It is used when a new line is created, for the |=| operator and
3718 in Insert mode as specified with the 'indentkeys' option.
3719 When this option is not empty, it overrules the 'cindent' and
3720 'smartindent' indenting.
3721 When 'paste' is set this option is not used for indenting.
3722 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003723 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 when the expression is evaluated (but it may be moved around).
3725 The expression must return the number of spaces worth of indent. It
3726 can return "-1" to keep the current indent (this means 'autoindent' is
3727 used for the indent).
3728 Functions useful for computing the indent are |indent()|, |cindent()|
3729 and |lispindent()|.
3730 The evaluation of the expression must not have side effects! It must
3731 not change the text, jump to another window, etc. Afterwards the
3732 cursor position is always restored, thus the cursor may be moved.
3733 Normally this option would be set to call a function: >
3734 :set indentexpr=GetMyIndent()
3735< Error messages will be suppressed, unless the 'debug' option contains
3736 "msg".
3737 See |indent-expression|. Also see |eval-sandbox|.
3738 NOTE: This option is made empty when 'compatible' is set.
3739
3740 *'indentkeys'* *'indk'*
3741'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3742 local to buffer
3743 {not in Vi}
3744 {not available when compiled without the |+cindent|
3745 feature}
3746 A list of keys that, when typed in Insert mode, cause reindenting of
3747 the current line. Only happens if 'indentexpr' isn't empty.
3748 The format is identical to 'cinkeys', see |indentkeys-format|.
3749 See |C-indenting| and |indent-expression|.
3750
3751 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3752'infercase' 'inf' boolean (default off)
3753 local to buffer
3754 {not in Vi}
3755 When doing keyword completion in insert mode |ins-completion|, and
3756 'ignorecase' is also on, the case of the match is adjusted. If the
3757 typed text contains a lowercase letter where the match has an upper
3758 case letter, the completed part is made lowercase. If the typed text
3759 has no lowercase letters and the match has a lowercase letter where
3760 the typed text has an uppercase letter, and there is a letter before
3761 it, the completed part is made uppercase.
3762
3763 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3764'insertmode' 'im' boolean (default off)
3765 global
3766 {not in Vi}
3767 Makes Vim work in a way that Insert mode is the default mode. Useful
3768 if you want to use Vim as a modeless editor. Used for |evim|.
3769 These Insert mode commands will be useful:
3770 - Use the cursor keys to move around.
3771 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3772 this is a mapping, it is executed as if 'insertmode' was off.
3773 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003775 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3776 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
3778 These items change when 'insertmode' is set:
3779 - when starting to edit of a file, Vim goes to Insert mode.
3780 - <Esc> in Insert mode is a no-op and beeps.
3781 - <Esc> in Normal mode makes Vim go to Insert mode.
3782 - CTRL-L in Insert mode is a command, it is not inserted.
3783 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3784 However, when <Esc> is used inside a mapping, it behaves like
3785 'insertmode' was not set. This was done to be able to use the same
3786 mappings with 'insertmode' set or not set.
3787 When executing commands with |:normal| 'insertmode' is not used.
3788
3789 NOTE: This option is reset when 'compatible' is set.
3790
3791 *'isfname'* *'isf'*
3792'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3793 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3794 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3795 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3796 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3797 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3798 global
3799 {not in Vi}
3800 The characters specified by this option are included in file names and
3801 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003802 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 Multi-byte characters 256 and above are always included, only the
3804 characters up to 255 are specified with this option.
3805 For UTF-8 the characters 0xa0 to 0xff are included as well.
3806
3807 Note that on systems using a backslash as path separator, Vim tries to
3808 do its best to make it work as you would expect. That is a bit
3809 tricky, since Vi originally used the backslash to escape special
3810 characters. Vim will not remove a backslash in front of a normal file
3811 name character on these systems, but it will on Unix and alikes. The
3812 '&' and '^' are not included by default, because these are special for
3813 cmd.exe.
3814
3815 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003816 Each part can be a single character number or a range. A range is two
3817 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 decimal number between 0 and 255 or the ASCII character itself (does
3819 not work for digits). Example:
3820 "_,-,128-140,#-43" (include '_' and '-' and the range
3821 128 to 140 and '#' to 43)
3822 If a part starts with '^', the following character number or range
3823 will be excluded from the option. The option is interpreted from left
3824 to right. Put the excluded character after the range where it is
3825 included. To include '^' itself use it as the last character of the
3826 option or the end of a range. Example:
3827 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3828 If the character is '@', all characters where isalpha() returns TRUE
3829 are included. Normally these are the characters a to z and A to Z,
3830 plus accented characters. To include '@' itself use "@-@". Examples:
3831 "@,^a-z" All alphabetic characters, excluding lower
3832 case letters.
3833 "a-z,A-Z,@-@" All letters plus the '@' character.
3834 A comma can be included by using it where a character number is
3835 expected. Example:
3836 "48-57,,,_" Digits, comma and underscore.
3837 A comma can be excluded by prepending a '^'. Example:
3838 " -~,^,,9" All characters from space to '~', excluding
3839 comma, plus <Tab>.
3840 See |option-backslash| about including spaces and backslashes.
3841
3842 *'isident'* *'isi'*
3843'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3844 "@,48-57,_,128-167,224-235"
3845 otherwise: "@,48-57,_,192-255")
3846 global
3847 {not in Vi}
3848 The characters given by this option are included in identifiers.
3849 Identifiers are used in recognizing environment variables and after a
3850 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003851 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 option.
3853 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003854 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3856
3857 *'iskeyword'* *'isk'*
3858'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3859 "@,48-57,_,128-167,224-235"
3860 otherwise: "@,48-57,_,192-255"
3861 Vi default: "@,48-57,_")
3862 local to buffer
3863 {not in Vi}
3864 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003865 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 'isfname' for a description of the format of this option. For C
3867 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3868 For a help file it is set to all non-blank printable characters except
3869 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3870 command).
3871 When the 'lisp' option is on the '-' character is always included.
3872 NOTE: This option is set to the Vi default value when 'compatible' is
3873 set and to the Vim default value when 'compatible' is reset.
3874
3875 *'isprint'* *'isp'*
3876'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3877 "@,~-255"; otherwise: "@,161-255")
3878 global
3879 {not in Vi}
3880 The characters given by this option are displayed directly on the
3881 screen. It is also used for "\p" in a |pattern|. The characters from
3882 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3883 even when they are not included in 'isprint' or excluded. See
3884 'isfname' for a description of the format of this option.
3885
3886 Non-printable characters are displayed with two characters:
3887 0 - 31 "^@" - "^_"
3888 32 - 126 always single characters
3889 127 "^?"
3890 128 - 159 "~@" - "~_"
3891 160 - 254 "| " - "|~"
3892 255 "~?"
3893 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3894 displayed as <xx>, with the hexadecimal value of the byte.
3895 When 'display' contains "uhex" all unprintable characters are
3896 displayed as <xx>.
3897 The NonText highlighting will be used for unprintable characters.
3898 |hl-NonText|
3899
3900 Multi-byte characters 256 and above are always included, only the
3901 characters up to 255 are specified with this option. When a character
3902 is printable but it is not available in the current font, a
3903 replacement character will be shown.
3904 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3905 There is no option to specify these characters.
3906
3907 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3908'joinspaces' 'js' boolean (default on)
3909 global
3910 {not in Vi}
3911 Insert two spaces after a '.', '?' and '!' with a join command.
3912 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3913 Otherwise only one space is inserted.
3914 NOTE: This option is set when 'compatible' is set.
3915
3916 *'key'*
3917'key' string (default "")
3918 local to buffer
3919 {not in Vi}
3920 The key that is used for encrypting and decrypting the current buffer.
3921 See |encryption|.
3922 Careful: Do not set the key value by hand, someone might see the typed
3923 key. Use the |:X| command. But you can make 'key' empty: >
3924 :set key=
3925< It is not possible to get the value of this option with ":set key" or
3926 "echo &key". This is to avoid showing it to someone who shouldn't
3927 know. It also means you cannot see it yourself once you have set it,
3928 be careful not to make a typing error!
3929
3930 *'keymap'* *'kmp'* *E544*
3931'keymap' 'kmp' string (default "")
3932 local to buffer
3933 {not in Vi}
3934 {only available when compiled with the |+keymap|
3935 feature}
3936 Name of a keyboard mapping. See |mbyte-keymap|.
3937 Setting this option to a valid keymap name has the side effect of
3938 setting 'iminsert' to one, so that the keymap becomes effective.
3939 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003940 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941
3942 *'keymodel'* *'km'*
3943'keymodel' 'km' string (default "")
3944 global
3945 {not in Vi}
3946 List of comma separated words, which enable special things that keys
3947 can do. These values can be used:
3948 startsel Using a shifted special key starts selection (either
3949 Select mode or Visual mode, depending on "key" being
3950 present in 'selectmode').
3951 stopsel Using a not-shifted special key stops selection.
3952 Special keys in this context are the cursor keys, <End>, <Home>,
3953 <PageUp> and <PageDown>.
3954 The 'keymodel' option is set by the |:behave| command.
3955
3956 *'keywordprg'* *'kp'*
3957'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3958 OS/2: "view /", VMS: "help")
3959 global or local to buffer |global-local|
3960 {not in Vi}
3961 Program to use for the |K| command. Environment variables are
3962 expanded |:set_env|. ":help" may be used to access the Vim internal
3963 help. (Note that previously setting the global option to the empty
3964 value did this, which is now deprecated.)
3965 When "man" is used, Vim will automatically translate a count for the
3966 "K" command to a section number. Also for "man -s", in which case the
3967 "-s" is removed when there is no count.
3968 See |option-backslash| about including spaces and backslashes.
3969 Example: >
3970 :set keywordprg=man\ -s
3971< This option cannot be set from a |modeline| or in the |sandbox|, for
3972 security reasons.
3973
3974 *'langmap'* *'lmap'* *E357* *E358*
3975'langmap' 'lmap' string (default "")
3976 global
3977 {not in Vi}
3978 {only available when compiled with the |+langmap|
3979 feature}
3980 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003981 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 inserted directly. When in command mode the 'langmap' option takes
3983 care of translating these special characters to the original meaning
3984 of the key. This means you don't have to change the keyboard mode to
3985 be able to execute Normal mode commands.
3986 This is the opposite of the 'keymap' option, where characters are
3987 mapped in Insert mode.
3988 This only works for 8-bit characters. The value of 'langmap' may be
3989 specified with multi-byte characters (e.g., UTF-8), but only the lower
3990 8 bits of each character will be used.
3991
3992 Example (for Greek): *greek* >
3993 :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
3994< Example (exchanges meaning of z and y for commands): >
3995 :set langmap=zy,yz,ZY,YZ
3996<
3997 The 'langmap' option is a list of parts, separated with commas. Each
3998 part can be in one of two forms:
3999 1. A list of pairs. Each pair is a "from" character immediately
4000 followed by the "to" character. Examples: "aA", "aAbBcC".
4001 2. A list of "from" characters, a semi-colon and a list of "to"
4002 characters. Example: "abc;ABC"
4003 Example: "aA,fgh;FGH,cCdDeE"
4004 Special characters need to be preceded with a backslash. These are
4005 ";", ',' and backslash itself.
4006
4007 This will allow you to activate vim actions without having to switch
4008 back and forth between the languages. Your language characters will
4009 be understood as normal vim English characters (according to the
4010 langmap mappings) in the following cases:
4011 o Normal/Visual mode (commands, buffer/register names, user mappings)
4012 o Insert/Replace Mode: Register names after CTRL-R
4013 o Insert/Replace Mode: Mappings
4014 Characters entered in Command-line mode will NOT be affected by
4015 this option. Note that this option can be changed at any time
4016 allowing to switch between mappings for different languages/encodings.
4017 Use a mapping to avoid having to type it each time!
4018
4019 *'langmenu'* *'lm'*
4020'langmenu' 'lm' string (default "")
4021 global
4022 {not in Vi}
4023 {only available when compiled with the |+menu| and
4024 |+multi_lang| features}
4025 Language to use for menu translation. Tells which file is loaded
4026 from the "lang" directory in 'runtimepath': >
4027 "lang/menu_" . &langmenu . ".vim"
4028< (without the spaces). For example, to always use the Dutch menus, no
4029 matter what $LANG is set to: >
4030 :set langmenu=nl_NL.ISO_8859-1
4031< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004032 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 If your $LANG is set to a non-English language but you do want to use
4034 the English menus: >
4035 :set langmenu=none
4036< This option must be set before loading menus, switching on filetype
4037 detection or syntax highlighting. Once the menus are defined setting
4038 this option has no effect. But you could do this: >
4039 :source $VIMRUNTIME/delmenu.vim
4040 :set langmenu=de_DE.ISO_8859-1
4041 :source $VIMRUNTIME/menu.vim
4042< Warning: This deletes all menus that you defined yourself!
4043
4044 *'laststatus'* *'ls'*
4045'laststatus' 'ls' number (default 1)
4046 global
4047 {not in Vi}
4048 The value of this option influences when the last window will have a
4049 status line:
4050 0: never
4051 1: only if there are at least two windows
4052 2: always
4053 The screen looks nicer with a status line if you have several
4054 windows, but it takes another screen line. |status-line|
4055
4056 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4057'lazyredraw' 'lz' boolean (default off)
4058 global
4059 {not in Vi}
4060 When this option is set, the screen will not be redrawn while
4061 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004062 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 update use |:redraw|.
4064
4065 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4066'linebreak' 'lbr' boolean (default off)
4067 local to window
4068 {not in Vi}
4069 {not available when compiled without the |+linebreak|
4070 feature}
4071 If on Vim will wrap long lines at a character in 'breakat' rather
4072 than at the last character that fits on the screen. Unlike
4073 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4074 it only affects the way the file is displayed, not its contents. The
4075 value of 'showbreak' is used to put in front of wrapped lines.
4076 This option is not used when the 'wrap' option is off or 'list' is on.
4077 Note that <Tab> characters after an <EOL> are mostly not displayed
4078 with the right amount of white space.
4079
4080 *'lines'* *E593*
4081'lines' number (default 24 or terminal height)
4082 global
4083 Number of lines of the Vim window.
4084 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004085 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086 When Vim is running in the GUI or in a resizable window, setting this
4087 option will cause the window size to be changed. When you only want
4088 to use the size for the GUI, put the command in your |gvimrc| file.
4089 Vim limits the number of lines to what fits on the screen. You can
4090 use this command to get the tallest window possible: >
4091 :set lines=999
4092< If you get less lines than expected, check the 'guiheadroom' option.
4093 When you set this option and Vim is unable to change the physical
4094 number of lines of the display, the display may be messed up.
4095
4096 *'linespace'* *'lsp'*
4097'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4098 global
4099 {not in Vi}
4100 {only in the GUI}
4101 Number of pixel lines inserted between characters. Useful if the font
4102 uses the full character cell height, making lines touch each other.
4103 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004104 With some fonts there can be too much room between lines (to have
4105 space for ascents and descents). Then it makes sense to set
4106 'linespace' to a negative value. This may cause display problems
4107 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004108
4109 *'lisp'* *'nolisp'*
4110'lisp' boolean (default off)
4111 local to buffer
4112 {not available when compiled without the |+lispindent|
4113 feature}
4114 Lisp mode: When <Enter> is typed in insert mode set the indent for
4115 the next line to Lisp standards (well, sort of). Also happens with
4116 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4117 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4118 better. Also see 'lispwords'.
4119 The '-' character is included in keyword characters. Redefines the
4120 "=" operator to use this same indentation algorithm rather than
4121 calling an external program if 'equalprg' is empty.
4122 This option is not used when 'paste' is set.
4123 {Vi: Does it a little bit differently}
4124
4125 *'lispwords'* *'lw'*
4126'lispwords' 'lw' string (default is very long)
4127 global
4128 {not in Vi}
4129 {not available when compiled without the |+lispindent|
4130 feature}
4131 Comma separated list of words that influence the Lisp indenting.
4132 |'lisp'|
4133
4134 *'list'* *'nolist'*
4135'list' boolean (default off)
4136 local to window
4137 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4138 see the difference between tabs and spaces and for trailing blanks.
4139 Note that this will also affect formatting (set with 'textwidth' or
4140 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4141 changing the way tabs are displayed.
4142
4143 *'listchars'* *'lcs'*
4144'listchars' 'lcs' string (default "eol:$")
4145 global
4146 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004147 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 settings.
4149 eol:c Character to show at the end of each line. When
4150 omitted, there is no extra character at the end of the
4151 line.
4152 tab:xy Two characters to be used to show a Tab. The first
4153 char is used once. The second char is repeated to
4154 fill the space that the Tab normally occupies.
4155 "tab:>-" will show a Tab that takes four spaces as
4156 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004157 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 trailing spaces are blank.
4159 extends:c Character to show in the last column, when 'wrap' is
4160 off and the line continues beyond the right of the
4161 screen.
4162 precedes:c Character to show in the first column, when 'wrap'
4163 is off and there is text preceding the character
4164 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004165 nbsp:c Character to show for a non-breakable space (character
4166 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004168 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 be used when 'encoding' is "utf-8", otherwise only printable
4170 characters are allowed.
4171
4172 Examples: >
4173 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004174 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 :set lcs=extends:>,precedes:<
4176< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004177 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178
4179 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4180'loadplugins' 'lpl' boolean (default on)
4181 global
4182 {not in Vi}
4183 When on the plugin scripts are loaded when starting up |load-plugins|.
4184 This option can be reset in your |vimrc| file to disable the loading
4185 of plugins.
4186 Note that using the "-u NONE" and "--noplugin" command line arguments
4187 reset this option. |-u| |--noplugin|
4188
4189 *'magic'* *'nomagic'*
4190'magic' boolean (default on)
4191 global
4192 Changes the special characters that can be used in search patterns.
4193 See |pattern|.
4194 NOTE: To avoid portability problems with using patterns, always keep
4195 this option at the default "on". Only switch it off when working with
4196 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004197 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198
4199 *'makeef'* *'mef'*
4200'makeef' 'mef' string (default: "")
4201 global
4202 {not in Vi}
4203 {not available when compiled without the |+quickfix|
4204 feature}
4205 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4206 and the |:grep| command.
4207 When it is empty, an internally generated temp file will be used.
4208 When "##" is included, it is replaced by a number to make the name
4209 unique. This makes sure that the ":make" command doesn't overwrite an
4210 existing file.
4211 NOT used for the ":cf" command. See 'errorfile' for that.
4212 Environment variables are expanded |:set_env|.
4213 See |option-backslash| about including spaces and backslashes.
4214 This option cannot be set from a |modeline| or in the |sandbox|, for
4215 security reasons.
4216
4217 *'makeprg'* *'mp'*
4218'makeprg' 'mp' string (default "make", VMS: "MMS")
4219 global or local to buffer |global-local|
4220 {not in Vi}
4221 Program to use for the ":make" command. See |:make_makeprg|. This
4222 option may contain '%' and '#' characters, which are expanded like
4223 when used in a command-line. Environment variables are expanded
4224 |:set_env|. See |option-backslash| about including spaces and
4225 backslashes. Note that a '|' must be escaped twice: once for ":set"
4226 and once for the interpretation of a command. When you use a filter
4227 called "myfilter" do it like this: >
4228 :set makeprg=gmake\ \\\|\ myfilter
4229< The placeholder "$*" can be given (even multiple times) to specify
4230 where the arguments will be included, for example: >
4231 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4232< This option cannot be set from a |modeline| or in the |sandbox|, for
4233 security reasons.
4234
4235 *'matchpairs'* *'mps'*
4236'matchpairs' 'mps' string (default "(:),{:},[:]")
4237 local to buffer
4238 {not in Vi}
4239 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004240 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 must be different. The characters must be separated by a colon. The
4242 pairs must be separated by a comma. Example for including '<' and '>'
4243 (HTML): >
4244 :set mps+=<:>
4245
4246< A more exotic example, to jump between the '=' and ';' in an
4247 assignment, useful for languages like C and Java: >
4248 :au FileType c,cpp,java set mps+==:;
4249
4250< For a more advanced way of using "%", see the matchit.vim plugin in
4251 the $VIMRUNTIME/macros directory. |add-local-help|
4252
4253 *'matchtime'* *'mat'*
4254'matchtime' 'mat' number (default 5)
4255 global
4256 {not in Vi}{in Nvi}
4257 Tenths of a second to show the matching paren, when 'showmatch' is
4258 set. Note that this is not in milliseconds, like other options that
4259 set a time. This is to be compatible with Nvi.
4260
4261 *'maxfuncdepth'* *'mfd'*
4262'maxfuncdepth' 'mfd' number (default 100)
4263 global
4264 {not in Vi}
4265 Maximum depth of function calls for user functions. This normally
4266 catches endless recursion. When using a recursive function with
4267 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4268 more memory, there is the danger of failing when memory is exhausted.
4269 See also |:function|.
4270
4271 *'maxmapdepth'* *'mmd'* *E223*
4272'maxmapdepth' 'mmd' number (default 1000)
4273 global
4274 {not in Vi}
4275 Maximum number of times a mapping is done without resulting in a
4276 character to be used. This normally catches endless mappings, like
4277 ":map x y" with ":map y x". It still does not catch ":map g wg",
4278 because the 'w' is used before the next mapping is done. See also
4279 |key-mapping|.
4280
4281 *'maxmem'* *'mm'*
4282'maxmem' 'mm' number (default between 256 to 5120 (system
4283 dependent) or half the amount of memory
4284 available)
4285 global
4286 {not in Vi}
4287 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4288 limit is reached allocating extra memory for a buffer will cause
4289 other memory to be freed. Maximum value 2000000. Use this to work
4290 without a limit. Also see 'maxmemtot'.
4291
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004292 *'maxmempattern'* *'mmp'*
4293'maxmempattern' 'mmp' number (default 1000)
4294 global
4295 {not in Vi}
4296 Maximum amount of memory (in Kbyte) to use for pattern matching.
4297 Maximum value 2000000. Use this to work without a limit.
4298 *E363*
4299 When Vim runs into the limit it gives an error message mostly behaves
4300 like CTRL-C was typed.
4301 Running into the limit often means that the pattern is very
4302 inefficient or too complex. This may already happen with the pattern
4303 "\(.\)*" on a very long line. ".*" works much better.
4304 Vim may run out of memory before hitting the 'maxmempattern' limit.
4305
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 *'maxmemtot'* *'mmt'*
4307'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4308 dependent) or half the amount of memory
4309 available)
4310 global
4311 {not in Vi}
4312 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004313 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 'maxmem'.
4315
4316 *'menuitems'* *'mis'*
4317'menuitems' 'mis' number (default 25)
4318 global
4319 {not in Vi}
4320 {not available when compiled without the |+menu|
4321 feature}
4322 Maximum number of items to use in a menu. Used for menus that are
4323 generated from a list of items, e.g., the Buffers menu. Changing this
4324 option has no direct effect, the menu must be refreshed first.
4325
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004326 *'mkspellmem'* *'msm'*
4327'mkspellmem' 'msm' string (default "460000,2000,500")
4328 global
4329 {not in Vi}
4330 {not available when compiled without the |+syntax|
4331 feature}
4332 Parameters for |:mkspell|. This tunes when to start compressing the
4333 word tree. Compression can be slow when there are many words, but
4334 it's needed to avoid running out of memory. The amount of memory used
4335 per word depends very much on how similar the words are, that's why
4336 this tuning is complicated.
4337
4338 There are three numbers, separated by commas:
4339 {start},{inc},{added}
4340
4341 For most languages the uncompressed word tree fits in memory. {start}
4342 gives the amount of memory in Kbyte that can be used before any
4343 compression is done. It should be a bit smaller than the amount of
4344 memory that is available to Vim.
4345
4346 When going over the {start} limit the {inc} number specifies the
4347 amount of memory in Kbyte that can be allocated before another
4348 compression is done. A low number means compression is done after
4349 less words are added, which is slow. A high number means more memory
4350 will be allocated.
4351
4352 After doing compression, {added} times 1024 words can be added before
4353 the {inc} limit is ignored and compression is done when any extra
4354 amount of memory is needed. A low number means there is a smaller
4355 chance of hitting the {inc} limit, less memory is used but it's
4356 slower.
4357
4358 The languages for which these numbers are important are Italian and
4359 Hungarian. The default works for when you have about 512 Mbyte. If
4360 you have 1 Gbyte you could use: >
4361 :set mkspellmem=900000,3000,800
4362< If you have less than 512 Mbyte |:mkspell| may fail for some
4363 languages, no matter what you set 'mkspellmem' to.
4364
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4366'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4367 local to buffer
4368 *'modelines'* *'mls'*
4369'modelines' 'mls' number (default 5)
4370 global
4371 {not in Vi}
4372 If 'modeline' is on 'modelines' gives the number of lines that is
4373 checked for set commands. If 'modeline' is off or 'modelines' is zero
4374 no lines are checked. See |modeline|.
4375 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4376 set and to the Vim default value when 'compatible' is reset.
4377
4378 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4379'modifiable' 'ma' boolean (default on)
4380 local to buffer
4381 {not in Vi} *E21*
4382 When off the buffer contents cannot be changed. The 'fileformat' and
4383 'fileencoding' options also can't be changed.
4384 Can be reset with the |-M| command line argument.
4385
4386 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4387'modified' 'mod' boolean (default off)
4388 local to buffer
4389 {not in Vi}
4390 When on, the buffer is considered to be modified. This option is set
4391 when:
4392 1. A change was made to the text since it was last written. Using the
4393 |undo| command to go back to the original text will reset the
4394 option. But undoing changes that were made before writing the
4395 buffer will set the option again, since the text is different from
4396 when it was written.
4397 2. 'fileformat' or 'fileencoding' is different from its original
4398 value. The original value is set when the buffer is read or
4399 written. A ":set nomodified" command also resets the original
4400 values to the current values and the 'modified' option will be
4401 reset.
4402 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4403 will be ignored.
4404
4405 *'more'* *'nomore'*
4406'more' boolean (Vim default: on, Vi default: off)
4407 global
4408 {not in Vi}
4409 When on, listings pause when the whole screen is filled. You will get
4410 the |more-prompt|. When this option is off there are no pauses, the
4411 listing continues until finished.
4412 NOTE: This option is set to the Vi default value when 'compatible' is
4413 set and to the Vim default value when 'compatible' is reset.
4414
4415 *'mouse'* *E538*
4416'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4417 global
4418 {not in Vi}
4419 Enable the use of the mouse. Only works for certain terminals
4420 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4421 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4422 The mouse can be enabled for different modes:
4423 n Normal mode
4424 v Visual mode
4425 i Insert mode
4426 c Command-line mode
4427 h all previous modes when editing a help file
4428 a all previous modes
4429 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430 Normally you would enable the mouse in all four modes with: >
4431 :set mouse=a
4432< When the mouse is not enabled, the GUI will still use the mouse for
4433 modeless selection. This doesn't move the text cursor.
4434
4435 See |mouse-using|. Also see |'clipboard'|.
4436
4437 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004438 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439 the mouse buttons can still be used by keeping the shift key pressed.
4440 Also see the 'clipboard' option.
4441
4442 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4443'mousefocus' 'mousef' boolean (default off)
4444 global
4445 {not in Vi}
4446 {only works in the GUI}
4447 The window that the mouse pointer is on is automatically activated.
4448 When changing the window layout or window focus in another way, the
4449 mouse pointer is moved to the window with keyboard focus. Off is the
4450 default because it makes using the pull down menus a little goofy, as
4451 a pointer transit may activate a window unintentionally.
4452
4453 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4454'mousehide' 'mh' boolean (default on)
4455 global
4456 {not in Vi}
4457 {only works in the GUI}
4458 When on, the mouse pointer is hidden when characters are typed.
4459 The mouse pointer is restored when the mouse is moved.
4460
4461 *'mousemodel'* *'mousem'*
4462'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4463 global
4464 {not in Vi}
4465 Sets the model to use for the mouse. The name mostly specifies what
4466 the right mouse button is used for:
4467 extend Right mouse button extends a selection. This works
4468 like in an xterm.
4469 popup Right mouse button pops up a menu. The shifted left
4470 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004471 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 popup_setpos Like "popup", but the cursor will be moved to the
4473 position where the mouse was clicked, and thus the
4474 selected operation will act upon the clicked object.
4475 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004476 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 course, that right clicking outside a selection will
4478 end Visual mode.
4479 Overview of what button does what for each model:
4480 mouse extend popup(_setpos) ~
4481 left click place cursor place cursor
4482 left drag start selection start selection
4483 shift-left search word extend selection
4484 right click extend selection popup menu (place cursor)
4485 right drag extend selection -
4486 middle click paste paste
4487
4488 In the "popup" model the right mouse button produces a pop-up menu.
4489 You need to define this first, see |popup-menu|.
4490
4491 Note that you can further refine the meaning of buttons with mappings.
4492 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4493 selection (because that's handled in the GUI code directly).
4494
4495 The 'mousemodel' option is set by the |:behave| command.
4496
4497 *'mouseshape'* *'mouses'* *E547*
4498'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004499 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 global
4501 {not in Vi}
4502 {only available when compiled with the |+mouseshape|
4503 feature}
4504 This option tells Vim what the mouse pointer should look like in
4505 different modes. The option is a comma separated list of parts, much
4506 like used for 'guicursor'. Each part consist of a mode/location-list
4507 and an argument-list:
4508 mode-list:shape,mode-list:shape,..
4509 The mode-list is a dash separated list of these modes/locations:
4510 In a normal window: ~
4511 n Normal mode
4512 v Visual mode
4513 ve Visual mode with 'selection' "exclusive" (same as 'v',
4514 if not specified)
4515 o Operator-pending mode
4516 i Insert mode
4517 r Replace mode
4518
4519 Others: ~
4520 c appending to the command-line
4521 ci inserting in the command-line
4522 cr replacing in the command-line
4523 m at the 'Hit ENTER' or 'More' prompts
4524 ml idem, but cursor in the last line
4525 e any mode, pointer below last window
4526 s any mode, pointer on a status line
4527 sd any mode, while dragging a status line
4528 vs any mode, pointer on a vertical separator line
4529 vd any mode, while dragging a vertical separator line
4530 a everywhere
4531
4532 The shape is one of the following:
4533 avail name looks like ~
4534 w x arrow Normal mouse pointer
4535 w x blank no pointer at all (use with care!)
4536 w x beam I-beam
4537 w x updown up-down sizing arrows
4538 w x leftright left-right sizing arrows
4539 w x busy The system's usual busy pointer
4540 w x no The system's usual 'no input' pointer
4541 x udsizing indicates up-down resizing
4542 x lrsizing indicates left-right resizing
4543 x crosshair like a big thin +
4544 x hand1 black hand
4545 x hand2 white hand
4546 x pencil what you write with
4547 x question big ?
4548 x rightup-arrow arrow pointing right-up
4549 w x up-arrow arrow pointing up
4550 x <number> any X11 pointer number (see X11/cursorfont.h)
4551
4552 The "avail" column contains a 'w' if the shape is available for Win32,
4553 x for X11.
4554 Any modes not specified or shapes not available use the normal mouse
4555 pointer.
4556
4557 Example: >
4558 :set mouseshape=s:udsizing,m:no
4559< will make the mouse turn to a sizing arrow over the status lines and
4560 indicate no input when the hit-enter prompt is displayed (since
4561 clicking the mouse has no effect in this state.)
4562
4563 *'mousetime'* *'mouset'*
4564'mousetime' 'mouset' number (default 500)
4565 global
4566 {not in Vi}
4567 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4568 time in msec between two mouse clicks for the second click to be
4569 recognized as a multi click.
4570
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004571 *'mzquantum'* *'mzq'*
4572'mzquantum' 'mzq' number (default 100)
4573 global
4574 {not in Vi}
4575 {not available when compiled without the |+mzscheme|
4576 feature}
4577 The number of milliseconds between polls for MzScheme threads.
4578 Negative or zero value means no thread scheduling.
4579
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 *'nrformats'* *'nf'*
4581'nrformats' 'nf' string (default "octal,hex")
4582 local to buffer
4583 {not in Vi}
4584 This defines what bases Vim will consider for numbers when using the
4585 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4586 respectively; see |CTRL-A| for more info on these commands.
4587 alpha if included, single alphabetical characters will be
4588 incremented or decremented. This is useful for a list with a
4589 letter index a), b), etc.
4590 octal if included, numbers that start with a zero will be considered
4591 to be octal. Example: Using CTRL-A on "007" results in "010".
4592 hex if included, numbers starting with "0x" or "0X" will be
4593 considered to be hexadecimal. Example: Using CTRL-X on
4594 "0x100" results in "0x0ff".
4595 Numbers which simply begin with a digit in the range 1-9 are always
4596 considered decimal. This also happens for numbers that are not
4597 recognized as octal or hex.
4598
4599 *'number'* *'nu'* *'nonumber'* *'nonu'*
4600'number' 'nu' boolean (default off)
4601 local to window
4602 Print the line number in front of each line. When the 'n' option is
4603 excluded from 'cpoptions' a wrapped line will not use the column of
4604 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004605 The 'numberwidth' option can be used to set the room used for the line
4606 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 When a long, wrapped line doesn't start with the first character, '-'
4608 characters are put before the number.
4609 See |hl-LineNr| for the highlighting used for the number.
4610
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004611 *'numberwidth'* *'nuw'*
4612'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4613 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004614 {not in Vi}
4615 {only available when compiled with the |+linebreak|
4616 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004617 Minimal number of columns to use for the line number. Only relevant
4618 when the 'number' option is set.
4619 Since one space is always between the number and the text, there is
4620 one less character for the number itself.
4621 The value is the minimum width. A bigger width is used when needed to
4622 fit the highest line number in the buffer. Thus with the Vim default
4623 of 4 there is room for a line number up to 999. When the buffer has
4624 1000 lines five columns will be used.
4625 The minimum value is 1, the maximum value is 10.
4626 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4627
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004628 *'omnifunc'* *'ofu'*
4629'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004630 local to buffer
4631 {not in Vi}
4632 {not available when compiled without the +eval
4633 or +insert_expand feature}
4634 This option specifies a function to be used for CTRL-X CTRL-O
4635 completion. |i_CTRL-X_CTRL-O|
4636
4637 For the use of the function see 'completefunc'.
4638
4639
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 *'osfiletype'* *'oft'* *E366*
4641'osfiletype' 'oft' string (RISC-OS default: "Text",
4642 others default: "")
4643 local to buffer
4644 {not in Vi}
4645 {only available when compiled with the |+osfiletype|
4646 feature}
4647 Some operating systems store extra information about files besides
4648 name, datestamp and permissions. This option contains the extra
4649 information, the nature of which will vary between systems.
4650 The value of this option is usually set when the file is loaded, and
4651 use to set the file type when file is written.
4652 It can affect the pattern matching of the automatic commands.
4653 |autocmd-osfiletypes|
4654
4655 *'paragraphs'* *'para'*
4656'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4657 global
4658 Specifies the nroff macros that separate paragraphs. These are pairs
4659 of two letters (see |object-motions|).
4660
4661 *'paste'* *'nopaste'*
4662'paste' boolean (default off)
4663 global
4664 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004665 Put Vim in Paste mode. This is useful if you want to cut or copy
4666 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 unexpected effects.
4668 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004669 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 knows about pasting and will mostly do the right thing without 'paste'
4671 being set. The same is true for a terminal where Vim handles the
4672 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004673 This option is reset when starting the GUI. Thus if you set it in
4674 your .vimrc it will work in a terminal, but not in the GUI. Setting
4675 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4676 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677 When the 'paste' option is switched on (also when it was already on):
4678 - mapping in Insert mode and Command-line mode is disabled
4679 - abbreviations are disabled
4680 - 'textwidth' is set to 0
4681 - 'wrapmargin' is set to 0
4682 - 'autoindent' is reset
4683 - 'smartindent' is reset
4684 - 'softtabstop' is set to 0
4685 - 'revins' is reset
4686 - 'ruler' is reset
4687 - 'showmatch' is reset
4688 - 'formatoptions' is used like it is empty
4689 These options keep their value, but their effect is disabled:
4690 - 'lisp'
4691 - 'indentexpr'
4692 - 'cindent'
4693 NOTE: When you start editing another file while the 'paste' option is
4694 on, settings from the modelines or autocommands may change the
4695 settings again, causing trouble when pasting text. You might want to
4696 set the 'paste' option again.
4697 When the 'paste' option is reset the mentioned options are restored to
4698 the value before the moment 'paste' was switched from off to on.
4699 Resetting 'paste' before ever setting it does not have any effect.
4700 Since mapping doesn't work while 'paste' is active, you need to use
4701 the 'pastetoggle' option to toggle the 'paste' option with some key.
4702
4703 *'pastetoggle'* *'pt'*
4704'pastetoggle' 'pt' string (default "")
4705 global
4706 {not in Vi}
4707 When non-empty, specifies the key sequence that toggles the 'paste'
4708 option. This is like specifying a mapping: >
4709 :map {keys} :set invpaste<CR>
4710< Where {keys} is the value of 'pastetoggle'.
4711 The difference is that it will work even when 'paste' is set.
4712 'pastetoggle' works in Insert mode and Normal mode, but not in
4713 Command-line mode.
4714 Mappings are checked first, thus overrule 'pastetoggle'. However,
4715 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4716 this: >
4717 :map <F10> :set paste<CR>
4718 :map <F11> :set nopaste<CR>
4719 :imap <F10> <C-O>:set paste<CR>
4720 :imap <F11> <nop>
4721 :set pastetoggle=<F11>
4722< This will make <F10> start paste mode and <F11> stop paste mode.
4723 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4724 mode everything is inserted literally, except the 'pastetoggle' key
4725 sequence.
4726
4727 *'pex'* *'patchexpr'*
4728'patchexpr' 'pex' string (default "")
4729 global
4730 {not in Vi}
4731 {not available when compiled without the |+diff|
4732 feature}
4733 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004734 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735
4736 *'patchmode'* *'pm'* *E206*
4737'patchmode' 'pm' string (default "")
4738 global
4739 {not in Vi}
4740 When non-empty the oldest version of a file is kept. This can be used
4741 to keep the original version of a file if you are changing files in a
4742 source distribution. Only the first time that a file is written a
4743 copy of the original file will be kept. The name of the copy is the
4744 name of the original file with the string in the 'patchmode' option
4745 appended. This option should start with a dot. Use a string like
4746 ".org". 'backupdir' must not be empty for this to work (Detail: The
4747 backup file is renamed to the patchmode file after the new file has
4748 been successfully written, that's why it must be possible to write a
4749 backup file). If there was no file to be backed up, an empty file is
4750 created.
4751 When the 'backupskip' pattern matches, a patchmode file is not made.
4752 Using 'patchmode' for compressed files appends the extension at the
4753 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4754 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004755 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756
4757 *'path'* *'pa'* *E343* *E345* *E347*
4758'path' 'pa' string (default on Unix: ".,/usr/include,,"
4759 on OS/2: ".,/emx/include,,"
4760 other systems: ".,,")
4761 global or local to buffer |global-local|
4762 {not in Vi}
4763 This is a list of directories which will be searched when using the
4764 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4765 being searched for has a relative path (not starting with '/'). The
4766 directories in the 'path' option may be relative or absolute.
4767 - Use commas to separate directory names: >
4768 :set path=.,/usr/local/include,/usr/include
4769< - Spaces can also be used to separate directory names (for backwards
4770 compatibility with version 3.0). To have a space in a directory
4771 name, precede it with an extra backslash, and escape the space: >
4772 :set path=.,/dir/with\\\ space
4773< - To include a comma in a directory name precede it with an extra
4774 backslash: >
4775 :set path=.,/dir/with\\,comma
4776< - To search relative to the directory of the current file, use: >
4777 :set path=.
4778< - To search in the current directory use an empty string between two
4779 commas: >
4780 :set path=,,
4781< - A directory name may end in a ':' or '/'.
4782 - Environment variables are expanded |:set_env|.
4783 - When using |netrw.vim| URLs can be used. For example, adding
4784 "http://www.vim.org" will make ":find index.html" work.
4785 - Search upwards and downwards in a directory tree:
4786 1) "*" matches a sequence of characters, e.g.: >
4787 :set path=/usr/include/*
4788< means all subdirectories in /usr/include (but not /usr/include
4789 itself). >
4790 :set path=/usr/*c
4791< matches /usr/doc and /usr/src.
4792 2) "**" matches a subtree, up to 100 directories deep. Example: >
4793 :set path=/home/user_x/src/**
4794< means search in the whole subtree under "/home/usr_x/src".
4795 3) If the path ends with a ';', this path is the startpoint
4796 for upward search.
4797 See |file-searching| for more info and exact syntax.
4798 {not available when compiled without the |+path_extra| feature}
4799 - Careful with '\' characters, type two to get one in the option: >
4800 :set path=.,c:\\include
4801< Or just use '/' instead: >
4802 :set path=.,c:/include
4803< Don't forget "." or files won't even be found in the same directory as
4804 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004805 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 it is something like 256 or 1024 characters.
4807 You can check if all the include files are found, using the value of
4808 'path', see |:checkpath|.
4809 The use of |:set+=| and |:set-=| is preferred when adding or removing
4810 directories from the list. This avoids problems when a future version
4811 uses another default. To remove the current directory use: >
4812 :set path-=
4813< To add the current directory use: >
4814 :set path+=
4815< To use an environment variable, you probably need to replace the
4816 separator. Here is an example to append $INCL, in which directory
4817 names are separated with a semi-colon: >
4818 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4819< Replace the ';' with a ':' or whatever separator is used. Note that
4820 this doesn't work when $INCL contains a comma or white space.
4821
4822 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4823'preserveindent' 'pi' boolean (default off)
4824 local to buffer
4825 {not in Vi}
4826 When changing the indent of the current line, preserve as much of the
4827 indent structure as possible. Normally the indent is replaced by a
4828 series of tabs followed by spaces as required (unless |'expandtab'| is
4829 enabled, in which case only spaces are used). Enabling this option
4830 means the indent will preserve as many existing characters as possible
4831 for indenting, and only add additional tabs or spaces as required.
4832 NOTE: When using ">>" multiple times the resulting indent is a mix of
4833 tabs and spaces. You might not like this.
4834 NOTE: 'preserveindent' is reset when 'compatible' is set.
4835 Also see 'copyindent'.
4836 Use |:retab| to clean up white space.
4837
4838 *'previewheight'* *'pvh'*
4839'previewheight' 'pvh' number (default 12)
4840 global
4841 {not in Vi}
4842 {not available when compiled without the |+windows| or
4843 |+quickfix| feature}
4844 Default height for a preview window. Used for |:ptag| and associated
4845 commands. Used for |CTRL-W_}| when no count is given.
4846
4847 *'previewwindow'* *'nopreviewwindow'*
4848 *'pvw'* *'nopvw'* *E590*
4849'previewwindow' 'pvw' boolean (default off)
4850 local to window
4851 {not in Vi}
4852 {not available when compiled without the |+windows| or
4853 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004854 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 set. It's normally not set directly, but by using one of the commands
4856 |:ptag|, |:pedit|, etc.
4857
4858 *'printdevice'* *'pdev'*
4859'printdevice' 'pdev' string (default empty)
4860 global
4861 {not in Vi}
4862 {only available when compiled with the |+printer|
4863 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004864 The name of the printer to be used for |:hardcopy|.
4865 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004866 This option cannot be set from a |modeline| or in the |sandbox|, for
4867 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004868
Bram Moolenaar8299df92004-07-10 09:47:34 +00004869 *'printencoding'* *'penc'*
4870'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 global
4872 {not in Vi}
4873 {only available when compiled with the |+printer|
4874 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004875 Sets the character encoding used when printing.
4876 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
4878 *'printexpr'* *'pexpr'*
4879'printexpr' 'pexpr' String (default: see below)
4880 global
4881 {not in Vi}
4882 {only available when compiled with the |+printer|
4883 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004884 Expression used to print the PostScript produced with |:hardcopy|.
4885 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886
Bram Moolenaar8299df92004-07-10 09:47:34 +00004887 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888'printfont' 'pfn' string (default "courier")
4889 global
4890 {not in Vi}
4891 {only available when compiled with the |+printer|
4892 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004893 The name of the font that will be used for |:hardcopy|.
4894 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895
4896 *'printheader'* *'pheader'*
4897'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4898 global
4899 {not in Vi}
4900 {only available when compiled with the |+printer|
4901 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004902 The format of the header produced in |:hardcopy| output.
4903 See |pheader-option|.
4904
4905 *'printmbcharset'* *'pmbcs'*
4906'printmbcharset' 'pmbcs' string (default "")
4907 global
4908 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004909 {only available when compiled with the |+printer|,
4910 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004911 The CJK character set to be used for CJK output from |:hardcopy|.
4912 See |pmbcs-option|.
4913
4914 *'printmbfont'* *'pmbfn'*
4915'printmbfont' 'pmbfn' string (default "")
4916 global
4917 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004918 {only available when compiled with the |+printer|,
4919 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004920 List of font names to be used for CJK output from |:hardcopy|.
4921 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922
4923 *'printoptions'* *'popt'*
4924'printoptions' 'popt' string (default "")
4925 global
4926 {not in Vi}
4927 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004928 List of items that control the format of the output of |:hardcopy|.
4929 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004931 *'prompt'* *'noprompt'*
4932'prompt' boolean (default on)
4933 global
4934 When on a ":" prompt is used in Ex mode.
4935
Bram Moolenaar677ee682005-01-27 14:41:15 +00004936 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004937'quoteescape' 'qe' string (default "\")
4938 local to buffer
4939 {not in Vi}
4940 The characters that are used to escape quotes in a string. Used for
4941 objects like a', a" and a` |a'|.
4942 When one of the characters in this option is found inside a string,
4943 the following character will be skipped. The default value makes the
4944 text "foo\"bar\\" considered to be one string.
4945
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4947'readonly' 'ro' boolean (default off)
4948 local to buffer
4949 If on, writes fail unless you use a '!'. Protects you from
4950 accidentally overwriting a file. Default on when Vim is started
4951 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004952 When using ":w!" the 'readonly' option is reset for the current
4953 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004955 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956
4957 *'remap'* *'noremap'*
4958'remap' boolean (default on)
4959 global
4960 Allows for mappings to work recursively. If you do not want this for
4961 a single entry, use the :noremap[!] command.
4962
4963 *'report'*
4964'report' number (default 2)
4965 global
4966 Threshold for reporting number of lines changed. When the number of
4967 changed lines is more than 'report' a message will be given for most
4968 ":" commands. If you want it always, set 'report' to 0.
4969 For the ":substitute" command the number of substitutions is used
4970 instead of the number of lines.
4971
4972 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4973'restorescreen' 'rs' boolean (default on)
4974 global
4975 {not in Vi} {only in Windows 95/NT console version}
4976 When set, the screen contents is restored when exiting Vim. This also
4977 happens when executing external commands.
4978
4979 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4980 options in your .vimrc. To disable restoring:
4981 set t_ti= t_te=
4982 To enable restoring (for an xterm):
4983 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4984 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4985
4986 *'revins'* *'ri'* *'norevins'* *'nori'*
4987'revins' 'ri' boolean (default off)
4988 global
4989 {not in Vi}
4990 {only available when compiled with the |+rightleft|
4991 feature}
4992 Inserting characters in Insert mode will work backwards. See "typing
4993 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4994 command in Insert mode, when 'allowrevins' is set.
4995 NOTE: This option is reset when 'compatible' or 'paste' is set.
4996
4997 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4998'rightleft' 'rl' boolean (default off)
4999 local to window
5000 {not in Vi}
5001 {only available when compiled with the |+rightleft|
5002 feature}
5003 When on, display orientation becomes right-to-left, i.e., characters
5004 that are stored in the file appear from the right to the left.
5005 Using this option, it is possible to edit files for languages that
5006 are written from the right to the left such as Hebrew and Arabic.
5007 This option is per window, so it is possible to edit mixed files
5008 simultaneously, or to view the same file in both ways (this is
5009 useful whenever you have a mixed text file with both right-to-left
5010 and left-to-right strings so that both sets are displayed properly
5011 in different windows). Also see |rileft.txt|.
5012
5013 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5014'rightleftcmd' 'rlc' string (default "search")
5015 local to window
5016 {not in Vi}
5017 {only available when compiled with the |+rightleft|
5018 feature}
5019 Each word in this option enables the command line editing to work in
5020 right-to-left mode for a group of commands:
5021
5022 search "/" and "?" commands
5023
5024 This is useful for languages such as Hebrew, Arabic and Farsi.
5025 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5026
5027 *'ruler'* *'ru'* *'noruler'* *'noru'*
5028'ruler' 'ru' boolean (default off)
5029 global
5030 {not in Vi}
5031 {not available when compiled without the
5032 |+cmdline_info| feature}
5033 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005034 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 text in the file is shown on the far right:
5036 Top first line is visible
5037 Bot last line is visible
5038 All first and last line are visible
5039 45% relative position in the file
5040 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005041 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005043 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 this option takes precedence over 'ruler' and 'rulerformat'
5045 If the number of characters displayed is different from the number of
5046 bytes in the text (e.g., for a TAB or a multi-byte character), both
5047 the text column (byte number) and the screen column are shown,
5048 separated with a dash.
5049 For an empty line "0-1" is shown.
5050 For an empty buffer the line number will also be zero: "0,0-1".
5051 This option is reset when the 'paste' option is set.
5052 If you don't want to see the ruler all the time but want to know where
5053 you are, use "g CTRL-G" |g_CTRL-G|.
5054 NOTE: This option is reset when 'compatible' is set.
5055
5056 *'rulerformat'* *'ruf'*
5057'rulerformat' 'ruf' string (default empty)
5058 global
5059 {not in Vi}
5060 {not available when compiled without the |+statusline|
5061 feature}
5062 When this option is not empty, it determines the content of the ruler
5063 string, as displayed for the 'ruler' option.
5064 The format of this option, is like that of 'statusline'.
5065 The default ruler width is 17 characters. To make the ruler 15
5066 characters wide, put "%15(" at the start and "%)" at the end.
5067 Example: >
5068 :set rulerformat=%15(%c%V\ %p%%%)
5069<
5070 *'runtimepath'* *'rtp'* *vimfiles*
5071'runtimepath' 'rtp' string (default:
5072 Unix: "$HOME/.vim,
5073 $VIM/vimfiles,
5074 $VIMRUNTIME,
5075 $VIM/vimfiles/after,
5076 $HOME/.vim/after"
5077 Amiga: "home:vimfiles,
5078 $VIM/vimfiles,
5079 $VIMRUNTIME,
5080 $VIM/vimfiles/after,
5081 home:vimfiles/after"
5082 PC, OS/2: "$HOME/vimfiles,
5083 $VIM/vimfiles,
5084 $VIMRUNTIME,
5085 $VIM/vimfiles/after,
5086 $HOME/vimfiles/after"
5087 Macintosh: "$VIM:vimfiles,
5088 $VIMRUNTIME,
5089 $VIM:vimfiles:after"
5090 RISC-OS: "Choices:vimfiles,
5091 $VIMRUNTIME,
5092 Choices:vimfiles/after"
5093 VMS: "sys$login:vimfiles,
5094 $VIM/vimfiles,
5095 $VIMRUNTIME,
5096 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005097 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 global
5099 {not in Vi}
5100 This is a list of directories which will be searched for runtime
5101 files:
5102 filetype.vim filetypes by file name |new-filetype|
5103 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005104 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 colors/ color scheme files |:colorscheme|
5106 compiler/ compiler files |:compiler|
5107 doc/ documentation |write-local-help|
5108 ftplugin/ filetype plugins |write-filetype-plugin|
5109 indent/ indent scripts |indent-expression|
5110 keymap/ key mapping files |mbyte-keymap|
5111 lang/ menu translations |:menutrans|
5112 menu.vim GUI menus |menu.vim|
5113 plugin/ plugin scripts |write-plugin|
5114 print/ files for printing |postscript-print-encoding|
5115 syntax/ syntax files |mysyntaxfile|
5116 tutor/ files for vimtutor |tutor|
5117
5118 And any other file searched for with the |:runtime| command.
5119
5120 The defaults for most systems are setup to search five locations:
5121 1. In your home directory, for your personal preferences.
5122 2. In a system-wide Vim directory, for preferences from the system
5123 administrator.
5124 3. In $VIMRUNTIME, for files distributed with Vim.
5125 *after-directory*
5126 4. In the "after" directory in the system-wide Vim directory. This is
5127 for the system administrator to overrule or add to the distributed
5128 defaults (rarely needed)
5129 5. In the "after" directory in your home directory. This is for
5130 personal preferences to overrule or add to the distributed defaults
5131 or system-wide settings (rarely needed).
5132
5133 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5134 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005135 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 wildcards.
5137 See |:runtime|.
5138 Example: >
5139 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5140< This will use the directory "~/vimruntime" first (containing your
5141 personal Vim runtime files), then "/mygroup/vim" (shared between a
5142 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5143 files).
5144 You probably should always include $VIMRUNTIME somewhere, to use the
5145 distributed runtime files. You can put a directory before $VIMRUNTIME
5146 to find files which replace a distributed runtime files. You can put
5147 a directory after $VIMRUNTIME to find files which add to distributed
5148 runtime files.
5149 This option cannot be set from a |modeline| or in the |sandbox|, for
5150 security reasons.
5151
5152 *'scroll'* *'scr'*
5153'scroll' 'scr' number (default: half the window height)
5154 local to window
5155 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5156 set to half the number of lines in the window when the window size
5157 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005158 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5160 the number of screen lines instead of file lines, makes a difference
5161 when lines wrap}
5162
5163 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5164'scrollbind' 'scb' boolean (default off)
5165 local to window
5166 {not in Vi}
5167 {not available when compiled without the |+scrollbind|
5168 feature}
5169 See also |scroll-binding|. When this option is set, the current
5170 window scrolls as other scrollbind windows (windows that also have
5171 this option set) scroll. This option is useful for viewing the
5172 differences between two versions of a file, see 'diff'.
5173 See |'scrollopt'| for options that determine how this option should be
5174 interpreted.
5175 This option is mostly reset when splitting a window to edit another
5176 file. This means that ":split | edit file" results in two windows
5177 with scroll-binding, but ":split file" does not.
5178
5179 *'scrolljump'* *'sj'*
5180'scrolljump' 'sj' number (default 1)
5181 global
5182 {not in Vi}
5183 Minimal number of lines to scroll when the cursor gets off the
5184 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5185 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005186 When set to a negative number from -1 to -100 this is used as the
5187 percentage of the window height. Thus -50 scrolls half the window
5188 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 NOTE: This option is set to 1 when 'compatible' is set.
5190
5191 *'scrolloff'* *'so'*
5192'scrolloff' 'so' number (default 0)
5193 global
5194 {not in Vi}
5195 Minimal number of screen lines to keep above and below the cursor.
5196 This will make some context visible around where you are working. If
5197 you set it to a very large value (999) the cursor line will always be
5198 in the middle of the window (except at the start or end of the file or
5199 when long lines wrap).
5200 For scrolling horizontally see 'sidescrolloff'.
5201 NOTE: This option is set to 0 when 'compatible' is set.
5202
5203 *'scrollopt'* *'sbo'*
5204'scrollopt' 'sbo' string (default "ver,jump")
5205 global
5206 {not available when compiled without the |+scrollbind|
5207 feature}
5208 {not in Vi}
5209 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005210 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5211 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 The following words are available:
5213 ver Bind vertical scrolling for 'scrollbind' windows
5214 hor Bind horizontal scrolling for 'scrollbind' windows
5215 jump Applies to the offset between two windows for vertical
5216 scrolling. This offset is the difference in the first
5217 displayed line of the bound windows. When moving
5218 around in a window, another 'scrollbind' window may
5219 reach a position before the start or after the end of
5220 the buffer. The offset is not changed though, when
5221 moving back the 'scrollbind' window will try to scroll
5222 to the desired position when possible.
5223 When now making that window the current one, two
5224 things can be done with the relative offset:
5225 1. When "jump" is not included, the relative offset is
5226 adjusted for the scroll position in the new current
5227 window. When going back to the other window, the
5228 the new relative offset will be used.
5229 2. When "jump" is included, the other windows are
5230 scrolled to keep the same relative offset. When
5231 going back to the other window, it still uses the
5232 same relative offset.
5233 Also see |scroll-binding|.
5234
5235 *'sections'* *'sect'*
5236'sections' 'sect' string (default "SHNHH HUnhsh")
5237 global
5238 Specifies the nroff macros that separate sections. These are pairs of
5239 two letters (See |object-motions|). The default makes a section start
5240 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5241
5242 *'secure'* *'nosecure'* *E523*
5243'secure' boolean (default off)
5244 global
5245 {not in Vi}
5246 When on, ":autocmd", shell and write commands are not allowed in
5247 ".vimrc" and ".exrc" in the current directory and map commands are
5248 displayed. Switch it off only if you know that you will not run into
5249 problems, or when the 'exrc' option is off. On Unix this option is
5250 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005251 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 'secure' at the end of your ~/.vimrc then.
5253 This option cannot be set from a |modeline| or in the |sandbox|, for
5254 security reasons.
5255
5256 *'selection'* *'sel'*
5257'selection' 'sel' string (default "inclusive")
5258 global
5259 {not in Vi}
5260 This option defines the behavior of the selection. It is only used
5261 in Visual and Select mode.
5262 Possible values:
5263 value past line inclusive ~
5264 old no yes
5265 inclusive yes yes
5266 exclusive yes no
5267 "past line" means that the cursor is allowed to be positioned one
5268 character past the line.
5269 "inclusive" means that the last character of the selection is included
5270 in an operation. For example, when "x" is used to delete the
5271 selection.
5272 Note that when "exclusive" is used and selecting from the end
5273 backwards, you cannot include the last character of a line, when
5274 starting in Normal mode and 'virtualedit' empty.
5275
5276 The 'selection' option is set by the |:behave| command.
5277
5278 *'selectmode'* *'slm'*
5279'selectmode' 'slm' string (default "")
5280 global
5281 {not in Vi}
5282 This is a comma separated list of words, which specifies when to start
5283 Select mode instead of Visual mode, when a selection is started.
5284 Possible values:
5285 mouse when using the mouse
5286 key when using shifted special keys
5287 cmd when using "v", "V" or CTRL-V
5288 See |Select-mode|.
5289 The 'selectmode' option is set by the |:behave| command.
5290
5291 *'sessionoptions'* *'ssop'*
5292'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5293 help,options,winsize")
5294 global
5295 {not in Vi}
5296 {not available when compiled without the +mksession
5297 feature}
5298 Changes the effect of the |:mksession| command. It is a comma
5299 separated list of words. Each word enables saving and restoring
5300 something:
5301 word save and restore ~
5302 blank empty windows
5303 buffers hidden and unloaded buffers, not just those in windows
5304 curdir the current directory
5305 folds manually created folds, opened/closed folds and local
5306 fold options
5307 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005308 and contain at least one lowercase letter. Only
5309 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 help the help window
5311 localoptions options and mappings local to a window or buffer (not
5312 global values for local options)
5313 options all options and mappings (also global values for local
5314 options)
5315 resize size of the Vim window: 'lines' and 'columns'
5316 sesdir the directory in which the session file is located
5317 will become the current directory (useful with
5318 projects accessed over a network from different
5319 systems)
5320 slash backslashes in file names replaced with forward
5321 slashes
5322 unix with Unix end-of-line format (single <NL>), even when
5323 on Windows or DOS
5324 winpos position of the whole Vim window
5325 winsize window sizes
5326
5327 Don't include both "curdir" and "sesdir".
5328 When "curdir" nor "sesdir" is included, file names are stored with
5329 absolute paths.
5330 "slash" and "unix" are useful on Windows when sharing session files
5331 with Unix. The Unix version of Vim cannot source dos format scripts,
5332 but the Windows version of Vim can source unix format scripts.
5333
5334 *'shell'* *'sh'* *E91*
5335'shell' 'sh' string (default $SHELL or "sh",
5336 MS-DOS and Win32: "command.com" or
5337 "cmd.exe", OS/2: "cmd")
5338 global
5339 Name of the shell to use for ! and :! commands. When changing the
5340 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5341 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005342 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 See |option-backslash| about including spaces and backslashes.
5344 Environment variables are expanded |:set_env|.
5345 If the name of the shell contains a space, you might need to enclose
5346 it in quotes. Example: >
5347 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5348< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005349 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 "-f" is not inside the quotes, because it is not part of the command
5351 name. And Vim automagically recognizes the backslashes that are path
5352 separators.
5353 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5354 variable to change the way external commands are executed. See the
5355 libc.inf file of DJGPP.
5356 Under MS-Windows, when the executable ends in ".com" it must be
5357 included. Thus setting the shell to "command.com" or "4dos.com"
5358 works, but "command" and "4dos" do not work for all commands (e.g.,
5359 filtering).
5360 For unknown reasons, when using "4dos.com" the current directory is
5361 changed to "C:\". To avoid this set 'shell' like this: >
5362 :set shell=command.com\ /c\ 4dos
5363< This option cannot be set from a |modeline| or in the |sandbox|, for
5364 security reasons.
5365
5366 *'shellcmdflag'* *'shcf'*
5367'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5368 does not contain "sh" somewhere: "/c")
5369 global
5370 {not in Vi}
5371 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5372 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5373 systems, the default is set according to the value of 'shell', to
5374 reduce the need to set this option by the user. It's not used for
5375 OS/2 (EMX figures this out itself). See |option-backslash| about
5376 including spaces and backslashes. See |dos-shell|.
5377 This option cannot be set from a |modeline| or in the |sandbox|, for
5378 security reasons.
5379
5380 *'shellpipe'* *'sp'*
5381'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5382 global
5383 {not in Vi}
5384 {not available when compiled without the |+quickfix|
5385 feature}
5386 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005387 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 including spaces and backslashes.
5389 The name of the temporary file can be represented by "%s" if necessary
5390 (the file name is appended automatically if no %s appears in the value
5391 of this option).
5392 For the Amiga and MS-DOS the default is ">". The output is directly
5393 saved in a file and not echoed to the screen.
5394 For Unix the default it "| tee". The stdout of the compiler is saved
5395 in a file and echoed to the screen. If the 'shell' option is "csh" or
5396 "tcsh" after initializations, the default becomes "|& tee". If the
5397 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5398 "2>&1| tee". This means that stderr is also included.
5399 The initialization of this option is done after reading the ".vimrc"
5400 and the other initializations, so that when the 'shell' option is set
5401 there, the 'shellpipe' option changes automatically, unless it was
5402 explicitly set before.
5403 When 'shellpipe' is set to an empty string, no redirection of the
5404 ":make" output will be done. This is useful if you use a 'makeprg'
5405 that writes to 'makeef' by itself. If you want no piping, but do
5406 want to include the 'makeef', set 'shellpipe' to a single space.
5407 Don't forget to precede the space with a backslash: ":set sp=\ ".
5408 In the future pipes may be used for filtering and this option will
5409 become obsolete (at least for Unix).
5410 This option cannot be set from a |modeline| or in the |sandbox|, for
5411 security reasons.
5412
5413 *'shellquote'* *'shq'*
5414'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5415 contains "sh" somewhere: "\"")
5416 global
5417 {not in Vi}
5418 Quoting character(s), put around the command passed to the shell, for
5419 the "!" and ":!" commands. The redirection is kept outside of the
5420 quoting. See 'shellxquote' to include the redirection. It's
5421 probably not useful to set both options.
5422 This is an empty string by default. Only known to be useful for
5423 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5424 or bash, where it should be "\"". The default is adjusted according
5425 the value of 'shell', to reduce the need to set this option by the
5426 user. See |dos-shell|.
5427 This option cannot be set from a |modeline| or in the |sandbox|, for
5428 security reasons.
5429
5430 *'shellredir'* *'srr'*
5431'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5432 global
5433 {not in Vi}
5434 String to be used to put the output of a filter command in a temporary
5435 file. See also |:!|. See |option-backslash| about including spaces
5436 and backslashes.
5437 The name of the temporary file can be represented by "%s" if necessary
5438 (the file name is appended automatically if no %s appears in the value
5439 of this option).
5440 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5441 or "zsh" during initializations, the default becomes ">&". If the
5442 'shell' option is "sh", "ksh" or "bash" the default becomes
5443 ">%s 2>&1". This means that stderr is also included.
5444 For Win32, the Unix checks are done and additionally "cmd" is checked
5445 for, which makes the default ">%s 2>&1". Also, the same names with
5446 ".exe" appended are checked for.
5447 The initialization of this option is done after reading the ".vimrc"
5448 and the other initializations, so that when the 'shell' option is set
5449 there, the 'shellredir' option changes automatically unless it was
5450 explicitly set before.
5451 In the future pipes may be used for filtering and this option will
5452 become obsolete (at least for Unix).
5453 This option cannot be set from a |modeline| or in the |sandbox|, for
5454 security reasons.
5455
5456 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5457'shellslash' 'ssl' boolean (default off)
5458 global
5459 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5460 When set, a forward slash is used when expanding file names. This is
5461 useful when a Unix-like shell is used instead of command.com or
5462 cmd.exe. Backward slashes can still be typed, but they are changed to
5463 forward slashes by Vim.
5464 Note that setting or resetting this option has no effect for some
5465 existing file names, thus this option needs to be set before opening
5466 any file for best results. This might change in the future.
5467 'shellslash' only works when a backslash can be used as a path
5468 separator. To test if this is so use: >
5469 if exists('+shellslash')
5470<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005471 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5472'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5473 global
5474 {not in Vi}
5475 When on, use temp files for shell commands. When off use a pipe.
5476 When using a pipe is not possible temp files are used anyway.
5477 Currently a pipe is only supported on Unix. You can check it with: >
5478 :if has("filterpipe")
5479< The advantage of using a pipe is that nobody can read the temp file
5480 and the 'shell' command does not need to support redirection.
5481 The advantage of using a temp file is that the file type and encoding
5482 can be detected.
5483 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5484 |FilterWritePost| autocommands event are not triggered when
5485 'shelltemp' is off.
5486
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 *'shelltype'* *'st'*
5488'shelltype' 'st' number (default 0)
5489 global
5490 {not in Vi} {only for the Amiga}
5491 On the Amiga this option influences the way how the commands work
5492 which use a shell.
5493 0 and 1: always use the shell
5494 2 and 3: use the shell only to filter lines
5495 4 and 5: use shell only for ':sh' command
5496 When not using the shell, the command is executed directly.
5497
5498 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5499 1 and 3: use "shell cmd" to start external commands
5500
5501 *'shellxquote'* *'sxq'*
5502'shellxquote' 'sxq' string (default: "";
5503 for Win32, when 'shell' contains "sh"
5504 somewhere: "\""
5505 for Unix, when using system(): "\"")
5506 global
5507 {not in Vi}
5508 Quoting character(s), put around the command passed to the shell, for
5509 the "!" and ":!" commands. Includes the redirection. See
5510 'shellquote' to exclude the redirection. It's probably not useful
5511 to set both options.
5512 This is an empty string by default. Known to be useful for
5513 third-party shells when using the Win32 version, such as the MKS Korn
5514 Shell or bash, where it should be "\"". The default is adjusted
5515 according the value of 'shell', to reduce the need to set this option
5516 by the user. See |dos-shell|.
5517 This option cannot be set from a |modeline| or in the |sandbox|, for
5518 security reasons.
5519
5520 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5521'shiftround' 'sr' boolean (default off)
5522 global
5523 {not in Vi}
5524 Round indent to multiple of 'shiftwidth'. Applies to > and <
5525 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5526 a multiple of 'shiftwidth' (this is Vi compatible).
5527 NOTE: This option is reset when 'compatible' is set.
5528
5529 *'shiftwidth'* *'sw'*
5530'shiftwidth' 'sw' number (default 8)
5531 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005532 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 |'cindent'|, |>>|, |<<|, etc.
5534
5535 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005536'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5537 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 global
5539 {not in Vi}
5540 This option helps to avoid all the |hit-enter| prompts caused by file
5541 messages, for example with CTRL-G, and to avoid some other messages.
5542 It is a list of flags:
5543 flag meaning when present ~
5544 f use "(3 of 5)" instead of "(file 3 of 5)"
5545 i use "[noeol]" instead of "[Incomplete last line]"
5546 l use "999L, 888C" instead of "999 lines, 888 characters"
5547 m use "[+]" instead of "[Modified]"
5548 n use "[New]" instead of "[New File]"
5549 r use "[RO]" instead of "[readonly]"
5550 w use "[w]" instead of "written" for file write message
5551 and "[a]" instead of "appended" for ':w >> file' command
5552 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5553 "[unix format]" and "[mac]" instead of "[mac format]".
5554 a all of the above abbreviations
5555
5556 o overwrite message for writing a file with subsequent message
5557 for reading a file (useful for ":wn" or when 'autowrite' on)
5558 O message for reading a file overwrites any previous message.
5559 Also for quickfix message (e.g., ":cn").
5560 s don't give "search hit BOTTOM, continuing at TOP" or "search
5561 hit TOP, continuing at BOTTOM" messages
5562 t truncate file message at the start if it is too long to fit
5563 on the command-line, "<" will appear in the left most column.
5564 Ignored in Ex mode.
5565 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005566 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005567 Ignored in Ex mode.
5568 W don't give "written" or "[w]" when writing a file
5569 A don't give the "ATTENTION" message when an existing swap file
5570 is found.
5571 I don't give the intro message when starting Vim |:intro|.
5572
5573 This gives you the opportunity to avoid that a change between buffers
5574 requires you to hit <Enter>, but still gives as useful a message as
5575 possible for the space available. To get the whole message that you
5576 would have got with 'shm' empty, use ":file!"
5577 Useful values:
5578 shm= No abbreviation of message.
5579 shm=a Abbreviation, but no loss of information.
5580 shm=at Abbreviation, and truncate message when necessary.
5581
5582 NOTE: This option is set to the Vi default value when 'compatible' is
5583 set and to the Vim default value when 'compatible' is reset.
5584
5585 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5586'shortname' 'sn' boolean (default off)
5587 local to buffer
5588 {not in Vi, not in MS-DOS versions}
5589 Filenames are assumed to be 8 characters plus one extension of 3
5590 characters. Multiple dots in file names are not allowed. When this
5591 option is on, dots in file names are replaced with underscores when
5592 adding an extension (".~" or ".swp"). This option is not available
5593 for MS-DOS, because then it would always be on. This option is useful
5594 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5595 or crossdos. When running the Win32 GUI version under Win32s, this
5596 option is always on by default.
5597
5598 *'showbreak'* *'sbr'* *E595*
5599'showbreak' 'sbr' string (default "")
5600 global
5601 {not in Vi}
5602 {not available when compiled without the |+linebreak|
5603 feature}
5604 String to put at the start of lines that have been wrapped. Useful
5605 values are "> " or "+++ ".
5606 Only printable single-cell characters are allowed, excluding <Tab> and
5607 comma (in a future version the comma might be used to separate the
5608 part that is shown at the end and at the start of a line).
5609 The characters are highlighted according to the '@' flag in
5610 'highlight'.
5611 Note that tabs after the showbreak will be displayed differently.
5612 If you want the 'showbreak' to appear in between line numbers, add the
5613 "n" flag to 'cpoptions'.
5614
5615 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5616'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5617 off)
5618 global
5619 {not in Vi}
5620 {not available when compiled without the
5621 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005622 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 terminal is slow.
5624 In Visual mode the size of the selected area is shown:
5625 - When selecting characters within a line, the number of characters.
5626 - When selecting more than one line, the number of lines.
5627 - When selecting a block, the size in screen characters: linesxcolumns.
5628 NOTE: This option is set to the Vi default value when 'compatible' is
5629 set and to the Vim default value when 'compatible' is reset.
5630
5631 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5632'showfulltag' 'sft' boolean (default off)
5633 global
5634 {not in Vi}
5635 When completing a word in insert mode (see |ins-completion|) from the
5636 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005637 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638 matched a C function, you can see a template for what arguments are
5639 required (coding style permitting).
5640
5641 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5642'showmatch' 'sm' boolean (default off)
5643 global
5644 When a bracket is inserted, briefly jump to the matching one. The
5645 jump is only done if the match can be seen on the screen. The time to
5646 show the match can be set with 'matchtime'.
5647 A Beep is given if there is no match (no matter if the match can be
5648 seen or not). This option is reset when the 'paste' option is set.
5649 When the 'm' flag is not included in 'cpoptions', typing a character
5650 will immediately move the cursor back to where it belongs.
5651 See the "sm" field in 'guicursor' for setting the cursor shape and
5652 blinking when showing the match.
5653 The 'matchpairs' option can be used to specify the characters to show
5654 matches for. 'rightleft' and 'revins' are used to look for opposite
5655 matches.
5656 Note: For the use of the short form parental guidance is advised.
5657
5658 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5659'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5660 global
5661 If in Insert, Replace or Visual mode put a message on the last line.
5662 Use the 'M' flag in 'highlight' to set the type of highlighting for
5663 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005664 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 doesn't mean XIM is really active, especially when 'imactivatekey' is
5666 not set.
5667 NOTE: This option is set to the Vi default value when 'compatible' is
5668 set and to the Vim default value when 'compatible' is reset.
5669
5670 *'sidescroll'* *'ss'*
5671'sidescroll' 'ss' number (default 0)
5672 global
5673 {not in Vi}
5674 The minimal number of columns to scroll horizontally. Used only when
5675 the 'wrap' option is off and the cursor is moved off of the screen.
5676 When it is zero the cursor will be put in the middle of the screen.
5677 When using a slow terminal set it to a large number or 0. When using
5678 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5679 commands.
5680
5681 *'sidescrolloff'* *'siso'*
5682'sidescrolloff' 'siso' number (default 0)
5683 global
5684 {not in Vi}
5685 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005686 right of the cursor if 'nowrap' is set. Setting this option to a
5687 value greater than 0 while having |'sidescroll'| also at a non-zero
5688 value makes some context visible in the line you are scrolling in
5689 horizontally (except at beginning of the line). Setting this option
5690 to a large value (like 999) has the effect of keeping the cursor
5691 horizontally centered in the window, as long as one does not come too
5692 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 NOTE: This option is set to 0 when 'compatible' is set.
5694
5695 Example: Try this together with 'sidescroll' and 'listchars' as
5696 in the following example to never allow the cursor to move
5697 onto the "extends" character:
5698
5699 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5700 :set sidescrolloff=1
5701
5702
5703 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5704'smartcase' 'scs' boolean (default off)
5705 global
5706 {not in Vi}
5707 Override the 'ignorecase' option if the search pattern contains upper
5708 case characters. Only used when the search pattern is typed and
5709 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005710 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005711 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5712 recalling the search pattern from history and hitting <Enter>.
5713 NOTE: This option is reset when 'compatible' is set.
5714
5715 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5716'smartindent' 'si' boolean (default off)
5717 local to buffer
5718 {not in Vi}
5719 {not available when compiled without the
5720 |+smartindent| feature}
5721 Do smart autoindenting when starting a new line. Works for C-like
5722 programs, but can also be used for other languages. 'cindent' does
5723 something like this, works better in most cases, but is more strict,
5724 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5725 'indentexpr' is a more advanced alternative.
5726 Normally 'autoindent' should also be on when using 'smartindent'.
5727 An indent is automatically inserted:
5728 - After a line ending in '{'.
5729 - After a line starting with a keyword from 'cinwords'.
5730 - Before a line starting with '}' (only with the "O" command).
5731 When typing '}' as the first character in a new line, that line is
5732 given the same indent as the matching '{'.
5733 When typing '#' as the first character in a new line, the indent for
5734 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005735 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005736 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5737 When using the ">>" command, lines starting with '#' are not shifted
5738 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005739 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 is set smart indenting is disabled.
5741
5742 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5743'smarttab' 'sta' boolean (default off)
5744 global
5745 {not in Vi}
5746 When on, a <Tab> in front of a line inserts blanks according to
5747 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5748 a 'shiftwidth' worth of space at the start of the line.
5749 When off a <Tab> always inserts blanks according to 'tabstop'.
5750 'shiftwidth' is only used for shifting text left or right
5751 |shift-left-right|.
5752 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5753 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005754 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755 NOTE: This option is reset when 'compatible' is set.
5756
5757 *'softtabstop'* *'sts'*
5758'softtabstop' 'sts' number (default 0)
5759 local to buffer
5760 {not in Vi}
5761 Number of spaces that a <Tab> counts for while performing editing
5762 operations, like inserting a <Tab> or using <BS>. It "feels" like
5763 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5764 used. This is useful to keep the 'ts' setting at its standard value
5765 of 8, while being able to edit like it is set to 'sts'. However,
5766 commands like "x" still work on the actual characters.
5767 When 'sts' is zero, this feature is off.
5768 'softtabstop' is set to 0 when the 'paste' option is set.
5769 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5770 spaces is minimized by using <Tab>s.
5771 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5772 set.
5773 NOTE: This option is set to 0 when 'compatible' is set.
5774
Bram Moolenaar217ad922005-03-20 22:37:15 +00005775 *'spell'* *'nospell'*
5776'spell' boolean (default off)
5777 local to window
5778 {not in Vi}
5779 {not available when compiled without the |+syntax|
5780 feature}
5781 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005782 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005783
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005784 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005785'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005786 local to buffer
5787 {not in Vi}
5788 {not available when compiled without the |+syntax|
5789 feature}
5790 Pattern to locate the end of a sentence. The following word will be
5791 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005792 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005793 When this check is not wanted make this option empty.
5794 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005795 Be careful with special characters, see |option-backslash| about
5796 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005797 To set this option automatically depending on the language, see
5798 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005799
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005800 *'spellfile'* *'spf'*
5801'spellfile' 'spf' string (default empty)
5802 local to buffer
5803 {not in Vi}
5804 {not available when compiled without the |+syntax|
5805 feature}
5806 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005807 commands. It must end in ".{encoding}.add". You need to include the
5808 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005809 *E765*
5810 It may also be a comma separated list of names. A count before the
5811 |zg| and |zw| commands can be used to access each. This allows using
5812 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005813 When a word is added while this option is empty Vim will set it for
5814 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005815 writable and the first language name that appears in 'spelllang',
5816 ignoring the region.
5817 The resulting ".spl" file will be used for spell checking, it does not
5818 have to appear in 'spelllang'.
5819 Normally one file is used for all regions, but you can add the region
5820 name if you want to. However, it will then only be used when
5821 'spellfile' is set to it, for entries in 'spelllang' only files
5822 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005823 This option cannot be set from a |modeline| or in the |sandbox|, for
5824 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005825
Bram Moolenaar217ad922005-03-20 22:37:15 +00005826 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005827'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005828 local to buffer
5829 {not in Vi}
5830 {not available when compiled without the |+syntax|
5831 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005832 A comma separated list of word list names. When the 'spell' option is
5833 on spellchecking will be done for these languages. Example: >
5834 set spelllang=en_us,nl,medical
5835< This means US English, Dutch and medical words are recognized. Words
5836 that are not recognized will be highlighted.
5837 The word list name must not include a comma or dot. Using a dash is
5838 recommended to separate the two letter language name from a
5839 specification. Thus "en-rare" is used for rare English words.
5840 A region name must come last and have the form "_xx", where "xx" is
5841 the two-letter, lower case region name. You can use more than one
5842 region by listing them: "en_us,en_ca" supports both US and Canadian
5843 English, but not words specific for Australia, New Zealand or Great
5844 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005845 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005846 As a special case the name of a .spl file can be given as-is. The
5847 first "_xx" in the name is removed and used as the region name
5848 (_xx is an underscore, two letters and followed by a non-letter).
5849 This is mainly for testing purposes. You must make sure the correct
5850 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005851 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005852 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5853 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005854 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005855
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005856 After this option has been set successfully, Vim will source the files
5857 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5858 up to the first comma, dot or underscore. See |set-spc-auto|.
5859
5860
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005861 *'spellsuggest'* *'sps'*
5862'spellsuggest' 'sps' string (default "best")
5863 global
5864 {not in Vi}
5865 {not available when compiled without the |+syntax|
5866 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005867 Methods used for spelling suggestions. Both for the |z?| command and
5868 the |spellsuggest()| function. This is a comma-separated list of
5869 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005870
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005871 best Internal method that works best for English. Finds
5872 changes like "fast" and uses a bit of sound-a-like
5873 scoring to improve the ordering.
5874
5875 double Internal method that uses two methods and mixes the
5876 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005877 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005878 word. That only works when the language specifies
5879 sound folding. Can be slow and doesn't always give
5880 better results.
5881
5882 fast Internal method that only checks for simple changes:
5883 character inserts/deletes/swaps. Works well for
5884 simple typing mistakes.
5885
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005886 {number} The maximum number of suggestions listed for |z?|.
5887 Not used for |spellsuggest()|. The number of
5888 suggestions is never more than the value of 'lines'
5889 minus two.
5890
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005891 file:{filename} Read file {filename}, which must have two columns,
5892 separated by a slash. The first column contains the
5893 bad word, the second column the suggested good word.
5894 Example:
5895 theribal/terrible ~
5896 Use this for common mistakes that do not appear at the
5897 top of the suggestion list with the internal methods.
5898 Lines without a slash are ignored, use this for
5899 comments.
5900 The file is used for all languages.
5901
5902 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5903 trouble with spaces. |v:val| holds the badly spelled
5904 word. The expression must evaluate to a List of
5905 Lists, each with a suggestion and a score.
5906 Example:
5907 [['the', 33], ['that', 44]]
5908 Set 'verbose' and use |z?| to see the scores that the
5909 internal methods use. A lower score is better.
5910 This may invoke |spellsuggest()| if you temporarily
5911 set 'spellsuggest' to exclude the "expr:" part.
5912 Errors are silently ignored, unless you set the
5913 'verbose' option to a non-zero value.
5914
5915 Only one of "best", "double" or "fast" may be used. The others may
5916 appear several times in any order. Example: >
5917 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5918<
5919 This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005921
5922
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5924'splitbelow' 'sb' boolean (default off)
5925 global
5926 {not in Vi}
5927 {not available when compiled without the +windows
5928 feature}
5929 When on, splitting a window will put the new window below the current
5930 one. |:split|
5931
5932 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5933'splitright' 'spr' boolean (default off)
5934 global
5935 {not in Vi}
5936 {not available when compiled without the +vertsplit
5937 feature}
5938 When on, splitting a window will put the new window right of the
5939 current one. |:vsplit|
5940
5941 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5942'startofline' 'sol' boolean (default on)
5943 global
5944 {not in Vi}
5945 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005946 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005947 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005948 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 with a linewise operator, with "%" with a count and to buffer changing
5950 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5951 only has a line number, e.g., ":25" or ":+".
5952 In case of buffer changing commands the cursor is placed at the column
5953 where it was the last time the buffer was edited.
5954 NOTE: This option is set when 'compatible' is set.
5955
5956 *'statusline'* *'stl'* *E540* *E541* *E542*
5957'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005958 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 {not in Vi}
5960 {not available when compiled without the |+statusline|
5961 feature}
5962 When nonempty, this option determines the content of the status line.
5963 Also see |status-line|.
5964
5965 The option consists of printf style '%' items interspersed with
5966 normal text. Each status line item is of the form:
5967 %-0{minwid}.{maxwid}{item}
5968 All fields except the {item} is optional. A single percent sign can
5969 be given as "%%". Up to 80 items can be specified.
5970
5971 Note that the only effect of 'ruler' when this option is set (and
5972 'laststatus' is 2) is controlling the output of |CTRL-G|.
5973
5974 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005975 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005977 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005978 minwid Minimum width of the item, padding as set by '-' & '0'.
5979 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005980 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 on the left for text items. Numeric items will be
5982 shifted down to maxwid-2 digits followed by '>'number
5983 where number is the amount of missing digits, much like
5984 an exponential notation.
5985 item A one letter code as described below.
5986
5987 Following is a description of the possible statusline items. The
5988 second character in "item" is the type:
5989 N for number
5990 S for string
5991 F for flags as described below
5992 - not applicable
5993
5994 item meaning ~
5995 f S Path to the file in the buffer, relative to current directory.
5996 F S Full path to the file in the buffer.
5997 t S File name (tail) of file in the buffer.
5998 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5999 M F Modified flag, text is ",+" or ",-".
6000 r F Readonly flag, text is " [RO]".
6001 R F Readonly flag, text is ",RO".
6002 h F Help buffer flag, text is " [help]".
6003 H F Help buffer flag, text is ",HLP".
6004 w F Preview window flag, text is " [Preview]".
6005 W F Preview window flag, text is ",PRV".
6006 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6007 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6008 {not available when compiled without |+autocmd| feature}
6009 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6010 being used: "<keymap>"
6011 n N Buffer number.
6012 b N Value of byte under cursor.
6013 B N As above, in hexadecimal.
6014 o N Byte number in file of byte under cursor, first byte is 1.
6015 Mnemonic: Offset from start of file (with one added)
6016 {not available when compiled without |+byte_offset| feature}
6017 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006018 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006019 l N Line number.
6020 L N Number of lines in buffer.
6021 c N Column number.
6022 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006023 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 p N Percentage through file in lines as in |CTRL-G|.
6025 P S Percentage through file of displayed window. This is like the
6026 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006027 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 Empty if the argument file count is zero or one.
6029 { NF Evaluate expression between '{' and '}' and substitute result.
6030 ( - Start of item group. Can be used for setting the width and
6031 alignment of a section. Must be followed by %) somewhere.
6032 ) - End of item group. No width fields allowed.
6033 < - Where to truncate line if too long. Default is at the start.
6034 No width fields allowed.
6035 = - Separation point between left and right aligned items.
6036 No width fields allowed.
6037 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006038 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006039 The difference between User{N} and StatusLine will be applied
6040 to StatusLineNC for the statusline of non-current windows.
6041 The number N must be between 1 and 9. See |hl-User1..9|
6042
6043 Display of flags are controlled by the following heuristic:
6044 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006045 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006046 with a space it is assumed that it wants to separate itself from
6047 anything but other flags. That is: A leading comma is removed if the
6048 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006049 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 make a nice display when flags are used like in the examples below.
6051
Bram Moolenaar582fd852005-03-28 20:58:01 +00006052 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 not set) and a minwid is not set for the group, the whole group will
6054 become empty. This will make a group like the following disappear
6055 completely from the statusline when none of the flags are set. >
6056 :set statusline=...%(\ [%M%R%H]%)...
6057<
6058 Beware that an expression is evaluated each and every time the status
6059 line is displayed. The current buffer and current window will be set
6060 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006061 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6063 real current buffer. The expression is evaluated in the |sandbox|.
6064
6065 If the statusline is not updated when you want it (e.g., after setting
6066 a variable that's used in an expression), you can force an update by
6067 setting an option without changing its value. Example: >
6068 :let &ro = &ro
6069
6070< A result of all digits is regarded a number for display purposes.
6071 Otherwise the result is taken as flag text and applied to the rules
6072 described above.
6073
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006074 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006075 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6076 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6077
6078 Examples:
6079 Emulate standard status line with 'ruler' set >
6080 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6081< Similar, but add ASCII value of char under the cursor (like "ga") >
6082 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6083< Display byte count and byte value, modified flag in red. >
6084 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6085 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6086< Display a ,GZ flag if a compressed file is loaded >
6087 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6088< In the |:autocmd|'s: >
6089 :let b:gzflag = 1
6090< And: >
6091 :unlet b:gzflag
6092< And define this function: >
6093 :function VarExists(var, val)
6094 : if exists(a:var) | return a:val | else | return '' | endif
6095 :endfunction
6096<
6097 *'suffixes'* *'su'*
6098'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6099 global
6100 {not in Vi}
6101 Files with these suffixes get a lower priority when multiple files
6102 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006103 suffixes. Spaces after the comma are ignored. A dot is also seen as
6104 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 separator, precede it with a backslash (see |option-backslash| about
6106 including spaces and backslashes).
6107 See 'wildignore' for completely ignoring files.
6108 The use of |:set+=| and |:set-=| is preferred when adding or removing
6109 suffixes from the list. This avoids problems when a future version
6110 uses another default.
6111
6112 *'suffixesadd'* *'sua'*
6113'suffixesadd' 'sua' string (default "")
6114 local to buffer
6115 {not in Vi}
6116 {not available when compiled without the
6117 |+file_in_path| feature}
6118 Comma separated list of suffixes, which are used when searching for a
6119 file for the "gf", "[I", etc. commands. Example: >
6120 :set suffixesadd=.java
6121<
6122 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6123'swapfile' 'swf' boolean (default on)
6124 local to buffer
6125 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 swapfile is not wanted for a specific buffer. For example, with
6128 confidential information that even root must not be able to access.
6129 Careful: All text will be in memory:
6130 - Don't use this for big files.
6131 - Recovery will be impossible!
6132 A swapfile will only be present when |'updatecount'| is non-zero and
6133 'swapfile' is set.
6134 When 'swapfile' is reset, the swap file for the current buffer is
6135 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6136 non-zero, a swap file is immediately created.
6137 Also see |swap-file| and |'swapsync'|.
6138
6139 This option is used together with 'bufhidden' and 'buftype' to
6140 specify special kinds of buffers. See |special-buffers|.
6141
6142 *'swapsync'* *'sws'*
6143'swapsync' 'sws' string (default "fsync")
6144 global
6145 {not in Vi}
6146 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006147 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006148 When this option is empty parts of the swap file may be in memory and
6149 not written to disk. When the system crashes you may lose more work.
6150 On Unix the system does a sync now and then without Vim asking for it,
6151 so the disadvantage of setting this option off is small. On some
6152 systems the swap file will not be written at all. For a unix system
6153 setting it to "sync" will use the sync() call instead of the default
6154 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006155 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156
6157 *'switchbuf'* *'swb'*
6158'switchbuf' 'swb' string (default "")
6159 global
6160 {not in Vi}
6161 This option controls the behavior when switching between buffers.
6162 Possible values (comma separated list):
6163 useopen If included, jump to the first open window that
6164 contains the specified buffer (if there is one).
6165 Otherwise: Do not examine other windows.
6166 This setting is checked with |quickfix| commands, when
6167 jumping to errors (":cc", ":cn", "cp", etc.). It is
6168 also used in all buffer related split commands, for
6169 example ":sbuffer", ":sbnext", or ":sbrewind".
6170 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006171 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 Supported in |quickfix| commands that display errors.
6173
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006174 *'synmaxcol'* *'smc'*
6175'synmaxcol' 'smc' number (default 3000)
6176 local to buffer
6177 {not in Vi}
6178 {not available when compiled without the |+syntax|
6179 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006180 Maximum column in which to search for syntax items. In long lines the
6181 text after this column is not highlighted and following lines may not
6182 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006183 This helps to avoid very slow redrawing for an XML file that is one
6184 long line.
6185 Set to zero to remove the limit.
6186
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 *'syntax'* *'syn'*
6188'syntax' 'syn' string (default empty)
6189 local to buffer
6190 {not in Vi}
6191 {not available when compiled without the |+syntax|
6192 feature}
6193 When this option is set, the syntax with this name is loaded, unless
6194 syntax highlighting has been switched off with ":syntax off".
6195 Otherwise this option does not always reflect the current syntax (the
6196 b:current_syntax variable does).
6197 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006198 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006199 /* vim: set syntax=idl : */
6200< To switch off syntax highlighting for the current file, use: >
6201 :set syntax=OFF
6202< To switch syntax highlighting on according to the current value of the
6203 'filetype' option: >
6204 :set syntax=ON
6205< What actually happens when setting the 'syntax' option is that the
6206 Syntax autocommand event is triggered with the value as argument.
6207 This option is not copied to another buffer, independent of the 's' or
6208 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006209 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210
6211 *'tabstop'* *'ts'*
6212'tabstop' 'ts' number (default 8)
6213 local to buffer
6214 Number of spaces that a <Tab> in the file counts for. Also see
6215 |:retab| command, and 'softtabstop' option.
6216
6217 Note: Setting 'tabstop' to any other value than 8 can make your file
6218 appear wrong in many places (e.g., when printing it).
6219
6220 There are four main ways to use tabs in Vim:
6221 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6222 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6223 will use a mix of tabs and spaces, but typing Tab and BS will
6224 behave like a tab appears every 4 (or 3) characters.
6225 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6226 'expandtab'. This way you will always insert spaces. The
6227 formatting will never be messed up when 'tabstop' is changed.
6228 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006229 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 works when using Vim to edit the file.
6231 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6232 'noexpandtab'. This should then work (for initial indents only)
6233 for any tabstop setting that people use. It might be nice to have
6234 tabs after the first non-blank inserted as spaces if you do this
6235 though. Otherwise aligned comments will be wrong when 'tabstop' is
6236 changed.
6237
6238 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6239'tagbsearch' 'tbs' boolean (default on)
6240 global
6241 {not in Vi}
6242 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006243 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 searching makes searching for a tag a LOT faster, but a linear search
6245 will find more tags if the tags file wasn't properly sorted.
6246 Vim normally assumes that your tags files are sorted, or indicate that
6247 they are not sorted. Only when this is not the case does the
6248 'tagbsearch' option need to be switched off.
6249
6250 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006251 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 certain files, or retry all files with a linear search. When
6253 'tagbsearch' is off, only a linear search is done.
6254
6255 Linear searching is done anyway, for one file, when Vim finds a line
6256 at the start of the file indicating that it's not sorted: >
6257 !_TAG_FILE_SORTED 0 /some command/
6258< [The whitespace before and after the '0' must be a single <Tab>]
6259
6260 When a binary search was done and no match was found in any of the
6261 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6262 instead of a normal tag name, a retry is done with a linear search.
6263 Tags in unsorted tags files, and matches with different case will only
6264 be found in the retry.
6265
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006266 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006267 linear search can be avoided for the 'ignorecase' case. Use a value
6268 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6269 case-fold sorted with the -f switch to "sort" in most unices, as in
6270 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6271 5.3 or higher the -f or --fold-case-sort switch can be used for this
6272 as well. Note that case must be folded to uppercase for this to work.
6273
6274 When 'tagbsearch' is off, tags searching is slower when a full match
6275 exists, but faster when no full match exists. Tags in unsorted tags
6276 files may only be found with 'tagbsearch' off.
6277 When the tags file is not sorted, or sorted in a wrong way (not on
6278 ASCII byte value), 'tagbsearch' should be off, or the line given above
6279 must be included in the tags file.
6280 This option doesn't affect commands that find all matching tags (e.g.,
6281 command-line completion and ":help").
6282 {Vi: always uses binary search in some versions}
6283
6284 *'taglength'* *'tl'*
6285'taglength' 'tl' number (default 0)
6286 global
6287 If non-zero, tags are significant up to this number of characters.
6288
6289 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6290'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6291 global
6292 {not in Vi}
6293 If on and using a tag file in another directory, file names in that
6294 tag file are relative to the directory where the tag file is.
6295 NOTE: This option is set to the Vi default value when 'compatible' is
6296 set and to the Vim default value when 'compatible' is reset.
6297
6298 *'tags'* *'tag'* *E433*
6299'tags' 'tag' string (default "./tags,tags", when compiled with
6300 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6301 global or local to buffer |global-local|
6302 Filenames for the tag command, separated by spaces or commas. To
6303 include a space or comma in a file name, precede it with a backslash
6304 (see |option-backslash| about including spaces and backslashes).
6305 When a file name starts with "./", the '.' is replaced with the path
6306 of the current file. But only when the 'd' flag is not included in
6307 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6308 |tags-option|.
6309 "*", "**" and other wildcards can be used to search for tags files in
6310 a directory tree. See |file-searching|. {not available when compiled
6311 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006312 The |tagfiles()| function can be used to get a list of the file names
6313 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6315 files are also supported. They are automatically recognized. The
6316 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6317 differences are ignored (MS-Windows). |emacs-tags|
6318 The use of |:set+=| and |:set-=| is preferred when adding or removing
6319 file names from the list. This avoids problems when a future version
6320 uses another default.
6321 {Vi: default is "tags /usr/lib/tags"}
6322
6323 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6324'tagstack' 'tgst' boolean (default on)
6325 global
6326 {not in all versions of Vi}
6327 When on, the |tagstack| is used normally. When off, a ":tag" or
6328 ":tselect" command with an argument will not push the tag onto the
6329 tagstack. A following ":tag" without an argument, a ":pop" command or
6330 any other command that uses the tagstack will use the unmodified
6331 tagstack, but does change the pointer to the active entry.
6332 Resetting this option is useful when using a ":tag" command in a
6333 mapping which should not change the tagstack.
6334
6335 *'term'* *E529* *E530* *E531*
6336'term' string (default is $TERM, if that fails:
6337 in the GUI: "builtin_gui"
6338 on Amiga: "amiga"
6339 on BeOS: "beos-ansi"
6340 on Mac: "mac-ansi"
6341 on MiNT: "vt52"
6342 on MS-DOS: "pcterm"
6343 on OS/2: "os2ansi"
6344 on Unix: "ansi"
6345 on VMS: "ansi"
6346 on Win 32: "win32")
6347 global
6348 Name of the terminal. Used for choosing the terminal control
6349 characters. Environment variables are expanded |:set_env|.
6350 For example: >
6351 :set term=$TERM
6352< See |termcap|.
6353
6354 *'termbidi'* *'tbidi'*
6355 *'notermbidi'* *'notbidi'*
6356'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6357 global
6358 {not in Vi}
6359 {only available when compiled with the |+arabic|
6360 feature}
6361 The terminal is in charge of Bi-directionality of text (as specified
6362 by Unicode). The terminal is also expected to do the required shaping
6363 that some languages (such as Arabic) require.
6364 Setting this option implies that 'rightleft' will not be set when
6365 'arabic' is set and the value of 'arabicshape' will be ignored.
6366 Note that setting 'termbidi' has the immediate effect that
6367 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6368 This option is reset when the GUI is started.
6369 For further details see |arabic.txt|.
6370
6371 *'termencoding'* *'tenc'*
6372'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6373 Macintosh GUI: "macroman")
6374 global
6375 {only available when compiled with the |+multi_byte|
6376 feature}
6377 {not in Vi}
6378 Encoding used for the terminal. This specifies what character
6379 encoding the keyboard produces and the display will understand. For
6380 the GUI it only applies to the keyboard ('encoding' is used for the
6381 display).
6382 In the Win32 console version the default value is the console codepage
6383 when it differs from the ANSI codepage.
6384 *E617*
6385 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6386 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6387 Any attempts to set a different value will be rejected, and an error
6388 message is shown.
6389 For the Win32 GUI 'termencoding' is not used for typed characters,
6390 because the Win32 system always passes Unicode characters.
6391 When empty, the same encoding is used as for the 'encoding' option.
6392 This is the normal value.
6393 Not all combinations for 'termencoding' and 'encoding' are valid. See
6394 |encoding-table|.
6395 The value for this option must be supported by internal conversions or
6396 iconv(). When this is not possible no conversion will be done and you
6397 will probably experience problems with non-ASCII characters.
6398 Example: You are working with the locale set to euc-jp (Japanese) and
6399 want to edit a UTF-8 file: >
6400 :let &termencoding = &encoding
6401 :set encoding=utf-8
6402< You need to do this when your system has no locale support for UTF-8.
6403
6404 *'terse'* *'noterse'*
6405'terse' boolean (default off)
6406 global
6407 When set: Add 's' flag to 'shortmess' option (this makes the message
6408 for a search that hits the start or end of the file not being
6409 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6410 shortens a lot of messages}
6411
6412 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6413'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6414 global
6415 {not in Vi}
6416 This option is obsolete. Use 'fileformats'.
6417 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6418 set to the default value for the current system. When 'textauto' is
6419 reset, 'fileformats' is made empty.
6420 NOTE: This option is set to the Vi default value when 'compatible' is
6421 set and to the Vim default value when 'compatible' is reset.
6422
6423 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6424'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6425 others: default off)
6426 local to buffer
6427 {not in Vi}
6428 This option is obsolete. Use 'fileformat'.
6429 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6430 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6431 "unix".
6432
6433 *'textwidth'* *'tw'*
6434'textwidth' 'tw' number (default 0)
6435 local to buffer
6436 {not in Vi}
6437 Maximum width of text that is being inserted. A longer line will be
6438 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006439 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6440 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 'formatoptions' and |ins-textwidth|.
6442 NOTE: This option is set to 0 when 'compatible' is set.
6443
6444 *'thesaurus'* *'tsr'*
6445'thesaurus' 'tsr' string (default "")
6446 global or local to buffer |global-local|
6447 {not in Vi}
6448 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006449 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 the file should contain words with similar meaning, separated by
6451 non-keyword characters (white space is preferred). Maximum line
6452 length is 510 bytes.
6453 To obtain a file to be used here, check out the wordlist FAQ at
6454 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006455 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 after a comma are ignored, otherwise spaces are included in the file
6457 name. See |option-backslash| about using backslashes.
6458 The use of |:set+=| and |:set-=| is preferred when adding or removing
6459 directories from the list. This avoids problems when a future version
6460 uses another default.
6461 Backticks cannot be used in this option for security reasons.
6462
6463 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6464'tildeop' 'top' boolean (default off)
6465 global
6466 {not in Vi}
6467 When on: The tilde command "~" behaves like an operator.
6468 NOTE: This option is reset when 'compatible' is set.
6469
6470 *'timeout'* *'to'* *'notimeout'* *'noto'*
6471'timeout' 'to' boolean (default on)
6472 global
6473 *'ttimeout'* *'nottimeout'*
6474'ttimeout' boolean (default off)
6475 global
6476 {not in Vi}
6477 These two options together determine the behavior when part of a
6478 mapped key sequence or keyboard code has been received:
6479
6480 'timeout' 'ttimeout' action ~
6481 off off do not time out
6482 on on or off time out on :mappings and key codes
6483 off on time out on key codes
6484
6485 If both options are off, Vim will wait until either the complete
6486 mapping or key sequence has been received, or it is clear that there
6487 is no mapping or key sequence for the received characters. For
6488 example: if you have mapped "vl" and Vim has received 'v', the next
6489 character is needed to see if the 'v' is followed by an 'l'.
6490 When one of the options is on, Vim will wait for about 1 second for
6491 the next character to arrive. After that the already received
6492 characters are interpreted as single characters. The waiting time can
6493 be changed with the 'timeoutlen' option.
6494 On slow terminals or very busy systems timing out may cause
6495 malfunctioning cursor keys. If both options are off, Vim waits
6496 forever after an entered <Esc> if there are key codes that start
6497 with <Esc>. You will have to type <Esc> twice. If you do not have
6498 problems with key codes, but would like to have :mapped key
6499 sequences not timing out in 1 second, set the 'ttimeout' option and
6500 reset the 'timeout' option.
6501
6502 NOTE: 'ttimeout' is reset when 'compatible' is set.
6503
6504 *'timeoutlen'* *'tm'*
6505'timeoutlen' 'tm' number (default 1000)
6506 global
6507 {not in all versions of Vi}
6508 *'ttimeoutlen'* *'ttm'*
6509'ttimeoutlen' 'ttm' number (default -1)
6510 global
6511 {not in Vi}
6512 The time in milliseconds that is waited for a key code or mapped key
6513 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6514 when part of a command has been typed.
6515 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6516 different timeout value for key codes is desired set 'ttimeoutlen' to
6517 a non-negative number.
6518
6519 ttimeoutlen mapping delay key code delay ~
6520 < 0 'timeoutlen' 'timeoutlen'
6521 >= 0 'timeoutlen' 'ttimeoutlen'
6522
6523 The timeout only happens when the 'timeout' and 'ttimeout' options
6524 tell so. A useful setting would be >
6525 :set timeout timeoutlen=3000 ttimeoutlen=100
6526< (time out on mapping after three seconds, time out on key codes after
6527 a tenth of a second).
6528
6529 *'title'* *'notitle'*
6530'title' boolean (default off, on when title can be restored)
6531 global
6532 {not in Vi}
6533 {not available when compiled without the |+title|
6534 feature}
6535 When on, the title of the window will be set to the value of
6536 'titlestring' (if it is not empty), or to:
6537 filename [+=-] (path) - VIM
6538 Where:
6539 filename the name of the file being edited
6540 - indicates the file cannot be modified, 'ma' off
6541 + indicates the file was modified
6542 = indicates the file is read-only
6543 =+ indicates the file is read-only and modified
6544 (path) is the path of the file being edited
6545 - VIM the server name |v:servername| or "VIM"
6546 Only works if the terminal supports setting window titles
6547 (currently Amiga console, Win32 console, all GUI versions and
6548 terminals with a non- empty 't_ts' option - these are Unix xterm and
6549 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6550 *X11*
6551 When Vim was compiled with HAVE_X11 defined, the original title will
6552 be restored if possible. The output of ":version" will include "+X11"
6553 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6554 works for the icon name |'icon'|.
6555 But: When Vim was started with the |-X| argument, restoring the title
6556 will not work (except in the GUI).
6557 If the title cannot be restored, it is set to the value of 'titleold'.
6558 You might want to restore the title outside of Vim then.
6559 When using an xterm from a remote machine you can use this command:
6560 rsh machine_name xterm -display $DISPLAY &
6561 then the WINDOWID environment variable should be inherited and the
6562 title of the window should change back to what it should be after
6563 exiting Vim.
6564
6565 *'titlelen'*
6566'titlelen' number (default 85)
6567 global
6568 {not in Vi}
6569 {not available when compiled without the |+title|
6570 feature}
6571 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006572 title. When the title is longer, only the end of the path name is
6573 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 Using a percentage makes this adapt to the width of the window. But
6575 it won't work perfectly, because the actual number of characters
6576 available also depends on the font used and other things in the title
6577 bar. When 'titlelen' is zero the full path is used. Otherwise,
6578 values from 1 to 30000 percent can be used.
6579 'titlelen' is also used for the 'titlestring' option.
6580
6581 *'titleold'*
6582'titleold' string (default "Thanks for flying Vim")
6583 global
6584 {not in Vi}
6585 {only available when compiled with the |+title|
6586 feature}
6587 This option will be used for the window title when exiting Vim if the
6588 original title cannot be restored. Only happens if 'title' is on or
6589 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006590 This option cannot be set from a |modeline| or in the |sandbox|, for
6591 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 *'titlestring'*
6593'titlestring' string (default "")
6594 global
6595 {not in Vi}
6596 {not available when compiled without the |+title|
6597 feature}
6598 When this option is not empty, it will be used for the title of the
6599 window. This happens only when the 'title' option is on.
6600 Only works if the terminal supports setting window titles (currently
6601 Amiga console, Win32 console, all GUI versions and terminals with a
6602 non-empty 't_ts' option).
6603 When Vim was compiled with HAVE_X11 defined, the original title will
6604 be restored if possible |X11|.
6605 When this option contains printf-style '%' items, they will be
6606 expanded according to the rules used for 'statusline'.
6607 Example: >
6608 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6609 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6610< The value of 'titlelen' is used to align items in the middle or right
6611 of the available space.
6612 Some people prefer to have the file name first: >
6613 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6614< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006615 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 separating space only when needed.
6617 NOTE: Use of special characters in 'titlestring' may cause the display
6618 to be garbled (e.g., when it contains a CR or NL character).
6619 {not available when compiled without the |+statusline| feature}
6620
6621 *'toolbar'* *'tb'*
6622'toolbar' 'tb' string (default "icons,tooltips")
6623 global
6624 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6625 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006626 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 possible values are:
6628 icons Toolbar buttons are shown with icons.
6629 text Toolbar buttons shown with text.
6630 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006631 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 tooltips Tooltips are active for toolbar buttons.
6633 Tooltips refer to the popup help text which appears after the mouse
6634 cursor is placed over a toolbar button for a brief moment.
6635
6636 If you want the toolbar to be shown with icons as well as text, do the
6637 following: >
6638 :set tb=icons,text
6639< Motif and Athena cannot display icons and text at the same time. They
6640 will show icons if both are requested.
6641
6642 If none of the strings specified in 'toolbar' are valid or if
6643 'toolbar' is empty, this option is ignored. If you want to disable
6644 the toolbar, you need to set the 'guioptions' option. For example: >
6645 :set guioptions-=T
6646< Also see |gui-toolbar|.
6647
6648 *'toolbariconsize'* *'tbis'*
6649'toolbariconsize' 'tbis' string (default "small")
6650 global
6651 {not in Vi}
6652 {only in the GTK+ 2 GUI}
6653 Controls the size of toolbar icons. The possible values are:
6654 tiny Use tiny toolbar icons.
6655 small Use small toolbar icons (default).
6656 medium Use medium-sized toolbar icons.
6657 large Use large toolbar icons.
6658 The exact dimensions in pixels of the various icon sizes depend on
6659 the current theme. Common dimensions are large=32x32, medium=24x24,
6660 small=20x20 and tiny=16x16.
6661
6662 If 'toolbariconsize' is empty, the global default size as determined
6663 by user preferences or the current theme is used.
6664
6665 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6666'ttybuiltin' 'tbi' boolean (default on)
6667 global
6668 {not in Vi}
6669 When on, the builtin termcaps are searched before the external ones.
6670 When off the builtin termcaps are searched after the external ones.
6671 When this option is changed, you should set the 'term' option next for
6672 the change to take effect, for example: >
6673 :set notbi term=$TERM
6674< See also |termcap|.
6675 Rationale: The default for this option is "on", because the builtin
6676 termcap entries are generally better (many systems contain faulty
6677 xterm entries...).
6678
6679 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6680'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6681 sun-cmd, screen, rxvt, dtterm or
6682 iris-ansi; also on when running Vim in
6683 a DOS console)
6684 global
6685 {not in Vi}
6686 Indicates a fast terminal connection. More characters will be sent to
6687 the screen for redrawing, instead of using insert/delete line
6688 commands. Improves smoothness of redrawing when there are multiple
6689 windows and the terminal does not support a scrolling region.
6690 Also enables the extra writing of characters at the end of each screen
6691 line for lines that wrap. This helps when using copy/paste with the
6692 mouse in an xterm and other terminals.
6693
6694 *'ttymouse'* *'ttym'*
6695'ttymouse' 'ttym' string (default depends on 'term')
6696 global
6697 {not in Vi}
6698 {only in Unix and VMS, doesn't work in the GUI; not
6699 available when compiled without |+mouse|}
6700 Name of the terminal type for which mouse codes are to be recognized.
6701 Currently these three strings are valid:
6702 *xterm-mouse*
6703 xterm xterm-like mouse handling. The mouse generates
6704 "<Esc>[Mscr", where "scr" is three bytes:
6705 "s" = button state
6706 "c" = column plus 33
6707 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006708 This only works up to 223 columns! See "dec" for a
6709 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 xterm2 Works like "xterm", but with the xterm reporting the
6711 mouse position while the mouse is dragged. This works
6712 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006713 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 work. See below for how Vim detects this
6715 automatically.
6716 *netterm-mouse*
6717 netterm NetTerm mouse handling. The mouse generates
6718 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6719 for the row and column.
6720 *dec-mouse*
6721 dec DEC terminal mouse handling. The mouse generates a
6722 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006723 This is also available for an Xterm, if it was
6724 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 *jsbterm-mouse*
6726 jsbterm JSB term mouse handling.
6727 *pterm-mouse*
6728 pterm QNX pterm mouse handling.
6729
6730 The mouse handling must be enabled at compile time |+mouse_xterm|
6731 |+mouse_dec| |+mouse_netterm|.
6732 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6733 recognized, if enabled at compile time. DEC terminal mouse codes
6734 are recognized if enabled at compile time, and 'ttymouse' is not
6735 "xterm" (because the xterm and dec mouse codes conflict).
6736 This option is automatically set to "xterm", when the 'term' option is
6737 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6738 or "xterm2" already. The main use of this option is to set it to
6739 "xterm", when the terminal name doesn't start with "xterm", but it can
6740 handle xterm mouse codes.
6741 The "xterm2" value will be set if the xterm version is reported to be
6742 95 of higher. This only works when compiled with the |+termresponse|
6743 feature and if |t_RV| is set to the escape sequence to request the
6744 xterm version number. Otherwise "xterm2" must be set explicitly.
6745 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6746 t_RV to an empty string: >
6747 :set t_RV=
6748<
6749 *'ttyscroll'* *'tsl'*
6750'ttyscroll' 'tsl' number (default 999)
6751 global
6752 Maximum number of lines to scroll the screen. If there are more lines
6753 to scroll the window is redrawn. For terminals where scrolling is
6754 very slow and redrawing is not slow this can be set to a small number,
6755 e.g., 3, to speed up displaying.
6756
6757 *'ttytype'* *'tty'*
6758'ttytype' 'tty' string (default from $TERM)
6759 global
6760 Alias for 'term', see above.
6761
6762 *'undolevels'* *'ul'*
6763'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6764 Win32 and OS/2)
6765 global
6766 {not in Vi}
6767 Maximum number of changes that can be undone. Since undo information
6768 is kept in memory, higher numbers will cause more memory to be used
6769 (nevertheless, a single change can use an unlimited amount of memory).
6770 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6771 itself: >
6772 set ul=0
6773< But you can also get Vi compatibility by including the 'u' flag in
6774 'cpoptions', and still be able to use CTRL-R to repeat undo.
6775 Set to a negative number for no undo at all: >
6776 set ul=-1
6777< This helps when you run out of memory for a single change.
6778 Also see |undo-two-ways|.
6779
6780 *'updatecount'* *'uc'*
6781'updatecount' 'uc' number (default: 200)
6782 global
6783 {not in Vi}
6784 After typing this many characters the swap file will be written to
6785 disk. When zero, no swap file will be created at all (see chapter on
6786 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6787 Vim with the "-n" option, see |startup|. When editing in readonly
6788 mode this option will be initialized to 10000.
6789 The swapfile can be disabled per buffer with |'swapfile'|.
6790 When 'updatecount' is set from zero to non-zero, swap files are
6791 created for all buffers that have 'swapfile' set. When 'updatecount'
6792 is set to zero, existing swap files are not deleted.
6793 Also see |'swapsync'|.
6794 This option has no meaning in buffers where |'buftype'| is "nofile"
6795 or "nowrite".
6796
6797 *'updatetime'* *'ut'*
6798'updatetime' 'ut' number (default 4000)
6799 global
6800 {not in Vi}
6801 If this many milliseconds nothing is typed the swap file will be
6802 written to disk (see |crash-recovery|). Also used for the
6803 |CursorHold| autocommand event.
6804
6805 *'verbose'* *'vbs'*
6806'verbose' 'vbs' number (default 0)
6807 global
6808 {not in Vi, although some versions have a boolean
6809 verbose option}
6810 When bigger than zero, Vim will give messages about what it is doing.
6811 Currently, these messages are given:
6812 >= 1 When the viminfo file is read or written.
6813 >= 2 When a file is ":source"'ed.
6814 >= 5 Every searched tags file.
6815 >= 8 Files for which a group of autocommands is executed.
6816 >= 9 Every executed autocommand.
6817 >= 12 Every executed function.
6818 >= 13 When an exception is thrown, caught, finished, or discarded.
6819 >= 14 Anything pending in a ":finally" clause.
6820 >= 15 Every executed Ex command (truncated at 200 characters).
6821
6822 This option can also be set with the "-V" argument. See |-V|.
6823 This option is also set by the |:verbose| command.
6824
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006825 When the 'verbosefile' option is set then the verbose messages are not
6826 displayed.
6827
6828 *'verbosefile'* *'vfile'*
6829'verbosefile' 'vfile' string (default empty)
6830 global
6831 {not in Vi}
6832 When not empty all messages are written in a file with this name.
6833 When the file exists messages are appended.
6834 Writing to the file ends when Vim exits or when 'verbosefile' is made
6835 empty.
6836 Setting 'verbosefile' to a new value is like making it empty first.
6837 The difference with |:redir| is that verbose messages are not
6838 displayed when 'verbosefile' is set.
6839
Bram Moolenaar071d4272004-06-13 20:20:40 +00006840 *'viewdir'* *'vdir'*
6841'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6842 "$VIM/vimfiles/view",
6843 for Unix: "~/.vim/view",
6844 for Macintosh: "$VIM:vimfiles:view"
6845 for VMS: "sys$login:vimfiles/view"
6846 for RiscOS: "Choices:vimfiles/view")
6847 global
6848 {not in Vi}
6849 {not available when compiled without the +mksession
6850 feature}
6851 Name of the directory where to store files for |:mkview|.
6852 This option cannot be set from a |modeline| or in the |sandbox|, for
6853 security reasons.
6854
6855 *'viewoptions'* *'vop'*
6856'viewoptions' 'vop' string (default: "folds,options,cursor")
6857 global
6858 {not in Vi}
6859 {not available when compiled without the +mksession
6860 feature}
6861 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006862 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 word save and restore ~
6864 cursor cursor position in file and in window
6865 folds manually created folds, opened/closed folds and local
6866 fold options
6867 options options and mappings local to a window or buffer (not
6868 global values for local options)
6869 slash backslashes in file names replaced with forward
6870 slashes
6871 unix with Unix end-of-line format (single <NL>), even when
6872 on Windows or DOS
6873
6874 "slash" and "unix" are useful on Windows when sharing view files
6875 with Unix. The Unix version of Vim cannot source dos format scripts,
6876 but the Windows version of Vim can source unix format scripts.
6877
6878 *'viminfo'* *'vi'* *E526* *E527* *E528*
6879'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6880 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6881 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6882 for others: '20,<50,s10,h)
6883 global
6884 {not in Vi}
6885 {not available when compiled without the |+viminfo|
6886 feature}
6887 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006888 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 separated list of parameters, each consisting of a single character
6890 identifying the particular parameter, followed by a number or string
6891 which specifies the value of that parameter. If a particular
6892 character is left out, then the default value is used for that
6893 parameter. The following is a list of the identifying characters and
6894 the effect of their value.
6895 CHAR VALUE ~
6896 ! When included, save and restore global variables that start
6897 with an uppercase letter, and don't contain a lowercase
6898 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006899 and "_K_L_M" are not. Only String and Number types are
6900 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 " Maximum number of lines saved for each register. Old name of
6902 the '<' item, with the disadvantage that you need to put a
6903 backslash before the ", otherwise it will be recognized as the
6904 start of a comment!
6905 % When included, save and restore the buffer list. If Vim is
6906 started with a file name argument, the buffer list is not
6907 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006908 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006909 without a file name and buffers for help files are not written
6910 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006911 When followed by a number, the number specifies the maximum
6912 number of buffers that are stored. Without a number all
6913 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006914 ' Maximum number of previously edited files for which the marks
6915 are remembered. This parameter must always be included when
6916 'viminfo' is non-empty.
6917 Including this item also means that the |jumplist| and the
6918 |changelist| are stored in the viminfo file.
6919 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006920 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006921 patterns are also saved. When not included, the value of
6922 'history' is used.
6923 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006924 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 < Maximum number of lines saved for each register. If zero then
6926 registers are not saved. When not included, all lines are
6927 saved. '"' is the old name for this item.
6928 Also see the 's' item below: limit specified in Kbyte.
6929 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006930 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 c When included, convert the text in the viminfo file from the
6932 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006933 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 f Whether file marks need to be stored. If zero, file marks ('0
6935 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006936 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 cursor position (when exiting or when doing ":wviminfo").
6938 h Disable the effect of 'hlsearch' when loading the viminfo
6939 file. When not included, it depends on whether ":nohlsearch"
6940 has been used since the last search command.
6941 n Name of the viminfo file. The name must immediately follow
6942 the 'n'. Must be the last one! If the "-i" argument was
6943 given when starting Vim, that file name overrides the one
6944 given here with 'viminfo'. Environment variables are expanded
6945 when opening the file, not when setting the option.
6946 r Removable media. The argument is a string (up to the next
6947 ','). This parameter can be given several times. Each
6948 specifies the start of a path for which no marks will be
6949 stored. This is to avoid removable media. For MS-DOS you
6950 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6951 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6952 ignored. Maximum length of each 'r' argument is 50
6953 characters.
6954 s Maximum size of an item in Kbyte. If zero then registers are
6955 not saved. Currently only applies to registers. The default
6956 "s10" will exclude registers with more than 10 Kbyte of text.
6957 Also see the '<' item above: line count limit.
6958
6959 Example: >
6960 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6961<
6962 '50 Marks will be remembered for the last 50 files you
6963 edited.
6964 <1000 Contents of registers (up to 1000 lines each) will be
6965 remembered.
6966 s100 Registers with more than 100 Kbyte text are skipped.
6967 :0 Command-line history will not be saved.
6968 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6969 no / Since '/' is not specified, the default will be used,
6970 that is, save all of the search history, and also the
6971 previous search and substitute patterns.
6972 no % The buffer list will not be saved nor read back.
6973 no h 'hlsearch' highlighting will be restored.
6974
6975 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6976 load the contents of the file, this is not done automatically.
6977
6978 This option cannot be set from a |modeline| or in the |sandbox|, for
6979 security reasons.
6980
6981 *'virtualedit'* *'ve'*
6982'virtualedit' 've' string (default "")
6983 global
6984 {not in Vi}
6985 {not available when compiled without the
6986 |+virtualedit| feature}
6987 A comma separated list of these words:
6988 block Allow virtual editing in Visual block mode.
6989 insert Allow virtual editing in Insert mode.
6990 all Allow virtual editing in all modes.
6991 Virtual editing means that the cursor can be positioned where there is
6992 no actual character. This can be halfway into a Tab or beyond the end
6993 of the line. Useful for selecting a rectangle in Visual mode and
6994 editing a table.
6995
6996 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6997'visualbell' 'vb' boolean (default off)
6998 global
6999 {not in Vi}
7000 Use visual bell instead of beeping. The terminal code to display the
7001 visual bell is given with 't_vb'. When no beep or flash is wanted,
7002 use ":set vb t_vb=".
7003 Note: When the GUI starts, 't_vb' is reset to its default value. You
7004 might want to set it again in your |gvimrc|.
7005 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7006 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7007 where 40 is the time in msec.
7008 Does not work on the Amiga, you always get a screen flash.
7009 Also see 'errorbells'.
7010
7011 *'warn'* *'nowarn'*
7012'warn' boolean (default on)
7013 global
7014 Give a warning message when a shell command is used while the buffer
7015 has been changed.
7016
7017 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7018'weirdinvert' 'wiv' boolean (default off)
7019 global
7020 {not in Vi}
7021 This option has the same effect as the 't_xs' termcap option.
7022 It is provided for backwards compatibility with version 4.x.
7023 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7024 vice versa. Has no effect when the GUI is running.
7025
7026 *'whichwrap'* *'ww'*
7027'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7028 global
7029 {not in Vi}
7030 Allow specified keys that move the cursor left/right to move to the
7031 previous/next line when the cursor is on the first/last character in
7032 the line. Concatenate characters to allow this for these keys:
7033 char key mode ~
7034 b <BS> Normal and Visual
7035 s <Space> Normal and Visual
7036 h "h" Normal and Visual
7037 l "l" Normal and Visual
7038 < <Left> Normal and Visual
7039 > <Right> Normal and Visual
7040 ~ "~" Normal
7041 [ <Left> Insert and Replace
7042 ] <Right> Insert and Replace
7043 For example: >
7044 :set ww=<,>,[,]
7045< allows wrap only when cursor keys are used.
7046 When the movement keys are used in combination with a delete or change
7047 operator, the <EOL> also counts for a character. This makes "3h"
7048 different from "3dh" when the cursor crosses the end of a line. This
7049 is also true for "x" and "X", because they do the same as "dl" and
7050 "dh". If you use this, you may also want to use the mapping
7051 ":map <BS> X" to make backspace delete the character in front of the
7052 cursor.
7053 When 'l' is included, you get a side effect: "yl" on an empty line
7054 will include the <EOL>, so that "p" will insert a new line.
7055 NOTE: This option is set to the Vi default value when 'compatible' is
7056 set and to the Vim default value when 'compatible' is reset.
7057
7058 *'wildchar'* *'wc'*
7059'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7060 global
7061 {not in Vi}
7062 Character you have to type to start wildcard expansion in the
7063 command-line, as specified with 'wildmode'.
7064 The character is not recognized when used inside a macro. See
7065 'wildcharm' for that.
7066 Although 'wc' is a number option, you can set it to a special key: >
7067 :set wc=<Esc>
7068< NOTE: This option is set to the Vi default value when 'compatible' is
7069 set and to the Vim default value when 'compatible' is reset.
7070
7071 *'wildcharm'* *'wcm'*
7072'wildcharm' 'wcm' number (default: none (0))
7073 global
7074 {not in Vi}
7075 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007076 recognized when used inside a macro. You can find "spare" command-line
7077 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007078 you'll never actually type 'wildcharm', just use it in mappings that
7079 automatically invoke completion mode, e.g.: >
7080 :set wcm=<C-Z>
7081 :cmap ss so $vim/sessions/*.vim<C-Z>
7082< Then after typing :ss you can use CTRL-P & CTRL-N.
7083
7084 *'wildignore'* *'wig'*
7085'wildignore' 'wig' string (default "")
7086 global
7087 {not in Vi}
7088 {not available when compiled without the |+wildignore|
7089 feature}
7090 A list of file patterns. A file that matches with one of these
7091 patterns is ignored when completing file or directory names.
7092 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7093 Also see 'suffixes'.
7094 Example: >
7095 :set wildignore=*.o,*.obj
7096< The use of |:set+=| and |:set-=| is preferred when adding or removing
7097 a pattern from the list. This avoids problems when a future version
7098 uses another default.
7099
7100 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7101'wildmenu' 'wmnu' boolean (default off)
7102 global
7103 {not in Vi}
7104 {not available if compiled without the |+wildmenu|
7105 feature}
7106 When 'wildmenu' is on, command-line completion operates in an enhanced
7107 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7108 the possible matches are shown just above the command line, with the
7109 first match highlighted (overwriting the status line, if there is
7110 one). Keys that show the previous/next match, such as <Tab> or
7111 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7112 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7113 specified. "longest" and "list" do not start "wildmenu" mode.
7114 If there are more matches than can fit in the line, a ">" is shown on
7115 the right and/or a "<" is shown on the left. The status line scrolls
7116 as needed.
7117 The "wildmenu" mode is abandoned when a key is hit that is not used
7118 for selecting a completion.
7119 While the "wildmenu" is active the following keys have special
7120 meanings:
7121
7122 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7123 <Down> - in filename/menu name completion: move into a
7124 subdirectory or submenu.
7125 <CR> - in menu completion, when the cursor is just after a
7126 dot: move into a submenu.
7127 <Up> - in filename/menu name completion: move up into
7128 parent directory or parent menu.
7129
7130 This makes the menus accessible from the console |console-menus|.
7131
7132 If you prefer the <Left> and <Right> keys to move the cursor instead
7133 of selecting a different match, use this: >
7134 :cnoremap <Left> <Space><BS><Left>
7135 :cnoremap <Right> <Space><BS><Right>
7136<
7137 The "WildMenu" highlighting is used for displaying the current match
7138 |hl-WildMenu|.
7139
7140 *'wildmode'* *'wim'*
7141'wildmode' 'wim' string (Vim default: "full")
7142 global
7143 {not in Vi}
7144 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007146 part specifies what to do for each consecutive use of 'wildchar. The
7147 first part specifies the behavior for the first use of 'wildchar',
7148 The second part for the second use, etc.
7149 These are the possible values for each part:
7150 "" Complete only the first match.
7151 "full" Complete the next full match. After the last match,
7152 the original string is used and then the first match
7153 again.
7154 "longest" Complete till longest common string. If this doesn't
7155 result in a longer string, use the next part.
7156 "longest:full" Like "longest", but also start 'wildmenu' if it is
7157 enabled.
7158 "list" When more than one match, list all matches.
7159 "list:full" When more than one match, list all matches and
7160 complete first match.
7161 "list:longest" When more than one match, list all matches and
7162 complete till longest common string.
7163 When there is only a single match, it is fully completed in all cases.
7164
7165 Examples: >
7166 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007167< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007168 :set wildmode=longest,full
7169< Complete longest common string, then each full match >
7170 :set wildmode=list:full
7171< List all matches and complete each full match >
7172 :set wildmode=list,full
7173< List all matches without completing, then each full match >
7174 :set wildmode=longest,list
7175< Complete longest common string, then list alternatives.
7176
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007177 *'wildoptions'* *'wop'*
7178'wildoptions' 'wop' string (default "")
7179 global
7180 {not in Vi}
7181 {not available when compiled without the |+wildignore|
7182 feature}
7183 A list of words that change how command line completion is done.
7184 Currently only one word is allowed:
7185 tagfile When using CTRL-D to list matching tags, the kind of
7186 tag and the file of the tag is listed. Only one match
7187 is displayed per line. Often used tag kinds are:
7188 d #define
7189 f function
7190 Also see |cmdline-completion|.
7191
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 *'winaltkeys'* *'wak'*
7193'winaltkeys' 'wak' string (default "menu")
7194 global
7195 {not in Vi}
7196 {only used in Win32, Motif, GTK and Photon GUI}
7197 Some GUI versions allow the access to menu entries by using the ALT
7198 key in combination with a character that appears underlined in the
7199 menu. This conflicts with the use of the ALT key for mappings and
7200 entering special characters. This option tells what to do:
7201 no Don't use ALT keys for menus. ALT key combinations can be
7202 mapped, but there is no automatic handling. This can then be
7203 done with the |:simalt| command.
7204 yes ALT key handling is done by the windowing system. ALT key
7205 combinations cannot be mapped.
7206 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007207 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 keys can be mapped.
7209 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7210 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007211 This option is not used for <F10>; on Win32 and with GTK <F10> will
7212 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007214 *'window'* *'wi'*
7215'window' 'wi' number (default screen height - 1)
7216 global
7217 Window height. Do not confuse this with the height of the Vim window,
7218 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007219 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7220 value is smaller than 'lines' minus one. The screen will scroll
7221 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007222 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7223 in a much smarter way, taking care of wrapping lines.
7224 When resizing the Vim window, the value is smaller than 1 or more than
7225 or equal to 'lines' it will be set to 'lines' minus 1.
7226 {Vi also uses the option to specify the number of displayed lines}
7227
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 *'winheight'* *'wh'* *E591*
7229'winheight' 'wh' number (default 1)
7230 global
7231 {not in Vi}
7232 {not available when compiled without the +windows
7233 feature}
7234 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007235 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 current window is smaller, its size is increased, at the cost of the
7237 height of other windows. Set it to 999 to make the current window
7238 always fill the screen (although this has the drawback that ":all"
7239 will create only two windows). Set it to a small number for normal
7240 editing.
7241 Minimum value is 1.
7242 The height is not adjusted after one of the commands to change the
7243 height of the current window.
7244 'winheight' applies to the current window. Use 'winminheight' to set
7245 the minimal height for other windows.
7246
7247 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7248'winfixheight' 'wfh' boolean (default off)
7249 local to window
7250 {not in Vi}
7251 {not available when compiled without the +windows
7252 feature}
7253 Keep the window height when windows are opened or closed and
7254 'equalalways' is set. Set by default for the |preview-window| and
7255 |quickfix-window|.
7256 The height may be changed anyway when running out of room.
7257
7258 *'winminheight'* *'wmh'*
7259'winminheight' 'wmh' number (default 1)
7260 global
7261 {not in Vi}
7262 {not available when compiled without the +windows
7263 feature}
7264 The minimal height of a window, when it's not the current window.
7265 This is a hard minimum, windows will never become smaller.
7266 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7267 status bar) if necessary. They will return to at least one line when
7268 they become active (since the cursor has to have somewhere to go.)
7269 Use 'winheight' to set the minimal height of the current window.
7270 This option is only checked when making a window smaller. Don't use a
7271 large number, it will cause errors when opening more than a few
7272 windows. A value of 0 to 3 is reasonable.
7273
7274 *'winminwidth'* *'wmw'*
7275'winminwidth' 'wmw' number (default 1)
7276 global
7277 {not in Vi}
7278 {not available when compiled without the +vertsplit
7279 feature}
7280 The minimal width of a window, when it's not the current window.
7281 This is a hard minimum, windows will never become smaller.
7282 When set to zero, windows may be "squashed" to zero columns (i.e. just
7283 a vertical separator) if necessary. They will return to at least one
7284 line when they become active (since the cursor has to have somewhere
7285 to go.)
7286 Use 'winwidth' to set the minimal width of the current window.
7287 This option is only checked when making a window smaller. Don't use a
7288 large number, it will cause errors when opening more than a few
7289 windows. A value of 0 to 12 is reasonable.
7290
7291 *'winwidth'* *'wiw'* *E592*
7292'winwidth' 'wiw' number (default 20)
7293 global
7294 {not in Vi}
7295 {not available when compiled without the +vertsplit
7296 feature}
7297 Minimal number of columns for the current window. This is not a hard
7298 minimum, Vim will use fewer columns if there is not enough room. If
7299 the current window is smaller, its size is increased, at the cost of
7300 the width of other windows. Set it to 999 to make the current window
7301 always fill the screen. Set it to a small number for normal editing.
7302 The width is not adjusted after one of the commands to change the
7303 width of the current window.
7304 'winwidth' applies to the current window. Use 'winminwidth' to set
7305 the minimal width for other windows.
7306
7307 *'wrap'* *'nowrap'*
7308'wrap' boolean (default on)
7309 local to window
7310 {not in Vi}
7311 This option changes how text is displayed. It doesn't change the text
7312 in the buffer, see 'textwidth' for that.
7313 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007314 displaying continues on the next line. When off lines will not wrap
7315 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 moved to a part that is not shown, the screen will scroll
7317 horizontally.
7318 The line will be broken in the middle of a word if necessary. See
7319 'linebreak' to get the break at a word boundary.
7320 To make scrolling horizontally a bit more useful, try this: >
7321 :set sidescroll=5
7322 :set listchars+=precedes:<,extends:>
7323< See 'sidescroll', 'listchars' and |wrap-off|.
7324
7325 *'wrapmargin'* *'wm'*
7326'wrapmargin' 'wm' number (default 0)
7327 local to buffer
7328 Number of characters from the right window border where wrapping
7329 starts. When typing text beyond this limit, an <EOL> will be inserted
7330 and inserting continues on the next line.
7331 Options that add a margin, such as 'number' and 'foldcolumn', cause
7332 the text width to be further reduced. This is Vi compatible.
7333 When 'textwidth' is non-zero, this option is not used.
7334 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7335 and less usefully}
7336
7337 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7338'wrapscan' 'ws' boolean (default on) *E384* *E385*
7339 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007340 Searches wrap around the end of the file. Also applies to |]s| and
7341 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342
7343 *'write'* *'nowrite'*
7344'write' boolean (default on)
7345 global
7346 {not in Vi}
7347 Allows writing files. When not set, writing a file is not allowed.
7348 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007349 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007350 argument. Filtering text is still possible, even though this requires
7351 writing a temporary file.
7352
7353 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7354'writeany' 'wa' boolean (default off)
7355 global
7356 Allows writing to any file with no need for "!" override.
7357
7358 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7359'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7360 otherwise)
7361 global
7362 {not in Vi}
7363 Make a backup before overwriting a file. The backup is removed after
7364 the file was successfully written, unless the 'backup' option is
7365 also on. Reset this option if your file system is almost full. See
7366 |backup-table| for another explanation.
7367 When the 'backupskip' pattern matches, a backup is not made anyway.
7368 NOTE: This option is set to the default value when 'compatible' is
7369 set.
7370
7371 *'writedelay'* *'wd'*
7372'writedelay' 'wd' number (default 0)
7373 global
7374 {not in Vi}
7375 The number of microseconds to wait for each character sent to the
7376 screen. When non-zero, characters are sent to the terminal one by
7377 one. For MS-DOS pcterm this does not work. For debugging purposes.
7378
7379 vim:tw=78:ts=8:ft=help:norl: