blob: 16c36db2ca464c572f9cfb17afe0d58342ac0625 [file] [log] [blame]
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Jan 19
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}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001601 This option specifies a function to be used for Insert mode completion
1602 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001603
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
Bram Moolenaarb3480382005-12-11 21:33:32 +00001822 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823 *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 Moolenaarb3480382005-12-11 21:33:32 +00001891 *cpo-P*
1892 P When included, a ":write" command that appends to a
1893 file will set the file name for the current buffer, if
1894 the current buffer doesn't have a file name yet and
1895 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001896 *cpo-q*
1897 q When joining multiple lines leave the cursor at the
1898 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001899 *cpo-r*
1900 r Redo ("." command) uses "/" to repeat a search
1901 command, instead of the actually used search string.
1902 *cpo-R*
1903 R Remove marks from filtered lines. Without this flag
1904 marks are kept like |:keepmarks| was used.
1905 *cpo-s*
1906 s Set buffer options when entering the buffer for the
1907 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001908 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 set when the buffer is created.
1910 *cpo-S*
1911 S Set buffer options always when entering a buffer
1912 (except 'readonly', 'fileformat', 'filetype' and
1913 'syntax'). This is the (most) Vi compatible setting.
1914 The options are set to the values in the current
1915 buffer. When you change an option and go to another
1916 buffer, the value is copied. Effectively makes the
1917 buffer options global to all buffers.
1918
1919 's' 'S' copy buffer options
1920 no no when buffer created
1921 yes no when buffer first entered (default)
1922 X yes each time when buffer entered (vi comp.)
1923 *cpo-t*
1924 t Search pattern for the tag command is remembered for
1925 "n" command. Otherwise Vim only puts the pattern in
1926 the history for search pattern, but doesn't change the
1927 last used search pattern.
1928 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001929 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 *cpo-v*
1931 v Backspaced characters remain visible on the screen in
1932 Insert mode. Without this flag the characters are
1933 erased from the screen right away. With this flag the
1934 screen newly typed text overwrites backspaced
1935 characters.
1936 *cpo-w*
1937 w When using "cw" on a blank character, only change one
1938 character and not all blanks until the start of the
1939 next word.
1940 *cpo-W*
1941 W Don't overwrite a readonly file. When omitted, ":w!"
1942 overwrites a readonly file, if possible.
1943 *cpo-x*
1944 x <Esc> on the command-line executes the command-line.
1945 The default in Vim is to abandon the command-line,
1946 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001947 *cpo-X*
1948 X When using a count with "R" the replaced text is
1949 deleted only once. Also when repeating "R" with "."
1950 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 *cpo-y*
1952 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo-Z*
1954 Z When using "w!" while the 'readonly' option is set,
1955 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *cpo-!*
1957 ! When redoing a filter command, use the last used
1958 external command, whatever it was. Otherwise the last
1959 used -filter- command is used.
1960 *cpo-$*
1961 $ When making a change to one line, don't redisplay the
1962 line, but put a '$' at the end of the changed text.
1963 The changed text will be overwritten when you type the
1964 new text. The line is redisplayed if you type any
1965 command that moves the cursor from the insertion
1966 point.
1967 *cpo-%*
1968 % Vi-compatible matching is done for the "%" command.
1969 Does not recognize "#if", "#endif", etc.
1970 Does not recognize "/*" and "*/".
1971 Parens inside single and double quotes are also
1972 counted, causing a string that contains a paren to
1973 disturb the matching. For example, in a line like
1974 "if (strcmp("foo(", s))" the first paren does not
1975 match the last one. When this flag is not included,
1976 parens inside single and double quotes are treated
1977 specially. When matching a paren outside of quotes,
1978 everything inside quotes is ignored. When matching a
1979 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001980 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001981 This flag is also used for other features, such as
1982 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001983 *cpo--*
1984 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001985 it would go above the first line or below the last
1986 line. Without it the cursor moves to the first or
1987 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001988 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001989 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001990 *cpo-+*
1991 + When included, a ":write file" command will reset the
1992 'modified' flag of the buffer, even though the buffer
1993 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001994 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 * Use ":*" in the same way as ":@". When not included,
1996 ":*" is an alias for ":'<,'>", select the Visual area.
1997 *cpo-<*
1998 < Disable the recognition of special key codes in |<>|
1999 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002000 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 ":map X <Tab>" results in X being mapped to:
2002 '<' included: "<Tab>" (5 characters)
2003 '<' excluded: "^I" (^I is a real <Tab>)
2004 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002005 *cpo->*
2006 > When appending to a register, put a line break before
2007 the appended text.
2008
2009 POSIX flags. These are not included in the Vi default value, except
2010 when $VIM_POSIX was set on startup. |posix|
2011
2012 contains behavior ~
2013 *cpo-#*
2014 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002015 *cpo-&*
2016 & When ":preserve" was used keep the swap file when
2017 exiting normally while this buffer is still loaded.
2018 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002019 *cpo-\*
2020 \ Backslash in a [] range in a search pattern is taken
2021 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002022 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2023 '\' excluded: "/[ \-]" finds <Space> and '-'
2024 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002025 *cpo-/*
2026 / When "%" is used as the replacement string in a |:s|
2027 command, use the previous replacement string. |:s%|
2028 *cpo-{*
2029 { The |{| and |}| commands also stop at a "{" character
2030 at the start of a line.
2031 *cpo-.*
2032 . The ":chdir" and ":cd" commands fail if the current
2033 buffer is modified, unless ! is used. Vim doesn't
2034 need this, since it remembers the full path of an
2035 opened file.
2036 *cpo-bar*
2037 | The value of the $LINES and $COLUMNS environment
2038 variables overrule the terminal size values obtained
2039 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041
2042 *'cscopepathcomp'* *'cspc'*
2043'cscopepathcomp' 'cspc' number (default 0)
2044 global
2045 {not available when compiled without the |+cscope|
2046 feature}
2047 {not in Vi}
2048 Determines how many components of the path to show in a list of tags.
2049 See |cscopepathcomp|.
2050
2051 *'cscopeprg'* *'csprg'*
2052'cscopeprg' 'csprg' string (default "cscope")
2053 global
2054 {not available when compiled without the |+cscope|
2055 feature}
2056 {not in Vi}
2057 Specifies the command to execute cscope. See |cscopeprg|.
2058 This option cannot be set from a |modeline| or in the |sandbox|, for
2059 security reasons.
2060
2061 *'cscopequickfix'* *'csqf'*
2062'cscopequickfix' 'csqf' string (default "")
2063 global
2064 {not available when compiled without the |+cscope|
2065 or |+quickfix| features}
2066 {not in Vi}
2067 Specifies whether to use quickfix window to show cscope results.
2068 See |cscopequickfix|.
2069
2070 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2071'cscopetag' 'cst' boolean (default off)
2072 global
2073 {not available when compiled without the |+cscope|
2074 feature}
2075 {not in Vi}
2076 Use cscope for tag commands. See |cscope-options|.
2077 NOTE: This option is reset when 'compatible' is set.
2078
2079 *'cscopetagorder'* *'csto'*
2080'cscopetagorder' 'csto' number (default 0)
2081 global
2082 {not available when compiled without the |+cscope|
2083 feature}
2084 {not in Vi}
2085 Determines the order in which ":cstag" performs a search. See
2086 |cscopetagorder|.
2087 NOTE: This option is set to 0 when 'compatible' is set.
2088
2089 *'cscopeverbose'* *'csverb'*
2090 *'nocscopeverbose'* *'nocsverb'*
2091'cscopeverbose' 'csverb' boolean (default off)
2092 global
2093 {not available when compiled without the |+cscope|
2094 feature}
2095 {not in Vi}
2096 Give messages when adding a cscope database. See |cscopeverbose|.
2097 NOTE: This option is reset when 'compatible' is set.
2098
2099 *'debug'*
2100'debug' string (default "")
2101 global
2102 {not in Vi}
2103 When set to "msg", error messages that would otherwise be omitted will
2104 be given anyway. This is useful when debugging 'foldexpr' or
2105 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002106 When set to "beep", a message will be given when otherwise only a beep
2107 would be produced.
2108 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109
2110 *'define'* *'def'*
2111'define' 'def' string (default "^\s*#\s*define")
2112 global or local to buffer |global-local|
2113 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002114 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 pattern, just like for the "/" command. This option is used for the
2116 commands like "[i" and "[d" |include-search|. The 'isident' option is
2117 used to recognize the defined name after the match:
2118 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2119 See |option-backslash| about inserting backslashes to include a space
2120 or backslash.
2121 The default value is for C programs. For C++ this value would be
2122 useful, to include const type declarations: >
2123 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2124< When using the ":set" command, you need to double the backslashes!
2125
2126 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2127'delcombine' 'deco' boolean (default off)
2128 global
2129 {not in Vi}
2130 {only available when compiled with the |+multi_byte|
2131 feature}
2132 If editing Unicode and this option is set, backspace and Normal mode
2133 "x" delete each combining character on its own. When it is off (the
2134 default) the character along with its combining characters are
2135 deleted.
2136 Note: When 'delcombine' is set "xx" may work different from "2x"!
2137
2138 This is useful for Arabic, Hebrew and many other languages where one
2139 may have combining characters overtop of base characters, and want
2140 to remove only the combining ones.
2141
2142 *'dictionary'* *'dict'*
2143'dictionary' 'dict' string (default "")
2144 global or local to buffer |global-local|
2145 {not in Vi}
2146 List of file names, separated by commas, that are used to lookup words
2147 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2148 contain a list of words. This can be one word per line, or several
2149 words per line, separated by non-keyword characters (white space is
2150 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002151 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 after a comma are ignored, otherwise spaces are included in the file
2153 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002154 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 Where to find a list of words?
2156 - On FreeBSD, there is the file "/usr/share/dict/words".
2157 - In the Simtel archive, look in the "msdos/linguist" directory.
2158 - In "miscfiles" of the GNU collection.
2159 The use of |:set+=| and |:set-=| is preferred when adding or removing
2160 directories from the list. This avoids problems when a future version
2161 uses another default.
2162 Backticks cannot be used in this option for security reasons.
2163
2164 *'diff'* *'nodiff'*
2165'diff' boolean (default off)
2166 local to window
2167 {not in Vi}
2168 {not available when compiled without the |+diff|
2169 feature}
2170 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002171 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172
2173 *'dex'* *'diffexpr'*
2174'diffexpr' 'dex' string (default "")
2175 global
2176 {not in Vi}
2177 {not available when compiled without the |+diff|
2178 feature}
2179 Expression which is evaluated to obtain an ed-style diff file from two
2180 versions of a file. See |diff-diffexpr|.
2181 This option cannot be set from a |modeline| or in the |sandbox|, for
2182 security reasons.
2183
2184 *'dip'* *'diffopt'*
2185'diffopt' 'dip' string (default "filler")
2186 global
2187 {not in Vi}
2188 {not available when compiled without the |+diff|
2189 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 All are optional. Items must be separated by a comma.
2192
2193 filler Show filler lines, to keep the text
2194 synchronized with a window that has inserted
2195 lines at the same position. Mostly useful
2196 when windows are side-by-side and 'scrollbind'
2197 is set.
2198
2199 context:{n} Use a context of {n} lines between a change
2200 and a fold that contains unchanged lines.
2201 When omitted a context of six lines is used.
2202 See |fold-diff|.
2203
2204 icase Ignore changes in case of text. "a" and "A"
2205 are considered the same. Adds the "-i" flag
2206 to the "diff" command if 'diffexpr' is empty.
2207
2208 iwhite Ignore changes in amount of white space. Adds
2209 the "-b" flag to the "diff" command if
2210 'diffexpr' is empty. Check the documentation
2211 of the "diff" command for what this does
2212 exactly. It should ignore adding trailing
2213 white space, but not leading white space.
2214
2215 Examples: >
2216
2217 :set diffopt=filler,context:4
2218 :set diffopt=
2219 :set diffopt=filler
2220<
2221 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2222'digraph' 'dg' boolean (default off)
2223 global
2224 {not in Vi}
2225 {not available when compiled without the |+digraphs|
2226 feature}
2227 Enable the entering of digraphs in Insert mode with {char1} <BS>
2228 {char2}. See |digraphs|.
2229 NOTE: This option is reset when 'compatible' is set.
2230
2231 *'directory'* *'dir'*
2232'directory' 'dir' string (default for Amiga: ".,t:",
2233 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2234 for Unix: ".,~/tmp,/var/tmp,/tmp")
2235 global
2236 List of directory names for the swap file, separated with commas.
2237 - The swap file will be created in the first directory where this is
2238 possible.
2239 - Empty means that no swap file will be used (recovery is
2240 impossible!).
2241 - A directory "." means to put the swap file in the same directory as
2242 the edited file. On Unix, a dot is prepended to the file name, so
2243 it doesn't show in a directory listing. On MS-Windows the "hidden"
2244 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002245 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 put the swap file relative to where the edited file is. The leading
2247 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002248 - For Unix and Win32, if a directory ends in two path separators "//"
2249 or "\\", the swap file name will be built from the complete path to
2250 the file with all path separators substituted to percent '%' signs.
2251 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 - Spaces after the comma are ignored, other spaces are considered part
2253 of the directory name. To have a space at the start of a directory
2254 name, precede it with a backslash.
2255 - To include a comma in a directory name precede it with a backslash.
2256 - A directory name may end in an ':' or '/'.
2257 - Environment variables are expanded |:set_env|.
2258 - Careful with '\' characters, type one before a space, type two to
2259 get one in the option (see |option-backslash|), for example: >
2260 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2261< - For backwards compatibility with Vim version 3.0 a '>' at the start
2262 of the option is removed.
2263 Using "." first in the list is recommended. This means that editing
2264 the same file twice will result in a warning. Using "/tmp" on Unix is
2265 discouraged: When the system crashes you lose the swap file.
2266 "/var/tmp" is often not cleared when rebooting, thus is a better
2267 choice than "/tmp". But it can contain a lot of files, your swap
2268 files get lost in the crowd. That is why a "tmp" directory in your
2269 home directory is tried first.
2270 The use of |:set+=| and |:set-=| is preferred when adding or removing
2271 directories from the list. This avoids problems when a future version
2272 uses another default.
2273 This option cannot be set from a |modeline| or in the |sandbox|, for
2274 security reasons.
2275 {Vi: directory to put temp file in, defaults to "/tmp"}
2276
2277 *'display'* *'dy'*
2278'display' 'dy' string (default "")
2279 global
2280 {not in Vi}
2281 Change the way text is displayed. This is comma separated list of
2282 flags:
2283 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 last line that doesn't fit is replaced with "@" lines.
2286 uhex Show unprintable characters hexadecimal as <xx>
2287 instead of using ^C and ~C.
2288
2289 *'eadirection'* *'ead'*
2290'eadirection' 'ead' string (default "both")
2291 global
2292 {not in Vi}
2293 {not available when compiled without the +vertsplit
2294 feature}
2295 Tells when the 'equalalways' option applies:
2296 ver vertically, width of windows is not affected
2297 hor horizontally, height of windows is not affected
2298 both width and height of windows is affected
2299
2300 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2301'edcompatible' 'ed' boolean (default off)
2302 global
2303 Makes the 'g' and 'c' flags of the ":substitute" command to be
2304 toggled each time the flag is given. See |complex-change|. See
2305 also 'gdefault' option.
2306 Switching this option on is discouraged!
2307
2308 *'encoding'* *'enc'* *E543*
2309'encoding' 'enc' string (default: "latin1" or value from $LANG)
2310 global
2311 {only available when compiled with the |+multi_byte|
2312 feature}
2313 {not in Vi}
2314 Sets the character encoding used inside Vim. It applies to text in
2315 the buffers, registers, Strings in expressions, text stored in the
2316 viminfo file, etc. It sets the kind of characters which Vim can work
2317 with. See |encoding-names| for the possible values.
2318
2319 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002320 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002321 It should normally be kept at its default value, or set when Vim
2322 starts up. See |multibyte|.
2323
2324 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2325 "utf-8". Although care has been taken to allow different values of
2326 'encoding', "utf-8" is the natural choice for the environment and
2327 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002328 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 versions, and to avoid changing the encoding of newly created files
2330 without your knowledge (in case 'fileencodings' is empty).
2331
2332 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002333 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334 iconv() or as specified with 'charconvert'.
2335
2336 Normally 'encoding' will be equal to your current locale. This will
2337 be the default if Vim recognizes your environment settings. If
2338 'encoding' is not set to the current locale, 'termencoding' must be
2339 set to convert typed and displayed text. See |encoding-table|.
2340
2341 When you set this option, it fires the |EncodingChanged| autocommand
2342 event so that you can set up fonts if necessary.
2343
2344 When the option is set, the value is converted to lowercase. Thus
2345 you can set it with uppercase values too. Underscores are translated
2346 to '-' signs.
2347 When the encoding is recognized, it is changed to the standard name.
2348 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2349 "iso-8859-2" and "utf8" becomes "utf-8".
2350
2351 Note: "latin1" is also used when the encoding could not be detected.
2352 This only works when editing files in the same encoding! When the
2353 actual character set is not latin1, make sure 'fileencoding' and
2354 'fileencodings' are empty. When conversion is needed, switch to using
2355 utf-8.
2356
2357 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2358 You don't notice this while editing, but it does matter for the
2359 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2360 setting 'encoding' to one of these values instead of utf-8 only has
2361 effect for encoding used for files when 'fileencoding' is empty.
2362
Bram Moolenaar661b1822005-07-28 22:36:45 +00002363 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2364 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2367'endofline' 'eol' boolean (default on)
2368 local to buffer
2369 {not in Vi}
2370 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002371 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 option is automatically set when starting to edit a new file, unless
2373 the file does not have an <EOL> for the last line in the file, in
2374 which case it is reset. Normally you don't have to set or reset this
2375 option. When 'binary' is off the value is not used when writing the
2376 file. When 'binary' is on it is used to remember the presence of a
2377 <EOL> for the last line in the file, so that when you write the file
2378 the situation from the original file can be kept. But you can change
2379 it if you want to.
2380
2381 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2382'equalalways' 'ea' boolean (default on)
2383 global
2384 {not in Vi}
2385 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002386 splitting or closing a window. This also happens the moment the
2387 option is switched on. When off, splitting a window will reduce the
2388 size of the current window and leave the other windows the same. When
2389 closing a window the extra lines are given to the window next to it
2390 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 When mixing vertically and horizontally split windows, a minimal size
2392 is computed and some windows may be larger if there is room. The
2393 'eadirection' option tells in which direction the size is affected.
2394 Changing the height of a window can be avoided by setting
2395 'winfixheight'.
2396
2397 *'equalprg'* *'ep'*
2398'equalprg' 'ep' string (default "")
2399 global or local to buffer |global-local|
2400 {not in Vi}
2401 External program to use for "=" command. When this option is empty
2402 the internal formatting functions are used ('lisp', 'cindent' or
2403 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002404 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405 about including spaces and backslashes.
2406 This option cannot be set from a |modeline| or in the |sandbox|, for
2407 security reasons.
2408
2409 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2410'errorbells' 'eb' boolean (default off)
2411 global
2412 Ring the bell (beep or screen flash) for error messages. This only
2413 makes a difference for error messages, the bell will be used always
2414 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002415 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416 screen flash or do nothing.
2417
2418 *'errorfile'* *'ef'*
2419'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2420 others: "errors.err")
2421 global
2422 {not in Vi}
2423 {not available when compiled without the |+quickfix|
2424 feature}
2425 Name of the errorfile for the QuickFix mode (see |:cf|).
2426 When the "-q" command-line argument is used, 'errorfile' is set to the
2427 following argument. See |-q|.
2428 NOT used for the ":make" command. See 'makeef' for that.
2429 Environment variables are expanded |:set_env|.
2430 See |option-backslash| about including spaces and backslashes.
2431 This option cannot be set from a |modeline| or in the |sandbox|, for
2432 security reasons.
2433
2434 *'errorformat'* *'efm'*
2435'errorformat' 'efm' string (default is very long)
2436 global or local to buffer |global-local|
2437 {not in Vi}
2438 {not available when compiled without the |+quickfix|
2439 feature}
2440 Scanf-like description of the format for the lines in the error file
2441 (see |errorformat|).
2442
2443 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2444'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2445 global
2446 {not in Vi}
2447 Function keys that start with an <Esc> are recognized in Insert
2448 mode. When this option is off, the cursor and function keys cannot be
2449 used in Insert mode if they start with an <Esc>. The advantage of
2450 this is that the single <Esc> is recognized immediately, instead of
2451 after one second. Instead of resetting this option, you might want to
2452 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2453 when 'esckeys' is off, you can still map anything, but the cursor keys
2454 won't work by default.
2455 NOTE: This option is set to the Vi default value when 'compatible' is
2456 set and to the Vim default value when 'compatible' is reset.
2457
2458 *'eventignore'* *'ei'*
2459'eventignore' 'ei' string (default "")
2460 global
2461 {not in Vi}
2462 {not available when compiled without the |+autocmd|
2463 feature}
2464 A list of autocommand event names, which are to be ignored.
2465 When set to "all", all autocommand events are ignored, autocommands
2466 will not be executed.
2467 Otherwise this is a comma separated list of event names. Example: >
2468 :set ei=WinEnter,WinLeave
2469<
2470 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2471'expandtab' 'et' boolean (default off)
2472 local to buffer
2473 {not in Vi}
2474 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002475 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002476 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2477 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2478 NOTE: This option is reset when 'compatible' is set.
2479
2480 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2481'exrc' 'ex' boolean (default off)
2482 global
2483 {not in Vi}
2484 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2485 directory. If you switch this option on you should also consider
2486 setting the 'secure' option (see |initialization|). Using a local
2487 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2488 also see |.vimrc| and |gui-init|.
2489 This option cannot be set from a |modeline| or in the |sandbox|, for
2490 security reasons.
2491
2492 *'fileencoding'* *'fenc'* *E213*
2493'fileencoding' 'fenc' string (default: "")
2494 local to buffer
2495 {only available when compiled with the |+multi_byte|
2496 feature}
2497 {not in Vi}
2498 Sets the character encoding for the file of this buffer.
2499 When 'fileencoding' is different from 'encoding', conversion will be
2500 done when reading and writing the file.
2501 When 'fileencoding' is empty, the same value as 'encoding' will be
2502 used (no conversion when reading or writing a file).
2503 WARNING: Conversion can cause loss of information! When
2504 'encoding' is "utf-8" conversion is most likely done in a way
2505 that the reverse conversion results in the same text. When
2506 'encoding' is not "utf-8" some characters may be lost!
2507 See 'encoding' for the possible values. Additionally, values may be
2508 specified that can be handled by the converter, see
2509 |mbyte-conversion|.
2510 When reading a file 'fileencoding' will be set from 'fileencodings'.
2511 To read a file in a certain encoding it won't work by setting
2512 'fileencoding', use the |++enc| argument.
2513 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2514 When the option is set, the value is converted to lowercase. Thus
2515 you can set it with uppercase values too. '_' characters are
2516 replaced with '-'. If a name is recognized from the list for
2517 'encoding', it is replaced by the standard name. For example
2518 "ISO8859-2" becomes "iso-8859-2".
2519 When this option is set, after starting to edit a file, the 'modified'
2520 option is set, because the file would be different when written.
2521 If you do this in a modeline, you might want to set 'nomodified' to
2522 avoid this.
2523 This option can not be changed when 'modifiable' is off.
2524
2525 *'fe'*
2526 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 old short name was 'fe', which is no longer used.
2529
2530 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002531'fileencodings' 'fencs' string (default: "ucs-bom",
2532 "ucs-bom,utf-8,default,latin1" when
2533 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 global
2535 {only available when compiled with the |+multi_byte|
2536 feature}
2537 {not in Vi}
2538 This is a list of character encodings considered when starting to edit
2539 an existing file. When a file is read, Vim tries to use the first
2540 mentioned character encoding. If an error is detected, the next one
2541 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002542 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 an empty string, which means the value of 'encoding' is used.
2544 WARNING: Conversion can cause loss of information! When
2545 'encoding' is "utf-8" (or one of the other Unicode variants)
2546 conversion is most likely done in a way that the reverse
2547 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002548 "utf-8" some non-ASCII characters may be lost! You can use
2549 the |++bad| argument to specify what is done with characters
2550 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 For an empty file or a file with only ASCII characters most encodings
2552 will work and the first entry of 'fileencodings' will be used (except
2553 "ucs-bom", which requires the BOM to be present). If you prefer
2554 another encoding use an BufReadPost autocommand event to test if your
2555 preferred encoding is to be used. Example: >
2556 au BufReadPost * if search('\S', 'w') == 0 |
2557 \ set fenc=iso-2022-jp | endif
2558< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2559 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002560 When the |++enc| argument is used then the value of 'fileencodings' is
2561 not used.
2562 Note that 'fileencodings' is not used for a new file, 'fileencoding'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 is always empty then. This means that a non-existing file may get a
2564 different encoding than an empty file.
2565 The special value "ucs-bom" can be used to check for a Unicode BOM
2566 (Byte Order Mark) at the start of the file. It must not be preceded
2567 by "utf-8" or another Unicode encoding for this to work properly.
2568 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2569 because Vim cannot detect an error, thus the encoding is always
2570 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002571 The special value "default" can be used for the encoding from the
2572 environment. This is the default value for 'encoding'. It is useful
2573 when 'encoding' is set to "utf-8" and your environment uses a
2574 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 WRONG VALUES: WHAT'S WRONG:
2576 latin1,utf-8 "latin1" will always be used
2577 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2578 file
2579 cp1250,latin1 "cp1250" will always be used
2580 If 'fileencodings' is empty, 'fileencoding' is not modified.
2581 See 'fileencoding' for the possible values.
2582 Setting this option does not have an effect until the next time a file
2583 is read.
2584
2585 *'fileformat'* *'ff'*
2586'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2587 Unix default: "unix",
2588 Macintosh default: "mac")
2589 local to buffer
2590 {not in Vi}
2591 This gives the <EOL> of the current buffer, which is used for
2592 reading/writing the buffer from/to a file:
2593 dos <CR> <NL>
2594 unix <NL>
2595 mac <CR>
2596 When "dos" is used, CTRL-Z at the end of a file is ignored.
2597 See |file-formats| and |file-read|.
2598 For the character encoding of the file see 'fileencoding'.
2599 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2600 works like it was set to "unix'.
2601 This option is set automatically when starting to edit a file and
2602 'fileformats' is not empty and 'binary' is off.
2603 When this option is set, after starting to edit a file, the 'modified'
2604 option is set, because the file would be different when written.
2605 This option can not be changed when 'modifiable' is off.
2606 For backwards compatibility: When this option is set to "dos",
2607 'textmode' is set, otherwise 'textmode' is reset.
2608
2609 *'fileformats'* *'ffs'*
2610'fileformats' 'ffs' string (default:
2611 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2612 Vim Unix: "unix,dos",
2613 Vim Mac: "mac,unix,dos",
2614 Vi Cygwin: "unix,dos",
2615 Vi others: "")
2616 global
2617 {not in Vi}
2618 This gives the end-of-line (<EOL>) formats that will be tried when
2619 starting to edit a new buffer and when reading a file into an existing
2620 buffer:
2621 - When empty, the format defined with 'fileformat' will be used
2622 always. It is not set automatically.
2623 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002624 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 'fileformats' name will be used when a file is read into an existing
2626 buffer, no matter what 'fileformat' for that buffer is set to.
2627 - When more than one name is present, separated by commas, automatic
2628 <EOL> detection will be done when reading a file. When starting to
2629 edit a file, a check is done for the <EOL>:
2630 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2631 'fileformat' is set to "dos".
2632 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002633 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002634 preceding <CR>, "unix" is preferred over "dos".
2635 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2636 This means that "mac" is only chosen when "unix" is not present,
2637 or when no <NL> is found in the file, and when "dos" is not
2638 present, or no <CR><NL> is present in the file.
2639 Also if "unix" was first chosen, but the first <CR> is before
2640 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2641 the file, then 'fileformat' is set to "mac".
2642 4. If 'fileformat' is still not set, the first name from
2643 'fileformats' is used.
2644 When reading a file into an existing buffer, the same is done, but
2645 this happens like 'fileformat' has been set appropriately for that
2646 file only, the option is not changed.
2647 When 'binary' is set, the value of 'fileformats' is not used.
2648
2649 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2650 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2651 done:
2652 - When 'fileformats' is empty, there is no automatic detection. Dos
2653 format will be used.
2654 - When 'fileformats' is set to one or more names, automatic detection
2655 is done. This is based on the first <NL> in the file: If there is a
2656 <CR> in front of it, Dos format is used, otherwise Unix format is
2657 used.
2658 Also see |file-formats|.
2659 For backwards compatibility: When this option is set to an empty
2660 string or one format (no comma is included), 'textauto' is reset,
2661 otherwise 'textauto' is set.
2662 NOTE: This option is set to the Vi default value when 'compatible' is
2663 set and to the Vim default value when 'compatible' is reset.
2664
2665 *'filetype'* *'ft'*
2666'filetype' 'ft' string (default: "")
2667 local to buffer
2668 {not in Vi}
2669 {not available when compiled without the |+autocmd|
2670 feature}
2671 When this option is set, the FileType autocommand event is triggered.
2672 All autocommands that match with the value of this option will be
2673 executed. Thus the value of 'filetype' is used in place of the file
2674 name.
2675 Otherwise this option does not always reflect the current file type.
2676 This option is normally set when the file type is detected. To enable
2677 this use the ":filetype on" command. |:filetype|
2678 Setting this option to a different value is most useful in a modeline,
2679 for a file for which the file type is not automatically recognized.
2680 Example, for in an IDL file: >
2681 /* vim: set filetype=idl : */
2682< |FileType| |filetypes|
2683 Do not confuse this option with 'osfiletype', which is for the file
2684 type that is actually stored with the file.
2685 This option is not copied to another buffer, independent of the 's' or
2686 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002687 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688
2689 *'fillchars'* *'fcs'*
2690'fillchars' 'fcs' string (default "vert:|,fold:-")
2691 global
2692 {not in Vi}
2693 {not available when compiled without the |+windows|
2694 and |+folding| features}
2695 Characters to fill the statuslines and vertical separators.
2696 It is a comma separated list of items:
2697
2698 item default Used for ~
2699 stl:c ' ' or '^' statusline of the current window
2700 stlnc:c ' ' or '-' statusline of the non-current windows
2701 vert:c '|' vertical separators |:vsplit|
2702 fold:c '-' filling 'foldtext'
2703 diff:c '-' deleted lines of the 'diff' option
2704
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002705 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 "stlnc" the space will be used when there is highlighting, '^' or '-'
2707 otherwise.
2708
2709 Example: >
2710 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2711< This is similar to the default, except that these characters will also
2712 be used when there is highlighting.
2713
2714 The highlighting used for these items:
2715 item highlight group ~
2716 stl:c StatusLine |hl-StatusLine|
2717 stlnc:c StatusLineNC |hl-StatusLineNC|
2718 vert:c VertSplit |hl-VertSplit|
2719 fold:c Folded |hl-Folded|
2720 diff:c DiffDelete |hl-DiffDelete|
2721
2722 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2723'fkmap' 'fk' boolean (default off) *E198*
2724 global
2725 {not in Vi}
2726 {only available when compiled with the |+rightleft|
2727 feature}
2728 When on, the keyboard is mapped for the Farsi character set.
2729 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002730 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731
2732 *'foldclose'* *'fcl'*
2733'foldclose' 'fcl' string (default "")
2734 global
2735 {not in Vi}
2736 {not available when compiled without the |+folding|
2737 feature}
2738 When set to "all", a fold is closed when the cursor isn't in it and
2739 its level is higher than 'foldlevel'. Useful if you want folds to
2740 automatically close when moving out of them.
2741
2742 *'foldcolumn'* *'fdc'*
2743'foldcolumn' 'fdc' number (default 0)
2744 local to window
2745 {not in Vi}
2746 {not available when compiled without the |+folding|
2747 feature}
2748 When non-zero, a column with the specified width is shown at the side
2749 of the window which indicates open and closed folds. The maximum
2750 value is 12.
2751 See |folding|.
2752
2753 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2754'foldenable' 'fen' boolean (default on)
2755 local to window
2756 {not in Vi}
2757 {not available when compiled without the |+folding|
2758 feature}
2759 When off, all folds are open. This option can be used to quickly
2760 switch between showing all text unfolded and viewing the text with
2761 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002762 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 'foldenable' is off.
2764 This option is set by commands that create a new fold or close a fold.
2765 See |folding|.
2766
2767 *'foldexpr'* *'fde'*
2768'foldexpr' 'fde' string (default: "0")
2769 local to window
2770 {not in Vi}
2771 {not available when compiled without the |+folding|
2772 or |+eval| feature}
2773 The expression used for when 'foldmethod' is "expr". It is evaluated
2774 for each line to obtain its fold level. See |fold-expr|. Also see
2775 |eval-sandbox|.
2776
2777 *'foldignore'* *'fdi'*
2778'foldignore' 'fdi' string (default: "#")
2779 local to window
2780 {not in Vi}
2781 {not available when compiled without the |+folding|
2782 feature}
2783 Used only when 'foldmethod' is "indent". Lines starting with
2784 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002785 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 The default "#" works well for C programs. See |fold-indent|.
2787
2788 *'foldlevel'* *'fdl'*
2789'foldlevel' 'fdl' number (default: 0)
2790 local to window
2791 {not in Vi}
2792 {not available when compiled without the |+folding|
2793 feature}
2794 Sets the fold level: Folds with a higher level will be closed.
2795 Setting this option to zero will close all folds. Higher numbers will
2796 close fewer folds.
2797 This option is set by commands like |zm|, |zM| and |zR|.
2798 See |fold-foldlevel|.
2799
2800 *'foldlevelstart'* *'fdls'*
2801'foldlevelstart' 'fdls' number (default: -1)
2802 global
2803 {not in Vi}
2804 {not available when compiled without the |+folding|
2805 feature}
2806 Sets 'foldlevel' when starting to edit another buffer in a window.
2807 Useful to always start editing with all folds closed (value zero),
2808 some folds closed (one) or no folds closed (99).
2809 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002810 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 ignores this option and closes all folds.
2812 It is also done before BufReadPre autocommands, to allow an autocmd to
2813 overrule the 'foldlevel' value for specific files.
2814 When the value is negative, it is not used.
2815
2816 *'foldmarker'* *'fmr'* *E536*
2817'foldmarker' 'fmr' string (default: "{{{,}}}")
2818 local to window
2819 {not in Vi}
2820 {not available when compiled without the |+folding|
2821 feature}
2822 The start and end marker used when 'foldmethod' is "marker". There
2823 must be one comma, which separates the start and end marker. The
2824 marker is a literal string (a regular expression would be too slow).
2825 See |fold-marker|.
2826
2827 *'foldmethod'* *'fdm'*
2828'foldmethod' 'fdm' string (default: "manual")
2829 local to window
2830 {not in Vi}
2831 {not available when compiled without the |+folding|
2832 feature}
2833 The kind of folding used for the current window. Possible values:
2834 |fold-manual| manual Folds are created manually.
2835 |fold-indent| indent Lines with equal indent form a fold.
2836 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2837 |fold-marker| marker Markers are used to specify folds.
2838 |fold-syntax| syntax Syntax highlighting items specify folds.
2839 |fold-diff| diff Fold text that is not changed.
2840
2841 *'foldminlines'* *'fml'*
2842'foldminlines' 'fml' number (default: 1)
2843 local to window
2844 {not in Vi}
2845 {not available when compiled without the |+folding|
2846 feature}
2847 Sets the minimum number of screen lines for a fold to be displayed
2848 closed. Also for manually closed folds.
2849 Note that this only has an effect of what is displayed. After using
2850 "zc" to close a fold, which is displayed open because it's smaller
2851 than 'foldminlines', a following "zc" may close a containing fold.
2852
2853 *'foldnestmax'* *'fdn'*
2854'foldnestmax' 'fdn' number (default: 20)
2855 local to window
2856 {not in Vi}
2857 {not available when compiled without the |+folding|
2858 feature}
2859 Sets the maximum nesting of folds for the "indent" and "syntax"
2860 methods. This avoids that too many folds will be created. Using more
2861 than 20 doesn't work, because the internal limit is 20.
2862
2863 *'foldopen'* *'fdo'*
2864'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2865 search,tag,undo")
2866 global
2867 {not in Vi}
2868 {not available when compiled without the |+folding|
2869 feature}
2870 Specifies for which type of commands folds will be opened, if the
2871 command moves the cursor into a closed fold. It is a comma separated
2872 list of items.
2873 item commands ~
2874 all any
2875 block "(", "{", "[[", "[{", etc.
2876 hor horizontal movements: "l", "w", "fx", etc.
2877 insert any command in Insert mode
2878 jump far jumps: "G", "gg", etc.
2879 mark jumping to a mark: "'m", CTRL-O, etc.
2880 percent "%"
2881 quickfix ":cn", ":crew", ":make", etc.
2882 search search for a pattern: "/", "n", "*", "gd", etc.
2883 (not for a search pattern in a ":" command)
2884 tag jumping to a tag: ":ta", CTRL-T, etc.
2885 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002886 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 the |zv| command to the mapping to get the same effect.
2888 When a movement command is used for an operator (e.g., "dl" or "y%")
2889 this option is not used. This means the operator will include the
2890 whole closed fold.
2891 Note that vertical movements are not here, because it would make it
2892 very difficult to move onto a closed fold.
2893 In insert mode the folds containing the cursor will always be open
2894 when text is inserted.
2895 To close folds you can re-apply 'foldlevel' with the |zx| command or
2896 set the 'foldclose' option to "all".
2897
2898 *'foldtext'* *'fdt'*
2899'foldtext' 'fdt' string (default: "foldtext()")
2900 local to window
2901 {not in Vi}
2902 {not available when compiled without the |+folding|
2903 feature}
2904 An expression which is used to specify the text displayed for a closed
2905 fold. See |fold-foldtext|.
2906
2907 *'formatoptions'* *'fo'*
2908'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2909 local to buffer
2910 {not in Vi}
2911 This is a sequence of letters which describes how automatic
2912 formatting is to be done. See |fo-table|. When the 'paste' option is
2913 on, no formatting is done (like 'formatoptions' is empty). Commas can
2914 be inserted for readability.
2915 To avoid problems with flags that are added in the future, use the
2916 "+=" and "-=" feature of ":set" |add-option-flags|.
2917 NOTE: This option is set to the Vi default value when 'compatible' is
2918 set and to the Vim default value when 'compatible' is reset.
2919
Bram Moolenaar86b68352004-12-27 21:59:20 +00002920 *'formatlistpat'* *'flp'*
2921'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2922 local to buffer
2923 {not in Vi}
2924 A pattern that is used to recognize a list header. This is used for
2925 the "n" flag in 'formatoptions'.
2926 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002927 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002928 while still checking more characters. There must be a character
2929 following the pattern, when it matches the whole line it is handled
2930 like there is no match.
2931 The default recognizes a number, followed by an optional punctuation
2932 character and white space.
2933
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934 *'formatprg'* *'fp'*
2935'formatprg' 'fp' string (default "")
2936 global
2937 {not in Vi}
2938 The name of an external program that will be used to format the lines
2939 selected with the "gq" command. The program must take the input on
2940 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002941 such a program.
2942 If this option is an empty string, the internal format function will
2943 be used |C-indenting|.
2944 Environment variables are expanded |:set_env|. See |option-backslash|
2945 about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 This option cannot be set from a |modeline| or in the |sandbox|, for
2947 security reasons.
2948
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002949 *'fsync'* *'fs'*
2950'fsync' 'fs' boolean (default on)
2951 global
2952 {not in Vi}
2953 When on, the library function fsync() will be called after writing a
2954 file. This will flush a file to disk, ensuring that it is safely
2955 written even on filesystems which do metadata-only journaling. This
2956 will force the harddrive to spin up on Linux systems running in laptop
2957 mode, so it may be undesirable in some situations. Be warned that
2958 turning this off increases the chances of data loss after a crash. On
2959 systems without an fsync() implementation, this variable is always
2960 off.
2961 Also see 'swapsync' for controlling fsync() on swap files.
2962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2964'gdefault' 'gd' boolean (default off)
2965 global
2966 {not in Vi}
2967 When on, the ":substitute" flag 'g' is default on. This means that
2968 all matches in a line are substituted instead of one. When a 'g' flag
2969 is given to a ":substitute" command, this will toggle the substitution
2970 of all or one match. See |complex-change|.
2971
2972 command 'gdefault' on 'gdefault' off ~
2973 :s/// subst. all subst. one
2974 :s///g subst. one subst. all
2975 :s///gg subst. all subst. one
2976
2977 NOTE: This option is reset when 'compatible' is set.
2978
2979 *'grepformat'* *'gfm'*
2980'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2981 global
2982 {not in Vi}
2983 Format to recognize for the ":grep" command output.
2984 This is a scanf-like string that uses the same format as the
2985 'errorformat' option: see |errorformat|.
2986
2987 *'grepprg'* *'gp'*
2988'grepprg' 'gp' string (default "grep -n ",
2989 Unix: "grep -n $* /dev/null",
2990 Win32: "findstr /n" or "grep -n",
2991 VMS: "SEARCH/NUMBERS ")
2992 global or local to buffer |global-local|
2993 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002994 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 and '#' characters, which are expanded like when used in a command-
2996 line. The placeholder "$*" is allowed to specify where the arguments
2997 will be included. Environment variables are expanded |:set_env|. See
2998 |option-backslash| about including spaces and backslashes.
2999 When your "grep" accepts the "-H" argument, use this to make ":grep"
3000 also work well with a single file: >
3001 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003002< Special value: When 'grepprg' is set to "internal" the |:grep| command
3003 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003004 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 apply equally to 'grepprg'.
3006 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3007 otherwise it's "grep -n".
3008 This option cannot be set from a |modeline| or in the |sandbox|, for
3009 security reasons.
3010
3011 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3012'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3013 ve:ver35-Cursor,
3014 o:hor50-Cursor,
3015 i-ci:ver25-Cursor/lCursor,
3016 r-cr:hor20-Cursor/lCursor,
3017 sm:block-Cursor
3018 -blinkwait175-blinkoff150-blinkon175",
3019 for MS-DOS and Win32 console:
3020 "n-v-c:block,o:hor50,i-ci:hor15,
3021 r-cr:hor30,sm:block")
3022 global
3023 {not in Vi}
3024 {only available when compiled with GUI enabled, and
3025 for MS-DOS and Win32 console}
3026 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003027 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 the height of the cursor can be changed. This can be done by
3029 specifying a block cursor, or a percentage for a vertical or
3030 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003031 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003033 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 mode-list and an argument-list:
3035 mode-list:argument-list,mode-list:argument-list,..
3036 The mode-list is a dash separated list of these modes:
3037 n Normal mode
3038 v Visual mode
3039 ve Visual mode with 'selection' "exclusive" (same as 'v',
3040 if not specified)
3041 o Operator-pending mode
3042 i Insert mode
3043 r Replace mode
3044 c Command-line Normal (append) mode
3045 ci Command-line Insert mode
3046 cr Command-line Replace mode
3047 sm showmatch in Insert mode
3048 a all modes
3049 The argument-list is a dash separated list of these arguments:
3050 hor{N} horizontal bar, {N} percent of the character height
3051 ver{N} vertical bar, {N} percent of the character width
3052 block block cursor, fills the whole character
3053 [only one of the above three should be present]
3054 blinkwait{N} *cursor-blinking*
3055 blinkon{N}
3056 blinkoff{N}
3057 blink times for cursor: blinkwait is the delay before
3058 the cursor starts blinking, blinkon is the time that
3059 the cursor is shown and blinkoff is the time that the
3060 cursor is not shown. The times are in msec. When one
3061 of the numbers is zero, there is no blinking. The
3062 default is: "blinkwait700-blinkon400-blinkoff250".
3063 These numbers are used for a missing entry. This
3064 means that blinking is enabled by default. To switch
3065 blinking off you can use "blinkon0". The cursor only
3066 blinks when Vim is waiting for input, not while
3067 executing a command.
3068 To make the cursor blink in an xterm, see
3069 |xterm-blink|.
3070 {group-name}
3071 a highlight group name, that sets the color and font
3072 for the cursor
3073 {group-name}/{group-name}
3074 Two highlight group names, the first is used when
3075 no language mappings are used, the other when they
3076 are. |language-mapping|
3077
3078 Examples of parts:
3079 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3080 block cursor with colors from the "nCursor"
3081 highlight group
3082 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3083 In Insert and Command-line Insert mode, use a
3084 30% vertical bar cursor with colors from the
3085 "iCursor" highlight group. Blink a bit
3086 faster.
3087
3088 The 'a' mode is different. It will set the given argument-list for
3089 all modes. It does not reset anything to defaults. This can be used
3090 to do a common setting for all modes. For example, to switch off
3091 blinking: "a:blinkon0"
3092
3093 Examples of cursor highlighting: >
3094 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3095 :highlight Cursor gui=NONE guifg=bg guibg=fg
3096<
3097 *'guifont'* *'gfn'*
3098 *E235* *E596* *E610* *E611*
3099'guifont' 'gfn' string (default "")
3100 global
3101 {not in Vi}
3102 {only available when compiled with GUI enabled}
3103 This is a list of fonts which will be used for the GUI version of Vim.
3104 In its simplest form the value is just one font name. When
3105 the font cannot be found you will get an error message. To try other
3106 font names a list can be specified, font names separated with commas.
3107 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003108
Bram Moolenaar05159a02005-02-26 23:04:13 +00003109 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3110 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 Spaces after a comma are ignored. To include a comma in a font name
3113 precede it with a backslash. Setting an option requires an extra
3114 backslash before a space and a backslash. See also
3115 |option-backslash|. For example: >
3116 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003117< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003119
3120 If none of the fonts can be loaded, Vim will keep the current setting.
3121 If an empty font list is given, Vim will try using other resource
3122 settings (for X, it will use the Vim.font resource), and finally it
3123 will try some builtin default which should always be there ("7x13" in
3124 the case of X). The font names given should be "normal" fonts. Vim
3125 will try to find the related bold and italic fonts.
3126
Bram Moolenaar05159a02005-02-26 23:04:13 +00003127 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003128 :set guifont=*
3129< will bring up a font requester, where you can pick the font you want.
3130
3131 The font name depends on the GUI used. See |setting-guifont| for a
3132 way to set 'guifont' for various systems.
3133
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 For the GTK+ 2 GUI the font name looks like this: >
3135 :set guifont=Andale\ Mono\ 11
3136< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003137
3138 For Mac OSX you can use something like this: >
3139 :set guifont=Monaco:h10
3140< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003142 width). An exception is GTK 2: all fonts are accepted, but
3143 mono-spaced fonts look best.
3144
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 To preview a font on X11, you might be able to use the "xfontsel"
3146 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003147
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 For the Win32 GUI *E244* *E245*
3149 - takes these options in the font name:
3150 hXX - height is XX (points, can be floating-point)
3151 wXX - width is XX (points, can be floating-point)
3152 b - bold
3153 i - italic
3154 u - underline
3155 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003156 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3158 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3159 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003160 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161
3162 Use a ':' to separate the options.
3163 - A '_' can be used in the place of a space, so you don't need to use
3164 backslashes to escape the spaces.
3165 - Examples: >
3166 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3167 :set guifont=Andale_Mono:h7.5:w4.5
3168< See also |font-sizes|.
3169
3170 *'guifontset'* *'gfs'*
3171 *E250* *E252* *E234* *E597* *E598*
3172'guifontset' 'gfs' string (default "")
3173 global
3174 {not in Vi}
3175 {only available when compiled with GUI enabled and
3176 with the |+xfontset| feature}
3177 {not available in the GTK+ 2 GUI}
3178 When not empty, specifies two (or more) fonts to be used. The first
3179 one for normal English, the second one for your special language. See
3180 |xfontset|.
3181 Setting this option also means that all font names will be handled as
3182 a fontset name. Also the ones used for the "font" argument of the
3183 |:highlight| command.
3184 The fonts must match with the current locale. If fonts for the
3185 character sets that the current locale uses are not included, setting
3186 'guifontset' will fail.
3187 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3188 the comma-separated names are alternative names, one of which will be
3189 used. In 'guifontset' the whole string is one fontset name,
3190 including the commas. It is not possible to specify alternative
3191 fontset names.
3192 This example works on many X11 systems: >
3193 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3194<
3195 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3196'guifontwide' 'gfw' string (default "")
3197 global
3198 {not in Vi}
3199 {only available when compiled with GUI enabled}
3200 When not empty, specifies a comma-separated list of fonts to be used
3201 for double-width characters. The first font that can be loaded is
3202 used.
3203 Note: The size of these fonts must be exactly twice as wide as the one
3204 specified with 'guifont' and the same height.
3205
3206 All GUI versions but GTK+ 2:
3207
3208 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3209 'guifontset' is empty or invalid.
3210 When 'guifont' is set and a valid font is found in it and
3211 'guifontwide' is empty Vim will attempt to find a matching
3212 double-width font and set 'guifontwide' to it.
3213
3214 GTK+ 2 GUI only: *guifontwide_gtk2*
3215
3216 If set and valid, 'guifontwide' is always used for double width
3217 characters, even if 'encoding' is not set to "utf-8".
3218 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003219 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003220 font for characters not available in 'guifont'. Thus you do not need
3221 to set 'guifontwide' at all unless you want to override the choice
3222 made by Pango/Xft.
3223
3224 *'guiheadroom'* *'ghr'*
3225'guiheadroom' 'ghr' number (default 50)
3226 global
3227 {not in Vi} {only for GTK and X11 GUI}
3228 The number of pixels subtracted from the screen height when fitting
3229 the GUI window on the screen. Set this before the GUI is started,
3230 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 lines will be left for window decorations and other items on the
3233 screen. Set it to a negative value to allow windows taller than the
3234 screen.
3235
3236 *'guioptions'* *'go'*
3237'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003238 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 global
3240 {not in Vi}
3241 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003242 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 sequence of letters which describes what components and options of the
3244 GUI should be used.
3245 To avoid problems with flags that are added in the future, use the
3246 "+=" and "-=" feature of ":set" |add-option-flags|.
3247
3248 Valid letters are as follows:
3249 *guioptions_a*
3250 'a' Autoselect: If present, then whenever VISUAL mode is started,
3251 or the Visual area extended, Vim tries to become the owner of
3252 the windowing system's global selection. This means that the
3253 Visually highlighted text is available for pasting into other
3254 applications as well as into Vim itself. When the Visual mode
3255 ends, possibly due to an operation on the text, or when an
3256 application wants to paste the selection, the highlighted text
3257 is automatically yanked into the "* selection register.
3258 Thus the selection is still available for pasting into other
3259 applications after the VISUAL mode has ended.
3260 If not present, then Vim won't become the owner of the
3261 windowing system's global selection unless explicitly told to
3262 by a yank or delete operation for the "* register.
3263 The same applies to the modeless selection.
3264
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003265 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 applies to the modeless selection.
3267
3268 'guioptions' autoselect Visual autoselect modeless ~
3269 "" - -
3270 "a" yes yes
3271 "A" - yes
3272 "aA" yes yes
3273
3274 'c' Use console dialogs instead of popup dialogs for simple
3275 choices.
3276
3277 'f' Foreground: Don't use fork() to detach the GUI from the shell
3278 where it was started. Use this for programs that wait for the
3279 editor to finish (e.g., an e-mail program). Alternatively you
3280 can use "gvim -f" or ":gui -f" to start the GUI in the
3281 foreground. |gui-fork|
3282 Note: Set this option in the vimrc file. The forking may have
3283 happened already when the gvimrc file is read.
3284
3285 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3286 corner of the window. It's black&white on non-GTK, because of
3287 limitations of X11. For a color icon, see |X11-icon|.
3288
3289 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 that this flag must be added in the .vimrc file, before
3292 switching on syntax or filetype recognition (when the .gvimrc
3293 file is sourced the system menu has already been loaded; the
3294 ":syntax on" and ":filetype on" commands load the menu too).
3295 'g' Grey menu items: Make menu items that are not active grey. If
3296 'g' is not included inactive menu items are not shown at all.
3297 Exception: Athena will always use grey menu items.
3298
3299 't' Include tearoff menu items. Currently only works for Win32,
3300 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003301 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3302 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303
3304 'r' Right-hand scrollbar is always present.
3305 'R' Right-hand scrollbar is present when there is a vertically
3306 split window.
3307 'l' Left-hand scrollbar is always present.
3308 'L' Left-hand scrollbar is present when there is a vertically
3309 split window.
3310 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3311 the longest visible line, or on the cursor line if the 'h'
3312 flag is included. |gui-horiz-scroll|
3313 'h' Limit horizontal scrollbar size to the length of the cursor
3314 line. Reduces computations. |gui-horiz-scroll|
3315
3316 And yes, you may even have scrollbars on the left AND the right if
3317 you really want to :-). See |gui-scrollbars| for more information.
3318
3319 'v' Use a vertical button layout for dialogs. When not included,
3320 a horizontal layout is preferred, but when it doesn't fit a
3321 vertical layout is used anyway.
3322 'p' Use Pointer callbacks for X11 GUI. This is required for some
3323 window managers. If the cursor is not blinking or hollow at
3324 the right moment, try adding this flag. This must be done
3325 before starting the GUI. Set it in your gvimrc. Adding or
3326 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003327 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003328
3329 *'guipty'* *'noguipty'*
3330'guipty' boolean (default on)
3331 global
3332 {not in Vi}
3333 {only available when compiled with GUI enabled}
3334 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3335 I/O to/from shell commands. See |gui-pty|.
3336
3337 *'helpfile'* *'hf'*
3338'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3339 (others) "$VIMRUNTIME/doc/help.txt")
3340 global
3341 {not in Vi}
3342 Name of the main help file. All distributed help files should be
3343 placed together in one directory. Additionally, all "doc" directories
3344 in 'runtimepath' will be used.
3345 Environment variables are expanded |:set_env|. For example:
3346 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003347 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003348 spaces and backslashes.
3349 This option cannot be set from a |modeline| or in the |sandbox|, for
3350 security reasons.
3351
3352 *'helpheight'* *'hh'*
3353'helpheight' 'hh' number (default 20)
3354 global
3355 {not in Vi}
3356 {not available when compiled without the +windows
3357 feature}
3358 Minimal initial height of the help window when it is opened with the
3359 ":help" command. The initial height of the help window is half of the
3360 current window, or (when the 'ea' option is on) the same as other
3361 windows. When the height is less than 'helpheight', the height is
3362 set to 'helpheight'. Set to zero to disable.
3363
3364 *'helplang'* *'hlg'*
3365'helplang' 'hlg' string (default: messages language or empty)
3366 global
3367 {only available when compiled with the |+multi_lang|
3368 feature}
3369 {not in Vi}
3370 Comma separated list of languages. Vim will use the first language
3371 for which the desired help can be found. The English help will always
3372 be used as a last resort. You can add "en" to prefer English over
3373 another language, but that will only find tags that exist in that
3374 language and not in the English help.
3375 Example: >
3376 :set helplang=de,it
3377< This will first search German, then Italian and finally English help
3378 files.
3379 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3380 try to find the tag in the current language before using this option.
3381 See |help-translated|.
3382
3383 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3384'hidden' 'hid' boolean (default off)
3385 global
3386 {not in Vi}
3387 When off a buffer is unloaded when it is |abandon|ed. When on a
3388 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3389 displayed in another window, it does not become hidden, of course.
3390 The commands that move through the buffer list sometimes make a buffer
3391 hidden although the 'hidden' option is off: When the buffer is
3392 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003393 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003394 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 This option is set for one command with ":hide {command}" |:hide|.
3396 WARNING: It's easy to forget that you have changes in hidden buffers.
3397 Think twice when using ":q!" or ":qa!".
3398
3399 *'highlight'* *'hl'*
3400'highlight' 'hl' string (default (as a single string):
3401 "8:SpecialKey,@:NonText,d:Directory,
3402 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3403 M:ModeMsg,n:LineNr,r:Question,
3404 s:StatusLine,S:StatusLineNC,c:VertSplit
3405 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3406 f:Folded,F:FoldColumn,A:DiffAdd,
3407 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003408 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003409 R:SpellRare,L:SpellLocal,
3410 +:Pmenu,=:PmenuSel,
3411 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 global
3413 {not in Vi}
3414 This option can be used to set highlighting mode for various
3415 occasions. It is a comma separated list of character pairs. The
3416 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003417 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3419 |hl-NonText| @ '~' and '@' at the end of the window and
3420 characters from 'showbreak'
3421 |hl-Directory| d directories in CTRL-D listing and other special
3422 things in listings
3423 |hl-ErrorMsg| e error messages
3424 h (obsolete, ignored)
3425 |hl-IncSearch| i 'incsearch' highlighting
3426 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3427 |hl-MoreMsg| m |more-prompt|
3428 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3429 |hl-LineNr| n line number for ":number" and ":#" commands
3430 |hl-Question| r |hit-enter| prompt and yes/no questions
3431 |hl-StatusLine| s status line of current window |status-line|
3432 |hl-StatusLineNC| S status lines of not-current windows
3433 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3434 |hl-VertSplit| c column used to separate vertically split windows
3435 |hl-Visual| v Visual mode
3436 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3437 Selection" Only X11 Gui's |gui-x11| and
3438 |xterm-clipboard|.
3439 |hl-WarningMsg| w warning messages
3440 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3441 |hl-Folded| f line used for closed folds
3442 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003443 |hl-DiffAdd| A added line in diff mode
3444 |hl-DiffChange| C changed line in diff mode
3445 |hl-DiffDelete| D deleted line in diff mode
3446 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003448 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003449 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003450 |hl-SpellRare| R rare word |spell|
3451 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003452 |hl-Pmenu| + popup menu normal line
3453 |hl-PmenuSel| = popup menu normal line
3454 |hl-PmenuSbar| x popup menu scrollbar
3455 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456
3457 The display modes are:
3458 r reverse (termcap entry "mr" and "me")
3459 i italic (termcap entry "ZH" and "ZR")
3460 b bold (termcap entry "md" and "me")
3461 s standout (termcap entry "so" and "se")
3462 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003463 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 n no highlighting
3465 - no highlighting
3466 : use a highlight group
3467 The default is used for occasions that are not included.
3468 If you want to change what the display modes do, see |dos-colors|
3469 for an example.
3470 When using the ':' display mode, this must be followed by the name of
3471 a highlight group. A highlight group can be used to define any type
3472 of highlighting, including using color. See |:highlight| on how to
3473 define one. The default uses a different group for each occasion.
3474 See |highlight-default| for the default highlight groups.
3475
3476 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3477'hlsearch' 'hls' boolean (default off)
3478 global
3479 {not in Vi}
3480 {not available when compiled without the
3481 |+extra_search| feature}
3482 When there is a previous search pattern, highlight all its matches.
3483 The type of highlighting used can be set with the 'l' occasion in the
3484 'highlight' option. This uses the "Search" highlight group by
3485 default. Note that only the matching text is highlighted, any offsets
3486 are not applied.
3487 See also: 'incsearch' and |:match|.
3488 When you get bored looking at the highlighted matches, you can turn it
3489 off with |:nohlsearch|. As soon as you use a search command, the
3490 highlighting comes back.
3491 When the search pattern can match an end-of-line, Vim will try to
3492 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003493 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 line below a closed fold. A match in a previous line which is not
3495 drawn may not continue in an newly drawn line.
3496 NOTE: This option is reset when 'compatible' is set.
3497
3498 *'history'* *'hi'*
3499'history' 'hi' number (Vim default: 20, Vi default: 0)
3500 global
3501 {not in Vi}
3502 A history of ":" commands, and a history of previous search patterns
3503 are remembered. This option decides how many entries may be stored in
3504 each of these histories (see |cmdline-editing|).
3505 NOTE: This option is set to the Vi default value when 'compatible' is
3506 set and to the Vim default value when 'compatible' is reset.
3507
3508 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3509'hkmap' 'hk' boolean (default off)
3510 global
3511 {not in Vi}
3512 {only available when compiled with the |+rightleft|
3513 feature}
3514 When on, the keyboard is mapped for the Hebrew character set.
3515 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3516 toggle this option. See |rileft.txt|.
3517 NOTE: This option is reset when 'compatible' is set.
3518
3519 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3520'hkmapp' 'hkp' boolean (default off)
3521 global
3522 {not in Vi}
3523 {only available when compiled with the |+rightleft|
3524 feature}
3525 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3526 This is useful if you have a non-Hebrew keyboard.
3527 See |rileft.txt|.
3528 NOTE: This option is reset when 'compatible' is set.
3529
3530 *'icon'* *'noicon'*
3531'icon' boolean (default off, on when title can be restored)
3532 global
3533 {not in Vi}
3534 {not available when compiled without the |+title|
3535 feature}
3536 When on, the icon text of the window will be set to the value of
3537 'iconstring' (if it is not empty), or to the name of the file
3538 currently being edited. Only the last part of the name is used.
3539 Overridden by the 'iconstring' option.
3540 Only works if the terminal supports setting window icons (currently
3541 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3542 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3543 builtin termcap).
3544 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003545 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 X11.
3547
3548 *'iconstring'*
3549'iconstring' string (default "")
3550 global
3551 {not in Vi}
3552 {not available when compiled without the |+title|
3553 feature}
3554 When this option is not empty, it will be used for the icon text of
3555 the window. This happens only when the 'icon' option is on.
3556 Only works if the terminal supports setting window icon text
3557 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3558 Does not work for MS Windows.
3559 When Vim was compiled with HAVE_X11 defined, the original icon will be
3560 restored if possible |X11|.
3561 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003562 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 'titlestring' for example settings.
3564 {not available when compiled without the |+statusline| feature}
3565
3566 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3567'ignorecase' 'ic' boolean (default off)
3568 global
3569 Ignore case in search patterns. Also used when searching in the tags
3570 file.
3571 Also see 'smartcase'.
3572 Can be overruled by using "\c" or "\C" in the pattern, see
3573 |/ignorecase|.
3574
3575 *'imactivatekey'* *'imak'*
3576'imactivatekey' 'imak' string (default "")
3577 global
3578 {not in Vi}
3579 {only available when compiled with |+xim| and
3580 |+GUI_GTK|}
3581 Specifies the key that your Input Method in X-Windows uses for
3582 activation. When this is specified correctly, vim can fully control
3583 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3584 You can't use this option to change the activation key, the option
3585 tells Vim what the key is.
3586 Format:
3587 [MODIFIER_FLAG-]KEY_STRING
3588
3589 These characters can be used for MODIFIER_FLAG (case is ignored):
3590 S Shift key
3591 L Lock key
3592 C Control key
3593 1 Mod1 key
3594 2 Mod2 key
3595 3 Mod3 key
3596 4 Mod4 key
3597 5 Mod5 key
3598 Combinations are allowed, for example "S-C-space" or "SC-space" are
3599 both shift+ctrl+space.
3600 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3601
3602 Example: >
3603 :set imactivatekey=S-space
3604< "S-space" means shift+space. This is the activation key for kinput2 +
3605 canna (Japanese), and ami (Korean).
3606
3607 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3608'imcmdline' 'imc' boolean (default off)
3609 global
3610 {not in Vi}
3611 {only available when compiled with the |+xim|
3612 |+multi_byte_ime| or |global-ime| feature}
3613 When set the Input Method is always on when starting to edit a command
3614 line, unless entering a search pattern (see 'imsearch' for that).
3615 Setting this option is useful when your input method allows entering
3616 English characters directly, e.g., when it's used to type accented
3617 characters with dead keys.
3618
3619 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3620'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3621 global
3622 {not in Vi}
3623 {only available when compiled with the |+xim|
3624 |+multi_byte_ime| or |global-ime| feature}
3625 When set the Input Method is never used. This is useful to disable
3626 the IM when it doesn't work properly.
3627 Currently this option is on by default for SGI/IRIX machines. This
3628 may change in later releases.
3629
3630 *'iminsert'* *'imi'*
3631'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3632 local to buffer
3633 {not in Vi}
3634 Specifies whether :lmap or an Input Method (IM) is to be used in
3635 Insert mode. Valid values:
3636 0 :lmap is off and IM is off
3637 1 :lmap is ON and IM is off
3638 2 :lmap is off and IM is ON
3639 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3640 or |global-ime|.
3641 To always reset the option to zero when leaving Insert mode with <Esc>
3642 this can be used: >
3643 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3644< This makes :lmap and IM turn off automatically when leaving Insert
3645 mode.
3646 Note that this option changes when using CTRL-^ in Insert mode
3647 |i_CTRL-^|.
3648 The value is set to 1 when setting 'keymap' to a valid keymap name.
3649 It is also used for the argument of commands like "r" and "f".
3650 The value 0 may not work correctly with Athena and Motif with some XIM
3651 methods. Use 'imdisable' to disable XIM then.
3652
3653 *'imsearch'* *'ims'*
3654'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3655 local to buffer
3656 {not in Vi}
3657 Specifies whether :lmap or an Input Method (IM) is to be used when
3658 entering a search pattern. Valid values:
3659 -1 the value of 'iminsert' is used, makes it look like
3660 'iminsert' is also used when typing a search pattern
3661 0 :lmap is off and IM is off
3662 1 :lmap is ON and IM is off
3663 2 :lmap is off and IM is ON
3664 Note that this option changes when using CTRL-^ in Command-line mode
3665 |c_CTRL-^|.
3666 The value is set to 1 when it is not -1 and setting the 'keymap'
3667 option to a valid keymap name.
3668 The value 0 may not work correctly with Athena and Motif with some XIM
3669 methods. Use 'imdisable' to disable XIM then.
3670
3671 *'include'* *'inc'*
3672'include' 'inc' string (default "^\s*#\s*include")
3673 global or local to buffer |global-local|
3674 {not in Vi}
3675 {not available when compiled without the
3676 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003677 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 pattern, just like for the "/" command (See |pattern|). The default
3679 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003680 "]I", "[d", etc.
3681 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003682 comes after the matched pattern. But if "\zs" appears in the pattern
3683 then the text matched from "\zs" to the end, or until "\ze" if it
3684 appears, is used as the file name. Use this to include characters
3685 that are not in 'isfname', such as a space. You can then use
3686 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003687 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688
3689 *'includeexpr'* *'inex'*
3690'includeexpr' 'inex' string (default "")
3691 local to buffer
3692 {not in Vi}
3693 {not available when compiled without the
3694 |+find_in_path| or |+eval| feature}
3695 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003696 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 :set includeexpr=substitute(v:fname,'\\.','/','g')
3698< The "v:fname" variable will be set to the file name that was detected.
3699 Evaluated in the |sandbox|.
3700 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003701 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 Also used for |<cfile>|.
3703
3704 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3705'incsearch' 'is' boolean (default off)
3706 global
3707 {not in Vi}
3708 {not available when compiled without the
3709 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003710 While typing a search command, show where the pattern, as it was typed
3711 so far, matches. The matched string is highlighted. If the pattern
3712 is invalid or not found, nothing is shown. The screen will be updated
3713 often, this is only useful on fast terminals.
3714 Note that the match will be shown, but the cursor will return to its
3715 original position when no match is found and when pressing <Esc>. You
3716 still need to finish the search command with <Enter> to move the
3717 cursor to the match.
3718 The highlighting can be set with the 'i' flag in 'highlight'.
3719 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003720 NOTE: This option is reset when 'compatible' is set.
3721
3722 *'indentexpr'* *'inde'*
3723'indentexpr' 'inde' string (default "")
3724 local to buffer
3725 {not in Vi}
3726 {not available when compiled without the |+cindent|
3727 or |+eval| features}
3728 Expression which is evaluated to obtain the proper indent for a line.
3729 It is used when a new line is created, for the |=| operator and
3730 in Insert mode as specified with the 'indentkeys' option.
3731 When this option is not empty, it overrules the 'cindent' and
3732 'smartindent' indenting.
3733 When 'paste' is set this option is not used for indenting.
3734 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003735 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736 when the expression is evaluated (but it may be moved around).
3737 The expression must return the number of spaces worth of indent. It
3738 can return "-1" to keep the current indent (this means 'autoindent' is
3739 used for the indent).
3740 Functions useful for computing the indent are |indent()|, |cindent()|
3741 and |lispindent()|.
3742 The evaluation of the expression must not have side effects! It must
3743 not change the text, jump to another window, etc. Afterwards the
3744 cursor position is always restored, thus the cursor may be moved.
3745 Normally this option would be set to call a function: >
3746 :set indentexpr=GetMyIndent()
3747< Error messages will be suppressed, unless the 'debug' option contains
3748 "msg".
3749 See |indent-expression|. Also see |eval-sandbox|.
3750 NOTE: This option is made empty when 'compatible' is set.
3751
3752 *'indentkeys'* *'indk'*
3753'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3754 local to buffer
3755 {not in Vi}
3756 {not available when compiled without the |+cindent|
3757 feature}
3758 A list of keys that, when typed in Insert mode, cause reindenting of
3759 the current line. Only happens if 'indentexpr' isn't empty.
3760 The format is identical to 'cinkeys', see |indentkeys-format|.
3761 See |C-indenting| and |indent-expression|.
3762
3763 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3764'infercase' 'inf' boolean (default off)
3765 local to buffer
3766 {not in Vi}
3767 When doing keyword completion in insert mode |ins-completion|, and
3768 'ignorecase' is also on, the case of the match is adjusted. If the
3769 typed text contains a lowercase letter where the match has an upper
3770 case letter, the completed part is made lowercase. If the typed text
3771 has no lowercase letters and the match has a lowercase letter where
3772 the typed text has an uppercase letter, and there is a letter before
3773 it, the completed part is made uppercase.
3774
3775 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3776'insertmode' 'im' boolean (default off)
3777 global
3778 {not in Vi}
3779 Makes Vim work in a way that Insert mode is the default mode. Useful
3780 if you want to use Vim as a modeless editor. Used for |evim|.
3781 These Insert mode commands will be useful:
3782 - Use the cursor keys to move around.
3783 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3784 this is a mapping, it is executed as if 'insertmode' was off.
3785 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003787 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3788 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789
3790 These items change when 'insertmode' is set:
3791 - when starting to edit of a file, Vim goes to Insert mode.
3792 - <Esc> in Insert mode is a no-op and beeps.
3793 - <Esc> in Normal mode makes Vim go to Insert mode.
3794 - CTRL-L in Insert mode is a command, it is not inserted.
3795 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3796 However, when <Esc> is used inside a mapping, it behaves like
3797 'insertmode' was not set. This was done to be able to use the same
3798 mappings with 'insertmode' set or not set.
3799 When executing commands with |:normal| 'insertmode' is not used.
3800
3801 NOTE: This option is reset when 'compatible' is set.
3802
3803 *'isfname'* *'isf'*
3804'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3805 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3806 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3807 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3808 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3809 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3810 global
3811 {not in Vi}
3812 The characters specified by this option are included in file names and
3813 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003814 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 Multi-byte characters 256 and above are always included, only the
3816 characters up to 255 are specified with this option.
3817 For UTF-8 the characters 0xa0 to 0xff are included as well.
3818
3819 Note that on systems using a backslash as path separator, Vim tries to
3820 do its best to make it work as you would expect. That is a bit
3821 tricky, since Vi originally used the backslash to escape special
3822 characters. Vim will not remove a backslash in front of a normal file
3823 name character on these systems, but it will on Unix and alikes. The
3824 '&' and '^' are not included by default, because these are special for
3825 cmd.exe.
3826
3827 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003828 Each part can be a single character number or a range. A range is two
3829 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 decimal number between 0 and 255 or the ASCII character itself (does
3831 not work for digits). Example:
3832 "_,-,128-140,#-43" (include '_' and '-' and the range
3833 128 to 140 and '#' to 43)
3834 If a part starts with '^', the following character number or range
3835 will be excluded from the option. The option is interpreted from left
3836 to right. Put the excluded character after the range where it is
3837 included. To include '^' itself use it as the last character of the
3838 option or the end of a range. Example:
3839 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3840 If the character is '@', all characters where isalpha() returns TRUE
3841 are included. Normally these are the characters a to z and A to Z,
3842 plus accented characters. To include '@' itself use "@-@". Examples:
3843 "@,^a-z" All alphabetic characters, excluding lower
3844 case letters.
3845 "a-z,A-Z,@-@" All letters plus the '@' character.
3846 A comma can be included by using it where a character number is
3847 expected. Example:
3848 "48-57,,,_" Digits, comma and underscore.
3849 A comma can be excluded by prepending a '^'. Example:
3850 " -~,^,,9" All characters from space to '~', excluding
3851 comma, plus <Tab>.
3852 See |option-backslash| about including spaces and backslashes.
3853
3854 *'isident'* *'isi'*
3855'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3856 "@,48-57,_,128-167,224-235"
3857 otherwise: "@,48-57,_,192-255")
3858 global
3859 {not in Vi}
3860 The characters given by this option are included in identifiers.
3861 Identifiers are used in recognizing environment variables and after a
3862 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003863 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 option.
3865 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003866 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003867 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3868
3869 *'iskeyword'* *'isk'*
3870'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3871 "@,48-57,_,128-167,224-235"
3872 otherwise: "@,48-57,_,192-255"
3873 Vi default: "@,48-57,_")
3874 local to buffer
3875 {not in Vi}
3876 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003877 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 'isfname' for a description of the format of this option. For C
3879 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3880 For a help file it is set to all non-blank printable characters except
3881 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3882 command).
3883 When the 'lisp' option is on the '-' character is always included.
3884 NOTE: This option is set to the Vi default value when 'compatible' is
3885 set and to the Vim default value when 'compatible' is reset.
3886
3887 *'isprint'* *'isp'*
3888'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3889 "@,~-255"; otherwise: "@,161-255")
3890 global
3891 {not in Vi}
3892 The characters given by this option are displayed directly on the
3893 screen. It is also used for "\p" in a |pattern|. The characters from
3894 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3895 even when they are not included in 'isprint' or excluded. See
3896 'isfname' for a description of the format of this option.
3897
3898 Non-printable characters are displayed with two characters:
3899 0 - 31 "^@" - "^_"
3900 32 - 126 always single characters
3901 127 "^?"
3902 128 - 159 "~@" - "~_"
3903 160 - 254 "| " - "|~"
3904 255 "~?"
3905 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3906 displayed as <xx>, with the hexadecimal value of the byte.
3907 When 'display' contains "uhex" all unprintable characters are
3908 displayed as <xx>.
3909 The NonText highlighting will be used for unprintable characters.
3910 |hl-NonText|
3911
3912 Multi-byte characters 256 and above are always included, only the
3913 characters up to 255 are specified with this option. When a character
3914 is printable but it is not available in the current font, a
3915 replacement character will be shown.
3916 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3917 There is no option to specify these characters.
3918
3919 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3920'joinspaces' 'js' boolean (default on)
3921 global
3922 {not in Vi}
3923 Insert two spaces after a '.', '?' and '!' with a join command.
3924 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3925 Otherwise only one space is inserted.
3926 NOTE: This option is set when 'compatible' is set.
3927
3928 *'key'*
3929'key' string (default "")
3930 local to buffer
3931 {not in Vi}
3932 The key that is used for encrypting and decrypting the current buffer.
3933 See |encryption|.
3934 Careful: Do not set the key value by hand, someone might see the typed
3935 key. Use the |:X| command. But you can make 'key' empty: >
3936 :set key=
3937< It is not possible to get the value of this option with ":set key" or
3938 "echo &key". This is to avoid showing it to someone who shouldn't
3939 know. It also means you cannot see it yourself once you have set it,
3940 be careful not to make a typing error!
3941
3942 *'keymap'* *'kmp'* *E544*
3943'keymap' 'kmp' string (default "")
3944 local to buffer
3945 {not in Vi}
3946 {only available when compiled with the |+keymap|
3947 feature}
3948 Name of a keyboard mapping. See |mbyte-keymap|.
3949 Setting this option to a valid keymap name has the side effect of
3950 setting 'iminsert' to one, so that the keymap becomes effective.
3951 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003952 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953
3954 *'keymodel'* *'km'*
3955'keymodel' 'km' string (default "")
3956 global
3957 {not in Vi}
3958 List of comma separated words, which enable special things that keys
3959 can do. These values can be used:
3960 startsel Using a shifted special key starts selection (either
3961 Select mode or Visual mode, depending on "key" being
3962 present in 'selectmode').
3963 stopsel Using a not-shifted special key stops selection.
3964 Special keys in this context are the cursor keys, <End>, <Home>,
3965 <PageUp> and <PageDown>.
3966 The 'keymodel' option is set by the |:behave| command.
3967
3968 *'keywordprg'* *'kp'*
3969'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3970 OS/2: "view /", VMS: "help")
3971 global or local to buffer |global-local|
3972 {not in Vi}
3973 Program to use for the |K| command. Environment variables are
3974 expanded |:set_env|. ":help" may be used to access the Vim internal
3975 help. (Note that previously setting the global option to the empty
3976 value did this, which is now deprecated.)
3977 When "man" is used, Vim will automatically translate a count for the
3978 "K" command to a section number. Also for "man -s", in which case the
3979 "-s" is removed when there is no count.
3980 See |option-backslash| about including spaces and backslashes.
3981 Example: >
3982 :set keywordprg=man\ -s
3983< This option cannot be set from a |modeline| or in the |sandbox|, for
3984 security reasons.
3985
3986 *'langmap'* *'lmap'* *E357* *E358*
3987'langmap' 'lmap' string (default "")
3988 global
3989 {not in Vi}
3990 {only available when compiled with the |+langmap|
3991 feature}
3992 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003993 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 inserted directly. When in command mode the 'langmap' option takes
3995 care of translating these special characters to the original meaning
3996 of the key. This means you don't have to change the keyboard mode to
3997 be able to execute Normal mode commands.
3998 This is the opposite of the 'keymap' option, where characters are
3999 mapped in Insert mode.
4000 This only works for 8-bit characters. The value of 'langmap' may be
4001 specified with multi-byte characters (e.g., UTF-8), but only the lower
4002 8 bits of each character will be used.
4003
4004 Example (for Greek): *greek* >
4005 :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
4006< Example (exchanges meaning of z and y for commands): >
4007 :set langmap=zy,yz,ZY,YZ
4008<
4009 The 'langmap' option is a list of parts, separated with commas. Each
4010 part can be in one of two forms:
4011 1. A list of pairs. Each pair is a "from" character immediately
4012 followed by the "to" character. Examples: "aA", "aAbBcC".
4013 2. A list of "from" characters, a semi-colon and a list of "to"
4014 characters. Example: "abc;ABC"
4015 Example: "aA,fgh;FGH,cCdDeE"
4016 Special characters need to be preceded with a backslash. These are
4017 ";", ',' and backslash itself.
4018
4019 This will allow you to activate vim actions without having to switch
4020 back and forth between the languages. Your language characters will
4021 be understood as normal vim English characters (according to the
4022 langmap mappings) in the following cases:
4023 o Normal/Visual mode (commands, buffer/register names, user mappings)
4024 o Insert/Replace Mode: Register names after CTRL-R
4025 o Insert/Replace Mode: Mappings
4026 Characters entered in Command-line mode will NOT be affected by
4027 this option. Note that this option can be changed at any time
4028 allowing to switch between mappings for different languages/encodings.
4029 Use a mapping to avoid having to type it each time!
4030
4031 *'langmenu'* *'lm'*
4032'langmenu' 'lm' string (default "")
4033 global
4034 {not in Vi}
4035 {only available when compiled with the |+menu| and
4036 |+multi_lang| features}
4037 Language to use for menu translation. Tells which file is loaded
4038 from the "lang" directory in 'runtimepath': >
4039 "lang/menu_" . &langmenu . ".vim"
4040< (without the spaces). For example, to always use the Dutch menus, no
4041 matter what $LANG is set to: >
4042 :set langmenu=nl_NL.ISO_8859-1
4043< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004044 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 If your $LANG is set to a non-English language but you do want to use
4046 the English menus: >
4047 :set langmenu=none
4048< This option must be set before loading menus, switching on filetype
4049 detection or syntax highlighting. Once the menus are defined setting
4050 this option has no effect. But you could do this: >
4051 :source $VIMRUNTIME/delmenu.vim
4052 :set langmenu=de_DE.ISO_8859-1
4053 :source $VIMRUNTIME/menu.vim
4054< Warning: This deletes all menus that you defined yourself!
4055
4056 *'laststatus'* *'ls'*
4057'laststatus' 'ls' number (default 1)
4058 global
4059 {not in Vi}
4060 The value of this option influences when the last window will have a
4061 status line:
4062 0: never
4063 1: only if there are at least two windows
4064 2: always
4065 The screen looks nicer with a status line if you have several
4066 windows, but it takes another screen line. |status-line|
4067
4068 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4069'lazyredraw' 'lz' boolean (default off)
4070 global
4071 {not in Vi}
4072 When this option is set, the screen will not be redrawn while
4073 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004074 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 update use |:redraw|.
4076
4077 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4078'linebreak' 'lbr' boolean (default off)
4079 local to window
4080 {not in Vi}
4081 {not available when compiled without the |+linebreak|
4082 feature}
4083 If on Vim will wrap long lines at a character in 'breakat' rather
4084 than at the last character that fits on the screen. Unlike
4085 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4086 it only affects the way the file is displayed, not its contents. The
4087 value of 'showbreak' is used to put in front of wrapped lines.
4088 This option is not used when the 'wrap' option is off or 'list' is on.
4089 Note that <Tab> characters after an <EOL> are mostly not displayed
4090 with the right amount of white space.
4091
4092 *'lines'* *E593*
4093'lines' number (default 24 or terminal height)
4094 global
4095 Number of lines of the Vim window.
4096 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004097 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 When Vim is running in the GUI or in a resizable window, setting this
4099 option will cause the window size to be changed. When you only want
4100 to use the size for the GUI, put the command in your |gvimrc| file.
4101 Vim limits the number of lines to what fits on the screen. You can
4102 use this command to get the tallest window possible: >
4103 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004104< Minimum value is 2, maximum value is 1000.
4105 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 When you set this option and Vim is unable to change the physical
4107 number of lines of the display, the display may be messed up.
4108
4109 *'linespace'* *'lsp'*
4110'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4111 global
4112 {not in Vi}
4113 {only in the GUI}
4114 Number of pixel lines inserted between characters. Useful if the font
4115 uses the full character cell height, making lines touch each other.
4116 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004117 With some fonts there can be too much room between lines (to have
4118 space for ascents and descents). Then it makes sense to set
4119 'linespace' to a negative value. This may cause display problems
4120 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121
4122 *'lisp'* *'nolisp'*
4123'lisp' boolean (default off)
4124 local to buffer
4125 {not available when compiled without the |+lispindent|
4126 feature}
4127 Lisp mode: When <Enter> is typed in insert mode set the indent for
4128 the next line to Lisp standards (well, sort of). Also happens with
4129 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4130 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4131 better. Also see 'lispwords'.
4132 The '-' character is included in keyword characters. Redefines the
4133 "=" operator to use this same indentation algorithm rather than
4134 calling an external program if 'equalprg' is empty.
4135 This option is not used when 'paste' is set.
4136 {Vi: Does it a little bit differently}
4137
4138 *'lispwords'* *'lw'*
4139'lispwords' 'lw' string (default is very long)
4140 global
4141 {not in Vi}
4142 {not available when compiled without the |+lispindent|
4143 feature}
4144 Comma separated list of words that influence the Lisp indenting.
4145 |'lisp'|
4146
4147 *'list'* *'nolist'*
4148'list' boolean (default off)
4149 local to window
4150 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4151 see the difference between tabs and spaces and for trailing blanks.
4152 Note that this will also affect formatting (set with 'textwidth' or
4153 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4154 changing the way tabs are displayed.
4155
4156 *'listchars'* *'lcs'*
4157'listchars' 'lcs' string (default "eol:$")
4158 global
4159 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004160 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 settings.
4162 eol:c Character to show at the end of each line. When
4163 omitted, there is no extra character at the end of the
4164 line.
4165 tab:xy Two characters to be used to show a Tab. The first
4166 char is used once. The second char is repeated to
4167 fill the space that the Tab normally occupies.
4168 "tab:>-" will show a Tab that takes four spaces as
4169 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004170 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 trailing spaces are blank.
4172 extends:c Character to show in the last column, when 'wrap' is
4173 off and the line continues beyond the right of the
4174 screen.
4175 precedes:c Character to show in the first column, when 'wrap'
4176 is off and there is text preceding the character
4177 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004178 nbsp:c Character to show for a non-breakable space (character
4179 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004181 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 be used when 'encoding' is "utf-8", otherwise only printable
4183 characters are allowed.
4184
4185 Examples: >
4186 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004187 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 :set lcs=extends:>,precedes:<
4189< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004190 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
4192 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4193'loadplugins' 'lpl' boolean (default on)
4194 global
4195 {not in Vi}
4196 When on the plugin scripts are loaded when starting up |load-plugins|.
4197 This option can be reset in your |vimrc| file to disable the loading
4198 of plugins.
4199 Note that using the "-u NONE" and "--noplugin" command line arguments
4200 reset this option. |-u| |--noplugin|
4201
4202 *'magic'* *'nomagic'*
4203'magic' boolean (default on)
4204 global
4205 Changes the special characters that can be used in search patterns.
4206 See |pattern|.
4207 NOTE: To avoid portability problems with using patterns, always keep
4208 this option at the default "on". Only switch it off when working with
4209 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004210 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211
4212 *'makeef'* *'mef'*
4213'makeef' 'mef' string (default: "")
4214 global
4215 {not in Vi}
4216 {not available when compiled without the |+quickfix|
4217 feature}
4218 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4219 and the |:grep| command.
4220 When it is empty, an internally generated temp file will be used.
4221 When "##" is included, it is replaced by a number to make the name
4222 unique. This makes sure that the ":make" command doesn't overwrite an
4223 existing file.
4224 NOT used for the ":cf" command. See 'errorfile' for that.
4225 Environment variables are expanded |:set_env|.
4226 See |option-backslash| about including spaces and backslashes.
4227 This option cannot be set from a |modeline| or in the |sandbox|, for
4228 security reasons.
4229
4230 *'makeprg'* *'mp'*
4231'makeprg' 'mp' string (default "make", VMS: "MMS")
4232 global or local to buffer |global-local|
4233 {not in Vi}
4234 Program to use for the ":make" command. See |:make_makeprg|. This
4235 option may contain '%' and '#' characters, which are expanded like
4236 when used in a command-line. Environment variables are expanded
4237 |:set_env|. See |option-backslash| about including spaces and
4238 backslashes. Note that a '|' must be escaped twice: once for ":set"
4239 and once for the interpretation of a command. When you use a filter
4240 called "myfilter" do it like this: >
4241 :set makeprg=gmake\ \\\|\ myfilter
4242< The placeholder "$*" can be given (even multiple times) to specify
4243 where the arguments will be included, for example: >
4244 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4245< This option cannot be set from a |modeline| or in the |sandbox|, for
4246 security reasons.
4247
4248 *'matchpairs'* *'mps'*
4249'matchpairs' 'mps' string (default "(:),{:},[:]")
4250 local to buffer
4251 {not in Vi}
4252 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004253 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 must be different. The characters must be separated by a colon. The
4255 pairs must be separated by a comma. Example for including '<' and '>'
4256 (HTML): >
4257 :set mps+=<:>
4258
4259< A more exotic example, to jump between the '=' and ';' in an
4260 assignment, useful for languages like C and Java: >
4261 :au FileType c,cpp,java set mps+==:;
4262
4263< For a more advanced way of using "%", see the matchit.vim plugin in
4264 the $VIMRUNTIME/macros directory. |add-local-help|
4265
4266 *'matchtime'* *'mat'*
4267'matchtime' 'mat' number (default 5)
4268 global
4269 {not in Vi}{in Nvi}
4270 Tenths of a second to show the matching paren, when 'showmatch' is
4271 set. Note that this is not in milliseconds, like other options that
4272 set a time. This is to be compatible with Nvi.
4273
4274 *'maxfuncdepth'* *'mfd'*
4275'maxfuncdepth' 'mfd' number (default 100)
4276 global
4277 {not in Vi}
4278 Maximum depth of function calls for user functions. This normally
4279 catches endless recursion. When using a recursive function with
4280 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4281 more memory, there is the danger of failing when memory is exhausted.
4282 See also |:function|.
4283
4284 *'maxmapdepth'* *'mmd'* *E223*
4285'maxmapdepth' 'mmd' number (default 1000)
4286 global
4287 {not in Vi}
4288 Maximum number of times a mapping is done without resulting in a
4289 character to be used. This normally catches endless mappings, like
4290 ":map x y" with ":map y x". It still does not catch ":map g wg",
4291 because the 'w' is used before the next mapping is done. See also
4292 |key-mapping|.
4293
4294 *'maxmem'* *'mm'*
4295'maxmem' 'mm' number (default between 256 to 5120 (system
4296 dependent) or half the amount of memory
4297 available)
4298 global
4299 {not in Vi}
4300 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4301 limit is reached allocating extra memory for a buffer will cause
4302 other memory to be freed. Maximum value 2000000. Use this to work
4303 without a limit. Also see 'maxmemtot'.
4304
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004305 *'maxmempattern'* *'mmp'*
4306'maxmempattern' 'mmp' number (default 1000)
4307 global
4308 {not in Vi}
4309 Maximum amount of memory (in Kbyte) to use for pattern matching.
4310 Maximum value 2000000. Use this to work without a limit.
4311 *E363*
4312 When Vim runs into the limit it gives an error message mostly behaves
4313 like CTRL-C was typed.
4314 Running into the limit often means that the pattern is very
4315 inefficient or too complex. This may already happen with the pattern
4316 "\(.\)*" on a very long line. ".*" works much better.
4317 Vim may run out of memory before hitting the 'maxmempattern' limit.
4318
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 *'maxmemtot'* *'mmt'*
4320'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4321 dependent) or half the amount of memory
4322 available)
4323 global
4324 {not in Vi}
4325 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004326 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 'maxmem'.
4328
4329 *'menuitems'* *'mis'*
4330'menuitems' 'mis' number (default 25)
4331 global
4332 {not in Vi}
4333 {not available when compiled without the |+menu|
4334 feature}
4335 Maximum number of items to use in a menu. Used for menus that are
4336 generated from a list of items, e.g., the Buffers menu. Changing this
4337 option has no direct effect, the menu must be refreshed first.
4338
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004339 *'mkspellmem'* *'msm'*
4340'mkspellmem' 'msm' string (default "460000,2000,500")
4341 global
4342 {not in Vi}
4343 {not available when compiled without the |+syntax|
4344 feature}
4345 Parameters for |:mkspell|. This tunes when to start compressing the
4346 word tree. Compression can be slow when there are many words, but
4347 it's needed to avoid running out of memory. The amount of memory used
4348 per word depends very much on how similar the words are, that's why
4349 this tuning is complicated.
4350
4351 There are three numbers, separated by commas:
4352 {start},{inc},{added}
4353
4354 For most languages the uncompressed word tree fits in memory. {start}
4355 gives the amount of memory in Kbyte that can be used before any
4356 compression is done. It should be a bit smaller than the amount of
4357 memory that is available to Vim.
4358
4359 When going over the {start} limit the {inc} number specifies the
4360 amount of memory in Kbyte that can be allocated before another
4361 compression is done. A low number means compression is done after
4362 less words are added, which is slow. A high number means more memory
4363 will be allocated.
4364
4365 After doing compression, {added} times 1024 words can be added before
4366 the {inc} limit is ignored and compression is done when any extra
4367 amount of memory is needed. A low number means there is a smaller
4368 chance of hitting the {inc} limit, less memory is used but it's
4369 slower.
4370
4371 The languages for which these numbers are important are Italian and
4372 Hungarian. The default works for when you have about 512 Mbyte. If
4373 you have 1 Gbyte you could use: >
4374 :set mkspellmem=900000,3000,800
4375< If you have less than 512 Mbyte |:mkspell| may fail for some
4376 languages, no matter what you set 'mkspellmem' to.
4377
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4379'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4380 local to buffer
4381 *'modelines'* *'mls'*
4382'modelines' 'mls' number (default 5)
4383 global
4384 {not in Vi}
4385 If 'modeline' is on 'modelines' gives the number of lines that is
4386 checked for set commands. If 'modeline' is off or 'modelines' is zero
4387 no lines are checked. See |modeline|.
4388 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4389 set and to the Vim default value when 'compatible' is reset.
4390
4391 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4392'modifiable' 'ma' boolean (default on)
4393 local to buffer
4394 {not in Vi} *E21*
4395 When off the buffer contents cannot be changed. The 'fileformat' and
4396 'fileencoding' options also can't be changed.
4397 Can be reset with the |-M| command line argument.
4398
4399 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4400'modified' 'mod' boolean (default off)
4401 local to buffer
4402 {not in Vi}
4403 When on, the buffer is considered to be modified. This option is set
4404 when:
4405 1. A change was made to the text since it was last written. Using the
4406 |undo| command to go back to the original text will reset the
4407 option. But undoing changes that were made before writing the
4408 buffer will set the option again, since the text is different from
4409 when it was written.
4410 2. 'fileformat' or 'fileencoding' is different from its original
4411 value. The original value is set when the buffer is read or
4412 written. A ":set nomodified" command also resets the original
4413 values to the current values and the 'modified' option will be
4414 reset.
4415 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4416 will be ignored.
4417
4418 *'more'* *'nomore'*
4419'more' boolean (Vim default: on, Vi default: off)
4420 global
4421 {not in Vi}
4422 When on, listings pause when the whole screen is filled. You will get
4423 the |more-prompt|. When this option is off there are no pauses, the
4424 listing continues until finished.
4425 NOTE: This option is set to the Vi default value when 'compatible' is
4426 set and to the Vim default value when 'compatible' is reset.
4427
4428 *'mouse'* *E538*
4429'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4430 global
4431 {not in Vi}
4432 Enable the use of the mouse. Only works for certain terminals
4433 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4434 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4435 The mouse can be enabled for different modes:
4436 n Normal mode
4437 v Visual mode
4438 i Insert mode
4439 c Command-line mode
4440 h all previous modes when editing a help file
4441 a all previous modes
4442 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 Normally you would enable the mouse in all four modes with: >
4444 :set mouse=a
4445< When the mouse is not enabled, the GUI will still use the mouse for
4446 modeless selection. This doesn't move the text cursor.
4447
4448 See |mouse-using|. Also see |'clipboard'|.
4449
4450 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004451 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 the mouse buttons can still be used by keeping the shift key pressed.
4453 Also see the 'clipboard' option.
4454
4455 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4456'mousefocus' 'mousef' boolean (default off)
4457 global
4458 {not in Vi}
4459 {only works in the GUI}
4460 The window that the mouse pointer is on is automatically activated.
4461 When changing the window layout or window focus in another way, the
4462 mouse pointer is moved to the window with keyboard focus. Off is the
4463 default because it makes using the pull down menus a little goofy, as
4464 a pointer transit may activate a window unintentionally.
4465
4466 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4467'mousehide' 'mh' boolean (default on)
4468 global
4469 {not in Vi}
4470 {only works in the GUI}
4471 When on, the mouse pointer is hidden when characters are typed.
4472 The mouse pointer is restored when the mouse is moved.
4473
4474 *'mousemodel'* *'mousem'*
4475'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4476 global
4477 {not in Vi}
4478 Sets the model to use for the mouse. The name mostly specifies what
4479 the right mouse button is used for:
4480 extend Right mouse button extends a selection. This works
4481 like in an xterm.
4482 popup Right mouse button pops up a menu. The shifted left
4483 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004484 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 popup_setpos Like "popup", but the cursor will be moved to the
4486 position where the mouse was clicked, and thus the
4487 selected operation will act upon the clicked object.
4488 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004489 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 course, that right clicking outside a selection will
4491 end Visual mode.
4492 Overview of what button does what for each model:
4493 mouse extend popup(_setpos) ~
4494 left click place cursor place cursor
4495 left drag start selection start selection
4496 shift-left search word extend selection
4497 right click extend selection popup menu (place cursor)
4498 right drag extend selection -
4499 middle click paste paste
4500
4501 In the "popup" model the right mouse button produces a pop-up menu.
4502 You need to define this first, see |popup-menu|.
4503
4504 Note that you can further refine the meaning of buttons with mappings.
4505 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4506 selection (because that's handled in the GUI code directly).
4507
4508 The 'mousemodel' option is set by the |:behave| command.
4509
4510 *'mouseshape'* *'mouses'* *E547*
4511'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004512 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 global
4514 {not in Vi}
4515 {only available when compiled with the |+mouseshape|
4516 feature}
4517 This option tells Vim what the mouse pointer should look like in
4518 different modes. The option is a comma separated list of parts, much
4519 like used for 'guicursor'. Each part consist of a mode/location-list
4520 and an argument-list:
4521 mode-list:shape,mode-list:shape,..
4522 The mode-list is a dash separated list of these modes/locations:
4523 In a normal window: ~
4524 n Normal mode
4525 v Visual mode
4526 ve Visual mode with 'selection' "exclusive" (same as 'v',
4527 if not specified)
4528 o Operator-pending mode
4529 i Insert mode
4530 r Replace mode
4531
4532 Others: ~
4533 c appending to the command-line
4534 ci inserting in the command-line
4535 cr replacing in the command-line
4536 m at the 'Hit ENTER' or 'More' prompts
4537 ml idem, but cursor in the last line
4538 e any mode, pointer below last window
4539 s any mode, pointer on a status line
4540 sd any mode, while dragging a status line
4541 vs any mode, pointer on a vertical separator line
4542 vd any mode, while dragging a vertical separator line
4543 a everywhere
4544
4545 The shape is one of the following:
4546 avail name looks like ~
4547 w x arrow Normal mouse pointer
4548 w x blank no pointer at all (use with care!)
4549 w x beam I-beam
4550 w x updown up-down sizing arrows
4551 w x leftright left-right sizing arrows
4552 w x busy The system's usual busy pointer
4553 w x no The system's usual 'no input' pointer
4554 x udsizing indicates up-down resizing
4555 x lrsizing indicates left-right resizing
4556 x crosshair like a big thin +
4557 x hand1 black hand
4558 x hand2 white hand
4559 x pencil what you write with
4560 x question big ?
4561 x rightup-arrow arrow pointing right-up
4562 w x up-arrow arrow pointing up
4563 x <number> any X11 pointer number (see X11/cursorfont.h)
4564
4565 The "avail" column contains a 'w' if the shape is available for Win32,
4566 x for X11.
4567 Any modes not specified or shapes not available use the normal mouse
4568 pointer.
4569
4570 Example: >
4571 :set mouseshape=s:udsizing,m:no
4572< will make the mouse turn to a sizing arrow over the status lines and
4573 indicate no input when the hit-enter prompt is displayed (since
4574 clicking the mouse has no effect in this state.)
4575
4576 *'mousetime'* *'mouset'*
4577'mousetime' 'mouset' number (default 500)
4578 global
4579 {not in Vi}
4580 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4581 time in msec between two mouse clicks for the second click to be
4582 recognized as a multi click.
4583
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004584 *'mzquantum'* *'mzq'*
4585'mzquantum' 'mzq' number (default 100)
4586 global
4587 {not in Vi}
4588 {not available when compiled without the |+mzscheme|
4589 feature}
4590 The number of milliseconds between polls for MzScheme threads.
4591 Negative or zero value means no thread scheduling.
4592
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 *'nrformats'* *'nf'*
4594'nrformats' 'nf' string (default "octal,hex")
4595 local to buffer
4596 {not in Vi}
4597 This defines what bases Vim will consider for numbers when using the
4598 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4599 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004600 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 incremented or decremented. This is useful for a list with a
4602 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004603 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004605 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 considered to be hexadecimal. Example: Using CTRL-X on
4607 "0x100" results in "0x0ff".
4608 Numbers which simply begin with a digit in the range 1-9 are always
4609 considered decimal. This also happens for numbers that are not
4610 recognized as octal or hex.
4611
4612 *'number'* *'nu'* *'nonumber'* *'nonu'*
4613'number' 'nu' boolean (default off)
4614 local to window
4615 Print the line number in front of each line. When the 'n' option is
4616 excluded from 'cpoptions' a wrapped line will not use the column of
4617 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004618 The 'numberwidth' option can be used to set the room used for the line
4619 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 When a long, wrapped line doesn't start with the first character, '-'
4621 characters are put before the number.
4622 See |hl-LineNr| for the highlighting used for the number.
4623
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004624 *'numberwidth'* *'nuw'*
4625'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4626 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004627 {not in Vi}
4628 {only available when compiled with the |+linebreak|
4629 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004630 Minimal number of columns to use for the line number. Only relevant
4631 when the 'number' option is set.
4632 Since one space is always between the number and the text, there is
4633 one less character for the number itself.
4634 The value is the minimum width. A bigger width is used when needed to
4635 fit the highest line number in the buffer. Thus with the Vim default
4636 of 4 there is room for a line number up to 999. When the buffer has
4637 1000 lines five columns will be used.
4638 The minimum value is 1, the maximum value is 10.
4639 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4640
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004641 *'omnifunc'* *'ofu'*
4642'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004643 local to buffer
4644 {not in Vi}
4645 {not available when compiled without the +eval
4646 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004647 This option specifies a function to be used for Insert mode omni
4648 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004649 For the use of the function see 'completefunc'.
4650
4651
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004652 *'operatorfunc'* *'opfunc'*
4653'operatorfunc' 'opfunc' string (default: empty)
4654 global
4655 {not in Vi}
4656 This option specifies a function to be called by the |g@| operator.
4657 See |:map-operator| for more info and an example.
4658
4659 This option cannot be set from a |modeline| or in the |sandbox|, for
4660 security reasons.
4661
4662
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 *'osfiletype'* *'oft'* *E366*
4664'osfiletype' 'oft' string (RISC-OS default: "Text",
4665 others default: "")
4666 local to buffer
4667 {not in Vi}
4668 {only available when compiled with the |+osfiletype|
4669 feature}
4670 Some operating systems store extra information about files besides
4671 name, datestamp and permissions. This option contains the extra
4672 information, the nature of which will vary between systems.
4673 The value of this option is usually set when the file is loaded, and
4674 use to set the file type when file is written.
4675 It can affect the pattern matching of the automatic commands.
4676 |autocmd-osfiletypes|
4677
4678 *'paragraphs'* *'para'*
4679'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4680 global
4681 Specifies the nroff macros that separate paragraphs. These are pairs
4682 of two letters (see |object-motions|).
4683
4684 *'paste'* *'nopaste'*
4685'paste' boolean (default off)
4686 global
4687 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004688 Put Vim in Paste mode. This is useful if you want to cut or copy
4689 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 unexpected effects.
4691 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004692 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 knows about pasting and will mostly do the right thing without 'paste'
4694 being set. The same is true for a terminal where Vim handles the
4695 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004696 This option is reset when starting the GUI. Thus if you set it in
4697 your .vimrc it will work in a terminal, but not in the GUI. Setting
4698 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4699 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 When the 'paste' option is switched on (also when it was already on):
4701 - mapping in Insert mode and Command-line mode is disabled
4702 - abbreviations are disabled
4703 - 'textwidth' is set to 0
4704 - 'wrapmargin' is set to 0
4705 - 'autoindent' is reset
4706 - 'smartindent' is reset
4707 - 'softtabstop' is set to 0
4708 - 'revins' is reset
4709 - 'ruler' is reset
4710 - 'showmatch' is reset
4711 - 'formatoptions' is used like it is empty
4712 These options keep their value, but their effect is disabled:
4713 - 'lisp'
4714 - 'indentexpr'
4715 - 'cindent'
4716 NOTE: When you start editing another file while the 'paste' option is
4717 on, settings from the modelines or autocommands may change the
4718 settings again, causing trouble when pasting text. You might want to
4719 set the 'paste' option again.
4720 When the 'paste' option is reset the mentioned options are restored to
4721 the value before the moment 'paste' was switched from off to on.
4722 Resetting 'paste' before ever setting it does not have any effect.
4723 Since mapping doesn't work while 'paste' is active, you need to use
4724 the 'pastetoggle' option to toggle the 'paste' option with some key.
4725
4726 *'pastetoggle'* *'pt'*
4727'pastetoggle' 'pt' string (default "")
4728 global
4729 {not in Vi}
4730 When non-empty, specifies the key sequence that toggles the 'paste'
4731 option. This is like specifying a mapping: >
4732 :map {keys} :set invpaste<CR>
4733< Where {keys} is the value of 'pastetoggle'.
4734 The difference is that it will work even when 'paste' is set.
4735 'pastetoggle' works in Insert mode and Normal mode, but not in
4736 Command-line mode.
4737 Mappings are checked first, thus overrule 'pastetoggle'. However,
4738 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4739 this: >
4740 :map <F10> :set paste<CR>
4741 :map <F11> :set nopaste<CR>
4742 :imap <F10> <C-O>:set paste<CR>
4743 :imap <F11> <nop>
4744 :set pastetoggle=<F11>
4745< This will make <F10> start paste mode and <F11> stop paste mode.
4746 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4747 mode everything is inserted literally, except the 'pastetoggle' key
4748 sequence.
4749
4750 *'pex'* *'patchexpr'*
4751'patchexpr' 'pex' string (default "")
4752 global
4753 {not in Vi}
4754 {not available when compiled without the |+diff|
4755 feature}
4756 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004757 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758
4759 *'patchmode'* *'pm'* *E206*
4760'patchmode' 'pm' string (default "")
4761 global
4762 {not in Vi}
4763 When non-empty the oldest version of a file is kept. This can be used
4764 to keep the original version of a file if you are changing files in a
4765 source distribution. Only the first time that a file is written a
4766 copy of the original file will be kept. The name of the copy is the
4767 name of the original file with the string in the 'patchmode' option
4768 appended. This option should start with a dot. Use a string like
4769 ".org". 'backupdir' must not be empty for this to work (Detail: The
4770 backup file is renamed to the patchmode file after the new file has
4771 been successfully written, that's why it must be possible to write a
4772 backup file). If there was no file to be backed up, an empty file is
4773 created.
4774 When the 'backupskip' pattern matches, a patchmode file is not made.
4775 Using 'patchmode' for compressed files appends the extension at the
4776 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4777 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004778 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779
4780 *'path'* *'pa'* *E343* *E345* *E347*
4781'path' 'pa' string (default on Unix: ".,/usr/include,,"
4782 on OS/2: ".,/emx/include,,"
4783 other systems: ".,,")
4784 global or local to buffer |global-local|
4785 {not in Vi}
4786 This is a list of directories which will be searched when using the
4787 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4788 being searched for has a relative path (not starting with '/'). The
4789 directories in the 'path' option may be relative or absolute.
4790 - Use commas to separate directory names: >
4791 :set path=.,/usr/local/include,/usr/include
4792< - Spaces can also be used to separate directory names (for backwards
4793 compatibility with version 3.0). To have a space in a directory
4794 name, precede it with an extra backslash, and escape the space: >
4795 :set path=.,/dir/with\\\ space
4796< - To include a comma in a directory name precede it with an extra
4797 backslash: >
4798 :set path=.,/dir/with\\,comma
4799< - To search relative to the directory of the current file, use: >
4800 :set path=.
4801< - To search in the current directory use an empty string between two
4802 commas: >
4803 :set path=,,
4804< - A directory name may end in a ':' or '/'.
4805 - Environment variables are expanded |:set_env|.
4806 - When using |netrw.vim| URLs can be used. For example, adding
4807 "http://www.vim.org" will make ":find index.html" work.
4808 - Search upwards and downwards in a directory tree:
4809 1) "*" matches a sequence of characters, e.g.: >
4810 :set path=/usr/include/*
4811< means all subdirectories in /usr/include (but not /usr/include
4812 itself). >
4813 :set path=/usr/*c
4814< matches /usr/doc and /usr/src.
4815 2) "**" matches a subtree, up to 100 directories deep. Example: >
4816 :set path=/home/user_x/src/**
4817< means search in the whole subtree under "/home/usr_x/src".
4818 3) If the path ends with a ';', this path is the startpoint
4819 for upward search.
4820 See |file-searching| for more info and exact syntax.
4821 {not available when compiled without the |+path_extra| feature}
4822 - Careful with '\' characters, type two to get one in the option: >
4823 :set path=.,c:\\include
4824< Or just use '/' instead: >
4825 :set path=.,c:/include
4826< Don't forget "." or files won't even be found in the same directory as
4827 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004828 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 it is something like 256 or 1024 characters.
4830 You can check if all the include files are found, using the value of
4831 'path', see |:checkpath|.
4832 The use of |:set+=| and |:set-=| is preferred when adding or removing
4833 directories from the list. This avoids problems when a future version
4834 uses another default. To remove the current directory use: >
4835 :set path-=
4836< To add the current directory use: >
4837 :set path+=
4838< To use an environment variable, you probably need to replace the
4839 separator. Here is an example to append $INCL, in which directory
4840 names are separated with a semi-colon: >
4841 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4842< Replace the ';' with a ':' or whatever separator is used. Note that
4843 this doesn't work when $INCL contains a comma or white space.
4844
4845 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4846'preserveindent' 'pi' boolean (default off)
4847 local to buffer
4848 {not in Vi}
4849 When changing the indent of the current line, preserve as much of the
4850 indent structure as possible. Normally the indent is replaced by a
4851 series of tabs followed by spaces as required (unless |'expandtab'| is
4852 enabled, in which case only spaces are used). Enabling this option
4853 means the indent will preserve as many existing characters as possible
4854 for indenting, and only add additional tabs or spaces as required.
4855 NOTE: When using ">>" multiple times the resulting indent is a mix of
4856 tabs and spaces. You might not like this.
4857 NOTE: 'preserveindent' is reset when 'compatible' is set.
4858 Also see 'copyindent'.
4859 Use |:retab| to clean up white space.
4860
4861 *'previewheight'* *'pvh'*
4862'previewheight' 'pvh' number (default 12)
4863 global
4864 {not in Vi}
4865 {not available when compiled without the |+windows| or
4866 |+quickfix| feature}
4867 Default height for a preview window. Used for |:ptag| and associated
4868 commands. Used for |CTRL-W_}| when no count is given.
4869
4870 *'previewwindow'* *'nopreviewwindow'*
4871 *'pvw'* *'nopvw'* *E590*
4872'previewwindow' 'pvw' boolean (default off)
4873 local to window
4874 {not in Vi}
4875 {not available when compiled without the |+windows| or
4876 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004877 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878 set. It's normally not set directly, but by using one of the commands
4879 |:ptag|, |:pedit|, etc.
4880
4881 *'printdevice'* *'pdev'*
4882'printdevice' 'pdev' string (default empty)
4883 global
4884 {not in Vi}
4885 {only available when compiled with the |+printer|
4886 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004887 The name of the printer to be used for |:hardcopy|.
4888 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004889 This option cannot be set from a |modeline| or in the |sandbox|, for
4890 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004891
Bram Moolenaar8299df92004-07-10 09:47:34 +00004892 *'printencoding'* *'penc'*
4893'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 global
4895 {not in Vi}
4896 {only available when compiled with the |+printer|
4897 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004898 Sets the character encoding used when printing.
4899 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900
4901 *'printexpr'* *'pexpr'*
4902'printexpr' 'pexpr' String (default: see below)
4903 global
4904 {not in Vi}
4905 {only available when compiled with the |+printer|
4906 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004907 Expression used to print the PostScript produced with |:hardcopy|.
4908 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909
Bram Moolenaar8299df92004-07-10 09:47:34 +00004910 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911'printfont' 'pfn' string (default "courier")
4912 global
4913 {not in Vi}
4914 {only available when compiled with the |+printer|
4915 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004916 The name of the font that will be used for |:hardcopy|.
4917 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918
4919 *'printheader'* *'pheader'*
4920'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4921 global
4922 {not in Vi}
4923 {only available when compiled with the |+printer|
4924 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004925 The format of the header produced in |:hardcopy| output.
4926 See |pheader-option|.
4927
4928 *'printmbcharset'* *'pmbcs'*
4929'printmbcharset' 'pmbcs' string (default "")
4930 global
4931 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004932 {only available when compiled with the |+printer|,
4933 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004934 The CJK character set to be used for CJK output from |:hardcopy|.
4935 See |pmbcs-option|.
4936
4937 *'printmbfont'* *'pmbfn'*
4938'printmbfont' 'pmbfn' string (default "")
4939 global
4940 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004941 {only available when compiled with the |+printer|,
4942 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004943 List of font names to be used for CJK output from |:hardcopy|.
4944 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945
4946 *'printoptions'* *'popt'*
4947'printoptions' 'popt' string (default "")
4948 global
4949 {not in Vi}
4950 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004951 List of items that control the format of the output of |:hardcopy|.
4952 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004954 *'prompt'* *'noprompt'*
4955'prompt' boolean (default on)
4956 global
4957 When on a ":" prompt is used in Ex mode.
4958
Bram Moolenaar677ee682005-01-27 14:41:15 +00004959 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004960'quoteescape' 'qe' string (default "\")
4961 local to buffer
4962 {not in Vi}
4963 The characters that are used to escape quotes in a string. Used for
4964 objects like a', a" and a` |a'|.
4965 When one of the characters in this option is found inside a string,
4966 the following character will be skipped. The default value makes the
4967 text "foo\"bar\\" considered to be one string.
4968
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4970'readonly' 'ro' boolean (default off)
4971 local to buffer
4972 If on, writes fail unless you use a '!'. Protects you from
4973 accidentally overwriting a file. Default on when Vim is started
4974 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004975 When using ":w!" the 'readonly' option is reset for the current
4976 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004978 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979
4980 *'remap'* *'noremap'*
4981'remap' boolean (default on)
4982 global
4983 Allows for mappings to work recursively. If you do not want this for
4984 a single entry, use the :noremap[!] command.
4985
4986 *'report'*
4987'report' number (default 2)
4988 global
4989 Threshold for reporting number of lines changed. When the number of
4990 changed lines is more than 'report' a message will be given for most
4991 ":" commands. If you want it always, set 'report' to 0.
4992 For the ":substitute" command the number of substitutions is used
4993 instead of the number of lines.
4994
4995 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4996'restorescreen' 'rs' boolean (default on)
4997 global
4998 {not in Vi} {only in Windows 95/NT console version}
4999 When set, the screen contents is restored when exiting Vim. This also
5000 happens when executing external commands.
5001
5002 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5003 options in your .vimrc. To disable restoring:
5004 set t_ti= t_te=
5005 To enable restoring (for an xterm):
5006 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5007 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5008
5009 *'revins'* *'ri'* *'norevins'* *'nori'*
5010'revins' 'ri' boolean (default off)
5011 global
5012 {not in Vi}
5013 {only available when compiled with the |+rightleft|
5014 feature}
5015 Inserting characters in Insert mode will work backwards. See "typing
5016 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5017 command in Insert mode, when 'allowrevins' is set.
5018 NOTE: This option is reset when 'compatible' or 'paste' is set.
5019
5020 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5021'rightleft' 'rl' boolean (default off)
5022 local to window
5023 {not in Vi}
5024 {only available when compiled with the |+rightleft|
5025 feature}
5026 When on, display orientation becomes right-to-left, i.e., characters
5027 that are stored in the file appear from the right to the left.
5028 Using this option, it is possible to edit files for languages that
5029 are written from the right to the left such as Hebrew and Arabic.
5030 This option is per window, so it is possible to edit mixed files
5031 simultaneously, or to view the same file in both ways (this is
5032 useful whenever you have a mixed text file with both right-to-left
5033 and left-to-right strings so that both sets are displayed properly
5034 in different windows). Also see |rileft.txt|.
5035
5036 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5037'rightleftcmd' 'rlc' string (default "search")
5038 local to window
5039 {not in Vi}
5040 {only available when compiled with the |+rightleft|
5041 feature}
5042 Each word in this option enables the command line editing to work in
5043 right-to-left mode for a group of commands:
5044
5045 search "/" and "?" commands
5046
5047 This is useful for languages such as Hebrew, Arabic and Farsi.
5048 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5049
5050 *'ruler'* *'ru'* *'noruler'* *'noru'*
5051'ruler' 'ru' boolean (default off)
5052 global
5053 {not in Vi}
5054 {not available when compiled without the
5055 |+cmdline_info| feature}
5056 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005057 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058 text in the file is shown on the far right:
5059 Top first line is visible
5060 Bot last line is visible
5061 All first and last line are visible
5062 45% relative position in the file
5063 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005064 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005066 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 this option takes precedence over 'ruler' and 'rulerformat'
5068 If the number of characters displayed is different from the number of
5069 bytes in the text (e.g., for a TAB or a multi-byte character), both
5070 the text column (byte number) and the screen column are shown,
5071 separated with a dash.
5072 For an empty line "0-1" is shown.
5073 For an empty buffer the line number will also be zero: "0,0-1".
5074 This option is reset when the 'paste' option is set.
5075 If you don't want to see the ruler all the time but want to know where
5076 you are, use "g CTRL-G" |g_CTRL-G|.
5077 NOTE: This option is reset when 'compatible' is set.
5078
5079 *'rulerformat'* *'ruf'*
5080'rulerformat' 'ruf' string (default empty)
5081 global
5082 {not in Vi}
5083 {not available when compiled without the |+statusline|
5084 feature}
5085 When this option is not empty, it determines the content of the ruler
5086 string, as displayed for the 'ruler' option.
5087 The format of this option, is like that of 'statusline'.
5088 The default ruler width is 17 characters. To make the ruler 15
5089 characters wide, put "%15(" at the start and "%)" at the end.
5090 Example: >
5091 :set rulerformat=%15(%c%V\ %p%%%)
5092<
5093 *'runtimepath'* *'rtp'* *vimfiles*
5094'runtimepath' 'rtp' string (default:
5095 Unix: "$HOME/.vim,
5096 $VIM/vimfiles,
5097 $VIMRUNTIME,
5098 $VIM/vimfiles/after,
5099 $HOME/.vim/after"
5100 Amiga: "home:vimfiles,
5101 $VIM/vimfiles,
5102 $VIMRUNTIME,
5103 $VIM/vimfiles/after,
5104 home:vimfiles/after"
5105 PC, OS/2: "$HOME/vimfiles,
5106 $VIM/vimfiles,
5107 $VIMRUNTIME,
5108 $VIM/vimfiles/after,
5109 $HOME/vimfiles/after"
5110 Macintosh: "$VIM:vimfiles,
5111 $VIMRUNTIME,
5112 $VIM:vimfiles:after"
5113 RISC-OS: "Choices:vimfiles,
5114 $VIMRUNTIME,
5115 Choices:vimfiles/after"
5116 VMS: "sys$login:vimfiles,
5117 $VIM/vimfiles,
5118 $VIMRUNTIME,
5119 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005120 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 global
5122 {not in Vi}
5123 This is a list of directories which will be searched for runtime
5124 files:
5125 filetype.vim filetypes by file name |new-filetype|
5126 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005127 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 colors/ color scheme files |:colorscheme|
5129 compiler/ compiler files |:compiler|
5130 doc/ documentation |write-local-help|
5131 ftplugin/ filetype plugins |write-filetype-plugin|
5132 indent/ indent scripts |indent-expression|
5133 keymap/ key mapping files |mbyte-keymap|
5134 lang/ menu translations |:menutrans|
5135 menu.vim GUI menus |menu.vim|
5136 plugin/ plugin scripts |write-plugin|
5137 print/ files for printing |postscript-print-encoding|
5138 syntax/ syntax files |mysyntaxfile|
5139 tutor/ files for vimtutor |tutor|
5140
5141 And any other file searched for with the |:runtime| command.
5142
5143 The defaults for most systems are setup to search five locations:
5144 1. In your home directory, for your personal preferences.
5145 2. In a system-wide Vim directory, for preferences from the system
5146 administrator.
5147 3. In $VIMRUNTIME, for files distributed with Vim.
5148 *after-directory*
5149 4. In the "after" directory in the system-wide Vim directory. This is
5150 for the system administrator to overrule or add to the distributed
5151 defaults (rarely needed)
5152 5. In the "after" directory in your home directory. This is for
5153 personal preferences to overrule or add to the distributed defaults
5154 or system-wide settings (rarely needed).
5155
5156 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5157 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005158 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 wildcards.
5160 See |:runtime|.
5161 Example: >
5162 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5163< This will use the directory "~/vimruntime" first (containing your
5164 personal Vim runtime files), then "/mygroup/vim" (shared between a
5165 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5166 files).
5167 You probably should always include $VIMRUNTIME somewhere, to use the
5168 distributed runtime files. You can put a directory before $VIMRUNTIME
5169 to find files which replace a distributed runtime files. You can put
5170 a directory after $VIMRUNTIME to find files which add to distributed
5171 runtime files.
5172 This option cannot be set from a |modeline| or in the |sandbox|, for
5173 security reasons.
5174
5175 *'scroll'* *'scr'*
5176'scroll' 'scr' number (default: half the window height)
5177 local to window
5178 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5179 set to half the number of lines in the window when the window size
5180 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005181 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5183 the number of screen lines instead of file lines, makes a difference
5184 when lines wrap}
5185
5186 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5187'scrollbind' 'scb' boolean (default off)
5188 local to window
5189 {not in Vi}
5190 {not available when compiled without the |+scrollbind|
5191 feature}
5192 See also |scroll-binding|. When this option is set, the current
5193 window scrolls as other scrollbind windows (windows that also have
5194 this option set) scroll. This option is useful for viewing the
5195 differences between two versions of a file, see 'diff'.
5196 See |'scrollopt'| for options that determine how this option should be
5197 interpreted.
5198 This option is mostly reset when splitting a window to edit another
5199 file. This means that ":split | edit file" results in two windows
5200 with scroll-binding, but ":split file" does not.
5201
5202 *'scrolljump'* *'sj'*
5203'scrolljump' 'sj' number (default 1)
5204 global
5205 {not in Vi}
5206 Minimal number of lines to scroll when the cursor gets off the
5207 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5208 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005209 When set to a negative number from -1 to -100 this is used as the
5210 percentage of the window height. Thus -50 scrolls half the window
5211 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 NOTE: This option is set to 1 when 'compatible' is set.
5213
5214 *'scrolloff'* *'so'*
5215'scrolloff' 'so' number (default 0)
5216 global
5217 {not in Vi}
5218 Minimal number of screen lines to keep above and below the cursor.
5219 This will make some context visible around where you are working. If
5220 you set it to a very large value (999) the cursor line will always be
5221 in the middle of the window (except at the start or end of the file or
5222 when long lines wrap).
5223 For scrolling horizontally see 'sidescrolloff'.
5224 NOTE: This option is set to 0 when 'compatible' is set.
5225
5226 *'scrollopt'* *'sbo'*
5227'scrollopt' 'sbo' string (default "ver,jump")
5228 global
5229 {not available when compiled without the |+scrollbind|
5230 feature}
5231 {not in Vi}
5232 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005233 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5234 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 The following words are available:
5236 ver Bind vertical scrolling for 'scrollbind' windows
5237 hor Bind horizontal scrolling for 'scrollbind' windows
5238 jump Applies to the offset between two windows for vertical
5239 scrolling. This offset is the difference in the first
5240 displayed line of the bound windows. When moving
5241 around in a window, another 'scrollbind' window may
5242 reach a position before the start or after the end of
5243 the buffer. The offset is not changed though, when
5244 moving back the 'scrollbind' window will try to scroll
5245 to the desired position when possible.
5246 When now making that window the current one, two
5247 things can be done with the relative offset:
5248 1. When "jump" is not included, the relative offset is
5249 adjusted for the scroll position in the new current
5250 window. When going back to the other window, the
5251 the new relative offset will be used.
5252 2. When "jump" is included, the other windows are
5253 scrolled to keep the same relative offset. When
5254 going back to the other window, it still uses the
5255 same relative offset.
5256 Also see |scroll-binding|.
5257
5258 *'sections'* *'sect'*
5259'sections' 'sect' string (default "SHNHH HUnhsh")
5260 global
5261 Specifies the nroff macros that separate sections. These are pairs of
5262 two letters (See |object-motions|). The default makes a section start
5263 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5264
5265 *'secure'* *'nosecure'* *E523*
5266'secure' boolean (default off)
5267 global
5268 {not in Vi}
5269 When on, ":autocmd", shell and write commands are not allowed in
5270 ".vimrc" and ".exrc" in the current directory and map commands are
5271 displayed. Switch it off only if you know that you will not run into
5272 problems, or when the 'exrc' option is off. On Unix this option is
5273 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005274 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005275 'secure' at the end of your ~/.vimrc then.
5276 This option cannot be set from a |modeline| or in the |sandbox|, for
5277 security reasons.
5278
5279 *'selection'* *'sel'*
5280'selection' 'sel' string (default "inclusive")
5281 global
5282 {not in Vi}
5283 This option defines the behavior of the selection. It is only used
5284 in Visual and Select mode.
5285 Possible values:
5286 value past line inclusive ~
5287 old no yes
5288 inclusive yes yes
5289 exclusive yes no
5290 "past line" means that the cursor is allowed to be positioned one
5291 character past the line.
5292 "inclusive" means that the last character of the selection is included
5293 in an operation. For example, when "x" is used to delete the
5294 selection.
5295 Note that when "exclusive" is used and selecting from the end
5296 backwards, you cannot include the last character of a line, when
5297 starting in Normal mode and 'virtualedit' empty.
5298
5299 The 'selection' option is set by the |:behave| command.
5300
5301 *'selectmode'* *'slm'*
5302'selectmode' 'slm' string (default "")
5303 global
5304 {not in Vi}
5305 This is a comma separated list of words, which specifies when to start
5306 Select mode instead of Visual mode, when a selection is started.
5307 Possible values:
5308 mouse when using the mouse
5309 key when using shifted special keys
5310 cmd when using "v", "V" or CTRL-V
5311 See |Select-mode|.
5312 The 'selectmode' option is set by the |:behave| command.
5313
5314 *'sessionoptions'* *'ssop'*
5315'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5316 help,options,winsize")
5317 global
5318 {not in Vi}
5319 {not available when compiled without the +mksession
5320 feature}
5321 Changes the effect of the |:mksession| command. It is a comma
5322 separated list of words. Each word enables saving and restoring
5323 something:
5324 word save and restore ~
5325 blank empty windows
5326 buffers hidden and unloaded buffers, not just those in windows
5327 curdir the current directory
5328 folds manually created folds, opened/closed folds and local
5329 fold options
5330 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005331 and contain at least one lowercase letter. Only
5332 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 help the help window
5334 localoptions options and mappings local to a window or buffer (not
5335 global values for local options)
5336 options all options and mappings (also global values for local
5337 options)
5338 resize size of the Vim window: 'lines' and 'columns'
5339 sesdir the directory in which the session file is located
5340 will become the current directory (useful with
5341 projects accessed over a network from different
5342 systems)
5343 slash backslashes in file names replaced with forward
5344 slashes
5345 unix with Unix end-of-line format (single <NL>), even when
5346 on Windows or DOS
5347 winpos position of the whole Vim window
5348 winsize window sizes
5349
5350 Don't include both "curdir" and "sesdir".
5351 When "curdir" nor "sesdir" is included, file names are stored with
5352 absolute paths.
5353 "slash" and "unix" are useful on Windows when sharing session files
5354 with Unix. The Unix version of Vim cannot source dos format scripts,
5355 but the Windows version of Vim can source unix format scripts.
5356
5357 *'shell'* *'sh'* *E91*
5358'shell' 'sh' string (default $SHELL or "sh",
5359 MS-DOS and Win32: "command.com" or
5360 "cmd.exe", OS/2: "cmd")
5361 global
5362 Name of the shell to use for ! and :! commands. When changing the
5363 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5364 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005365 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 See |option-backslash| about including spaces and backslashes.
5367 Environment variables are expanded |:set_env|.
5368 If the name of the shell contains a space, you might need to enclose
5369 it in quotes. Example: >
5370 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5371< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005372 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 "-f" is not inside the quotes, because it is not part of the command
5374 name. And Vim automagically recognizes the backslashes that are path
5375 separators.
5376 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5377 variable to change the way external commands are executed. See the
5378 libc.inf file of DJGPP.
5379 Under MS-Windows, when the executable ends in ".com" it must be
5380 included. Thus setting the shell to "command.com" or "4dos.com"
5381 works, but "command" and "4dos" do not work for all commands (e.g.,
5382 filtering).
5383 For unknown reasons, when using "4dos.com" the current directory is
5384 changed to "C:\". To avoid this set 'shell' like this: >
5385 :set shell=command.com\ /c\ 4dos
5386< This option cannot be set from a |modeline| or in the |sandbox|, for
5387 security reasons.
5388
5389 *'shellcmdflag'* *'shcf'*
5390'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5391 does not contain "sh" somewhere: "/c")
5392 global
5393 {not in Vi}
5394 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5395 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5396 systems, the default is set according to the value of 'shell', to
5397 reduce the need to set this option by the user. It's not used for
5398 OS/2 (EMX figures this out itself). See |option-backslash| about
5399 including spaces and backslashes. See |dos-shell|.
5400 This option cannot be set from a |modeline| or in the |sandbox|, for
5401 security reasons.
5402
5403 *'shellpipe'* *'sp'*
5404'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5405 global
5406 {not in Vi}
5407 {not available when compiled without the |+quickfix|
5408 feature}
5409 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005410 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 including spaces and backslashes.
5412 The name of the temporary file can be represented by "%s" if necessary
5413 (the file name is appended automatically if no %s appears in the value
5414 of this option).
5415 For the Amiga and MS-DOS the default is ">". The output is directly
5416 saved in a file and not echoed to the screen.
5417 For Unix the default it "| tee". The stdout of the compiler is saved
5418 in a file and echoed to the screen. If the 'shell' option is "csh" or
5419 "tcsh" after initializations, the default becomes "|& tee". If the
5420 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5421 "2>&1| tee". This means that stderr is also included.
5422 The initialization of this option is done after reading the ".vimrc"
5423 and the other initializations, so that when the 'shell' option is set
5424 there, the 'shellpipe' option changes automatically, unless it was
5425 explicitly set before.
5426 When 'shellpipe' is set to an empty string, no redirection of the
5427 ":make" output will be done. This is useful if you use a 'makeprg'
5428 that writes to 'makeef' by itself. If you want no piping, but do
5429 want to include the 'makeef', set 'shellpipe' to a single space.
5430 Don't forget to precede the space with a backslash: ":set sp=\ ".
5431 In the future pipes may be used for filtering and this option will
5432 become obsolete (at least for Unix).
5433 This option cannot be set from a |modeline| or in the |sandbox|, for
5434 security reasons.
5435
5436 *'shellquote'* *'shq'*
5437'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5438 contains "sh" somewhere: "\"")
5439 global
5440 {not in Vi}
5441 Quoting character(s), put around the command passed to the shell, for
5442 the "!" and ":!" commands. The redirection is kept outside of the
5443 quoting. See 'shellxquote' to include the redirection. It's
5444 probably not useful to set both options.
5445 This is an empty string by default. Only known to be useful for
5446 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5447 or bash, where it should be "\"". The default is adjusted according
5448 the value of 'shell', to reduce the need to set this option by the
5449 user. See |dos-shell|.
5450 This option cannot be set from a |modeline| or in the |sandbox|, for
5451 security reasons.
5452
5453 *'shellredir'* *'srr'*
5454'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5455 global
5456 {not in Vi}
5457 String to be used to put the output of a filter command in a temporary
5458 file. See also |:!|. See |option-backslash| about including spaces
5459 and backslashes.
5460 The name of the temporary file can be represented by "%s" if necessary
5461 (the file name is appended automatically if no %s appears in the value
5462 of this option).
5463 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5464 or "zsh" during initializations, the default becomes ">&". If the
5465 'shell' option is "sh", "ksh" or "bash" the default becomes
5466 ">%s 2>&1". This means that stderr is also included.
5467 For Win32, the Unix checks are done and additionally "cmd" is checked
5468 for, which makes the default ">%s 2>&1". Also, the same names with
5469 ".exe" appended are checked for.
5470 The initialization of this option is done after reading the ".vimrc"
5471 and the other initializations, so that when the 'shell' option is set
5472 there, the 'shellredir' option changes automatically unless it was
5473 explicitly set before.
5474 In the future pipes may be used for filtering and this option will
5475 become obsolete (at least for Unix).
5476 This option cannot be set from a |modeline| or in the |sandbox|, for
5477 security reasons.
5478
5479 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5480'shellslash' 'ssl' boolean (default off)
5481 global
5482 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5483 When set, a forward slash is used when expanding file names. This is
5484 useful when a Unix-like shell is used instead of command.com or
5485 cmd.exe. Backward slashes can still be typed, but they are changed to
5486 forward slashes by Vim.
5487 Note that setting or resetting this option has no effect for some
5488 existing file names, thus this option needs to be set before opening
5489 any file for best results. This might change in the future.
5490 'shellslash' only works when a backslash can be used as a path
5491 separator. To test if this is so use: >
5492 if exists('+shellslash')
5493<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005494 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5495'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5496 global
5497 {not in Vi}
5498 When on, use temp files for shell commands. When off use a pipe.
5499 When using a pipe is not possible temp files are used anyway.
5500 Currently a pipe is only supported on Unix. You can check it with: >
5501 :if has("filterpipe")
5502< The advantage of using a pipe is that nobody can read the temp file
5503 and the 'shell' command does not need to support redirection.
5504 The advantage of using a temp file is that the file type and encoding
5505 can be detected.
5506 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5507 |FilterWritePost| autocommands event are not triggered when
5508 'shelltemp' is off.
5509
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 *'shelltype'* *'st'*
5511'shelltype' 'st' number (default 0)
5512 global
5513 {not in Vi} {only for the Amiga}
5514 On the Amiga this option influences the way how the commands work
5515 which use a shell.
5516 0 and 1: always use the shell
5517 2 and 3: use the shell only to filter lines
5518 4 and 5: use shell only for ':sh' command
5519 When not using the shell, the command is executed directly.
5520
5521 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5522 1 and 3: use "shell cmd" to start external commands
5523
5524 *'shellxquote'* *'sxq'*
5525'shellxquote' 'sxq' string (default: "";
5526 for Win32, when 'shell' contains "sh"
5527 somewhere: "\""
5528 for Unix, when using system(): "\"")
5529 global
5530 {not in Vi}
5531 Quoting character(s), put around the command passed to the shell, for
5532 the "!" and ":!" commands. Includes the redirection. See
5533 'shellquote' to exclude the redirection. It's probably not useful
5534 to set both options.
5535 This is an empty string by default. Known to be useful for
5536 third-party shells when using the Win32 version, such as the MKS Korn
5537 Shell or bash, where it should be "\"". The default is adjusted
5538 according the value of 'shell', to reduce the need to set this option
5539 by the user. See |dos-shell|.
5540 This option cannot be set from a |modeline| or in the |sandbox|, for
5541 security reasons.
5542
5543 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5544'shiftround' 'sr' boolean (default off)
5545 global
5546 {not in Vi}
5547 Round indent to multiple of 'shiftwidth'. Applies to > and <
5548 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5549 a multiple of 'shiftwidth' (this is Vi compatible).
5550 NOTE: This option is reset when 'compatible' is set.
5551
5552 *'shiftwidth'* *'sw'*
5553'shiftwidth' 'sw' number (default 8)
5554 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556 |'cindent'|, |>>|, |<<|, etc.
5557
5558 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005559'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5560 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 global
5562 {not in Vi}
5563 This option helps to avoid all the |hit-enter| prompts caused by file
5564 messages, for example with CTRL-G, and to avoid some other messages.
5565 It is a list of flags:
5566 flag meaning when present ~
5567 f use "(3 of 5)" instead of "(file 3 of 5)"
5568 i use "[noeol]" instead of "[Incomplete last line]"
5569 l use "999L, 888C" instead of "999 lines, 888 characters"
5570 m use "[+]" instead of "[Modified]"
5571 n use "[New]" instead of "[New File]"
5572 r use "[RO]" instead of "[readonly]"
5573 w use "[w]" instead of "written" for file write message
5574 and "[a]" instead of "appended" for ':w >> file' command
5575 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5576 "[unix format]" and "[mac]" instead of "[mac format]".
5577 a all of the above abbreviations
5578
5579 o overwrite message for writing a file with subsequent message
5580 for reading a file (useful for ":wn" or when 'autowrite' on)
5581 O message for reading a file overwrites any previous message.
5582 Also for quickfix message (e.g., ":cn").
5583 s don't give "search hit BOTTOM, continuing at TOP" or "search
5584 hit TOP, continuing at BOTTOM" messages
5585 t truncate file message at the start if it is too long to fit
5586 on the command-line, "<" will appear in the left most column.
5587 Ignored in Ex mode.
5588 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005589 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 Ignored in Ex mode.
5591 W don't give "written" or "[w]" when writing a file
5592 A don't give the "ATTENTION" message when an existing swap file
5593 is found.
5594 I don't give the intro message when starting Vim |:intro|.
5595
5596 This gives you the opportunity to avoid that a change between buffers
5597 requires you to hit <Enter>, but still gives as useful a message as
5598 possible for the space available. To get the whole message that you
5599 would have got with 'shm' empty, use ":file!"
5600 Useful values:
5601 shm= No abbreviation of message.
5602 shm=a Abbreviation, but no loss of information.
5603 shm=at Abbreviation, and truncate message when necessary.
5604
5605 NOTE: This option is set to the Vi default value when 'compatible' is
5606 set and to the Vim default value when 'compatible' is reset.
5607
5608 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5609'shortname' 'sn' boolean (default off)
5610 local to buffer
5611 {not in Vi, not in MS-DOS versions}
5612 Filenames are assumed to be 8 characters plus one extension of 3
5613 characters. Multiple dots in file names are not allowed. When this
5614 option is on, dots in file names are replaced with underscores when
5615 adding an extension (".~" or ".swp"). This option is not available
5616 for MS-DOS, because then it would always be on. This option is useful
5617 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5618 or crossdos. When running the Win32 GUI version under Win32s, this
5619 option is always on by default.
5620
5621 *'showbreak'* *'sbr'* *E595*
5622'showbreak' 'sbr' string (default "")
5623 global
5624 {not in Vi}
5625 {not available when compiled without the |+linebreak|
5626 feature}
5627 String to put at the start of lines that have been wrapped. Useful
5628 values are "> " or "+++ ".
5629 Only printable single-cell characters are allowed, excluding <Tab> and
5630 comma (in a future version the comma might be used to separate the
5631 part that is shown at the end and at the start of a line).
5632 The characters are highlighted according to the '@' flag in
5633 'highlight'.
5634 Note that tabs after the showbreak will be displayed differently.
5635 If you want the 'showbreak' to appear in between line numbers, add the
5636 "n" flag to 'cpoptions'.
5637
5638 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5639'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5640 off)
5641 global
5642 {not in Vi}
5643 {not available when compiled without the
5644 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005645 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005646 terminal is slow.
5647 In Visual mode the size of the selected area is shown:
5648 - When selecting characters within a line, the number of characters.
5649 - When selecting more than one line, the number of lines.
5650 - When selecting a block, the size in screen characters: linesxcolumns.
5651 NOTE: This option is set to the Vi default value when 'compatible' is
5652 set and to the Vim default value when 'compatible' is reset.
5653
5654 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5655'showfulltag' 'sft' boolean (default off)
5656 global
5657 {not in Vi}
5658 When completing a word in insert mode (see |ins-completion|) from the
5659 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005660 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 matched a C function, you can see a template for what arguments are
5662 required (coding style permitting).
5663
5664 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5665'showmatch' 'sm' boolean (default off)
5666 global
5667 When a bracket is inserted, briefly jump to the matching one. The
5668 jump is only done if the match can be seen on the screen. The time to
5669 show the match can be set with 'matchtime'.
5670 A Beep is given if there is no match (no matter if the match can be
5671 seen or not). This option is reset when the 'paste' option is set.
5672 When the 'm' flag is not included in 'cpoptions', typing a character
5673 will immediately move the cursor back to where it belongs.
5674 See the "sm" field in 'guicursor' for setting the cursor shape and
5675 blinking when showing the match.
5676 The 'matchpairs' option can be used to specify the characters to show
5677 matches for. 'rightleft' and 'revins' are used to look for opposite
5678 matches.
5679 Note: For the use of the short form parental guidance is advised.
5680
5681 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5682'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5683 global
5684 If in Insert, Replace or Visual mode put a message on the last line.
5685 Use the 'M' flag in 'highlight' to set the type of highlighting for
5686 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005687 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 doesn't mean XIM is really active, especially when 'imactivatekey' is
5689 not set.
5690 NOTE: This option is set to the Vi default value when 'compatible' is
5691 set and to the Vim default value when 'compatible' is reset.
5692
5693 *'sidescroll'* *'ss'*
5694'sidescroll' 'ss' number (default 0)
5695 global
5696 {not in Vi}
5697 The minimal number of columns to scroll horizontally. Used only when
5698 the 'wrap' option is off and the cursor is moved off of the screen.
5699 When it is zero the cursor will be put in the middle of the screen.
5700 When using a slow terminal set it to a large number or 0. When using
5701 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5702 commands.
5703
5704 *'sidescrolloff'* *'siso'*
5705'sidescrolloff' 'siso' number (default 0)
5706 global
5707 {not in Vi}
5708 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005709 right of the cursor if 'nowrap' is set. Setting this option to a
5710 value greater than 0 while having |'sidescroll'| also at a non-zero
5711 value makes some context visible in the line you are scrolling in
5712 horizontally (except at beginning of the line). Setting this option
5713 to a large value (like 999) has the effect of keeping the cursor
5714 horizontally centered in the window, as long as one does not come too
5715 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 NOTE: This option is set to 0 when 'compatible' is set.
5717
5718 Example: Try this together with 'sidescroll' and 'listchars' as
5719 in the following example to never allow the cursor to move
5720 onto the "extends" character:
5721
5722 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5723 :set sidescrolloff=1
5724
5725
5726 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5727'smartcase' 'scs' boolean (default off)
5728 global
5729 {not in Vi}
5730 Override the 'ignorecase' option if the search pattern contains upper
5731 case characters. Only used when the search pattern is typed and
5732 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005733 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5735 recalling the search pattern from history and hitting <Enter>.
5736 NOTE: This option is reset when 'compatible' is set.
5737
5738 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5739'smartindent' 'si' boolean (default off)
5740 local to buffer
5741 {not in Vi}
5742 {not available when compiled without the
5743 |+smartindent| feature}
5744 Do smart autoindenting when starting a new line. Works for C-like
5745 programs, but can also be used for other languages. 'cindent' does
5746 something like this, works better in most cases, but is more strict,
5747 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5748 'indentexpr' is a more advanced alternative.
5749 Normally 'autoindent' should also be on when using 'smartindent'.
5750 An indent is automatically inserted:
5751 - After a line ending in '{'.
5752 - After a line starting with a keyword from 'cinwords'.
5753 - Before a line starting with '}' (only with the "O" command).
5754 When typing '}' as the first character in a new line, that line is
5755 given the same indent as the matching '{'.
5756 When typing '#' as the first character in a new line, the indent for
5757 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005758 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5760 When using the ">>" command, lines starting with '#' are not shifted
5761 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005762 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 is set smart indenting is disabled.
5764
5765 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5766'smarttab' 'sta' boolean (default off)
5767 global
5768 {not in Vi}
5769 When on, a <Tab> in front of a line inserts blanks according to
5770 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5771 a 'shiftwidth' worth of space at the start of the line.
5772 When off a <Tab> always inserts blanks according to 'tabstop'.
5773 'shiftwidth' is only used for shifting text left or right
5774 |shift-left-right|.
5775 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5776 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005777 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 NOTE: This option is reset when 'compatible' is set.
5779
5780 *'softtabstop'* *'sts'*
5781'softtabstop' 'sts' number (default 0)
5782 local to buffer
5783 {not in Vi}
5784 Number of spaces that a <Tab> counts for while performing editing
5785 operations, like inserting a <Tab> or using <BS>. It "feels" like
5786 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5787 used. This is useful to keep the 'ts' setting at its standard value
5788 of 8, while being able to edit like it is set to 'sts'. However,
5789 commands like "x" still work on the actual characters.
5790 When 'sts' is zero, this feature is off.
5791 'softtabstop' is set to 0 when the 'paste' option is set.
5792 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5793 spaces is minimized by using <Tab>s.
5794 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5795 set.
5796 NOTE: This option is set to 0 when 'compatible' is set.
5797
Bram Moolenaar217ad922005-03-20 22:37:15 +00005798 *'spell'* *'nospell'*
5799'spell' boolean (default off)
5800 local to window
5801 {not in Vi}
5802 {not available when compiled without the |+syntax|
5803 feature}
5804 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005805 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005806
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005807 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005808'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005809 local to buffer
5810 {not in Vi}
5811 {not available when compiled without the |+syntax|
5812 feature}
5813 Pattern to locate the end of a sentence. The following word will be
5814 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005815 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005816 When this check is not wanted make this option empty.
5817 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005818 Be careful with special characters, see |option-backslash| about
5819 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005820 To set this option automatically depending on the language, see
5821 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005822
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005823 *'spellfile'* *'spf'*
5824'spellfile' 'spf' string (default empty)
5825 local to buffer
5826 {not in Vi}
5827 {not available when compiled without the |+syntax|
5828 feature}
5829 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005830 commands. It must end in ".{encoding}.add". You need to include the
5831 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005832 *E765*
5833 It may also be a comma separated list of names. A count before the
5834 |zg| and |zw| commands can be used to access each. This allows using
5835 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005836 When a word is added while this option is empty Vim will set it for
5837 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005838 writable and the first language name that appears in 'spelllang',
5839 ignoring the region.
5840 The resulting ".spl" file will be used for spell checking, it does not
5841 have to appear in 'spelllang'.
5842 Normally one file is used for all regions, but you can add the region
5843 name if you want to. However, it will then only be used when
5844 'spellfile' is set to it, for entries in 'spelllang' only files
5845 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005846 This option cannot be set from a |modeline| or in the |sandbox|, for
5847 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005848
Bram Moolenaar217ad922005-03-20 22:37:15 +00005849 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005850'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005851 local to buffer
5852 {not in Vi}
5853 {not available when compiled without the |+syntax|
5854 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005855 A comma separated list of word list names. When the 'spell' option is
5856 on spellchecking will be done for these languages. Example: >
5857 set spelllang=en_us,nl,medical
5858< This means US English, Dutch and medical words are recognized. Words
5859 that are not recognized will be highlighted.
5860 The word list name must not include a comma or dot. Using a dash is
5861 recommended to separate the two letter language name from a
5862 specification. Thus "en-rare" is used for rare English words.
5863 A region name must come last and have the form "_xx", where "xx" is
5864 the two-letter, lower case region name. You can use more than one
5865 region by listing them: "en_us,en_ca" supports both US and Canadian
5866 English, but not words specific for Australia, New Zealand or Great
5867 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005868 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005869 As a special case the name of a .spl file can be given as-is. The
5870 first "_xx" in the name is removed and used as the region name
5871 (_xx is an underscore, two letters and followed by a non-letter).
5872 This is mainly for testing purposes. You must make sure the correct
5873 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005874 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005875 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5876 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005877 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005878
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005879 After this option has been set successfully, Vim will source the files
5880 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5881 up to the first comma, dot or underscore. See |set-spc-auto|.
5882
5883
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005884 *'spellsuggest'* *'sps'*
5885'spellsuggest' 'sps' string (default "best")
5886 global
5887 {not in Vi}
5888 {not available when compiled without the |+syntax|
5889 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005890 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005891 the |spellsuggest()| function. This is a comma-separated list of
5892 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005893
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005894 best Internal method that works best for English. Finds
5895 changes like "fast" and uses a bit of sound-a-like
5896 scoring to improve the ordering.
5897
5898 double Internal method that uses two methods and mixes the
5899 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005900 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005901 word. That only works when the language specifies
5902 sound folding. Can be slow and doesn't always give
5903 better results.
5904
5905 fast Internal method that only checks for simple changes:
5906 character inserts/deletes/swaps. Works well for
5907 simple typing mistakes.
5908
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005909 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005910 Not used for |spellsuggest()|. The number of
5911 suggestions is never more than the value of 'lines'
5912 minus two.
5913
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005914 file:{filename} Read file {filename}, which must have two columns,
5915 separated by a slash. The first column contains the
5916 bad word, the second column the suggested good word.
5917 Example:
5918 theribal/terrible ~
5919 Use this for common mistakes that do not appear at the
5920 top of the suggestion list with the internal methods.
5921 Lines without a slash are ignored, use this for
5922 comments.
5923 The file is used for all languages.
5924
5925 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5926 trouble with spaces. |v:val| holds the badly spelled
5927 word. The expression must evaluate to a List of
5928 Lists, each with a suggestion and a score.
5929 Example:
5930 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005931 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005932 internal methods use. A lower score is better.
5933 This may invoke |spellsuggest()| if you temporarily
5934 set 'spellsuggest' to exclude the "expr:" part.
5935 Errors are silently ignored, unless you set the
5936 'verbose' option to a non-zero value.
5937
5938 Only one of "best", "double" or "fast" may be used. The others may
5939 appear several times in any order. Example: >
5940 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5941<
5942 This option cannot be set from a |modeline| or in the |sandbox|, for
5943 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005944
5945
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5947'splitbelow' 'sb' boolean (default off)
5948 global
5949 {not in Vi}
5950 {not available when compiled without the +windows
5951 feature}
5952 When on, splitting a window will put the new window below the current
5953 one. |:split|
5954
5955 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5956'splitright' 'spr' boolean (default off)
5957 global
5958 {not in Vi}
5959 {not available when compiled without the +vertsplit
5960 feature}
5961 When on, splitting a window will put the new window right of the
5962 current one. |:vsplit|
5963
5964 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5965'startofline' 'sol' boolean (default on)
5966 global
5967 {not in Vi}
5968 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005969 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005970 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005971 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005972 with a linewise operator, with "%" with a count and to buffer changing
5973 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5974 only has a line number, e.g., ":25" or ":+".
5975 In case of buffer changing commands the cursor is placed at the column
5976 where it was the last time the buffer was edited.
5977 NOTE: This option is set when 'compatible' is set.
5978
5979 *'statusline'* *'stl'* *E540* *E541* *E542*
5980'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005981 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 {not in Vi}
5983 {not available when compiled without the |+statusline|
5984 feature}
5985 When nonempty, this option determines the content of the status line.
5986 Also see |status-line|.
5987
5988 The option consists of printf style '%' items interspersed with
5989 normal text. Each status line item is of the form:
5990 %-0{minwid}.{maxwid}{item}
5991 All fields except the {item} is optional. A single percent sign can
5992 be given as "%%". Up to 80 items can be specified.
5993
5994 Note that the only effect of 'ruler' when this option is set (and
5995 'laststatus' is 2) is controlling the output of |CTRL-G|.
5996
5997 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005998 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006000 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006001 minwid Minimum width of the item, padding as set by '-' & '0'.
6002 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006003 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006004 on the left for text items. Numeric items will be
6005 shifted down to maxwid-2 digits followed by '>'number
6006 where number is the amount of missing digits, much like
6007 an exponential notation.
6008 item A one letter code as described below.
6009
6010 Following is a description of the possible statusline items. The
6011 second character in "item" is the type:
6012 N for number
6013 S for string
6014 F for flags as described below
6015 - not applicable
6016
6017 item meaning ~
6018 f S Path to the file in the buffer, relative to current directory.
6019 F S Full path to the file in the buffer.
6020 t S File name (tail) of file in the buffer.
6021 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6022 M F Modified flag, text is ",+" or ",-".
6023 r F Readonly flag, text is " [RO]".
6024 R F Readonly flag, text is ",RO".
6025 h F Help buffer flag, text is " [help]".
6026 H F Help buffer flag, text is ",HLP".
6027 w F Preview window flag, text is " [Preview]".
6028 W F Preview window flag, text is ",PRV".
6029 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6030 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6031 {not available when compiled without |+autocmd| feature}
6032 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6033 being used: "<keymap>"
6034 n N Buffer number.
6035 b N Value of byte under cursor.
6036 B N As above, in hexadecimal.
6037 o N Byte number in file of byte under cursor, first byte is 1.
6038 Mnemonic: Offset from start of file (with one added)
6039 {not available when compiled without |+byte_offset| feature}
6040 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006041 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 l N Line number.
6043 L N Number of lines in buffer.
6044 c N Column number.
6045 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006046 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 p N Percentage through file in lines as in |CTRL-G|.
6048 P S Percentage through file of displayed window. This is like the
6049 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006050 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 Empty if the argument file count is zero or one.
6052 { NF Evaluate expression between '{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006053 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 ( - Start of item group. Can be used for setting the width and
6055 alignment of a section. Must be followed by %) somewhere.
6056 ) - End of item group. No width fields allowed.
6057 < - Where to truncate line if too long. Default is at the start.
6058 No width fields allowed.
6059 = - Separation point between left and right aligned items.
6060 No width fields allowed.
6061 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006062 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006063 The difference between User{N} and StatusLine will be applied
6064 to StatusLineNC for the statusline of non-current windows.
6065 The number N must be between 1 and 9. See |hl-User1..9|
6066
6067 Display of flags are controlled by the following heuristic:
6068 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006069 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 with a space it is assumed that it wants to separate itself from
6071 anything but other flags. That is: A leading comma is removed if the
6072 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006073 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 make a nice display when flags are used like in the examples below.
6075
Bram Moolenaar582fd852005-03-28 20:58:01 +00006076 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 not set) and a minwid is not set for the group, the whole group will
6078 become empty. This will make a group like the following disappear
6079 completely from the statusline when none of the flags are set. >
6080 :set statusline=...%(\ [%M%R%H]%)...
6081<
6082 Beware that an expression is evaluated each and every time the status
6083 line is displayed. The current buffer and current window will be set
6084 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006085 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006086 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6087 real current buffer. The expression is evaluated in the |sandbox|.
6088
6089 If the statusline is not updated when you want it (e.g., after setting
6090 a variable that's used in an expression), you can force an update by
6091 setting an option without changing its value. Example: >
6092 :let &ro = &ro
6093
6094< A result of all digits is regarded a number for display purposes.
6095 Otherwise the result is taken as flag text and applied to the rules
6096 described above.
6097
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006098 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6100 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6101
6102 Examples:
6103 Emulate standard status line with 'ruler' set >
6104 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6105< Similar, but add ASCII value of char under the cursor (like "ga") >
6106 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6107< Display byte count and byte value, modified flag in red. >
6108 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6109 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6110< Display a ,GZ flag if a compressed file is loaded >
6111 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6112< In the |:autocmd|'s: >
6113 :let b:gzflag = 1
6114< And: >
6115 :unlet b:gzflag
6116< And define this function: >
6117 :function VarExists(var, val)
6118 : if exists(a:var) | return a:val | else | return '' | endif
6119 :endfunction
6120<
6121 *'suffixes'* *'su'*
6122'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6123 global
6124 {not in Vi}
6125 Files with these suffixes get a lower priority when multiple files
6126 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006127 suffixes. Spaces after the comma are ignored. A dot is also seen as
6128 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 separator, precede it with a backslash (see |option-backslash| about
6130 including spaces and backslashes).
6131 See 'wildignore' for completely ignoring files.
6132 The use of |:set+=| and |:set-=| is preferred when adding or removing
6133 suffixes from the list. This avoids problems when a future version
6134 uses another default.
6135
6136 *'suffixesadd'* *'sua'*
6137'suffixesadd' 'sua' string (default "")
6138 local to buffer
6139 {not in Vi}
6140 {not available when compiled without the
6141 |+file_in_path| feature}
6142 Comma separated list of suffixes, which are used when searching for a
6143 file for the "gf", "[I", etc. commands. Example: >
6144 :set suffixesadd=.java
6145<
6146 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6147'swapfile' 'swf' boolean (default on)
6148 local to buffer
6149 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006150 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151 swapfile is not wanted for a specific buffer. For example, with
6152 confidential information that even root must not be able to access.
6153 Careful: All text will be in memory:
6154 - Don't use this for big files.
6155 - Recovery will be impossible!
6156 A swapfile will only be present when |'updatecount'| is non-zero and
6157 'swapfile' is set.
6158 When 'swapfile' is reset, the swap file for the current buffer is
6159 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6160 non-zero, a swap file is immediately created.
6161 Also see |swap-file| and |'swapsync'|.
6162
6163 This option is used together with 'bufhidden' and 'buftype' to
6164 specify special kinds of buffers. See |special-buffers|.
6165
6166 *'swapsync'* *'sws'*
6167'swapsync' 'sws' string (default "fsync")
6168 global
6169 {not in Vi}
6170 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006171 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006172 When this option is empty parts of the swap file may be in memory and
6173 not written to disk. When the system crashes you may lose more work.
6174 On Unix the system does a sync now and then without Vim asking for it,
6175 so the disadvantage of setting this option off is small. On some
6176 systems the swap file will not be written at all. For a unix system
6177 setting it to "sync" will use the sync() call instead of the default
6178 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006179 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180
6181 *'switchbuf'* *'swb'*
6182'switchbuf' 'swb' string (default "")
6183 global
6184 {not in Vi}
6185 This option controls the behavior when switching between buffers.
6186 Possible values (comma separated list):
6187 useopen If included, jump to the first open window that
6188 contains the specified buffer (if there is one).
6189 Otherwise: Do not examine other windows.
6190 This setting is checked with |quickfix| commands, when
6191 jumping to errors (":cc", ":cn", "cp", etc.). It is
6192 also used in all buffer related split commands, for
6193 example ":sbuffer", ":sbnext", or ":sbrewind".
6194 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006195 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 Supported in |quickfix| commands that display errors.
6197
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006198 *'synmaxcol'* *'smc'*
6199'synmaxcol' 'smc' number (default 3000)
6200 local to buffer
6201 {not in Vi}
6202 {not available when compiled without the |+syntax|
6203 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006204 Maximum column in which to search for syntax items. In long lines the
6205 text after this column is not highlighted and following lines may not
6206 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006207 This helps to avoid very slow redrawing for an XML file that is one
6208 long line.
6209 Set to zero to remove the limit.
6210
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 *'syntax'* *'syn'*
6212'syntax' 'syn' string (default empty)
6213 local to buffer
6214 {not in Vi}
6215 {not available when compiled without the |+syntax|
6216 feature}
6217 When this option is set, the syntax with this name is loaded, unless
6218 syntax highlighting has been switched off with ":syntax off".
6219 Otherwise this option does not always reflect the current syntax (the
6220 b:current_syntax variable does).
6221 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006222 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 /* vim: set syntax=idl : */
6224< To switch off syntax highlighting for the current file, use: >
6225 :set syntax=OFF
6226< To switch syntax highlighting on according to the current value of the
6227 'filetype' option: >
6228 :set syntax=ON
6229< What actually happens when setting the 'syntax' option is that the
6230 Syntax autocommand event is triggered with the value as argument.
6231 This option is not copied to another buffer, independent of the 's' or
6232 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006233 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234
6235 *'tabstop'* *'ts'*
6236'tabstop' 'ts' number (default 8)
6237 local to buffer
6238 Number of spaces that a <Tab> in the file counts for. Also see
6239 |:retab| command, and 'softtabstop' option.
6240
6241 Note: Setting 'tabstop' to any other value than 8 can make your file
6242 appear wrong in many places (e.g., when printing it).
6243
6244 There are four main ways to use tabs in Vim:
6245 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6246 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6247 will use a mix of tabs and spaces, but typing Tab and BS will
6248 behave like a tab appears every 4 (or 3) characters.
6249 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6250 'expandtab'. This way you will always insert spaces. The
6251 formatting will never be messed up when 'tabstop' is changed.
6252 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006253 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 works when using Vim to edit the file.
6255 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6256 'noexpandtab'. This should then work (for initial indents only)
6257 for any tabstop setting that people use. It might be nice to have
6258 tabs after the first non-blank inserted as spaces if you do this
6259 though. Otherwise aligned comments will be wrong when 'tabstop' is
6260 changed.
6261
6262 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6263'tagbsearch' 'tbs' boolean (default on)
6264 global
6265 {not in Vi}
6266 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006267 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 searching makes searching for a tag a LOT faster, but a linear search
6269 will find more tags if the tags file wasn't properly sorted.
6270 Vim normally assumes that your tags files are sorted, or indicate that
6271 they are not sorted. Only when this is not the case does the
6272 'tagbsearch' option need to be switched off.
6273
6274 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006275 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 certain files, or retry all files with a linear search. When
6277 'tagbsearch' is off, only a linear search is done.
6278
6279 Linear searching is done anyway, for one file, when Vim finds a line
6280 at the start of the file indicating that it's not sorted: >
6281 !_TAG_FILE_SORTED 0 /some command/
6282< [The whitespace before and after the '0' must be a single <Tab>]
6283
6284 When a binary search was done and no match was found in any of the
6285 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6286 instead of a normal tag name, a retry is done with a linear search.
6287 Tags in unsorted tags files, and matches with different case will only
6288 be found in the retry.
6289
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006290 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 linear search can be avoided for the 'ignorecase' case. Use a value
6292 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6293 case-fold sorted with the -f switch to "sort" in most unices, as in
6294 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6295 5.3 or higher the -f or --fold-case-sort switch can be used for this
6296 as well. Note that case must be folded to uppercase for this to work.
6297
6298 When 'tagbsearch' is off, tags searching is slower when a full match
6299 exists, but faster when no full match exists. Tags in unsorted tags
6300 files may only be found with 'tagbsearch' off.
6301 When the tags file is not sorted, or sorted in a wrong way (not on
6302 ASCII byte value), 'tagbsearch' should be off, or the line given above
6303 must be included in the tags file.
6304 This option doesn't affect commands that find all matching tags (e.g.,
6305 command-line completion and ":help").
6306 {Vi: always uses binary search in some versions}
6307
6308 *'taglength'* *'tl'*
6309'taglength' 'tl' number (default 0)
6310 global
6311 If non-zero, tags are significant up to this number of characters.
6312
6313 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6314'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6315 global
6316 {not in Vi}
6317 If on and using a tag file in another directory, file names in that
6318 tag file are relative to the directory where the tag file is.
6319 NOTE: This option is set to the Vi default value when 'compatible' is
6320 set and to the Vim default value when 'compatible' is reset.
6321
6322 *'tags'* *'tag'* *E433*
6323'tags' 'tag' string (default "./tags,tags", when compiled with
6324 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6325 global or local to buffer |global-local|
6326 Filenames for the tag command, separated by spaces or commas. To
6327 include a space or comma in a file name, precede it with a backslash
6328 (see |option-backslash| about including spaces and backslashes).
6329 When a file name starts with "./", the '.' is replaced with the path
6330 of the current file. But only when the 'd' flag is not included in
6331 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6332 |tags-option|.
6333 "*", "**" and other wildcards can be used to search for tags files in
6334 a directory tree. See |file-searching|. {not available when compiled
6335 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006336 The |tagfiles()| function can be used to get a list of the file names
6337 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6339 files are also supported. They are automatically recognized. The
6340 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6341 differences are ignored (MS-Windows). |emacs-tags|
6342 The use of |:set+=| and |:set-=| is preferred when adding or removing
6343 file names from the list. This avoids problems when a future version
6344 uses another default.
6345 {Vi: default is "tags /usr/lib/tags"}
6346
6347 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6348'tagstack' 'tgst' boolean (default on)
6349 global
6350 {not in all versions of Vi}
6351 When on, the |tagstack| is used normally. When off, a ":tag" or
6352 ":tselect" command with an argument will not push the tag onto the
6353 tagstack. A following ":tag" without an argument, a ":pop" command or
6354 any other command that uses the tagstack will use the unmodified
6355 tagstack, but does change the pointer to the active entry.
6356 Resetting this option is useful when using a ":tag" command in a
6357 mapping which should not change the tagstack.
6358
6359 *'term'* *E529* *E530* *E531*
6360'term' string (default is $TERM, if that fails:
6361 in the GUI: "builtin_gui"
6362 on Amiga: "amiga"
6363 on BeOS: "beos-ansi"
6364 on Mac: "mac-ansi"
6365 on MiNT: "vt52"
6366 on MS-DOS: "pcterm"
6367 on OS/2: "os2ansi"
6368 on Unix: "ansi"
6369 on VMS: "ansi"
6370 on Win 32: "win32")
6371 global
6372 Name of the terminal. Used for choosing the terminal control
6373 characters. Environment variables are expanded |:set_env|.
6374 For example: >
6375 :set term=$TERM
6376< See |termcap|.
6377
6378 *'termbidi'* *'tbidi'*
6379 *'notermbidi'* *'notbidi'*
6380'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6381 global
6382 {not in Vi}
6383 {only available when compiled with the |+arabic|
6384 feature}
6385 The terminal is in charge of Bi-directionality of text (as specified
6386 by Unicode). The terminal is also expected to do the required shaping
6387 that some languages (such as Arabic) require.
6388 Setting this option implies that 'rightleft' will not be set when
6389 'arabic' is set and the value of 'arabicshape' will be ignored.
6390 Note that setting 'termbidi' has the immediate effect that
6391 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6392 This option is reset when the GUI is started.
6393 For further details see |arabic.txt|.
6394
6395 *'termencoding'* *'tenc'*
6396'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6397 Macintosh GUI: "macroman")
6398 global
6399 {only available when compiled with the |+multi_byte|
6400 feature}
6401 {not in Vi}
6402 Encoding used for the terminal. This specifies what character
6403 encoding the keyboard produces and the display will understand. For
6404 the GUI it only applies to the keyboard ('encoding' is used for the
6405 display).
6406 In the Win32 console version the default value is the console codepage
6407 when it differs from the ANSI codepage.
6408 *E617*
6409 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6410 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6411 Any attempts to set a different value will be rejected, and an error
6412 message is shown.
6413 For the Win32 GUI 'termencoding' is not used for typed characters,
6414 because the Win32 system always passes Unicode characters.
6415 When empty, the same encoding is used as for the 'encoding' option.
6416 This is the normal value.
6417 Not all combinations for 'termencoding' and 'encoding' are valid. See
6418 |encoding-table|.
6419 The value for this option must be supported by internal conversions or
6420 iconv(). When this is not possible no conversion will be done and you
6421 will probably experience problems with non-ASCII characters.
6422 Example: You are working with the locale set to euc-jp (Japanese) and
6423 want to edit a UTF-8 file: >
6424 :let &termencoding = &encoding
6425 :set encoding=utf-8
6426< You need to do this when your system has no locale support for UTF-8.
6427
6428 *'terse'* *'noterse'*
6429'terse' boolean (default off)
6430 global
6431 When set: Add 's' flag to 'shortmess' option (this makes the message
6432 for a search that hits the start or end of the file not being
6433 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6434 shortens a lot of messages}
6435
6436 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6437'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6438 global
6439 {not in Vi}
6440 This option is obsolete. Use 'fileformats'.
6441 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6442 set to the default value for the current system. When 'textauto' is
6443 reset, 'fileformats' is made empty.
6444 NOTE: This option is set to the Vi default value when 'compatible' is
6445 set and to the Vim default value when 'compatible' is reset.
6446
6447 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6448'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6449 others: default off)
6450 local to buffer
6451 {not in Vi}
6452 This option is obsolete. Use 'fileformat'.
6453 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6454 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6455 "unix".
6456
6457 *'textwidth'* *'tw'*
6458'textwidth' 'tw' number (default 0)
6459 local to buffer
6460 {not in Vi}
6461 Maximum width of text that is being inserted. A longer line will be
6462 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006463 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6464 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 'formatoptions' and |ins-textwidth|.
6466 NOTE: This option is set to 0 when 'compatible' is set.
6467
6468 *'thesaurus'* *'tsr'*
6469'thesaurus' 'tsr' string (default "")
6470 global or local to buffer |global-local|
6471 {not in Vi}
6472 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006473 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 the file should contain words with similar meaning, separated by
6475 non-keyword characters (white space is preferred). Maximum line
6476 length is 510 bytes.
6477 To obtain a file to be used here, check out the wordlist FAQ at
6478 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006479 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006480 after a comma are ignored, otherwise spaces are included in the file
6481 name. See |option-backslash| about using backslashes.
6482 The use of |:set+=| and |:set-=| is preferred when adding or removing
6483 directories from the list. This avoids problems when a future version
6484 uses another default.
6485 Backticks cannot be used in this option for security reasons.
6486
6487 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6488'tildeop' 'top' boolean (default off)
6489 global
6490 {not in Vi}
6491 When on: The tilde command "~" behaves like an operator.
6492 NOTE: This option is reset when 'compatible' is set.
6493
6494 *'timeout'* *'to'* *'notimeout'* *'noto'*
6495'timeout' 'to' boolean (default on)
6496 global
6497 *'ttimeout'* *'nottimeout'*
6498'ttimeout' boolean (default off)
6499 global
6500 {not in Vi}
6501 These two options together determine the behavior when part of a
6502 mapped key sequence or keyboard code has been received:
6503
6504 'timeout' 'ttimeout' action ~
6505 off off do not time out
6506 on on or off time out on :mappings and key codes
6507 off on time out on key codes
6508
6509 If both options are off, Vim will wait until either the complete
6510 mapping or key sequence has been received, or it is clear that there
6511 is no mapping or key sequence for the received characters. For
6512 example: if you have mapped "vl" and Vim has received 'v', the next
6513 character is needed to see if the 'v' is followed by an 'l'.
6514 When one of the options is on, Vim will wait for about 1 second for
6515 the next character to arrive. After that the already received
6516 characters are interpreted as single characters. The waiting time can
6517 be changed with the 'timeoutlen' option.
6518 On slow terminals or very busy systems timing out may cause
6519 malfunctioning cursor keys. If both options are off, Vim waits
6520 forever after an entered <Esc> if there are key codes that start
6521 with <Esc>. You will have to type <Esc> twice. If you do not have
6522 problems with key codes, but would like to have :mapped key
6523 sequences not timing out in 1 second, set the 'ttimeout' option and
6524 reset the 'timeout' option.
6525
6526 NOTE: 'ttimeout' is reset when 'compatible' is set.
6527
6528 *'timeoutlen'* *'tm'*
6529'timeoutlen' 'tm' number (default 1000)
6530 global
6531 {not in all versions of Vi}
6532 *'ttimeoutlen'* *'ttm'*
6533'ttimeoutlen' 'ttm' number (default -1)
6534 global
6535 {not in Vi}
6536 The time in milliseconds that is waited for a key code or mapped key
6537 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6538 when part of a command has been typed.
6539 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6540 different timeout value for key codes is desired set 'ttimeoutlen' to
6541 a non-negative number.
6542
6543 ttimeoutlen mapping delay key code delay ~
6544 < 0 'timeoutlen' 'timeoutlen'
6545 >= 0 'timeoutlen' 'ttimeoutlen'
6546
6547 The timeout only happens when the 'timeout' and 'ttimeout' options
6548 tell so. A useful setting would be >
6549 :set timeout timeoutlen=3000 ttimeoutlen=100
6550< (time out on mapping after three seconds, time out on key codes after
6551 a tenth of a second).
6552
6553 *'title'* *'notitle'*
6554'title' boolean (default off, on when title can be restored)
6555 global
6556 {not in Vi}
6557 {not available when compiled without the |+title|
6558 feature}
6559 When on, the title of the window will be set to the value of
6560 'titlestring' (if it is not empty), or to:
6561 filename [+=-] (path) - VIM
6562 Where:
6563 filename the name of the file being edited
6564 - indicates the file cannot be modified, 'ma' off
6565 + indicates the file was modified
6566 = indicates the file is read-only
6567 =+ indicates the file is read-only and modified
6568 (path) is the path of the file being edited
6569 - VIM the server name |v:servername| or "VIM"
6570 Only works if the terminal supports setting window titles
6571 (currently Amiga console, Win32 console, all GUI versions and
6572 terminals with a non- empty 't_ts' option - these are Unix xterm and
6573 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6574 *X11*
6575 When Vim was compiled with HAVE_X11 defined, the original title will
6576 be restored if possible. The output of ":version" will include "+X11"
6577 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6578 works for the icon name |'icon'|.
6579 But: When Vim was started with the |-X| argument, restoring the title
6580 will not work (except in the GUI).
6581 If the title cannot be restored, it is set to the value of 'titleold'.
6582 You might want to restore the title outside of Vim then.
6583 When using an xterm from a remote machine you can use this command:
6584 rsh machine_name xterm -display $DISPLAY &
6585 then the WINDOWID environment variable should be inherited and the
6586 title of the window should change back to what it should be after
6587 exiting Vim.
6588
6589 *'titlelen'*
6590'titlelen' number (default 85)
6591 global
6592 {not in Vi}
6593 {not available when compiled without the |+title|
6594 feature}
6595 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006596 title. When the title is longer, only the end of the path name is
6597 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 Using a percentage makes this adapt to the width of the window. But
6599 it won't work perfectly, because the actual number of characters
6600 available also depends on the font used and other things in the title
6601 bar. When 'titlelen' is zero the full path is used. Otherwise,
6602 values from 1 to 30000 percent can be used.
6603 'titlelen' is also used for the 'titlestring' option.
6604
6605 *'titleold'*
6606'titleold' string (default "Thanks for flying Vim")
6607 global
6608 {not in Vi}
6609 {only available when compiled with the |+title|
6610 feature}
6611 This option will be used for the window title when exiting Vim if the
6612 original title cannot be restored. Only happens if 'title' is on or
6613 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006614 This option cannot be set from a |modeline| or in the |sandbox|, for
6615 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006616 *'titlestring'*
6617'titlestring' string (default "")
6618 global
6619 {not in Vi}
6620 {not available when compiled without the |+title|
6621 feature}
6622 When this option is not empty, it will be used for the title of the
6623 window. This happens only when the 'title' option is on.
6624 Only works if the terminal supports setting window titles (currently
6625 Amiga console, Win32 console, all GUI versions and terminals with a
6626 non-empty 't_ts' option).
6627 When Vim was compiled with HAVE_X11 defined, the original title will
6628 be restored if possible |X11|.
6629 When this option contains printf-style '%' items, they will be
6630 expanded according to the rules used for 'statusline'.
6631 Example: >
6632 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6633 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6634< The value of 'titlelen' is used to align items in the middle or right
6635 of the available space.
6636 Some people prefer to have the file name first: >
6637 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6638< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006639 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 separating space only when needed.
6641 NOTE: Use of special characters in 'titlestring' may cause the display
6642 to be garbled (e.g., when it contains a CR or NL character).
6643 {not available when compiled without the |+statusline| feature}
6644
6645 *'toolbar'* *'tb'*
6646'toolbar' 'tb' string (default "icons,tooltips")
6647 global
6648 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6649 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006650 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 possible values are:
6652 icons Toolbar buttons are shown with icons.
6653 text Toolbar buttons shown with text.
6654 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006655 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 tooltips Tooltips are active for toolbar buttons.
6657 Tooltips refer to the popup help text which appears after the mouse
6658 cursor is placed over a toolbar button for a brief moment.
6659
6660 If you want the toolbar to be shown with icons as well as text, do the
6661 following: >
6662 :set tb=icons,text
6663< Motif and Athena cannot display icons and text at the same time. They
6664 will show icons if both are requested.
6665
6666 If none of the strings specified in 'toolbar' are valid or if
6667 'toolbar' is empty, this option is ignored. If you want to disable
6668 the toolbar, you need to set the 'guioptions' option. For example: >
6669 :set guioptions-=T
6670< Also see |gui-toolbar|.
6671
6672 *'toolbariconsize'* *'tbis'*
6673'toolbariconsize' 'tbis' string (default "small")
6674 global
6675 {not in Vi}
6676 {only in the GTK+ 2 GUI}
6677 Controls the size of toolbar icons. The possible values are:
6678 tiny Use tiny toolbar icons.
6679 small Use small toolbar icons (default).
6680 medium Use medium-sized toolbar icons.
6681 large Use large toolbar icons.
6682 The exact dimensions in pixels of the various icon sizes depend on
6683 the current theme. Common dimensions are large=32x32, medium=24x24,
6684 small=20x20 and tiny=16x16.
6685
6686 If 'toolbariconsize' is empty, the global default size as determined
6687 by user preferences or the current theme is used.
6688
6689 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6690'ttybuiltin' 'tbi' boolean (default on)
6691 global
6692 {not in Vi}
6693 When on, the builtin termcaps are searched before the external ones.
6694 When off the builtin termcaps are searched after the external ones.
6695 When this option is changed, you should set the 'term' option next for
6696 the change to take effect, for example: >
6697 :set notbi term=$TERM
6698< See also |termcap|.
6699 Rationale: The default for this option is "on", because the builtin
6700 termcap entries are generally better (many systems contain faulty
6701 xterm entries...).
6702
6703 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6704'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6705 sun-cmd, screen, rxvt, dtterm or
6706 iris-ansi; also on when running Vim in
6707 a DOS console)
6708 global
6709 {not in Vi}
6710 Indicates a fast terminal connection. More characters will be sent to
6711 the screen for redrawing, instead of using insert/delete line
6712 commands. Improves smoothness of redrawing when there are multiple
6713 windows and the terminal does not support a scrolling region.
6714 Also enables the extra writing of characters at the end of each screen
6715 line for lines that wrap. This helps when using copy/paste with the
6716 mouse in an xterm and other terminals.
6717
6718 *'ttymouse'* *'ttym'*
6719'ttymouse' 'ttym' string (default depends on 'term')
6720 global
6721 {not in Vi}
6722 {only in Unix and VMS, doesn't work in the GUI; not
6723 available when compiled without |+mouse|}
6724 Name of the terminal type for which mouse codes are to be recognized.
6725 Currently these three strings are valid:
6726 *xterm-mouse*
6727 xterm xterm-like mouse handling. The mouse generates
6728 "<Esc>[Mscr", where "scr" is three bytes:
6729 "s" = button state
6730 "c" = column plus 33
6731 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006732 This only works up to 223 columns! See "dec" for a
6733 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 xterm2 Works like "xterm", but with the xterm reporting the
6735 mouse position while the mouse is dragged. This works
6736 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006737 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 work. See below for how Vim detects this
6739 automatically.
6740 *netterm-mouse*
6741 netterm NetTerm mouse handling. The mouse generates
6742 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6743 for the row and column.
6744 *dec-mouse*
6745 dec DEC terminal mouse handling. The mouse generates a
6746 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006747 This is also available for an Xterm, if it was
6748 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 *jsbterm-mouse*
6750 jsbterm JSB term mouse handling.
6751 *pterm-mouse*
6752 pterm QNX pterm mouse handling.
6753
6754 The mouse handling must be enabled at compile time |+mouse_xterm|
6755 |+mouse_dec| |+mouse_netterm|.
6756 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6757 recognized, if enabled at compile time. DEC terminal mouse codes
6758 are recognized if enabled at compile time, and 'ttymouse' is not
6759 "xterm" (because the xterm and dec mouse codes conflict).
6760 This option is automatically set to "xterm", when the 'term' option is
6761 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6762 or "xterm2" already. The main use of this option is to set it to
6763 "xterm", when the terminal name doesn't start with "xterm", but it can
6764 handle xterm mouse codes.
6765 The "xterm2" value will be set if the xterm version is reported to be
6766 95 of higher. This only works when compiled with the |+termresponse|
6767 feature and if |t_RV| is set to the escape sequence to request the
6768 xterm version number. Otherwise "xterm2" must be set explicitly.
6769 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6770 t_RV to an empty string: >
6771 :set t_RV=
6772<
6773 *'ttyscroll'* *'tsl'*
6774'ttyscroll' 'tsl' number (default 999)
6775 global
6776 Maximum number of lines to scroll the screen. If there are more lines
6777 to scroll the window is redrawn. For terminals where scrolling is
6778 very slow and redrawing is not slow this can be set to a small number,
6779 e.g., 3, to speed up displaying.
6780
6781 *'ttytype'* *'tty'*
6782'ttytype' 'tty' string (default from $TERM)
6783 global
6784 Alias for 'term', see above.
6785
6786 *'undolevels'* *'ul'*
6787'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6788 Win32 and OS/2)
6789 global
6790 {not in Vi}
6791 Maximum number of changes that can be undone. Since undo information
6792 is kept in memory, higher numbers will cause more memory to be used
6793 (nevertheless, a single change can use an unlimited amount of memory).
6794 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6795 itself: >
6796 set ul=0
6797< But you can also get Vi compatibility by including the 'u' flag in
6798 'cpoptions', and still be able to use CTRL-R to repeat undo.
6799 Set to a negative number for no undo at all: >
6800 set ul=-1
6801< This helps when you run out of memory for a single change.
6802 Also see |undo-two-ways|.
6803
6804 *'updatecount'* *'uc'*
6805'updatecount' 'uc' number (default: 200)
6806 global
6807 {not in Vi}
6808 After typing this many characters the swap file will be written to
6809 disk. When zero, no swap file will be created at all (see chapter on
6810 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6811 Vim with the "-n" option, see |startup|. When editing in readonly
6812 mode this option will be initialized to 10000.
6813 The swapfile can be disabled per buffer with |'swapfile'|.
6814 When 'updatecount' is set from zero to non-zero, swap files are
6815 created for all buffers that have 'swapfile' set. When 'updatecount'
6816 is set to zero, existing swap files are not deleted.
6817 Also see |'swapsync'|.
6818 This option has no meaning in buffers where |'buftype'| is "nofile"
6819 or "nowrite".
6820
6821 *'updatetime'* *'ut'*
6822'updatetime' 'ut' number (default 4000)
6823 global
6824 {not in Vi}
6825 If this many milliseconds nothing is typed the swap file will be
6826 written to disk (see |crash-recovery|). Also used for the
6827 |CursorHold| autocommand event.
6828
6829 *'verbose'* *'vbs'*
6830'verbose' 'vbs' number (default 0)
6831 global
6832 {not in Vi, although some versions have a boolean
6833 verbose option}
6834 When bigger than zero, Vim will give messages about what it is doing.
6835 Currently, these messages are given:
6836 >= 1 When the viminfo file is read or written.
6837 >= 2 When a file is ":source"'ed.
6838 >= 5 Every searched tags file.
6839 >= 8 Files for which a group of autocommands is executed.
6840 >= 9 Every executed autocommand.
6841 >= 12 Every executed function.
6842 >= 13 When an exception is thrown, caught, finished, or discarded.
6843 >= 14 Anything pending in a ":finally" clause.
6844 >= 15 Every executed Ex command (truncated at 200 characters).
6845
6846 This option can also be set with the "-V" argument. See |-V|.
6847 This option is also set by the |:verbose| command.
6848
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006849 When the 'verbosefile' option is set then the verbose messages are not
6850 displayed.
6851
6852 *'verbosefile'* *'vfile'*
6853'verbosefile' 'vfile' string (default empty)
6854 global
6855 {not in Vi}
6856 When not empty all messages are written in a file with this name.
6857 When the file exists messages are appended.
6858 Writing to the file ends when Vim exits or when 'verbosefile' is made
6859 empty.
6860 Setting 'verbosefile' to a new value is like making it empty first.
6861 The difference with |:redir| is that verbose messages are not
6862 displayed when 'verbosefile' is set.
6863
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 *'viewdir'* *'vdir'*
6865'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6866 "$VIM/vimfiles/view",
6867 for Unix: "~/.vim/view",
6868 for Macintosh: "$VIM:vimfiles:view"
6869 for VMS: "sys$login:vimfiles/view"
6870 for RiscOS: "Choices:vimfiles/view")
6871 global
6872 {not in Vi}
6873 {not available when compiled without the +mksession
6874 feature}
6875 Name of the directory where to store files for |:mkview|.
6876 This option cannot be set from a |modeline| or in the |sandbox|, for
6877 security reasons.
6878
6879 *'viewoptions'* *'vop'*
6880'viewoptions' 'vop' string (default: "folds,options,cursor")
6881 global
6882 {not in Vi}
6883 {not available when compiled without the +mksession
6884 feature}
6885 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006886 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 word save and restore ~
6888 cursor cursor position in file and in window
6889 folds manually created folds, opened/closed folds and local
6890 fold options
6891 options options and mappings local to a window or buffer (not
6892 global values for local options)
6893 slash backslashes in file names replaced with forward
6894 slashes
6895 unix with Unix end-of-line format (single <NL>), even when
6896 on Windows or DOS
6897
6898 "slash" and "unix" are useful on Windows when sharing view files
6899 with Unix. The Unix version of Vim cannot source dos format scripts,
6900 but the Windows version of Vim can source unix format scripts.
6901
6902 *'viminfo'* *'vi'* *E526* *E527* *E528*
6903'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6904 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6905 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6906 for others: '20,<50,s10,h)
6907 global
6908 {not in Vi}
6909 {not available when compiled without the |+viminfo|
6910 feature}
6911 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006912 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913 separated list of parameters, each consisting of a single character
6914 identifying the particular parameter, followed by a number or string
6915 which specifies the value of that parameter. If a particular
6916 character is left out, then the default value is used for that
6917 parameter. The following is a list of the identifying characters and
6918 the effect of their value.
6919 CHAR VALUE ~
6920 ! When included, save and restore global variables that start
6921 with an uppercase letter, and don't contain a lowercase
6922 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006923 and "_K_L_M" are not. Only String and Number types are
6924 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 " Maximum number of lines saved for each register. Old name of
6926 the '<' item, with the disadvantage that you need to put a
6927 backslash before the ", otherwise it will be recognized as the
6928 start of a comment!
6929 % When included, save and restore the buffer list. If Vim is
6930 started with a file name argument, the buffer list is not
6931 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006932 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 without a file name and buffers for help files are not written
6934 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006935 When followed by a number, the number specifies the maximum
6936 number of buffers that are stored. Without a number all
6937 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 ' Maximum number of previously edited files for which the marks
6939 are remembered. This parameter must always be included when
6940 'viminfo' is non-empty.
6941 Including this item also means that the |jumplist| and the
6942 |changelist| are stored in the viminfo file.
6943 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006944 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 patterns are also saved. When not included, the value of
6946 'history' is used.
6947 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006948 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 < Maximum number of lines saved for each register. If zero then
6950 registers are not saved. When not included, all lines are
6951 saved. '"' is the old name for this item.
6952 Also see the 's' item below: limit specified in Kbyte.
6953 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006954 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 c When included, convert the text in the viminfo file from the
6956 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006957 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006958 f Whether file marks need to be stored. If zero, file marks ('0
6959 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006960 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 cursor position (when exiting or when doing ":wviminfo").
6962 h Disable the effect of 'hlsearch' when loading the viminfo
6963 file. When not included, it depends on whether ":nohlsearch"
6964 has been used since the last search command.
6965 n Name of the viminfo file. The name must immediately follow
6966 the 'n'. Must be the last one! If the "-i" argument was
6967 given when starting Vim, that file name overrides the one
6968 given here with 'viminfo'. Environment variables are expanded
6969 when opening the file, not when setting the option.
6970 r Removable media. The argument is a string (up to the next
6971 ','). This parameter can be given several times. Each
6972 specifies the start of a path for which no marks will be
6973 stored. This is to avoid removable media. For MS-DOS you
6974 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6975 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6976 ignored. Maximum length of each 'r' argument is 50
6977 characters.
6978 s Maximum size of an item in Kbyte. If zero then registers are
6979 not saved. Currently only applies to registers. The default
6980 "s10" will exclude registers with more than 10 Kbyte of text.
6981 Also see the '<' item above: line count limit.
6982
6983 Example: >
6984 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6985<
6986 '50 Marks will be remembered for the last 50 files you
6987 edited.
6988 <1000 Contents of registers (up to 1000 lines each) will be
6989 remembered.
6990 s100 Registers with more than 100 Kbyte text are skipped.
6991 :0 Command-line history will not be saved.
6992 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6993 no / Since '/' is not specified, the default will be used,
6994 that is, save all of the search history, and also the
6995 previous search and substitute patterns.
6996 no % The buffer list will not be saved nor read back.
6997 no h 'hlsearch' highlighting will be restored.
6998
6999 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7000 load the contents of the file, this is not done automatically.
7001
7002 This option cannot be set from a |modeline| or in the |sandbox|, for
7003 security reasons.
7004
7005 *'virtualedit'* *'ve'*
7006'virtualedit' 've' string (default "")
7007 global
7008 {not in Vi}
7009 {not available when compiled without the
7010 |+virtualedit| feature}
7011 A comma separated list of these words:
7012 block Allow virtual editing in Visual block mode.
7013 insert Allow virtual editing in Insert mode.
7014 all Allow virtual editing in all modes.
7015 Virtual editing means that the cursor can be positioned where there is
7016 no actual character. This can be halfway into a Tab or beyond the end
7017 of the line. Useful for selecting a rectangle in Visual mode and
7018 editing a table.
7019
7020 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7021'visualbell' 'vb' boolean (default off)
7022 global
7023 {not in Vi}
7024 Use visual bell instead of beeping. The terminal code to display the
7025 visual bell is given with 't_vb'. When no beep or flash is wanted,
7026 use ":set vb t_vb=".
7027 Note: When the GUI starts, 't_vb' is reset to its default value. You
7028 might want to set it again in your |gvimrc|.
7029 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7030 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7031 where 40 is the time in msec.
7032 Does not work on the Amiga, you always get a screen flash.
7033 Also see 'errorbells'.
7034
7035 *'warn'* *'nowarn'*
7036'warn' boolean (default on)
7037 global
7038 Give a warning message when a shell command is used while the buffer
7039 has been changed.
7040
7041 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7042'weirdinvert' 'wiv' boolean (default off)
7043 global
7044 {not in Vi}
7045 This option has the same effect as the 't_xs' termcap option.
7046 It is provided for backwards compatibility with version 4.x.
7047 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7048 vice versa. Has no effect when the GUI is running.
7049
7050 *'whichwrap'* *'ww'*
7051'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7052 global
7053 {not in Vi}
7054 Allow specified keys that move the cursor left/right to move to the
7055 previous/next line when the cursor is on the first/last character in
7056 the line. Concatenate characters to allow this for these keys:
7057 char key mode ~
7058 b <BS> Normal and Visual
7059 s <Space> Normal and Visual
7060 h "h" Normal and Visual
7061 l "l" Normal and Visual
7062 < <Left> Normal and Visual
7063 > <Right> Normal and Visual
7064 ~ "~" Normal
7065 [ <Left> Insert and Replace
7066 ] <Right> Insert and Replace
7067 For example: >
7068 :set ww=<,>,[,]
7069< allows wrap only when cursor keys are used.
7070 When the movement keys are used in combination with a delete or change
7071 operator, the <EOL> also counts for a character. This makes "3h"
7072 different from "3dh" when the cursor crosses the end of a line. This
7073 is also true for "x" and "X", because they do the same as "dl" and
7074 "dh". If you use this, you may also want to use the mapping
7075 ":map <BS> X" to make backspace delete the character in front of the
7076 cursor.
7077 When 'l' is included, you get a side effect: "yl" on an empty line
7078 will include the <EOL>, so that "p" will insert a new line.
7079 NOTE: This option is set to the Vi default value when 'compatible' is
7080 set and to the Vim default value when 'compatible' is reset.
7081
7082 *'wildchar'* *'wc'*
7083'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7084 global
7085 {not in Vi}
7086 Character you have to type to start wildcard expansion in the
7087 command-line, as specified with 'wildmode'.
7088 The character is not recognized when used inside a macro. See
7089 'wildcharm' for that.
7090 Although 'wc' is a number option, you can set it to a special key: >
7091 :set wc=<Esc>
7092< NOTE: This option is set to the Vi default value when 'compatible' is
7093 set and to the Vim default value when 'compatible' is reset.
7094
7095 *'wildcharm'* *'wcm'*
7096'wildcharm' 'wcm' number (default: none (0))
7097 global
7098 {not in Vi}
7099 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007100 recognized when used inside a macro. You can find "spare" command-line
7101 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 you'll never actually type 'wildcharm', just use it in mappings that
7103 automatically invoke completion mode, e.g.: >
7104 :set wcm=<C-Z>
7105 :cmap ss so $vim/sessions/*.vim<C-Z>
7106< Then after typing :ss you can use CTRL-P & CTRL-N.
7107
7108 *'wildignore'* *'wig'*
7109'wildignore' 'wig' string (default "")
7110 global
7111 {not in Vi}
7112 {not available when compiled without the |+wildignore|
7113 feature}
7114 A list of file patterns. A file that matches with one of these
7115 patterns is ignored when completing file or directory names.
7116 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7117 Also see 'suffixes'.
7118 Example: >
7119 :set wildignore=*.o,*.obj
7120< The use of |:set+=| and |:set-=| is preferred when adding or removing
7121 a pattern from the list. This avoids problems when a future version
7122 uses another default.
7123
7124 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7125'wildmenu' 'wmnu' boolean (default off)
7126 global
7127 {not in Vi}
7128 {not available if compiled without the |+wildmenu|
7129 feature}
7130 When 'wildmenu' is on, command-line completion operates in an enhanced
7131 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7132 the possible matches are shown just above the command line, with the
7133 first match highlighted (overwriting the status line, if there is
7134 one). Keys that show the previous/next match, such as <Tab> or
7135 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7136 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7137 specified. "longest" and "list" do not start "wildmenu" mode.
7138 If there are more matches than can fit in the line, a ">" is shown on
7139 the right and/or a "<" is shown on the left. The status line scrolls
7140 as needed.
7141 The "wildmenu" mode is abandoned when a key is hit that is not used
7142 for selecting a completion.
7143 While the "wildmenu" is active the following keys have special
7144 meanings:
7145
7146 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7147 <Down> - in filename/menu name completion: move into a
7148 subdirectory or submenu.
7149 <CR> - in menu completion, when the cursor is just after a
7150 dot: move into a submenu.
7151 <Up> - in filename/menu name completion: move up into
7152 parent directory or parent menu.
7153
7154 This makes the menus accessible from the console |console-menus|.
7155
7156 If you prefer the <Left> and <Right> keys to move the cursor instead
7157 of selecting a different match, use this: >
7158 :cnoremap <Left> <Space><BS><Left>
7159 :cnoremap <Right> <Space><BS><Right>
7160<
7161 The "WildMenu" highlighting is used for displaying the current match
7162 |hl-WildMenu|.
7163
7164 *'wildmode'* *'wim'*
7165'wildmode' 'wim' string (Vim default: "full")
7166 global
7167 {not in Vi}
7168 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007169 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007170 part specifies what to do for each consecutive use of 'wildchar. The
7171 first part specifies the behavior for the first use of 'wildchar',
7172 The second part for the second use, etc.
7173 These are the possible values for each part:
7174 "" Complete only the first match.
7175 "full" Complete the next full match. After the last match,
7176 the original string is used and then the first match
7177 again.
7178 "longest" Complete till longest common string. If this doesn't
7179 result in a longer string, use the next part.
7180 "longest:full" Like "longest", but also start 'wildmenu' if it is
7181 enabled.
7182 "list" When more than one match, list all matches.
7183 "list:full" When more than one match, list all matches and
7184 complete first match.
7185 "list:longest" When more than one match, list all matches and
7186 complete till longest common string.
7187 When there is only a single match, it is fully completed in all cases.
7188
7189 Examples: >
7190 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007191< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 :set wildmode=longest,full
7193< Complete longest common string, then each full match >
7194 :set wildmode=list:full
7195< List all matches and complete each full match >
7196 :set wildmode=list,full
7197< List all matches without completing, then each full match >
7198 :set wildmode=longest,list
7199< Complete longest common string, then list alternatives.
7200
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007201 *'wildoptions'* *'wop'*
7202'wildoptions' 'wop' string (default "")
7203 global
7204 {not in Vi}
7205 {not available when compiled without the |+wildignore|
7206 feature}
7207 A list of words that change how command line completion is done.
7208 Currently only one word is allowed:
7209 tagfile When using CTRL-D to list matching tags, the kind of
7210 tag and the file of the tag is listed. Only one match
7211 is displayed per line. Often used tag kinds are:
7212 d #define
7213 f function
7214 Also see |cmdline-completion|.
7215
Bram Moolenaar071d4272004-06-13 20:20:40 +00007216 *'winaltkeys'* *'wak'*
7217'winaltkeys' 'wak' string (default "menu")
7218 global
7219 {not in Vi}
7220 {only used in Win32, Motif, GTK and Photon GUI}
7221 Some GUI versions allow the access to menu entries by using the ALT
7222 key in combination with a character that appears underlined in the
7223 menu. This conflicts with the use of the ALT key for mappings and
7224 entering special characters. This option tells what to do:
7225 no Don't use ALT keys for menus. ALT key combinations can be
7226 mapped, but there is no automatic handling. This can then be
7227 done with the |:simalt| command.
7228 yes ALT key handling is done by the windowing system. ALT key
7229 combinations cannot be mapped.
7230 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007231 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 keys can be mapped.
7233 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7234 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007235 This option is not used for <F10>; on Win32 and with GTK <F10> will
7236 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007238 *'window'* *'wi'*
7239'window' 'wi' number (default screen height - 1)
7240 global
7241 Window height. Do not confuse this with the height of the Vim window,
7242 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007243 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7244 value is smaller than 'lines' minus one. The screen will scroll
7245 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007246 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7247 in a much smarter way, taking care of wrapping lines.
7248 When resizing the Vim window, the value is smaller than 1 or more than
7249 or equal to 'lines' it will be set to 'lines' minus 1.
7250 {Vi also uses the option to specify the number of displayed lines}
7251
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 *'winheight'* *'wh'* *E591*
7253'winheight' 'wh' number (default 1)
7254 global
7255 {not in Vi}
7256 {not available when compiled without the +windows
7257 feature}
7258 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007259 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 current window is smaller, its size is increased, at the cost of the
7261 height of other windows. Set it to 999 to make the current window
7262 always fill the screen (although this has the drawback that ":all"
7263 will create only two windows). Set it to a small number for normal
7264 editing.
7265 Minimum value is 1.
7266 The height is not adjusted after one of the commands to change the
7267 height of the current window.
7268 'winheight' applies to the current window. Use 'winminheight' to set
7269 the minimal height for other windows.
7270
7271 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7272'winfixheight' 'wfh' boolean (default off)
7273 local to window
7274 {not in Vi}
7275 {not available when compiled without the +windows
7276 feature}
7277 Keep the window height when windows are opened or closed and
7278 'equalalways' is set. Set by default for the |preview-window| and
7279 |quickfix-window|.
7280 The height may be changed anyway when running out of room.
7281
7282 *'winminheight'* *'wmh'*
7283'winminheight' 'wmh' number (default 1)
7284 global
7285 {not in Vi}
7286 {not available when compiled without the +windows
7287 feature}
7288 The minimal height of a window, when it's not the current window.
7289 This is a hard minimum, windows will never become smaller.
7290 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7291 status bar) if necessary. They will return to at least one line when
7292 they become active (since the cursor has to have somewhere to go.)
7293 Use 'winheight' to set the minimal height of the current window.
7294 This option is only checked when making a window smaller. Don't use a
7295 large number, it will cause errors when opening more than a few
7296 windows. A value of 0 to 3 is reasonable.
7297
7298 *'winminwidth'* *'wmw'*
7299'winminwidth' 'wmw' number (default 1)
7300 global
7301 {not in Vi}
7302 {not available when compiled without the +vertsplit
7303 feature}
7304 The minimal width of a window, when it's not the current window.
7305 This is a hard minimum, windows will never become smaller.
7306 When set to zero, windows may be "squashed" to zero columns (i.e. just
7307 a vertical separator) if necessary. They will return to at least one
7308 line when they become active (since the cursor has to have somewhere
7309 to go.)
7310 Use 'winwidth' to set the minimal width of the current window.
7311 This option is only checked when making a window smaller. Don't use a
7312 large number, it will cause errors when opening more than a few
7313 windows. A value of 0 to 12 is reasonable.
7314
7315 *'winwidth'* *'wiw'* *E592*
7316'winwidth' 'wiw' number (default 20)
7317 global
7318 {not in Vi}
7319 {not available when compiled without the +vertsplit
7320 feature}
7321 Minimal number of columns for the current window. This is not a hard
7322 minimum, Vim will use fewer columns if there is not enough room. If
7323 the current window is smaller, its size is increased, at the cost of
7324 the width of other windows. Set it to 999 to make the current window
7325 always fill the screen. Set it to a small number for normal editing.
7326 The width is not adjusted after one of the commands to change the
7327 width of the current window.
7328 'winwidth' applies to the current window. Use 'winminwidth' to set
7329 the minimal width for other windows.
7330
7331 *'wrap'* *'nowrap'*
7332'wrap' boolean (default on)
7333 local to window
7334 {not in Vi}
7335 This option changes how text is displayed. It doesn't change the text
7336 in the buffer, see 'textwidth' for that.
7337 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007338 displaying continues on the next line. When off lines will not wrap
7339 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 moved to a part that is not shown, the screen will scroll
7341 horizontally.
7342 The line will be broken in the middle of a word if necessary. See
7343 'linebreak' to get the break at a word boundary.
7344 To make scrolling horizontally a bit more useful, try this: >
7345 :set sidescroll=5
7346 :set listchars+=precedes:<,extends:>
7347< See 'sidescroll', 'listchars' and |wrap-off|.
7348
7349 *'wrapmargin'* *'wm'*
7350'wrapmargin' 'wm' number (default 0)
7351 local to buffer
7352 Number of characters from the right window border where wrapping
7353 starts. When typing text beyond this limit, an <EOL> will be inserted
7354 and inserting continues on the next line.
7355 Options that add a margin, such as 'number' and 'foldcolumn', cause
7356 the text width to be further reduced. This is Vi compatible.
7357 When 'textwidth' is non-zero, this option is not used.
7358 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7359 and less usefully}
7360
7361 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7362'wrapscan' 'ws' boolean (default on) *E384* *E385*
7363 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007364 Searches wrap around the end of the file. Also applies to |]s| and
7365 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366
7367 *'write'* *'nowrite'*
7368'write' boolean (default on)
7369 global
7370 {not in Vi}
7371 Allows writing files. When not set, writing a file is not allowed.
7372 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007373 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 argument. Filtering text is still possible, even though this requires
7375 writing a temporary file.
7376
7377 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7378'writeany' 'wa' boolean (default off)
7379 global
7380 Allows writing to any file with no need for "!" override.
7381
7382 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7383'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7384 otherwise)
7385 global
7386 {not in Vi}
7387 Make a backup before overwriting a file. The backup is removed after
7388 the file was successfully written, unless the 'backup' option is
7389 also on. Reset this option if your file system is almost full. See
7390 |backup-table| for another explanation.
7391 When the 'backupskip' pattern matches, a backup is not made anyway.
7392 NOTE: This option is set to the default value when 'compatible' is
7393 set.
7394
7395 *'writedelay'* *'wd'*
7396'writedelay' 'wd' number (default 0)
7397 global
7398 {not in Vi}
7399 The number of microseconds to wait for each character sent to the
7400 screen. When non-zero, characters are sent to the terminal one by
7401 one. For MS-DOS pcterm this does not work. For debugging purposes.
7402
7403 vim:tw=78:ts=8:ft=help:norl: