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