blob: cbce4f9ae0a1aabd325332c764233461a547e907 [file] [log] [blame]
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Nov 30
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.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001439 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440
1441 *'comments'* *'com'* *E524* *E525*
1442'comments' 'com' string (default
1443 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1444 local to buffer
1445 {not in Vi}
1446 {not available when compiled without the |+comments|
1447 feature}
1448 A comma separated list of strings that can start a comment line. See
1449 |format-comments|. See |option-backslash| about using backslashes to
1450 insert a space.
1451
1452 *'commentstring'* *'cms'* *E537*
1453'commentstring' 'cms' string (default "/*%s*/")
1454 local to buffer
1455 {not in Vi}
1456 {not available when compiled without the |+folding|
1457 feature}
1458 A template for a comment. The "%s" in the value is replaced with the
1459 comment text. Currently only used to add markers for folding, see
1460 |fold-marker|.
1461
1462 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001463'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1464 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 global
1466 {not in Vi}
1467 This option has the effect of making Vim either more Vi-compatible, or
1468 make Vim behave in a more useful way.
1469 This is a special kind of option, because when it's set or reset,
1470 other options are also changed as a side effect. CAREFUL: Setting or
1471 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001472 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 set this option in your vimrc file, you should probably put it at the
1474 very start.
1475 By default this option is on and the Vi defaults are used for the
1476 options. This default was chosen for those people who want to use Vim
1477 just like Vi, and don't even (want to) know about the 'compatible'
1478 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001479 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1480 this option is switched off, and all options that have not been
1481 modified will be set to the Vim defaults. Effectively, this means
1482 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1483 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1484 happen for the system-wide vimrc or gvimrc file). Also see
1485 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 You can also set this option with the "-C" argument, and reset it with
1487 "-N". See |-C| and |-N|.
1488 Switching this option off makes the Vim defaults be used for options
1489 that have a different Vi and Vim default value. See the options
1490 marked with a '+' below. Other options are not modified.
1491 At the moment this option is set, several other options will be set
1492 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001493 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001494 editing.
1495 See also 'cpoptions'.
1496
1497 option + set value effect ~
1498
1499 'allowrevins' off no CTRL-_ command
1500 'backupcopy' Unix: "yes" backup file is a copy
1501 others: "auto" copy or rename backup file
1502 'backspace' "" normal backspace
1503 'backup' off no backup file
1504 'cindent' off no C code indentation
1505 'cedit' + "" no key to open the |cmdwin|
1506 'cpoptions' + (all flags) Vi-compatible flags
1507 'cscopetag' off don't use cscope for ":tag"
1508 'cscopetagorder' 0 see |cscopetagorder|
1509 'cscopeverbose' off see |cscopeverbose|
1510 'digraph' off no digraphs
1511 'esckeys' + off no <Esc>-keys in Insert mode
1512 'expandtab' off tabs not expanded to spaces
1513 'fileformats' + "" no automatic file format detection,
1514 "dos,unix" except for DOS, Windows and OS/2
1515 'formatoptions' + "vt" Vi compatible formatting
1516 'gdefault' off no default 'g' flag for ":s"
1517 'history' + 0 no commandline history
1518 'hkmap' off no Hebrew keyboard mapping
1519 'hkmapp' off no phonetic Hebrew keyboard mapping
1520 'hlsearch' off no highlighting of search matches
1521 'incsearch' off no incremental searching
1522 'indentexpr' "" no indenting by expression
1523 'insertmode' off do not start in Insert mode
1524 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1525 characters and '_'
1526 'joinspaces' on insert 2 spaces after period
1527 'modeline' + off no modelines
1528 'more' + off no pauses in listings
1529 'revins' off no reverse insert
1530 'ruler' off no ruler
1531 'scrolljump' 1 no jump scroll
1532 'scrolloff' 0 no scroll offset
1533 'shiftround' off indent not rounded to shiftwidth
1534 'shortmess' + "" no shortening of messages
1535 'showcmd' + off command characters not shown
1536 'showmode' + off current mode not shown
1537 'smartcase' off no automatic ignore case switch
1538 'smartindent' off no smart indentation
1539 'smarttab' off no smart tab size
1540 'softtabstop' 0 tabs are always 'tabstop' positions
1541 'startofline' on goto startofline with some commands
1542 'tagrelative' + off tag file names are not relative
1543 'textauto' + off no automatic textmode detection
1544 'textwidth' 0 no automatic line wrap
1545 'tildeop' off tilde is not an operator
1546 'ttimeout' off no terminal timeout
1547 'whichwrap' + "" left-right movements don't wrap
1548 'wildchar' + CTRL-E only when the current value is <Tab>
1549 use CTRL-E for cmdline completion
1550 'writebackup' on or off depends on +writebackup feature
1551
1552 *'complete'* *'cpt'* *E535*
1553'complete' 'cpt' string (default: ".,w,b,u,t,i")
1554 local to buffer
1555 {not in Vi}
1556 This option specifies how keyword completion |ins-completion| works
1557 when CTRL-P or CTRL-N are used. It is also used for whole-line
1558 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1559 and the places to scan. It is a comma separated list of flags:
1560 . scan the current buffer ('wrapscan' is ignored)
1561 w scan buffers from other windows
1562 b scan other loaded buffers that are in the buffer list
1563 u scan the unloaded buffers that are in the buffer list
1564 U scan the buffers that are not in the buffer list
1565 k scan the files given with the 'dictionary' option
1566 k{dict} scan the file {dict}. Several "k" flags can be given,
1567 patterns are valid too. For example: >
1568 :set cpt=k/usr/dict/*,k~/spanish
1569< s scan the files given with the 'thesaurus' option
1570 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1571 are valid too.
1572 i scan current and included files
1573 d scan current and included files for defined name or macro
1574 |i_CTRL-X_CTRL-D|
1575 ] tag completion
1576 t same as "]"
1577
1578 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1579 not executed, this may lead to unexpected completions from some files
1580 (gzipped files for example). Unloaded buffers are not scanned for
1581 whole-line completion.
1582
1583 The default is ".,w,b,u,t,i", which means to scan:
1584 1. the current buffer
1585 2. buffers in other windows
1586 3. other loaded buffers
1587 4. unloaded buffers
1588 5. tags
1589 6. included files
1590
1591 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001592 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1593 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001595 *'completefunc'* *'cfu'*
1596'completefunc' 'cfu' string (default: empty)
1597 local to buffer
1598 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001599 {not available when compiled without the +eval
1600 or +insert_expand feature}
1601 This option specifies a function to be used for CTRL-X CTRL-U
1602 completion. |i_CTRL-X_CTRL-U|
1603
Bram Moolenaare344bea2005-09-01 20:46:49 +00001604 The function will be invoked with two arguments. First the function
1605 is called to find the start of the text to be completed. Secondly the
1606 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001607
Bram Moolenaare344bea2005-09-01 20:46:49 +00001608 On the first invocation the arguments are:
1609 a:findstart 1
1610 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001611
Bram Moolenaare344bea2005-09-01 20:46:49 +00001612 The function must return the column of where the completion starts.
1613 It must be a number between zero and the cursor column "col('.')".
1614 This involves looking at the characters just before the cursor and
1615 including those characters that could be part of the completed item.
1616 The text between this column and the cursor column will be replaced
1617 with the matches. Return -1 if no completion can be done.
1618
1619 On the second invocation the arguments are:
1620 a:findstart 0
1621 a:base the text with which matches should match, what was
Bram Moolenaard5cdbeb2005-10-10 20:59:28 +00001622 located in the first call (can be empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00001623
1624 The function must return a List with the matching words. These
1625 matches usually include the "a:base" text. When there are no matches
1626 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001627
Bram Moolenaar572cb562005-08-05 21:35:02 +00001628 When searching for matches takes some time call |complete_add()| to
1629 add each match to the total list. These matches should then not
1630 appear in the returned list! Call |complete_check()| now and then to
1631 allow the user to press a key while still searching for matches. Stop
1632 searching when it returns non-zero.
1633
Bram Moolenaare344bea2005-09-01 20:46:49 +00001634 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001635 This option cannot be set from a |modeline| or in the |sandbox|, for
1636 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001637
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001638 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001639 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001640 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001641 " locate the start of the word
1642 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001643 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001644 while start > 0 && line[start - 1] =~ '\a'
1645 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001646 endwhile
1647 return start
1648 else
1649 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001650 let res = []
1651 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1652 if m =~ '^' . a:base
1653 call add(res, m)
1654 endif
1655 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001656 return res
1657 endif
1658 endfun
1659 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001660<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001661 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001662 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001663 if a:findstart
1664 " locate the start of the word
1665 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001666 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001667 while start > 0 && line[start - 1] =~ '\a'
1668 let start -= 1
1669 endwhile
1670 return start
1671 else
1672 " find months matching with "a:base"
1673 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1674 if m =~ '^' . a:base
1675 call complete_add(m)
1676 endif
1677 sleep 300m " simulate searching for next match
1678 if complete_check()
1679 break
1680 endif
1681 endfor
1682 return []
1683 endif
1684 endfun
1685 set completefunc=CompleteMonths
1686<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001687
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001688 *'completeopt'* *'cot'*
1689'completeopt' 'cot' string (default: "menu")
1690 global
1691 {not in Vi}
1692 Options for Insert mode completion |ins-completion|.
1693 Currently the only supported value is:
1694
1695 menu Use a popup menu to show the possible completions. The
1696 menu is only shown when there is more than one match and
1697 sufficient colors are available. |ins-completion-menu|
1698
1699
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1701'confirm' 'cf' boolean (default off)
1702 global
1703 {not in Vi}
1704 When 'confirm' is on, certain operations that would normally
1705 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1706 instead raise a |dialog| asking if you wish to save the current
1707 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1708 If 'confirm' is off you can still activate confirmation for one
1709 command only (this is most useful in mappings) with the |:confirm|
1710 command.
1711 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1712
1713 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1714'conskey' 'consk' boolean (default off)
1715 global
1716 {not in Vi} {only for MS-DOS}
1717 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001718 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 three methods of console input are available:
1720 'conskey' 'bioskey' action ~
1721 on on or off direct console input
1722 off on BIOS
1723 off off STDIN
1724
1725 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1726'copyindent' 'ci' boolean (default off)
1727 local to buffer
1728 {not in Vi}
1729 Copy the structure of the existing lines indent when autoindenting a
1730 new line. Normally the new indent is reconstructed by a series of
1731 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1732 in which case only spaces are used). Enabling this option makes the
1733 new line copy whatever characters were used for indenting on the
1734 existing line. If the new indent is greater than on the existing
1735 line, the remaining space is filled in the normal manner.
1736 NOTE: 'copyindent' is reset when 'compatible' is set.
1737 Also see 'preserveindent'.
1738
1739 *'cpoptions'* *'cpo'*
1740'cpoptions' 'cpo' string (Vim default: "aABceFs",
1741 Vi default: all flags)
1742 global
1743 {not in Vi}
1744 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001745 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746 not being vi-compatible is mostly or sometimes preferred.
1747 'cpoptions' stands for "compatible-options".
1748 Commas can be added for readability.
1749 To avoid problems with flags that are added in the future, use the
1750 "+=" and "-=" feature of ":set" |add-option-flags|.
1751 NOTE: This option is set to the Vi default value when 'compatible' is
1752 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001753 NOTE: This option is set to the POSIX default value at startup when
1754 the Vi default value would be used and the $VIM_POSIX environment
1755 variable exists |posix|. This means tries to behave like the POSIX
1756 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757
1758 contains behavior ~
1759 *cpo-a*
1760 a When included, a ":read" command with a file name
1761 argument will set the alternate file name for the
1762 current window.
1763 *cpo-A*
1764 A When included, a ":write" command with a file name
1765 argument will set the alternate file name for the
1766 current window.
1767 *cpo-b*
1768 b "\|" in a ":map" command is recognized as the end of
1769 the map command. The '\' is included in the mapping,
1770 the text after the '|' is interpreted as the next
1771 command. Use a CTRL-V instead of a backslash to
1772 include the '|' in the mapping. Applies to all
1773 mapping, abbreviation, menu and autocmd commands.
1774 See also |map_bar|.
1775 *cpo-B*
1776 B A backslash has no special meaning in mappings,
1777 abbreviations and the "to" part of the menu commands.
1778 Remove this flag to be able to use a backslash like a
1779 CTRL-V. For example, the command ":map X \<Esc>"
1780 results in X being mapped to:
1781 'B' included: "\^[" (^[ is a real <Esc>)
1782 'B' excluded: "<Esc>" (5 characters)
1783 ('<' excluded in both cases)
1784 *cpo-c*
1785 c Searching continues at the end of any match at the
1786 cursor position, but not further than the start of the
1787 next line. When not present searching continues
1788 one character from the cursor position. With 'c'
1789 "abababababab" only gets three matches when repeating
1790 "/abab", without 'c' there are five matches.
1791 *cpo-C*
1792 C Do not concatenate sourced lines that start with a
1793 backslash. See |line-continuation|.
1794 *cpo-d*
1795 d Using "./" in the 'tags' option doesn't mean to use
1796 the tags file relative to the current file, but the
1797 tags file in the current directory.
1798 *cpo-D*
1799 D Can't use CTRL-K to enter a digraph after Normal mode
1800 commands with a character argument, like |r|, |f| and
1801 |t|.
1802 *cpo-e*
1803 e When executing a register with ":@r", always add a
1804 <CR> to the last line, also when the register is not
1805 linewise. If this flag is not present, the register
1806 is not linewise and the last line does not end in a
1807 <CR>, then the last line is put on the command-line
1808 and can be edited before hitting <CR>.
1809 *cpo-E*
1810 E It is an error when using "y", "d", "c", "g~", "gu" or
1811 "gU" on an Empty region. The operators only work when
1812 at least one character is to be operate on. Example:
1813 This makes "y0" fail in the first column.
1814 *cpo-f*
1815 f When included, a ":read" command with a file name
1816 argument will set the file name for the current buffer,
1817 if the current buffer doesn't have a file name yet.
1818 *cpo-F*
1819 F When included, a ":write" command with a file name
1820 argument will set the file name for the current
1821 buffer, if the current buffer doesn't have a file name
1822 yet.
1823 *cpo-g*
1824 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001825 *cpo-H*
1826 H When using "I" on a line with only blanks, insert
1827 before the last blank. Without this flag insert after
1828 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 *cpo-i*
1830 i When included, interrupting the reading of a file will
1831 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001832 *cpo-I*
1833 I When moving the cursor up or down just after inserting
1834 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 *cpo-j*
1836 j When joining lines, only add two spaces after a '.',
1837 not after '!' or '?'. Also see 'joinspaces'.
1838 *cpo-J*
1839 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001840 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 white space.
1842 *cpo-k*
1843 k Disable the recognition of raw key codes in
1844 mappings, abbreviations, and the "to" part of menu
1845 commands. For example, if <Key> sends ^[OA (where ^[
1846 is <Esc>), the command ":map X ^[OA" results in X
1847 being mapped to:
1848 'k' included: "^[OA" (3 characters)
1849 'k' excluded: "<Key>" (one key code)
1850 Also see the '<' flag below.
1851 *cpo-K*
1852 K Don't wait for a key code to complete when it is
1853 halfway a mapping. This breaks mapping <F1><F1> when
1854 only part of the second <F1> has been read. It
1855 enables cancelling the mapping by typing <F1><Esc>.
1856 *cpo-l*
1857 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001858 literally, only "\]", "\^", "\-" and "\\" are special.
1859 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1861 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001862 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 *cpo-L*
1864 L When the 'list' option is set, 'wrapmargin',
1865 'textwidth', 'softtabstop' and Virtual Replace mode
1866 (see |gR|) count a <Tab> as two characters, instead of
1867 the normal behavior of a <Tab>.
1868 *cpo-m*
1869 m When included, a showmatch will always wait half a
1870 second. When not included, a showmatch will wait half
1871 a second or until a character is typed. |'showmatch'|
1872 *cpo-M*
1873 M When excluded, "%" matching will take backslashes into
1874 account. Thus in "( \( )" and "\( ( \)" the outer
1875 parenthesis match. When included "%" ignores
1876 backslashes, which is Vi compatible.
1877 *cpo-n*
1878 n When included, the column used for 'number' will also
1879 be used for text of wrapped lines.
1880 *cpo-o*
1881 o Line offset to search command is not remembered for
1882 next search.
1883 *cpo-O*
1884 O Don't complain if a file is being overwritten, even
1885 when it didn't exist when editing it. This is a
1886 protection against a file unexpectedly created by
1887 someone else. Vi didn't complain about this.
1888 *cpo-p*
1889 p Vi compatible Lisp indenting. When not present, a
1890 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001891 *cpo-q*
1892 q When joining multiple lines leave the cursor at the
1893 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 *cpo-r*
1895 r Redo ("." command) uses "/" to repeat a search
1896 command, instead of the actually used search string.
1897 *cpo-R*
1898 R Remove marks from filtered lines. Without this flag
1899 marks are kept like |:keepmarks| was used.
1900 *cpo-s*
1901 s Set buffer options when entering the buffer for the
1902 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001903 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 set when the buffer is created.
1905 *cpo-S*
1906 S Set buffer options always when entering a buffer
1907 (except 'readonly', 'fileformat', 'filetype' and
1908 'syntax'). This is the (most) Vi compatible setting.
1909 The options are set to the values in the current
1910 buffer. When you change an option and go to another
1911 buffer, the value is copied. Effectively makes the
1912 buffer options global to all buffers.
1913
1914 's' 'S' copy buffer options
1915 no no when buffer created
1916 yes no when buffer first entered (default)
1917 X yes each time when buffer entered (vi comp.)
1918 *cpo-t*
1919 t Search pattern for the tag command is remembered for
1920 "n" command. Otherwise Vim only puts the pattern in
1921 the history for search pattern, but doesn't change the
1922 last used search pattern.
1923 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001924 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 *cpo-v*
1926 v Backspaced characters remain visible on the screen in
1927 Insert mode. Without this flag the characters are
1928 erased from the screen right away. With this flag the
1929 screen newly typed text overwrites backspaced
1930 characters.
1931 *cpo-w*
1932 w When using "cw" on a blank character, only change one
1933 character and not all blanks until the start of the
1934 next word.
1935 *cpo-W*
1936 W Don't overwrite a readonly file. When omitted, ":w!"
1937 overwrites a readonly file, if possible.
1938 *cpo-x*
1939 x <Esc> on the command-line executes the command-line.
1940 The default in Vim is to abandon the command-line,
1941 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001942 *cpo-X*
1943 X When using a count with "R" the replaced text is
1944 deleted only once. Also when repeating "R" with "."
1945 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 *cpo-y*
1947 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001948 *cpo-Z*
1949 Z When using "w!" while the 'readonly' option is set,
1950 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 *cpo-!*
1952 ! When redoing a filter command, use the last used
1953 external command, whatever it was. Otherwise the last
1954 used -filter- command is used.
1955 *cpo-$*
1956 $ When making a change to one line, don't redisplay the
1957 line, but put a '$' at the end of the changed text.
1958 The changed text will be overwritten when you type the
1959 new text. The line is redisplayed if you type any
1960 command that moves the cursor from the insertion
1961 point.
1962 *cpo-%*
1963 % Vi-compatible matching is done for the "%" command.
1964 Does not recognize "#if", "#endif", etc.
1965 Does not recognize "/*" and "*/".
1966 Parens inside single and double quotes are also
1967 counted, causing a string that contains a paren to
1968 disturb the matching. For example, in a line like
1969 "if (strcmp("foo(", s))" the first paren does not
1970 match the last one. When this flag is not included,
1971 parens inside single and double quotes are treated
1972 specially. When matching a paren outside of quotes,
1973 everything inside quotes is ignored. When matching a
1974 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001975 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001976 This flag is also used for other features, such as
1977 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001978 *cpo--*
1979 - When included, a vertical movement command fails when
1980 it would above the first line or below the last line.
1981 Without it the cursor moves to the first or last line,
1982 unless it already was in that line.
1983 Applies to the commands "-", "k", CTRL-P, "+", "j",
1984 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001985 *cpo-+*
1986 + When included, a ":write file" command will reset the
1987 'modified' flag of the buffer, even though the buffer
1988 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001989 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 * Use ":*" in the same way as ":@". When not included,
1991 ":*" is an alias for ":'<,'>", select the Visual area.
1992 *cpo-<*
1993 < Disable the recognition of special key codes in |<>|
1994 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001995 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 ":map X <Tab>" results in X being mapped to:
1997 '<' included: "<Tab>" (5 characters)
1998 '<' excluded: "^I" (^I is a real <Tab>)
1999 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002000 *cpo->*
2001 > When appending to a register, put a line break before
2002 the appended text.
2003
2004 POSIX flags. These are not included in the Vi default value, except
2005 when $VIM_POSIX was set on startup. |posix|
2006
2007 contains behavior ~
2008 *cpo-#*
2009 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002010 *cpo-&*
2011 & When ":preserve" was used keep the swap file when
2012 exiting normally while this buffer is still loaded.
2013 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002014 *cpo-\*
2015 \ Backslash in a [] range in a search pattern is taken
2016 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002017 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2018 '\' excluded: "/[ \-]" finds <Space> and '-'
2019 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002020 *cpo-/*
2021 / When "%" is used as the replacement string in a |:s|
2022 command, use the previous replacement string. |:s%|
2023 *cpo-{*
2024 { The |{| and |}| commands also stop at a "{" character
2025 at the start of a line.
2026 *cpo-.*
2027 . The ":chdir" and ":cd" commands fail if the current
2028 buffer is modified, unless ! is used. Vim doesn't
2029 need this, since it remembers the full path of an
2030 opened file.
2031 *cpo-bar*
2032 | The value of the $LINES and $COLUMNS environment
2033 variables overrule the terminal size values obtained
2034 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002035
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036
2037 *'cscopepathcomp'* *'cspc'*
2038'cscopepathcomp' 'cspc' number (default 0)
2039 global
2040 {not available when compiled without the |+cscope|
2041 feature}
2042 {not in Vi}
2043 Determines how many components of the path to show in a list of tags.
2044 See |cscopepathcomp|.
2045
2046 *'cscopeprg'* *'csprg'*
2047'cscopeprg' 'csprg' string (default "cscope")
2048 global
2049 {not available when compiled without the |+cscope|
2050 feature}
2051 {not in Vi}
2052 Specifies the command to execute cscope. See |cscopeprg|.
2053 This option cannot be set from a |modeline| or in the |sandbox|, for
2054 security reasons.
2055
2056 *'cscopequickfix'* *'csqf'*
2057'cscopequickfix' 'csqf' string (default "")
2058 global
2059 {not available when compiled without the |+cscope|
2060 or |+quickfix| features}
2061 {not in Vi}
2062 Specifies whether to use quickfix window to show cscope results.
2063 See |cscopequickfix|.
2064
2065 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2066'cscopetag' 'cst' boolean (default off)
2067 global
2068 {not available when compiled without the |+cscope|
2069 feature}
2070 {not in Vi}
2071 Use cscope for tag commands. See |cscope-options|.
2072 NOTE: This option is reset when 'compatible' is set.
2073
2074 *'cscopetagorder'* *'csto'*
2075'cscopetagorder' 'csto' number (default 0)
2076 global
2077 {not available when compiled without the |+cscope|
2078 feature}
2079 {not in Vi}
2080 Determines the order in which ":cstag" performs a search. See
2081 |cscopetagorder|.
2082 NOTE: This option is set to 0 when 'compatible' is set.
2083
2084 *'cscopeverbose'* *'csverb'*
2085 *'nocscopeverbose'* *'nocsverb'*
2086'cscopeverbose' 'csverb' boolean (default off)
2087 global
2088 {not available when compiled without the |+cscope|
2089 feature}
2090 {not in Vi}
2091 Give messages when adding a cscope database. See |cscopeverbose|.
2092 NOTE: This option is reset when 'compatible' is set.
2093
2094 *'debug'*
2095'debug' string (default "")
2096 global
2097 {not in Vi}
2098 When set to "msg", error messages that would otherwise be omitted will
2099 be given anyway. This is useful when debugging 'foldexpr' or
2100 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002101 When set to "beep", a message will be given when otherwise only a beep
2102 would be produced.
2103 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104
2105 *'define'* *'def'*
2106'define' 'def' string (default "^\s*#\s*define")
2107 global or local to buffer |global-local|
2108 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002109 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 pattern, just like for the "/" command. This option is used for the
2111 commands like "[i" and "[d" |include-search|. The 'isident' option is
2112 used to recognize the defined name after the match:
2113 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2114 See |option-backslash| about inserting backslashes to include a space
2115 or backslash.
2116 The default value is for C programs. For C++ this value would be
2117 useful, to include const type declarations: >
2118 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2119< When using the ":set" command, you need to double the backslashes!
2120
2121 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2122'delcombine' 'deco' boolean (default off)
2123 global
2124 {not in Vi}
2125 {only available when compiled with the |+multi_byte|
2126 feature}
2127 If editing Unicode and this option is set, backspace and Normal mode
2128 "x" delete each combining character on its own. When it is off (the
2129 default) the character along with its combining characters are
2130 deleted.
2131 Note: When 'delcombine' is set "xx" may work different from "2x"!
2132
2133 This is useful for Arabic, Hebrew and many other languages where one
2134 may have combining characters overtop of base characters, and want
2135 to remove only the combining ones.
2136
2137 *'dictionary'* *'dict'*
2138'dictionary' 'dict' string (default "")
2139 global or local to buffer |global-local|
2140 {not in Vi}
2141 List of file names, separated by commas, that are used to lookup words
2142 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2143 contain a list of words. This can be one word per line, or several
2144 words per line, separated by non-keyword characters (white space is
2145 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002146 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 after a comma are ignored, otherwise spaces are included in the file
2148 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002149 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 Where to find a list of words?
2151 - On FreeBSD, there is the file "/usr/share/dict/words".
2152 - In the Simtel archive, look in the "msdos/linguist" directory.
2153 - In "miscfiles" of the GNU collection.
2154 The use of |:set+=| and |:set-=| is preferred when adding or removing
2155 directories from the list. This avoids problems when a future version
2156 uses another default.
2157 Backticks cannot be used in this option for security reasons.
2158
2159 *'diff'* *'nodiff'*
2160'diff' boolean (default off)
2161 local to window
2162 {not in Vi}
2163 {not available when compiled without the |+diff|
2164 feature}
2165 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002166 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167
2168 *'dex'* *'diffexpr'*
2169'diffexpr' 'dex' string (default "")
2170 global
2171 {not in Vi}
2172 {not available when compiled without the |+diff|
2173 feature}
2174 Expression which is evaluated to obtain an ed-style diff file from two
2175 versions of a file. See |diff-diffexpr|.
2176 This option cannot be set from a |modeline| or in the |sandbox|, for
2177 security reasons.
2178
2179 *'dip'* *'diffopt'*
2180'diffopt' 'dip' string (default "filler")
2181 global
2182 {not in Vi}
2183 {not available when compiled without the |+diff|
2184 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002185 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002186 All are optional. Items must be separated by a comma.
2187
2188 filler Show filler lines, to keep the text
2189 synchronized with a window that has inserted
2190 lines at the same position. Mostly useful
2191 when windows are side-by-side and 'scrollbind'
2192 is set.
2193
2194 context:{n} Use a context of {n} lines between a change
2195 and a fold that contains unchanged lines.
2196 When omitted a context of six lines is used.
2197 See |fold-diff|.
2198
2199 icase Ignore changes in case of text. "a" and "A"
2200 are considered the same. Adds the "-i" flag
2201 to the "diff" command if 'diffexpr' is empty.
2202
2203 iwhite Ignore changes in amount of white space. Adds
2204 the "-b" flag to the "diff" command if
2205 'diffexpr' is empty. Check the documentation
2206 of the "diff" command for what this does
2207 exactly. It should ignore adding trailing
2208 white space, but not leading white space.
2209
2210 Examples: >
2211
2212 :set diffopt=filler,context:4
2213 :set diffopt=
2214 :set diffopt=filler
2215<
2216 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2217'digraph' 'dg' boolean (default off)
2218 global
2219 {not in Vi}
2220 {not available when compiled without the |+digraphs|
2221 feature}
2222 Enable the entering of digraphs in Insert mode with {char1} <BS>
2223 {char2}. See |digraphs|.
2224 NOTE: This option is reset when 'compatible' is set.
2225
2226 *'directory'* *'dir'*
2227'directory' 'dir' string (default for Amiga: ".,t:",
2228 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2229 for Unix: ".,~/tmp,/var/tmp,/tmp")
2230 global
2231 List of directory names for the swap file, separated with commas.
2232 - The swap file will be created in the first directory where this is
2233 possible.
2234 - Empty means that no swap file will be used (recovery is
2235 impossible!).
2236 - A directory "." means to put the swap file in the same directory as
2237 the edited file. On Unix, a dot is prepended to the file name, so
2238 it doesn't show in a directory listing. On MS-Windows the "hidden"
2239 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002240 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241 put the swap file relative to where the edited file is. The leading
2242 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002243 - For Unix and Win32, if a directory ends in two path separators "//"
2244 or "\\", the swap file name will be built from the complete path to
2245 the file with all path separators substituted to percent '%' signs.
2246 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 - Spaces after the comma are ignored, other spaces are considered part
2248 of the directory name. To have a space at the start of a directory
2249 name, precede it with a backslash.
2250 - To include a comma in a directory name precede it with a backslash.
2251 - A directory name may end in an ':' or '/'.
2252 - Environment variables are expanded |:set_env|.
2253 - Careful with '\' characters, type one before a space, type two to
2254 get one in the option (see |option-backslash|), for example: >
2255 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2256< - For backwards compatibility with Vim version 3.0 a '>' at the start
2257 of the option is removed.
2258 Using "." first in the list is recommended. This means that editing
2259 the same file twice will result in a warning. Using "/tmp" on Unix is
2260 discouraged: When the system crashes you lose the swap file.
2261 "/var/tmp" is often not cleared when rebooting, thus is a better
2262 choice than "/tmp". But it can contain a lot of files, your swap
2263 files get lost in the crowd. That is why a "tmp" directory in your
2264 home directory is tried first.
2265 The use of |:set+=| and |:set-=| is preferred when adding or removing
2266 directories from the list. This avoids problems when a future version
2267 uses another default.
2268 This option cannot be set from a |modeline| or in the |sandbox|, for
2269 security reasons.
2270 {Vi: directory to put temp file in, defaults to "/tmp"}
2271
2272 *'display'* *'dy'*
2273'display' 'dy' string (default "")
2274 global
2275 {not in Vi}
2276 Change the way text is displayed. This is comma separated list of
2277 flags:
2278 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002279 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 last line that doesn't fit is replaced with "@" lines.
2281 uhex Show unprintable characters hexadecimal as <xx>
2282 instead of using ^C and ~C.
2283
2284 *'eadirection'* *'ead'*
2285'eadirection' 'ead' string (default "both")
2286 global
2287 {not in Vi}
2288 {not available when compiled without the +vertsplit
2289 feature}
2290 Tells when the 'equalalways' option applies:
2291 ver vertically, width of windows is not affected
2292 hor horizontally, height of windows is not affected
2293 both width and height of windows is affected
2294
2295 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2296'edcompatible' 'ed' boolean (default off)
2297 global
2298 Makes the 'g' and 'c' flags of the ":substitute" command to be
2299 toggled each time the flag is given. See |complex-change|. See
2300 also 'gdefault' option.
2301 Switching this option on is discouraged!
2302
2303 *'encoding'* *'enc'* *E543*
2304'encoding' 'enc' string (default: "latin1" or value from $LANG)
2305 global
2306 {only available when compiled with the |+multi_byte|
2307 feature}
2308 {not in Vi}
2309 Sets the character encoding used inside Vim. It applies to text in
2310 the buffers, registers, Strings in expressions, text stored in the
2311 viminfo file, etc. It sets the kind of characters which Vim can work
2312 with. See |encoding-names| for the possible values.
2313
2314 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002315 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 It should normally be kept at its default value, or set when Vim
2317 starts up. See |multibyte|.
2318
2319 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2320 "utf-8". Although care has been taken to allow different values of
2321 'encoding', "utf-8" is the natural choice for the environment and
2322 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 versions, and to avoid changing the encoding of newly created files
2325 without your knowledge (in case 'fileencodings' is empty).
2326
2327 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 iconv() or as specified with 'charconvert'.
2330
2331 Normally 'encoding' will be equal to your current locale. This will
2332 be the default if Vim recognizes your environment settings. If
2333 'encoding' is not set to the current locale, 'termencoding' must be
2334 set to convert typed and displayed text. See |encoding-table|.
2335
2336 When you set this option, it fires the |EncodingChanged| autocommand
2337 event so that you can set up fonts if necessary.
2338
2339 When the option is set, the value is converted to lowercase. Thus
2340 you can set it with uppercase values too. Underscores are translated
2341 to '-' signs.
2342 When the encoding is recognized, it is changed to the standard name.
2343 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2344 "iso-8859-2" and "utf8" becomes "utf-8".
2345
2346 Note: "latin1" is also used when the encoding could not be detected.
2347 This only works when editing files in the same encoding! When the
2348 actual character set is not latin1, make sure 'fileencoding' and
2349 'fileencodings' are empty. When conversion is needed, switch to using
2350 utf-8.
2351
2352 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2353 You don't notice this while editing, but it does matter for the
2354 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2355 setting 'encoding' to one of these values instead of utf-8 only has
2356 effect for encoding used for files when 'fileencoding' is empty.
2357
Bram Moolenaar661b1822005-07-28 22:36:45 +00002358 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2359 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360
2361 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2362'endofline' 'eol' boolean (default on)
2363 local to buffer
2364 {not in Vi}
2365 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002366 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 option is automatically set when starting to edit a new file, unless
2368 the file does not have an <EOL> for the last line in the file, in
2369 which case it is reset. Normally you don't have to set or reset this
2370 option. When 'binary' is off the value is not used when writing the
2371 file. When 'binary' is on it is used to remember the presence of a
2372 <EOL> for the last line in the file, so that when you write the file
2373 the situation from the original file can be kept. But you can change
2374 it if you want to.
2375
2376 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2377'equalalways' 'ea' boolean (default on)
2378 global
2379 {not in Vi}
2380 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002381 splitting or closing a window. This also happens the moment the
2382 option is switched on. When off, splitting a window will reduce the
2383 size of the current window and leave the other windows the same. When
2384 closing a window the extra lines are given to the window next to it
2385 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 When mixing vertically and horizontally split windows, a minimal size
2387 is computed and some windows may be larger if there is room. The
2388 'eadirection' option tells in which direction the size is affected.
2389 Changing the height of a window can be avoided by setting
2390 'winfixheight'.
2391
2392 *'equalprg'* *'ep'*
2393'equalprg' 'ep' string (default "")
2394 global or local to buffer |global-local|
2395 {not in Vi}
2396 External program to use for "=" command. When this option is empty
2397 the internal formatting functions are used ('lisp', 'cindent' or
2398 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002399 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 about including spaces and backslashes.
2401 This option cannot be set from a |modeline| or in the |sandbox|, for
2402 security reasons.
2403
2404 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2405'errorbells' 'eb' boolean (default off)
2406 global
2407 Ring the bell (beep or screen flash) for error messages. This only
2408 makes a difference for error messages, the bell will be used always
2409 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 screen flash or do nothing.
2412
2413 *'errorfile'* *'ef'*
2414'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2415 others: "errors.err")
2416 global
2417 {not in Vi}
2418 {not available when compiled without the |+quickfix|
2419 feature}
2420 Name of the errorfile for the QuickFix mode (see |:cf|).
2421 When the "-q" command-line argument is used, 'errorfile' is set to the
2422 following argument. See |-q|.
2423 NOT used for the ":make" command. See 'makeef' for that.
2424 Environment variables are expanded |:set_env|.
2425 See |option-backslash| about including spaces and backslashes.
2426 This option cannot be set from a |modeline| or in the |sandbox|, for
2427 security reasons.
2428
2429 *'errorformat'* *'efm'*
2430'errorformat' 'efm' string (default is very long)
2431 global or local to buffer |global-local|
2432 {not in Vi}
2433 {not available when compiled without the |+quickfix|
2434 feature}
2435 Scanf-like description of the format for the lines in the error file
2436 (see |errorformat|).
2437
2438 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2439'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2440 global
2441 {not in Vi}
2442 Function keys that start with an <Esc> are recognized in Insert
2443 mode. When this option is off, the cursor and function keys cannot be
2444 used in Insert mode if they start with an <Esc>. The advantage of
2445 this is that the single <Esc> is recognized immediately, instead of
2446 after one second. Instead of resetting this option, you might want to
2447 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2448 when 'esckeys' is off, you can still map anything, but the cursor keys
2449 won't work by default.
2450 NOTE: This option is set to the Vi default value when 'compatible' is
2451 set and to the Vim default value when 'compatible' is reset.
2452
2453 *'eventignore'* *'ei'*
2454'eventignore' 'ei' string (default "")
2455 global
2456 {not in Vi}
2457 {not available when compiled without the |+autocmd|
2458 feature}
2459 A list of autocommand event names, which are to be ignored.
2460 When set to "all", all autocommand events are ignored, autocommands
2461 will not be executed.
2462 Otherwise this is a comma separated list of event names. Example: >
2463 :set ei=WinEnter,WinLeave
2464<
2465 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2466'expandtab' 'et' boolean (default off)
2467 local to buffer
2468 {not in Vi}
2469 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002470 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2472 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2473 NOTE: This option is reset when 'compatible' is set.
2474
2475 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2476'exrc' 'ex' boolean (default off)
2477 global
2478 {not in Vi}
2479 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2480 directory. If you switch this option on you should also consider
2481 setting the 'secure' option (see |initialization|). Using a local
2482 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2483 also see |.vimrc| and |gui-init|.
2484 This option cannot be set from a |modeline| or in the |sandbox|, for
2485 security reasons.
2486
2487 *'fileencoding'* *'fenc'* *E213*
2488'fileencoding' 'fenc' string (default: "")
2489 local to buffer
2490 {only available when compiled with the |+multi_byte|
2491 feature}
2492 {not in Vi}
2493 Sets the character encoding for the file of this buffer.
2494 When 'fileencoding' is different from 'encoding', conversion will be
2495 done when reading and writing the file.
2496 When 'fileencoding' is empty, the same value as 'encoding' will be
2497 used (no conversion when reading or writing a file).
2498 WARNING: Conversion can cause loss of information! When
2499 'encoding' is "utf-8" conversion is most likely done in a way
2500 that the reverse conversion results in the same text. When
2501 'encoding' is not "utf-8" some characters may be lost!
2502 See 'encoding' for the possible values. Additionally, values may be
2503 specified that can be handled by the converter, see
2504 |mbyte-conversion|.
2505 When reading a file 'fileencoding' will be set from 'fileencodings'.
2506 To read a file in a certain encoding it won't work by setting
2507 'fileencoding', use the |++enc| argument.
2508 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2509 When the option is set, the value is converted to lowercase. Thus
2510 you can set it with uppercase values too. '_' characters are
2511 replaced with '-'. If a name is recognized from the list for
2512 'encoding', it is replaced by the standard name. For example
2513 "ISO8859-2" becomes "iso-8859-2".
2514 When this option is set, after starting to edit a file, the 'modified'
2515 option is set, because the file would be different when written.
2516 If you do this in a modeline, you might want to set 'nomodified' to
2517 avoid this.
2518 This option can not be changed when 'modifiable' is off.
2519
2520 *'fe'*
2521 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002522 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523 old short name was 'fe', which is no longer used.
2524
2525 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002526'fileencodings' 'fencs' string (default: "ucs-bom",
2527 "ucs-bom,utf-8,default,latin1" when
2528 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 global
2530 {only available when compiled with the |+multi_byte|
2531 feature}
2532 {not in Vi}
2533 This is a list of character encodings considered when starting to edit
2534 an existing file. When a file is read, Vim tries to use the first
2535 mentioned character encoding. If an error is detected, the next one
2536 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002537 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 an empty string, which means the value of 'encoding' is used.
2539 WARNING: Conversion can cause loss of information! When
2540 'encoding' is "utf-8" (or one of the other Unicode variants)
2541 conversion is most likely done in a way that the reverse
2542 conversion results in the same text. When 'encoding' is not
2543 "utf-8" special characters may be lost!
2544 For an empty file or a file with only ASCII characters most encodings
2545 will work and the first entry of 'fileencodings' will be used (except
2546 "ucs-bom", which requires the BOM to be present). If you prefer
2547 another encoding use an BufReadPost autocommand event to test if your
2548 preferred encoding is to be used. Example: >
2549 au BufReadPost * if search('\S', 'w') == 0 |
2550 \ set fenc=iso-2022-jp | endif
2551< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2552 non-blank characters.
2553 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2554 is always empty then. This means that a non-existing file may get a
2555 different encoding than an empty file.
2556 The special value "ucs-bom" can be used to check for a Unicode BOM
2557 (Byte Order Mark) at the start of the file. It must not be preceded
2558 by "utf-8" or another Unicode encoding for this to work properly.
2559 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2560 because Vim cannot detect an error, thus the encoding is always
2561 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002562 The special value "default" can be used for the encoding from the
2563 environment. This is the default value for 'encoding'. It is useful
2564 when 'encoding' is set to "utf-8" and your environment uses a
2565 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 WRONG VALUES: WHAT'S WRONG:
2567 latin1,utf-8 "latin1" will always be used
2568 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2569 file
2570 cp1250,latin1 "cp1250" will always be used
2571 If 'fileencodings' is empty, 'fileencoding' is not modified.
2572 See 'fileencoding' for the possible values.
2573 Setting this option does not have an effect until the next time a file
2574 is read.
2575
2576 *'fileformat'* *'ff'*
2577'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2578 Unix default: "unix",
2579 Macintosh default: "mac")
2580 local to buffer
2581 {not in Vi}
2582 This gives the <EOL> of the current buffer, which is used for
2583 reading/writing the buffer from/to a file:
2584 dos <CR> <NL>
2585 unix <NL>
2586 mac <CR>
2587 When "dos" is used, CTRL-Z at the end of a file is ignored.
2588 See |file-formats| and |file-read|.
2589 For the character encoding of the file see 'fileencoding'.
2590 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2591 works like it was set to "unix'.
2592 This option is set automatically when starting to edit a file and
2593 'fileformats' is not empty and 'binary' is off.
2594 When this option is set, after starting to edit a file, the 'modified'
2595 option is set, because the file would be different when written.
2596 This option can not be changed when 'modifiable' is off.
2597 For backwards compatibility: When this option is set to "dos",
2598 'textmode' is set, otherwise 'textmode' is reset.
2599
2600 *'fileformats'* *'ffs'*
2601'fileformats' 'ffs' string (default:
2602 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2603 Vim Unix: "unix,dos",
2604 Vim Mac: "mac,unix,dos",
2605 Vi Cygwin: "unix,dos",
2606 Vi others: "")
2607 global
2608 {not in Vi}
2609 This gives the end-of-line (<EOL>) formats that will be tried when
2610 starting to edit a new buffer and when reading a file into an existing
2611 buffer:
2612 - When empty, the format defined with 'fileformat' will be used
2613 always. It is not set automatically.
2614 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002615 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 'fileformats' name will be used when a file is read into an existing
2617 buffer, no matter what 'fileformat' for that buffer is set to.
2618 - When more than one name is present, separated by commas, automatic
2619 <EOL> detection will be done when reading a file. When starting to
2620 edit a file, a check is done for the <EOL>:
2621 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2622 'fileformat' is set to "dos".
2623 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 preceding <CR>, "unix" is preferred over "dos".
2626 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2627 This means that "mac" is only chosen when "unix" is not present,
2628 or when no <NL> is found in the file, and when "dos" is not
2629 present, or no <CR><NL> is present in the file.
2630 Also if "unix" was first chosen, but the first <CR> is before
2631 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2632 the file, then 'fileformat' is set to "mac".
2633 4. If 'fileformat' is still not set, the first name from
2634 'fileformats' is used.
2635 When reading a file into an existing buffer, the same is done, but
2636 this happens like 'fileformat' has been set appropriately for that
2637 file only, the option is not changed.
2638 When 'binary' is set, the value of 'fileformats' is not used.
2639
2640 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2641 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2642 done:
2643 - When 'fileformats' is empty, there is no automatic detection. Dos
2644 format will be used.
2645 - When 'fileformats' is set to one or more names, automatic detection
2646 is done. This is based on the first <NL> in the file: If there is a
2647 <CR> in front of it, Dos format is used, otherwise Unix format is
2648 used.
2649 Also see |file-formats|.
2650 For backwards compatibility: When this option is set to an empty
2651 string or one format (no comma is included), 'textauto' is reset,
2652 otherwise 'textauto' is set.
2653 NOTE: This option is set to the Vi default value when 'compatible' is
2654 set and to the Vim default value when 'compatible' is reset.
2655
2656 *'filetype'* *'ft'*
2657'filetype' 'ft' string (default: "")
2658 local to buffer
2659 {not in Vi}
2660 {not available when compiled without the |+autocmd|
2661 feature}
2662 When this option is set, the FileType autocommand event is triggered.
2663 All autocommands that match with the value of this option will be
2664 executed. Thus the value of 'filetype' is used in place of the file
2665 name.
2666 Otherwise this option does not always reflect the current file type.
2667 This option is normally set when the file type is detected. To enable
2668 this use the ":filetype on" command. |:filetype|
2669 Setting this option to a different value is most useful in a modeline,
2670 for a file for which the file type is not automatically recognized.
2671 Example, for in an IDL file: >
2672 /* vim: set filetype=idl : */
2673< |FileType| |filetypes|
2674 Do not confuse this option with 'osfiletype', which is for the file
2675 type that is actually stored with the file.
2676 This option is not copied to another buffer, independent of the 's' or
2677 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002678 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679
2680 *'fillchars'* *'fcs'*
2681'fillchars' 'fcs' string (default "vert:|,fold:-")
2682 global
2683 {not in Vi}
2684 {not available when compiled without the |+windows|
2685 and |+folding| features}
2686 Characters to fill the statuslines and vertical separators.
2687 It is a comma separated list of items:
2688
2689 item default Used for ~
2690 stl:c ' ' or '^' statusline of the current window
2691 stlnc:c ' ' or '-' statusline of the non-current windows
2692 vert:c '|' vertical separators |:vsplit|
2693 fold:c '-' filling 'foldtext'
2694 diff:c '-' deleted lines of the 'diff' option
2695
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002696 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 "stlnc" the space will be used when there is highlighting, '^' or '-'
2698 otherwise.
2699
2700 Example: >
2701 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2702< This is similar to the default, except that these characters will also
2703 be used when there is highlighting.
2704
2705 The highlighting used for these items:
2706 item highlight group ~
2707 stl:c StatusLine |hl-StatusLine|
2708 stlnc:c StatusLineNC |hl-StatusLineNC|
2709 vert:c VertSplit |hl-VertSplit|
2710 fold:c Folded |hl-Folded|
2711 diff:c DiffDelete |hl-DiffDelete|
2712
2713 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2714'fkmap' 'fk' boolean (default off) *E198*
2715 global
2716 {not in Vi}
2717 {only available when compiled with the |+rightleft|
2718 feature}
2719 When on, the keyboard is mapped for the Farsi character set.
2720 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002721 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722
2723 *'foldclose'* *'fcl'*
2724'foldclose' 'fcl' string (default "")
2725 global
2726 {not in Vi}
2727 {not available when compiled without the |+folding|
2728 feature}
2729 When set to "all", a fold is closed when the cursor isn't in it and
2730 its level is higher than 'foldlevel'. Useful if you want folds to
2731 automatically close when moving out of them.
2732
2733 *'foldcolumn'* *'fdc'*
2734'foldcolumn' 'fdc' number (default 0)
2735 local to window
2736 {not in Vi}
2737 {not available when compiled without the |+folding|
2738 feature}
2739 When non-zero, a column with the specified width is shown at the side
2740 of the window which indicates open and closed folds. The maximum
2741 value is 12.
2742 See |folding|.
2743
2744 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2745'foldenable' 'fen' boolean (default on)
2746 local to window
2747 {not in Vi}
2748 {not available when compiled without the |+folding|
2749 feature}
2750 When off, all folds are open. This option can be used to quickly
2751 switch between showing all text unfolded and viewing the text with
2752 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002753 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 'foldenable' is off.
2755 This option is set by commands that create a new fold or close a fold.
2756 See |folding|.
2757
2758 *'foldexpr'* *'fde'*
2759'foldexpr' 'fde' string (default: "0")
2760 local to window
2761 {not in Vi}
2762 {not available when compiled without the |+folding|
2763 or |+eval| feature}
2764 The expression used for when 'foldmethod' is "expr". It is evaluated
2765 for each line to obtain its fold level. See |fold-expr|. Also see
2766 |eval-sandbox|.
2767
2768 *'foldignore'* *'fdi'*
2769'foldignore' 'fdi' string (default: "#")
2770 local to window
2771 {not in Vi}
2772 {not available when compiled without the |+folding|
2773 feature}
2774 Used only when 'foldmethod' is "indent". Lines starting with
2775 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002776 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 The default "#" works well for C programs. See |fold-indent|.
2778
2779 *'foldlevel'* *'fdl'*
2780'foldlevel' 'fdl' number (default: 0)
2781 local to window
2782 {not in Vi}
2783 {not available when compiled without the |+folding|
2784 feature}
2785 Sets the fold level: Folds with a higher level will be closed.
2786 Setting this option to zero will close all folds. Higher numbers will
2787 close fewer folds.
2788 This option is set by commands like |zm|, |zM| and |zR|.
2789 See |fold-foldlevel|.
2790
2791 *'foldlevelstart'* *'fdls'*
2792'foldlevelstart' 'fdls' number (default: -1)
2793 global
2794 {not in Vi}
2795 {not available when compiled without the |+folding|
2796 feature}
2797 Sets 'foldlevel' when starting to edit another buffer in a window.
2798 Useful to always start editing with all folds closed (value zero),
2799 some folds closed (one) or no folds closed (99).
2800 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 ignores this option and closes all folds.
2803 It is also done before BufReadPre autocommands, to allow an autocmd to
2804 overrule the 'foldlevel' value for specific files.
2805 When the value is negative, it is not used.
2806
2807 *'foldmarker'* *'fmr'* *E536*
2808'foldmarker' 'fmr' string (default: "{{{,}}}")
2809 local to window
2810 {not in Vi}
2811 {not available when compiled without the |+folding|
2812 feature}
2813 The start and end marker used when 'foldmethod' is "marker". There
2814 must be one comma, which separates the start and end marker. The
2815 marker is a literal string (a regular expression would be too slow).
2816 See |fold-marker|.
2817
2818 *'foldmethod'* *'fdm'*
2819'foldmethod' 'fdm' string (default: "manual")
2820 local to window
2821 {not in Vi}
2822 {not available when compiled without the |+folding|
2823 feature}
2824 The kind of folding used for the current window. Possible values:
2825 |fold-manual| manual Folds are created manually.
2826 |fold-indent| indent Lines with equal indent form a fold.
2827 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2828 |fold-marker| marker Markers are used to specify folds.
2829 |fold-syntax| syntax Syntax highlighting items specify folds.
2830 |fold-diff| diff Fold text that is not changed.
2831
2832 *'foldminlines'* *'fml'*
2833'foldminlines' 'fml' number (default: 1)
2834 local to window
2835 {not in Vi}
2836 {not available when compiled without the |+folding|
2837 feature}
2838 Sets the minimum number of screen lines for a fold to be displayed
2839 closed. Also for manually closed folds.
2840 Note that this only has an effect of what is displayed. After using
2841 "zc" to close a fold, which is displayed open because it's smaller
2842 than 'foldminlines', a following "zc" may close a containing fold.
2843
2844 *'foldnestmax'* *'fdn'*
2845'foldnestmax' 'fdn' number (default: 20)
2846 local to window
2847 {not in Vi}
2848 {not available when compiled without the |+folding|
2849 feature}
2850 Sets the maximum nesting of folds for the "indent" and "syntax"
2851 methods. This avoids that too many folds will be created. Using more
2852 than 20 doesn't work, because the internal limit is 20.
2853
2854 *'foldopen'* *'fdo'*
2855'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2856 search,tag,undo")
2857 global
2858 {not in Vi}
2859 {not available when compiled without the |+folding|
2860 feature}
2861 Specifies for which type of commands folds will be opened, if the
2862 command moves the cursor into a closed fold. It is a comma separated
2863 list of items.
2864 item commands ~
2865 all any
2866 block "(", "{", "[[", "[{", etc.
2867 hor horizontal movements: "l", "w", "fx", etc.
2868 insert any command in Insert mode
2869 jump far jumps: "G", "gg", etc.
2870 mark jumping to a mark: "'m", CTRL-O, etc.
2871 percent "%"
2872 quickfix ":cn", ":crew", ":make", etc.
2873 search search for a pattern: "/", "n", "*", "gd", etc.
2874 (not for a search pattern in a ":" command)
2875 tag jumping to a tag: ":ta", CTRL-T, etc.
2876 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002877 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 the |zv| command to the mapping to get the same effect.
2879 When a movement command is used for an operator (e.g., "dl" or "y%")
2880 this option is not used. This means the operator will include the
2881 whole closed fold.
2882 Note that vertical movements are not here, because it would make it
2883 very difficult to move onto a closed fold.
2884 In insert mode the folds containing the cursor will always be open
2885 when text is inserted.
2886 To close folds you can re-apply 'foldlevel' with the |zx| command or
2887 set the 'foldclose' option to "all".
2888
2889 *'foldtext'* *'fdt'*
2890'foldtext' 'fdt' string (default: "foldtext()")
2891 local to window
2892 {not in Vi}
2893 {not available when compiled without the |+folding|
2894 feature}
2895 An expression which is used to specify the text displayed for a closed
2896 fold. See |fold-foldtext|.
2897
2898 *'formatoptions'* *'fo'*
2899'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2900 local to buffer
2901 {not in Vi}
2902 This is a sequence of letters which describes how automatic
2903 formatting is to be done. See |fo-table|. When the 'paste' option is
2904 on, no formatting is done (like 'formatoptions' is empty). Commas can
2905 be inserted for readability.
2906 To avoid problems with flags that are added in the future, use the
2907 "+=" and "-=" feature of ":set" |add-option-flags|.
2908 NOTE: This option is set to the Vi default value when 'compatible' is
2909 set and to the Vim default value when 'compatible' is reset.
2910
Bram Moolenaar86b68352004-12-27 21:59:20 +00002911 *'formatlistpat'* *'flp'*
2912'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2913 local to buffer
2914 {not in Vi}
2915 A pattern that is used to recognize a list header. This is used for
2916 the "n" flag in 'formatoptions'.
2917 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002918 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002919 while still checking more characters. There must be a character
2920 following the pattern, when it matches the whole line it is handled
2921 like there is no match.
2922 The default recognizes a number, followed by an optional punctuation
2923 character and white space.
2924
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 *'formatprg'* *'fp'*
2926'formatprg' 'fp' string (default "")
2927 global
2928 {not in Vi}
2929 The name of an external program that will be used to format the lines
2930 selected with the "gq" command. The program must take the input on
2931 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002932 such a program.
2933 If this option is an empty string, the internal format function will
2934 be used |C-indenting|.
2935 Environment variables are expanded |:set_env|. See |option-backslash|
2936 about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 This option cannot be set from a |modeline| or in the |sandbox|, for
2938 security reasons.
2939
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002940 *'fsync'* *'fs'*
2941'fsync' 'fs' boolean (default on)
2942 global
2943 {not in Vi}
2944 When on, the library function fsync() will be called after writing a
2945 file. This will flush a file to disk, ensuring that it is safely
2946 written even on filesystems which do metadata-only journaling. This
2947 will force the harddrive to spin up on Linux systems running in laptop
2948 mode, so it may be undesirable in some situations. Be warned that
2949 turning this off increases the chances of data loss after a crash. On
2950 systems without an fsync() implementation, this variable is always
2951 off.
2952 Also see 'swapsync' for controlling fsync() on swap files.
2953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2955'gdefault' 'gd' boolean (default off)
2956 global
2957 {not in Vi}
2958 When on, the ":substitute" flag 'g' is default on. This means that
2959 all matches in a line are substituted instead of one. When a 'g' flag
2960 is given to a ":substitute" command, this will toggle the substitution
2961 of all or one match. See |complex-change|.
2962
2963 command 'gdefault' on 'gdefault' off ~
2964 :s/// subst. all subst. one
2965 :s///g subst. one subst. all
2966 :s///gg subst. all subst. one
2967
2968 NOTE: This option is reset when 'compatible' is set.
2969
2970 *'grepformat'* *'gfm'*
2971'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2972 global
2973 {not in Vi}
2974 Format to recognize for the ":grep" command output.
2975 This is a scanf-like string that uses the same format as the
2976 'errorformat' option: see |errorformat|.
2977
2978 *'grepprg'* *'gp'*
2979'grepprg' 'gp' string (default "grep -n ",
2980 Unix: "grep -n $* /dev/null",
2981 Win32: "findstr /n" or "grep -n",
2982 VMS: "SEARCH/NUMBERS ")
2983 global or local to buffer |global-local|
2984 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002985 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 and '#' characters, which are expanded like when used in a command-
2987 line. The placeholder "$*" is allowed to specify where the arguments
2988 will be included. Environment variables are expanded |:set_env|. See
2989 |option-backslash| about including spaces and backslashes.
2990 When your "grep" accepts the "-H" argument, use this to make ":grep"
2991 also work well with a single file: >
2992 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002993< Special value: When 'grepprg' is set to "internal" the |:grep| command
2994 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002995 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002996 apply equally to 'grepprg'.
2997 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2998 otherwise it's "grep -n".
2999 This option cannot be set from a |modeline| or in the |sandbox|, for
3000 security reasons.
3001
3002 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3003'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3004 ve:ver35-Cursor,
3005 o:hor50-Cursor,
3006 i-ci:ver25-Cursor/lCursor,
3007 r-cr:hor20-Cursor/lCursor,
3008 sm:block-Cursor
3009 -blinkwait175-blinkoff150-blinkon175",
3010 for MS-DOS and Win32 console:
3011 "n-v-c:block,o:hor50,i-ci:hor15,
3012 r-cr:hor30,sm:block")
3013 global
3014 {not in Vi}
3015 {only available when compiled with GUI enabled, and
3016 for MS-DOS and Win32 console}
3017 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 the height of the cursor can be changed. This can be done by
3020 specifying a block cursor, or a percentage for a vertical or
3021 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003022 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003024 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 mode-list and an argument-list:
3026 mode-list:argument-list,mode-list:argument-list,..
3027 The mode-list is a dash separated list of these modes:
3028 n Normal mode
3029 v Visual mode
3030 ve Visual mode with 'selection' "exclusive" (same as 'v',
3031 if not specified)
3032 o Operator-pending mode
3033 i Insert mode
3034 r Replace mode
3035 c Command-line Normal (append) mode
3036 ci Command-line Insert mode
3037 cr Command-line Replace mode
3038 sm showmatch in Insert mode
3039 a all modes
3040 The argument-list is a dash separated list of these arguments:
3041 hor{N} horizontal bar, {N} percent of the character height
3042 ver{N} vertical bar, {N} percent of the character width
3043 block block cursor, fills the whole character
3044 [only one of the above three should be present]
3045 blinkwait{N} *cursor-blinking*
3046 blinkon{N}
3047 blinkoff{N}
3048 blink times for cursor: blinkwait is the delay before
3049 the cursor starts blinking, blinkon is the time that
3050 the cursor is shown and blinkoff is the time that the
3051 cursor is not shown. The times are in msec. When one
3052 of the numbers is zero, there is no blinking. The
3053 default is: "blinkwait700-blinkon400-blinkoff250".
3054 These numbers are used for a missing entry. This
3055 means that blinking is enabled by default. To switch
3056 blinking off you can use "blinkon0". The cursor only
3057 blinks when Vim is waiting for input, not while
3058 executing a command.
3059 To make the cursor blink in an xterm, see
3060 |xterm-blink|.
3061 {group-name}
3062 a highlight group name, that sets the color and font
3063 for the cursor
3064 {group-name}/{group-name}
3065 Two highlight group names, the first is used when
3066 no language mappings are used, the other when they
3067 are. |language-mapping|
3068
3069 Examples of parts:
3070 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3071 block cursor with colors from the "nCursor"
3072 highlight group
3073 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3074 In Insert and Command-line Insert mode, use a
3075 30% vertical bar cursor with colors from the
3076 "iCursor" highlight group. Blink a bit
3077 faster.
3078
3079 The 'a' mode is different. It will set the given argument-list for
3080 all modes. It does not reset anything to defaults. This can be used
3081 to do a common setting for all modes. For example, to switch off
3082 blinking: "a:blinkon0"
3083
3084 Examples of cursor highlighting: >
3085 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3086 :highlight Cursor gui=NONE guifg=bg guibg=fg
3087<
3088 *'guifont'* *'gfn'*
3089 *E235* *E596* *E610* *E611*
3090'guifont' 'gfn' string (default "")
3091 global
3092 {not in Vi}
3093 {only available when compiled with GUI enabled}
3094 This is a list of fonts which will be used for the GUI version of Vim.
3095 In its simplest form the value is just one font name. When
3096 the font cannot be found you will get an error message. To try other
3097 font names a list can be specified, font names separated with commas.
3098 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003099
Bram Moolenaar05159a02005-02-26 23:04:13 +00003100 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3101 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003102
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 Spaces after a comma are ignored. To include a comma in a font name
3104 precede it with a backslash. Setting an option requires an extra
3105 backslash before a space and a backslash. See also
3106 |option-backslash|. For example: >
3107 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003108< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003110
3111 If none of the fonts can be loaded, Vim will keep the current setting.
3112 If an empty font list is given, Vim will try using other resource
3113 settings (for X, it will use the Vim.font resource), and finally it
3114 will try some builtin default which should always be there ("7x13" in
3115 the case of X). The font names given should be "normal" fonts. Vim
3116 will try to find the related bold and italic fonts.
3117
Bram Moolenaar05159a02005-02-26 23:04:13 +00003118 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003119 :set guifont=*
3120< will bring up a font requester, where you can pick the font you want.
3121
3122 The font name depends on the GUI used. See |setting-guifont| for a
3123 way to set 'guifont' for various systems.
3124
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 For the GTK+ 2 GUI the font name looks like this: >
3126 :set guifont=Andale\ Mono\ 11
3127< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003128
3129 For Mac OSX you can use something like this: >
3130 :set guifont=Monaco:h10
3131< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003133 width). An exception is GTK 2: all fonts are accepted, but
3134 mono-spaced fonts look best.
3135
Bram Moolenaar071d4272004-06-13 20:20:40 +00003136 To preview a font on X11, you might be able to use the "xfontsel"
3137 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003138
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 For the Win32 GUI *E244* *E245*
3140 - takes these options in the font name:
3141 hXX - height is XX (points, can be floating-point)
3142 wXX - width is XX (points, can be floating-point)
3143 b - bold
3144 i - italic
3145 u - underline
3146 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003147 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3149 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3150 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003151 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152
3153 Use a ':' to separate the options.
3154 - A '_' can be used in the place of a space, so you don't need to use
3155 backslashes to escape the spaces.
3156 - Examples: >
3157 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3158 :set guifont=Andale_Mono:h7.5:w4.5
3159< See also |font-sizes|.
3160
3161 *'guifontset'* *'gfs'*
3162 *E250* *E252* *E234* *E597* *E598*
3163'guifontset' 'gfs' string (default "")
3164 global
3165 {not in Vi}
3166 {only available when compiled with GUI enabled and
3167 with the |+xfontset| feature}
3168 {not available in the GTK+ 2 GUI}
3169 When not empty, specifies two (or more) fonts to be used. The first
3170 one for normal English, the second one for your special language. See
3171 |xfontset|.
3172 Setting this option also means that all font names will be handled as
3173 a fontset name. Also the ones used for the "font" argument of the
3174 |:highlight| command.
3175 The fonts must match with the current locale. If fonts for the
3176 character sets that the current locale uses are not included, setting
3177 'guifontset' will fail.
3178 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3179 the comma-separated names are alternative names, one of which will be
3180 used. In 'guifontset' the whole string is one fontset name,
3181 including the commas. It is not possible to specify alternative
3182 fontset names.
3183 This example works on many X11 systems: >
3184 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3185<
3186 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3187'guifontwide' 'gfw' string (default "")
3188 global
3189 {not in Vi}
3190 {only available when compiled with GUI enabled}
3191 When not empty, specifies a comma-separated list of fonts to be used
3192 for double-width characters. The first font that can be loaded is
3193 used.
3194 Note: The size of these fonts must be exactly twice as wide as the one
3195 specified with 'guifont' and the same height.
3196
3197 All GUI versions but GTK+ 2:
3198
3199 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3200 'guifontset' is empty or invalid.
3201 When 'guifont' is set and a valid font is found in it and
3202 'guifontwide' is empty Vim will attempt to find a matching
3203 double-width font and set 'guifontwide' to it.
3204
3205 GTK+ 2 GUI only: *guifontwide_gtk2*
3206
3207 If set and valid, 'guifontwide' is always used for double width
3208 characters, even if 'encoding' is not set to "utf-8".
3209 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003210 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 font for characters not available in 'guifont'. Thus you do not need
3212 to set 'guifontwide' at all unless you want to override the choice
3213 made by Pango/Xft.
3214
3215 *'guiheadroom'* *'ghr'*
3216'guiheadroom' 'ghr' number (default 50)
3217 global
3218 {not in Vi} {only for GTK and X11 GUI}
3219 The number of pixels subtracted from the screen height when fitting
3220 the GUI window on the screen. Set this before the GUI is started,
3221 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003222 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 lines will be left for window decorations and other items on the
3224 screen. Set it to a negative value to allow windows taller than the
3225 screen.
3226
3227 *'guioptions'* *'go'*
3228'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003229 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 global
3231 {not in Vi}
3232 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003233 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 sequence of letters which describes what components and options of the
3235 GUI should be used.
3236 To avoid problems with flags that are added in the future, use the
3237 "+=" and "-=" feature of ":set" |add-option-flags|.
3238
3239 Valid letters are as follows:
3240 *guioptions_a*
3241 'a' Autoselect: If present, then whenever VISUAL mode is started,
3242 or the Visual area extended, Vim tries to become the owner of
3243 the windowing system's global selection. This means that the
3244 Visually highlighted text is available for pasting into other
3245 applications as well as into Vim itself. When the Visual mode
3246 ends, possibly due to an operation on the text, or when an
3247 application wants to paste the selection, the highlighted text
3248 is automatically yanked into the "* selection register.
3249 Thus the selection is still available for pasting into other
3250 applications after the VISUAL mode has ended.
3251 If not present, then Vim won't become the owner of the
3252 windowing system's global selection unless explicitly told to
3253 by a yank or delete operation for the "* register.
3254 The same applies to the modeless selection.
3255
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003256 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 applies to the modeless selection.
3258
3259 'guioptions' autoselect Visual autoselect modeless ~
3260 "" - -
3261 "a" yes yes
3262 "A" - yes
3263 "aA" yes yes
3264
3265 'c' Use console dialogs instead of popup dialogs for simple
3266 choices.
3267
3268 'f' Foreground: Don't use fork() to detach the GUI from the shell
3269 where it was started. Use this for programs that wait for the
3270 editor to finish (e.g., an e-mail program). Alternatively you
3271 can use "gvim -f" or ":gui -f" to start the GUI in the
3272 foreground. |gui-fork|
3273 Note: Set this option in the vimrc file. The forking may have
3274 happened already when the gvimrc file is read.
3275
3276 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3277 corner of the window. It's black&white on non-GTK, because of
3278 limitations of X11. For a color icon, see |X11-icon|.
3279
3280 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003281 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 that this flag must be added in the .vimrc file, before
3283 switching on syntax or filetype recognition (when the .gvimrc
3284 file is sourced the system menu has already been loaded; the
3285 ":syntax on" and ":filetype on" commands load the menu too).
3286 'g' Grey menu items: Make menu items that are not active grey. If
3287 'g' is not included inactive menu items are not shown at all.
3288 Exception: Athena will always use grey menu items.
3289
3290 't' Include tearoff menu items. Currently only works for Win32,
3291 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003292 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3293 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294
3295 'r' Right-hand scrollbar is always present.
3296 'R' Right-hand scrollbar is present when there is a vertically
3297 split window.
3298 'l' Left-hand scrollbar is always present.
3299 'L' Left-hand scrollbar is present when there is a vertically
3300 split window.
3301 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3302 the longest visible line, or on the cursor line if the 'h'
3303 flag is included. |gui-horiz-scroll|
3304 'h' Limit horizontal scrollbar size to the length of the cursor
3305 line. Reduces computations. |gui-horiz-scroll|
3306
3307 And yes, you may even have scrollbars on the left AND the right if
3308 you really want to :-). See |gui-scrollbars| for more information.
3309
3310 'v' Use a vertical button layout for dialogs. When not included,
3311 a horizontal layout is preferred, but when it doesn't fit a
3312 vertical layout is used anyway.
3313 'p' Use Pointer callbacks for X11 GUI. This is required for some
3314 window managers. If the cursor is not blinking or hollow at
3315 the right moment, try adding this flag. This must be done
3316 before starting the GUI. Set it in your gvimrc. Adding or
3317 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003318 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319
3320 *'guipty'* *'noguipty'*
3321'guipty' boolean (default on)
3322 global
3323 {not in Vi}
3324 {only available when compiled with GUI enabled}
3325 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3326 I/O to/from shell commands. See |gui-pty|.
3327
3328 *'helpfile'* *'hf'*
3329'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3330 (others) "$VIMRUNTIME/doc/help.txt")
3331 global
3332 {not in Vi}
3333 Name of the main help file. All distributed help files should be
3334 placed together in one directory. Additionally, all "doc" directories
3335 in 'runtimepath' will be used.
3336 Environment variables are expanded |:set_env|. For example:
3337 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003338 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003339 spaces and backslashes.
3340 This option cannot be set from a |modeline| or in the |sandbox|, for
3341 security reasons.
3342
3343 *'helpheight'* *'hh'*
3344'helpheight' 'hh' number (default 20)
3345 global
3346 {not in Vi}
3347 {not available when compiled without the +windows
3348 feature}
3349 Minimal initial height of the help window when it is opened with the
3350 ":help" command. The initial height of the help window is half of the
3351 current window, or (when the 'ea' option is on) the same as other
3352 windows. When the height is less than 'helpheight', the height is
3353 set to 'helpheight'. Set to zero to disable.
3354
3355 *'helplang'* *'hlg'*
3356'helplang' 'hlg' string (default: messages language or empty)
3357 global
3358 {only available when compiled with the |+multi_lang|
3359 feature}
3360 {not in Vi}
3361 Comma separated list of languages. Vim will use the first language
3362 for which the desired help can be found. The English help will always
3363 be used as a last resort. You can add "en" to prefer English over
3364 another language, but that will only find tags that exist in that
3365 language and not in the English help.
3366 Example: >
3367 :set helplang=de,it
3368< This will first search German, then Italian and finally English help
3369 files.
3370 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3371 try to find the tag in the current language before using this option.
3372 See |help-translated|.
3373
3374 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3375'hidden' 'hid' boolean (default off)
3376 global
3377 {not in Vi}
3378 When off a buffer is unloaded when it is |abandon|ed. When on a
3379 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3380 displayed in another window, it does not become hidden, of course.
3381 The commands that move through the buffer list sometimes make a buffer
3382 hidden although the 'hidden' option is off: When the buffer is
3383 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003384 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003385 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 This option is set for one command with ":hide {command}" |:hide|.
3387 WARNING: It's easy to forget that you have changes in hidden buffers.
3388 Think twice when using ":q!" or ":qa!".
3389
3390 *'highlight'* *'hl'*
3391'highlight' 'hl' string (default (as a single string):
3392 "8:SpecialKey,@:NonText,d:Directory,
3393 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3394 M:ModeMsg,n:LineNr,r:Question,
3395 s:StatusLine,S:StatusLineNC,c:VertSplit
3396 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3397 f:Folded,F:FoldColumn,A:DiffAdd,
3398 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003399 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003400 R:SpellRare,L:SpellLocal,
3401 +:Pmenu,=:PmenuSel,
3402 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 global
3404 {not in Vi}
3405 This option can be used to set highlighting mode for various
3406 occasions. It is a comma separated list of character pairs. The
3407 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003408 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3410 |hl-NonText| @ '~' and '@' at the end of the window and
3411 characters from 'showbreak'
3412 |hl-Directory| d directories in CTRL-D listing and other special
3413 things in listings
3414 |hl-ErrorMsg| e error messages
3415 h (obsolete, ignored)
3416 |hl-IncSearch| i 'incsearch' highlighting
3417 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3418 |hl-MoreMsg| m |more-prompt|
3419 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3420 |hl-LineNr| n line number for ":number" and ":#" commands
3421 |hl-Question| r |hit-enter| prompt and yes/no questions
3422 |hl-StatusLine| s status line of current window |status-line|
3423 |hl-StatusLineNC| S status lines of not-current windows
3424 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3425 |hl-VertSplit| c column used to separate vertically split windows
3426 |hl-Visual| v Visual mode
3427 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3428 Selection" Only X11 Gui's |gui-x11| and
3429 |xterm-clipboard|.
3430 |hl-WarningMsg| w warning messages
3431 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3432 |hl-Folded| f line used for closed folds
3433 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003434 |hl-DiffAdd| A added line in diff mode
3435 |hl-DiffChange| C changed line in diff mode
3436 |hl-DiffDelete| D deleted line in diff mode
3437 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003439 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003440 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003441 |hl-SpellRare| R rare word |spell|
3442 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003443 |hl-Pmenu| + popup menu normal line
3444 |hl-PmenuSel| = popup menu normal line
3445 |hl-PmenuSbar| x popup menu scrollbar
3446 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447
3448 The display modes are:
3449 r reverse (termcap entry "mr" and "me")
3450 i italic (termcap entry "ZH" and "ZR")
3451 b bold (termcap entry "md" and "me")
3452 s standout (termcap entry "so" and "se")
3453 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003454 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 n no highlighting
3456 - no highlighting
3457 : use a highlight group
3458 The default is used for occasions that are not included.
3459 If you want to change what the display modes do, see |dos-colors|
3460 for an example.
3461 When using the ':' display mode, this must be followed by the name of
3462 a highlight group. A highlight group can be used to define any type
3463 of highlighting, including using color. See |:highlight| on how to
3464 define one. The default uses a different group for each occasion.
3465 See |highlight-default| for the default highlight groups.
3466
3467 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3468'hlsearch' 'hls' boolean (default off)
3469 global
3470 {not in Vi}
3471 {not available when compiled without the
3472 |+extra_search| feature}
3473 When there is a previous search pattern, highlight all its matches.
3474 The type of highlighting used can be set with the 'l' occasion in the
3475 'highlight' option. This uses the "Search" highlight group by
3476 default. Note that only the matching text is highlighted, any offsets
3477 are not applied.
3478 See also: 'incsearch' and |:match|.
3479 When you get bored looking at the highlighted matches, you can turn it
3480 off with |:nohlsearch|. As soon as you use a search command, the
3481 highlighting comes back.
3482 When the search pattern can match an end-of-line, Vim will try to
3483 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003484 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 line below a closed fold. A match in a previous line which is not
3486 drawn may not continue in an newly drawn line.
3487 NOTE: This option is reset when 'compatible' is set.
3488
3489 *'history'* *'hi'*
3490'history' 'hi' number (Vim default: 20, Vi default: 0)
3491 global
3492 {not in Vi}
3493 A history of ":" commands, and a history of previous search patterns
3494 are remembered. This option decides how many entries may be stored in
3495 each of these histories (see |cmdline-editing|).
3496 NOTE: This option is set to the Vi default value when 'compatible' is
3497 set and to the Vim default value when 'compatible' is reset.
3498
3499 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3500'hkmap' 'hk' boolean (default off)
3501 global
3502 {not in Vi}
3503 {only available when compiled with the |+rightleft|
3504 feature}
3505 When on, the keyboard is mapped for the Hebrew character set.
3506 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3507 toggle this option. See |rileft.txt|.
3508 NOTE: This option is reset when 'compatible' is set.
3509
3510 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3511'hkmapp' 'hkp' boolean (default off)
3512 global
3513 {not in Vi}
3514 {only available when compiled with the |+rightleft|
3515 feature}
3516 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3517 This is useful if you have a non-Hebrew keyboard.
3518 See |rileft.txt|.
3519 NOTE: This option is reset when 'compatible' is set.
3520
3521 *'icon'* *'noicon'*
3522'icon' boolean (default off, on when title can be restored)
3523 global
3524 {not in Vi}
3525 {not available when compiled without the |+title|
3526 feature}
3527 When on, the icon text of the window will be set to the value of
3528 'iconstring' (if it is not empty), or to the name of the file
3529 currently being edited. Only the last part of the name is used.
3530 Overridden by the 'iconstring' option.
3531 Only works if the terminal supports setting window icons (currently
3532 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3533 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3534 builtin termcap).
3535 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003536 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 X11.
3538
3539 *'iconstring'*
3540'iconstring' string (default "")
3541 global
3542 {not in Vi}
3543 {not available when compiled without the |+title|
3544 feature}
3545 When this option is not empty, it will be used for the icon text of
3546 the window. This happens only when the 'icon' option is on.
3547 Only works if the terminal supports setting window icon text
3548 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3549 Does not work for MS Windows.
3550 When Vim was compiled with HAVE_X11 defined, the original icon will be
3551 restored if possible |X11|.
3552 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003553 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 'titlestring' for example settings.
3555 {not available when compiled without the |+statusline| feature}
3556
3557 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3558'ignorecase' 'ic' boolean (default off)
3559 global
3560 Ignore case in search patterns. Also used when searching in the tags
3561 file.
3562 Also see 'smartcase'.
3563 Can be overruled by using "\c" or "\C" in the pattern, see
3564 |/ignorecase|.
3565
3566 *'imactivatekey'* *'imak'*
3567'imactivatekey' 'imak' string (default "")
3568 global
3569 {not in Vi}
3570 {only available when compiled with |+xim| and
3571 |+GUI_GTK|}
3572 Specifies the key that your Input Method in X-Windows uses for
3573 activation. When this is specified correctly, vim can fully control
3574 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3575 You can't use this option to change the activation key, the option
3576 tells Vim what the key is.
3577 Format:
3578 [MODIFIER_FLAG-]KEY_STRING
3579
3580 These characters can be used for MODIFIER_FLAG (case is ignored):
3581 S Shift key
3582 L Lock key
3583 C Control key
3584 1 Mod1 key
3585 2 Mod2 key
3586 3 Mod3 key
3587 4 Mod4 key
3588 5 Mod5 key
3589 Combinations are allowed, for example "S-C-space" or "SC-space" are
3590 both shift+ctrl+space.
3591 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3592
3593 Example: >
3594 :set imactivatekey=S-space
3595< "S-space" means shift+space. This is the activation key for kinput2 +
3596 canna (Japanese), and ami (Korean).
3597
3598 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3599'imcmdline' 'imc' boolean (default off)
3600 global
3601 {not in Vi}
3602 {only available when compiled with the |+xim|
3603 |+multi_byte_ime| or |global-ime| feature}
3604 When set the Input Method is always on when starting to edit a command
3605 line, unless entering a search pattern (see 'imsearch' for that).
3606 Setting this option is useful when your input method allows entering
3607 English characters directly, e.g., when it's used to type accented
3608 characters with dead keys.
3609
3610 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3611'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3612 global
3613 {not in Vi}
3614 {only available when compiled with the |+xim|
3615 |+multi_byte_ime| or |global-ime| feature}
3616 When set the Input Method is never used. This is useful to disable
3617 the IM when it doesn't work properly.
3618 Currently this option is on by default for SGI/IRIX machines. This
3619 may change in later releases.
3620
3621 *'iminsert'* *'imi'*
3622'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3623 local to buffer
3624 {not in Vi}
3625 Specifies whether :lmap or an Input Method (IM) is to be used in
3626 Insert mode. Valid values:
3627 0 :lmap is off and IM is off
3628 1 :lmap is ON and IM is off
3629 2 :lmap is off and IM is ON
3630 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3631 or |global-ime|.
3632 To always reset the option to zero when leaving Insert mode with <Esc>
3633 this can be used: >
3634 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3635< This makes :lmap and IM turn off automatically when leaving Insert
3636 mode.
3637 Note that this option changes when using CTRL-^ in Insert mode
3638 |i_CTRL-^|.
3639 The value is set to 1 when setting 'keymap' to a valid keymap name.
3640 It is also used for the argument of commands like "r" and "f".
3641 The value 0 may not work correctly with Athena and Motif with some XIM
3642 methods. Use 'imdisable' to disable XIM then.
3643
3644 *'imsearch'* *'ims'*
3645'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3646 local to buffer
3647 {not in Vi}
3648 Specifies whether :lmap or an Input Method (IM) is to be used when
3649 entering a search pattern. Valid values:
3650 -1 the value of 'iminsert' is used, makes it look like
3651 'iminsert' is also used when typing a search pattern
3652 0 :lmap is off and IM is off
3653 1 :lmap is ON and IM is off
3654 2 :lmap is off and IM is ON
3655 Note that this option changes when using CTRL-^ in Command-line mode
3656 |c_CTRL-^|.
3657 The value is set to 1 when it is not -1 and setting the 'keymap'
3658 option to a valid keymap name.
3659 The value 0 may not work correctly with Athena and Motif with some XIM
3660 methods. Use 'imdisable' to disable XIM then.
3661
3662 *'include'* *'inc'*
3663'include' 'inc' string (default "^\s*#\s*include")
3664 global or local to buffer |global-local|
3665 {not in Vi}
3666 {not available when compiled without the
3667 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003668 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 pattern, just like for the "/" command (See |pattern|). The default
3670 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003671 "]I", "[d", etc.
3672 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003673 comes after the matched pattern. But if "\zs" appears in the pattern
3674 then the text matched from "\zs" to the end, or until "\ze" if it
3675 appears, is used as the file name. Use this to include characters
3676 that are not in 'isfname', such as a space. You can then use
3677 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003678 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679
3680 *'includeexpr'* *'inex'*
3681'includeexpr' 'inex' string (default "")
3682 local to buffer
3683 {not in Vi}
3684 {not available when compiled without the
3685 |+find_in_path| or |+eval| feature}
3686 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003687 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 :set includeexpr=substitute(v:fname,'\\.','/','g')
3689< The "v:fname" variable will be set to the file name that was detected.
3690 Evaluated in the |sandbox|.
3691 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003692 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 Also used for |<cfile>|.
3694
3695 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3696'incsearch' 'is' boolean (default off)
3697 global
3698 {not in Vi}
3699 {not available when compiled without the
3700 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003701 While typing a search command, show where the pattern, as it was typed
3702 so far, matches. The matched string is highlighted. If the pattern
3703 is invalid or not found, nothing is shown. The screen will be updated
3704 often, this is only useful on fast terminals.
3705 Note that the match will be shown, but the cursor will return to its
3706 original position when no match is found and when pressing <Esc>. You
3707 still need to finish the search command with <Enter> to move the
3708 cursor to the match.
3709 The highlighting can be set with the 'i' flag in 'highlight'.
3710 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 NOTE: This option is reset when 'compatible' is set.
3712
3713 *'indentexpr'* *'inde'*
3714'indentexpr' 'inde' string (default "")
3715 local to buffer
3716 {not in Vi}
3717 {not available when compiled without the |+cindent|
3718 or |+eval| features}
3719 Expression which is evaluated to obtain the proper indent for a line.
3720 It is used when a new line is created, for the |=| operator and
3721 in Insert mode as specified with the 'indentkeys' option.
3722 When this option is not empty, it overrules the 'cindent' and
3723 'smartindent' indenting.
3724 When 'paste' is set this option is not used for indenting.
3725 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003726 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 when the expression is evaluated (but it may be moved around).
3728 The expression must return the number of spaces worth of indent. It
3729 can return "-1" to keep the current indent (this means 'autoindent' is
3730 used for the indent).
3731 Functions useful for computing the indent are |indent()|, |cindent()|
3732 and |lispindent()|.
3733 The evaluation of the expression must not have side effects! It must
3734 not change the text, jump to another window, etc. Afterwards the
3735 cursor position is always restored, thus the cursor may be moved.
3736 Normally this option would be set to call a function: >
3737 :set indentexpr=GetMyIndent()
3738< Error messages will be suppressed, unless the 'debug' option contains
3739 "msg".
3740 See |indent-expression|. Also see |eval-sandbox|.
3741 NOTE: This option is made empty when 'compatible' is set.
3742
3743 *'indentkeys'* *'indk'*
3744'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3745 local to buffer
3746 {not in Vi}
3747 {not available when compiled without the |+cindent|
3748 feature}
3749 A list of keys that, when typed in Insert mode, cause reindenting of
3750 the current line. Only happens if 'indentexpr' isn't empty.
3751 The format is identical to 'cinkeys', see |indentkeys-format|.
3752 See |C-indenting| and |indent-expression|.
3753
3754 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3755'infercase' 'inf' boolean (default off)
3756 local to buffer
3757 {not in Vi}
3758 When doing keyword completion in insert mode |ins-completion|, and
3759 'ignorecase' is also on, the case of the match is adjusted. If the
3760 typed text contains a lowercase letter where the match has an upper
3761 case letter, the completed part is made lowercase. If the typed text
3762 has no lowercase letters and the match has a lowercase letter where
3763 the typed text has an uppercase letter, and there is a letter before
3764 it, the completed part is made uppercase.
3765
3766 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3767'insertmode' 'im' boolean (default off)
3768 global
3769 {not in Vi}
3770 Makes Vim work in a way that Insert mode is the default mode. Useful
3771 if you want to use Vim as a modeless editor. Used for |evim|.
3772 These Insert mode commands will be useful:
3773 - Use the cursor keys to move around.
3774 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3775 this is a mapping, it is executed as if 'insertmode' was off.
3776 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003778 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3779 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780
3781 These items change when 'insertmode' is set:
3782 - when starting to edit of a file, Vim goes to Insert mode.
3783 - <Esc> in Insert mode is a no-op and beeps.
3784 - <Esc> in Normal mode makes Vim go to Insert mode.
3785 - CTRL-L in Insert mode is a command, it is not inserted.
3786 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3787 However, when <Esc> is used inside a mapping, it behaves like
3788 'insertmode' was not set. This was done to be able to use the same
3789 mappings with 'insertmode' set or not set.
3790 When executing commands with |:normal| 'insertmode' is not used.
3791
3792 NOTE: This option is reset when 'compatible' is set.
3793
3794 *'isfname'* *'isf'*
3795'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3796 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3797 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3798 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3799 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3800 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3801 global
3802 {not in Vi}
3803 The characters specified by this option are included in file names and
3804 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003805 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 Multi-byte characters 256 and above are always included, only the
3807 characters up to 255 are specified with this option.
3808 For UTF-8 the characters 0xa0 to 0xff are included as well.
3809
3810 Note that on systems using a backslash as path separator, Vim tries to
3811 do its best to make it work as you would expect. That is a bit
3812 tricky, since Vi originally used the backslash to escape special
3813 characters. Vim will not remove a backslash in front of a normal file
3814 name character on these systems, but it will on Unix and alikes. The
3815 '&' and '^' are not included by default, because these are special for
3816 cmd.exe.
3817
3818 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003819 Each part can be a single character number or a range. A range is two
3820 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 decimal number between 0 and 255 or the ASCII character itself (does
3822 not work for digits). Example:
3823 "_,-,128-140,#-43" (include '_' and '-' and the range
3824 128 to 140 and '#' to 43)
3825 If a part starts with '^', the following character number or range
3826 will be excluded from the option. The option is interpreted from left
3827 to right. Put the excluded character after the range where it is
3828 included. To include '^' itself use it as the last character of the
3829 option or the end of a range. Example:
3830 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3831 If the character is '@', all characters where isalpha() returns TRUE
3832 are included. Normally these are the characters a to z and A to Z,
3833 plus accented characters. To include '@' itself use "@-@". Examples:
3834 "@,^a-z" All alphabetic characters, excluding lower
3835 case letters.
3836 "a-z,A-Z,@-@" All letters plus the '@' character.
3837 A comma can be included by using it where a character number is
3838 expected. Example:
3839 "48-57,,,_" Digits, comma and underscore.
3840 A comma can be excluded by prepending a '^'. Example:
3841 " -~,^,,9" All characters from space to '~', excluding
3842 comma, plus <Tab>.
3843 See |option-backslash| about including spaces and backslashes.
3844
3845 *'isident'* *'isi'*
3846'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3847 "@,48-57,_,128-167,224-235"
3848 otherwise: "@,48-57,_,192-255")
3849 global
3850 {not in Vi}
3851 The characters given by this option are included in identifiers.
3852 Identifiers are used in recognizing environment variables and after a
3853 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003854 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003855 option.
3856 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003857 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3859
3860 *'iskeyword'* *'isk'*
3861'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3862 "@,48-57,_,128-167,224-235"
3863 otherwise: "@,48-57,_,192-255"
3864 Vi default: "@,48-57,_")
3865 local to buffer
3866 {not in Vi}
3867 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003868 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 'isfname' for a description of the format of this option. For C
3870 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3871 For a help file it is set to all non-blank printable characters except
3872 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3873 command).
3874 When the 'lisp' option is on the '-' character is always included.
3875 NOTE: This option is set to the Vi default value when 'compatible' is
3876 set and to the Vim default value when 'compatible' is reset.
3877
3878 *'isprint'* *'isp'*
3879'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3880 "@,~-255"; otherwise: "@,161-255")
3881 global
3882 {not in Vi}
3883 The characters given by this option are displayed directly on the
3884 screen. It is also used for "\p" in a |pattern|. The characters from
3885 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3886 even when they are not included in 'isprint' or excluded. See
3887 'isfname' for a description of the format of this option.
3888
3889 Non-printable characters are displayed with two characters:
3890 0 - 31 "^@" - "^_"
3891 32 - 126 always single characters
3892 127 "^?"
3893 128 - 159 "~@" - "~_"
3894 160 - 254 "| " - "|~"
3895 255 "~?"
3896 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3897 displayed as <xx>, with the hexadecimal value of the byte.
3898 When 'display' contains "uhex" all unprintable characters are
3899 displayed as <xx>.
3900 The NonText highlighting will be used for unprintable characters.
3901 |hl-NonText|
3902
3903 Multi-byte characters 256 and above are always included, only the
3904 characters up to 255 are specified with this option. When a character
3905 is printable but it is not available in the current font, a
3906 replacement character will be shown.
3907 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3908 There is no option to specify these characters.
3909
3910 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3911'joinspaces' 'js' boolean (default on)
3912 global
3913 {not in Vi}
3914 Insert two spaces after a '.', '?' and '!' with a join command.
3915 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3916 Otherwise only one space is inserted.
3917 NOTE: This option is set when 'compatible' is set.
3918
3919 *'key'*
3920'key' string (default "")
3921 local to buffer
3922 {not in Vi}
3923 The key that is used for encrypting and decrypting the current buffer.
3924 See |encryption|.
3925 Careful: Do not set the key value by hand, someone might see the typed
3926 key. Use the |:X| command. But you can make 'key' empty: >
3927 :set key=
3928< It is not possible to get the value of this option with ":set key" or
3929 "echo &key". This is to avoid showing it to someone who shouldn't
3930 know. It also means you cannot see it yourself once you have set it,
3931 be careful not to make a typing error!
3932
3933 *'keymap'* *'kmp'* *E544*
3934'keymap' 'kmp' string (default "")
3935 local to buffer
3936 {not in Vi}
3937 {only available when compiled with the |+keymap|
3938 feature}
3939 Name of a keyboard mapping. See |mbyte-keymap|.
3940 Setting this option to a valid keymap name has the side effect of
3941 setting 'iminsert' to one, so that the keymap becomes effective.
3942 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003943 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944
3945 *'keymodel'* *'km'*
3946'keymodel' 'km' string (default "")
3947 global
3948 {not in Vi}
3949 List of comma separated words, which enable special things that keys
3950 can do. These values can be used:
3951 startsel Using a shifted special key starts selection (either
3952 Select mode or Visual mode, depending on "key" being
3953 present in 'selectmode').
3954 stopsel Using a not-shifted special key stops selection.
3955 Special keys in this context are the cursor keys, <End>, <Home>,
3956 <PageUp> and <PageDown>.
3957 The 'keymodel' option is set by the |:behave| command.
3958
3959 *'keywordprg'* *'kp'*
3960'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3961 OS/2: "view /", VMS: "help")
3962 global or local to buffer |global-local|
3963 {not in Vi}
3964 Program to use for the |K| command. Environment variables are
3965 expanded |:set_env|. ":help" may be used to access the Vim internal
3966 help. (Note that previously setting the global option to the empty
3967 value did this, which is now deprecated.)
3968 When "man" is used, Vim will automatically translate a count for the
3969 "K" command to a section number. Also for "man -s", in which case the
3970 "-s" is removed when there is no count.
3971 See |option-backslash| about including spaces and backslashes.
3972 Example: >
3973 :set keywordprg=man\ -s
3974< This option cannot be set from a |modeline| or in the |sandbox|, for
3975 security reasons.
3976
3977 *'langmap'* *'lmap'* *E357* *E358*
3978'langmap' 'lmap' string (default "")
3979 global
3980 {not in Vi}
3981 {only available when compiled with the |+langmap|
3982 feature}
3983 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003984 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 inserted directly. When in command mode the 'langmap' option takes
3986 care of translating these special characters to the original meaning
3987 of the key. This means you don't have to change the keyboard mode to
3988 be able to execute Normal mode commands.
3989 This is the opposite of the 'keymap' option, where characters are
3990 mapped in Insert mode.
3991 This only works for 8-bit characters. The value of 'langmap' may be
3992 specified with multi-byte characters (e.g., UTF-8), but only the lower
3993 8 bits of each character will be used.
3994
3995 Example (for Greek): *greek* >
3996 :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
3997< Example (exchanges meaning of z and y for commands): >
3998 :set langmap=zy,yz,ZY,YZ
3999<
4000 The 'langmap' option is a list of parts, separated with commas. Each
4001 part can be in one of two forms:
4002 1. A list of pairs. Each pair is a "from" character immediately
4003 followed by the "to" character. Examples: "aA", "aAbBcC".
4004 2. A list of "from" characters, a semi-colon and a list of "to"
4005 characters. Example: "abc;ABC"
4006 Example: "aA,fgh;FGH,cCdDeE"
4007 Special characters need to be preceded with a backslash. These are
4008 ";", ',' and backslash itself.
4009
4010 This will allow you to activate vim actions without having to switch
4011 back and forth between the languages. Your language characters will
4012 be understood as normal vim English characters (according to the
4013 langmap mappings) in the following cases:
4014 o Normal/Visual mode (commands, buffer/register names, user mappings)
4015 o Insert/Replace Mode: Register names after CTRL-R
4016 o Insert/Replace Mode: Mappings
4017 Characters entered in Command-line mode will NOT be affected by
4018 this option. Note that this option can be changed at any time
4019 allowing to switch between mappings for different languages/encodings.
4020 Use a mapping to avoid having to type it each time!
4021
4022 *'langmenu'* *'lm'*
4023'langmenu' 'lm' string (default "")
4024 global
4025 {not in Vi}
4026 {only available when compiled with the |+menu| and
4027 |+multi_lang| features}
4028 Language to use for menu translation. Tells which file is loaded
4029 from the "lang" directory in 'runtimepath': >
4030 "lang/menu_" . &langmenu . ".vim"
4031< (without the spaces). For example, to always use the Dutch menus, no
4032 matter what $LANG is set to: >
4033 :set langmenu=nl_NL.ISO_8859-1
4034< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004035 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 If your $LANG is set to a non-English language but you do want to use
4037 the English menus: >
4038 :set langmenu=none
4039< This option must be set before loading menus, switching on filetype
4040 detection or syntax highlighting. Once the menus are defined setting
4041 this option has no effect. But you could do this: >
4042 :source $VIMRUNTIME/delmenu.vim
4043 :set langmenu=de_DE.ISO_8859-1
4044 :source $VIMRUNTIME/menu.vim
4045< Warning: This deletes all menus that you defined yourself!
4046
4047 *'laststatus'* *'ls'*
4048'laststatus' 'ls' number (default 1)
4049 global
4050 {not in Vi}
4051 The value of this option influences when the last window will have a
4052 status line:
4053 0: never
4054 1: only if there are at least two windows
4055 2: always
4056 The screen looks nicer with a status line if you have several
4057 windows, but it takes another screen line. |status-line|
4058
4059 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4060'lazyredraw' 'lz' boolean (default off)
4061 global
4062 {not in Vi}
4063 When this option is set, the screen will not be redrawn while
4064 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004065 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 update use |:redraw|.
4067
4068 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4069'linebreak' 'lbr' boolean (default off)
4070 local to window
4071 {not in Vi}
4072 {not available when compiled without the |+linebreak|
4073 feature}
4074 If on Vim will wrap long lines at a character in 'breakat' rather
4075 than at the last character that fits on the screen. Unlike
4076 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4077 it only affects the way the file is displayed, not its contents. The
4078 value of 'showbreak' is used to put in front of wrapped lines.
4079 This option is not used when the 'wrap' option is off or 'list' is on.
4080 Note that <Tab> characters after an <EOL> are mostly not displayed
4081 with the right amount of white space.
4082
4083 *'lines'* *E593*
4084'lines' number (default 24 or terminal height)
4085 global
4086 Number of lines of the Vim window.
4087 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004088 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 When Vim is running in the GUI or in a resizable window, setting this
4090 option will cause the window size to be changed. When you only want
4091 to use the size for the GUI, put the command in your |gvimrc| file.
4092 Vim limits the number of lines to what fits on the screen. You can
4093 use this command to get the tallest window possible: >
4094 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004095< Minimum value is 2, maximum value is 1000.
4096 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 When you set this option and Vim is unable to change the physical
4098 number of lines of the display, the display may be messed up.
4099
4100 *'linespace'* *'lsp'*
4101'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4102 global
4103 {not in Vi}
4104 {only in the GUI}
4105 Number of pixel lines inserted between characters. Useful if the font
4106 uses the full character cell height, making lines touch each other.
4107 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004108 With some fonts there can be too much room between lines (to have
4109 space for ascents and descents). Then it makes sense to set
4110 'linespace' to a negative value. This may cause display problems
4111 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112
4113 *'lisp'* *'nolisp'*
4114'lisp' boolean (default off)
4115 local to buffer
4116 {not available when compiled without the |+lispindent|
4117 feature}
4118 Lisp mode: When <Enter> is typed in insert mode set the indent for
4119 the next line to Lisp standards (well, sort of). Also happens with
4120 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4121 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4122 better. Also see 'lispwords'.
4123 The '-' character is included in keyword characters. Redefines the
4124 "=" operator to use this same indentation algorithm rather than
4125 calling an external program if 'equalprg' is empty.
4126 This option is not used when 'paste' is set.
4127 {Vi: Does it a little bit differently}
4128
4129 *'lispwords'* *'lw'*
4130'lispwords' 'lw' string (default is very long)
4131 global
4132 {not in Vi}
4133 {not available when compiled without the |+lispindent|
4134 feature}
4135 Comma separated list of words that influence the Lisp indenting.
4136 |'lisp'|
4137
4138 *'list'* *'nolist'*
4139'list' boolean (default off)
4140 local to window
4141 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4142 see the difference between tabs and spaces and for trailing blanks.
4143 Note that this will also affect formatting (set with 'textwidth' or
4144 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4145 changing the way tabs are displayed.
4146
4147 *'listchars'* *'lcs'*
4148'listchars' 'lcs' string (default "eol:$")
4149 global
4150 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004151 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 settings.
4153 eol:c Character to show at the end of each line. When
4154 omitted, there is no extra character at the end of the
4155 line.
4156 tab:xy Two characters to be used to show a Tab. The first
4157 char is used once. The second char is repeated to
4158 fill the space that the Tab normally occupies.
4159 "tab:>-" will show a Tab that takes four spaces as
4160 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 trailing spaces are blank.
4163 extends:c Character to show in the last column, when 'wrap' is
4164 off and the line continues beyond the right of the
4165 screen.
4166 precedes:c Character to show in the first column, when 'wrap'
4167 is off and there is text preceding the character
4168 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004169 nbsp:c Character to show for a non-breakable space (character
4170 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004172 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 be used when 'encoding' is "utf-8", otherwise only printable
4174 characters are allowed.
4175
4176 Examples: >
4177 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004178 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 :set lcs=extends:>,precedes:<
4180< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004181 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182
4183 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4184'loadplugins' 'lpl' boolean (default on)
4185 global
4186 {not in Vi}
4187 When on the plugin scripts are loaded when starting up |load-plugins|.
4188 This option can be reset in your |vimrc| file to disable the loading
4189 of plugins.
4190 Note that using the "-u NONE" and "--noplugin" command line arguments
4191 reset this option. |-u| |--noplugin|
4192
4193 *'magic'* *'nomagic'*
4194'magic' boolean (default on)
4195 global
4196 Changes the special characters that can be used in search patterns.
4197 See |pattern|.
4198 NOTE: To avoid portability problems with using patterns, always keep
4199 this option at the default "on". Only switch it off when working with
4200 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004201 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202
4203 *'makeef'* *'mef'*
4204'makeef' 'mef' string (default: "")
4205 global
4206 {not in Vi}
4207 {not available when compiled without the |+quickfix|
4208 feature}
4209 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4210 and the |:grep| command.
4211 When it is empty, an internally generated temp file will be used.
4212 When "##" is included, it is replaced by a number to make the name
4213 unique. This makes sure that the ":make" command doesn't overwrite an
4214 existing file.
4215 NOT used for the ":cf" command. See 'errorfile' for that.
4216 Environment variables are expanded |:set_env|.
4217 See |option-backslash| about including spaces and backslashes.
4218 This option cannot be set from a |modeline| or in the |sandbox|, for
4219 security reasons.
4220
4221 *'makeprg'* *'mp'*
4222'makeprg' 'mp' string (default "make", VMS: "MMS")
4223 global or local to buffer |global-local|
4224 {not in Vi}
4225 Program to use for the ":make" command. See |:make_makeprg|. This
4226 option may contain '%' and '#' characters, which are expanded like
4227 when used in a command-line. Environment variables are expanded
4228 |:set_env|. See |option-backslash| about including spaces and
4229 backslashes. Note that a '|' must be escaped twice: once for ":set"
4230 and once for the interpretation of a command. When you use a filter
4231 called "myfilter" do it like this: >
4232 :set makeprg=gmake\ \\\|\ myfilter
4233< The placeholder "$*" can be given (even multiple times) to specify
4234 where the arguments will be included, for example: >
4235 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4236< This option cannot be set from a |modeline| or in the |sandbox|, for
4237 security reasons.
4238
4239 *'matchpairs'* *'mps'*
4240'matchpairs' 'mps' string (default "(:),{:},[:]")
4241 local to buffer
4242 {not in Vi}
4243 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004244 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 must be different. The characters must be separated by a colon. The
4246 pairs must be separated by a comma. Example for including '<' and '>'
4247 (HTML): >
4248 :set mps+=<:>
4249
4250< A more exotic example, to jump between the '=' and ';' in an
4251 assignment, useful for languages like C and Java: >
4252 :au FileType c,cpp,java set mps+==:;
4253
4254< For a more advanced way of using "%", see the matchit.vim plugin in
4255 the $VIMRUNTIME/macros directory. |add-local-help|
4256
4257 *'matchtime'* *'mat'*
4258'matchtime' 'mat' number (default 5)
4259 global
4260 {not in Vi}{in Nvi}
4261 Tenths of a second to show the matching paren, when 'showmatch' is
4262 set. Note that this is not in milliseconds, like other options that
4263 set a time. This is to be compatible with Nvi.
4264
4265 *'maxfuncdepth'* *'mfd'*
4266'maxfuncdepth' 'mfd' number (default 100)
4267 global
4268 {not in Vi}
4269 Maximum depth of function calls for user functions. This normally
4270 catches endless recursion. When using a recursive function with
4271 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4272 more memory, there is the danger of failing when memory is exhausted.
4273 See also |:function|.
4274
4275 *'maxmapdepth'* *'mmd'* *E223*
4276'maxmapdepth' 'mmd' number (default 1000)
4277 global
4278 {not in Vi}
4279 Maximum number of times a mapping is done without resulting in a
4280 character to be used. This normally catches endless mappings, like
4281 ":map x y" with ":map y x". It still does not catch ":map g wg",
4282 because the 'w' is used before the next mapping is done. See also
4283 |key-mapping|.
4284
4285 *'maxmem'* *'mm'*
4286'maxmem' 'mm' number (default between 256 to 5120 (system
4287 dependent) or half the amount of memory
4288 available)
4289 global
4290 {not in Vi}
4291 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4292 limit is reached allocating extra memory for a buffer will cause
4293 other memory to be freed. Maximum value 2000000. Use this to work
4294 without a limit. Also see 'maxmemtot'.
4295
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004296 *'maxmempattern'* *'mmp'*
4297'maxmempattern' 'mmp' number (default 1000)
4298 global
4299 {not in Vi}
4300 Maximum amount of memory (in Kbyte) to use for pattern matching.
4301 Maximum value 2000000. Use this to work without a limit.
4302 *E363*
4303 When Vim runs into the limit it gives an error message mostly behaves
4304 like CTRL-C was typed.
4305 Running into the limit often means that the pattern is very
4306 inefficient or too complex. This may already happen with the pattern
4307 "\(.\)*" on a very long line. ".*" works much better.
4308 Vim may run out of memory before hitting the 'maxmempattern' limit.
4309
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 *'maxmemtot'* *'mmt'*
4311'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4312 dependent) or half the amount of memory
4313 available)
4314 global
4315 {not in Vi}
4316 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004317 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 'maxmem'.
4319
4320 *'menuitems'* *'mis'*
4321'menuitems' 'mis' number (default 25)
4322 global
4323 {not in Vi}
4324 {not available when compiled without the |+menu|
4325 feature}
4326 Maximum number of items to use in a menu. Used for menus that are
4327 generated from a list of items, e.g., the Buffers menu. Changing this
4328 option has no direct effect, the menu must be refreshed first.
4329
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004330 *'mkspellmem'* *'msm'*
4331'mkspellmem' 'msm' string (default "460000,2000,500")
4332 global
4333 {not in Vi}
4334 {not available when compiled without the |+syntax|
4335 feature}
4336 Parameters for |:mkspell|. This tunes when to start compressing the
4337 word tree. Compression can be slow when there are many words, but
4338 it's needed to avoid running out of memory. The amount of memory used
4339 per word depends very much on how similar the words are, that's why
4340 this tuning is complicated.
4341
4342 There are three numbers, separated by commas:
4343 {start},{inc},{added}
4344
4345 For most languages the uncompressed word tree fits in memory. {start}
4346 gives the amount of memory in Kbyte that can be used before any
4347 compression is done. It should be a bit smaller than the amount of
4348 memory that is available to Vim.
4349
4350 When going over the {start} limit the {inc} number specifies the
4351 amount of memory in Kbyte that can be allocated before another
4352 compression is done. A low number means compression is done after
4353 less words are added, which is slow. A high number means more memory
4354 will be allocated.
4355
4356 After doing compression, {added} times 1024 words can be added before
4357 the {inc} limit is ignored and compression is done when any extra
4358 amount of memory is needed. A low number means there is a smaller
4359 chance of hitting the {inc} limit, less memory is used but it's
4360 slower.
4361
4362 The languages for which these numbers are important are Italian and
4363 Hungarian. The default works for when you have about 512 Mbyte. If
4364 you have 1 Gbyte you could use: >
4365 :set mkspellmem=900000,3000,800
4366< If you have less than 512 Mbyte |:mkspell| may fail for some
4367 languages, no matter what you set 'mkspellmem' to.
4368
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4370'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4371 local to buffer
4372 *'modelines'* *'mls'*
4373'modelines' 'mls' number (default 5)
4374 global
4375 {not in Vi}
4376 If 'modeline' is on 'modelines' gives the number of lines that is
4377 checked for set commands. If 'modeline' is off or 'modelines' is zero
4378 no lines are checked. See |modeline|.
4379 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4380 set and to the Vim default value when 'compatible' is reset.
4381
4382 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4383'modifiable' 'ma' boolean (default on)
4384 local to buffer
4385 {not in Vi} *E21*
4386 When off the buffer contents cannot be changed. The 'fileformat' and
4387 'fileencoding' options also can't be changed.
4388 Can be reset with the |-M| command line argument.
4389
4390 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4391'modified' 'mod' boolean (default off)
4392 local to buffer
4393 {not in Vi}
4394 When on, the buffer is considered to be modified. This option is set
4395 when:
4396 1. A change was made to the text since it was last written. Using the
4397 |undo| command to go back to the original text will reset the
4398 option. But undoing changes that were made before writing the
4399 buffer will set the option again, since the text is different from
4400 when it was written.
4401 2. 'fileformat' or 'fileencoding' is different from its original
4402 value. The original value is set when the buffer is read or
4403 written. A ":set nomodified" command also resets the original
4404 values to the current values and the 'modified' option will be
4405 reset.
4406 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4407 will be ignored.
4408
4409 *'more'* *'nomore'*
4410'more' boolean (Vim default: on, Vi default: off)
4411 global
4412 {not in Vi}
4413 When on, listings pause when the whole screen is filled. You will get
4414 the |more-prompt|. When this option is off there are no pauses, the
4415 listing continues until finished.
4416 NOTE: This option is set to the Vi default value when 'compatible' is
4417 set and to the Vim default value when 'compatible' is reset.
4418
4419 *'mouse'* *E538*
4420'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4421 global
4422 {not in Vi}
4423 Enable the use of the mouse. Only works for certain terminals
4424 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4425 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4426 The mouse can be enabled for different modes:
4427 n Normal mode
4428 v Visual mode
4429 i Insert mode
4430 c Command-line mode
4431 h all previous modes when editing a help file
4432 a all previous modes
4433 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 Normally you would enable the mouse in all four modes with: >
4435 :set mouse=a
4436< When the mouse is not enabled, the GUI will still use the mouse for
4437 modeless selection. This doesn't move the text cursor.
4438
4439 See |mouse-using|. Also see |'clipboard'|.
4440
4441 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004442 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 the mouse buttons can still be used by keeping the shift key pressed.
4444 Also see the 'clipboard' option.
4445
4446 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4447'mousefocus' 'mousef' boolean (default off)
4448 global
4449 {not in Vi}
4450 {only works in the GUI}
4451 The window that the mouse pointer is on is automatically activated.
4452 When changing the window layout or window focus in another way, the
4453 mouse pointer is moved to the window with keyboard focus. Off is the
4454 default because it makes using the pull down menus a little goofy, as
4455 a pointer transit may activate a window unintentionally.
4456
4457 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4458'mousehide' 'mh' boolean (default on)
4459 global
4460 {not in Vi}
4461 {only works in the GUI}
4462 When on, the mouse pointer is hidden when characters are typed.
4463 The mouse pointer is restored when the mouse is moved.
4464
4465 *'mousemodel'* *'mousem'*
4466'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4467 global
4468 {not in Vi}
4469 Sets the model to use for the mouse. The name mostly specifies what
4470 the right mouse button is used for:
4471 extend Right mouse button extends a selection. This works
4472 like in an xterm.
4473 popup Right mouse button pops up a menu. The shifted left
4474 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004475 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 popup_setpos Like "popup", but the cursor will be moved to the
4477 position where the mouse was clicked, and thus the
4478 selected operation will act upon the clicked object.
4479 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004480 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 course, that right clicking outside a selection will
4482 end Visual mode.
4483 Overview of what button does what for each model:
4484 mouse extend popup(_setpos) ~
4485 left click place cursor place cursor
4486 left drag start selection start selection
4487 shift-left search word extend selection
4488 right click extend selection popup menu (place cursor)
4489 right drag extend selection -
4490 middle click paste paste
4491
4492 In the "popup" model the right mouse button produces a pop-up menu.
4493 You need to define this first, see |popup-menu|.
4494
4495 Note that you can further refine the meaning of buttons with mappings.
4496 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4497 selection (because that's handled in the GUI code directly).
4498
4499 The 'mousemodel' option is set by the |:behave| command.
4500
4501 *'mouseshape'* *'mouses'* *E547*
4502'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004503 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 global
4505 {not in Vi}
4506 {only available when compiled with the |+mouseshape|
4507 feature}
4508 This option tells Vim what the mouse pointer should look like in
4509 different modes. The option is a comma separated list of parts, much
4510 like used for 'guicursor'. Each part consist of a mode/location-list
4511 and an argument-list:
4512 mode-list:shape,mode-list:shape,..
4513 The mode-list is a dash separated list of these modes/locations:
4514 In a normal window: ~
4515 n Normal mode
4516 v Visual mode
4517 ve Visual mode with 'selection' "exclusive" (same as 'v',
4518 if not specified)
4519 o Operator-pending mode
4520 i Insert mode
4521 r Replace mode
4522
4523 Others: ~
4524 c appending to the command-line
4525 ci inserting in the command-line
4526 cr replacing in the command-line
4527 m at the 'Hit ENTER' or 'More' prompts
4528 ml idem, but cursor in the last line
4529 e any mode, pointer below last window
4530 s any mode, pointer on a status line
4531 sd any mode, while dragging a status line
4532 vs any mode, pointer on a vertical separator line
4533 vd any mode, while dragging a vertical separator line
4534 a everywhere
4535
4536 The shape is one of the following:
4537 avail name looks like ~
4538 w x arrow Normal mouse pointer
4539 w x blank no pointer at all (use with care!)
4540 w x beam I-beam
4541 w x updown up-down sizing arrows
4542 w x leftright left-right sizing arrows
4543 w x busy The system's usual busy pointer
4544 w x no The system's usual 'no input' pointer
4545 x udsizing indicates up-down resizing
4546 x lrsizing indicates left-right resizing
4547 x crosshair like a big thin +
4548 x hand1 black hand
4549 x hand2 white hand
4550 x pencil what you write with
4551 x question big ?
4552 x rightup-arrow arrow pointing right-up
4553 w x up-arrow arrow pointing up
4554 x <number> any X11 pointer number (see X11/cursorfont.h)
4555
4556 The "avail" column contains a 'w' if the shape is available for Win32,
4557 x for X11.
4558 Any modes not specified or shapes not available use the normal mouse
4559 pointer.
4560
4561 Example: >
4562 :set mouseshape=s:udsizing,m:no
4563< will make the mouse turn to a sizing arrow over the status lines and
4564 indicate no input when the hit-enter prompt is displayed (since
4565 clicking the mouse has no effect in this state.)
4566
4567 *'mousetime'* *'mouset'*
4568'mousetime' 'mouset' number (default 500)
4569 global
4570 {not in Vi}
4571 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4572 time in msec between two mouse clicks for the second click to be
4573 recognized as a multi click.
4574
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004575 *'mzquantum'* *'mzq'*
4576'mzquantum' 'mzq' number (default 100)
4577 global
4578 {not in Vi}
4579 {not available when compiled without the |+mzscheme|
4580 feature}
4581 The number of milliseconds between polls for MzScheme threads.
4582 Negative or zero value means no thread scheduling.
4583
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 *'nrformats'* *'nf'*
4585'nrformats' 'nf' string (default "octal,hex")
4586 local to buffer
4587 {not in Vi}
4588 This defines what bases Vim will consider for numbers when using the
4589 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4590 respectively; see |CTRL-A| for more info on these commands.
4591 alpha if included, single alphabetical characters will be
4592 incremented or decremented. This is useful for a list with a
4593 letter index a), b), etc.
4594 octal if included, numbers that start with a zero will be considered
4595 to be octal. Example: Using CTRL-A on "007" results in "010".
4596 hex if included, numbers starting with "0x" or "0X" will be
4597 considered to be hexadecimal. Example: Using CTRL-X on
4598 "0x100" results in "0x0ff".
4599 Numbers which simply begin with a digit in the range 1-9 are always
4600 considered decimal. This also happens for numbers that are not
4601 recognized as octal or hex.
4602
4603 *'number'* *'nu'* *'nonumber'* *'nonu'*
4604'number' 'nu' boolean (default off)
4605 local to window
4606 Print the line number in front of each line. When the 'n' option is
4607 excluded from 'cpoptions' a wrapped line will not use the column of
4608 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004609 The 'numberwidth' option can be used to set the room used for the line
4610 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 When a long, wrapped line doesn't start with the first character, '-'
4612 characters are put before the number.
4613 See |hl-LineNr| for the highlighting used for the number.
4614
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004615 *'numberwidth'* *'nuw'*
4616'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4617 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004618 {not in Vi}
4619 {only available when compiled with the |+linebreak|
4620 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004621 Minimal number of columns to use for the line number. Only relevant
4622 when the 'number' option is set.
4623 Since one space is always between the number and the text, there is
4624 one less character for the number itself.
4625 The value is the minimum width. A bigger width is used when needed to
4626 fit the highest line number in the buffer. Thus with the Vim default
4627 of 4 there is room for a line number up to 999. When the buffer has
4628 1000 lines five columns will be used.
4629 The minimum value is 1, the maximum value is 10.
4630 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4631
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004632 *'omnifunc'* *'ofu'*
4633'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004634 local to buffer
4635 {not in Vi}
4636 {not available when compiled without the +eval
4637 or +insert_expand feature}
4638 This option specifies a function to be used for CTRL-X CTRL-O
4639 completion. |i_CTRL-X_CTRL-O|
4640
4641 For the use of the function see 'completefunc'.
4642
4643
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 *'osfiletype'* *'oft'* *E366*
4645'osfiletype' 'oft' string (RISC-OS default: "Text",
4646 others default: "")
4647 local to buffer
4648 {not in Vi}
4649 {only available when compiled with the |+osfiletype|
4650 feature}
4651 Some operating systems store extra information about files besides
4652 name, datestamp and permissions. This option contains the extra
4653 information, the nature of which will vary between systems.
4654 The value of this option is usually set when the file is loaded, and
4655 use to set the file type when file is written.
4656 It can affect the pattern matching of the automatic commands.
4657 |autocmd-osfiletypes|
4658
4659 *'paragraphs'* *'para'*
4660'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4661 global
4662 Specifies the nroff macros that separate paragraphs. These are pairs
4663 of two letters (see |object-motions|).
4664
4665 *'paste'* *'nopaste'*
4666'paste' boolean (default off)
4667 global
4668 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004669 Put Vim in Paste mode. This is useful if you want to cut or copy
4670 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 unexpected effects.
4672 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004673 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 knows about pasting and will mostly do the right thing without 'paste'
4675 being set. The same is true for a terminal where Vim handles the
4676 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004677 This option is reset when starting the GUI. Thus if you set it in
4678 your .vimrc it will work in a terminal, but not in the GUI. Setting
4679 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4680 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 When the 'paste' option is switched on (also when it was already on):
4682 - mapping in Insert mode and Command-line mode is disabled
4683 - abbreviations are disabled
4684 - 'textwidth' is set to 0
4685 - 'wrapmargin' is set to 0
4686 - 'autoindent' is reset
4687 - 'smartindent' is reset
4688 - 'softtabstop' is set to 0
4689 - 'revins' is reset
4690 - 'ruler' is reset
4691 - 'showmatch' is reset
4692 - 'formatoptions' is used like it is empty
4693 These options keep their value, but their effect is disabled:
4694 - 'lisp'
4695 - 'indentexpr'
4696 - 'cindent'
4697 NOTE: When you start editing another file while the 'paste' option is
4698 on, settings from the modelines or autocommands may change the
4699 settings again, causing trouble when pasting text. You might want to
4700 set the 'paste' option again.
4701 When the 'paste' option is reset the mentioned options are restored to
4702 the value before the moment 'paste' was switched from off to on.
4703 Resetting 'paste' before ever setting it does not have any effect.
4704 Since mapping doesn't work while 'paste' is active, you need to use
4705 the 'pastetoggle' option to toggle the 'paste' option with some key.
4706
4707 *'pastetoggle'* *'pt'*
4708'pastetoggle' 'pt' string (default "")
4709 global
4710 {not in Vi}
4711 When non-empty, specifies the key sequence that toggles the 'paste'
4712 option. This is like specifying a mapping: >
4713 :map {keys} :set invpaste<CR>
4714< Where {keys} is the value of 'pastetoggle'.
4715 The difference is that it will work even when 'paste' is set.
4716 'pastetoggle' works in Insert mode and Normal mode, but not in
4717 Command-line mode.
4718 Mappings are checked first, thus overrule 'pastetoggle'. However,
4719 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4720 this: >
4721 :map <F10> :set paste<CR>
4722 :map <F11> :set nopaste<CR>
4723 :imap <F10> <C-O>:set paste<CR>
4724 :imap <F11> <nop>
4725 :set pastetoggle=<F11>
4726< This will make <F10> start paste mode and <F11> stop paste mode.
4727 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4728 mode everything is inserted literally, except the 'pastetoggle' key
4729 sequence.
4730
4731 *'pex'* *'patchexpr'*
4732'patchexpr' 'pex' string (default "")
4733 global
4734 {not in Vi}
4735 {not available when compiled without the |+diff|
4736 feature}
4737 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004738 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739
4740 *'patchmode'* *'pm'* *E206*
4741'patchmode' 'pm' string (default "")
4742 global
4743 {not in Vi}
4744 When non-empty the oldest version of a file is kept. This can be used
4745 to keep the original version of a file if you are changing files in a
4746 source distribution. Only the first time that a file is written a
4747 copy of the original file will be kept. The name of the copy is the
4748 name of the original file with the string in the 'patchmode' option
4749 appended. This option should start with a dot. Use a string like
4750 ".org". 'backupdir' must not be empty for this to work (Detail: The
4751 backup file is renamed to the patchmode file after the new file has
4752 been successfully written, that's why it must be possible to write a
4753 backup file). If there was no file to be backed up, an empty file is
4754 created.
4755 When the 'backupskip' pattern matches, a patchmode file is not made.
4756 Using 'patchmode' for compressed files appends the extension at the
4757 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4758 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004759 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760
4761 *'path'* *'pa'* *E343* *E345* *E347*
4762'path' 'pa' string (default on Unix: ".,/usr/include,,"
4763 on OS/2: ".,/emx/include,,"
4764 other systems: ".,,")
4765 global or local to buffer |global-local|
4766 {not in Vi}
4767 This is a list of directories which will be searched when using the
4768 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4769 being searched for has a relative path (not starting with '/'). The
4770 directories in the 'path' option may be relative or absolute.
4771 - Use commas to separate directory names: >
4772 :set path=.,/usr/local/include,/usr/include
4773< - Spaces can also be used to separate directory names (for backwards
4774 compatibility with version 3.0). To have a space in a directory
4775 name, precede it with an extra backslash, and escape the space: >
4776 :set path=.,/dir/with\\\ space
4777< - To include a comma in a directory name precede it with an extra
4778 backslash: >
4779 :set path=.,/dir/with\\,comma
4780< - To search relative to the directory of the current file, use: >
4781 :set path=.
4782< - To search in the current directory use an empty string between two
4783 commas: >
4784 :set path=,,
4785< - A directory name may end in a ':' or '/'.
4786 - Environment variables are expanded |:set_env|.
4787 - When using |netrw.vim| URLs can be used. For example, adding
4788 "http://www.vim.org" will make ":find index.html" work.
4789 - Search upwards and downwards in a directory tree:
4790 1) "*" matches a sequence of characters, e.g.: >
4791 :set path=/usr/include/*
4792< means all subdirectories in /usr/include (but not /usr/include
4793 itself). >
4794 :set path=/usr/*c
4795< matches /usr/doc and /usr/src.
4796 2) "**" matches a subtree, up to 100 directories deep. Example: >
4797 :set path=/home/user_x/src/**
4798< means search in the whole subtree under "/home/usr_x/src".
4799 3) If the path ends with a ';', this path is the startpoint
4800 for upward search.
4801 See |file-searching| for more info and exact syntax.
4802 {not available when compiled without the |+path_extra| feature}
4803 - Careful with '\' characters, type two to get one in the option: >
4804 :set path=.,c:\\include
4805< Or just use '/' instead: >
4806 :set path=.,c:/include
4807< Don't forget "." or files won't even be found in the same directory as
4808 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004809 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 it is something like 256 or 1024 characters.
4811 You can check if all the include files are found, using the value of
4812 'path', see |:checkpath|.
4813 The use of |:set+=| and |:set-=| is preferred when adding or removing
4814 directories from the list. This avoids problems when a future version
4815 uses another default. To remove the current directory use: >
4816 :set path-=
4817< To add the current directory use: >
4818 :set path+=
4819< To use an environment variable, you probably need to replace the
4820 separator. Here is an example to append $INCL, in which directory
4821 names are separated with a semi-colon: >
4822 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4823< Replace the ';' with a ':' or whatever separator is used. Note that
4824 this doesn't work when $INCL contains a comma or white space.
4825
4826 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4827'preserveindent' 'pi' boolean (default off)
4828 local to buffer
4829 {not in Vi}
4830 When changing the indent of the current line, preserve as much of the
4831 indent structure as possible. Normally the indent is replaced by a
4832 series of tabs followed by spaces as required (unless |'expandtab'| is
4833 enabled, in which case only spaces are used). Enabling this option
4834 means the indent will preserve as many existing characters as possible
4835 for indenting, and only add additional tabs or spaces as required.
4836 NOTE: When using ">>" multiple times the resulting indent is a mix of
4837 tabs and spaces. You might not like this.
4838 NOTE: 'preserveindent' is reset when 'compatible' is set.
4839 Also see 'copyindent'.
4840 Use |:retab| to clean up white space.
4841
4842 *'previewheight'* *'pvh'*
4843'previewheight' 'pvh' number (default 12)
4844 global
4845 {not in Vi}
4846 {not available when compiled without the |+windows| or
4847 |+quickfix| feature}
4848 Default height for a preview window. Used for |:ptag| and associated
4849 commands. Used for |CTRL-W_}| when no count is given.
4850
4851 *'previewwindow'* *'nopreviewwindow'*
4852 *'pvw'* *'nopvw'* *E590*
4853'previewwindow' 'pvw' boolean (default off)
4854 local to window
4855 {not in Vi}
4856 {not available when compiled without the |+windows| or
4857 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004858 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 set. It's normally not set directly, but by using one of the commands
4860 |:ptag|, |:pedit|, etc.
4861
4862 *'printdevice'* *'pdev'*
4863'printdevice' 'pdev' string (default empty)
4864 global
4865 {not in Vi}
4866 {only available when compiled with the |+printer|
4867 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004868 The name of the printer to be used for |:hardcopy|.
4869 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004870 This option cannot be set from a |modeline| or in the |sandbox|, for
4871 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872
Bram Moolenaar8299df92004-07-10 09:47:34 +00004873 *'printencoding'* *'penc'*
4874'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 global
4876 {not in Vi}
4877 {only available when compiled with the |+printer|
4878 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004879 Sets the character encoding used when printing.
4880 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 *'printexpr'* *'pexpr'*
4883'printexpr' 'pexpr' String (default: see below)
4884 global
4885 {not in Vi}
4886 {only available when compiled with the |+printer|
4887 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004888 Expression used to print the PostScript produced with |:hardcopy|.
4889 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890
Bram Moolenaar8299df92004-07-10 09:47:34 +00004891 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892'printfont' 'pfn' string (default "courier")
4893 global
4894 {not in Vi}
4895 {only available when compiled with the |+printer|
4896 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004897 The name of the font that will be used for |:hardcopy|.
4898 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
4900 *'printheader'* *'pheader'*
4901'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4902 global
4903 {not in Vi}
4904 {only available when compiled with the |+printer|
4905 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004906 The format of the header produced in |:hardcopy| output.
4907 See |pheader-option|.
4908
4909 *'printmbcharset'* *'pmbcs'*
4910'printmbcharset' 'pmbcs' string (default "")
4911 global
4912 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004913 {only available when compiled with the |+printer|,
4914 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004915 The CJK character set to be used for CJK output from |:hardcopy|.
4916 See |pmbcs-option|.
4917
4918 *'printmbfont'* *'pmbfn'*
4919'printmbfont' 'pmbfn' string (default "")
4920 global
4921 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004922 {only available when compiled with the |+printer|,
4923 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004924 List of font names to be used for CJK output from |:hardcopy|.
4925 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926
4927 *'printoptions'* *'popt'*
4928'printoptions' 'popt' string (default "")
4929 global
4930 {not in Vi}
4931 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004932 List of items that control the format of the output of |:hardcopy|.
4933 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004934
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004935 *'prompt'* *'noprompt'*
4936'prompt' boolean (default on)
4937 global
4938 When on a ":" prompt is used in Ex mode.
4939
Bram Moolenaar677ee682005-01-27 14:41:15 +00004940 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004941'quoteescape' 'qe' string (default "\")
4942 local to buffer
4943 {not in Vi}
4944 The characters that are used to escape quotes in a string. Used for
4945 objects like a', a" and a` |a'|.
4946 When one of the characters in this option is found inside a string,
4947 the following character will be skipped. The default value makes the
4948 text "foo\"bar\\" considered to be one string.
4949
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4951'readonly' 'ro' boolean (default off)
4952 local to buffer
4953 If on, writes fail unless you use a '!'. Protects you from
4954 accidentally overwriting a file. Default on when Vim is started
4955 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004956 When using ":w!" the 'readonly' option is reset for the current
4957 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004959 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960
4961 *'remap'* *'noremap'*
4962'remap' boolean (default on)
4963 global
4964 Allows for mappings to work recursively. If you do not want this for
4965 a single entry, use the :noremap[!] command.
4966
4967 *'report'*
4968'report' number (default 2)
4969 global
4970 Threshold for reporting number of lines changed. When the number of
4971 changed lines is more than 'report' a message will be given for most
4972 ":" commands. If you want it always, set 'report' to 0.
4973 For the ":substitute" command the number of substitutions is used
4974 instead of the number of lines.
4975
4976 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4977'restorescreen' 'rs' boolean (default on)
4978 global
4979 {not in Vi} {only in Windows 95/NT console version}
4980 When set, the screen contents is restored when exiting Vim. This also
4981 happens when executing external commands.
4982
4983 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4984 options in your .vimrc. To disable restoring:
4985 set t_ti= t_te=
4986 To enable restoring (for an xterm):
4987 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4988 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4989
4990 *'revins'* *'ri'* *'norevins'* *'nori'*
4991'revins' 'ri' boolean (default off)
4992 global
4993 {not in Vi}
4994 {only available when compiled with the |+rightleft|
4995 feature}
4996 Inserting characters in Insert mode will work backwards. See "typing
4997 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4998 command in Insert mode, when 'allowrevins' is set.
4999 NOTE: This option is reset when 'compatible' or 'paste' is set.
5000
5001 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5002'rightleft' 'rl' boolean (default off)
5003 local to window
5004 {not in Vi}
5005 {only available when compiled with the |+rightleft|
5006 feature}
5007 When on, display orientation becomes right-to-left, i.e., characters
5008 that are stored in the file appear from the right to the left.
5009 Using this option, it is possible to edit files for languages that
5010 are written from the right to the left such as Hebrew and Arabic.
5011 This option is per window, so it is possible to edit mixed files
5012 simultaneously, or to view the same file in both ways (this is
5013 useful whenever you have a mixed text file with both right-to-left
5014 and left-to-right strings so that both sets are displayed properly
5015 in different windows). Also see |rileft.txt|.
5016
5017 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5018'rightleftcmd' 'rlc' string (default "search")
5019 local to window
5020 {not in Vi}
5021 {only available when compiled with the |+rightleft|
5022 feature}
5023 Each word in this option enables the command line editing to work in
5024 right-to-left mode for a group of commands:
5025
5026 search "/" and "?" commands
5027
5028 This is useful for languages such as Hebrew, Arabic and Farsi.
5029 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5030
5031 *'ruler'* *'ru'* *'noruler'* *'noru'*
5032'ruler' 'ru' boolean (default off)
5033 global
5034 {not in Vi}
5035 {not available when compiled without the
5036 |+cmdline_info| feature}
5037 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005038 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 text in the file is shown on the far right:
5040 Top first line is visible
5041 Bot last line is visible
5042 All first and last line are visible
5043 45% relative position in the file
5044 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005045 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005047 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 this option takes precedence over 'ruler' and 'rulerformat'
5049 If the number of characters displayed is different from the number of
5050 bytes in the text (e.g., for a TAB or a multi-byte character), both
5051 the text column (byte number) and the screen column are shown,
5052 separated with a dash.
5053 For an empty line "0-1" is shown.
5054 For an empty buffer the line number will also be zero: "0,0-1".
5055 This option is reset when the 'paste' option is set.
5056 If you don't want to see the ruler all the time but want to know where
5057 you are, use "g CTRL-G" |g_CTRL-G|.
5058 NOTE: This option is reset when 'compatible' is set.
5059
5060 *'rulerformat'* *'ruf'*
5061'rulerformat' 'ruf' string (default empty)
5062 global
5063 {not in Vi}
5064 {not available when compiled without the |+statusline|
5065 feature}
5066 When this option is not empty, it determines the content of the ruler
5067 string, as displayed for the 'ruler' option.
5068 The format of this option, is like that of 'statusline'.
5069 The default ruler width is 17 characters. To make the ruler 15
5070 characters wide, put "%15(" at the start and "%)" at the end.
5071 Example: >
5072 :set rulerformat=%15(%c%V\ %p%%%)
5073<
5074 *'runtimepath'* *'rtp'* *vimfiles*
5075'runtimepath' 'rtp' string (default:
5076 Unix: "$HOME/.vim,
5077 $VIM/vimfiles,
5078 $VIMRUNTIME,
5079 $VIM/vimfiles/after,
5080 $HOME/.vim/after"
5081 Amiga: "home:vimfiles,
5082 $VIM/vimfiles,
5083 $VIMRUNTIME,
5084 $VIM/vimfiles/after,
5085 home:vimfiles/after"
5086 PC, OS/2: "$HOME/vimfiles,
5087 $VIM/vimfiles,
5088 $VIMRUNTIME,
5089 $VIM/vimfiles/after,
5090 $HOME/vimfiles/after"
5091 Macintosh: "$VIM:vimfiles,
5092 $VIMRUNTIME,
5093 $VIM:vimfiles:after"
5094 RISC-OS: "Choices:vimfiles,
5095 $VIMRUNTIME,
5096 Choices:vimfiles/after"
5097 VMS: "sys$login:vimfiles,
5098 $VIM/vimfiles,
5099 $VIMRUNTIME,
5100 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005101 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 global
5103 {not in Vi}
5104 This is a list of directories which will be searched for runtime
5105 files:
5106 filetype.vim filetypes by file name |new-filetype|
5107 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005108 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 colors/ color scheme files |:colorscheme|
5110 compiler/ compiler files |:compiler|
5111 doc/ documentation |write-local-help|
5112 ftplugin/ filetype plugins |write-filetype-plugin|
5113 indent/ indent scripts |indent-expression|
5114 keymap/ key mapping files |mbyte-keymap|
5115 lang/ menu translations |:menutrans|
5116 menu.vim GUI menus |menu.vim|
5117 plugin/ plugin scripts |write-plugin|
5118 print/ files for printing |postscript-print-encoding|
5119 syntax/ syntax files |mysyntaxfile|
5120 tutor/ files for vimtutor |tutor|
5121
5122 And any other file searched for with the |:runtime| command.
5123
5124 The defaults for most systems are setup to search five locations:
5125 1. In your home directory, for your personal preferences.
5126 2. In a system-wide Vim directory, for preferences from the system
5127 administrator.
5128 3. In $VIMRUNTIME, for files distributed with Vim.
5129 *after-directory*
5130 4. In the "after" directory in the system-wide Vim directory. This is
5131 for the system administrator to overrule or add to the distributed
5132 defaults (rarely needed)
5133 5. In the "after" directory in your home directory. This is for
5134 personal preferences to overrule or add to the distributed defaults
5135 or system-wide settings (rarely needed).
5136
5137 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5138 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005139 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 wildcards.
5141 See |:runtime|.
5142 Example: >
5143 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5144< This will use the directory "~/vimruntime" first (containing your
5145 personal Vim runtime files), then "/mygroup/vim" (shared between a
5146 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5147 files).
5148 You probably should always include $VIMRUNTIME somewhere, to use the
5149 distributed runtime files. You can put a directory before $VIMRUNTIME
5150 to find files which replace a distributed runtime files. You can put
5151 a directory after $VIMRUNTIME to find files which add to distributed
5152 runtime files.
5153 This option cannot be set from a |modeline| or in the |sandbox|, for
5154 security reasons.
5155
5156 *'scroll'* *'scr'*
5157'scroll' 'scr' number (default: half the window height)
5158 local to window
5159 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5160 set to half the number of lines in the window when the window size
5161 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005162 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5164 the number of screen lines instead of file lines, makes a difference
5165 when lines wrap}
5166
5167 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5168'scrollbind' 'scb' boolean (default off)
5169 local to window
5170 {not in Vi}
5171 {not available when compiled without the |+scrollbind|
5172 feature}
5173 See also |scroll-binding|. When this option is set, the current
5174 window scrolls as other scrollbind windows (windows that also have
5175 this option set) scroll. This option is useful for viewing the
5176 differences between two versions of a file, see 'diff'.
5177 See |'scrollopt'| for options that determine how this option should be
5178 interpreted.
5179 This option is mostly reset when splitting a window to edit another
5180 file. This means that ":split | edit file" results in two windows
5181 with scroll-binding, but ":split file" does not.
5182
5183 *'scrolljump'* *'sj'*
5184'scrolljump' 'sj' number (default 1)
5185 global
5186 {not in Vi}
5187 Minimal number of lines to scroll when the cursor gets off the
5188 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5189 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005190 When set to a negative number from -1 to -100 this is used as the
5191 percentage of the window height. Thus -50 scrolls half the window
5192 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 NOTE: This option is set to 1 when 'compatible' is set.
5194
5195 *'scrolloff'* *'so'*
5196'scrolloff' 'so' number (default 0)
5197 global
5198 {not in Vi}
5199 Minimal number of screen lines to keep above and below the cursor.
5200 This will make some context visible around where you are working. If
5201 you set it to a very large value (999) the cursor line will always be
5202 in the middle of the window (except at the start or end of the file or
5203 when long lines wrap).
5204 For scrolling horizontally see 'sidescrolloff'.
5205 NOTE: This option is set to 0 when 'compatible' is set.
5206
5207 *'scrollopt'* *'sbo'*
5208'scrollopt' 'sbo' string (default "ver,jump")
5209 global
5210 {not available when compiled without the |+scrollbind|
5211 feature}
5212 {not in Vi}
5213 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005214 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5215 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 The following words are available:
5217 ver Bind vertical scrolling for 'scrollbind' windows
5218 hor Bind horizontal scrolling for 'scrollbind' windows
5219 jump Applies to the offset between two windows for vertical
5220 scrolling. This offset is the difference in the first
5221 displayed line of the bound windows. When moving
5222 around in a window, another 'scrollbind' window may
5223 reach a position before the start or after the end of
5224 the buffer. The offset is not changed though, when
5225 moving back the 'scrollbind' window will try to scroll
5226 to the desired position when possible.
5227 When now making that window the current one, two
5228 things can be done with the relative offset:
5229 1. When "jump" is not included, the relative offset is
5230 adjusted for the scroll position in the new current
5231 window. When going back to the other window, the
5232 the new relative offset will be used.
5233 2. When "jump" is included, the other windows are
5234 scrolled to keep the same relative offset. When
5235 going back to the other window, it still uses the
5236 same relative offset.
5237 Also see |scroll-binding|.
5238
5239 *'sections'* *'sect'*
5240'sections' 'sect' string (default "SHNHH HUnhsh")
5241 global
5242 Specifies the nroff macros that separate sections. These are pairs of
5243 two letters (See |object-motions|). The default makes a section start
5244 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5245
5246 *'secure'* *'nosecure'* *E523*
5247'secure' boolean (default off)
5248 global
5249 {not in Vi}
5250 When on, ":autocmd", shell and write commands are not allowed in
5251 ".vimrc" and ".exrc" in the current directory and map commands are
5252 displayed. Switch it off only if you know that you will not run into
5253 problems, or when the 'exrc' option is off. On Unix this option is
5254 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005255 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256 'secure' at the end of your ~/.vimrc then.
5257 This option cannot be set from a |modeline| or in the |sandbox|, for
5258 security reasons.
5259
5260 *'selection'* *'sel'*
5261'selection' 'sel' string (default "inclusive")
5262 global
5263 {not in Vi}
5264 This option defines the behavior of the selection. It is only used
5265 in Visual and Select mode.
5266 Possible values:
5267 value past line inclusive ~
5268 old no yes
5269 inclusive yes yes
5270 exclusive yes no
5271 "past line" means that the cursor is allowed to be positioned one
5272 character past the line.
5273 "inclusive" means that the last character of the selection is included
5274 in an operation. For example, when "x" is used to delete the
5275 selection.
5276 Note that when "exclusive" is used and selecting from the end
5277 backwards, you cannot include the last character of a line, when
5278 starting in Normal mode and 'virtualedit' empty.
5279
5280 The 'selection' option is set by the |:behave| command.
5281
5282 *'selectmode'* *'slm'*
5283'selectmode' 'slm' string (default "")
5284 global
5285 {not in Vi}
5286 This is a comma separated list of words, which specifies when to start
5287 Select mode instead of Visual mode, when a selection is started.
5288 Possible values:
5289 mouse when using the mouse
5290 key when using shifted special keys
5291 cmd when using "v", "V" or CTRL-V
5292 See |Select-mode|.
5293 The 'selectmode' option is set by the |:behave| command.
5294
5295 *'sessionoptions'* *'ssop'*
5296'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5297 help,options,winsize")
5298 global
5299 {not in Vi}
5300 {not available when compiled without the +mksession
5301 feature}
5302 Changes the effect of the |:mksession| command. It is a comma
5303 separated list of words. Each word enables saving and restoring
5304 something:
5305 word save and restore ~
5306 blank empty windows
5307 buffers hidden and unloaded buffers, not just those in windows
5308 curdir the current directory
5309 folds manually created folds, opened/closed folds and local
5310 fold options
5311 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005312 and contain at least one lowercase letter. Only
5313 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314 help the help window
5315 localoptions options and mappings local to a window or buffer (not
5316 global values for local options)
5317 options all options and mappings (also global values for local
5318 options)
5319 resize size of the Vim window: 'lines' and 'columns'
5320 sesdir the directory in which the session file is located
5321 will become the current directory (useful with
5322 projects accessed over a network from different
5323 systems)
5324 slash backslashes in file names replaced with forward
5325 slashes
5326 unix with Unix end-of-line format (single <NL>), even when
5327 on Windows or DOS
5328 winpos position of the whole Vim window
5329 winsize window sizes
5330
5331 Don't include both "curdir" and "sesdir".
5332 When "curdir" nor "sesdir" is included, file names are stored with
5333 absolute paths.
5334 "slash" and "unix" are useful on Windows when sharing session files
5335 with Unix. The Unix version of Vim cannot source dos format scripts,
5336 but the Windows version of Vim can source unix format scripts.
5337
5338 *'shell'* *'sh'* *E91*
5339'shell' 'sh' string (default $SHELL or "sh",
5340 MS-DOS and Win32: "command.com" or
5341 "cmd.exe", OS/2: "cmd")
5342 global
5343 Name of the shell to use for ! and :! commands. When changing the
5344 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5345 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005346 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 See |option-backslash| about including spaces and backslashes.
5348 Environment variables are expanded |:set_env|.
5349 If the name of the shell contains a space, you might need to enclose
5350 it in quotes. Example: >
5351 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5352< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005353 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 "-f" is not inside the quotes, because it is not part of the command
5355 name. And Vim automagically recognizes the backslashes that are path
5356 separators.
5357 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5358 variable to change the way external commands are executed. See the
5359 libc.inf file of DJGPP.
5360 Under MS-Windows, when the executable ends in ".com" it must be
5361 included. Thus setting the shell to "command.com" or "4dos.com"
5362 works, but "command" and "4dos" do not work for all commands (e.g.,
5363 filtering).
5364 For unknown reasons, when using "4dos.com" the current directory is
5365 changed to "C:\". To avoid this set 'shell' like this: >
5366 :set shell=command.com\ /c\ 4dos
5367< This option cannot be set from a |modeline| or in the |sandbox|, for
5368 security reasons.
5369
5370 *'shellcmdflag'* *'shcf'*
5371'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5372 does not contain "sh" somewhere: "/c")
5373 global
5374 {not in Vi}
5375 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5376 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5377 systems, the default is set according to the value of 'shell', to
5378 reduce the need to set this option by the user. It's not used for
5379 OS/2 (EMX figures this out itself). See |option-backslash| about
5380 including spaces and backslashes. See |dos-shell|.
5381 This option cannot be set from a |modeline| or in the |sandbox|, for
5382 security reasons.
5383
5384 *'shellpipe'* *'sp'*
5385'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5386 global
5387 {not in Vi}
5388 {not available when compiled without the |+quickfix|
5389 feature}
5390 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005391 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 including spaces and backslashes.
5393 The name of the temporary file can be represented by "%s" if necessary
5394 (the file name is appended automatically if no %s appears in the value
5395 of this option).
5396 For the Amiga and MS-DOS the default is ">". The output is directly
5397 saved in a file and not echoed to the screen.
5398 For Unix the default it "| tee". The stdout of the compiler is saved
5399 in a file and echoed to the screen. If the 'shell' option is "csh" or
5400 "tcsh" after initializations, the default becomes "|& tee". If the
5401 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5402 "2>&1| tee". This means that stderr is also included.
5403 The initialization of this option is done after reading the ".vimrc"
5404 and the other initializations, so that when the 'shell' option is set
5405 there, the 'shellpipe' option changes automatically, unless it was
5406 explicitly set before.
5407 When 'shellpipe' is set to an empty string, no redirection of the
5408 ":make" output will be done. This is useful if you use a 'makeprg'
5409 that writes to 'makeef' by itself. If you want no piping, but do
5410 want to include the 'makeef', set 'shellpipe' to a single space.
5411 Don't forget to precede the space with a backslash: ":set sp=\ ".
5412 In the future pipes may be used for filtering and this option will
5413 become obsolete (at least for Unix).
5414 This option cannot be set from a |modeline| or in the |sandbox|, for
5415 security reasons.
5416
5417 *'shellquote'* *'shq'*
5418'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5419 contains "sh" somewhere: "\"")
5420 global
5421 {not in Vi}
5422 Quoting character(s), put around the command passed to the shell, for
5423 the "!" and ":!" commands. The redirection is kept outside of the
5424 quoting. See 'shellxquote' to include the redirection. It's
5425 probably not useful to set both options.
5426 This is an empty string by default. Only known to be useful for
5427 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5428 or bash, where it should be "\"". The default is adjusted according
5429 the value of 'shell', to reduce the need to set this option by the
5430 user. See |dos-shell|.
5431 This option cannot be set from a |modeline| or in the |sandbox|, for
5432 security reasons.
5433
5434 *'shellredir'* *'srr'*
5435'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5436 global
5437 {not in Vi}
5438 String to be used to put the output of a filter command in a temporary
5439 file. See also |:!|. See |option-backslash| about including spaces
5440 and backslashes.
5441 The name of the temporary file can be represented by "%s" if necessary
5442 (the file name is appended automatically if no %s appears in the value
5443 of this option).
5444 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5445 or "zsh" during initializations, the default becomes ">&". If the
5446 'shell' option is "sh", "ksh" or "bash" the default becomes
5447 ">%s 2>&1". This means that stderr is also included.
5448 For Win32, the Unix checks are done and additionally "cmd" is checked
5449 for, which makes the default ">%s 2>&1". Also, the same names with
5450 ".exe" appended are checked for.
5451 The initialization of this option is done after reading the ".vimrc"
5452 and the other initializations, so that when the 'shell' option is set
5453 there, the 'shellredir' option changes automatically unless it was
5454 explicitly set before.
5455 In the future pipes may be used for filtering and this option will
5456 become obsolete (at least for Unix).
5457 This option cannot be set from a |modeline| or in the |sandbox|, for
5458 security reasons.
5459
5460 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5461'shellslash' 'ssl' boolean (default off)
5462 global
5463 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5464 When set, a forward slash is used when expanding file names. This is
5465 useful when a Unix-like shell is used instead of command.com or
5466 cmd.exe. Backward slashes can still be typed, but they are changed to
5467 forward slashes by Vim.
5468 Note that setting or resetting this option has no effect for some
5469 existing file names, thus this option needs to be set before opening
5470 any file for best results. This might change in the future.
5471 'shellslash' only works when a backslash can be used as a path
5472 separator. To test if this is so use: >
5473 if exists('+shellslash')
5474<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005475 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5476'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5477 global
5478 {not in Vi}
5479 When on, use temp files for shell commands. When off use a pipe.
5480 When using a pipe is not possible temp files are used anyway.
5481 Currently a pipe is only supported on Unix. You can check it with: >
5482 :if has("filterpipe")
5483< The advantage of using a pipe is that nobody can read the temp file
5484 and the 'shell' command does not need to support redirection.
5485 The advantage of using a temp file is that the file type and encoding
5486 can be detected.
5487 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5488 |FilterWritePost| autocommands event are not triggered when
5489 'shelltemp' is off.
5490
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 *'shelltype'* *'st'*
5492'shelltype' 'st' number (default 0)
5493 global
5494 {not in Vi} {only for the Amiga}
5495 On the Amiga this option influences the way how the commands work
5496 which use a shell.
5497 0 and 1: always use the shell
5498 2 and 3: use the shell only to filter lines
5499 4 and 5: use shell only for ':sh' command
5500 When not using the shell, the command is executed directly.
5501
5502 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5503 1 and 3: use "shell cmd" to start external commands
5504
5505 *'shellxquote'* *'sxq'*
5506'shellxquote' 'sxq' string (default: "";
5507 for Win32, when 'shell' contains "sh"
5508 somewhere: "\""
5509 for Unix, when using system(): "\"")
5510 global
5511 {not in Vi}
5512 Quoting character(s), put around the command passed to the shell, for
5513 the "!" and ":!" commands. Includes the redirection. See
5514 'shellquote' to exclude the redirection. It's probably not useful
5515 to set both options.
5516 This is an empty string by default. Known to be useful for
5517 third-party shells when using the Win32 version, such as the MKS Korn
5518 Shell or bash, where it should be "\"". The default is adjusted
5519 according the value of 'shell', to reduce the need to set this option
5520 by the user. See |dos-shell|.
5521 This option cannot be set from a |modeline| or in the |sandbox|, for
5522 security reasons.
5523
5524 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5525'shiftround' 'sr' boolean (default off)
5526 global
5527 {not in Vi}
5528 Round indent to multiple of 'shiftwidth'. Applies to > and <
5529 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5530 a multiple of 'shiftwidth' (this is Vi compatible).
5531 NOTE: This option is reset when 'compatible' is set.
5532
5533 *'shiftwidth'* *'sw'*
5534'shiftwidth' 'sw' number (default 8)
5535 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005536 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 |'cindent'|, |>>|, |<<|, etc.
5538
5539 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005540'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5541 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 global
5543 {not in Vi}
5544 This option helps to avoid all the |hit-enter| prompts caused by file
5545 messages, for example with CTRL-G, and to avoid some other messages.
5546 It is a list of flags:
5547 flag meaning when present ~
5548 f use "(3 of 5)" instead of "(file 3 of 5)"
5549 i use "[noeol]" instead of "[Incomplete last line]"
5550 l use "999L, 888C" instead of "999 lines, 888 characters"
5551 m use "[+]" instead of "[Modified]"
5552 n use "[New]" instead of "[New File]"
5553 r use "[RO]" instead of "[readonly]"
5554 w use "[w]" instead of "written" for file write message
5555 and "[a]" instead of "appended" for ':w >> file' command
5556 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5557 "[unix format]" and "[mac]" instead of "[mac format]".
5558 a all of the above abbreviations
5559
5560 o overwrite message for writing a file with subsequent message
5561 for reading a file (useful for ":wn" or when 'autowrite' on)
5562 O message for reading a file overwrites any previous message.
5563 Also for quickfix message (e.g., ":cn").
5564 s don't give "search hit BOTTOM, continuing at TOP" or "search
5565 hit TOP, continuing at BOTTOM" messages
5566 t truncate file message at the start if it is too long to fit
5567 on the command-line, "<" will appear in the left most column.
5568 Ignored in Ex mode.
5569 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005570 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 Ignored in Ex mode.
5572 W don't give "written" or "[w]" when writing a file
5573 A don't give the "ATTENTION" message when an existing swap file
5574 is found.
5575 I don't give the intro message when starting Vim |:intro|.
5576
5577 This gives you the opportunity to avoid that a change between buffers
5578 requires you to hit <Enter>, but still gives as useful a message as
5579 possible for the space available. To get the whole message that you
5580 would have got with 'shm' empty, use ":file!"
5581 Useful values:
5582 shm= No abbreviation of message.
5583 shm=a Abbreviation, but no loss of information.
5584 shm=at Abbreviation, and truncate message when necessary.
5585
5586 NOTE: This option is set to the Vi default value when 'compatible' is
5587 set and to the Vim default value when 'compatible' is reset.
5588
5589 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5590'shortname' 'sn' boolean (default off)
5591 local to buffer
5592 {not in Vi, not in MS-DOS versions}
5593 Filenames are assumed to be 8 characters plus one extension of 3
5594 characters. Multiple dots in file names are not allowed. When this
5595 option is on, dots in file names are replaced with underscores when
5596 adding an extension (".~" or ".swp"). This option is not available
5597 for MS-DOS, because then it would always be on. This option is useful
5598 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5599 or crossdos. When running the Win32 GUI version under Win32s, this
5600 option is always on by default.
5601
5602 *'showbreak'* *'sbr'* *E595*
5603'showbreak' 'sbr' string (default "")
5604 global
5605 {not in Vi}
5606 {not available when compiled without the |+linebreak|
5607 feature}
5608 String to put at the start of lines that have been wrapped. Useful
5609 values are "> " or "+++ ".
5610 Only printable single-cell characters are allowed, excluding <Tab> and
5611 comma (in a future version the comma might be used to separate the
5612 part that is shown at the end and at the start of a line).
5613 The characters are highlighted according to the '@' flag in
5614 'highlight'.
5615 Note that tabs after the showbreak will be displayed differently.
5616 If you want the 'showbreak' to appear in between line numbers, add the
5617 "n" flag to 'cpoptions'.
5618
5619 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5620'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5621 off)
5622 global
5623 {not in Vi}
5624 {not available when compiled without the
5625 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005626 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 terminal is slow.
5628 In Visual mode the size of the selected area is shown:
5629 - When selecting characters within a line, the number of characters.
5630 - When selecting more than one line, the number of lines.
5631 - When selecting a block, the size in screen characters: linesxcolumns.
5632 NOTE: This option is set to the Vi default value when 'compatible' is
5633 set and to the Vim default value when 'compatible' is reset.
5634
5635 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5636'showfulltag' 'sft' boolean (default off)
5637 global
5638 {not in Vi}
5639 When completing a word in insert mode (see |ins-completion|) from the
5640 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005641 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 matched a C function, you can see a template for what arguments are
5643 required (coding style permitting).
5644
5645 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5646'showmatch' 'sm' boolean (default off)
5647 global
5648 When a bracket is inserted, briefly jump to the matching one. The
5649 jump is only done if the match can be seen on the screen. The time to
5650 show the match can be set with 'matchtime'.
5651 A Beep is given if there is no match (no matter if the match can be
5652 seen or not). This option is reset when the 'paste' option is set.
5653 When the 'm' flag is not included in 'cpoptions', typing a character
5654 will immediately move the cursor back to where it belongs.
5655 See the "sm" field in 'guicursor' for setting the cursor shape and
5656 blinking when showing the match.
5657 The 'matchpairs' option can be used to specify the characters to show
5658 matches for. 'rightleft' and 'revins' are used to look for opposite
5659 matches.
5660 Note: For the use of the short form parental guidance is advised.
5661
5662 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5663'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5664 global
5665 If in Insert, Replace or Visual mode put a message on the last line.
5666 Use the 'M' flag in 'highlight' to set the type of highlighting for
5667 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005668 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 doesn't mean XIM is really active, especially when 'imactivatekey' is
5670 not set.
5671 NOTE: This option is set to the Vi default value when 'compatible' is
5672 set and to the Vim default value when 'compatible' is reset.
5673
5674 *'sidescroll'* *'ss'*
5675'sidescroll' 'ss' number (default 0)
5676 global
5677 {not in Vi}
5678 The minimal number of columns to scroll horizontally. Used only when
5679 the 'wrap' option is off and the cursor is moved off of the screen.
5680 When it is zero the cursor will be put in the middle of the screen.
5681 When using a slow terminal set it to a large number or 0. When using
5682 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5683 commands.
5684
5685 *'sidescrolloff'* *'siso'*
5686'sidescrolloff' 'siso' number (default 0)
5687 global
5688 {not in Vi}
5689 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005690 right of the cursor if 'nowrap' is set. Setting this option to a
5691 value greater than 0 while having |'sidescroll'| also at a non-zero
5692 value makes some context visible in the line you are scrolling in
5693 horizontally (except at beginning of the line). Setting this option
5694 to a large value (like 999) has the effect of keeping the cursor
5695 horizontally centered in the window, as long as one does not come too
5696 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 NOTE: This option is set to 0 when 'compatible' is set.
5698
5699 Example: Try this together with 'sidescroll' and 'listchars' as
5700 in the following example to never allow the cursor to move
5701 onto the "extends" character:
5702
5703 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5704 :set sidescrolloff=1
5705
5706
5707 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5708'smartcase' 'scs' boolean (default off)
5709 global
5710 {not in Vi}
5711 Override the 'ignorecase' option if the search pattern contains upper
5712 case characters. Only used when the search pattern is typed and
5713 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005714 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5716 recalling the search pattern from history and hitting <Enter>.
5717 NOTE: This option is reset when 'compatible' is set.
5718
5719 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5720'smartindent' 'si' boolean (default off)
5721 local to buffer
5722 {not in Vi}
5723 {not available when compiled without the
5724 |+smartindent| feature}
5725 Do smart autoindenting when starting a new line. Works for C-like
5726 programs, but can also be used for other languages. 'cindent' does
5727 something like this, works better in most cases, but is more strict,
5728 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5729 'indentexpr' is a more advanced alternative.
5730 Normally 'autoindent' should also be on when using 'smartindent'.
5731 An indent is automatically inserted:
5732 - After a line ending in '{'.
5733 - After a line starting with a keyword from 'cinwords'.
5734 - Before a line starting with '}' (only with the "O" command).
5735 When typing '}' as the first character in a new line, that line is
5736 given the same indent as the matching '{'.
5737 When typing '#' as the first character in a new line, the indent for
5738 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005739 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5741 When using the ">>" command, lines starting with '#' are not shifted
5742 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005743 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005744 is set smart indenting is disabled.
5745
5746 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5747'smarttab' 'sta' boolean (default off)
5748 global
5749 {not in Vi}
5750 When on, a <Tab> in front of a line inserts blanks according to
5751 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5752 a 'shiftwidth' worth of space at the start of the line.
5753 When off a <Tab> always inserts blanks according to 'tabstop'.
5754 'shiftwidth' is only used for shifting text left or right
5755 |shift-left-right|.
5756 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5757 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005758 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 NOTE: This option is reset when 'compatible' is set.
5760
5761 *'softtabstop'* *'sts'*
5762'softtabstop' 'sts' number (default 0)
5763 local to buffer
5764 {not in Vi}
5765 Number of spaces that a <Tab> counts for while performing editing
5766 operations, like inserting a <Tab> or using <BS>. It "feels" like
5767 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5768 used. This is useful to keep the 'ts' setting at its standard value
5769 of 8, while being able to edit like it is set to 'sts'. However,
5770 commands like "x" still work on the actual characters.
5771 When 'sts' is zero, this feature is off.
5772 'softtabstop' is set to 0 when the 'paste' option is set.
5773 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5774 spaces is minimized by using <Tab>s.
5775 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5776 set.
5777 NOTE: This option is set to 0 when 'compatible' is set.
5778
Bram Moolenaar217ad922005-03-20 22:37:15 +00005779 *'spell'* *'nospell'*
5780'spell' boolean (default off)
5781 local to window
5782 {not in Vi}
5783 {not available when compiled without the |+syntax|
5784 feature}
5785 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005786 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005787
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005788 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005789'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005790 local to buffer
5791 {not in Vi}
5792 {not available when compiled without the |+syntax|
5793 feature}
5794 Pattern to locate the end of a sentence. The following word will be
5795 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005796 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005797 When this check is not wanted make this option empty.
5798 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005799 Be careful with special characters, see |option-backslash| about
5800 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005801 To set this option automatically depending on the language, see
5802 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005803
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005804 *'spellfile'* *'spf'*
5805'spellfile' 'spf' string (default empty)
5806 local to buffer
5807 {not in Vi}
5808 {not available when compiled without the |+syntax|
5809 feature}
5810 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005811 commands. It must end in ".{encoding}.add". You need to include the
5812 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005813 *E765*
5814 It may also be a comma separated list of names. A count before the
5815 |zg| and |zw| commands can be used to access each. This allows using
5816 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005817 When a word is added while this option is empty Vim will set it for
5818 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005819 writable and the first language name that appears in 'spelllang',
5820 ignoring the region.
5821 The resulting ".spl" file will be used for spell checking, it does not
5822 have to appear in 'spelllang'.
5823 Normally one file is used for all regions, but you can add the region
5824 name if you want to. However, it will then only be used when
5825 'spellfile' is set to it, for entries in 'spelllang' only files
5826 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005829
Bram Moolenaar217ad922005-03-20 22:37:15 +00005830 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005831'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005832 local to buffer
5833 {not in Vi}
5834 {not available when compiled without the |+syntax|
5835 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005836 A comma separated list of word list names. When the 'spell' option is
5837 on spellchecking will be done for these languages. Example: >
5838 set spelllang=en_us,nl,medical
5839< This means US English, Dutch and medical words are recognized. Words
5840 that are not recognized will be highlighted.
5841 The word list name must not include a comma or dot. Using a dash is
5842 recommended to separate the two letter language name from a
5843 specification. Thus "en-rare" is used for rare English words.
5844 A region name must come last and have the form "_xx", where "xx" is
5845 the two-letter, lower case region name. You can use more than one
5846 region by listing them: "en_us,en_ca" supports both US and Canadian
5847 English, but not words specific for Australia, New Zealand or Great
5848 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005849 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005850 As a special case the name of a .spl file can be given as-is. The
5851 first "_xx" in the name is removed and used as the region name
5852 (_xx is an underscore, two letters and followed by a non-letter).
5853 This is mainly for testing purposes. You must make sure the correct
5854 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005855 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005856 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5857 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005858 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005859
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005860 After this option has been set successfully, Vim will source the files
5861 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5862 up to the first comma, dot or underscore. See |set-spc-auto|.
5863
5864
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005865 *'spellsuggest'* *'sps'*
5866'spellsuggest' 'sps' string (default "best")
5867 global
5868 {not in Vi}
5869 {not available when compiled without the |+syntax|
5870 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005871 Methods used for spelling suggestions. Both for the |z?| command and
5872 the |spellsuggest()| function. This is a comma-separated list of
5873 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005874
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005875 best Internal method that works best for English. Finds
5876 changes like "fast" and uses a bit of sound-a-like
5877 scoring to improve the ordering.
5878
5879 double Internal method that uses two methods and mixes the
5880 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005881 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005882 word. That only works when the language specifies
5883 sound folding. Can be slow and doesn't always give
5884 better results.
5885
5886 fast Internal method that only checks for simple changes:
5887 character inserts/deletes/swaps. Works well for
5888 simple typing mistakes.
5889
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005890 {number} The maximum number of suggestions listed for |z?|.
5891 Not used for |spellsuggest()|. The number of
5892 suggestions is never more than the value of 'lines'
5893 minus two.
5894
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005895 file:{filename} Read file {filename}, which must have two columns,
5896 separated by a slash. The first column contains the
5897 bad word, the second column the suggested good word.
5898 Example:
5899 theribal/terrible ~
5900 Use this for common mistakes that do not appear at the
5901 top of the suggestion list with the internal methods.
5902 Lines without a slash are ignored, use this for
5903 comments.
5904 The file is used for all languages.
5905
5906 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5907 trouble with spaces. |v:val| holds the badly spelled
5908 word. The expression must evaluate to a List of
5909 Lists, each with a suggestion and a score.
5910 Example:
5911 [['the', 33], ['that', 44]]
5912 Set 'verbose' and use |z?| to see the scores that the
5913 internal methods use. A lower score is better.
5914 This may invoke |spellsuggest()| if you temporarily
5915 set 'spellsuggest' to exclude the "expr:" part.
5916 Errors are silently ignored, unless you set the
5917 'verbose' option to a non-zero value.
5918
5919 Only one of "best", "double" or "fast" may be used. The others may
5920 appear several times in any order. Example: >
5921 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5922<
5923 This option cannot be set from a |modeline| or in the |sandbox|, for
5924 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005925
5926
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5928'splitbelow' 'sb' boolean (default off)
5929 global
5930 {not in Vi}
5931 {not available when compiled without the +windows
5932 feature}
5933 When on, splitting a window will put the new window below the current
5934 one. |:split|
5935
5936 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5937'splitright' 'spr' boolean (default off)
5938 global
5939 {not in Vi}
5940 {not available when compiled without the +vertsplit
5941 feature}
5942 When on, splitting a window will put the new window right of the
5943 current one. |:vsplit|
5944
5945 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5946'startofline' 'sol' boolean (default on)
5947 global
5948 {not in Vi}
5949 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005950 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005951 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005952 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005953 with a linewise operator, with "%" with a count and to buffer changing
5954 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5955 only has a line number, e.g., ":25" or ":+".
5956 In case of buffer changing commands the cursor is placed at the column
5957 where it was the last time the buffer was edited.
5958 NOTE: This option is set when 'compatible' is set.
5959
5960 *'statusline'* *'stl'* *E540* *E541* *E542*
5961'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005962 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 {not in Vi}
5964 {not available when compiled without the |+statusline|
5965 feature}
5966 When nonempty, this option determines the content of the status line.
5967 Also see |status-line|.
5968
5969 The option consists of printf style '%' items interspersed with
5970 normal text. Each status line item is of the form:
5971 %-0{minwid}.{maxwid}{item}
5972 All fields except the {item} is optional. A single percent sign can
5973 be given as "%%". Up to 80 items can be specified.
5974
5975 Note that the only effect of 'ruler' when this option is set (and
5976 'laststatus' is 2) is controlling the output of |CTRL-G|.
5977
5978 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005979 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005981 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 minwid Minimum width of the item, padding as set by '-' & '0'.
5983 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005984 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005985 on the left for text items. Numeric items will be
5986 shifted down to maxwid-2 digits followed by '>'number
5987 where number is the amount of missing digits, much like
5988 an exponential notation.
5989 item A one letter code as described below.
5990
5991 Following is a description of the possible statusline items. The
5992 second character in "item" is the type:
5993 N for number
5994 S for string
5995 F for flags as described below
5996 - not applicable
5997
5998 item meaning ~
5999 f S Path to the file in the buffer, relative to current directory.
6000 F S Full path to the file in the buffer.
6001 t S File name (tail) of file in the buffer.
6002 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6003 M F Modified flag, text is ",+" or ",-".
6004 r F Readonly flag, text is " [RO]".
6005 R F Readonly flag, text is ",RO".
6006 h F Help buffer flag, text is " [help]".
6007 H F Help buffer flag, text is ",HLP".
6008 w F Preview window flag, text is " [Preview]".
6009 W F Preview window flag, text is ",PRV".
6010 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6011 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6012 {not available when compiled without |+autocmd| feature}
6013 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6014 being used: "<keymap>"
6015 n N Buffer number.
6016 b N Value of byte under cursor.
6017 B N As above, in hexadecimal.
6018 o N Byte number in file of byte under cursor, first byte is 1.
6019 Mnemonic: Offset from start of file (with one added)
6020 {not available when compiled without |+byte_offset| feature}
6021 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006022 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006023 l N Line number.
6024 L N Number of lines in buffer.
6025 c N Column number.
6026 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006027 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 p N Percentage through file in lines as in |CTRL-G|.
6029 P S Percentage through file of displayed window. This is like the
6030 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006031 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 Empty if the argument file count is zero or one.
6033 { NF Evaluate expression between '{' and '}' and substitute result.
6034 ( - Start of item group. Can be used for setting the width and
6035 alignment of a section. Must be followed by %) somewhere.
6036 ) - End of item group. No width fields allowed.
6037 < - Where to truncate line if too long. Default is at the start.
6038 No width fields allowed.
6039 = - Separation point between left and right aligned items.
6040 No width fields allowed.
6041 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006042 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006043 The difference between User{N} and StatusLine will be applied
6044 to StatusLineNC for the statusline of non-current windows.
6045 The number N must be between 1 and 9. See |hl-User1..9|
6046
6047 Display of flags are controlled by the following heuristic:
6048 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006049 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 with a space it is assumed that it wants to separate itself from
6051 anything but other flags. That is: A leading comma is removed if the
6052 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006053 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 make a nice display when flags are used like in the examples below.
6055
Bram Moolenaar582fd852005-03-28 20:58:01 +00006056 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 not set) and a minwid is not set for the group, the whole group will
6058 become empty. This will make a group like the following disappear
6059 completely from the statusline when none of the flags are set. >
6060 :set statusline=...%(\ [%M%R%H]%)...
6061<
6062 Beware that an expression is evaluated each and every time the status
6063 line is displayed. The current buffer and current window will be set
6064 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006065 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6067 real current buffer. The expression is evaluated in the |sandbox|.
6068
6069 If the statusline is not updated when you want it (e.g., after setting
6070 a variable that's used in an expression), you can force an update by
6071 setting an option without changing its value. Example: >
6072 :let &ro = &ro
6073
6074< A result of all digits is regarded a number for display purposes.
6075 Otherwise the result is taken as flag text and applied to the rules
6076 described above.
6077
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006078 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6080 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6081
6082 Examples:
6083 Emulate standard status line with 'ruler' set >
6084 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6085< Similar, but add ASCII value of char under the cursor (like "ga") >
6086 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6087< Display byte count and byte value, modified flag in red. >
6088 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6089 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6090< Display a ,GZ flag if a compressed file is loaded >
6091 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6092< In the |:autocmd|'s: >
6093 :let b:gzflag = 1
6094< And: >
6095 :unlet b:gzflag
6096< And define this function: >
6097 :function VarExists(var, val)
6098 : if exists(a:var) | return a:val | else | return '' | endif
6099 :endfunction
6100<
6101 *'suffixes'* *'su'*
6102'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6103 global
6104 {not in Vi}
6105 Files with these suffixes get a lower priority when multiple files
6106 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006107 suffixes. Spaces after the comma are ignored. A dot is also seen as
6108 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 separator, precede it with a backslash (see |option-backslash| about
6110 including spaces and backslashes).
6111 See 'wildignore' for completely ignoring files.
6112 The use of |:set+=| and |:set-=| is preferred when adding or removing
6113 suffixes from the list. This avoids problems when a future version
6114 uses another default.
6115
6116 *'suffixesadd'* *'sua'*
6117'suffixesadd' 'sua' string (default "")
6118 local to buffer
6119 {not in Vi}
6120 {not available when compiled without the
6121 |+file_in_path| feature}
6122 Comma separated list of suffixes, which are used when searching for a
6123 file for the "gf", "[I", etc. commands. Example: >
6124 :set suffixesadd=.java
6125<
6126 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6127'swapfile' 'swf' boolean (default on)
6128 local to buffer
6129 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006130 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 swapfile is not wanted for a specific buffer. For example, with
6132 confidential information that even root must not be able to access.
6133 Careful: All text will be in memory:
6134 - Don't use this for big files.
6135 - Recovery will be impossible!
6136 A swapfile will only be present when |'updatecount'| is non-zero and
6137 'swapfile' is set.
6138 When 'swapfile' is reset, the swap file for the current buffer is
6139 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6140 non-zero, a swap file is immediately created.
6141 Also see |swap-file| and |'swapsync'|.
6142
6143 This option is used together with 'bufhidden' and 'buftype' to
6144 specify special kinds of buffers. See |special-buffers|.
6145
6146 *'swapsync'* *'sws'*
6147'swapsync' 'sws' string (default "fsync")
6148 global
6149 {not in Vi}
6150 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006151 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006152 When this option is empty parts of the swap file may be in memory and
6153 not written to disk. When the system crashes you may lose more work.
6154 On Unix the system does a sync now and then without Vim asking for it,
6155 so the disadvantage of setting this option off is small. On some
6156 systems the swap file will not be written at all. For a unix system
6157 setting it to "sync" will use the sync() call instead of the default
6158 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006159 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006160
6161 *'switchbuf'* *'swb'*
6162'switchbuf' 'swb' string (default "")
6163 global
6164 {not in Vi}
6165 This option controls the behavior when switching between buffers.
6166 Possible values (comma separated list):
6167 useopen If included, jump to the first open window that
6168 contains the specified buffer (if there is one).
6169 Otherwise: Do not examine other windows.
6170 This setting is checked with |quickfix| commands, when
6171 jumping to errors (":cc", ":cn", "cp", etc.). It is
6172 also used in all buffer related split commands, for
6173 example ":sbuffer", ":sbnext", or ":sbrewind".
6174 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006175 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 Supported in |quickfix| commands that display errors.
6177
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006178 *'synmaxcol'* *'smc'*
6179'synmaxcol' 'smc' number (default 3000)
6180 local to buffer
6181 {not in Vi}
6182 {not available when compiled without the |+syntax|
6183 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006184 Maximum column in which to search for syntax items. In long lines the
6185 text after this column is not highlighted and following lines may not
6186 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006187 This helps to avoid very slow redrawing for an XML file that is one
6188 long line.
6189 Set to zero to remove the limit.
6190
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 *'syntax'* *'syn'*
6192'syntax' 'syn' string (default empty)
6193 local to buffer
6194 {not in Vi}
6195 {not available when compiled without the |+syntax|
6196 feature}
6197 When this option is set, the syntax with this name is loaded, unless
6198 syntax highlighting has been switched off with ":syntax off".
6199 Otherwise this option does not always reflect the current syntax (the
6200 b:current_syntax variable does).
6201 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006202 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 /* vim: set syntax=idl : */
6204< To switch off syntax highlighting for the current file, use: >
6205 :set syntax=OFF
6206< To switch syntax highlighting on according to the current value of the
6207 'filetype' option: >
6208 :set syntax=ON
6209< What actually happens when setting the 'syntax' option is that the
6210 Syntax autocommand event is triggered with the value as argument.
6211 This option is not copied to another buffer, independent of the 's' or
6212 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006213 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214
6215 *'tabstop'* *'ts'*
6216'tabstop' 'ts' number (default 8)
6217 local to buffer
6218 Number of spaces that a <Tab> in the file counts for. Also see
6219 |:retab| command, and 'softtabstop' option.
6220
6221 Note: Setting 'tabstop' to any other value than 8 can make your file
6222 appear wrong in many places (e.g., when printing it).
6223
6224 There are four main ways to use tabs in Vim:
6225 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6226 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6227 will use a mix of tabs and spaces, but typing Tab and BS will
6228 behave like a tab appears every 4 (or 3) characters.
6229 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6230 'expandtab'. This way you will always insert spaces. The
6231 formatting will never be messed up when 'tabstop' is changed.
6232 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006233 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 works when using Vim to edit the file.
6235 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6236 'noexpandtab'. This should then work (for initial indents only)
6237 for any tabstop setting that people use. It might be nice to have
6238 tabs after the first non-blank inserted as spaces if you do this
6239 though. Otherwise aligned comments will be wrong when 'tabstop' is
6240 changed.
6241
6242 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6243'tagbsearch' 'tbs' boolean (default on)
6244 global
6245 {not in Vi}
6246 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006247 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 searching makes searching for a tag a LOT faster, but a linear search
6249 will find more tags if the tags file wasn't properly sorted.
6250 Vim normally assumes that your tags files are sorted, or indicate that
6251 they are not sorted. Only when this is not the case does the
6252 'tagbsearch' option need to be switched off.
6253
6254 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006255 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006256 certain files, or retry all files with a linear search. When
6257 'tagbsearch' is off, only a linear search is done.
6258
6259 Linear searching is done anyway, for one file, when Vim finds a line
6260 at the start of the file indicating that it's not sorted: >
6261 !_TAG_FILE_SORTED 0 /some command/
6262< [The whitespace before and after the '0' must be a single <Tab>]
6263
6264 When a binary search was done and no match was found in any of the
6265 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6266 instead of a normal tag name, a retry is done with a linear search.
6267 Tags in unsorted tags files, and matches with different case will only
6268 be found in the retry.
6269
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006270 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 linear search can be avoided for the 'ignorecase' case. Use a value
6272 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6273 case-fold sorted with the -f switch to "sort" in most unices, as in
6274 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6275 5.3 or higher the -f or --fold-case-sort switch can be used for this
6276 as well. Note that case must be folded to uppercase for this to work.
6277
6278 When 'tagbsearch' is off, tags searching is slower when a full match
6279 exists, but faster when no full match exists. Tags in unsorted tags
6280 files may only be found with 'tagbsearch' off.
6281 When the tags file is not sorted, or sorted in a wrong way (not on
6282 ASCII byte value), 'tagbsearch' should be off, or the line given above
6283 must be included in the tags file.
6284 This option doesn't affect commands that find all matching tags (e.g.,
6285 command-line completion and ":help").
6286 {Vi: always uses binary search in some versions}
6287
6288 *'taglength'* *'tl'*
6289'taglength' 'tl' number (default 0)
6290 global
6291 If non-zero, tags are significant up to this number of characters.
6292
6293 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6294'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6295 global
6296 {not in Vi}
6297 If on and using a tag file in another directory, file names in that
6298 tag file are relative to the directory where the tag file is.
6299 NOTE: This option is set to the Vi default value when 'compatible' is
6300 set and to the Vim default value when 'compatible' is reset.
6301
6302 *'tags'* *'tag'* *E433*
6303'tags' 'tag' string (default "./tags,tags", when compiled with
6304 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6305 global or local to buffer |global-local|
6306 Filenames for the tag command, separated by spaces or commas. To
6307 include a space or comma in a file name, precede it with a backslash
6308 (see |option-backslash| about including spaces and backslashes).
6309 When a file name starts with "./", the '.' is replaced with the path
6310 of the current file. But only when the 'd' flag is not included in
6311 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6312 |tags-option|.
6313 "*", "**" and other wildcards can be used to search for tags files in
6314 a directory tree. See |file-searching|. {not available when compiled
6315 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006316 The |tagfiles()| function can be used to get a list of the file names
6317 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6319 files are also supported. They are automatically recognized. The
6320 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6321 differences are ignored (MS-Windows). |emacs-tags|
6322 The use of |:set+=| and |:set-=| is preferred when adding or removing
6323 file names from the list. This avoids problems when a future version
6324 uses another default.
6325 {Vi: default is "tags /usr/lib/tags"}
6326
6327 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6328'tagstack' 'tgst' boolean (default on)
6329 global
6330 {not in all versions of Vi}
6331 When on, the |tagstack| is used normally. When off, a ":tag" or
6332 ":tselect" command with an argument will not push the tag onto the
6333 tagstack. A following ":tag" without an argument, a ":pop" command or
6334 any other command that uses the tagstack will use the unmodified
6335 tagstack, but does change the pointer to the active entry.
6336 Resetting this option is useful when using a ":tag" command in a
6337 mapping which should not change the tagstack.
6338
6339 *'term'* *E529* *E530* *E531*
6340'term' string (default is $TERM, if that fails:
6341 in the GUI: "builtin_gui"
6342 on Amiga: "amiga"
6343 on BeOS: "beos-ansi"
6344 on Mac: "mac-ansi"
6345 on MiNT: "vt52"
6346 on MS-DOS: "pcterm"
6347 on OS/2: "os2ansi"
6348 on Unix: "ansi"
6349 on VMS: "ansi"
6350 on Win 32: "win32")
6351 global
6352 Name of the terminal. Used for choosing the terminal control
6353 characters. Environment variables are expanded |:set_env|.
6354 For example: >
6355 :set term=$TERM
6356< See |termcap|.
6357
6358 *'termbidi'* *'tbidi'*
6359 *'notermbidi'* *'notbidi'*
6360'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6361 global
6362 {not in Vi}
6363 {only available when compiled with the |+arabic|
6364 feature}
6365 The terminal is in charge of Bi-directionality of text (as specified
6366 by Unicode). The terminal is also expected to do the required shaping
6367 that some languages (such as Arabic) require.
6368 Setting this option implies that 'rightleft' will not be set when
6369 'arabic' is set and the value of 'arabicshape' will be ignored.
6370 Note that setting 'termbidi' has the immediate effect that
6371 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6372 This option is reset when the GUI is started.
6373 For further details see |arabic.txt|.
6374
6375 *'termencoding'* *'tenc'*
6376'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6377 Macintosh GUI: "macroman")
6378 global
6379 {only available when compiled with the |+multi_byte|
6380 feature}
6381 {not in Vi}
6382 Encoding used for the terminal. This specifies what character
6383 encoding the keyboard produces and the display will understand. For
6384 the GUI it only applies to the keyboard ('encoding' is used for the
6385 display).
6386 In the Win32 console version the default value is the console codepage
6387 when it differs from the ANSI codepage.
6388 *E617*
6389 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6390 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6391 Any attempts to set a different value will be rejected, and an error
6392 message is shown.
6393 For the Win32 GUI 'termencoding' is not used for typed characters,
6394 because the Win32 system always passes Unicode characters.
6395 When empty, the same encoding is used as for the 'encoding' option.
6396 This is the normal value.
6397 Not all combinations for 'termencoding' and 'encoding' are valid. See
6398 |encoding-table|.
6399 The value for this option must be supported by internal conversions or
6400 iconv(). When this is not possible no conversion will be done and you
6401 will probably experience problems with non-ASCII characters.
6402 Example: You are working with the locale set to euc-jp (Japanese) and
6403 want to edit a UTF-8 file: >
6404 :let &termencoding = &encoding
6405 :set encoding=utf-8
6406< You need to do this when your system has no locale support for UTF-8.
6407
6408 *'terse'* *'noterse'*
6409'terse' boolean (default off)
6410 global
6411 When set: Add 's' flag to 'shortmess' option (this makes the message
6412 for a search that hits the start or end of the file not being
6413 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6414 shortens a lot of messages}
6415
6416 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6417'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6418 global
6419 {not in Vi}
6420 This option is obsolete. Use 'fileformats'.
6421 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6422 set to the default value for the current system. When 'textauto' is
6423 reset, 'fileformats' is made empty.
6424 NOTE: This option is set to the Vi default value when 'compatible' is
6425 set and to the Vim default value when 'compatible' is reset.
6426
6427 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6428'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6429 others: default off)
6430 local to buffer
6431 {not in Vi}
6432 This option is obsolete. Use 'fileformat'.
6433 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6434 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6435 "unix".
6436
6437 *'textwidth'* *'tw'*
6438'textwidth' 'tw' number (default 0)
6439 local to buffer
6440 {not in Vi}
6441 Maximum width of text that is being inserted. A longer line will be
6442 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006443 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6444 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 'formatoptions' and |ins-textwidth|.
6446 NOTE: This option is set to 0 when 'compatible' is set.
6447
6448 *'thesaurus'* *'tsr'*
6449'thesaurus' 'tsr' string (default "")
6450 global or local to buffer |global-local|
6451 {not in Vi}
6452 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006453 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 the file should contain words with similar meaning, separated by
6455 non-keyword characters (white space is preferred). Maximum line
6456 length is 510 bytes.
6457 To obtain a file to be used here, check out the wordlist FAQ at
6458 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006459 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 after a comma are ignored, otherwise spaces are included in the file
6461 name. See |option-backslash| about using backslashes.
6462 The use of |:set+=| and |:set-=| is preferred when adding or removing
6463 directories from the list. This avoids problems when a future version
6464 uses another default.
6465 Backticks cannot be used in this option for security reasons.
6466
6467 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6468'tildeop' 'top' boolean (default off)
6469 global
6470 {not in Vi}
6471 When on: The tilde command "~" behaves like an operator.
6472 NOTE: This option is reset when 'compatible' is set.
6473
6474 *'timeout'* *'to'* *'notimeout'* *'noto'*
6475'timeout' 'to' boolean (default on)
6476 global
6477 *'ttimeout'* *'nottimeout'*
6478'ttimeout' boolean (default off)
6479 global
6480 {not in Vi}
6481 These two options together determine the behavior when part of a
6482 mapped key sequence or keyboard code has been received:
6483
6484 'timeout' 'ttimeout' action ~
6485 off off do not time out
6486 on on or off time out on :mappings and key codes
6487 off on time out on key codes
6488
6489 If both options are off, Vim will wait until either the complete
6490 mapping or key sequence has been received, or it is clear that there
6491 is no mapping or key sequence for the received characters. For
6492 example: if you have mapped "vl" and Vim has received 'v', the next
6493 character is needed to see if the 'v' is followed by an 'l'.
6494 When one of the options is on, Vim will wait for about 1 second for
6495 the next character to arrive. After that the already received
6496 characters are interpreted as single characters. The waiting time can
6497 be changed with the 'timeoutlen' option.
6498 On slow terminals or very busy systems timing out may cause
6499 malfunctioning cursor keys. If both options are off, Vim waits
6500 forever after an entered <Esc> if there are key codes that start
6501 with <Esc>. You will have to type <Esc> twice. If you do not have
6502 problems with key codes, but would like to have :mapped key
6503 sequences not timing out in 1 second, set the 'ttimeout' option and
6504 reset the 'timeout' option.
6505
6506 NOTE: 'ttimeout' is reset when 'compatible' is set.
6507
6508 *'timeoutlen'* *'tm'*
6509'timeoutlen' 'tm' number (default 1000)
6510 global
6511 {not in all versions of Vi}
6512 *'ttimeoutlen'* *'ttm'*
6513'ttimeoutlen' 'ttm' number (default -1)
6514 global
6515 {not in Vi}
6516 The time in milliseconds that is waited for a key code or mapped key
6517 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6518 when part of a command has been typed.
6519 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6520 different timeout value for key codes is desired set 'ttimeoutlen' to
6521 a non-negative number.
6522
6523 ttimeoutlen mapping delay key code delay ~
6524 < 0 'timeoutlen' 'timeoutlen'
6525 >= 0 'timeoutlen' 'ttimeoutlen'
6526
6527 The timeout only happens when the 'timeout' and 'ttimeout' options
6528 tell so. A useful setting would be >
6529 :set timeout timeoutlen=3000 ttimeoutlen=100
6530< (time out on mapping after three seconds, time out on key codes after
6531 a tenth of a second).
6532
6533 *'title'* *'notitle'*
6534'title' boolean (default off, on when title can be restored)
6535 global
6536 {not in Vi}
6537 {not available when compiled without the |+title|
6538 feature}
6539 When on, the title of the window will be set to the value of
6540 'titlestring' (if it is not empty), or to:
6541 filename [+=-] (path) - VIM
6542 Where:
6543 filename the name of the file being edited
6544 - indicates the file cannot be modified, 'ma' off
6545 + indicates the file was modified
6546 = indicates the file is read-only
6547 =+ indicates the file is read-only and modified
6548 (path) is the path of the file being edited
6549 - VIM the server name |v:servername| or "VIM"
6550 Only works if the terminal supports setting window titles
6551 (currently Amiga console, Win32 console, all GUI versions and
6552 terminals with a non- empty 't_ts' option - these are Unix xterm and
6553 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6554 *X11*
6555 When Vim was compiled with HAVE_X11 defined, the original title will
6556 be restored if possible. The output of ":version" will include "+X11"
6557 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6558 works for the icon name |'icon'|.
6559 But: When Vim was started with the |-X| argument, restoring the title
6560 will not work (except in the GUI).
6561 If the title cannot be restored, it is set to the value of 'titleold'.
6562 You might want to restore the title outside of Vim then.
6563 When using an xterm from a remote machine you can use this command:
6564 rsh machine_name xterm -display $DISPLAY &
6565 then the WINDOWID environment variable should be inherited and the
6566 title of the window should change back to what it should be after
6567 exiting Vim.
6568
6569 *'titlelen'*
6570'titlelen' number (default 85)
6571 global
6572 {not in Vi}
6573 {not available when compiled without the |+title|
6574 feature}
6575 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006576 title. When the title is longer, only the end of the path name is
6577 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 Using a percentage makes this adapt to the width of the window. But
6579 it won't work perfectly, because the actual number of characters
6580 available also depends on the font used and other things in the title
6581 bar. When 'titlelen' is zero the full path is used. Otherwise,
6582 values from 1 to 30000 percent can be used.
6583 'titlelen' is also used for the 'titlestring' option.
6584
6585 *'titleold'*
6586'titleold' string (default "Thanks for flying Vim")
6587 global
6588 {not in Vi}
6589 {only available when compiled with the |+title|
6590 feature}
6591 This option will be used for the window title when exiting Vim if the
6592 original title cannot be restored. Only happens if 'title' is on or
6593 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006594 This option cannot be set from a |modeline| or in the |sandbox|, for
6595 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 *'titlestring'*
6597'titlestring' string (default "")
6598 global
6599 {not in Vi}
6600 {not available when compiled without the |+title|
6601 feature}
6602 When this option is not empty, it will be used for the title of the
6603 window. This happens only when the 'title' option is on.
6604 Only works if the terminal supports setting window titles (currently
6605 Amiga console, Win32 console, all GUI versions and terminals with a
6606 non-empty 't_ts' option).
6607 When Vim was compiled with HAVE_X11 defined, the original title will
6608 be restored if possible |X11|.
6609 When this option contains printf-style '%' items, they will be
6610 expanded according to the rules used for 'statusline'.
6611 Example: >
6612 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6613 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6614< The value of 'titlelen' is used to align items in the middle or right
6615 of the available space.
6616 Some people prefer to have the file name first: >
6617 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6618< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006619 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 separating space only when needed.
6621 NOTE: Use of special characters in 'titlestring' may cause the display
6622 to be garbled (e.g., when it contains a CR or NL character).
6623 {not available when compiled without the |+statusline| feature}
6624
6625 *'toolbar'* *'tb'*
6626'toolbar' 'tb' string (default "icons,tooltips")
6627 global
6628 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6629 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006630 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 possible values are:
6632 icons Toolbar buttons are shown with icons.
6633 text Toolbar buttons shown with text.
6634 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006635 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 tooltips Tooltips are active for toolbar buttons.
6637 Tooltips refer to the popup help text which appears after the mouse
6638 cursor is placed over a toolbar button for a brief moment.
6639
6640 If you want the toolbar to be shown with icons as well as text, do the
6641 following: >
6642 :set tb=icons,text
6643< Motif and Athena cannot display icons and text at the same time. They
6644 will show icons if both are requested.
6645
6646 If none of the strings specified in 'toolbar' are valid or if
6647 'toolbar' is empty, this option is ignored. If you want to disable
6648 the toolbar, you need to set the 'guioptions' option. For example: >
6649 :set guioptions-=T
6650< Also see |gui-toolbar|.
6651
6652 *'toolbariconsize'* *'tbis'*
6653'toolbariconsize' 'tbis' string (default "small")
6654 global
6655 {not in Vi}
6656 {only in the GTK+ 2 GUI}
6657 Controls the size of toolbar icons. The possible values are:
6658 tiny Use tiny toolbar icons.
6659 small Use small toolbar icons (default).
6660 medium Use medium-sized toolbar icons.
6661 large Use large toolbar icons.
6662 The exact dimensions in pixels of the various icon sizes depend on
6663 the current theme. Common dimensions are large=32x32, medium=24x24,
6664 small=20x20 and tiny=16x16.
6665
6666 If 'toolbariconsize' is empty, the global default size as determined
6667 by user preferences or the current theme is used.
6668
6669 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6670'ttybuiltin' 'tbi' boolean (default on)
6671 global
6672 {not in Vi}
6673 When on, the builtin termcaps are searched before the external ones.
6674 When off the builtin termcaps are searched after the external ones.
6675 When this option is changed, you should set the 'term' option next for
6676 the change to take effect, for example: >
6677 :set notbi term=$TERM
6678< See also |termcap|.
6679 Rationale: The default for this option is "on", because the builtin
6680 termcap entries are generally better (many systems contain faulty
6681 xterm entries...).
6682
6683 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6684'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6685 sun-cmd, screen, rxvt, dtterm or
6686 iris-ansi; also on when running Vim in
6687 a DOS console)
6688 global
6689 {not in Vi}
6690 Indicates a fast terminal connection. More characters will be sent to
6691 the screen for redrawing, instead of using insert/delete line
6692 commands. Improves smoothness of redrawing when there are multiple
6693 windows and the terminal does not support a scrolling region.
6694 Also enables the extra writing of characters at the end of each screen
6695 line for lines that wrap. This helps when using copy/paste with the
6696 mouse in an xterm and other terminals.
6697
6698 *'ttymouse'* *'ttym'*
6699'ttymouse' 'ttym' string (default depends on 'term')
6700 global
6701 {not in Vi}
6702 {only in Unix and VMS, doesn't work in the GUI; not
6703 available when compiled without |+mouse|}
6704 Name of the terminal type for which mouse codes are to be recognized.
6705 Currently these three strings are valid:
6706 *xterm-mouse*
6707 xterm xterm-like mouse handling. The mouse generates
6708 "<Esc>[Mscr", where "scr" is three bytes:
6709 "s" = button state
6710 "c" = column plus 33
6711 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006712 This only works up to 223 columns! See "dec" for a
6713 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 xterm2 Works like "xterm", but with the xterm reporting the
6715 mouse position while the mouse is dragged. This works
6716 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006717 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 work. See below for how Vim detects this
6719 automatically.
6720 *netterm-mouse*
6721 netterm NetTerm mouse handling. The mouse generates
6722 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6723 for the row and column.
6724 *dec-mouse*
6725 dec DEC terminal mouse handling. The mouse generates a
6726 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006727 This is also available for an Xterm, if it was
6728 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 *jsbterm-mouse*
6730 jsbterm JSB term mouse handling.
6731 *pterm-mouse*
6732 pterm QNX pterm mouse handling.
6733
6734 The mouse handling must be enabled at compile time |+mouse_xterm|
6735 |+mouse_dec| |+mouse_netterm|.
6736 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6737 recognized, if enabled at compile time. DEC terminal mouse codes
6738 are recognized if enabled at compile time, and 'ttymouse' is not
6739 "xterm" (because the xterm and dec mouse codes conflict).
6740 This option is automatically set to "xterm", when the 'term' option is
6741 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6742 or "xterm2" already. The main use of this option is to set it to
6743 "xterm", when the terminal name doesn't start with "xterm", but it can
6744 handle xterm mouse codes.
6745 The "xterm2" value will be set if the xterm version is reported to be
6746 95 of higher. This only works when compiled with the |+termresponse|
6747 feature and if |t_RV| is set to the escape sequence to request the
6748 xterm version number. Otherwise "xterm2" must be set explicitly.
6749 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6750 t_RV to an empty string: >
6751 :set t_RV=
6752<
6753 *'ttyscroll'* *'tsl'*
6754'ttyscroll' 'tsl' number (default 999)
6755 global
6756 Maximum number of lines to scroll the screen. If there are more lines
6757 to scroll the window is redrawn. For terminals where scrolling is
6758 very slow and redrawing is not slow this can be set to a small number,
6759 e.g., 3, to speed up displaying.
6760
6761 *'ttytype'* *'tty'*
6762'ttytype' 'tty' string (default from $TERM)
6763 global
6764 Alias for 'term', see above.
6765
6766 *'undolevels'* *'ul'*
6767'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6768 Win32 and OS/2)
6769 global
6770 {not in Vi}
6771 Maximum number of changes that can be undone. Since undo information
6772 is kept in memory, higher numbers will cause more memory to be used
6773 (nevertheless, a single change can use an unlimited amount of memory).
6774 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6775 itself: >
6776 set ul=0
6777< But you can also get Vi compatibility by including the 'u' flag in
6778 'cpoptions', and still be able to use CTRL-R to repeat undo.
6779 Set to a negative number for no undo at all: >
6780 set ul=-1
6781< This helps when you run out of memory for a single change.
6782 Also see |undo-two-ways|.
6783
6784 *'updatecount'* *'uc'*
6785'updatecount' 'uc' number (default: 200)
6786 global
6787 {not in Vi}
6788 After typing this many characters the swap file will be written to
6789 disk. When zero, no swap file will be created at all (see chapter on
6790 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6791 Vim with the "-n" option, see |startup|. When editing in readonly
6792 mode this option will be initialized to 10000.
6793 The swapfile can be disabled per buffer with |'swapfile'|.
6794 When 'updatecount' is set from zero to non-zero, swap files are
6795 created for all buffers that have 'swapfile' set. When 'updatecount'
6796 is set to zero, existing swap files are not deleted.
6797 Also see |'swapsync'|.
6798 This option has no meaning in buffers where |'buftype'| is "nofile"
6799 or "nowrite".
6800
6801 *'updatetime'* *'ut'*
6802'updatetime' 'ut' number (default 4000)
6803 global
6804 {not in Vi}
6805 If this many milliseconds nothing is typed the swap file will be
6806 written to disk (see |crash-recovery|). Also used for the
6807 |CursorHold| autocommand event.
6808
6809 *'verbose'* *'vbs'*
6810'verbose' 'vbs' number (default 0)
6811 global
6812 {not in Vi, although some versions have a boolean
6813 verbose option}
6814 When bigger than zero, Vim will give messages about what it is doing.
6815 Currently, these messages are given:
6816 >= 1 When the viminfo file is read or written.
6817 >= 2 When a file is ":source"'ed.
6818 >= 5 Every searched tags file.
6819 >= 8 Files for which a group of autocommands is executed.
6820 >= 9 Every executed autocommand.
6821 >= 12 Every executed function.
6822 >= 13 When an exception is thrown, caught, finished, or discarded.
6823 >= 14 Anything pending in a ":finally" clause.
6824 >= 15 Every executed Ex command (truncated at 200 characters).
6825
6826 This option can also be set with the "-V" argument. See |-V|.
6827 This option is also set by the |:verbose| command.
6828
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006829 When the 'verbosefile' option is set then the verbose messages are not
6830 displayed.
6831
6832 *'verbosefile'* *'vfile'*
6833'verbosefile' 'vfile' string (default empty)
6834 global
6835 {not in Vi}
6836 When not empty all messages are written in a file with this name.
6837 When the file exists messages are appended.
6838 Writing to the file ends when Vim exits or when 'verbosefile' is made
6839 empty.
6840 Setting 'verbosefile' to a new value is like making it empty first.
6841 The difference with |:redir| is that verbose messages are not
6842 displayed when 'verbosefile' is set.
6843
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 *'viewdir'* *'vdir'*
6845'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6846 "$VIM/vimfiles/view",
6847 for Unix: "~/.vim/view",
6848 for Macintosh: "$VIM:vimfiles:view"
6849 for VMS: "sys$login:vimfiles/view"
6850 for RiscOS: "Choices:vimfiles/view")
6851 global
6852 {not in Vi}
6853 {not available when compiled without the +mksession
6854 feature}
6855 Name of the directory where to store files for |:mkview|.
6856 This option cannot be set from a |modeline| or in the |sandbox|, for
6857 security reasons.
6858
6859 *'viewoptions'* *'vop'*
6860'viewoptions' 'vop' string (default: "folds,options,cursor")
6861 global
6862 {not in Vi}
6863 {not available when compiled without the +mksession
6864 feature}
6865 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006866 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 word save and restore ~
6868 cursor cursor position in file and in window
6869 folds manually created folds, opened/closed folds and local
6870 fold options
6871 options options and mappings local to a window or buffer (not
6872 global values for local options)
6873 slash backslashes in file names replaced with forward
6874 slashes
6875 unix with Unix end-of-line format (single <NL>), even when
6876 on Windows or DOS
6877
6878 "slash" and "unix" are useful on Windows when sharing view files
6879 with Unix. The Unix version of Vim cannot source dos format scripts,
6880 but the Windows version of Vim can source unix format scripts.
6881
6882 *'viminfo'* *'vi'* *E526* *E527* *E528*
6883'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6884 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6885 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6886 for others: '20,<50,s10,h)
6887 global
6888 {not in Vi}
6889 {not available when compiled without the |+viminfo|
6890 feature}
6891 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006892 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 separated list of parameters, each consisting of a single character
6894 identifying the particular parameter, followed by a number or string
6895 which specifies the value of that parameter. If a particular
6896 character is left out, then the default value is used for that
6897 parameter. The following is a list of the identifying characters and
6898 the effect of their value.
6899 CHAR VALUE ~
6900 ! When included, save and restore global variables that start
6901 with an uppercase letter, and don't contain a lowercase
6902 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006903 and "_K_L_M" are not. Only String and Number types are
6904 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 " Maximum number of lines saved for each register. Old name of
6906 the '<' item, with the disadvantage that you need to put a
6907 backslash before the ", otherwise it will be recognized as the
6908 start of a comment!
6909 % When included, save and restore the buffer list. If Vim is
6910 started with a file name argument, the buffer list is not
6911 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 without a file name and buffers for help files are not written
6914 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006915 When followed by a number, the number specifies the maximum
6916 number of buffers that are stored. Without a number all
6917 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006918 ' Maximum number of previously edited files for which the marks
6919 are remembered. This parameter must always be included when
6920 'viminfo' is non-empty.
6921 Including this item also means that the |jumplist| and the
6922 |changelist| are stored in the viminfo file.
6923 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006924 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 patterns are also saved. When not included, the value of
6926 'history' is used.
6927 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006928 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 < Maximum number of lines saved for each register. If zero then
6930 registers are not saved. When not included, all lines are
6931 saved. '"' is the old name for this item.
6932 Also see the 's' item below: limit specified in Kbyte.
6933 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006934 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 c When included, convert the text in the viminfo file from the
6936 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006937 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 f Whether file marks need to be stored. If zero, file marks ('0
6939 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006940 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941 cursor position (when exiting or when doing ":wviminfo").
6942 h Disable the effect of 'hlsearch' when loading the viminfo
6943 file. When not included, it depends on whether ":nohlsearch"
6944 has been used since the last search command.
6945 n Name of the viminfo file. The name must immediately follow
6946 the 'n'. Must be the last one! If the "-i" argument was
6947 given when starting Vim, that file name overrides the one
6948 given here with 'viminfo'. Environment variables are expanded
6949 when opening the file, not when setting the option.
6950 r Removable media. The argument is a string (up to the next
6951 ','). This parameter can be given several times. Each
6952 specifies the start of a path for which no marks will be
6953 stored. This is to avoid removable media. For MS-DOS you
6954 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6955 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6956 ignored. Maximum length of each 'r' argument is 50
6957 characters.
6958 s Maximum size of an item in Kbyte. If zero then registers are
6959 not saved. Currently only applies to registers. The default
6960 "s10" will exclude registers with more than 10 Kbyte of text.
6961 Also see the '<' item above: line count limit.
6962
6963 Example: >
6964 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6965<
6966 '50 Marks will be remembered for the last 50 files you
6967 edited.
6968 <1000 Contents of registers (up to 1000 lines each) will be
6969 remembered.
6970 s100 Registers with more than 100 Kbyte text are skipped.
6971 :0 Command-line history will not be saved.
6972 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6973 no / Since '/' is not specified, the default will be used,
6974 that is, save all of the search history, and also the
6975 previous search and substitute patterns.
6976 no % The buffer list will not be saved nor read back.
6977 no h 'hlsearch' highlighting will be restored.
6978
6979 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6980 load the contents of the file, this is not done automatically.
6981
6982 This option cannot be set from a |modeline| or in the |sandbox|, for
6983 security reasons.
6984
6985 *'virtualedit'* *'ve'*
6986'virtualedit' 've' string (default "")
6987 global
6988 {not in Vi}
6989 {not available when compiled without the
6990 |+virtualedit| feature}
6991 A comma separated list of these words:
6992 block Allow virtual editing in Visual block mode.
6993 insert Allow virtual editing in Insert mode.
6994 all Allow virtual editing in all modes.
6995 Virtual editing means that the cursor can be positioned where there is
6996 no actual character. This can be halfway into a Tab or beyond the end
6997 of the line. Useful for selecting a rectangle in Visual mode and
6998 editing a table.
6999
7000 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7001'visualbell' 'vb' boolean (default off)
7002 global
7003 {not in Vi}
7004 Use visual bell instead of beeping. The terminal code to display the
7005 visual bell is given with 't_vb'. When no beep or flash is wanted,
7006 use ":set vb t_vb=".
7007 Note: When the GUI starts, 't_vb' is reset to its default value. You
7008 might want to set it again in your |gvimrc|.
7009 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7010 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7011 where 40 is the time in msec.
7012 Does not work on the Amiga, you always get a screen flash.
7013 Also see 'errorbells'.
7014
7015 *'warn'* *'nowarn'*
7016'warn' boolean (default on)
7017 global
7018 Give a warning message when a shell command is used while the buffer
7019 has been changed.
7020
7021 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7022'weirdinvert' 'wiv' boolean (default off)
7023 global
7024 {not in Vi}
7025 This option has the same effect as the 't_xs' termcap option.
7026 It is provided for backwards compatibility with version 4.x.
7027 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7028 vice versa. Has no effect when the GUI is running.
7029
7030 *'whichwrap'* *'ww'*
7031'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7032 global
7033 {not in Vi}
7034 Allow specified keys that move the cursor left/right to move to the
7035 previous/next line when the cursor is on the first/last character in
7036 the line. Concatenate characters to allow this for these keys:
7037 char key mode ~
7038 b <BS> Normal and Visual
7039 s <Space> Normal and Visual
7040 h "h" Normal and Visual
7041 l "l" Normal and Visual
7042 < <Left> Normal and Visual
7043 > <Right> Normal and Visual
7044 ~ "~" Normal
7045 [ <Left> Insert and Replace
7046 ] <Right> Insert and Replace
7047 For example: >
7048 :set ww=<,>,[,]
7049< allows wrap only when cursor keys are used.
7050 When the movement keys are used in combination with a delete or change
7051 operator, the <EOL> also counts for a character. This makes "3h"
7052 different from "3dh" when the cursor crosses the end of a line. This
7053 is also true for "x" and "X", because they do the same as "dl" and
7054 "dh". If you use this, you may also want to use the mapping
7055 ":map <BS> X" to make backspace delete the character in front of the
7056 cursor.
7057 When 'l' is included, you get a side effect: "yl" on an empty line
7058 will include the <EOL>, so that "p" will insert a new line.
7059 NOTE: This option is set to the Vi default value when 'compatible' is
7060 set and to the Vim default value when 'compatible' is reset.
7061
7062 *'wildchar'* *'wc'*
7063'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7064 global
7065 {not in Vi}
7066 Character you have to type to start wildcard expansion in the
7067 command-line, as specified with 'wildmode'.
7068 The character is not recognized when used inside a macro. See
7069 'wildcharm' for that.
7070 Although 'wc' is a number option, you can set it to a special key: >
7071 :set wc=<Esc>
7072< NOTE: This option is set to the Vi default value when 'compatible' is
7073 set and to the Vim default value when 'compatible' is reset.
7074
7075 *'wildcharm'* *'wcm'*
7076'wildcharm' 'wcm' number (default: none (0))
7077 global
7078 {not in Vi}
7079 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007080 recognized when used inside a macro. You can find "spare" command-line
7081 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007082 you'll never actually type 'wildcharm', just use it in mappings that
7083 automatically invoke completion mode, e.g.: >
7084 :set wcm=<C-Z>
7085 :cmap ss so $vim/sessions/*.vim<C-Z>
7086< Then after typing :ss you can use CTRL-P & CTRL-N.
7087
7088 *'wildignore'* *'wig'*
7089'wildignore' 'wig' string (default "")
7090 global
7091 {not in Vi}
7092 {not available when compiled without the |+wildignore|
7093 feature}
7094 A list of file patterns. A file that matches with one of these
7095 patterns is ignored when completing file or directory names.
7096 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7097 Also see 'suffixes'.
7098 Example: >
7099 :set wildignore=*.o,*.obj
7100< The use of |:set+=| and |:set-=| is preferred when adding or removing
7101 a pattern from the list. This avoids problems when a future version
7102 uses another default.
7103
7104 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7105'wildmenu' 'wmnu' boolean (default off)
7106 global
7107 {not in Vi}
7108 {not available if compiled without the |+wildmenu|
7109 feature}
7110 When 'wildmenu' is on, command-line completion operates in an enhanced
7111 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7112 the possible matches are shown just above the command line, with the
7113 first match highlighted (overwriting the status line, if there is
7114 one). Keys that show the previous/next match, such as <Tab> or
7115 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7116 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7117 specified. "longest" and "list" do not start "wildmenu" mode.
7118 If there are more matches than can fit in the line, a ">" is shown on
7119 the right and/or a "<" is shown on the left. The status line scrolls
7120 as needed.
7121 The "wildmenu" mode is abandoned when a key is hit that is not used
7122 for selecting a completion.
7123 While the "wildmenu" is active the following keys have special
7124 meanings:
7125
7126 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7127 <Down> - in filename/menu name completion: move into a
7128 subdirectory or submenu.
7129 <CR> - in menu completion, when the cursor is just after a
7130 dot: move into a submenu.
7131 <Up> - in filename/menu name completion: move up into
7132 parent directory or parent menu.
7133
7134 This makes the menus accessible from the console |console-menus|.
7135
7136 If you prefer the <Left> and <Right> keys to move the cursor instead
7137 of selecting a different match, use this: >
7138 :cnoremap <Left> <Space><BS><Left>
7139 :cnoremap <Right> <Space><BS><Right>
7140<
7141 The "WildMenu" highlighting is used for displaying the current match
7142 |hl-WildMenu|.
7143
7144 *'wildmode'* *'wim'*
7145'wildmode' 'wim' string (Vim default: "full")
7146 global
7147 {not in Vi}
7148 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007149 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 part specifies what to do for each consecutive use of 'wildchar. The
7151 first part specifies the behavior for the first use of 'wildchar',
7152 The second part for the second use, etc.
7153 These are the possible values for each part:
7154 "" Complete only the first match.
7155 "full" Complete the next full match. After the last match,
7156 the original string is used and then the first match
7157 again.
7158 "longest" Complete till longest common string. If this doesn't
7159 result in a longer string, use the next part.
7160 "longest:full" Like "longest", but also start 'wildmenu' if it is
7161 enabled.
7162 "list" When more than one match, list all matches.
7163 "list:full" When more than one match, list all matches and
7164 complete first match.
7165 "list:longest" When more than one match, list all matches and
7166 complete till longest common string.
7167 When there is only a single match, it is fully completed in all cases.
7168
7169 Examples: >
7170 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007171< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 :set wildmode=longest,full
7173< Complete longest common string, then each full match >
7174 :set wildmode=list:full
7175< List all matches and complete each full match >
7176 :set wildmode=list,full
7177< List all matches without completing, then each full match >
7178 :set wildmode=longest,list
7179< Complete longest common string, then list alternatives.
7180
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007181 *'wildoptions'* *'wop'*
7182'wildoptions' 'wop' string (default "")
7183 global
7184 {not in Vi}
7185 {not available when compiled without the |+wildignore|
7186 feature}
7187 A list of words that change how command line completion is done.
7188 Currently only one word is allowed:
7189 tagfile When using CTRL-D to list matching tags, the kind of
7190 tag and the file of the tag is listed. Only one match
7191 is displayed per line. Often used tag kinds are:
7192 d #define
7193 f function
7194 Also see |cmdline-completion|.
7195
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 *'winaltkeys'* *'wak'*
7197'winaltkeys' 'wak' string (default "menu")
7198 global
7199 {not in Vi}
7200 {only used in Win32, Motif, GTK and Photon GUI}
7201 Some GUI versions allow the access to menu entries by using the ALT
7202 key in combination with a character that appears underlined in the
7203 menu. This conflicts with the use of the ALT key for mappings and
7204 entering special characters. This option tells what to do:
7205 no Don't use ALT keys for menus. ALT key combinations can be
7206 mapped, but there is no automatic handling. This can then be
7207 done with the |:simalt| command.
7208 yes ALT key handling is done by the windowing system. ALT key
7209 combinations cannot be mapped.
7210 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007211 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007212 keys can be mapped.
7213 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7214 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007215 This option is not used for <F10>; on Win32 and with GTK <F10> will
7216 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007218 *'window'* *'wi'*
7219'window' 'wi' number (default screen height - 1)
7220 global
7221 Window height. Do not confuse this with the height of the Vim window,
7222 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007223 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7224 value is smaller than 'lines' minus one. The screen will scroll
7225 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007226 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7227 in a much smarter way, taking care of wrapping lines.
7228 When resizing the Vim window, the value is smaller than 1 or more than
7229 or equal to 'lines' it will be set to 'lines' minus 1.
7230 {Vi also uses the option to specify the number of displayed lines}
7231
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 *'winheight'* *'wh'* *E591*
7233'winheight' 'wh' number (default 1)
7234 global
7235 {not in Vi}
7236 {not available when compiled without the +windows
7237 feature}
7238 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007239 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007240 current window is smaller, its size is increased, at the cost of the
7241 height of other windows. Set it to 999 to make the current window
7242 always fill the screen (although this has the drawback that ":all"
7243 will create only two windows). Set it to a small number for normal
7244 editing.
7245 Minimum value is 1.
7246 The height is not adjusted after one of the commands to change the
7247 height of the current window.
7248 'winheight' applies to the current window. Use 'winminheight' to set
7249 the minimal height for other windows.
7250
7251 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7252'winfixheight' 'wfh' boolean (default off)
7253 local to window
7254 {not in Vi}
7255 {not available when compiled without the +windows
7256 feature}
7257 Keep the window height when windows are opened or closed and
7258 'equalalways' is set. Set by default for the |preview-window| and
7259 |quickfix-window|.
7260 The height may be changed anyway when running out of room.
7261
7262 *'winminheight'* *'wmh'*
7263'winminheight' 'wmh' number (default 1)
7264 global
7265 {not in Vi}
7266 {not available when compiled without the +windows
7267 feature}
7268 The minimal height of a window, when it's not the current window.
7269 This is a hard minimum, windows will never become smaller.
7270 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7271 status bar) if necessary. They will return to at least one line when
7272 they become active (since the cursor has to have somewhere to go.)
7273 Use 'winheight' to set the minimal height of the current window.
7274 This option is only checked when making a window smaller. Don't use a
7275 large number, it will cause errors when opening more than a few
7276 windows. A value of 0 to 3 is reasonable.
7277
7278 *'winminwidth'* *'wmw'*
7279'winminwidth' 'wmw' number (default 1)
7280 global
7281 {not in Vi}
7282 {not available when compiled without the +vertsplit
7283 feature}
7284 The minimal width of a window, when it's not the current window.
7285 This is a hard minimum, windows will never become smaller.
7286 When set to zero, windows may be "squashed" to zero columns (i.e. just
7287 a vertical separator) if necessary. They will return to at least one
7288 line when they become active (since the cursor has to have somewhere
7289 to go.)
7290 Use 'winwidth' to set the minimal width of the current window.
7291 This option is only checked when making a window smaller. Don't use a
7292 large number, it will cause errors when opening more than a few
7293 windows. A value of 0 to 12 is reasonable.
7294
7295 *'winwidth'* *'wiw'* *E592*
7296'winwidth' 'wiw' number (default 20)
7297 global
7298 {not in Vi}
7299 {not available when compiled without the +vertsplit
7300 feature}
7301 Minimal number of columns for the current window. This is not a hard
7302 minimum, Vim will use fewer columns if there is not enough room. If
7303 the current window is smaller, its size is increased, at the cost of
7304 the width of other windows. Set it to 999 to make the current window
7305 always fill the screen. Set it to a small number for normal editing.
7306 The width is not adjusted after one of the commands to change the
7307 width of the current window.
7308 'winwidth' applies to the current window. Use 'winminwidth' to set
7309 the minimal width for other windows.
7310
7311 *'wrap'* *'nowrap'*
7312'wrap' boolean (default on)
7313 local to window
7314 {not in Vi}
7315 This option changes how text is displayed. It doesn't change the text
7316 in the buffer, see 'textwidth' for that.
7317 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007318 displaying continues on the next line. When off lines will not wrap
7319 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 moved to a part that is not shown, the screen will scroll
7321 horizontally.
7322 The line will be broken in the middle of a word if necessary. See
7323 'linebreak' to get the break at a word boundary.
7324 To make scrolling horizontally a bit more useful, try this: >
7325 :set sidescroll=5
7326 :set listchars+=precedes:<,extends:>
7327< See 'sidescroll', 'listchars' and |wrap-off|.
7328
7329 *'wrapmargin'* *'wm'*
7330'wrapmargin' 'wm' number (default 0)
7331 local to buffer
7332 Number of characters from the right window border where wrapping
7333 starts. When typing text beyond this limit, an <EOL> will be inserted
7334 and inserting continues on the next line.
7335 Options that add a margin, such as 'number' and 'foldcolumn', cause
7336 the text width to be further reduced. This is Vi compatible.
7337 When 'textwidth' is non-zero, this option is not used.
7338 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7339 and less usefully}
7340
7341 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7342'wrapscan' 'ws' boolean (default on) *E384* *E385*
7343 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007344 Searches wrap around the end of the file. Also applies to |]s| and
7345 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346
7347 *'write'* *'nowrite'*
7348'write' boolean (default on)
7349 global
7350 {not in Vi}
7351 Allows writing files. When not set, writing a file is not allowed.
7352 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007353 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 argument. Filtering text is still possible, even though this requires
7355 writing a temporary file.
7356
7357 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7358'writeany' 'wa' boolean (default off)
7359 global
7360 Allows writing to any file with no need for "!" override.
7361
7362 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7363'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7364 otherwise)
7365 global
7366 {not in Vi}
7367 Make a backup before overwriting a file. The backup is removed after
7368 the file was successfully written, unless the 'backup' option is
7369 also on. Reset this option if your file system is almost full. See
7370 |backup-table| for another explanation.
7371 When the 'backupskip' pattern matches, a backup is not made anyway.
7372 NOTE: This option is set to the default value when 'compatible' is
7373 set.
7374
7375 *'writedelay'* *'wd'*
7376'writedelay' 'wd' number (default 0)
7377 global
7378 {not in Vi}
7379 The number of microseconds to wait for each character sent to the
7380 screen. When non-zero, characters are sent to the terminal one by
7381 one. For MS-DOS pcterm this does not work. For debugging purposes.
7382
7383 vim:tw=78:ts=8:ft=help:norl: