blob: 2a812fe40b709021de7bfa53439728a510ce15d7 [file] [log] [blame]
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001*options.txt* For Vim version 7.0aa. Last change: 2006 Jan 20
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 Moolenaarb71eaae2006-01-20 23:10:18 +00001040 The expression may be evaluated in the |sandbox|, see
1041 |sandbox-option|.
1042
1043 It is not allowed to change text or jump to another window while
1044 evaluating 'balloonexpr' |textlock|.
1045
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001046 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001047 if has("balloon_multiline")
1048<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001049 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1050'binary' 'bin' boolean (default off)
1051 local to buffer
1052 {not in Vi}
1053 This option should be set before editing a binary file. You can also
1054 use the |-b| Vim argument. When this option is switched on a few
1055 options will be changed (also when it already was on):
1056 'textwidth' will be set to 0
1057 'wrapmargin' will be set to 0
1058 'modeline' will be off
1059 'expandtab' will be off
1060 Also, 'fileformat' and 'fileformats' options will not be used, the
1061 file is read and written like 'fileformat' was "unix" (a single <NL>
1062 separates lines).
1063 The 'fileencoding' and 'fileencodings' options will not be used, the
1064 file is read without conversion.
1065 NOTE: When you start editing a(nother) file while the 'bin' option is
1066 on, settings from autocommands may change the settings again (e.g.,
1067 'textwidth'), causing trouble when editing. You might want to set
1068 'bin' again when the file has been loaded.
1069 The previous values of these options are remembered and restored when
1070 'bin' is switched from on to off. Each buffer has its own set of
1071 saved option values.
1072 To edit a file with 'binary' set you can use the |++bin| argument.
1073 This avoids you have to do ":set bin", which would have effect for all
1074 files you edit.
1075 When writing a file the <EOL> for the last line is only written if
1076 there was one in the original file (normally Vim appends an <EOL> to
1077 the last line if there is none; this would make the file longer). See
1078 the 'endofline' option.
1079
1080 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1081'bioskey' 'biosk' boolean (default on)
1082 global
1083 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001084 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085 better to detect CTRL-C, but only works for the console. When using a
1086 terminal over a serial port reset this option.
1087 Also see |'conskey'|.
1088
1089 *'bomb'* *'nobomb'*
1090'bomb' boolean (default off)
1091 local to buffer
1092 {not in Vi}
1093 {only available when compiled with the |+multi_byte|
1094 feature}
1095 When writing a file and the following conditions are met, a BOM (Byte
1096 Order Mark) is prepended to the file:
1097 - this option is on
1098 - the 'binary' option is off
1099 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1100 endian variants.
1101 Some applications use the BOM to recognize the encoding of the file.
1102 Often used for UCS-2 files on MS-Windows. For other applications it
1103 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1104 appear halfway the resulting file.
1105 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1106 check for the presence of the BOM is done and 'bomb' set accordingly.
1107 Unless 'binary' is set, it is removed from the first line, so that you
1108 don't see it when editing. When you don't change the options, the BOM
1109 will be restored when writing the file.
1110
1111 *'breakat'* *'brk'*
1112'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1113 global
1114 {not in Vi}
1115 {not available when compiled without the |+linebreak|
1116 feature}
1117 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001118 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1119 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
1121 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001122'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001123 global
1124 {not in Vi} {only for Motif and Win32 GUI}
1125 Which directory to use for the file browser:
1126 last Use same directory as with last file browser.
1127 buffer Use the directory of the related buffer.
1128 current Use the current directory.
1129 {path} Use the specified directory
1130
1131 *'bufhidden'* *'bh'*
1132'bufhidden' 'bh' string (default: "")
1133 local to buffer
1134 {not in Vi}
1135 {not available when compiled without the |+quickfix|
1136 feature}
1137 This option specifies what happens when a buffer is no longer
1138 displayed in a window:
1139 <empty> follow the global 'hidden' option
1140 hide hide the buffer (don't unload it), also when 'hidden'
1141 is not set
1142 unload unload the buffer, also when 'hidden' is set or using
1143 |:hide|
1144 delete delete the buffer from the buffer list, also when
1145 'hidden' is set or using |:hide|, like using
1146 |:bdelete|
1147 wipe wipe out the buffer from the buffer list, also when
1148 'hidden' is set or using |:hide|, like using
1149 |:bwipeout|
1150
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001151 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1152 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001153 This option is used together with 'buftype' and 'swapfile' to specify
1154 special kinds of buffers. See |special-buffers|.
1155
1156 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1157'buflisted' 'bl' boolean (default: on)
1158 local to buffer
1159 {not in Vi}
1160 When this option is set, the buffer shows up in the buffer list. If
1161 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1162 This option is reset by Vim for buffers that are only used to remember
1163 a file name or marks. Vim sets it when starting to edit a buffer.
1164 But not when moving to a buffer with ":buffer".
1165
1166 *'buftype'* *'bt'* *E382*
1167'buftype' 'bt' string (default: "")
1168 local to buffer
1169 {not in Vi}
1170 {not available when compiled without the |+quickfix|
1171 feature}
1172 The value of this option specifies the type of a buffer:
1173 <empty> normal buffer
1174 nofile buffer which is not related to a file and will not be
1175 written
1176 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001177 acwrite buffer which will always be written with BufWriteCmd
1178 autocommands. {not available when compiled without the
1179 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 quickfix quickfix buffer, contains list of errors |:cwindow|
1181 help help buffer (you are not supposed to set this
1182 manually)
1183
1184 This option is used together with 'bufhidden' and 'swapfile' to
1185 specify special kinds of buffers. See |special-buffers|.
1186
1187 Be careful with changing this option, it can have many side effects!
1188
1189 A "quickfix" buffer is only used for the error list. This value is
1190 set by the |:cwindow| command and you are not supposed to change it.
1191
1192 "nofile" and "nowrite" buffers are similar:
1193 both: The buffer is not to be written to disk, ":w" doesn't
1194 work (":w filename" does work though).
1195 both: The buffer is never considered to be |'modified'|.
1196 There is no warning when the changes will be lost, for
1197 example when you quit Vim.
1198 both: A swap file is only created when using too much memory
1199 (when 'swapfile' has been reset there is never a swap
1200 file).
1201 nofile only: The buffer name is fixed, it is not handled like a
1202 file name. It is not modified in response to a |:cd|
1203 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001204 *E676*
1205 "acwrite" implies that the buffer name is not related to a file, like
1206 "nofile", but it will be written. Thus, in contrast to "nofile" and
1207 "nowrite", ":w" does work and a modified buffer can't be abandoned
1208 without saving. For writing there must be matching |BufWriteCmd|,
1209 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210
1211 *'casemap'* *'cmp'*
1212'casemap' 'cmp' string (default: "internal,keepascii")
1213 global
1214 {not in Vi}
1215 Specifies details about changing the case of letters. It may contain
1216 these words, separated by a comma:
1217 internal Use internal case mapping functions, the current
1218 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001219 matters when 'encoding' is a Unicode encoding,
1220 "latin1" or "iso-8859-15". When "internal" is
1221 omitted, the towupper() and towlower() system library
1222 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001223 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1224 case mapping, the current locale is not effective.
1225 This probably only matters for Turkish.
1226
1227 *'cdpath'* *'cd'* *E344* *E346*
1228'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1229 global
1230 {not in Vi}
1231 {not available when compiled without the
1232 |+file_in_path| feature}
1233 This is a list of directories which will be searched when using the
1234 |:cd| and |:lcd| commands, provided that the directory being searched
1235 for has a relative path (not starting with "/", "./" or "../").
1236 The 'cdpath' option's value has the same form and semantics as
1237 |'path'|. Also see |file-searching|.
1238 The default value is taken from $CDPATH, with a "," prepended to look
1239 in the current directory first.
1240 If the default value taken from $CDPATH is not what you want, include
1241 a modified version of the following command in your vimrc file to
1242 override it: >
1243 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1244< This option cannot be set from a |modeline| or in the |sandbox|, for
1245 security reasons.
1246 (parts of 'cdpath' can be passed to the shell to expand file names).
1247
1248 *'cedit'*
1249'cedit' string (Vi default: "", Vim default: CTRL-F)
1250 global
1251 {not in Vi}
1252 {not available when compiled without the |+vertsplit|
1253 feature}
1254 The key used in Command-line Mode to open the command-line window.
1255 The default is CTRL-F when 'compatible' is off.
1256 Only non-printable keys are allowed.
1257 The key can be specified as a single character, but it is difficult to
1258 type. The preferred way is to use the <> notation. Examples: >
1259 :set cedit=<C-Y>
1260 :set cedit=<Esc>
1261< |Nvi| also has this option, but it only uses the first character.
1262 See |cmdwin|.
1263
1264 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1265'charconvert' 'ccv' string (default "")
1266 global
1267 {only available when compiled with the |+multi_byte|
1268 feature and the |+eval| feature}
1269 {not in Vi}
1270 An expression that is used for character encoding conversion. It is
1271 evaluated when a file that is to be read or has been written has a
1272 different encoding from what is desired.
1273 'charconvert' is not used when the internal iconv() function is
1274 supported and is able to do the conversion. Using iconv() is
1275 preferred, because it is much faster.
1276 'charconvert' is not used when reading stdin |--|, because there is no
1277 file to convert from. You will have to save the text in a file first.
1278 The expression must return zero or an empty string for success,
1279 non-zero for failure.
1280 The possible encoding names encountered are in 'encoding'.
1281 Additionally, names given in 'fileencodings' and 'fileencoding' are
1282 used.
1283 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1284 is done internally by Vim, 'charconvert' is not used for this.
1285 'charconvert' is also used to convert the viminfo file, if the 'c'
1286 flag is present in 'viminfo'. Also used for Unicode conversion.
1287 Example: >
1288 set charconvert=CharConvert()
1289 fun CharConvert()
1290 system("recode "
1291 \ . v:charconvert_from . ".." . v:charconvert_to
1292 \ . " <" . v:fname_in . " >" v:fname_out)
1293 return v:shell_error
1294 endfun
1295< The related Vim variables are:
1296 v:charconvert_from name of the current encoding
1297 v:charconvert_to name of the desired encoding
1298 v:fname_in name of the input file
1299 v:fname_out name of the output file
1300 Note that v:fname_in and v:fname_out will never be the same.
1301 Note that v:charconvert_from and v:charconvert_to may be different
1302 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1303 Encryption is not done by Vim when using 'charconvert'. If you want
1304 to encrypt the file after conversion, 'charconvert' should take care
1305 of this.
1306 This option cannot be set from a |modeline| or in the |sandbox|, for
1307 security reasons.
1308
1309 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1310'cindent' 'cin' boolean (default off)
1311 local to buffer
1312 {not in Vi}
1313 {not available when compiled without the |+cindent|
1314 feature}
1315 Enables automatic C program indenting See 'cinkeys' to set the keys
1316 that trigger reindenting in insert mode and 'cinoptions' to set your
1317 preferred indent style.
1318 If 'indentexpr' is not empty, it overrules 'cindent'.
1319 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1320 the "=" operator indents using this algorithm rather than calling an
1321 external program.
1322 See |C-indenting|.
1323 When you don't like the way 'cindent' works, try the 'smartindent'
1324 option or 'indentexpr'.
1325 This option is not used when 'paste' is set.
1326 NOTE: This option is reset when 'compatible' is set.
1327
1328 *'cinkeys'* *'cink'*
1329'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1330 local to buffer
1331 {not in Vi}
1332 {not available when compiled without the |+cindent|
1333 feature}
1334 A list of keys that, when typed in Insert mode, cause reindenting of
1335 the current line. Only used if 'cindent' is on and 'indentexpr' is
1336 empty.
1337 For the format of this option see |cinkeys-format|.
1338 See |C-indenting|.
1339
1340 *'cinoptions'* *'cino'*
1341'cinoptions' 'cino' string (default "")
1342 local to buffer
1343 {not in Vi}
1344 {not available when compiled without the |+cindent|
1345 feature}
1346 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1347 program. See |cinoptions-values| for the values of this option, and
1348 |C-indenting| for info on C indenting in general.
1349
1350
1351 *'cinwords'* *'cinw'*
1352'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1353 local to buffer
1354 {not in Vi}
1355 {not available when compiled without both the
1356 |+cindent| and the |+smartindent| features}
1357 These keywords start an extra indent in the next line when
1358 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1359 an appropriate place (inside {}).
1360 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1361 matter, include the keyword both the uppercase and lowercase:
1362 "if,If,IF".
1363
1364 *'clipboard'* *'cb'*
1365'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1366 for X-windows, "" otherwise)
1367 global
1368 {not in Vi}
1369 {only in GUI versions or when the |+xterm_clipboard|
1370 feature is included}
1371 This option is a list of comma separated names.
1372 These names are recognized:
1373
1374 unnamed When included, Vim will use the clipboard register '*'
1375 for all yank, delete, change and put operations which
1376 would normally go to the unnamed register. When a
1377 register is explicitly specified, it will always be
1378 used regardless of whether "unnamed" is in 'clipboard'
1379 or not. The clipboard register can always be
1380 explicitly accessed using the "* notation. Also see
1381 |gui-clipboard|.
1382
1383 autoselect Works like the 'a' flag in 'guioptions': If present,
1384 then whenever Visual mode is started, or the Visual
1385 area extended, Vim tries to become the owner of the
1386 windowing system's global selection or put the
1387 selected text on the clipboard used by the selection
1388 register "*. See |guioptions_a| and |quotestar| for
1389 details. When the GUI is active, the 'a' flag in
1390 'guioptions' is used, when the GUI is not active, this
1391 "autoselect" flag is used.
1392 Also applies to the modeless selection.
1393
1394 autoselectml Like "autoselect", but for the modeless selection
1395 only. Compare to the 'A' flag in 'guioptions'.
1396
1397 exclude:{pattern}
1398 Defines a pattern that is matched against the name of
1399 the terminal 'term'. If there is a match, no
1400 connection will be made to the X server. This is
1401 useful in this situation:
1402 - Running Vim in a console.
1403 - $DISPLAY is set to start applications on another
1404 display.
1405 - You do not want to connect to the X server in the
1406 console, but do want this in a terminal emulator.
1407 To never connect to the X server use: >
1408 exclude:.*
1409< This has the same effect as using the |-X| argument.
1410 Note that when there is no connection to the X server
1411 the window title won't be restored and the clipboard
1412 cannot be accessed.
1413 The value of 'magic' is ignored, {pattern} is
1414 interpreted as if 'magic' was on.
1415 The rest of the option value will be used for
1416 {pattern}, this must be the last entry.
1417
1418 *'cmdheight'* *'ch'*
1419'cmdheight' 'ch' number (default 1)
1420 global
1421 {not in Vi}
1422 Number of screen lines to use for the command-line. Helps avoiding
1423 |hit-enter| prompts.
1424
1425 *'cmdwinheight'* *'cwh'*
1426'cmdwinheight' 'cwh' number (default 7)
1427 global
1428 {not in Vi}
1429 {not available when compiled without the |+vertsplit|
1430 feature}
1431 Number of screen lines to use for the command-line window. |cmdwin|
1432
1433 *'columns'* *'co'* *E594*
1434'columns' 'co' number (default 80 or terminal width)
1435 global
1436 {not in Vi}
1437 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001438 initialization and does not have to be set by hand. Also see
1439 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001440 When Vim is running in the GUI or in a resizable window, setting this
1441 option will cause the window size to be changed. When you only want
1442 to use the size for the GUI, put the command in your |gvimrc| file.
1443 When you set this option and Vim is unable to change the physical
1444 number of columns of the display, the display may be messed up.
Bram Moolenaarf4d11452005-12-02 00:46:37 +00001445 Mimimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446
1447 *'comments'* *'com'* *E524* *E525*
1448'comments' 'com' string (default
1449 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1450 local to buffer
1451 {not in Vi}
1452 {not available when compiled without the |+comments|
1453 feature}
1454 A comma separated list of strings that can start a comment line. See
1455 |format-comments|. See |option-backslash| about using backslashes to
1456 insert a space.
1457
1458 *'commentstring'* *'cms'* *E537*
1459'commentstring' 'cms' string (default "/*%s*/")
1460 local to buffer
1461 {not in Vi}
1462 {not available when compiled without the |+folding|
1463 feature}
1464 A template for a comment. The "%s" in the value is replaced with the
1465 comment text. Currently only used to add markers for folding, see
1466 |fold-marker|.
1467
1468 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001469'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1470 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 global
1472 {not in Vi}
1473 This option has the effect of making Vim either more Vi-compatible, or
1474 make Vim behave in a more useful way.
1475 This is a special kind of option, because when it's set or reset,
1476 other options are also changed as a side effect. CAREFUL: Setting or
1477 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001478 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 set this option in your vimrc file, you should probably put it at the
1480 very start.
1481 By default this option is on and the Vi defaults are used for the
1482 options. This default was chosen for those people who want to use Vim
1483 just like Vi, and don't even (want to) know about the 'compatible'
1484 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001485 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1486 this option is switched off, and all options that have not been
1487 modified will be set to the Vim defaults. Effectively, this means
1488 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1489 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1490 happen for the system-wide vimrc or gvimrc file). Also see
1491 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 You can also set this option with the "-C" argument, and reset it with
1493 "-N". See |-C| and |-N|.
1494 Switching this option off makes the Vim defaults be used for options
1495 that have a different Vi and Vim default value. See the options
1496 marked with a '+' below. Other options are not modified.
1497 At the moment this option is set, several other options will be set
1498 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001499 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 editing.
1501 See also 'cpoptions'.
1502
1503 option + set value effect ~
1504
1505 'allowrevins' off no CTRL-_ command
1506 'backupcopy' Unix: "yes" backup file is a copy
1507 others: "auto" copy or rename backup file
1508 'backspace' "" normal backspace
1509 'backup' off no backup file
1510 'cindent' off no C code indentation
1511 'cedit' + "" no key to open the |cmdwin|
1512 'cpoptions' + (all flags) Vi-compatible flags
1513 'cscopetag' off don't use cscope for ":tag"
1514 'cscopetagorder' 0 see |cscopetagorder|
1515 'cscopeverbose' off see |cscopeverbose|
1516 'digraph' off no digraphs
1517 'esckeys' + off no <Esc>-keys in Insert mode
1518 'expandtab' off tabs not expanded to spaces
1519 'fileformats' + "" no automatic file format detection,
1520 "dos,unix" except for DOS, Windows and OS/2
1521 'formatoptions' + "vt" Vi compatible formatting
1522 'gdefault' off no default 'g' flag for ":s"
1523 'history' + 0 no commandline history
1524 'hkmap' off no Hebrew keyboard mapping
1525 'hkmapp' off no phonetic Hebrew keyboard mapping
1526 'hlsearch' off no highlighting of search matches
1527 'incsearch' off no incremental searching
1528 'indentexpr' "" no indenting by expression
1529 'insertmode' off do not start in Insert mode
1530 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1531 characters and '_'
1532 'joinspaces' on insert 2 spaces after period
1533 'modeline' + off no modelines
1534 'more' + off no pauses in listings
1535 'revins' off no reverse insert
1536 'ruler' off no ruler
1537 'scrolljump' 1 no jump scroll
1538 'scrolloff' 0 no scroll offset
1539 'shiftround' off indent not rounded to shiftwidth
1540 'shortmess' + "" no shortening of messages
1541 'showcmd' + off command characters not shown
1542 'showmode' + off current mode not shown
1543 'smartcase' off no automatic ignore case switch
1544 'smartindent' off no smart indentation
1545 'smarttab' off no smart tab size
1546 'softtabstop' 0 tabs are always 'tabstop' positions
1547 'startofline' on goto startofline with some commands
1548 'tagrelative' + off tag file names are not relative
1549 'textauto' + off no automatic textmode detection
1550 'textwidth' 0 no automatic line wrap
1551 'tildeop' off tilde is not an operator
1552 'ttimeout' off no terminal timeout
1553 'whichwrap' + "" left-right movements don't wrap
1554 'wildchar' + CTRL-E only when the current value is <Tab>
1555 use CTRL-E for cmdline completion
1556 'writebackup' on or off depends on +writebackup feature
1557
1558 *'complete'* *'cpt'* *E535*
1559'complete' 'cpt' string (default: ".,w,b,u,t,i")
1560 local to buffer
1561 {not in Vi}
1562 This option specifies how keyword completion |ins-completion| works
1563 when CTRL-P or CTRL-N are used. It is also used for whole-line
1564 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1565 and the places to scan. It is a comma separated list of flags:
1566 . scan the current buffer ('wrapscan' is ignored)
1567 w scan buffers from other windows
1568 b scan other loaded buffers that are in the buffer list
1569 u scan the unloaded buffers that are in the buffer list
1570 U scan the buffers that are not in the buffer list
1571 k scan the files given with the 'dictionary' option
1572 k{dict} scan the file {dict}. Several "k" flags can be given,
1573 patterns are valid too. For example: >
1574 :set cpt=k/usr/dict/*,k~/spanish
1575< s scan the files given with the 'thesaurus' option
1576 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1577 are valid too.
1578 i scan current and included files
1579 d scan current and included files for defined name or macro
1580 |i_CTRL-X_CTRL-D|
1581 ] tag completion
1582 t same as "]"
1583
1584 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1585 not executed, this may lead to unexpected completions from some files
1586 (gzipped files for example). Unloaded buffers are not scanned for
1587 whole-line completion.
1588
1589 The default is ".,w,b,u,t,i", which means to scan:
1590 1. the current buffer
1591 2. buffers in other windows
1592 3. other loaded buffers
1593 4. unloaded buffers
1594 5. tags
1595 6. included files
1596
1597 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001598 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1599 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001601 *'completefunc'* *'cfu'*
1602'completefunc' 'cfu' string (default: empty)
1603 local to buffer
1604 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001605 {not available when compiled without the +eval
1606 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001607 This option specifies a function to be used for Insert mode completion
1608 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001609
Bram Moolenaare344bea2005-09-01 20:46:49 +00001610 The function will be invoked with two arguments. First the function
1611 is called to find the start of the text to be completed. Secondly the
1612 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001613
Bram Moolenaare344bea2005-09-01 20:46:49 +00001614 On the first invocation the arguments are:
1615 a:findstart 1
1616 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001617
Bram Moolenaare344bea2005-09-01 20:46:49 +00001618 The function must return the column of where the completion starts.
1619 It must be a number between zero and the cursor column "col('.')".
1620 This involves looking at the characters just before the cursor and
1621 including those characters that could be part of the completed item.
1622 The text between this column and the cursor column will be replaced
1623 with the matches. Return -1 if no completion can be done.
1624
1625 On the second invocation the arguments are:
1626 a:findstart 0
1627 a:base the text with which matches should match, what was
Bram Moolenaard5cdbeb2005-10-10 20:59:28 +00001628 located in the first call (can be empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00001629
1630 The function must return a List with the matching words. These
1631 matches usually include the "a:base" text. When there are no matches
1632 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001633
Bram Moolenaar572cb562005-08-05 21:35:02 +00001634 When searching for matches takes some time call |complete_add()| to
1635 add each match to the total list. These matches should then not
1636 appear in the returned list! Call |complete_check()| now and then to
1637 allow the user to press a key while still searching for matches. Stop
1638 searching when it returns non-zero.
1639
Bram Moolenaare344bea2005-09-01 20:46:49 +00001640 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001641 This option cannot be set from a |modeline| or in the |sandbox|, for
1642 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001643
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001644 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001645 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001646 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001647 " locate the start of the word
1648 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001649 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001650 while start > 0 && line[start - 1] =~ '\a'
1651 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001652 endwhile
1653 return start
1654 else
1655 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001656 let res = []
1657 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1658 if m =~ '^' . a:base
1659 call add(res, m)
1660 endif
1661 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001662 return res
1663 endif
1664 endfun
1665 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001666<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001667 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001668 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001669 if a:findstart
1670 " locate the start of the word
1671 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001672 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001673 while start > 0 && line[start - 1] =~ '\a'
1674 let start -= 1
1675 endwhile
1676 return start
1677 else
1678 " find months matching with "a:base"
1679 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1680 if m =~ '^' . a:base
1681 call complete_add(m)
1682 endif
1683 sleep 300m " simulate searching for next match
1684 if complete_check()
1685 break
1686 endif
1687 endfor
1688 return []
1689 endif
1690 endfun
1691 set completefunc=CompleteMonths
1692<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001693
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001694 *'completeopt'* *'cot'*
1695'completeopt' 'cot' string (default: "menu")
1696 global
1697 {not in Vi}
1698 Options for Insert mode completion |ins-completion|.
1699 Currently the only supported value is:
1700
1701 menu Use a popup menu to show the possible completions. The
1702 menu is only shown when there is more than one match and
1703 sufficient colors are available. |ins-completion-menu|
1704
1705
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1707'confirm' 'cf' boolean (default off)
1708 global
1709 {not in Vi}
1710 When 'confirm' is on, certain operations that would normally
1711 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1712 instead raise a |dialog| asking if you wish to save the current
1713 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1714 If 'confirm' is off you can still activate confirmation for one
1715 command only (this is most useful in mappings) with the |:confirm|
1716 command.
1717 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1718
1719 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1720'conskey' 'consk' boolean (default off)
1721 global
1722 {not in Vi} {only for MS-DOS}
1723 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001724 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725 three methods of console input are available:
1726 'conskey' 'bioskey' action ~
1727 on on or off direct console input
1728 off on BIOS
1729 off off STDIN
1730
1731 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1732'copyindent' 'ci' boolean (default off)
1733 local to buffer
1734 {not in Vi}
1735 Copy the structure of the existing lines indent when autoindenting a
1736 new line. Normally the new indent is reconstructed by a series of
1737 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1738 in which case only spaces are used). Enabling this option makes the
1739 new line copy whatever characters were used for indenting on the
1740 existing line. If the new indent is greater than on the existing
1741 line, the remaining space is filled in the normal manner.
1742 NOTE: 'copyindent' is reset when 'compatible' is set.
1743 Also see 'preserveindent'.
1744
1745 *'cpoptions'* *'cpo'*
1746'cpoptions' 'cpo' string (Vim default: "aABceFs",
1747 Vi default: all flags)
1748 global
1749 {not in Vi}
1750 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001751 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 not being vi-compatible is mostly or sometimes preferred.
1753 'cpoptions' stands for "compatible-options".
1754 Commas can be added for readability.
1755 To avoid problems with flags that are added in the future, use the
1756 "+=" and "-=" feature of ":set" |add-option-flags|.
1757 NOTE: This option is set to the Vi default value when 'compatible' is
1758 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001759 NOTE: This option is set to the POSIX default value at startup when
1760 the Vi default value would be used and the $VIM_POSIX environment
1761 variable exists |posix|. This means tries to behave like the POSIX
1762 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763
1764 contains behavior ~
1765 *cpo-a*
1766 a When included, a ":read" command with a file name
1767 argument will set the alternate file name for the
1768 current window.
1769 *cpo-A*
1770 A When included, a ":write" command with a file name
1771 argument will set the alternate file name for the
1772 current window.
1773 *cpo-b*
1774 b "\|" in a ":map" command is recognized as the end of
1775 the map command. The '\' is included in the mapping,
1776 the text after the '|' is interpreted as the next
1777 command. Use a CTRL-V instead of a backslash to
1778 include the '|' in the mapping. Applies to all
1779 mapping, abbreviation, menu and autocmd commands.
1780 See also |map_bar|.
1781 *cpo-B*
1782 B A backslash has no special meaning in mappings,
1783 abbreviations and the "to" part of the menu commands.
1784 Remove this flag to be able to use a backslash like a
1785 CTRL-V. For example, the command ":map X \<Esc>"
1786 results in X being mapped to:
1787 'B' included: "\^[" (^[ is a real <Esc>)
1788 'B' excluded: "<Esc>" (5 characters)
1789 ('<' excluded in both cases)
1790 *cpo-c*
1791 c Searching continues at the end of any match at the
1792 cursor position, but not further than the start of the
1793 next line. When not present searching continues
1794 one character from the cursor position. With 'c'
1795 "abababababab" only gets three matches when repeating
1796 "/abab", without 'c' there are five matches.
1797 *cpo-C*
1798 C Do not concatenate sourced lines that start with a
1799 backslash. See |line-continuation|.
1800 *cpo-d*
1801 d Using "./" in the 'tags' option doesn't mean to use
1802 the tags file relative to the current file, but the
1803 tags file in the current directory.
1804 *cpo-D*
1805 D Can't use CTRL-K to enter a digraph after Normal mode
1806 commands with a character argument, like |r|, |f| and
1807 |t|.
1808 *cpo-e*
1809 e When executing a register with ":@r", always add a
1810 <CR> to the last line, also when the register is not
1811 linewise. If this flag is not present, the register
1812 is not linewise and the last line does not end in a
1813 <CR>, then the last line is put on the command-line
1814 and can be edited before hitting <CR>.
1815 *cpo-E*
1816 E It is an error when using "y", "d", "c", "g~", "gu" or
1817 "gU" on an Empty region. The operators only work when
1818 at least one character is to be operate on. Example:
1819 This makes "y0" fail in the first column.
1820 *cpo-f*
1821 f When included, a ":read" command with a file name
1822 argument will set the file name for the current buffer,
1823 if the current buffer doesn't have a file name yet.
1824 *cpo-F*
1825 F When included, a ":write" command with a file name
1826 argument will set the file name for the current
1827 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001828 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 *cpo-g*
1830 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001831 *cpo-H*
1832 H When using "I" on a line with only blanks, insert
1833 before the last blank. Without this flag insert after
1834 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 *cpo-i*
1836 i When included, interrupting the reading of a file will
1837 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001838 *cpo-I*
1839 I When moving the cursor up or down just after inserting
1840 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 *cpo-j*
1842 j When joining lines, only add two spaces after a '.',
1843 not after '!' or '?'. Also see 'joinspaces'.
1844 *cpo-J*
1845 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001846 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 white space.
1848 *cpo-k*
1849 k Disable the recognition of raw key codes in
1850 mappings, abbreviations, and the "to" part of menu
1851 commands. For example, if <Key> sends ^[OA (where ^[
1852 is <Esc>), the command ":map X ^[OA" results in X
1853 being mapped to:
1854 'k' included: "^[OA" (3 characters)
1855 'k' excluded: "<Key>" (one key code)
1856 Also see the '<' flag below.
1857 *cpo-K*
1858 K Don't wait for a key code to complete when it is
1859 halfway a mapping. This breaks mapping <F1><F1> when
1860 only part of the second <F1> has been read. It
1861 enables cancelling the mapping by typing <F1><Esc>.
1862 *cpo-l*
1863 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001864 literally, only "\]", "\^", "\-" and "\\" are special.
1865 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1867 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001868 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 *cpo-L*
1870 L When the 'list' option is set, 'wrapmargin',
1871 'textwidth', 'softtabstop' and Virtual Replace mode
1872 (see |gR|) count a <Tab> as two characters, instead of
1873 the normal behavior of a <Tab>.
1874 *cpo-m*
1875 m When included, a showmatch will always wait half a
1876 second. When not included, a showmatch will wait half
1877 a second or until a character is typed. |'showmatch'|
1878 *cpo-M*
1879 M When excluded, "%" matching will take backslashes into
1880 account. Thus in "( \( )" and "\( ( \)" the outer
1881 parenthesis match. When included "%" ignores
1882 backslashes, which is Vi compatible.
1883 *cpo-n*
1884 n When included, the column used for 'number' will also
1885 be used for text of wrapped lines.
1886 *cpo-o*
1887 o Line offset to search command is not remembered for
1888 next search.
1889 *cpo-O*
1890 O Don't complain if a file is being overwritten, even
1891 when it didn't exist when editing it. This is a
1892 protection against a file unexpectedly created by
1893 someone else. Vi didn't complain about this.
1894 *cpo-p*
1895 p Vi compatible Lisp indenting. When not present, a
1896 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001897 *cpo-P*
1898 P When included, a ":write" command that appends to a
1899 file will set the file name for the current buffer, if
1900 the current buffer doesn't have a file name yet and
1901 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001902 *cpo-q*
1903 q When joining multiple lines leave the cursor at the
1904 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 *cpo-r*
1906 r Redo ("." command) uses "/" to repeat a search
1907 command, instead of the actually used search string.
1908 *cpo-R*
1909 R Remove marks from filtered lines. Without this flag
1910 marks are kept like |:keepmarks| was used.
1911 *cpo-s*
1912 s Set buffer options when entering the buffer for the
1913 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001914 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 set when the buffer is created.
1916 *cpo-S*
1917 S Set buffer options always when entering a buffer
1918 (except 'readonly', 'fileformat', 'filetype' and
1919 'syntax'). This is the (most) Vi compatible setting.
1920 The options are set to the values in the current
1921 buffer. When you change an option and go to another
1922 buffer, the value is copied. Effectively makes the
1923 buffer options global to all buffers.
1924
1925 's' 'S' copy buffer options
1926 no no when buffer created
1927 yes no when buffer first entered (default)
1928 X yes each time when buffer entered (vi comp.)
1929 *cpo-t*
1930 t Search pattern for the tag command is remembered for
1931 "n" command. Otherwise Vim only puts the pattern in
1932 the history for search pattern, but doesn't change the
1933 last used search pattern.
1934 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001935 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 *cpo-v*
1937 v Backspaced characters remain visible on the screen in
1938 Insert mode. Without this flag the characters are
1939 erased from the screen right away. With this flag the
1940 screen newly typed text overwrites backspaced
1941 characters.
1942 *cpo-w*
1943 w When using "cw" on a blank character, only change one
1944 character and not all blanks until the start of the
1945 next word.
1946 *cpo-W*
1947 W Don't overwrite a readonly file. When omitted, ":w!"
1948 overwrites a readonly file, if possible.
1949 *cpo-x*
1950 x <Esc> on the command-line executes the command-line.
1951 The default in Vim is to abandon the command-line,
1952 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo-X*
1954 X When using a count with "R" the replaced text is
1955 deleted only once. Also when repeating "R" with "."
1956 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 *cpo-y*
1958 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001959 *cpo-Z*
1960 Z When using "w!" while the 'readonly' option is set,
1961 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 *cpo-!*
1963 ! When redoing a filter command, use the last used
1964 external command, whatever it was. Otherwise the last
1965 used -filter- command is used.
1966 *cpo-$*
1967 $ When making a change to one line, don't redisplay the
1968 line, but put a '$' at the end of the changed text.
1969 The changed text will be overwritten when you type the
1970 new text. The line is redisplayed if you type any
1971 command that moves the cursor from the insertion
1972 point.
1973 *cpo-%*
1974 % Vi-compatible matching is done for the "%" command.
1975 Does not recognize "#if", "#endif", etc.
1976 Does not recognize "/*" and "*/".
1977 Parens inside single and double quotes are also
1978 counted, causing a string that contains a paren to
1979 disturb the matching. For example, in a line like
1980 "if (strcmp("foo(", s))" the first paren does not
1981 match the last one. When this flag is not included,
1982 parens inside single and double quotes are treated
1983 specially. When matching a paren outside of quotes,
1984 everything inside quotes is ignored. When matching a
1985 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001986 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001987 This flag is also used for other features, such as
1988 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001989 *cpo--*
1990 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001991 it would go above the first line or below the last
1992 line. Without it the cursor moves to the first or
1993 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001994 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001995 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001996 *cpo-+*
1997 + When included, a ":write file" command will reset the
1998 'modified' flag of the buffer, even though the buffer
1999 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002000 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 * Use ":*" in the same way as ":@". When not included,
2002 ":*" is an alias for ":'<,'>", select the Visual area.
2003 *cpo-<*
2004 < Disable the recognition of special key codes in |<>|
2005 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002006 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007 ":map X <Tab>" results in X being mapped to:
2008 '<' included: "<Tab>" (5 characters)
2009 '<' excluded: "^I" (^I is a real <Tab>)
2010 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002011 *cpo->*
2012 > When appending to a register, put a line break before
2013 the appended text.
2014
2015 POSIX flags. These are not included in the Vi default value, except
2016 when $VIM_POSIX was set on startup. |posix|
2017
2018 contains behavior ~
2019 *cpo-#*
2020 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002021 *cpo-&*
2022 & When ":preserve" was used keep the swap file when
2023 exiting normally while this buffer is still loaded.
2024 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002025 *cpo-\*
2026 \ Backslash in a [] range in a search pattern is taken
2027 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002028 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2029 '\' excluded: "/[ \-]" finds <Space> and '-'
2030 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002031 *cpo-/*
2032 / When "%" is used as the replacement string in a |:s|
2033 command, use the previous replacement string. |:s%|
2034 *cpo-{*
2035 { The |{| and |}| commands also stop at a "{" character
2036 at the start of a line.
2037 *cpo-.*
2038 . The ":chdir" and ":cd" commands fail if the current
2039 buffer is modified, unless ! is used. Vim doesn't
2040 need this, since it remembers the full path of an
2041 opened file.
2042 *cpo-bar*
2043 | The value of the $LINES and $COLUMNS environment
2044 variables overrule the terminal size values obtained
2045 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047
2048 *'cscopepathcomp'* *'cspc'*
2049'cscopepathcomp' 'cspc' number (default 0)
2050 global
2051 {not available when compiled without the |+cscope|
2052 feature}
2053 {not in Vi}
2054 Determines how many components of the path to show in a list of tags.
2055 See |cscopepathcomp|.
2056
2057 *'cscopeprg'* *'csprg'*
2058'cscopeprg' 'csprg' string (default "cscope")
2059 global
2060 {not available when compiled without the |+cscope|
2061 feature}
2062 {not in Vi}
2063 Specifies the command to execute cscope. See |cscopeprg|.
2064 This option cannot be set from a |modeline| or in the |sandbox|, for
2065 security reasons.
2066
2067 *'cscopequickfix'* *'csqf'*
2068'cscopequickfix' 'csqf' string (default "")
2069 global
2070 {not available when compiled without the |+cscope|
2071 or |+quickfix| features}
2072 {not in Vi}
2073 Specifies whether to use quickfix window to show cscope results.
2074 See |cscopequickfix|.
2075
2076 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2077'cscopetag' 'cst' boolean (default off)
2078 global
2079 {not available when compiled without the |+cscope|
2080 feature}
2081 {not in Vi}
2082 Use cscope for tag commands. See |cscope-options|.
2083 NOTE: This option is reset when 'compatible' is set.
2084
2085 *'cscopetagorder'* *'csto'*
2086'cscopetagorder' 'csto' number (default 0)
2087 global
2088 {not available when compiled without the |+cscope|
2089 feature}
2090 {not in Vi}
2091 Determines the order in which ":cstag" performs a search. See
2092 |cscopetagorder|.
2093 NOTE: This option is set to 0 when 'compatible' is set.
2094
2095 *'cscopeverbose'* *'csverb'*
2096 *'nocscopeverbose'* *'nocsverb'*
2097'cscopeverbose' 'csverb' boolean (default off)
2098 global
2099 {not available when compiled without the |+cscope|
2100 feature}
2101 {not in Vi}
2102 Give messages when adding a cscope database. See |cscopeverbose|.
2103 NOTE: This option is reset when 'compatible' is set.
2104
2105 *'debug'*
2106'debug' string (default "")
2107 global
2108 {not in Vi}
2109 When set to "msg", error messages that would otherwise be omitted will
2110 be given anyway. This is useful when debugging 'foldexpr' or
2111 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002112 When set to "beep", a message will be given when otherwise only a beep
2113 would be produced.
2114 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115
2116 *'define'* *'def'*
2117'define' 'def' string (default "^\s*#\s*define")
2118 global or local to buffer |global-local|
2119 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002120 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 pattern, just like for the "/" command. This option is used for the
2122 commands like "[i" and "[d" |include-search|. The 'isident' option is
2123 used to recognize the defined name after the match:
2124 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2125 See |option-backslash| about inserting backslashes to include a space
2126 or backslash.
2127 The default value is for C programs. For C++ this value would be
2128 useful, to include const type declarations: >
2129 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2130< When using the ":set" command, you need to double the backslashes!
2131
2132 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2133'delcombine' 'deco' boolean (default off)
2134 global
2135 {not in Vi}
2136 {only available when compiled with the |+multi_byte|
2137 feature}
2138 If editing Unicode and this option is set, backspace and Normal mode
2139 "x" delete each combining character on its own. When it is off (the
2140 default) the character along with its combining characters are
2141 deleted.
2142 Note: When 'delcombine' is set "xx" may work different from "2x"!
2143
2144 This is useful for Arabic, Hebrew and many other languages where one
2145 may have combining characters overtop of base characters, and want
2146 to remove only the combining ones.
2147
2148 *'dictionary'* *'dict'*
2149'dictionary' 'dict' string (default "")
2150 global or local to buffer |global-local|
2151 {not in Vi}
2152 List of file names, separated by commas, that are used to lookup words
2153 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2154 contain a list of words. This can be one word per line, or several
2155 words per line, separated by non-keyword characters (white space is
2156 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002157 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 after a comma are ignored, otherwise spaces are included in the file
2159 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002160 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 Where to find a list of words?
2162 - On FreeBSD, there is the file "/usr/share/dict/words".
2163 - In the Simtel archive, look in the "msdos/linguist" directory.
2164 - In "miscfiles" of the GNU collection.
2165 The use of |:set+=| and |:set-=| is preferred when adding or removing
2166 directories from the list. This avoids problems when a future version
2167 uses another default.
2168 Backticks cannot be used in this option for security reasons.
2169
2170 *'diff'* *'nodiff'*
2171'diff' boolean (default off)
2172 local to window
2173 {not in Vi}
2174 {not available when compiled without the |+diff|
2175 feature}
2176 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002177 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
2179 *'dex'* *'diffexpr'*
2180'diffexpr' 'dex' string (default "")
2181 global
2182 {not in Vi}
2183 {not available when compiled without the |+diff|
2184 feature}
2185 Expression which is evaluated to obtain an ed-style diff file from two
2186 versions of a file. See |diff-diffexpr|.
2187 This option cannot be set from a |modeline| or in the |sandbox|, for
2188 security reasons.
2189
2190 *'dip'* *'diffopt'*
2191'diffopt' 'dip' string (default "filler")
2192 global
2193 {not in Vi}
2194 {not available when compiled without the |+diff|
2195 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002196 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 All are optional. Items must be separated by a comma.
2198
2199 filler Show filler lines, to keep the text
2200 synchronized with a window that has inserted
2201 lines at the same position. Mostly useful
2202 when windows are side-by-side and 'scrollbind'
2203 is set.
2204
2205 context:{n} Use a context of {n} lines between a change
2206 and a fold that contains unchanged lines.
2207 When omitted a context of six lines is used.
2208 See |fold-diff|.
2209
2210 icase Ignore changes in case of text. "a" and "A"
2211 are considered the same. Adds the "-i" flag
2212 to the "diff" command if 'diffexpr' is empty.
2213
2214 iwhite Ignore changes in amount of white space. Adds
2215 the "-b" flag to the "diff" command if
2216 'diffexpr' is empty. Check the documentation
2217 of the "diff" command for what this does
2218 exactly. It should ignore adding trailing
2219 white space, but not leading white space.
2220
2221 Examples: >
2222
2223 :set diffopt=filler,context:4
2224 :set diffopt=
2225 :set diffopt=filler
2226<
2227 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2228'digraph' 'dg' boolean (default off)
2229 global
2230 {not in Vi}
2231 {not available when compiled without the |+digraphs|
2232 feature}
2233 Enable the entering of digraphs in Insert mode with {char1} <BS>
2234 {char2}. See |digraphs|.
2235 NOTE: This option is reset when 'compatible' is set.
2236
2237 *'directory'* *'dir'*
2238'directory' 'dir' string (default for Amiga: ".,t:",
2239 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2240 for Unix: ".,~/tmp,/var/tmp,/tmp")
2241 global
2242 List of directory names for the swap file, separated with commas.
2243 - The swap file will be created in the first directory where this is
2244 possible.
2245 - Empty means that no swap file will be used (recovery is
2246 impossible!).
2247 - A directory "." means to put the swap file in the same directory as
2248 the edited file. On Unix, a dot is prepended to the file name, so
2249 it doesn't show in a directory listing. On MS-Windows the "hidden"
2250 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002251 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 put the swap file relative to where the edited file is. The leading
2253 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002254 - For Unix and Win32, if a directory ends in two path separators "//"
2255 or "\\", the swap file name will be built from the complete path to
2256 the file with all path separators substituted to percent '%' signs.
2257 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 - Spaces after the comma are ignored, other spaces are considered part
2259 of the directory name. To have a space at the start of a directory
2260 name, precede it with a backslash.
2261 - To include a comma in a directory name precede it with a backslash.
2262 - A directory name may end in an ':' or '/'.
2263 - Environment variables are expanded |:set_env|.
2264 - Careful with '\' characters, type one before a space, type two to
2265 get one in the option (see |option-backslash|), for example: >
2266 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2267< - For backwards compatibility with Vim version 3.0 a '>' at the start
2268 of the option is removed.
2269 Using "." first in the list is recommended. This means that editing
2270 the same file twice will result in a warning. Using "/tmp" on Unix is
2271 discouraged: When the system crashes you lose the swap file.
2272 "/var/tmp" is often not cleared when rebooting, thus is a better
2273 choice than "/tmp". But it can contain a lot of files, your swap
2274 files get lost in the crowd. That is why a "tmp" directory in your
2275 home directory is tried first.
2276 The use of |:set+=| and |:set-=| is preferred when adding or removing
2277 directories from the list. This avoids problems when a future version
2278 uses another default.
2279 This option cannot be set from a |modeline| or in the |sandbox|, for
2280 security reasons.
2281 {Vi: directory to put temp file in, defaults to "/tmp"}
2282
2283 *'display'* *'dy'*
2284'display' 'dy' string (default "")
2285 global
2286 {not in Vi}
2287 Change the way text is displayed. This is comma separated list of
2288 flags:
2289 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002290 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002291 last line that doesn't fit is replaced with "@" lines.
2292 uhex Show unprintable characters hexadecimal as <xx>
2293 instead of using ^C and ~C.
2294
2295 *'eadirection'* *'ead'*
2296'eadirection' 'ead' string (default "both")
2297 global
2298 {not in Vi}
2299 {not available when compiled without the +vertsplit
2300 feature}
2301 Tells when the 'equalalways' option applies:
2302 ver vertically, width of windows is not affected
2303 hor horizontally, height of windows is not affected
2304 both width and height of windows is affected
2305
2306 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2307'edcompatible' 'ed' boolean (default off)
2308 global
2309 Makes the 'g' and 'c' flags of the ":substitute" command to be
2310 toggled each time the flag is given. See |complex-change|. See
2311 also 'gdefault' option.
2312 Switching this option on is discouraged!
2313
2314 *'encoding'* *'enc'* *E543*
2315'encoding' 'enc' string (default: "latin1" or value from $LANG)
2316 global
2317 {only available when compiled with the |+multi_byte|
2318 feature}
2319 {not in Vi}
2320 Sets the character encoding used inside Vim. It applies to text in
2321 the buffers, registers, Strings in expressions, text stored in the
2322 viminfo file, etc. It sets the kind of characters which Vim can work
2323 with. See |encoding-names| for the possible values.
2324
2325 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002326 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 It should normally be kept at its default value, or set when Vim
2328 starts up. See |multibyte|.
2329
2330 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2331 "utf-8". Although care has been taken to allow different values of
2332 'encoding', "utf-8" is the natural choice for the environment and
2333 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002334 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 versions, and to avoid changing the encoding of newly created files
2336 without your knowledge (in case 'fileencodings' is empty).
2337
2338 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002339 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 iconv() or as specified with 'charconvert'.
2341
2342 Normally 'encoding' will be equal to your current locale. This will
2343 be the default if Vim recognizes your environment settings. If
2344 'encoding' is not set to the current locale, 'termencoding' must be
2345 set to convert typed and displayed text. See |encoding-table|.
2346
2347 When you set this option, it fires the |EncodingChanged| autocommand
2348 event so that you can set up fonts if necessary.
2349
2350 When the option is set, the value is converted to lowercase. Thus
2351 you can set it with uppercase values too. Underscores are translated
2352 to '-' signs.
2353 When the encoding is recognized, it is changed to the standard name.
2354 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2355 "iso-8859-2" and "utf8" becomes "utf-8".
2356
2357 Note: "latin1" is also used when the encoding could not be detected.
2358 This only works when editing files in the same encoding! When the
2359 actual character set is not latin1, make sure 'fileencoding' and
2360 'fileencodings' are empty. When conversion is needed, switch to using
2361 utf-8.
2362
2363 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2364 You don't notice this while editing, but it does matter for the
2365 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2366 setting 'encoding' to one of these values instead of utf-8 only has
2367 effect for encoding used for files when 'fileencoding' is empty.
2368
Bram Moolenaar661b1822005-07-28 22:36:45 +00002369 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2370 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371
2372 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2373'endofline' 'eol' boolean (default on)
2374 local to buffer
2375 {not in Vi}
2376 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002377 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 option is automatically set when starting to edit a new file, unless
2379 the file does not have an <EOL> for the last line in the file, in
2380 which case it is reset. Normally you don't have to set or reset this
2381 option. When 'binary' is off the value is not used when writing the
2382 file. When 'binary' is on it is used to remember the presence of a
2383 <EOL> for the last line in the file, so that when you write the file
2384 the situation from the original file can be kept. But you can change
2385 it if you want to.
2386
2387 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2388'equalalways' 'ea' boolean (default on)
2389 global
2390 {not in Vi}
2391 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002392 splitting or closing a window. This also happens the moment the
2393 option is switched on. When off, splitting a window will reduce the
2394 size of the current window and leave the other windows the same. When
2395 closing a window the extra lines are given to the window next to it
2396 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 When mixing vertically and horizontally split windows, a minimal size
2398 is computed and some windows may be larger if there is room. The
2399 'eadirection' option tells in which direction the size is affected.
2400 Changing the height of a window can be avoided by setting
2401 'winfixheight'.
2402
2403 *'equalprg'* *'ep'*
2404'equalprg' 'ep' string (default "")
2405 global or local to buffer |global-local|
2406 {not in Vi}
2407 External program to use for "=" command. When this option is empty
2408 the internal formatting functions are used ('lisp', 'cindent' or
2409 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002410 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 about including spaces and backslashes.
2412 This option cannot be set from a |modeline| or in the |sandbox|, for
2413 security reasons.
2414
2415 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2416'errorbells' 'eb' boolean (default off)
2417 global
2418 Ring the bell (beep or screen flash) for error messages. This only
2419 makes a difference for error messages, the bell will be used always
2420 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002421 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 screen flash or do nothing.
2423
2424 *'errorfile'* *'ef'*
2425'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2426 others: "errors.err")
2427 global
2428 {not in Vi}
2429 {not available when compiled without the |+quickfix|
2430 feature}
2431 Name of the errorfile for the QuickFix mode (see |:cf|).
2432 When the "-q" command-line argument is used, 'errorfile' is set to the
2433 following argument. See |-q|.
2434 NOT used for the ":make" command. See 'makeef' for that.
2435 Environment variables are expanded |:set_env|.
2436 See |option-backslash| about including spaces and backslashes.
2437 This option cannot be set from a |modeline| or in the |sandbox|, for
2438 security reasons.
2439
2440 *'errorformat'* *'efm'*
2441'errorformat' 'efm' string (default is very long)
2442 global or local to buffer |global-local|
2443 {not in Vi}
2444 {not available when compiled without the |+quickfix|
2445 feature}
2446 Scanf-like description of the format for the lines in the error file
2447 (see |errorformat|).
2448
2449 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2450'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2451 global
2452 {not in Vi}
2453 Function keys that start with an <Esc> are recognized in Insert
2454 mode. When this option is off, the cursor and function keys cannot be
2455 used in Insert mode if they start with an <Esc>. The advantage of
2456 this is that the single <Esc> is recognized immediately, instead of
2457 after one second. Instead of resetting this option, you might want to
2458 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2459 when 'esckeys' is off, you can still map anything, but the cursor keys
2460 won't work by default.
2461 NOTE: This option is set to the Vi default value when 'compatible' is
2462 set and to the Vim default value when 'compatible' is reset.
2463
2464 *'eventignore'* *'ei'*
2465'eventignore' 'ei' string (default "")
2466 global
2467 {not in Vi}
2468 {not available when compiled without the |+autocmd|
2469 feature}
2470 A list of autocommand event names, which are to be ignored.
2471 When set to "all", all autocommand events are ignored, autocommands
2472 will not be executed.
2473 Otherwise this is a comma separated list of event names. Example: >
2474 :set ei=WinEnter,WinLeave
2475<
2476 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2477'expandtab' 'et' boolean (default off)
2478 local to buffer
2479 {not in Vi}
2480 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002481 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2483 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2484 NOTE: This option is reset when 'compatible' is set.
2485
2486 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2487'exrc' 'ex' boolean (default off)
2488 global
2489 {not in Vi}
2490 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2491 directory. If you switch this option on you should also consider
2492 setting the 'secure' option (see |initialization|). Using a local
2493 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2494 also see |.vimrc| and |gui-init|.
2495 This option cannot be set from a |modeline| or in the |sandbox|, for
2496 security reasons.
2497
2498 *'fileencoding'* *'fenc'* *E213*
2499'fileencoding' 'fenc' string (default: "")
2500 local to buffer
2501 {only available when compiled with the |+multi_byte|
2502 feature}
2503 {not in Vi}
2504 Sets the character encoding for the file of this buffer.
2505 When 'fileencoding' is different from 'encoding', conversion will be
2506 done when reading and writing the file.
2507 When 'fileencoding' is empty, the same value as 'encoding' will be
2508 used (no conversion when reading or writing a file).
2509 WARNING: Conversion can cause loss of information! When
2510 'encoding' is "utf-8" conversion is most likely done in a way
2511 that the reverse conversion results in the same text. When
2512 'encoding' is not "utf-8" some characters may be lost!
2513 See 'encoding' for the possible values. Additionally, values may be
2514 specified that can be handled by the converter, see
2515 |mbyte-conversion|.
2516 When reading a file 'fileencoding' will be set from 'fileencodings'.
2517 To read a file in a certain encoding it won't work by setting
2518 'fileencoding', use the |++enc| argument.
2519 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2520 When the option is set, the value is converted to lowercase. Thus
2521 you can set it with uppercase values too. '_' characters are
2522 replaced with '-'. If a name is recognized from the list for
2523 'encoding', it is replaced by the standard name. For example
2524 "ISO8859-2" becomes "iso-8859-2".
2525 When this option is set, after starting to edit a file, the 'modified'
2526 option is set, because the file would be different when written.
2527 If you do this in a modeline, you might want to set 'nomodified' to
2528 avoid this.
2529 This option can not be changed when 'modifiable' is off.
2530
2531 *'fe'*
2532 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002533 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 old short name was 'fe', which is no longer used.
2535
2536 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002537'fileencodings' 'fencs' string (default: "ucs-bom",
2538 "ucs-bom,utf-8,default,latin1" when
2539 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 global
2541 {only available when compiled with the |+multi_byte|
2542 feature}
2543 {not in Vi}
2544 This is a list of character encodings considered when starting to edit
2545 an existing file. When a file is read, Vim tries to use the first
2546 mentioned character encoding. If an error is detected, the next one
2547 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002548 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 an empty string, which means the value of 'encoding' is used.
2550 WARNING: Conversion can cause loss of information! When
2551 'encoding' is "utf-8" (or one of the other Unicode variants)
2552 conversion is most likely done in a way that the reverse
2553 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002554 "utf-8" some non-ASCII characters may be lost! You can use
2555 the |++bad| argument to specify what is done with characters
2556 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 For an empty file or a file with only ASCII characters most encodings
2558 will work and the first entry of 'fileencodings' will be used (except
2559 "ucs-bom", which requires the BOM to be present). If you prefer
2560 another encoding use an BufReadPost autocommand event to test if your
2561 preferred encoding is to be used. Example: >
2562 au BufReadPost * if search('\S', 'w') == 0 |
2563 \ set fenc=iso-2022-jp | endif
2564< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2565 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002566 When the |++enc| argument is used then the value of 'fileencodings' is
2567 not used.
2568 Note that 'fileencodings' is not used for a new file, 'fileencoding'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 is always empty then. This means that a non-existing file may get a
2570 different encoding than an empty file.
2571 The special value "ucs-bom" can be used to check for a Unicode BOM
2572 (Byte Order Mark) at the start of the file. It must not be preceded
2573 by "utf-8" or another Unicode encoding for this to work properly.
2574 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2575 because Vim cannot detect an error, thus the encoding is always
2576 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002577 The special value "default" can be used for the encoding from the
2578 environment. This is the default value for 'encoding'. It is useful
2579 when 'encoding' is set to "utf-8" and your environment uses a
2580 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 WRONG VALUES: WHAT'S WRONG:
2582 latin1,utf-8 "latin1" will always be used
2583 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2584 file
2585 cp1250,latin1 "cp1250" will always be used
2586 If 'fileencodings' is empty, 'fileencoding' is not modified.
2587 See 'fileencoding' for the possible values.
2588 Setting this option does not have an effect until the next time a file
2589 is read.
2590
2591 *'fileformat'* *'ff'*
2592'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2593 Unix default: "unix",
2594 Macintosh default: "mac")
2595 local to buffer
2596 {not in Vi}
2597 This gives the <EOL> of the current buffer, which is used for
2598 reading/writing the buffer from/to a file:
2599 dos <CR> <NL>
2600 unix <NL>
2601 mac <CR>
2602 When "dos" is used, CTRL-Z at the end of a file is ignored.
2603 See |file-formats| and |file-read|.
2604 For the character encoding of the file see 'fileencoding'.
2605 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2606 works like it was set to "unix'.
2607 This option is set automatically when starting to edit a file and
2608 'fileformats' is not empty and 'binary' is off.
2609 When this option is set, after starting to edit a file, the 'modified'
2610 option is set, because the file would be different when written.
2611 This option can not be changed when 'modifiable' is off.
2612 For backwards compatibility: When this option is set to "dos",
2613 'textmode' is set, otherwise 'textmode' is reset.
2614
2615 *'fileformats'* *'ffs'*
2616'fileformats' 'ffs' string (default:
2617 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2618 Vim Unix: "unix,dos",
2619 Vim Mac: "mac,unix,dos",
2620 Vi Cygwin: "unix,dos",
2621 Vi others: "")
2622 global
2623 {not in Vi}
2624 This gives the end-of-line (<EOL>) formats that will be tried when
2625 starting to edit a new buffer and when reading a file into an existing
2626 buffer:
2627 - When empty, the format defined with 'fileformat' will be used
2628 always. It is not set automatically.
2629 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002630 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 'fileformats' name will be used when a file is read into an existing
2632 buffer, no matter what 'fileformat' for that buffer is set to.
2633 - When more than one name is present, separated by commas, automatic
2634 <EOL> detection will be done when reading a file. When starting to
2635 edit a file, a check is done for the <EOL>:
2636 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2637 'fileformat' is set to "dos".
2638 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002639 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 preceding <CR>, "unix" is preferred over "dos".
2641 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2642 This means that "mac" is only chosen when "unix" is not present,
2643 or when no <NL> is found in the file, and when "dos" is not
2644 present, or no <CR><NL> is present in the file.
2645 Also if "unix" was first chosen, but the first <CR> is before
2646 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2647 the file, then 'fileformat' is set to "mac".
2648 4. If 'fileformat' is still not set, the first name from
2649 'fileformats' is used.
2650 When reading a file into an existing buffer, the same is done, but
2651 this happens like 'fileformat' has been set appropriately for that
2652 file only, the option is not changed.
2653 When 'binary' is set, the value of 'fileformats' is not used.
2654
2655 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2656 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2657 done:
2658 - When 'fileformats' is empty, there is no automatic detection. Dos
2659 format will be used.
2660 - When 'fileformats' is set to one or more names, automatic detection
2661 is done. This is based on the first <NL> in the file: If there is a
2662 <CR> in front of it, Dos format is used, otherwise Unix format is
2663 used.
2664 Also see |file-formats|.
2665 For backwards compatibility: When this option is set to an empty
2666 string or one format (no comma is included), 'textauto' is reset,
2667 otherwise 'textauto' is set.
2668 NOTE: This option is set to the Vi default value when 'compatible' is
2669 set and to the Vim default value when 'compatible' is reset.
2670
2671 *'filetype'* *'ft'*
2672'filetype' 'ft' string (default: "")
2673 local to buffer
2674 {not in Vi}
2675 {not available when compiled without the |+autocmd|
2676 feature}
2677 When this option is set, the FileType autocommand event is triggered.
2678 All autocommands that match with the value of this option will be
2679 executed. Thus the value of 'filetype' is used in place of the file
2680 name.
2681 Otherwise this option does not always reflect the current file type.
2682 This option is normally set when the file type is detected. To enable
2683 this use the ":filetype on" command. |:filetype|
2684 Setting this option to a different value is most useful in a modeline,
2685 for a file for which the file type is not automatically recognized.
2686 Example, for in an IDL file: >
2687 /* vim: set filetype=idl : */
2688< |FileType| |filetypes|
2689 Do not confuse this option with 'osfiletype', which is for the file
2690 type that is actually stored with the file.
2691 This option is not copied to another buffer, independent of the 's' or
2692 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002693 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694
2695 *'fillchars'* *'fcs'*
2696'fillchars' 'fcs' string (default "vert:|,fold:-")
2697 global
2698 {not in Vi}
2699 {not available when compiled without the |+windows|
2700 and |+folding| features}
2701 Characters to fill the statuslines and vertical separators.
2702 It is a comma separated list of items:
2703
2704 item default Used for ~
2705 stl:c ' ' or '^' statusline of the current window
2706 stlnc:c ' ' or '-' statusline of the non-current windows
2707 vert:c '|' vertical separators |:vsplit|
2708 fold:c '-' filling 'foldtext'
2709 diff:c '-' deleted lines of the 'diff' option
2710
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002711 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 "stlnc" the space will be used when there is highlighting, '^' or '-'
2713 otherwise.
2714
2715 Example: >
2716 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2717< This is similar to the default, except that these characters will also
2718 be used when there is highlighting.
2719
2720 The highlighting used for these items:
2721 item highlight group ~
2722 stl:c StatusLine |hl-StatusLine|
2723 stlnc:c StatusLineNC |hl-StatusLineNC|
2724 vert:c VertSplit |hl-VertSplit|
2725 fold:c Folded |hl-Folded|
2726 diff:c DiffDelete |hl-DiffDelete|
2727
2728 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2729'fkmap' 'fk' boolean (default off) *E198*
2730 global
2731 {not in Vi}
2732 {only available when compiled with the |+rightleft|
2733 feature}
2734 When on, the keyboard is mapped for the Farsi character set.
2735 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002736 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737
2738 *'foldclose'* *'fcl'*
2739'foldclose' 'fcl' string (default "")
2740 global
2741 {not in Vi}
2742 {not available when compiled without the |+folding|
2743 feature}
2744 When set to "all", a fold is closed when the cursor isn't in it and
2745 its level is higher than 'foldlevel'. Useful if you want folds to
2746 automatically close when moving out of them.
2747
2748 *'foldcolumn'* *'fdc'*
2749'foldcolumn' 'fdc' number (default 0)
2750 local to window
2751 {not in Vi}
2752 {not available when compiled without the |+folding|
2753 feature}
2754 When non-zero, a column with the specified width is shown at the side
2755 of the window which indicates open and closed folds. The maximum
2756 value is 12.
2757 See |folding|.
2758
2759 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2760'foldenable' 'fen' boolean (default on)
2761 local to window
2762 {not in Vi}
2763 {not available when compiled without the |+folding|
2764 feature}
2765 When off, all folds are open. This option can be used to quickly
2766 switch between showing all text unfolded and viewing the text with
2767 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002768 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 'foldenable' is off.
2770 This option is set by commands that create a new fold or close a fold.
2771 See |folding|.
2772
2773 *'foldexpr'* *'fde'*
2774'foldexpr' 'fde' string (default: "0")
2775 local to window
2776 {not in Vi}
2777 {not available when compiled without the |+folding|
2778 or |+eval| feature}
2779 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002780 for each line to obtain its fold level. See |fold-expr|.
2781
2782 The expression may be evaluated in the |sandbox|, see
2783 |sandbox-option|.
2784
2785 It is not allowed to change text or jump to another window while
2786 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787
2788 *'foldignore'* *'fdi'*
2789'foldignore' 'fdi' string (default: "#")
2790 local to window
2791 {not in Vi}
2792 {not available when compiled without the |+folding|
2793 feature}
2794 Used only when 'foldmethod' is "indent". Lines starting with
2795 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002796 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 The default "#" works well for C programs. See |fold-indent|.
2798
2799 *'foldlevel'* *'fdl'*
2800'foldlevel' 'fdl' number (default: 0)
2801 local to window
2802 {not in Vi}
2803 {not available when compiled without the |+folding|
2804 feature}
2805 Sets the fold level: Folds with a higher level will be closed.
2806 Setting this option to zero will close all folds. Higher numbers will
2807 close fewer folds.
2808 This option is set by commands like |zm|, |zM| and |zR|.
2809 See |fold-foldlevel|.
2810
2811 *'foldlevelstart'* *'fdls'*
2812'foldlevelstart' 'fdls' number (default: -1)
2813 global
2814 {not in Vi}
2815 {not available when compiled without the |+folding|
2816 feature}
2817 Sets 'foldlevel' when starting to edit another buffer in a window.
2818 Useful to always start editing with all folds closed (value zero),
2819 some folds closed (one) or no folds closed (99).
2820 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002821 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 ignores this option and closes all folds.
2823 It is also done before BufReadPre autocommands, to allow an autocmd to
2824 overrule the 'foldlevel' value for specific files.
2825 When the value is negative, it is not used.
2826
2827 *'foldmarker'* *'fmr'* *E536*
2828'foldmarker' 'fmr' string (default: "{{{,}}}")
2829 local to window
2830 {not in Vi}
2831 {not available when compiled without the |+folding|
2832 feature}
2833 The start and end marker used when 'foldmethod' is "marker". There
2834 must be one comma, which separates the start and end marker. The
2835 marker is a literal string (a regular expression would be too slow).
2836 See |fold-marker|.
2837
2838 *'foldmethod'* *'fdm'*
2839'foldmethod' 'fdm' string (default: "manual")
2840 local to window
2841 {not in Vi}
2842 {not available when compiled without the |+folding|
2843 feature}
2844 The kind of folding used for the current window. Possible values:
2845 |fold-manual| manual Folds are created manually.
2846 |fold-indent| indent Lines with equal indent form a fold.
2847 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2848 |fold-marker| marker Markers are used to specify folds.
2849 |fold-syntax| syntax Syntax highlighting items specify folds.
2850 |fold-diff| diff Fold text that is not changed.
2851
2852 *'foldminlines'* *'fml'*
2853'foldminlines' 'fml' number (default: 1)
2854 local to window
2855 {not in Vi}
2856 {not available when compiled without the |+folding|
2857 feature}
2858 Sets the minimum number of screen lines for a fold to be displayed
2859 closed. Also for manually closed folds.
2860 Note that this only has an effect of what is displayed. After using
2861 "zc" to close a fold, which is displayed open because it's smaller
2862 than 'foldminlines', a following "zc" may close a containing fold.
2863
2864 *'foldnestmax'* *'fdn'*
2865'foldnestmax' 'fdn' number (default: 20)
2866 local to window
2867 {not in Vi}
2868 {not available when compiled without the |+folding|
2869 feature}
2870 Sets the maximum nesting of folds for the "indent" and "syntax"
2871 methods. This avoids that too many folds will be created. Using more
2872 than 20 doesn't work, because the internal limit is 20.
2873
2874 *'foldopen'* *'fdo'*
2875'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2876 search,tag,undo")
2877 global
2878 {not in Vi}
2879 {not available when compiled without the |+folding|
2880 feature}
2881 Specifies for which type of commands folds will be opened, if the
2882 command moves the cursor into a closed fold. It is a comma separated
2883 list of items.
2884 item commands ~
2885 all any
2886 block "(", "{", "[[", "[{", etc.
2887 hor horizontal movements: "l", "w", "fx", etc.
2888 insert any command in Insert mode
2889 jump far jumps: "G", "gg", etc.
2890 mark jumping to a mark: "'m", CTRL-O, etc.
2891 percent "%"
2892 quickfix ":cn", ":crew", ":make", etc.
2893 search search for a pattern: "/", "n", "*", "gd", etc.
2894 (not for a search pattern in a ":" command)
2895 tag jumping to a tag: ":ta", CTRL-T, etc.
2896 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002897 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 the |zv| command to the mapping to get the same effect.
2899 When a movement command is used for an operator (e.g., "dl" or "y%")
2900 this option is not used. This means the operator will include the
2901 whole closed fold.
2902 Note that vertical movements are not here, because it would make it
2903 very difficult to move onto a closed fold.
2904 In insert mode the folds containing the cursor will always be open
2905 when text is inserted.
2906 To close folds you can re-apply 'foldlevel' with the |zx| command or
2907 set the 'foldclose' option to "all".
2908
2909 *'foldtext'* *'fdt'*
2910'foldtext' 'fdt' string (default: "foldtext()")
2911 local to window
2912 {not in Vi}
2913 {not available when compiled without the |+folding|
2914 feature}
2915 An expression which is used to specify the text displayed for a closed
2916 fold. See |fold-foldtext|.
2917
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002918 The expression may be evaluated in the |sandbox|, see
2919 |sandbox-option|.
2920
2921 It is not allowed to change text or jump to another window while
2922 evaluating 'foldtext' |textlock|.
2923
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 *'formatoptions'* *'fo'*
2925'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2926 local to buffer
2927 {not in Vi}
2928 This is a sequence of letters which describes how automatic
2929 formatting is to be done. See |fo-table|. When the 'paste' option is
2930 on, no formatting is done (like 'formatoptions' is empty). Commas can
2931 be inserted for readability.
2932 To avoid problems with flags that are added in the future, use the
2933 "+=" and "-=" feature of ":set" |add-option-flags|.
2934 NOTE: This option is set to the Vi default value when 'compatible' is
2935 set and to the Vim default value when 'compatible' is reset.
2936
Bram Moolenaar86b68352004-12-27 21:59:20 +00002937 *'formatlistpat'* *'flp'*
2938'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2939 local to buffer
2940 {not in Vi}
2941 A pattern that is used to recognize a list header. This is used for
2942 the "n" flag in 'formatoptions'.
2943 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002944 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002945 while still checking more characters. There must be a character
2946 following the pattern, when it matches the whole line it is handled
2947 like there is no match.
2948 The default recognizes a number, followed by an optional punctuation
2949 character and white space.
2950
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 *'formatprg'* *'fp'*
2952'formatprg' 'fp' string (default "")
2953 global
2954 {not in Vi}
2955 The name of an external program that will be used to format the lines
2956 selected with the "gq" command. The program must take the input on
2957 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002958 such a program.
2959 If this option is an empty string, the internal format function will
2960 be used |C-indenting|.
2961 Environment variables are expanded |:set_env|. See |option-backslash|
2962 about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 This option cannot be set from a |modeline| or in the |sandbox|, for
2964 security reasons.
2965
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002966 *'fsync'* *'fs'*
2967'fsync' 'fs' boolean (default on)
2968 global
2969 {not in Vi}
2970 When on, the library function fsync() will be called after writing a
2971 file. This will flush a file to disk, ensuring that it is safely
2972 written even on filesystems which do metadata-only journaling. This
2973 will force the harddrive to spin up on Linux systems running in laptop
2974 mode, so it may be undesirable in some situations. Be warned that
2975 turning this off increases the chances of data loss after a crash. On
2976 systems without an fsync() implementation, this variable is always
2977 off.
2978 Also see 'swapsync' for controlling fsync() on swap files.
2979
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2981'gdefault' 'gd' boolean (default off)
2982 global
2983 {not in Vi}
2984 When on, the ":substitute" flag 'g' is default on. This means that
2985 all matches in a line are substituted instead of one. When a 'g' flag
2986 is given to a ":substitute" command, this will toggle the substitution
2987 of all or one match. See |complex-change|.
2988
2989 command 'gdefault' on 'gdefault' off ~
2990 :s/// subst. all subst. one
2991 :s///g subst. one subst. all
2992 :s///gg subst. all subst. one
2993
2994 NOTE: This option is reset when 'compatible' is set.
2995
2996 *'grepformat'* *'gfm'*
2997'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2998 global
2999 {not in Vi}
3000 Format to recognize for the ":grep" command output.
3001 This is a scanf-like string that uses the same format as the
3002 'errorformat' option: see |errorformat|.
3003
3004 *'grepprg'* *'gp'*
3005'grepprg' 'gp' string (default "grep -n ",
3006 Unix: "grep -n $* /dev/null",
3007 Win32: "findstr /n" or "grep -n",
3008 VMS: "SEARCH/NUMBERS ")
3009 global or local to buffer |global-local|
3010 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003011 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 and '#' characters, which are expanded like when used in a command-
3013 line. The placeholder "$*" is allowed to specify where the arguments
3014 will be included. Environment variables are expanded |:set_env|. See
3015 |option-backslash| about including spaces and backslashes.
3016 When your "grep" accepts the "-H" argument, use this to make ":grep"
3017 also work well with a single file: >
3018 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003019< Special value: When 'grepprg' is set to "internal" the |:grep| command
3020 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003021 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 apply equally to 'grepprg'.
3023 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3024 otherwise it's "grep -n".
3025 This option cannot be set from a |modeline| or in the |sandbox|, for
3026 security reasons.
3027
3028 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3029'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3030 ve:ver35-Cursor,
3031 o:hor50-Cursor,
3032 i-ci:ver25-Cursor/lCursor,
3033 r-cr:hor20-Cursor/lCursor,
3034 sm:block-Cursor
3035 -blinkwait175-blinkoff150-blinkon175",
3036 for MS-DOS and Win32 console:
3037 "n-v-c:block,o:hor50,i-ci:hor15,
3038 r-cr:hor30,sm:block")
3039 global
3040 {not in Vi}
3041 {only available when compiled with GUI enabled, and
3042 for MS-DOS and Win32 console}
3043 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003044 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 the height of the cursor can be changed. This can be done by
3046 specifying a block cursor, or a percentage for a vertical or
3047 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003048 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003050 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 mode-list and an argument-list:
3052 mode-list:argument-list,mode-list:argument-list,..
3053 The mode-list is a dash separated list of these modes:
3054 n Normal mode
3055 v Visual mode
3056 ve Visual mode with 'selection' "exclusive" (same as 'v',
3057 if not specified)
3058 o Operator-pending mode
3059 i Insert mode
3060 r Replace mode
3061 c Command-line Normal (append) mode
3062 ci Command-line Insert mode
3063 cr Command-line Replace mode
3064 sm showmatch in Insert mode
3065 a all modes
3066 The argument-list is a dash separated list of these arguments:
3067 hor{N} horizontal bar, {N} percent of the character height
3068 ver{N} vertical bar, {N} percent of the character width
3069 block block cursor, fills the whole character
3070 [only one of the above three should be present]
3071 blinkwait{N} *cursor-blinking*
3072 blinkon{N}
3073 blinkoff{N}
3074 blink times for cursor: blinkwait is the delay before
3075 the cursor starts blinking, blinkon is the time that
3076 the cursor is shown and blinkoff is the time that the
3077 cursor is not shown. The times are in msec. When one
3078 of the numbers is zero, there is no blinking. The
3079 default is: "blinkwait700-blinkon400-blinkoff250".
3080 These numbers are used for a missing entry. This
3081 means that blinking is enabled by default. To switch
3082 blinking off you can use "blinkon0". The cursor only
3083 blinks when Vim is waiting for input, not while
3084 executing a command.
3085 To make the cursor blink in an xterm, see
3086 |xterm-blink|.
3087 {group-name}
3088 a highlight group name, that sets the color and font
3089 for the cursor
3090 {group-name}/{group-name}
3091 Two highlight group names, the first is used when
3092 no language mappings are used, the other when they
3093 are. |language-mapping|
3094
3095 Examples of parts:
3096 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3097 block cursor with colors from the "nCursor"
3098 highlight group
3099 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3100 In Insert and Command-line Insert mode, use a
3101 30% vertical bar cursor with colors from the
3102 "iCursor" highlight group. Blink a bit
3103 faster.
3104
3105 The 'a' mode is different. It will set the given argument-list for
3106 all modes. It does not reset anything to defaults. This can be used
3107 to do a common setting for all modes. For example, to switch off
3108 blinking: "a:blinkon0"
3109
3110 Examples of cursor highlighting: >
3111 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3112 :highlight Cursor gui=NONE guifg=bg guibg=fg
3113<
3114 *'guifont'* *'gfn'*
3115 *E235* *E596* *E610* *E611*
3116'guifont' 'gfn' string (default "")
3117 global
3118 {not in Vi}
3119 {only available when compiled with GUI enabled}
3120 This is a list of fonts which will be used for the GUI version of Vim.
3121 In its simplest form the value is just one font name. When
3122 the font cannot be found you will get an error message. To try other
3123 font names a list can be specified, font names separated with commas.
3124 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003125
Bram Moolenaar05159a02005-02-26 23:04:13 +00003126 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3127 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003128
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 Spaces after a comma are ignored. To include a comma in a font name
3130 precede it with a backslash. Setting an option requires an extra
3131 backslash before a space and a backslash. See also
3132 |option-backslash|. For example: >
3133 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003134< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003136
3137 If none of the fonts can be loaded, Vim will keep the current setting.
3138 If an empty font list is given, Vim will try using other resource
3139 settings (for X, it will use the Vim.font resource), and finally it
3140 will try some builtin default which should always be there ("7x13" in
3141 the case of X). The font names given should be "normal" fonts. Vim
3142 will try to find the related bold and italic fonts.
3143
Bram Moolenaar05159a02005-02-26 23:04:13 +00003144 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003145 :set guifont=*
3146< will bring up a font requester, where you can pick the font you want.
3147
3148 The font name depends on the GUI used. See |setting-guifont| for a
3149 way to set 'guifont' for various systems.
3150
Bram Moolenaar071d4272004-06-13 20:20:40 +00003151 For the GTK+ 2 GUI the font name looks like this: >
3152 :set guifont=Andale\ Mono\ 11
3153< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003154
3155 For Mac OSX you can use something like this: >
3156 :set guifont=Monaco:h10
3157< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003159 width). An exception is GTK 2: all fonts are accepted, but
3160 mono-spaced fonts look best.
3161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 To preview a font on X11, you might be able to use the "xfontsel"
3163 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003164
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 For the Win32 GUI *E244* *E245*
3166 - takes these options in the font name:
3167 hXX - height is XX (points, can be floating-point)
3168 wXX - width is XX (points, can be floating-point)
3169 b - bold
3170 i - italic
3171 u - underline
3172 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003173 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3175 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3176 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003177 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178
3179 Use a ':' to separate the options.
3180 - A '_' can be used in the place of a space, so you don't need to use
3181 backslashes to escape the spaces.
3182 - Examples: >
3183 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3184 :set guifont=Andale_Mono:h7.5:w4.5
3185< See also |font-sizes|.
3186
3187 *'guifontset'* *'gfs'*
3188 *E250* *E252* *E234* *E597* *E598*
3189'guifontset' 'gfs' string (default "")
3190 global
3191 {not in Vi}
3192 {only available when compiled with GUI enabled and
3193 with the |+xfontset| feature}
3194 {not available in the GTK+ 2 GUI}
3195 When not empty, specifies two (or more) fonts to be used. The first
3196 one for normal English, the second one for your special language. See
3197 |xfontset|.
3198 Setting this option also means that all font names will be handled as
3199 a fontset name. Also the ones used for the "font" argument of the
3200 |:highlight| command.
3201 The fonts must match with the current locale. If fonts for the
3202 character sets that the current locale uses are not included, setting
3203 'guifontset' will fail.
3204 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3205 the comma-separated names are alternative names, one of which will be
3206 used. In 'guifontset' the whole string is one fontset name,
3207 including the commas. It is not possible to specify alternative
3208 fontset names.
3209 This example works on many X11 systems: >
3210 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3211<
3212 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3213'guifontwide' 'gfw' string (default "")
3214 global
3215 {not in Vi}
3216 {only available when compiled with GUI enabled}
3217 When not empty, specifies a comma-separated list of fonts to be used
3218 for double-width characters. The first font that can be loaded is
3219 used.
3220 Note: The size of these fonts must be exactly twice as wide as the one
3221 specified with 'guifont' and the same height.
3222
3223 All GUI versions but GTK+ 2:
3224
3225 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3226 'guifontset' is empty or invalid.
3227 When 'guifont' is set and a valid font is found in it and
3228 'guifontwide' is empty Vim will attempt to find a matching
3229 double-width font and set 'guifontwide' to it.
3230
3231 GTK+ 2 GUI only: *guifontwide_gtk2*
3232
3233 If set and valid, 'guifontwide' is always used for double width
3234 characters, even if 'encoding' is not set to "utf-8".
3235 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003236 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 font for characters not available in 'guifont'. Thus you do not need
3238 to set 'guifontwide' at all unless you want to override the choice
3239 made by Pango/Xft.
3240
3241 *'guiheadroom'* *'ghr'*
3242'guiheadroom' 'ghr' number (default 50)
3243 global
3244 {not in Vi} {only for GTK and X11 GUI}
3245 The number of pixels subtracted from the screen height when fitting
3246 the GUI window on the screen. Set this before the GUI is started,
3247 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003248 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 lines will be left for window decorations and other items on the
3250 screen. Set it to a negative value to allow windows taller than the
3251 screen.
3252
3253 *'guioptions'* *'go'*
3254'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003255 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 global
3257 {not in Vi}
3258 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003259 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 sequence of letters which describes what components and options of the
3261 GUI should be used.
3262 To avoid problems with flags that are added in the future, use the
3263 "+=" and "-=" feature of ":set" |add-option-flags|.
3264
3265 Valid letters are as follows:
3266 *guioptions_a*
3267 'a' Autoselect: If present, then whenever VISUAL mode is started,
3268 or the Visual area extended, Vim tries to become the owner of
3269 the windowing system's global selection. This means that the
3270 Visually highlighted text is available for pasting into other
3271 applications as well as into Vim itself. When the Visual mode
3272 ends, possibly due to an operation on the text, or when an
3273 application wants to paste the selection, the highlighted text
3274 is automatically yanked into the "* selection register.
3275 Thus the selection is still available for pasting into other
3276 applications after the VISUAL mode has ended.
3277 If not present, then Vim won't become the owner of the
3278 windowing system's global selection unless explicitly told to
3279 by a yank or delete operation for the "* register.
3280 The same applies to the modeless selection.
3281
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003282 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 applies to the modeless selection.
3284
3285 'guioptions' autoselect Visual autoselect modeless ~
3286 "" - -
3287 "a" yes yes
3288 "A" - yes
3289 "aA" yes yes
3290
3291 'c' Use console dialogs instead of popup dialogs for simple
3292 choices.
3293
3294 'f' Foreground: Don't use fork() to detach the GUI from the shell
3295 where it was started. Use this for programs that wait for the
3296 editor to finish (e.g., an e-mail program). Alternatively you
3297 can use "gvim -f" or ":gui -f" to start the GUI in the
3298 foreground. |gui-fork|
3299 Note: Set this option in the vimrc file. The forking may have
3300 happened already when the gvimrc file is read.
3301
3302 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3303 corner of the window. It's black&white on non-GTK, because of
3304 limitations of X11. For a color icon, see |X11-icon|.
3305
3306 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003307 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 that this flag must be added in the .vimrc file, before
3309 switching on syntax or filetype recognition (when the .gvimrc
3310 file is sourced the system menu has already been loaded; the
3311 ":syntax on" and ":filetype on" commands load the menu too).
3312 'g' Grey menu items: Make menu items that are not active grey. If
3313 'g' is not included inactive menu items are not shown at all.
3314 Exception: Athena will always use grey menu items.
3315
3316 't' Include tearoff menu items. Currently only works for Win32,
3317 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003318 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3319 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320
3321 'r' Right-hand scrollbar is always present.
3322 'R' Right-hand scrollbar is present when there is a vertically
3323 split window.
3324 'l' Left-hand scrollbar is always present.
3325 'L' Left-hand scrollbar is present when there is a vertically
3326 split window.
3327 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3328 the longest visible line, or on the cursor line if the 'h'
3329 flag is included. |gui-horiz-scroll|
3330 'h' Limit horizontal scrollbar size to the length of the cursor
3331 line. Reduces computations. |gui-horiz-scroll|
3332
3333 And yes, you may even have scrollbars on the left AND the right if
3334 you really want to :-). See |gui-scrollbars| for more information.
3335
3336 'v' Use a vertical button layout for dialogs. When not included,
3337 a horizontal layout is preferred, but when it doesn't fit a
3338 vertical layout is used anyway.
3339 'p' Use Pointer callbacks for X11 GUI. This is required for some
3340 window managers. If the cursor is not blinking or hollow at
3341 the right moment, try adding this flag. This must be done
3342 before starting the GUI. Set it in your gvimrc. Adding or
3343 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003344 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345
3346 *'guipty'* *'noguipty'*
3347'guipty' boolean (default on)
3348 global
3349 {not in Vi}
3350 {only available when compiled with GUI enabled}
3351 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3352 I/O to/from shell commands. See |gui-pty|.
3353
3354 *'helpfile'* *'hf'*
3355'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3356 (others) "$VIMRUNTIME/doc/help.txt")
3357 global
3358 {not in Vi}
3359 Name of the main help file. All distributed help files should be
3360 placed together in one directory. Additionally, all "doc" directories
3361 in 'runtimepath' will be used.
3362 Environment variables are expanded |:set_env|. For example:
3363 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003364 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 spaces and backslashes.
3366 This option cannot be set from a |modeline| or in the |sandbox|, for
3367 security reasons.
3368
3369 *'helpheight'* *'hh'*
3370'helpheight' 'hh' number (default 20)
3371 global
3372 {not in Vi}
3373 {not available when compiled without the +windows
3374 feature}
3375 Minimal initial height of the help window when it is opened with the
3376 ":help" command. The initial height of the help window is half of the
3377 current window, or (when the 'ea' option is on) the same as other
3378 windows. When the height is less than 'helpheight', the height is
3379 set to 'helpheight'. Set to zero to disable.
3380
3381 *'helplang'* *'hlg'*
3382'helplang' 'hlg' string (default: messages language or empty)
3383 global
3384 {only available when compiled with the |+multi_lang|
3385 feature}
3386 {not in Vi}
3387 Comma separated list of languages. Vim will use the first language
3388 for which the desired help can be found. The English help will always
3389 be used as a last resort. You can add "en" to prefer English over
3390 another language, but that will only find tags that exist in that
3391 language and not in the English help.
3392 Example: >
3393 :set helplang=de,it
3394< This will first search German, then Italian and finally English help
3395 files.
3396 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3397 try to find the tag in the current language before using this option.
3398 See |help-translated|.
3399
3400 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3401'hidden' 'hid' boolean (default off)
3402 global
3403 {not in Vi}
3404 When off a buffer is unloaded when it is |abandon|ed. When on a
3405 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3406 displayed in another window, it does not become hidden, of course.
3407 The commands that move through the buffer list sometimes make a buffer
3408 hidden although the 'hidden' option is off: When the buffer is
3409 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003410 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003411 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 This option is set for one command with ":hide {command}" |:hide|.
3413 WARNING: It's easy to forget that you have changes in hidden buffers.
3414 Think twice when using ":q!" or ":qa!".
3415
3416 *'highlight'* *'hl'*
3417'highlight' 'hl' string (default (as a single string):
3418 "8:SpecialKey,@:NonText,d:Directory,
3419 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3420 M:ModeMsg,n:LineNr,r:Question,
3421 s:StatusLine,S:StatusLineNC,c:VertSplit
3422 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3423 f:Folded,F:FoldColumn,A:DiffAdd,
3424 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003425 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003426 R:SpellRare,L:SpellLocal,
3427 +:Pmenu,=:PmenuSel,
3428 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 global
3430 {not in Vi}
3431 This option can be used to set highlighting mode for various
3432 occasions. It is a comma separated list of character pairs. The
3433 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003434 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3436 |hl-NonText| @ '~' and '@' at the end of the window and
3437 characters from 'showbreak'
3438 |hl-Directory| d directories in CTRL-D listing and other special
3439 things in listings
3440 |hl-ErrorMsg| e error messages
3441 h (obsolete, ignored)
3442 |hl-IncSearch| i 'incsearch' highlighting
3443 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3444 |hl-MoreMsg| m |more-prompt|
3445 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3446 |hl-LineNr| n line number for ":number" and ":#" commands
3447 |hl-Question| r |hit-enter| prompt and yes/no questions
3448 |hl-StatusLine| s status line of current window |status-line|
3449 |hl-StatusLineNC| S status lines of not-current windows
3450 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3451 |hl-VertSplit| c column used to separate vertically split windows
3452 |hl-Visual| v Visual mode
3453 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3454 Selection" Only X11 Gui's |gui-x11| and
3455 |xterm-clipboard|.
3456 |hl-WarningMsg| w warning messages
3457 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3458 |hl-Folded| f line used for closed folds
3459 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003460 |hl-DiffAdd| A added line in diff mode
3461 |hl-DiffChange| C changed line in diff mode
3462 |hl-DiffDelete| D deleted line in diff mode
3463 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003465 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003466 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003467 |hl-SpellRare| R rare word |spell|
3468 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003469 |hl-Pmenu| + popup menu normal line
3470 |hl-PmenuSel| = popup menu normal line
3471 |hl-PmenuSbar| x popup menu scrollbar
3472 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473
3474 The display modes are:
3475 r reverse (termcap entry "mr" and "me")
3476 i italic (termcap entry "ZH" and "ZR")
3477 b bold (termcap entry "md" and "me")
3478 s standout (termcap entry "so" and "se")
3479 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003480 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 n no highlighting
3482 - no highlighting
3483 : use a highlight group
3484 The default is used for occasions that are not included.
3485 If you want to change what the display modes do, see |dos-colors|
3486 for an example.
3487 When using the ':' display mode, this must be followed by the name of
3488 a highlight group. A highlight group can be used to define any type
3489 of highlighting, including using color. See |:highlight| on how to
3490 define one. The default uses a different group for each occasion.
3491 See |highlight-default| for the default highlight groups.
3492
3493 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3494'hlsearch' 'hls' boolean (default off)
3495 global
3496 {not in Vi}
3497 {not available when compiled without the
3498 |+extra_search| feature}
3499 When there is a previous search pattern, highlight all its matches.
3500 The type of highlighting used can be set with the 'l' occasion in the
3501 'highlight' option. This uses the "Search" highlight group by
3502 default. Note that only the matching text is highlighted, any offsets
3503 are not applied.
3504 See also: 'incsearch' and |:match|.
3505 When you get bored looking at the highlighted matches, you can turn it
3506 off with |:nohlsearch|. As soon as you use a search command, the
3507 highlighting comes back.
3508 When the search pattern can match an end-of-line, Vim will try to
3509 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003510 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 line below a closed fold. A match in a previous line which is not
3512 drawn may not continue in an newly drawn line.
3513 NOTE: This option is reset when 'compatible' is set.
3514
3515 *'history'* *'hi'*
3516'history' 'hi' number (Vim default: 20, Vi default: 0)
3517 global
3518 {not in Vi}
3519 A history of ":" commands, and a history of previous search patterns
3520 are remembered. This option decides how many entries may be stored in
3521 each of these histories (see |cmdline-editing|).
3522 NOTE: This option is set to the Vi default value when 'compatible' is
3523 set and to the Vim default value when 'compatible' is reset.
3524
3525 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3526'hkmap' 'hk' boolean (default off)
3527 global
3528 {not in Vi}
3529 {only available when compiled with the |+rightleft|
3530 feature}
3531 When on, the keyboard is mapped for the Hebrew character set.
3532 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3533 toggle this option. See |rileft.txt|.
3534 NOTE: This option is reset when 'compatible' is set.
3535
3536 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3537'hkmapp' 'hkp' boolean (default off)
3538 global
3539 {not in Vi}
3540 {only available when compiled with the |+rightleft|
3541 feature}
3542 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3543 This is useful if you have a non-Hebrew keyboard.
3544 See |rileft.txt|.
3545 NOTE: This option is reset when 'compatible' is set.
3546
3547 *'icon'* *'noicon'*
3548'icon' boolean (default off, on when title can be restored)
3549 global
3550 {not in Vi}
3551 {not available when compiled without the |+title|
3552 feature}
3553 When on, the icon text of the window will be set to the value of
3554 'iconstring' (if it is not empty), or to the name of the file
3555 currently being edited. Only the last part of the name is used.
3556 Overridden by the 'iconstring' option.
3557 Only works if the terminal supports setting window icons (currently
3558 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3559 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3560 builtin termcap).
3561 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003562 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 X11.
3564
3565 *'iconstring'*
3566'iconstring' string (default "")
3567 global
3568 {not in Vi}
3569 {not available when compiled without the |+title|
3570 feature}
3571 When this option is not empty, it will be used for the icon text of
3572 the window. This happens only when the 'icon' option is on.
3573 Only works if the terminal supports setting window icon text
3574 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3575 Does not work for MS Windows.
3576 When Vim was compiled with HAVE_X11 defined, the original icon will be
3577 restored if possible |X11|.
3578 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003579 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 'titlestring' for example settings.
3581 {not available when compiled without the |+statusline| feature}
3582
3583 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3584'ignorecase' 'ic' boolean (default off)
3585 global
3586 Ignore case in search patterns. Also used when searching in the tags
3587 file.
3588 Also see 'smartcase'.
3589 Can be overruled by using "\c" or "\C" in the pattern, see
3590 |/ignorecase|.
3591
3592 *'imactivatekey'* *'imak'*
3593'imactivatekey' 'imak' string (default "")
3594 global
3595 {not in Vi}
3596 {only available when compiled with |+xim| and
3597 |+GUI_GTK|}
3598 Specifies the key that your Input Method in X-Windows uses for
3599 activation. When this is specified correctly, vim can fully control
3600 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3601 You can't use this option to change the activation key, the option
3602 tells Vim what the key is.
3603 Format:
3604 [MODIFIER_FLAG-]KEY_STRING
3605
3606 These characters can be used for MODIFIER_FLAG (case is ignored):
3607 S Shift key
3608 L Lock key
3609 C Control key
3610 1 Mod1 key
3611 2 Mod2 key
3612 3 Mod3 key
3613 4 Mod4 key
3614 5 Mod5 key
3615 Combinations are allowed, for example "S-C-space" or "SC-space" are
3616 both shift+ctrl+space.
3617 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3618
3619 Example: >
3620 :set imactivatekey=S-space
3621< "S-space" means shift+space. This is the activation key for kinput2 +
3622 canna (Japanese), and ami (Korean).
3623
3624 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3625'imcmdline' 'imc' boolean (default off)
3626 global
3627 {not in Vi}
3628 {only available when compiled with the |+xim|
3629 |+multi_byte_ime| or |global-ime| feature}
3630 When set the Input Method is always on when starting to edit a command
3631 line, unless entering a search pattern (see 'imsearch' for that).
3632 Setting this option is useful when your input method allows entering
3633 English characters directly, e.g., when it's used to type accented
3634 characters with dead keys.
3635
3636 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3637'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3638 global
3639 {not in Vi}
3640 {only available when compiled with the |+xim|
3641 |+multi_byte_ime| or |global-ime| feature}
3642 When set the Input Method is never used. This is useful to disable
3643 the IM when it doesn't work properly.
3644 Currently this option is on by default for SGI/IRIX machines. This
3645 may change in later releases.
3646
3647 *'iminsert'* *'imi'*
3648'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3649 local to buffer
3650 {not in Vi}
3651 Specifies whether :lmap or an Input Method (IM) is to be used in
3652 Insert mode. Valid values:
3653 0 :lmap is off and IM is off
3654 1 :lmap is ON and IM is off
3655 2 :lmap is off and IM is ON
3656 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3657 or |global-ime|.
3658 To always reset the option to zero when leaving Insert mode with <Esc>
3659 this can be used: >
3660 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3661< This makes :lmap and IM turn off automatically when leaving Insert
3662 mode.
3663 Note that this option changes when using CTRL-^ in Insert mode
3664 |i_CTRL-^|.
3665 The value is set to 1 when setting 'keymap' to a valid keymap name.
3666 It is also used for the argument of commands like "r" and "f".
3667 The value 0 may not work correctly with Athena and Motif with some XIM
3668 methods. Use 'imdisable' to disable XIM then.
3669
3670 *'imsearch'* *'ims'*
3671'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3672 local to buffer
3673 {not in Vi}
3674 Specifies whether :lmap or an Input Method (IM) is to be used when
3675 entering a search pattern. Valid values:
3676 -1 the value of 'iminsert' is used, makes it look like
3677 'iminsert' is also used when typing a search pattern
3678 0 :lmap is off and IM is off
3679 1 :lmap is ON and IM is off
3680 2 :lmap is off and IM is ON
3681 Note that this option changes when using CTRL-^ in Command-line mode
3682 |c_CTRL-^|.
3683 The value is set to 1 when it is not -1 and setting the 'keymap'
3684 option to a valid keymap name.
3685 The value 0 may not work correctly with Athena and Motif with some XIM
3686 methods. Use 'imdisable' to disable XIM then.
3687
3688 *'include'* *'inc'*
3689'include' 'inc' string (default "^\s*#\s*include")
3690 global or local to buffer |global-local|
3691 {not in Vi}
3692 {not available when compiled without the
3693 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003694 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 pattern, just like for the "/" command (See |pattern|). The default
3696 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003697 "]I", "[d", etc.
3698 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003699 comes after the matched pattern. But if "\zs" appears in the pattern
3700 then the text matched from "\zs" to the end, or until "\ze" if it
3701 appears, is used as the file name. Use this to include characters
3702 that are not in 'isfname', such as a space. You can then use
3703 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003704 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705
3706 *'includeexpr'* *'inex'*
3707'includeexpr' 'inex' string (default "")
3708 local to buffer
3709 {not in Vi}
3710 {not available when compiled without the
3711 |+find_in_path| or |+eval| feature}
3712 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003713 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 :set includeexpr=substitute(v:fname,'\\.','/','g')
3715< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003716
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003718 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 Also used for |<cfile>|.
3720
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003721 The expression may be evaluated in the |sandbox|, see
3722 |sandbox-option|.
3723
3724 It is not allowed to change text or jump to another window while
3725 evaluating 'includeexpr' |textlock|.
3726
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3728'incsearch' 'is' boolean (default off)
3729 global
3730 {not in Vi}
3731 {not available when compiled without the
3732 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003733 While typing a search command, show where the pattern, as it was typed
3734 so far, matches. The matched string is highlighted. If the pattern
3735 is invalid or not found, nothing is shown. The screen will be updated
3736 often, this is only useful on fast terminals.
3737 Note that the match will be shown, but the cursor will return to its
3738 original position when no match is found and when pressing <Esc>. You
3739 still need to finish the search command with <Enter> to move the
3740 cursor to the match.
3741 The highlighting can be set with the 'i' flag in 'highlight'.
3742 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 NOTE: This option is reset when 'compatible' is set.
3744
3745 *'indentexpr'* *'inde'*
3746'indentexpr' 'inde' string (default "")
3747 local to buffer
3748 {not in Vi}
3749 {not available when compiled without the |+cindent|
3750 or |+eval| features}
3751 Expression which is evaluated to obtain the proper indent for a line.
3752 It is used when a new line is created, for the |=| operator and
3753 in Insert mode as specified with the 'indentkeys' option.
3754 When this option is not empty, it overrules the 'cindent' and
3755 'smartindent' indenting.
3756 When 'paste' is set this option is not used for indenting.
3757 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003758 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 when the expression is evaluated (but it may be moved around).
3760 The expression must return the number of spaces worth of indent. It
3761 can return "-1" to keep the current indent (this means 'autoindent' is
3762 used for the indent).
3763 Functions useful for computing the indent are |indent()|, |cindent()|
3764 and |lispindent()|.
3765 The evaluation of the expression must not have side effects! It must
3766 not change the text, jump to another window, etc. Afterwards the
3767 cursor position is always restored, thus the cursor may be moved.
3768 Normally this option would be set to call a function: >
3769 :set indentexpr=GetMyIndent()
3770< Error messages will be suppressed, unless the 'debug' option contains
3771 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003772 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 NOTE: This option is made empty when 'compatible' is set.
3774
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003775 The expression may be evaluated in the |sandbox|, see
3776 |sandbox-option|.
3777
3778 It is not allowed to change text or jump to another window while
3779 evaluating 'indentexpr' |textlock|.
3780
3781
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 *'indentkeys'* *'indk'*
3783'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3784 local to buffer
3785 {not in Vi}
3786 {not available when compiled without the |+cindent|
3787 feature}
3788 A list of keys that, when typed in Insert mode, cause reindenting of
3789 the current line. Only happens if 'indentexpr' isn't empty.
3790 The format is identical to 'cinkeys', see |indentkeys-format|.
3791 See |C-indenting| and |indent-expression|.
3792
3793 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3794'infercase' 'inf' boolean (default off)
3795 local to buffer
3796 {not in Vi}
3797 When doing keyword completion in insert mode |ins-completion|, and
3798 'ignorecase' is also on, the case of the match is adjusted. If the
3799 typed text contains a lowercase letter where the match has an upper
3800 case letter, the completed part is made lowercase. If the typed text
3801 has no lowercase letters and the match has a lowercase letter where
3802 the typed text has an uppercase letter, and there is a letter before
3803 it, the completed part is made uppercase.
3804
3805 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3806'insertmode' 'im' boolean (default off)
3807 global
3808 {not in Vi}
3809 Makes Vim work in a way that Insert mode is the default mode. Useful
3810 if you want to use Vim as a modeless editor. Used for |evim|.
3811 These Insert mode commands will be useful:
3812 - Use the cursor keys to move around.
3813 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3814 this is a mapping, it is executed as if 'insertmode' was off.
3815 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003817 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3818 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819
3820 These items change when 'insertmode' is set:
3821 - when starting to edit of a file, Vim goes to Insert mode.
3822 - <Esc> in Insert mode is a no-op and beeps.
3823 - <Esc> in Normal mode makes Vim go to Insert mode.
3824 - CTRL-L in Insert mode is a command, it is not inserted.
3825 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3826 However, when <Esc> is used inside a mapping, it behaves like
3827 'insertmode' was not set. This was done to be able to use the same
3828 mappings with 'insertmode' set or not set.
3829 When executing commands with |:normal| 'insertmode' is not used.
3830
3831 NOTE: This option is reset when 'compatible' is set.
3832
3833 *'isfname'* *'isf'*
3834'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3835 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3836 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3837 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3838 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3839 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3840 global
3841 {not in Vi}
3842 The characters specified by this option are included in file names and
3843 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003844 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003845 Multi-byte characters 256 and above are always included, only the
3846 characters up to 255 are specified with this option.
3847 For UTF-8 the characters 0xa0 to 0xff are included as well.
3848
3849 Note that on systems using a backslash as path separator, Vim tries to
3850 do its best to make it work as you would expect. That is a bit
3851 tricky, since Vi originally used the backslash to escape special
3852 characters. Vim will not remove a backslash in front of a normal file
3853 name character on these systems, but it will on Unix and alikes. The
3854 '&' and '^' are not included by default, because these are special for
3855 cmd.exe.
3856
3857 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003858 Each part can be a single character number or a range. A range is two
3859 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 decimal number between 0 and 255 or the ASCII character itself (does
3861 not work for digits). Example:
3862 "_,-,128-140,#-43" (include '_' and '-' and the range
3863 128 to 140 and '#' to 43)
3864 If a part starts with '^', the following character number or range
3865 will be excluded from the option. The option is interpreted from left
3866 to right. Put the excluded character after the range where it is
3867 included. To include '^' itself use it as the last character of the
3868 option or the end of a range. Example:
3869 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3870 If the character is '@', all characters where isalpha() returns TRUE
3871 are included. Normally these are the characters a to z and A to Z,
3872 plus accented characters. To include '@' itself use "@-@". Examples:
3873 "@,^a-z" All alphabetic characters, excluding lower
3874 case letters.
3875 "a-z,A-Z,@-@" All letters plus the '@' character.
3876 A comma can be included by using it where a character number is
3877 expected. Example:
3878 "48-57,,,_" Digits, comma and underscore.
3879 A comma can be excluded by prepending a '^'. Example:
3880 " -~,^,,9" All characters from space to '~', excluding
3881 comma, plus <Tab>.
3882 See |option-backslash| about including spaces and backslashes.
3883
3884 *'isident'* *'isi'*
3885'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3886 "@,48-57,_,128-167,224-235"
3887 otherwise: "@,48-57,_,192-255")
3888 global
3889 {not in Vi}
3890 The characters given by this option are included in identifiers.
3891 Identifiers are used in recognizing environment variables and after a
3892 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003893 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 option.
3895 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003896 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3898
3899 *'iskeyword'* *'isk'*
3900'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3901 "@,48-57,_,128-167,224-235"
3902 otherwise: "@,48-57,_,192-255"
3903 Vi default: "@,48-57,_")
3904 local to buffer
3905 {not in Vi}
3906 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003907 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 'isfname' for a description of the format of this option. For C
3909 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3910 For a help file it is set to all non-blank printable characters except
3911 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3912 command).
3913 When the 'lisp' option is on the '-' character is always included.
3914 NOTE: This option is set to the Vi default value when 'compatible' is
3915 set and to the Vim default value when 'compatible' is reset.
3916
3917 *'isprint'* *'isp'*
3918'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3919 "@,~-255"; otherwise: "@,161-255")
3920 global
3921 {not in Vi}
3922 The characters given by this option are displayed directly on the
3923 screen. It is also used for "\p" in a |pattern|. The characters from
3924 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3925 even when they are not included in 'isprint' or excluded. See
3926 'isfname' for a description of the format of this option.
3927
3928 Non-printable characters are displayed with two characters:
3929 0 - 31 "^@" - "^_"
3930 32 - 126 always single characters
3931 127 "^?"
3932 128 - 159 "~@" - "~_"
3933 160 - 254 "| " - "|~"
3934 255 "~?"
3935 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3936 displayed as <xx>, with the hexadecimal value of the byte.
3937 When 'display' contains "uhex" all unprintable characters are
3938 displayed as <xx>.
3939 The NonText highlighting will be used for unprintable characters.
3940 |hl-NonText|
3941
3942 Multi-byte characters 256 and above are always included, only the
3943 characters up to 255 are specified with this option. When a character
3944 is printable but it is not available in the current font, a
3945 replacement character will be shown.
3946 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3947 There is no option to specify these characters.
3948
3949 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3950'joinspaces' 'js' boolean (default on)
3951 global
3952 {not in Vi}
3953 Insert two spaces after a '.', '?' and '!' with a join command.
3954 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3955 Otherwise only one space is inserted.
3956 NOTE: This option is set when 'compatible' is set.
3957
3958 *'key'*
3959'key' string (default "")
3960 local to buffer
3961 {not in Vi}
3962 The key that is used for encrypting and decrypting the current buffer.
3963 See |encryption|.
3964 Careful: Do not set the key value by hand, someone might see the typed
3965 key. Use the |:X| command. But you can make 'key' empty: >
3966 :set key=
3967< It is not possible to get the value of this option with ":set key" or
3968 "echo &key". This is to avoid showing it to someone who shouldn't
3969 know. It also means you cannot see it yourself once you have set it,
3970 be careful not to make a typing error!
3971
3972 *'keymap'* *'kmp'* *E544*
3973'keymap' 'kmp' string (default "")
3974 local to buffer
3975 {not in Vi}
3976 {only available when compiled with the |+keymap|
3977 feature}
3978 Name of a keyboard mapping. See |mbyte-keymap|.
3979 Setting this option to a valid keymap name has the side effect of
3980 setting 'iminsert' to one, so that the keymap becomes effective.
3981 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003982 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983
3984 *'keymodel'* *'km'*
3985'keymodel' 'km' string (default "")
3986 global
3987 {not in Vi}
3988 List of comma separated words, which enable special things that keys
3989 can do. These values can be used:
3990 startsel Using a shifted special key starts selection (either
3991 Select mode or Visual mode, depending on "key" being
3992 present in 'selectmode').
3993 stopsel Using a not-shifted special key stops selection.
3994 Special keys in this context are the cursor keys, <End>, <Home>,
3995 <PageUp> and <PageDown>.
3996 The 'keymodel' option is set by the |:behave| command.
3997
3998 *'keywordprg'* *'kp'*
3999'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4000 OS/2: "view /", VMS: "help")
4001 global or local to buffer |global-local|
4002 {not in Vi}
4003 Program to use for the |K| command. Environment variables are
4004 expanded |:set_env|. ":help" may be used to access the Vim internal
4005 help. (Note that previously setting the global option to the empty
4006 value did this, which is now deprecated.)
4007 When "man" is used, Vim will automatically translate a count for the
4008 "K" command to a section number. Also for "man -s", in which case the
4009 "-s" is removed when there is no count.
4010 See |option-backslash| about including spaces and backslashes.
4011 Example: >
4012 :set keywordprg=man\ -s
4013< This option cannot be set from a |modeline| or in the |sandbox|, for
4014 security reasons.
4015
4016 *'langmap'* *'lmap'* *E357* *E358*
4017'langmap' 'lmap' string (default "")
4018 global
4019 {not in Vi}
4020 {only available when compiled with the |+langmap|
4021 feature}
4022 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 inserted directly. When in command mode the 'langmap' option takes
4025 care of translating these special characters to the original meaning
4026 of the key. This means you don't have to change the keyboard mode to
4027 be able to execute Normal mode commands.
4028 This is the opposite of the 'keymap' option, where characters are
4029 mapped in Insert mode.
4030 This only works for 8-bit characters. The value of 'langmap' may be
4031 specified with multi-byte characters (e.g., UTF-8), but only the lower
4032 8 bits of each character will be used.
4033
4034 Example (for Greek): *greek* >
4035 :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
4036< Example (exchanges meaning of z and y for commands): >
4037 :set langmap=zy,yz,ZY,YZ
4038<
4039 The 'langmap' option is a list of parts, separated with commas. Each
4040 part can be in one of two forms:
4041 1. A list of pairs. Each pair is a "from" character immediately
4042 followed by the "to" character. Examples: "aA", "aAbBcC".
4043 2. A list of "from" characters, a semi-colon and a list of "to"
4044 characters. Example: "abc;ABC"
4045 Example: "aA,fgh;FGH,cCdDeE"
4046 Special characters need to be preceded with a backslash. These are
4047 ";", ',' and backslash itself.
4048
4049 This will allow you to activate vim actions without having to switch
4050 back and forth between the languages. Your language characters will
4051 be understood as normal vim English characters (according to the
4052 langmap mappings) in the following cases:
4053 o Normal/Visual mode (commands, buffer/register names, user mappings)
4054 o Insert/Replace Mode: Register names after CTRL-R
4055 o Insert/Replace Mode: Mappings
4056 Characters entered in Command-line mode will NOT be affected by
4057 this option. Note that this option can be changed at any time
4058 allowing to switch between mappings for different languages/encodings.
4059 Use a mapping to avoid having to type it each time!
4060
4061 *'langmenu'* *'lm'*
4062'langmenu' 'lm' string (default "")
4063 global
4064 {not in Vi}
4065 {only available when compiled with the |+menu| and
4066 |+multi_lang| features}
4067 Language to use for menu translation. Tells which file is loaded
4068 from the "lang" directory in 'runtimepath': >
4069 "lang/menu_" . &langmenu . ".vim"
4070< (without the spaces). For example, to always use the Dutch menus, no
4071 matter what $LANG is set to: >
4072 :set langmenu=nl_NL.ISO_8859-1
4073< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004074 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 If your $LANG is set to a non-English language but you do want to use
4076 the English menus: >
4077 :set langmenu=none
4078< This option must be set before loading menus, switching on filetype
4079 detection or syntax highlighting. Once the menus are defined setting
4080 this option has no effect. But you could do this: >
4081 :source $VIMRUNTIME/delmenu.vim
4082 :set langmenu=de_DE.ISO_8859-1
4083 :source $VIMRUNTIME/menu.vim
4084< Warning: This deletes all menus that you defined yourself!
4085
4086 *'laststatus'* *'ls'*
4087'laststatus' 'ls' number (default 1)
4088 global
4089 {not in Vi}
4090 The value of this option influences when the last window will have a
4091 status line:
4092 0: never
4093 1: only if there are at least two windows
4094 2: always
4095 The screen looks nicer with a status line if you have several
4096 windows, but it takes another screen line. |status-line|
4097
4098 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4099'lazyredraw' 'lz' boolean (default off)
4100 global
4101 {not in Vi}
4102 When this option is set, the screen will not be redrawn while
4103 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004104 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 update use |:redraw|.
4106
4107 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4108'linebreak' 'lbr' boolean (default off)
4109 local to window
4110 {not in Vi}
4111 {not available when compiled without the |+linebreak|
4112 feature}
4113 If on Vim will wrap long lines at a character in 'breakat' rather
4114 than at the last character that fits on the screen. Unlike
4115 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4116 it only affects the way the file is displayed, not its contents. The
4117 value of 'showbreak' is used to put in front of wrapped lines.
4118 This option is not used when the 'wrap' option is off or 'list' is on.
4119 Note that <Tab> characters after an <EOL> are mostly not displayed
4120 with the right amount of white space.
4121
4122 *'lines'* *E593*
4123'lines' number (default 24 or terminal height)
4124 global
4125 Number of lines of the Vim window.
4126 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004127 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 When Vim is running in the GUI or in a resizable window, setting this
4129 option will cause the window size to be changed. When you only want
4130 to use the size for the GUI, put the command in your |gvimrc| file.
4131 Vim limits the number of lines to what fits on the screen. You can
4132 use this command to get the tallest window possible: >
4133 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004134< Minimum value is 2, maximum value is 1000.
4135 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 When you set this option and Vim is unable to change the physical
4137 number of lines of the display, the display may be messed up.
4138
4139 *'linespace'* *'lsp'*
4140'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4141 global
4142 {not in Vi}
4143 {only in the GUI}
4144 Number of pixel lines inserted between characters. Useful if the font
4145 uses the full character cell height, making lines touch each other.
4146 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004147 With some fonts there can be too much room between lines (to have
4148 space for ascents and descents). Then it makes sense to set
4149 'linespace' to a negative value. This may cause display problems
4150 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152 *'lisp'* *'nolisp'*
4153'lisp' boolean (default off)
4154 local to buffer
4155 {not available when compiled without the |+lispindent|
4156 feature}
4157 Lisp mode: When <Enter> is typed in insert mode set the indent for
4158 the next line to Lisp standards (well, sort of). Also happens with
4159 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4160 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4161 better. Also see 'lispwords'.
4162 The '-' character is included in keyword characters. Redefines the
4163 "=" operator to use this same indentation algorithm rather than
4164 calling an external program if 'equalprg' is empty.
4165 This option is not used when 'paste' is set.
4166 {Vi: Does it a little bit differently}
4167
4168 *'lispwords'* *'lw'*
4169'lispwords' 'lw' string (default is very long)
4170 global
4171 {not in Vi}
4172 {not available when compiled without the |+lispindent|
4173 feature}
4174 Comma separated list of words that influence the Lisp indenting.
4175 |'lisp'|
4176
4177 *'list'* *'nolist'*
4178'list' boolean (default off)
4179 local to window
4180 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4181 see the difference between tabs and spaces and for trailing blanks.
4182 Note that this will also affect formatting (set with 'textwidth' or
4183 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4184 changing the way tabs are displayed.
4185
4186 *'listchars'* *'lcs'*
4187'listchars' 'lcs' string (default "eol:$")
4188 global
4189 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 settings.
4192 eol:c Character to show at the end of each line. When
4193 omitted, there is no extra character at the end of the
4194 line.
4195 tab:xy Two characters to be used to show a Tab. The first
4196 char is used once. The second char is repeated to
4197 fill the space that the Tab normally occupies.
4198 "tab:>-" will show a Tab that takes four spaces as
4199 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004200 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201 trailing spaces are blank.
4202 extends:c Character to show in the last column, when 'wrap' is
4203 off and the line continues beyond the right of the
4204 screen.
4205 precedes:c Character to show in the first column, when 'wrap'
4206 is off and there is text preceding the character
4207 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004208 nbsp:c Character to show for a non-breakable space (character
4209 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004211 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 be used when 'encoding' is "utf-8", otherwise only printable
4213 characters are allowed.
4214
4215 Examples: >
4216 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004217 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 :set lcs=extends:>,precedes:<
4219< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004220 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
4222 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4223'loadplugins' 'lpl' boolean (default on)
4224 global
4225 {not in Vi}
4226 When on the plugin scripts are loaded when starting up |load-plugins|.
4227 This option can be reset in your |vimrc| file to disable the loading
4228 of plugins.
4229 Note that using the "-u NONE" and "--noplugin" command line arguments
4230 reset this option. |-u| |--noplugin|
4231
4232 *'magic'* *'nomagic'*
4233'magic' boolean (default on)
4234 global
4235 Changes the special characters that can be used in search patterns.
4236 See |pattern|.
4237 NOTE: To avoid portability problems with using patterns, always keep
4238 this option at the default "on". Only switch it off when working with
4239 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004240 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241
4242 *'makeef'* *'mef'*
4243'makeef' 'mef' string (default: "")
4244 global
4245 {not in Vi}
4246 {not available when compiled without the |+quickfix|
4247 feature}
4248 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4249 and the |:grep| command.
4250 When it is empty, an internally generated temp file will be used.
4251 When "##" is included, it is replaced by a number to make the name
4252 unique. This makes sure that the ":make" command doesn't overwrite an
4253 existing file.
4254 NOT used for the ":cf" command. See 'errorfile' for that.
4255 Environment variables are expanded |:set_env|.
4256 See |option-backslash| about including spaces and backslashes.
4257 This option cannot be set from a |modeline| or in the |sandbox|, for
4258 security reasons.
4259
4260 *'makeprg'* *'mp'*
4261'makeprg' 'mp' string (default "make", VMS: "MMS")
4262 global or local to buffer |global-local|
4263 {not in Vi}
4264 Program to use for the ":make" command. See |:make_makeprg|. This
4265 option may contain '%' and '#' characters, which are expanded like
4266 when used in a command-line. Environment variables are expanded
4267 |:set_env|. See |option-backslash| about including spaces and
4268 backslashes. Note that a '|' must be escaped twice: once for ":set"
4269 and once for the interpretation of a command. When you use a filter
4270 called "myfilter" do it like this: >
4271 :set makeprg=gmake\ \\\|\ myfilter
4272< The placeholder "$*" can be given (even multiple times) to specify
4273 where the arguments will be included, for example: >
4274 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4275< This option cannot be set from a |modeline| or in the |sandbox|, for
4276 security reasons.
4277
4278 *'matchpairs'* *'mps'*
4279'matchpairs' 'mps' string (default "(:),{:},[:]")
4280 local to buffer
4281 {not in Vi}
4282 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004283 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284 must be different. The characters must be separated by a colon. The
4285 pairs must be separated by a comma. Example for including '<' and '>'
4286 (HTML): >
4287 :set mps+=<:>
4288
4289< A more exotic example, to jump between the '=' and ';' in an
4290 assignment, useful for languages like C and Java: >
4291 :au FileType c,cpp,java set mps+==:;
4292
4293< For a more advanced way of using "%", see the matchit.vim plugin in
4294 the $VIMRUNTIME/macros directory. |add-local-help|
4295
4296 *'matchtime'* *'mat'*
4297'matchtime' 'mat' number (default 5)
4298 global
4299 {not in Vi}{in Nvi}
4300 Tenths of a second to show the matching paren, when 'showmatch' is
4301 set. Note that this is not in milliseconds, like other options that
4302 set a time. This is to be compatible with Nvi.
4303
4304 *'maxfuncdepth'* *'mfd'*
4305'maxfuncdepth' 'mfd' number (default 100)
4306 global
4307 {not in Vi}
4308 Maximum depth of function calls for user functions. This normally
4309 catches endless recursion. When using a recursive function with
4310 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4311 more memory, there is the danger of failing when memory is exhausted.
4312 See also |:function|.
4313
4314 *'maxmapdepth'* *'mmd'* *E223*
4315'maxmapdepth' 'mmd' number (default 1000)
4316 global
4317 {not in Vi}
4318 Maximum number of times a mapping is done without resulting in a
4319 character to be used. This normally catches endless mappings, like
4320 ":map x y" with ":map y x". It still does not catch ":map g wg",
4321 because the 'w' is used before the next mapping is done. See also
4322 |key-mapping|.
4323
4324 *'maxmem'* *'mm'*
4325'maxmem' 'mm' number (default between 256 to 5120 (system
4326 dependent) or half the amount of memory
4327 available)
4328 global
4329 {not in Vi}
4330 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4331 limit is reached allocating extra memory for a buffer will cause
4332 other memory to be freed. Maximum value 2000000. Use this to work
4333 without a limit. Also see 'maxmemtot'.
4334
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004335 *'maxmempattern'* *'mmp'*
4336'maxmempattern' 'mmp' number (default 1000)
4337 global
4338 {not in Vi}
4339 Maximum amount of memory (in Kbyte) to use for pattern matching.
4340 Maximum value 2000000. Use this to work without a limit.
4341 *E363*
4342 When Vim runs into the limit it gives an error message mostly behaves
4343 like CTRL-C was typed.
4344 Running into the limit often means that the pattern is very
4345 inefficient or too complex. This may already happen with the pattern
4346 "\(.\)*" on a very long line. ".*" works much better.
4347 Vim may run out of memory before hitting the 'maxmempattern' limit.
4348
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 *'maxmemtot'* *'mmt'*
4350'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4351 dependent) or half the amount of memory
4352 available)
4353 global
4354 {not in Vi}
4355 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004356 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 'maxmem'.
4358
4359 *'menuitems'* *'mis'*
4360'menuitems' 'mis' number (default 25)
4361 global
4362 {not in Vi}
4363 {not available when compiled without the |+menu|
4364 feature}
4365 Maximum number of items to use in a menu. Used for menus that are
4366 generated from a list of items, e.g., the Buffers menu. Changing this
4367 option has no direct effect, the menu must be refreshed first.
4368
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004369 *'mkspellmem'* *'msm'*
4370'mkspellmem' 'msm' string (default "460000,2000,500")
4371 global
4372 {not in Vi}
4373 {not available when compiled without the |+syntax|
4374 feature}
4375 Parameters for |:mkspell|. This tunes when to start compressing the
4376 word tree. Compression can be slow when there are many words, but
4377 it's needed to avoid running out of memory. The amount of memory used
4378 per word depends very much on how similar the words are, that's why
4379 this tuning is complicated.
4380
4381 There are three numbers, separated by commas:
4382 {start},{inc},{added}
4383
4384 For most languages the uncompressed word tree fits in memory. {start}
4385 gives the amount of memory in Kbyte that can be used before any
4386 compression is done. It should be a bit smaller than the amount of
4387 memory that is available to Vim.
4388
4389 When going over the {start} limit the {inc} number specifies the
4390 amount of memory in Kbyte that can be allocated before another
4391 compression is done. A low number means compression is done after
4392 less words are added, which is slow. A high number means more memory
4393 will be allocated.
4394
4395 After doing compression, {added} times 1024 words can be added before
4396 the {inc} limit is ignored and compression is done when any extra
4397 amount of memory is needed. A low number means there is a smaller
4398 chance of hitting the {inc} limit, less memory is used but it's
4399 slower.
4400
4401 The languages for which these numbers are important are Italian and
4402 Hungarian. The default works for when you have about 512 Mbyte. If
4403 you have 1 Gbyte you could use: >
4404 :set mkspellmem=900000,3000,800
4405< If you have less than 512 Mbyte |:mkspell| may fail for some
4406 languages, no matter what you set 'mkspellmem' to.
4407
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4409'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4410 local to buffer
4411 *'modelines'* *'mls'*
4412'modelines' 'mls' number (default 5)
4413 global
4414 {not in Vi}
4415 If 'modeline' is on 'modelines' gives the number of lines that is
4416 checked for set commands. If 'modeline' is off or 'modelines' is zero
4417 no lines are checked. See |modeline|.
4418 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4419 set and to the Vim default value when 'compatible' is reset.
4420
4421 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4422'modifiable' 'ma' boolean (default on)
4423 local to buffer
4424 {not in Vi} *E21*
4425 When off the buffer contents cannot be changed. The 'fileformat' and
4426 'fileencoding' options also can't be changed.
4427 Can be reset with the |-M| command line argument.
4428
4429 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4430'modified' 'mod' boolean (default off)
4431 local to buffer
4432 {not in Vi}
4433 When on, the buffer is considered to be modified. This option is set
4434 when:
4435 1. A change was made to the text since it was last written. Using the
4436 |undo| command to go back to the original text will reset the
4437 option. But undoing changes that were made before writing the
4438 buffer will set the option again, since the text is different from
4439 when it was written.
4440 2. 'fileformat' or 'fileencoding' is different from its original
4441 value. The original value is set when the buffer is read or
4442 written. A ":set nomodified" command also resets the original
4443 values to the current values and the 'modified' option will be
4444 reset.
4445 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4446 will be ignored.
4447
4448 *'more'* *'nomore'*
4449'more' boolean (Vim default: on, Vi default: off)
4450 global
4451 {not in Vi}
4452 When on, listings pause when the whole screen is filled. You will get
4453 the |more-prompt|. When this option is off there are no pauses, the
4454 listing continues until finished.
4455 NOTE: This option is set to the Vi default value when 'compatible' is
4456 set and to the Vim default value when 'compatible' is reset.
4457
4458 *'mouse'* *E538*
4459'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4460 global
4461 {not in Vi}
4462 Enable the use of the mouse. Only works for certain terminals
4463 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4464 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4465 The mouse can be enabled for different modes:
4466 n Normal mode
4467 v Visual mode
4468 i Insert mode
4469 c Command-line mode
4470 h all previous modes when editing a help file
4471 a all previous modes
4472 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 Normally you would enable the mouse in all four modes with: >
4474 :set mouse=a
4475< When the mouse is not enabled, the GUI will still use the mouse for
4476 modeless selection. This doesn't move the text cursor.
4477
4478 See |mouse-using|. Also see |'clipboard'|.
4479
4480 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004481 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 the mouse buttons can still be used by keeping the shift key pressed.
4483 Also see the 'clipboard' option.
4484
4485 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4486'mousefocus' 'mousef' boolean (default off)
4487 global
4488 {not in Vi}
4489 {only works in the GUI}
4490 The window that the mouse pointer is on is automatically activated.
4491 When changing the window layout or window focus in another way, the
4492 mouse pointer is moved to the window with keyboard focus. Off is the
4493 default because it makes using the pull down menus a little goofy, as
4494 a pointer transit may activate a window unintentionally.
4495
4496 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4497'mousehide' 'mh' boolean (default on)
4498 global
4499 {not in Vi}
4500 {only works in the GUI}
4501 When on, the mouse pointer is hidden when characters are typed.
4502 The mouse pointer is restored when the mouse is moved.
4503
4504 *'mousemodel'* *'mousem'*
4505'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4506 global
4507 {not in Vi}
4508 Sets the model to use for the mouse. The name mostly specifies what
4509 the right mouse button is used for:
4510 extend Right mouse button extends a selection. This works
4511 like in an xterm.
4512 popup Right mouse button pops up a menu. The shifted left
4513 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004514 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515 popup_setpos Like "popup", but the cursor will be moved to the
4516 position where the mouse was clicked, and thus the
4517 selected operation will act upon the clicked object.
4518 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004519 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004520 course, that right clicking outside a selection will
4521 end Visual mode.
4522 Overview of what button does what for each model:
4523 mouse extend popup(_setpos) ~
4524 left click place cursor place cursor
4525 left drag start selection start selection
4526 shift-left search word extend selection
4527 right click extend selection popup menu (place cursor)
4528 right drag extend selection -
4529 middle click paste paste
4530
4531 In the "popup" model the right mouse button produces a pop-up menu.
4532 You need to define this first, see |popup-menu|.
4533
4534 Note that you can further refine the meaning of buttons with mappings.
4535 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4536 selection (because that's handled in the GUI code directly).
4537
4538 The 'mousemodel' option is set by the |:behave| command.
4539
4540 *'mouseshape'* *'mouses'* *E547*
4541'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004542 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 global
4544 {not in Vi}
4545 {only available when compiled with the |+mouseshape|
4546 feature}
4547 This option tells Vim what the mouse pointer should look like in
4548 different modes. The option is a comma separated list of parts, much
4549 like used for 'guicursor'. Each part consist of a mode/location-list
4550 and an argument-list:
4551 mode-list:shape,mode-list:shape,..
4552 The mode-list is a dash separated list of these modes/locations:
4553 In a normal window: ~
4554 n Normal mode
4555 v Visual mode
4556 ve Visual mode with 'selection' "exclusive" (same as 'v',
4557 if not specified)
4558 o Operator-pending mode
4559 i Insert mode
4560 r Replace mode
4561
4562 Others: ~
4563 c appending to the command-line
4564 ci inserting in the command-line
4565 cr replacing in the command-line
4566 m at the 'Hit ENTER' or 'More' prompts
4567 ml idem, but cursor in the last line
4568 e any mode, pointer below last window
4569 s any mode, pointer on a status line
4570 sd any mode, while dragging a status line
4571 vs any mode, pointer on a vertical separator line
4572 vd any mode, while dragging a vertical separator line
4573 a everywhere
4574
4575 The shape is one of the following:
4576 avail name looks like ~
4577 w x arrow Normal mouse pointer
4578 w x blank no pointer at all (use with care!)
4579 w x beam I-beam
4580 w x updown up-down sizing arrows
4581 w x leftright left-right sizing arrows
4582 w x busy The system's usual busy pointer
4583 w x no The system's usual 'no input' pointer
4584 x udsizing indicates up-down resizing
4585 x lrsizing indicates left-right resizing
4586 x crosshair like a big thin +
4587 x hand1 black hand
4588 x hand2 white hand
4589 x pencil what you write with
4590 x question big ?
4591 x rightup-arrow arrow pointing right-up
4592 w x up-arrow arrow pointing up
4593 x <number> any X11 pointer number (see X11/cursorfont.h)
4594
4595 The "avail" column contains a 'w' if the shape is available for Win32,
4596 x for X11.
4597 Any modes not specified or shapes not available use the normal mouse
4598 pointer.
4599
4600 Example: >
4601 :set mouseshape=s:udsizing,m:no
4602< will make the mouse turn to a sizing arrow over the status lines and
4603 indicate no input when the hit-enter prompt is displayed (since
4604 clicking the mouse has no effect in this state.)
4605
4606 *'mousetime'* *'mouset'*
4607'mousetime' 'mouset' number (default 500)
4608 global
4609 {not in Vi}
4610 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4611 time in msec between two mouse clicks for the second click to be
4612 recognized as a multi click.
4613
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004614 *'mzquantum'* *'mzq'*
4615'mzquantum' 'mzq' number (default 100)
4616 global
4617 {not in Vi}
4618 {not available when compiled without the |+mzscheme|
4619 feature}
4620 The number of milliseconds between polls for MzScheme threads.
4621 Negative or zero value means no thread scheduling.
4622
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623 *'nrformats'* *'nf'*
4624'nrformats' 'nf' string (default "octal,hex")
4625 local to buffer
4626 {not in Vi}
4627 This defines what bases Vim will consider for numbers when using the
4628 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4629 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004630 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 incremented or decremented. This is useful for a list with a
4632 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004633 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004635 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 considered to be hexadecimal. Example: Using CTRL-X on
4637 "0x100" results in "0x0ff".
4638 Numbers which simply begin with a digit in the range 1-9 are always
4639 considered decimal. This also happens for numbers that are not
4640 recognized as octal or hex.
4641
4642 *'number'* *'nu'* *'nonumber'* *'nonu'*
4643'number' 'nu' boolean (default off)
4644 local to window
4645 Print the line number in front of each line. When the 'n' option is
4646 excluded from 'cpoptions' a wrapped line will not use the column of
4647 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004648 The 'numberwidth' option can be used to set the room used for the line
4649 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 When a long, wrapped line doesn't start with the first character, '-'
4651 characters are put before the number.
4652 See |hl-LineNr| for the highlighting used for the number.
4653
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004654 *'numberwidth'* *'nuw'*
4655'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4656 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004657 {not in Vi}
4658 {only available when compiled with the |+linebreak|
4659 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004660 Minimal number of columns to use for the line number. Only relevant
4661 when the 'number' option is set.
4662 Since one space is always between the number and the text, there is
4663 one less character for the number itself.
4664 The value is the minimum width. A bigger width is used when needed to
4665 fit the highest line number in the buffer. Thus with the Vim default
4666 of 4 there is room for a line number up to 999. When the buffer has
4667 1000 lines five columns will be used.
4668 The minimum value is 1, the maximum value is 10.
4669 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4670
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004671 *'omnifunc'* *'ofu'*
4672'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004673 local to buffer
4674 {not in Vi}
4675 {not available when compiled without the +eval
4676 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004677 This option specifies a function to be used for Insert mode omni
4678 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004679 For the use of the function see 'completefunc'.
4680
4681
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004682 *'operatorfunc'* *'opfunc'*
4683'operatorfunc' 'opfunc' string (default: empty)
4684 global
4685 {not in Vi}
4686 This option specifies a function to be called by the |g@| operator.
4687 See |:map-operator| for more info and an example.
4688
4689 This option cannot be set from a |modeline| or in the |sandbox|, for
4690 security reasons.
4691
4692
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693 *'osfiletype'* *'oft'* *E366*
4694'osfiletype' 'oft' string (RISC-OS default: "Text",
4695 others default: "")
4696 local to buffer
4697 {not in Vi}
4698 {only available when compiled with the |+osfiletype|
4699 feature}
4700 Some operating systems store extra information about files besides
4701 name, datestamp and permissions. This option contains the extra
4702 information, the nature of which will vary between systems.
4703 The value of this option is usually set when the file is loaded, and
4704 use to set the file type when file is written.
4705 It can affect the pattern matching of the automatic commands.
4706 |autocmd-osfiletypes|
4707
4708 *'paragraphs'* *'para'*
4709'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4710 global
4711 Specifies the nroff macros that separate paragraphs. These are pairs
4712 of two letters (see |object-motions|).
4713
4714 *'paste'* *'nopaste'*
4715'paste' boolean (default off)
4716 global
4717 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004718 Put Vim in Paste mode. This is useful if you want to cut or copy
4719 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 unexpected effects.
4721 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004722 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 knows about pasting and will mostly do the right thing without 'paste'
4724 being set. The same is true for a terminal where Vim handles the
4725 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004726 This option is reset when starting the GUI. Thus if you set it in
4727 your .vimrc it will work in a terminal, but not in the GUI. Setting
4728 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4729 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 When the 'paste' option is switched on (also when it was already on):
4731 - mapping in Insert mode and Command-line mode is disabled
4732 - abbreviations are disabled
4733 - 'textwidth' is set to 0
4734 - 'wrapmargin' is set to 0
4735 - 'autoindent' is reset
4736 - 'smartindent' is reset
4737 - 'softtabstop' is set to 0
4738 - 'revins' is reset
4739 - 'ruler' is reset
4740 - 'showmatch' is reset
4741 - 'formatoptions' is used like it is empty
4742 These options keep their value, but their effect is disabled:
4743 - 'lisp'
4744 - 'indentexpr'
4745 - 'cindent'
4746 NOTE: When you start editing another file while the 'paste' option is
4747 on, settings from the modelines or autocommands may change the
4748 settings again, causing trouble when pasting text. You might want to
4749 set the 'paste' option again.
4750 When the 'paste' option is reset the mentioned options are restored to
4751 the value before the moment 'paste' was switched from off to on.
4752 Resetting 'paste' before ever setting it does not have any effect.
4753 Since mapping doesn't work while 'paste' is active, you need to use
4754 the 'pastetoggle' option to toggle the 'paste' option with some key.
4755
4756 *'pastetoggle'* *'pt'*
4757'pastetoggle' 'pt' string (default "")
4758 global
4759 {not in Vi}
4760 When non-empty, specifies the key sequence that toggles the 'paste'
4761 option. This is like specifying a mapping: >
4762 :map {keys} :set invpaste<CR>
4763< Where {keys} is the value of 'pastetoggle'.
4764 The difference is that it will work even when 'paste' is set.
4765 'pastetoggle' works in Insert mode and Normal mode, but not in
4766 Command-line mode.
4767 Mappings are checked first, thus overrule 'pastetoggle'. However,
4768 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4769 this: >
4770 :map <F10> :set paste<CR>
4771 :map <F11> :set nopaste<CR>
4772 :imap <F10> <C-O>:set paste<CR>
4773 :imap <F11> <nop>
4774 :set pastetoggle=<F11>
4775< This will make <F10> start paste mode and <F11> stop paste mode.
4776 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4777 mode everything is inserted literally, except the 'pastetoggle' key
4778 sequence.
4779
4780 *'pex'* *'patchexpr'*
4781'patchexpr' 'pex' string (default "")
4782 global
4783 {not in Vi}
4784 {not available when compiled without the |+diff|
4785 feature}
4786 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004787 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
4789 *'patchmode'* *'pm'* *E206*
4790'patchmode' 'pm' string (default "")
4791 global
4792 {not in Vi}
4793 When non-empty the oldest version of a file is kept. This can be used
4794 to keep the original version of a file if you are changing files in a
4795 source distribution. Only the first time that a file is written a
4796 copy of the original file will be kept. The name of the copy is the
4797 name of the original file with the string in the 'patchmode' option
4798 appended. This option should start with a dot. Use a string like
4799 ".org". 'backupdir' must not be empty for this to work (Detail: The
4800 backup file is renamed to the patchmode file after the new file has
4801 been successfully written, that's why it must be possible to write a
4802 backup file). If there was no file to be backed up, an empty file is
4803 created.
4804 When the 'backupskip' pattern matches, a patchmode file is not made.
4805 Using 'patchmode' for compressed files appends the extension at the
4806 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4807 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004808 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
4810 *'path'* *'pa'* *E343* *E345* *E347*
4811'path' 'pa' string (default on Unix: ".,/usr/include,,"
4812 on OS/2: ".,/emx/include,,"
4813 other systems: ".,,")
4814 global or local to buffer |global-local|
4815 {not in Vi}
4816 This is a list of directories which will be searched when using the
4817 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4818 being searched for has a relative path (not starting with '/'). The
4819 directories in the 'path' option may be relative or absolute.
4820 - Use commas to separate directory names: >
4821 :set path=.,/usr/local/include,/usr/include
4822< - Spaces can also be used to separate directory names (for backwards
4823 compatibility with version 3.0). To have a space in a directory
4824 name, precede it with an extra backslash, and escape the space: >
4825 :set path=.,/dir/with\\\ space
4826< - To include a comma in a directory name precede it with an extra
4827 backslash: >
4828 :set path=.,/dir/with\\,comma
4829< - To search relative to the directory of the current file, use: >
4830 :set path=.
4831< - To search in the current directory use an empty string between two
4832 commas: >
4833 :set path=,,
4834< - A directory name may end in a ':' or '/'.
4835 - Environment variables are expanded |:set_env|.
4836 - When using |netrw.vim| URLs can be used. For example, adding
4837 "http://www.vim.org" will make ":find index.html" work.
4838 - Search upwards and downwards in a directory tree:
4839 1) "*" matches a sequence of characters, e.g.: >
4840 :set path=/usr/include/*
4841< means all subdirectories in /usr/include (but not /usr/include
4842 itself). >
4843 :set path=/usr/*c
4844< matches /usr/doc and /usr/src.
4845 2) "**" matches a subtree, up to 100 directories deep. Example: >
4846 :set path=/home/user_x/src/**
4847< means search in the whole subtree under "/home/usr_x/src".
4848 3) If the path ends with a ';', this path is the startpoint
4849 for upward search.
4850 See |file-searching| for more info and exact syntax.
4851 {not available when compiled without the |+path_extra| feature}
4852 - Careful with '\' characters, type two to get one in the option: >
4853 :set path=.,c:\\include
4854< Or just use '/' instead: >
4855 :set path=.,c:/include
4856< Don't forget "." or files won't even be found in the same directory as
4857 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004858 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 it is something like 256 or 1024 characters.
4860 You can check if all the include files are found, using the value of
4861 'path', see |:checkpath|.
4862 The use of |:set+=| and |:set-=| is preferred when adding or removing
4863 directories from the list. This avoids problems when a future version
4864 uses another default. To remove the current directory use: >
4865 :set path-=
4866< To add the current directory use: >
4867 :set path+=
4868< To use an environment variable, you probably need to replace the
4869 separator. Here is an example to append $INCL, in which directory
4870 names are separated with a semi-colon: >
4871 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4872< Replace the ';' with a ':' or whatever separator is used. Note that
4873 this doesn't work when $INCL contains a comma or white space.
4874
4875 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4876'preserveindent' 'pi' boolean (default off)
4877 local to buffer
4878 {not in Vi}
4879 When changing the indent of the current line, preserve as much of the
4880 indent structure as possible. Normally the indent is replaced by a
4881 series of tabs followed by spaces as required (unless |'expandtab'| is
4882 enabled, in which case only spaces are used). Enabling this option
4883 means the indent will preserve as many existing characters as possible
4884 for indenting, and only add additional tabs or spaces as required.
4885 NOTE: When using ">>" multiple times the resulting indent is a mix of
4886 tabs and spaces. You might not like this.
4887 NOTE: 'preserveindent' is reset when 'compatible' is set.
4888 Also see 'copyindent'.
4889 Use |:retab| to clean up white space.
4890
4891 *'previewheight'* *'pvh'*
4892'previewheight' 'pvh' number (default 12)
4893 global
4894 {not in Vi}
4895 {not available when compiled without the |+windows| or
4896 |+quickfix| feature}
4897 Default height for a preview window. Used for |:ptag| and associated
4898 commands. Used for |CTRL-W_}| when no count is given.
4899
4900 *'previewwindow'* *'nopreviewwindow'*
4901 *'pvw'* *'nopvw'* *E590*
4902'previewwindow' 'pvw' boolean (default off)
4903 local to window
4904 {not in Vi}
4905 {not available when compiled without the |+windows| or
4906 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004907 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 set. It's normally not set directly, but by using one of the commands
4909 |:ptag|, |:pedit|, etc.
4910
4911 *'printdevice'* *'pdev'*
4912'printdevice' 'pdev' string (default empty)
4913 global
4914 {not in Vi}
4915 {only available when compiled with the |+printer|
4916 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004917 The name of the printer to be used for |:hardcopy|.
4918 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004919 This option cannot be set from a |modeline| or in the |sandbox|, for
4920 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaar8299df92004-07-10 09:47:34 +00004922 *'printencoding'* *'penc'*
4923'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 global
4925 {not in Vi}
4926 {only available when compiled with the |+printer|
4927 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004928 Sets the character encoding used when printing.
4929 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930
4931 *'printexpr'* *'pexpr'*
4932'printexpr' 'pexpr' String (default: see below)
4933 global
4934 {not in Vi}
4935 {only available when compiled with the |+printer|
4936 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004937 Expression used to print the PostScript produced with |:hardcopy|.
4938 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004939
Bram Moolenaar8299df92004-07-10 09:47:34 +00004940 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004941'printfont' 'pfn' string (default "courier")
4942 global
4943 {not in Vi}
4944 {only available when compiled with the |+printer|
4945 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004946 The name of the font that will be used for |:hardcopy|.
4947 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948
4949 *'printheader'* *'pheader'*
4950'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4951 global
4952 {not in Vi}
4953 {only available when compiled with the |+printer|
4954 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004955 The format of the header produced in |:hardcopy| output.
4956 See |pheader-option|.
4957
4958 *'printmbcharset'* *'pmbcs'*
4959'printmbcharset' 'pmbcs' string (default "")
4960 global
4961 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004962 {only available when compiled with the |+printer|,
4963 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004964 The CJK character set to be used for CJK output from |:hardcopy|.
4965 See |pmbcs-option|.
4966
4967 *'printmbfont'* *'pmbfn'*
4968'printmbfont' 'pmbfn' string (default "")
4969 global
4970 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004971 {only available when compiled with the |+printer|,
4972 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004973 List of font names to be used for CJK output from |:hardcopy|.
4974 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975
4976 *'printoptions'* *'popt'*
4977'printoptions' 'popt' string (default "")
4978 global
4979 {not in Vi}
4980 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004981 List of items that control the format of the output of |:hardcopy|.
4982 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004984 *'prompt'* *'noprompt'*
4985'prompt' boolean (default on)
4986 global
4987 When on a ":" prompt is used in Ex mode.
4988
Bram Moolenaar677ee682005-01-27 14:41:15 +00004989 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004990'quoteescape' 'qe' string (default "\")
4991 local to buffer
4992 {not in Vi}
4993 The characters that are used to escape quotes in a string. Used for
4994 objects like a', a" and a` |a'|.
4995 When one of the characters in this option is found inside a string,
4996 the following character will be skipped. The default value makes the
4997 text "foo\"bar\\" considered to be one string.
4998
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5000'readonly' 'ro' boolean (default off)
5001 local to buffer
5002 If on, writes fail unless you use a '!'. Protects you from
5003 accidentally overwriting a file. Default on when Vim is started
5004 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005005 When using ":w!" the 'readonly' option is reset for the current
5006 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005008 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009
5010 *'remap'* *'noremap'*
5011'remap' boolean (default on)
5012 global
5013 Allows for mappings to work recursively. If you do not want this for
5014 a single entry, use the :noremap[!] command.
5015
5016 *'report'*
5017'report' number (default 2)
5018 global
5019 Threshold for reporting number of lines changed. When the number of
5020 changed lines is more than 'report' a message will be given for most
5021 ":" commands. If you want it always, set 'report' to 0.
5022 For the ":substitute" command the number of substitutions is used
5023 instead of the number of lines.
5024
5025 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5026'restorescreen' 'rs' boolean (default on)
5027 global
5028 {not in Vi} {only in Windows 95/NT console version}
5029 When set, the screen contents is restored when exiting Vim. This also
5030 happens when executing external commands.
5031
5032 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5033 options in your .vimrc. To disable restoring:
5034 set t_ti= t_te=
5035 To enable restoring (for an xterm):
5036 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5037 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5038
5039 *'revins'* *'ri'* *'norevins'* *'nori'*
5040'revins' 'ri' boolean (default off)
5041 global
5042 {not in Vi}
5043 {only available when compiled with the |+rightleft|
5044 feature}
5045 Inserting characters in Insert mode will work backwards. See "typing
5046 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5047 command in Insert mode, when 'allowrevins' is set.
5048 NOTE: This option is reset when 'compatible' or 'paste' is set.
5049
5050 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5051'rightleft' 'rl' boolean (default off)
5052 local to window
5053 {not in Vi}
5054 {only available when compiled with the |+rightleft|
5055 feature}
5056 When on, display orientation becomes right-to-left, i.e., characters
5057 that are stored in the file appear from the right to the left.
5058 Using this option, it is possible to edit files for languages that
5059 are written from the right to the left such as Hebrew and Arabic.
5060 This option is per window, so it is possible to edit mixed files
5061 simultaneously, or to view the same file in both ways (this is
5062 useful whenever you have a mixed text file with both right-to-left
5063 and left-to-right strings so that both sets are displayed properly
5064 in different windows). Also see |rileft.txt|.
5065
5066 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5067'rightleftcmd' 'rlc' string (default "search")
5068 local to window
5069 {not in Vi}
5070 {only available when compiled with the |+rightleft|
5071 feature}
5072 Each word in this option enables the command line editing to work in
5073 right-to-left mode for a group of commands:
5074
5075 search "/" and "?" commands
5076
5077 This is useful for languages such as Hebrew, Arabic and Farsi.
5078 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5079
5080 *'ruler'* *'ru'* *'noruler'* *'noru'*
5081'ruler' 'ru' boolean (default off)
5082 global
5083 {not in Vi}
5084 {not available when compiled without the
5085 |+cmdline_info| feature}
5086 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005087 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088 text in the file is shown on the far right:
5089 Top first line is visible
5090 Bot last line is visible
5091 All first and last line are visible
5092 45% relative position in the file
5093 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005094 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005096 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 this option takes precedence over 'ruler' and 'rulerformat'
5098 If the number of characters displayed is different from the number of
5099 bytes in the text (e.g., for a TAB or a multi-byte character), both
5100 the text column (byte number) and the screen column are shown,
5101 separated with a dash.
5102 For an empty line "0-1" is shown.
5103 For an empty buffer the line number will also be zero: "0,0-1".
5104 This option is reset when the 'paste' option is set.
5105 If you don't want to see the ruler all the time but want to know where
5106 you are, use "g CTRL-G" |g_CTRL-G|.
5107 NOTE: This option is reset when 'compatible' is set.
5108
5109 *'rulerformat'* *'ruf'*
5110'rulerformat' 'ruf' string (default empty)
5111 global
5112 {not in Vi}
5113 {not available when compiled without the |+statusline|
5114 feature}
5115 When this option is not empty, it determines the content of the ruler
5116 string, as displayed for the 'ruler' option.
5117 The format of this option, is like that of 'statusline'.
5118 The default ruler width is 17 characters. To make the ruler 15
5119 characters wide, put "%15(" at the start and "%)" at the end.
5120 Example: >
5121 :set rulerformat=%15(%c%V\ %p%%%)
5122<
5123 *'runtimepath'* *'rtp'* *vimfiles*
5124'runtimepath' 'rtp' string (default:
5125 Unix: "$HOME/.vim,
5126 $VIM/vimfiles,
5127 $VIMRUNTIME,
5128 $VIM/vimfiles/after,
5129 $HOME/.vim/after"
5130 Amiga: "home:vimfiles,
5131 $VIM/vimfiles,
5132 $VIMRUNTIME,
5133 $VIM/vimfiles/after,
5134 home:vimfiles/after"
5135 PC, OS/2: "$HOME/vimfiles,
5136 $VIM/vimfiles,
5137 $VIMRUNTIME,
5138 $VIM/vimfiles/after,
5139 $HOME/vimfiles/after"
5140 Macintosh: "$VIM:vimfiles,
5141 $VIMRUNTIME,
5142 $VIM:vimfiles:after"
5143 RISC-OS: "Choices:vimfiles,
5144 $VIMRUNTIME,
5145 Choices:vimfiles/after"
5146 VMS: "sys$login:vimfiles,
5147 $VIM/vimfiles,
5148 $VIMRUNTIME,
5149 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005150 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151 global
5152 {not in Vi}
5153 This is a list of directories which will be searched for runtime
5154 files:
5155 filetype.vim filetypes by file name |new-filetype|
5156 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005157 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 colors/ color scheme files |:colorscheme|
5159 compiler/ compiler files |:compiler|
5160 doc/ documentation |write-local-help|
5161 ftplugin/ filetype plugins |write-filetype-plugin|
5162 indent/ indent scripts |indent-expression|
5163 keymap/ key mapping files |mbyte-keymap|
5164 lang/ menu translations |:menutrans|
5165 menu.vim GUI menus |menu.vim|
5166 plugin/ plugin scripts |write-plugin|
5167 print/ files for printing |postscript-print-encoding|
5168 syntax/ syntax files |mysyntaxfile|
5169 tutor/ files for vimtutor |tutor|
5170
5171 And any other file searched for with the |:runtime| command.
5172
5173 The defaults for most systems are setup to search five locations:
5174 1. In your home directory, for your personal preferences.
5175 2. In a system-wide Vim directory, for preferences from the system
5176 administrator.
5177 3. In $VIMRUNTIME, for files distributed with Vim.
5178 *after-directory*
5179 4. In the "after" directory in the system-wide Vim directory. This is
5180 for the system administrator to overrule or add to the distributed
5181 defaults (rarely needed)
5182 5. In the "after" directory in your home directory. This is for
5183 personal preferences to overrule or add to the distributed defaults
5184 or system-wide settings (rarely needed).
5185
5186 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5187 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005188 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 wildcards.
5190 See |:runtime|.
5191 Example: >
5192 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5193< This will use the directory "~/vimruntime" first (containing your
5194 personal Vim runtime files), then "/mygroup/vim" (shared between a
5195 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5196 files).
5197 You probably should always include $VIMRUNTIME somewhere, to use the
5198 distributed runtime files. You can put a directory before $VIMRUNTIME
5199 to find files which replace a distributed runtime files. You can put
5200 a directory after $VIMRUNTIME to find files which add to distributed
5201 runtime files.
5202 This option cannot be set from a |modeline| or in the |sandbox|, for
5203 security reasons.
5204
5205 *'scroll'* *'scr'*
5206'scroll' 'scr' number (default: half the window height)
5207 local to window
5208 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5209 set to half the number of lines in the window when the window size
5210 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005211 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5213 the number of screen lines instead of file lines, makes a difference
5214 when lines wrap}
5215
5216 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5217'scrollbind' 'scb' boolean (default off)
5218 local to window
5219 {not in Vi}
5220 {not available when compiled without the |+scrollbind|
5221 feature}
5222 See also |scroll-binding|. When this option is set, the current
5223 window scrolls as other scrollbind windows (windows that also have
5224 this option set) scroll. This option is useful for viewing the
5225 differences between two versions of a file, see 'diff'.
5226 See |'scrollopt'| for options that determine how this option should be
5227 interpreted.
5228 This option is mostly reset when splitting a window to edit another
5229 file. This means that ":split | edit file" results in two windows
5230 with scroll-binding, but ":split file" does not.
5231
5232 *'scrolljump'* *'sj'*
5233'scrolljump' 'sj' number (default 1)
5234 global
5235 {not in Vi}
5236 Minimal number of lines to scroll when the cursor gets off the
5237 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5238 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005239 When set to a negative number from -1 to -100 this is used as the
5240 percentage of the window height. Thus -50 scrolls half the window
5241 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 NOTE: This option is set to 1 when 'compatible' is set.
5243
5244 *'scrolloff'* *'so'*
5245'scrolloff' 'so' number (default 0)
5246 global
5247 {not in Vi}
5248 Minimal number of screen lines to keep above and below the cursor.
5249 This will make some context visible around where you are working. If
5250 you set it to a very large value (999) the cursor line will always be
5251 in the middle of the window (except at the start or end of the file or
5252 when long lines wrap).
5253 For scrolling horizontally see 'sidescrolloff'.
5254 NOTE: This option is set to 0 when 'compatible' is set.
5255
5256 *'scrollopt'* *'sbo'*
5257'scrollopt' 'sbo' string (default "ver,jump")
5258 global
5259 {not available when compiled without the |+scrollbind|
5260 feature}
5261 {not in Vi}
5262 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005263 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5264 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 The following words are available:
5266 ver Bind vertical scrolling for 'scrollbind' windows
5267 hor Bind horizontal scrolling for 'scrollbind' windows
5268 jump Applies to the offset between two windows for vertical
5269 scrolling. This offset is the difference in the first
5270 displayed line of the bound windows. When moving
5271 around in a window, another 'scrollbind' window may
5272 reach a position before the start or after the end of
5273 the buffer. The offset is not changed though, when
5274 moving back the 'scrollbind' window will try to scroll
5275 to the desired position when possible.
5276 When now making that window the current one, two
5277 things can be done with the relative offset:
5278 1. When "jump" is not included, the relative offset is
5279 adjusted for the scroll position in the new current
5280 window. When going back to the other window, the
5281 the new relative offset will be used.
5282 2. When "jump" is included, the other windows are
5283 scrolled to keep the same relative offset. When
5284 going back to the other window, it still uses the
5285 same relative offset.
5286 Also see |scroll-binding|.
5287
5288 *'sections'* *'sect'*
5289'sections' 'sect' string (default "SHNHH HUnhsh")
5290 global
5291 Specifies the nroff macros that separate sections. These are pairs of
5292 two letters (See |object-motions|). The default makes a section start
5293 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5294
5295 *'secure'* *'nosecure'* *E523*
5296'secure' boolean (default off)
5297 global
5298 {not in Vi}
5299 When on, ":autocmd", shell and write commands are not allowed in
5300 ".vimrc" and ".exrc" in the current directory and map commands are
5301 displayed. Switch it off only if you know that you will not run into
5302 problems, or when the 'exrc' option is off. On Unix this option is
5303 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005304 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305 'secure' at the end of your ~/.vimrc then.
5306 This option cannot be set from a |modeline| or in the |sandbox|, for
5307 security reasons.
5308
5309 *'selection'* *'sel'*
5310'selection' 'sel' string (default "inclusive")
5311 global
5312 {not in Vi}
5313 This option defines the behavior of the selection. It is only used
5314 in Visual and Select mode.
5315 Possible values:
5316 value past line inclusive ~
5317 old no yes
5318 inclusive yes yes
5319 exclusive yes no
5320 "past line" means that the cursor is allowed to be positioned one
5321 character past the line.
5322 "inclusive" means that the last character of the selection is included
5323 in an operation. For example, when "x" is used to delete the
5324 selection.
5325 Note that when "exclusive" is used and selecting from the end
5326 backwards, you cannot include the last character of a line, when
5327 starting in Normal mode and 'virtualedit' empty.
5328
5329 The 'selection' option is set by the |:behave| command.
5330
5331 *'selectmode'* *'slm'*
5332'selectmode' 'slm' string (default "")
5333 global
5334 {not in Vi}
5335 This is a comma separated list of words, which specifies when to start
5336 Select mode instead of Visual mode, when a selection is started.
5337 Possible values:
5338 mouse when using the mouse
5339 key when using shifted special keys
5340 cmd when using "v", "V" or CTRL-V
5341 See |Select-mode|.
5342 The 'selectmode' option is set by the |:behave| command.
5343
5344 *'sessionoptions'* *'ssop'*
5345'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5346 help,options,winsize")
5347 global
5348 {not in Vi}
5349 {not available when compiled without the +mksession
5350 feature}
5351 Changes the effect of the |:mksession| command. It is a comma
5352 separated list of words. Each word enables saving and restoring
5353 something:
5354 word save and restore ~
5355 blank empty windows
5356 buffers hidden and unloaded buffers, not just those in windows
5357 curdir the current directory
5358 folds manually created folds, opened/closed folds and local
5359 fold options
5360 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005361 and contain at least one lowercase letter. Only
5362 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 help the help window
5364 localoptions options and mappings local to a window or buffer (not
5365 global values for local options)
5366 options all options and mappings (also global values for local
5367 options)
5368 resize size of the Vim window: 'lines' and 'columns'
5369 sesdir the directory in which the session file is located
5370 will become the current directory (useful with
5371 projects accessed over a network from different
5372 systems)
5373 slash backslashes in file names replaced with forward
5374 slashes
5375 unix with Unix end-of-line format (single <NL>), even when
5376 on Windows or DOS
5377 winpos position of the whole Vim window
5378 winsize window sizes
5379
5380 Don't include both "curdir" and "sesdir".
5381 When "curdir" nor "sesdir" is included, file names are stored with
5382 absolute paths.
5383 "slash" and "unix" are useful on Windows when sharing session files
5384 with Unix. The Unix version of Vim cannot source dos format scripts,
5385 but the Windows version of Vim can source unix format scripts.
5386
5387 *'shell'* *'sh'* *E91*
5388'shell' 'sh' string (default $SHELL or "sh",
5389 MS-DOS and Win32: "command.com" or
5390 "cmd.exe", OS/2: "cmd")
5391 global
5392 Name of the shell to use for ! and :! commands. When changing the
5393 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5394 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005395 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 See |option-backslash| about including spaces and backslashes.
5397 Environment variables are expanded |:set_env|.
5398 If the name of the shell contains a space, you might need to enclose
5399 it in quotes. Example: >
5400 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5401< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005402 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005403 "-f" is not inside the quotes, because it is not part of the command
5404 name. And Vim automagically recognizes the backslashes that are path
5405 separators.
5406 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5407 variable to change the way external commands are executed. See the
5408 libc.inf file of DJGPP.
5409 Under MS-Windows, when the executable ends in ".com" it must be
5410 included. Thus setting the shell to "command.com" or "4dos.com"
5411 works, but "command" and "4dos" do not work for all commands (e.g.,
5412 filtering).
5413 For unknown reasons, when using "4dos.com" the current directory is
5414 changed to "C:\". To avoid this set 'shell' like this: >
5415 :set shell=command.com\ /c\ 4dos
5416< This option cannot be set from a |modeline| or in the |sandbox|, for
5417 security reasons.
5418
5419 *'shellcmdflag'* *'shcf'*
5420'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5421 does not contain "sh" somewhere: "/c")
5422 global
5423 {not in Vi}
5424 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5425 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5426 systems, the default is set according to the value of 'shell', to
5427 reduce the need to set this option by the user. It's not used for
5428 OS/2 (EMX figures this out itself). See |option-backslash| about
5429 including spaces and backslashes. See |dos-shell|.
5430 This option cannot be set from a |modeline| or in the |sandbox|, for
5431 security reasons.
5432
5433 *'shellpipe'* *'sp'*
5434'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5435 global
5436 {not in Vi}
5437 {not available when compiled without the |+quickfix|
5438 feature}
5439 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005440 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 including spaces and backslashes.
5442 The name of the temporary file can be represented by "%s" if necessary
5443 (the file name is appended automatically if no %s appears in the value
5444 of this option).
5445 For the Amiga and MS-DOS the default is ">". The output is directly
5446 saved in a file and not echoed to the screen.
5447 For Unix the default it "| tee". The stdout of the compiler is saved
5448 in a file and echoed to the screen. If the 'shell' option is "csh" or
5449 "tcsh" after initializations, the default becomes "|& tee". If the
5450 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5451 "2>&1| tee". This means that stderr is also included.
5452 The initialization of this option is done after reading the ".vimrc"
5453 and the other initializations, so that when the 'shell' option is set
5454 there, the 'shellpipe' option changes automatically, unless it was
5455 explicitly set before.
5456 When 'shellpipe' is set to an empty string, no redirection of the
5457 ":make" output will be done. This is useful if you use a 'makeprg'
5458 that writes to 'makeef' by itself. If you want no piping, but do
5459 want to include the 'makeef', set 'shellpipe' to a single space.
5460 Don't forget to precede the space with a backslash: ":set sp=\ ".
5461 In the future pipes may be used for filtering and this option will
5462 become obsolete (at least for Unix).
5463 This option cannot be set from a |modeline| or in the |sandbox|, for
5464 security reasons.
5465
5466 *'shellquote'* *'shq'*
5467'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5468 contains "sh" somewhere: "\"")
5469 global
5470 {not in Vi}
5471 Quoting character(s), put around the command passed to the shell, for
5472 the "!" and ":!" commands. The redirection is kept outside of the
5473 quoting. See 'shellxquote' to include the redirection. It's
5474 probably not useful to set both options.
5475 This is an empty string by default. Only known to be useful for
5476 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5477 or bash, where it should be "\"". The default is adjusted according
5478 the value of 'shell', to reduce the need to set this option by the
5479 user. See |dos-shell|.
5480 This option cannot be set from a |modeline| or in the |sandbox|, for
5481 security reasons.
5482
5483 *'shellredir'* *'srr'*
5484'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5485 global
5486 {not in Vi}
5487 String to be used to put the output of a filter command in a temporary
5488 file. See also |:!|. See |option-backslash| about including spaces
5489 and backslashes.
5490 The name of the temporary file can be represented by "%s" if necessary
5491 (the file name is appended automatically if no %s appears in the value
5492 of this option).
5493 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5494 or "zsh" during initializations, the default becomes ">&". If the
5495 'shell' option is "sh", "ksh" or "bash" the default becomes
5496 ">%s 2>&1". This means that stderr is also included.
5497 For Win32, the Unix checks are done and additionally "cmd" is checked
5498 for, which makes the default ">%s 2>&1". Also, the same names with
5499 ".exe" appended are checked for.
5500 The initialization of this option is done after reading the ".vimrc"
5501 and the other initializations, so that when the 'shell' option is set
5502 there, the 'shellredir' option changes automatically unless it was
5503 explicitly set before.
5504 In the future pipes may be used for filtering and this option will
5505 become obsolete (at least for Unix).
5506 This option cannot be set from a |modeline| or in the |sandbox|, for
5507 security reasons.
5508
5509 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5510'shellslash' 'ssl' boolean (default off)
5511 global
5512 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5513 When set, a forward slash is used when expanding file names. This is
5514 useful when a Unix-like shell is used instead of command.com or
5515 cmd.exe. Backward slashes can still be typed, but they are changed to
5516 forward slashes by Vim.
5517 Note that setting or resetting this option has no effect for some
5518 existing file names, thus this option needs to be set before opening
5519 any file for best results. This might change in the future.
5520 'shellslash' only works when a backslash can be used as a path
5521 separator. To test if this is so use: >
5522 if exists('+shellslash')
5523<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005524 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5525'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5526 global
5527 {not in Vi}
5528 When on, use temp files for shell commands. When off use a pipe.
5529 When using a pipe is not possible temp files are used anyway.
5530 Currently a pipe is only supported on Unix. You can check it with: >
5531 :if has("filterpipe")
5532< The advantage of using a pipe is that nobody can read the temp file
5533 and the 'shell' command does not need to support redirection.
5534 The advantage of using a temp file is that the file type and encoding
5535 can be detected.
5536 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5537 |FilterWritePost| autocommands event are not triggered when
5538 'shelltemp' is off.
5539
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 *'shelltype'* *'st'*
5541'shelltype' 'st' number (default 0)
5542 global
5543 {not in Vi} {only for the Amiga}
5544 On the Amiga this option influences the way how the commands work
5545 which use a shell.
5546 0 and 1: always use the shell
5547 2 and 3: use the shell only to filter lines
5548 4 and 5: use shell only for ':sh' command
5549 When not using the shell, the command is executed directly.
5550
5551 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5552 1 and 3: use "shell cmd" to start external commands
5553
5554 *'shellxquote'* *'sxq'*
5555'shellxquote' 'sxq' string (default: "";
5556 for Win32, when 'shell' contains "sh"
5557 somewhere: "\""
5558 for Unix, when using system(): "\"")
5559 global
5560 {not in Vi}
5561 Quoting character(s), put around the command passed to the shell, for
5562 the "!" and ":!" commands. Includes the redirection. See
5563 'shellquote' to exclude the redirection. It's probably not useful
5564 to set both options.
5565 This is an empty string by default. Known to be useful for
5566 third-party shells when using the Win32 version, such as the MKS Korn
5567 Shell or bash, where it should be "\"". The default is adjusted
5568 according the value of 'shell', to reduce the need to set this option
5569 by the user. See |dos-shell|.
5570 This option cannot be set from a |modeline| or in the |sandbox|, for
5571 security reasons.
5572
5573 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5574'shiftround' 'sr' boolean (default off)
5575 global
5576 {not in Vi}
5577 Round indent to multiple of 'shiftwidth'. Applies to > and <
5578 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5579 a multiple of 'shiftwidth' (this is Vi compatible).
5580 NOTE: This option is reset when 'compatible' is set.
5581
5582 *'shiftwidth'* *'sw'*
5583'shiftwidth' 'sw' number (default 8)
5584 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005585 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 |'cindent'|, |>>|, |<<|, etc.
5587
5588 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005589'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5590 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 global
5592 {not in Vi}
5593 This option helps to avoid all the |hit-enter| prompts caused by file
5594 messages, for example with CTRL-G, and to avoid some other messages.
5595 It is a list of flags:
5596 flag meaning when present ~
5597 f use "(3 of 5)" instead of "(file 3 of 5)"
5598 i use "[noeol]" instead of "[Incomplete last line]"
5599 l use "999L, 888C" instead of "999 lines, 888 characters"
5600 m use "[+]" instead of "[Modified]"
5601 n use "[New]" instead of "[New File]"
5602 r use "[RO]" instead of "[readonly]"
5603 w use "[w]" instead of "written" for file write message
5604 and "[a]" instead of "appended" for ':w >> file' command
5605 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5606 "[unix format]" and "[mac]" instead of "[mac format]".
5607 a all of the above abbreviations
5608
5609 o overwrite message for writing a file with subsequent message
5610 for reading a file (useful for ":wn" or when 'autowrite' on)
5611 O message for reading a file overwrites any previous message.
5612 Also for quickfix message (e.g., ":cn").
5613 s don't give "search hit BOTTOM, continuing at TOP" or "search
5614 hit TOP, continuing at BOTTOM" messages
5615 t truncate file message at the start if it is too long to fit
5616 on the command-line, "<" will appear in the left most column.
5617 Ignored in Ex mode.
5618 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005619 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620 Ignored in Ex mode.
5621 W don't give "written" or "[w]" when writing a file
5622 A don't give the "ATTENTION" message when an existing swap file
5623 is found.
5624 I don't give the intro message when starting Vim |:intro|.
5625
5626 This gives you the opportunity to avoid that a change between buffers
5627 requires you to hit <Enter>, but still gives as useful a message as
5628 possible for the space available. To get the whole message that you
5629 would have got with 'shm' empty, use ":file!"
5630 Useful values:
5631 shm= No abbreviation of message.
5632 shm=a Abbreviation, but no loss of information.
5633 shm=at Abbreviation, and truncate message when necessary.
5634
5635 NOTE: This option is set to the Vi default value when 'compatible' is
5636 set and to the Vim default value when 'compatible' is reset.
5637
5638 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5639'shortname' 'sn' boolean (default off)
5640 local to buffer
5641 {not in Vi, not in MS-DOS versions}
5642 Filenames are assumed to be 8 characters plus one extension of 3
5643 characters. Multiple dots in file names are not allowed. When this
5644 option is on, dots in file names are replaced with underscores when
5645 adding an extension (".~" or ".swp"). This option is not available
5646 for MS-DOS, because then it would always be on. This option is useful
5647 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5648 or crossdos. When running the Win32 GUI version under Win32s, this
5649 option is always on by default.
5650
5651 *'showbreak'* *'sbr'* *E595*
5652'showbreak' 'sbr' string (default "")
5653 global
5654 {not in Vi}
5655 {not available when compiled without the |+linebreak|
5656 feature}
5657 String to put at the start of lines that have been wrapped. Useful
5658 values are "> " or "+++ ".
5659 Only printable single-cell characters are allowed, excluding <Tab> and
5660 comma (in a future version the comma might be used to separate the
5661 part that is shown at the end and at the start of a line).
5662 The characters are highlighted according to the '@' flag in
5663 'highlight'.
5664 Note that tabs after the showbreak will be displayed differently.
5665 If you want the 'showbreak' to appear in between line numbers, add the
5666 "n" flag to 'cpoptions'.
5667
5668 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5669'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5670 off)
5671 global
5672 {not in Vi}
5673 {not available when compiled without the
5674 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005675 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 terminal is slow.
5677 In Visual mode the size of the selected area is shown:
5678 - When selecting characters within a line, the number of characters.
5679 - When selecting more than one line, the number of lines.
5680 - When selecting a block, the size in screen characters: linesxcolumns.
5681 NOTE: This option is set to the Vi default value when 'compatible' is
5682 set and to the Vim default value when 'compatible' is reset.
5683
5684 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5685'showfulltag' 'sft' boolean (default off)
5686 global
5687 {not in Vi}
5688 When completing a word in insert mode (see |ins-completion|) from the
5689 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005690 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 matched a C function, you can see a template for what arguments are
5692 required (coding style permitting).
5693
5694 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5695'showmatch' 'sm' boolean (default off)
5696 global
5697 When a bracket is inserted, briefly jump to the matching one. The
5698 jump is only done if the match can be seen on the screen. The time to
5699 show the match can be set with 'matchtime'.
5700 A Beep is given if there is no match (no matter if the match can be
5701 seen or not). This option is reset when the 'paste' option is set.
5702 When the 'm' flag is not included in 'cpoptions', typing a character
5703 will immediately move the cursor back to where it belongs.
5704 See the "sm" field in 'guicursor' for setting the cursor shape and
5705 blinking when showing the match.
5706 The 'matchpairs' option can be used to specify the characters to show
5707 matches for. 'rightleft' and 'revins' are used to look for opposite
5708 matches.
5709 Note: For the use of the short form parental guidance is advised.
5710
5711 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5712'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5713 global
5714 If in Insert, Replace or Visual mode put a message on the last line.
5715 Use the 'M' flag in 'highlight' to set the type of highlighting for
5716 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005717 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005718 doesn't mean XIM is really active, especially when 'imactivatekey' is
5719 not set.
5720 NOTE: This option is set to the Vi default value when 'compatible' is
5721 set and to the Vim default value when 'compatible' is reset.
5722
5723 *'sidescroll'* *'ss'*
5724'sidescroll' 'ss' number (default 0)
5725 global
5726 {not in Vi}
5727 The minimal number of columns to scroll horizontally. Used only when
5728 the 'wrap' option is off and the cursor is moved off of the screen.
5729 When it is zero the cursor will be put in the middle of the screen.
5730 When using a slow terminal set it to a large number or 0. When using
5731 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5732 commands.
5733
5734 *'sidescrolloff'* *'siso'*
5735'sidescrolloff' 'siso' number (default 0)
5736 global
5737 {not in Vi}
5738 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005739 right of the cursor if 'nowrap' is set. Setting this option to a
5740 value greater than 0 while having |'sidescroll'| also at a non-zero
5741 value makes some context visible in the line you are scrolling in
5742 horizontally (except at beginning of the line). Setting this option
5743 to a large value (like 999) has the effect of keeping the cursor
5744 horizontally centered in the window, as long as one does not come too
5745 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 NOTE: This option is set to 0 when 'compatible' is set.
5747
5748 Example: Try this together with 'sidescroll' and 'listchars' as
5749 in the following example to never allow the cursor to move
5750 onto the "extends" character:
5751
5752 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5753 :set sidescrolloff=1
5754
5755
5756 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5757'smartcase' 'scs' boolean (default off)
5758 global
5759 {not in Vi}
5760 Override the 'ignorecase' option if the search pattern contains upper
5761 case characters. Only used when the search pattern is typed and
5762 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005763 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5765 recalling the search pattern from history and hitting <Enter>.
5766 NOTE: This option is reset when 'compatible' is set.
5767
5768 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5769'smartindent' 'si' boolean (default off)
5770 local to buffer
5771 {not in Vi}
5772 {not available when compiled without the
5773 |+smartindent| feature}
5774 Do smart autoindenting when starting a new line. Works for C-like
5775 programs, but can also be used for other languages. 'cindent' does
5776 something like this, works better in most cases, but is more strict,
5777 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5778 'indentexpr' is a more advanced alternative.
5779 Normally 'autoindent' should also be on when using 'smartindent'.
5780 An indent is automatically inserted:
5781 - After a line ending in '{'.
5782 - After a line starting with a keyword from 'cinwords'.
5783 - Before a line starting with '}' (only with the "O" command).
5784 When typing '}' as the first character in a new line, that line is
5785 given the same indent as the matching '{'.
5786 When typing '#' as the first character in a new line, the indent for
5787 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005788 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005789 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5790 When using the ">>" command, lines starting with '#' are not shifted
5791 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 is set smart indenting is disabled.
5794
5795 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5796'smarttab' 'sta' boolean (default off)
5797 global
5798 {not in Vi}
5799 When on, a <Tab> in front of a line inserts blanks according to
5800 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5801 a 'shiftwidth' worth of space at the start of the line.
5802 When off a <Tab> always inserts blanks according to 'tabstop'.
5803 'shiftwidth' is only used for shifting text left or right
5804 |shift-left-right|.
5805 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5806 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005807 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808 NOTE: This option is reset when 'compatible' is set.
5809
5810 *'softtabstop'* *'sts'*
5811'softtabstop' 'sts' number (default 0)
5812 local to buffer
5813 {not in Vi}
5814 Number of spaces that a <Tab> counts for while performing editing
5815 operations, like inserting a <Tab> or using <BS>. It "feels" like
5816 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5817 used. This is useful to keep the 'ts' setting at its standard value
5818 of 8, while being able to edit like it is set to 'sts'. However,
5819 commands like "x" still work on the actual characters.
5820 When 'sts' is zero, this feature is off.
5821 'softtabstop' is set to 0 when the 'paste' option is set.
5822 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5823 spaces is minimized by using <Tab>s.
5824 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5825 set.
5826 NOTE: This option is set to 0 when 'compatible' is set.
5827
Bram Moolenaar217ad922005-03-20 22:37:15 +00005828 *'spell'* *'nospell'*
5829'spell' boolean (default off)
5830 local to window
5831 {not in Vi}
5832 {not available when compiled without the |+syntax|
5833 feature}
5834 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005835 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005836
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005837 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005838'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005839 local to buffer
5840 {not in Vi}
5841 {not available when compiled without the |+syntax|
5842 feature}
5843 Pattern to locate the end of a sentence. The following word will be
5844 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005845 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005846 When this check is not wanted make this option empty.
5847 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005848 Be careful with special characters, see |option-backslash| about
5849 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005850 To set this option automatically depending on the language, see
5851 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005852
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005853 *'spellfile'* *'spf'*
5854'spellfile' 'spf' string (default empty)
5855 local to buffer
5856 {not in Vi}
5857 {not available when compiled without the |+syntax|
5858 feature}
5859 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005860 commands. It must end in ".{encoding}.add". You need to include the
5861 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005862 *E765*
5863 It may also be a comma separated list of names. A count before the
5864 |zg| and |zw| commands can be used to access each. This allows using
5865 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005866 When a word is added while this option is empty Vim will set it for
5867 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005868 writable and the first language name that appears in 'spelllang',
5869 ignoring the region.
5870 The resulting ".spl" file will be used for spell checking, it does not
5871 have to appear in 'spelllang'.
5872 Normally one file is used for all regions, but you can add the region
5873 name if you want to. However, it will then only be used when
5874 'spellfile' is set to it, for entries in 'spelllang' only files
5875 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005876 This option cannot be set from a |modeline| or in the |sandbox|, for
5877 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005878
Bram Moolenaar217ad922005-03-20 22:37:15 +00005879 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005880'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005881 local to buffer
5882 {not in Vi}
5883 {not available when compiled without the |+syntax|
5884 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005885 A comma separated list of word list names. When the 'spell' option is
5886 on spellchecking will be done for these languages. Example: >
5887 set spelllang=en_us,nl,medical
5888< This means US English, Dutch and medical words are recognized. Words
5889 that are not recognized will be highlighted.
5890 The word list name must not include a comma or dot. Using a dash is
5891 recommended to separate the two letter language name from a
5892 specification. Thus "en-rare" is used for rare English words.
5893 A region name must come last and have the form "_xx", where "xx" is
5894 the two-letter, lower case region name. You can use more than one
5895 region by listing them: "en_us,en_ca" supports both US and Canadian
5896 English, but not words specific for Australia, New Zealand or Great
5897 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005898 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005899 As a special case the name of a .spl file can be given as-is. The
5900 first "_xx" in the name is removed and used as the region name
5901 (_xx is an underscore, two letters and followed by a non-letter).
5902 This is mainly for testing purposes. You must make sure the correct
5903 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005904 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005905 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5906 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005907 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005908
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005909 After this option has been set successfully, Vim will source the files
5910 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5911 up to the first comma, dot or underscore. See |set-spc-auto|.
5912
5913
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005914 *'spellsuggest'* *'sps'*
5915'spellsuggest' 'sps' string (default "best")
5916 global
5917 {not in Vi}
5918 {not available when compiled without the |+syntax|
5919 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005920 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005921 the |spellsuggest()| function. This is a comma-separated list of
5922 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005923
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005924 best Internal method that works best for English. Finds
5925 changes like "fast" and uses a bit of sound-a-like
5926 scoring to improve the ordering.
5927
5928 double Internal method that uses two methods and mixes the
5929 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005930 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005931 word. That only works when the language specifies
5932 sound folding. Can be slow and doesn't always give
5933 better results.
5934
5935 fast Internal method that only checks for simple changes:
5936 character inserts/deletes/swaps. Works well for
5937 simple typing mistakes.
5938
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005939 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005940 Not used for |spellsuggest()|. The number of
5941 suggestions is never more than the value of 'lines'
5942 minus two.
5943
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005944 file:{filename} Read file {filename}, which must have two columns,
5945 separated by a slash. The first column contains the
5946 bad word, the second column the suggested good word.
5947 Example:
5948 theribal/terrible ~
5949 Use this for common mistakes that do not appear at the
5950 top of the suggestion list with the internal methods.
5951 Lines without a slash are ignored, use this for
5952 comments.
5953 The file is used for all languages.
5954
5955 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5956 trouble with spaces. |v:val| holds the badly spelled
5957 word. The expression must evaluate to a List of
5958 Lists, each with a suggestion and a score.
5959 Example:
5960 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005961 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005962 internal methods use. A lower score is better.
5963 This may invoke |spellsuggest()| if you temporarily
5964 set 'spellsuggest' to exclude the "expr:" part.
5965 Errors are silently ignored, unless you set the
5966 'verbose' option to a non-zero value.
5967
5968 Only one of "best", "double" or "fast" may be used. The others may
5969 appear several times in any order. Example: >
5970 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5971<
5972 This option cannot be set from a |modeline| or in the |sandbox|, for
5973 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005974
5975
Bram Moolenaar071d4272004-06-13 20:20:40 +00005976 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5977'splitbelow' 'sb' boolean (default off)
5978 global
5979 {not in Vi}
5980 {not available when compiled without the +windows
5981 feature}
5982 When on, splitting a window will put the new window below the current
5983 one. |:split|
5984
5985 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5986'splitright' 'spr' boolean (default off)
5987 global
5988 {not in Vi}
5989 {not available when compiled without the +vertsplit
5990 feature}
5991 When on, splitting a window will put the new window right of the
5992 current one. |:vsplit|
5993
5994 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5995'startofline' 'sol' boolean (default on)
5996 global
5997 {not in Vi}
5998 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005999 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006000 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006001 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 with a linewise operator, with "%" with a count and to buffer changing
6003 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6004 only has a line number, e.g., ":25" or ":+".
6005 In case of buffer changing commands the cursor is placed at the column
6006 where it was the last time the buffer was edited.
6007 NOTE: This option is set when 'compatible' is set.
6008
6009 *'statusline'* *'stl'* *E540* *E541* *E542*
6010'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006011 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006012 {not in Vi}
6013 {not available when compiled without the |+statusline|
6014 feature}
6015 When nonempty, this option determines the content of the status line.
6016 Also see |status-line|.
6017
6018 The option consists of printf style '%' items interspersed with
6019 normal text. Each status line item is of the form:
6020 %-0{minwid}.{maxwid}{item}
6021 All fields except the {item} is optional. A single percent sign can
6022 be given as "%%". Up to 80 items can be specified.
6023
6024 Note that the only effect of 'ruler' when this option is set (and
6025 'laststatus' is 2) is controlling the output of |CTRL-G|.
6026
6027 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006028 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006029 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006030 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006031 minwid Minimum width of the item, padding as set by '-' & '0'.
6032 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006033 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006034 on the left for text items. Numeric items will be
6035 shifted down to maxwid-2 digits followed by '>'number
6036 where number is the amount of missing digits, much like
6037 an exponential notation.
6038 item A one letter code as described below.
6039
6040 Following is a description of the possible statusline items. The
6041 second character in "item" is the type:
6042 N for number
6043 S for string
6044 F for flags as described below
6045 - not applicable
6046
6047 item meaning ~
6048 f S Path to the file in the buffer, relative to current directory.
6049 F S Full path to the file in the buffer.
6050 t S File name (tail) of file in the buffer.
6051 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6052 M F Modified flag, text is ",+" or ",-".
6053 r F Readonly flag, text is " [RO]".
6054 R F Readonly flag, text is ",RO".
6055 h F Help buffer flag, text is " [help]".
6056 H F Help buffer flag, text is ",HLP".
6057 w F Preview window flag, text is " [Preview]".
6058 W F Preview window flag, text is ",PRV".
6059 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6060 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6061 {not available when compiled without |+autocmd| feature}
6062 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6063 being used: "<keymap>"
6064 n N Buffer number.
6065 b N Value of byte under cursor.
6066 B N As above, in hexadecimal.
6067 o N Byte number in file of byte under cursor, first byte is 1.
6068 Mnemonic: Offset from start of file (with one added)
6069 {not available when compiled without |+byte_offset| feature}
6070 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006071 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006072 l N Line number.
6073 L N Number of lines in buffer.
6074 c N Column number.
6075 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006076 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006077 p N Percentage through file in lines as in |CTRL-G|.
6078 P S Percentage through file of displayed window. This is like the
6079 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006080 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 Empty if the argument file count is zero or one.
6082 { NF Evaluate expression between '{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006083 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006084 ( - Start of item group. Can be used for setting the width and
6085 alignment of a section. Must be followed by %) somewhere.
6086 ) - End of item group. No width fields allowed.
6087 < - Where to truncate line if too long. Default is at the start.
6088 No width fields allowed.
6089 = - Separation point between left and right aligned items.
6090 No width fields allowed.
6091 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006092 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 The difference between User{N} and StatusLine will be applied
6094 to StatusLineNC for the statusline of non-current windows.
6095 The number N must be between 1 and 9. See |hl-User1..9|
6096
6097 Display of flags are controlled by the following heuristic:
6098 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006099 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 with a space it is assumed that it wants to separate itself from
6101 anything but other flags. That is: A leading comma is removed if the
6102 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006103 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 make a nice display when flags are used like in the examples below.
6105
Bram Moolenaar582fd852005-03-28 20:58:01 +00006106 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 not set) and a minwid is not set for the group, the whole group will
6108 become empty. This will make a group like the following disappear
6109 completely from the statusline when none of the flags are set. >
6110 :set statusline=...%(\ [%M%R%H]%)...
6111<
6112 Beware that an expression is evaluated each and every time the status
6113 line is displayed. The current buffer and current window will be set
6114 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006115 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006117 real current buffer.
6118
6119 The 'statusline' option may be evaluated in the |sandbox|, see
6120 |sandbox-option|.
6121
6122 It is not allowed to change text or jump to another window while
6123 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124
6125 If the statusline is not updated when you want it (e.g., after setting
6126 a variable that's used in an expression), you can force an update by
6127 setting an option without changing its value. Example: >
6128 :let &ro = &ro
6129
6130< A result of all digits is regarded a number for display purposes.
6131 Otherwise the result is taken as flag text and applied to the rules
6132 described above.
6133
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006134 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6136 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6137
6138 Examples:
6139 Emulate standard status line with 'ruler' set >
6140 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6141< Similar, but add ASCII value of char under the cursor (like "ga") >
6142 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6143< Display byte count and byte value, modified flag in red. >
6144 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6145 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6146< Display a ,GZ flag if a compressed file is loaded >
6147 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6148< In the |:autocmd|'s: >
6149 :let b:gzflag = 1
6150< And: >
6151 :unlet b:gzflag
6152< And define this function: >
6153 :function VarExists(var, val)
6154 : if exists(a:var) | return a:val | else | return '' | endif
6155 :endfunction
6156<
6157 *'suffixes'* *'su'*
6158'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6159 global
6160 {not in Vi}
6161 Files with these suffixes get a lower priority when multiple files
6162 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006163 suffixes. Spaces after the comma are ignored. A dot is also seen as
6164 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 separator, precede it with a backslash (see |option-backslash| about
6166 including spaces and backslashes).
6167 See 'wildignore' for completely ignoring files.
6168 The use of |:set+=| and |:set-=| is preferred when adding or removing
6169 suffixes from the list. This avoids problems when a future version
6170 uses another default.
6171
6172 *'suffixesadd'* *'sua'*
6173'suffixesadd' 'sua' string (default "")
6174 local to buffer
6175 {not in Vi}
6176 {not available when compiled without the
6177 |+file_in_path| feature}
6178 Comma separated list of suffixes, which are used when searching for a
6179 file for the "gf", "[I", etc. commands. Example: >
6180 :set suffixesadd=.java
6181<
6182 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6183'swapfile' 'swf' boolean (default on)
6184 local to buffer
6185 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006186 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 swapfile is not wanted for a specific buffer. For example, with
6188 confidential information that even root must not be able to access.
6189 Careful: All text will be in memory:
6190 - Don't use this for big files.
6191 - Recovery will be impossible!
6192 A swapfile will only be present when |'updatecount'| is non-zero and
6193 'swapfile' is set.
6194 When 'swapfile' is reset, the swap file for the current buffer is
6195 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6196 non-zero, a swap file is immediately created.
6197 Also see |swap-file| and |'swapsync'|.
6198
6199 This option is used together with 'bufhidden' and 'buftype' to
6200 specify special kinds of buffers. See |special-buffers|.
6201
6202 *'swapsync'* *'sws'*
6203'swapsync' 'sws' string (default "fsync")
6204 global
6205 {not in Vi}
6206 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006207 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 When this option is empty parts of the swap file may be in memory and
6209 not written to disk. When the system crashes you may lose more work.
6210 On Unix the system does a sync now and then without Vim asking for it,
6211 so the disadvantage of setting this option off is small. On some
6212 systems the swap file will not be written at all. For a unix system
6213 setting it to "sync" will use the sync() call instead of the default
6214 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006215 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006216
6217 *'switchbuf'* *'swb'*
6218'switchbuf' 'swb' string (default "")
6219 global
6220 {not in Vi}
6221 This option controls the behavior when switching between buffers.
6222 Possible values (comma separated list):
6223 useopen If included, jump to the first open window that
6224 contains the specified buffer (if there is one).
6225 Otherwise: Do not examine other windows.
6226 This setting is checked with |quickfix| commands, when
6227 jumping to errors (":cc", ":cn", "cp", etc.). It is
6228 also used in all buffer related split commands, for
6229 example ":sbuffer", ":sbnext", or ":sbrewind".
6230 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006231 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 Supported in |quickfix| commands that display errors.
6233
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006234 *'synmaxcol'* *'smc'*
6235'synmaxcol' 'smc' number (default 3000)
6236 local to buffer
6237 {not in Vi}
6238 {not available when compiled without the |+syntax|
6239 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006240 Maximum column in which to search for syntax items. In long lines the
6241 text after this column is not highlighted and following lines may not
6242 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006243 This helps to avoid very slow redrawing for an XML file that is one
6244 long line.
6245 Set to zero to remove the limit.
6246
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 *'syntax'* *'syn'*
6248'syntax' 'syn' string (default empty)
6249 local to buffer
6250 {not in Vi}
6251 {not available when compiled without the |+syntax|
6252 feature}
6253 When this option is set, the syntax with this name is loaded, unless
6254 syntax highlighting has been switched off with ":syntax off".
6255 Otherwise this option does not always reflect the current syntax (the
6256 b:current_syntax variable does).
6257 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006258 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 /* vim: set syntax=idl : */
6260< To switch off syntax highlighting for the current file, use: >
6261 :set syntax=OFF
6262< To switch syntax highlighting on according to the current value of the
6263 'filetype' option: >
6264 :set syntax=ON
6265< What actually happens when setting the 'syntax' option is that the
6266 Syntax autocommand event is triggered with the value as argument.
6267 This option is not copied to another buffer, independent of the 's' or
6268 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006269 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270
6271 *'tabstop'* *'ts'*
6272'tabstop' 'ts' number (default 8)
6273 local to buffer
6274 Number of spaces that a <Tab> in the file counts for. Also see
6275 |:retab| command, and 'softtabstop' option.
6276
6277 Note: Setting 'tabstop' to any other value than 8 can make your file
6278 appear wrong in many places (e.g., when printing it).
6279
6280 There are four main ways to use tabs in Vim:
6281 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6282 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6283 will use a mix of tabs and spaces, but typing Tab and BS will
6284 behave like a tab appears every 4 (or 3) characters.
6285 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6286 'expandtab'. This way you will always insert spaces. The
6287 formatting will never be messed up when 'tabstop' is changed.
6288 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006289 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 works when using Vim to edit the file.
6291 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6292 'noexpandtab'. This should then work (for initial indents only)
6293 for any tabstop setting that people use. It might be nice to have
6294 tabs after the first non-blank inserted as spaces if you do this
6295 though. Otherwise aligned comments will be wrong when 'tabstop' is
6296 changed.
6297
6298 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6299'tagbsearch' 'tbs' boolean (default on)
6300 global
6301 {not in Vi}
6302 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006303 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 searching makes searching for a tag a LOT faster, but a linear search
6305 will find more tags if the tags file wasn't properly sorted.
6306 Vim normally assumes that your tags files are sorted, or indicate that
6307 they are not sorted. Only when this is not the case does the
6308 'tagbsearch' option need to be switched off.
6309
6310 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006311 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 certain files, or retry all files with a linear search. When
6313 'tagbsearch' is off, only a linear search is done.
6314
6315 Linear searching is done anyway, for one file, when Vim finds a line
6316 at the start of the file indicating that it's not sorted: >
6317 !_TAG_FILE_SORTED 0 /some command/
6318< [The whitespace before and after the '0' must be a single <Tab>]
6319
6320 When a binary search was done and no match was found in any of the
6321 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6322 instead of a normal tag name, a retry is done with a linear search.
6323 Tags in unsorted tags files, and matches with different case will only
6324 be found in the retry.
6325
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006326 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 linear search can be avoided for the 'ignorecase' case. Use a value
6328 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6329 case-fold sorted with the -f switch to "sort" in most unices, as in
6330 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6331 5.3 or higher the -f or --fold-case-sort switch can be used for this
6332 as well. Note that case must be folded to uppercase for this to work.
6333
6334 When 'tagbsearch' is off, tags searching is slower when a full match
6335 exists, but faster when no full match exists. Tags in unsorted tags
6336 files may only be found with 'tagbsearch' off.
6337 When the tags file is not sorted, or sorted in a wrong way (not on
6338 ASCII byte value), 'tagbsearch' should be off, or the line given above
6339 must be included in the tags file.
6340 This option doesn't affect commands that find all matching tags (e.g.,
6341 command-line completion and ":help").
6342 {Vi: always uses binary search in some versions}
6343
6344 *'taglength'* *'tl'*
6345'taglength' 'tl' number (default 0)
6346 global
6347 If non-zero, tags are significant up to this number of characters.
6348
6349 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6350'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6351 global
6352 {not in Vi}
6353 If on and using a tag file in another directory, file names in that
6354 tag file are relative to the directory where the tag file is.
6355 NOTE: This option is set to the Vi default value when 'compatible' is
6356 set and to the Vim default value when 'compatible' is reset.
6357
6358 *'tags'* *'tag'* *E433*
6359'tags' 'tag' string (default "./tags,tags", when compiled with
6360 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6361 global or local to buffer |global-local|
6362 Filenames for the tag command, separated by spaces or commas. To
6363 include a space or comma in a file name, precede it with a backslash
6364 (see |option-backslash| about including spaces and backslashes).
6365 When a file name starts with "./", the '.' is replaced with the path
6366 of the current file. But only when the 'd' flag is not included in
6367 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6368 |tags-option|.
6369 "*", "**" and other wildcards can be used to search for tags files in
6370 a directory tree. See |file-searching|. {not available when compiled
6371 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006372 The |tagfiles()| function can be used to get a list of the file names
6373 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6375 files are also supported. They are automatically recognized. The
6376 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6377 differences are ignored (MS-Windows). |emacs-tags|
6378 The use of |:set+=| and |:set-=| is preferred when adding or removing
6379 file names from the list. This avoids problems when a future version
6380 uses another default.
6381 {Vi: default is "tags /usr/lib/tags"}
6382
6383 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6384'tagstack' 'tgst' boolean (default on)
6385 global
6386 {not in all versions of Vi}
6387 When on, the |tagstack| is used normally. When off, a ":tag" or
6388 ":tselect" command with an argument will not push the tag onto the
6389 tagstack. A following ":tag" without an argument, a ":pop" command or
6390 any other command that uses the tagstack will use the unmodified
6391 tagstack, but does change the pointer to the active entry.
6392 Resetting this option is useful when using a ":tag" command in a
6393 mapping which should not change the tagstack.
6394
6395 *'term'* *E529* *E530* *E531*
6396'term' string (default is $TERM, if that fails:
6397 in the GUI: "builtin_gui"
6398 on Amiga: "amiga"
6399 on BeOS: "beos-ansi"
6400 on Mac: "mac-ansi"
6401 on MiNT: "vt52"
6402 on MS-DOS: "pcterm"
6403 on OS/2: "os2ansi"
6404 on Unix: "ansi"
6405 on VMS: "ansi"
6406 on Win 32: "win32")
6407 global
6408 Name of the terminal. Used for choosing the terminal control
6409 characters. Environment variables are expanded |:set_env|.
6410 For example: >
6411 :set term=$TERM
6412< See |termcap|.
6413
6414 *'termbidi'* *'tbidi'*
6415 *'notermbidi'* *'notbidi'*
6416'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6417 global
6418 {not in Vi}
6419 {only available when compiled with the |+arabic|
6420 feature}
6421 The terminal is in charge of Bi-directionality of text (as specified
6422 by Unicode). The terminal is also expected to do the required shaping
6423 that some languages (such as Arabic) require.
6424 Setting this option implies that 'rightleft' will not be set when
6425 'arabic' is set and the value of 'arabicshape' will be ignored.
6426 Note that setting 'termbidi' has the immediate effect that
6427 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6428 This option is reset when the GUI is started.
6429 For further details see |arabic.txt|.
6430
6431 *'termencoding'* *'tenc'*
6432'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6433 Macintosh GUI: "macroman")
6434 global
6435 {only available when compiled with the |+multi_byte|
6436 feature}
6437 {not in Vi}
6438 Encoding used for the terminal. This specifies what character
6439 encoding the keyboard produces and the display will understand. For
6440 the GUI it only applies to the keyboard ('encoding' is used for the
6441 display).
6442 In the Win32 console version the default value is the console codepage
6443 when it differs from the ANSI codepage.
6444 *E617*
6445 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6446 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6447 Any attempts to set a different value will be rejected, and an error
6448 message is shown.
6449 For the Win32 GUI 'termencoding' is not used for typed characters,
6450 because the Win32 system always passes Unicode characters.
6451 When empty, the same encoding is used as for the 'encoding' option.
6452 This is the normal value.
6453 Not all combinations for 'termencoding' and 'encoding' are valid. See
6454 |encoding-table|.
6455 The value for this option must be supported by internal conversions or
6456 iconv(). When this is not possible no conversion will be done and you
6457 will probably experience problems with non-ASCII characters.
6458 Example: You are working with the locale set to euc-jp (Japanese) and
6459 want to edit a UTF-8 file: >
6460 :let &termencoding = &encoding
6461 :set encoding=utf-8
6462< You need to do this when your system has no locale support for UTF-8.
6463
6464 *'terse'* *'noterse'*
6465'terse' boolean (default off)
6466 global
6467 When set: Add 's' flag to 'shortmess' option (this makes the message
6468 for a search that hits the start or end of the file not being
6469 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6470 shortens a lot of messages}
6471
6472 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6473'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6474 global
6475 {not in Vi}
6476 This option is obsolete. Use 'fileformats'.
6477 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6478 set to the default value for the current system. When 'textauto' is
6479 reset, 'fileformats' is made empty.
6480 NOTE: This option is set to the Vi default value when 'compatible' is
6481 set and to the Vim default value when 'compatible' is reset.
6482
6483 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6484'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6485 others: default off)
6486 local to buffer
6487 {not in Vi}
6488 This option is obsolete. Use 'fileformat'.
6489 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6490 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6491 "unix".
6492
6493 *'textwidth'* *'tw'*
6494'textwidth' 'tw' number (default 0)
6495 local to buffer
6496 {not in Vi}
6497 Maximum width of text that is being inserted. A longer line will be
6498 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006499 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6500 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006501 'formatoptions' and |ins-textwidth|.
6502 NOTE: This option is set to 0 when 'compatible' is set.
6503
6504 *'thesaurus'* *'tsr'*
6505'thesaurus' 'tsr' string (default "")
6506 global or local to buffer |global-local|
6507 {not in Vi}
6508 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006509 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 the file should contain words with similar meaning, separated by
6511 non-keyword characters (white space is preferred). Maximum line
6512 length is 510 bytes.
6513 To obtain a file to be used here, check out the wordlist FAQ at
6514 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006515 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 after a comma are ignored, otherwise spaces are included in the file
6517 name. See |option-backslash| about using backslashes.
6518 The use of |:set+=| and |:set-=| is preferred when adding or removing
6519 directories from the list. This avoids problems when a future version
6520 uses another default.
6521 Backticks cannot be used in this option for security reasons.
6522
6523 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6524'tildeop' 'top' boolean (default off)
6525 global
6526 {not in Vi}
6527 When on: The tilde command "~" behaves like an operator.
6528 NOTE: This option is reset when 'compatible' is set.
6529
6530 *'timeout'* *'to'* *'notimeout'* *'noto'*
6531'timeout' 'to' boolean (default on)
6532 global
6533 *'ttimeout'* *'nottimeout'*
6534'ttimeout' boolean (default off)
6535 global
6536 {not in Vi}
6537 These two options together determine the behavior when part of a
6538 mapped key sequence or keyboard code has been received:
6539
6540 'timeout' 'ttimeout' action ~
6541 off off do not time out
6542 on on or off time out on :mappings and key codes
6543 off on time out on key codes
6544
6545 If both options are off, Vim will wait until either the complete
6546 mapping or key sequence has been received, or it is clear that there
6547 is no mapping or key sequence for the received characters. For
6548 example: if you have mapped "vl" and Vim has received 'v', the next
6549 character is needed to see if the 'v' is followed by an 'l'.
6550 When one of the options is on, Vim will wait for about 1 second for
6551 the next character to arrive. After that the already received
6552 characters are interpreted as single characters. The waiting time can
6553 be changed with the 'timeoutlen' option.
6554 On slow terminals or very busy systems timing out may cause
6555 malfunctioning cursor keys. If both options are off, Vim waits
6556 forever after an entered <Esc> if there are key codes that start
6557 with <Esc>. You will have to type <Esc> twice. If you do not have
6558 problems with key codes, but would like to have :mapped key
6559 sequences not timing out in 1 second, set the 'ttimeout' option and
6560 reset the 'timeout' option.
6561
6562 NOTE: 'ttimeout' is reset when 'compatible' is set.
6563
6564 *'timeoutlen'* *'tm'*
6565'timeoutlen' 'tm' number (default 1000)
6566 global
6567 {not in all versions of Vi}
6568 *'ttimeoutlen'* *'ttm'*
6569'ttimeoutlen' 'ttm' number (default -1)
6570 global
6571 {not in Vi}
6572 The time in milliseconds that is waited for a key code or mapped key
6573 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6574 when part of a command has been typed.
6575 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6576 different timeout value for key codes is desired set 'ttimeoutlen' to
6577 a non-negative number.
6578
6579 ttimeoutlen mapping delay key code delay ~
6580 < 0 'timeoutlen' 'timeoutlen'
6581 >= 0 'timeoutlen' 'ttimeoutlen'
6582
6583 The timeout only happens when the 'timeout' and 'ttimeout' options
6584 tell so. A useful setting would be >
6585 :set timeout timeoutlen=3000 ttimeoutlen=100
6586< (time out on mapping after three seconds, time out on key codes after
6587 a tenth of a second).
6588
6589 *'title'* *'notitle'*
6590'title' boolean (default off, on when title can be restored)
6591 global
6592 {not in Vi}
6593 {not available when compiled without the |+title|
6594 feature}
6595 When on, the title of the window will be set to the value of
6596 'titlestring' (if it is not empty), or to:
6597 filename [+=-] (path) - VIM
6598 Where:
6599 filename the name of the file being edited
6600 - indicates the file cannot be modified, 'ma' off
6601 + indicates the file was modified
6602 = indicates the file is read-only
6603 =+ indicates the file is read-only and modified
6604 (path) is the path of the file being edited
6605 - VIM the server name |v:servername| or "VIM"
6606 Only works if the terminal supports setting window titles
6607 (currently Amiga console, Win32 console, all GUI versions and
6608 terminals with a non- empty 't_ts' option - these are Unix xterm and
6609 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6610 *X11*
6611 When Vim was compiled with HAVE_X11 defined, the original title will
6612 be restored if possible. The output of ":version" will include "+X11"
6613 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6614 works for the icon name |'icon'|.
6615 But: When Vim was started with the |-X| argument, restoring the title
6616 will not work (except in the GUI).
6617 If the title cannot be restored, it is set to the value of 'titleold'.
6618 You might want to restore the title outside of Vim then.
6619 When using an xterm from a remote machine you can use this command:
6620 rsh machine_name xterm -display $DISPLAY &
6621 then the WINDOWID environment variable should be inherited and the
6622 title of the window should change back to what it should be after
6623 exiting Vim.
6624
6625 *'titlelen'*
6626'titlelen' number (default 85)
6627 global
6628 {not in Vi}
6629 {not available when compiled without the |+title|
6630 feature}
6631 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006632 title. When the title is longer, only the end of the path name is
6633 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 Using a percentage makes this adapt to the width of the window. But
6635 it won't work perfectly, because the actual number of characters
6636 available also depends on the font used and other things in the title
6637 bar. When 'titlelen' is zero the full path is used. Otherwise,
6638 values from 1 to 30000 percent can be used.
6639 'titlelen' is also used for the 'titlestring' option.
6640
6641 *'titleold'*
6642'titleold' string (default "Thanks for flying Vim")
6643 global
6644 {not in Vi}
6645 {only available when compiled with the |+title|
6646 feature}
6647 This option will be used for the window title when exiting Vim if the
6648 original title cannot be restored. Only happens if 'title' is on or
6649 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006650 This option cannot be set from a |modeline| or in the |sandbox|, for
6651 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 *'titlestring'*
6653'titlestring' string (default "")
6654 global
6655 {not in Vi}
6656 {not available when compiled without the |+title|
6657 feature}
6658 When this option is not empty, it will be used for the title of the
6659 window. This happens only when the 'title' option is on.
6660 Only works if the terminal supports setting window titles (currently
6661 Amiga console, Win32 console, all GUI versions and terminals with a
6662 non-empty 't_ts' option).
6663 When Vim was compiled with HAVE_X11 defined, the original title will
6664 be restored if possible |X11|.
6665 When this option contains printf-style '%' items, they will be
6666 expanded according to the rules used for 'statusline'.
6667 Example: >
6668 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6669 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6670< The value of 'titlelen' is used to align items in the middle or right
6671 of the available space.
6672 Some people prefer to have the file name first: >
6673 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6674< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006675 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 separating space only when needed.
6677 NOTE: Use of special characters in 'titlestring' may cause the display
6678 to be garbled (e.g., when it contains a CR or NL character).
6679 {not available when compiled without the |+statusline| feature}
6680
6681 *'toolbar'* *'tb'*
6682'toolbar' 'tb' string (default "icons,tooltips")
6683 global
6684 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6685 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006686 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006687 possible values are:
6688 icons Toolbar buttons are shown with icons.
6689 text Toolbar buttons shown with text.
6690 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006691 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 tooltips Tooltips are active for toolbar buttons.
6693 Tooltips refer to the popup help text which appears after the mouse
6694 cursor is placed over a toolbar button for a brief moment.
6695
6696 If you want the toolbar to be shown with icons as well as text, do the
6697 following: >
6698 :set tb=icons,text
6699< Motif and Athena cannot display icons and text at the same time. They
6700 will show icons if both are requested.
6701
6702 If none of the strings specified in 'toolbar' are valid or if
6703 'toolbar' is empty, this option is ignored. If you want to disable
6704 the toolbar, you need to set the 'guioptions' option. For example: >
6705 :set guioptions-=T
6706< Also see |gui-toolbar|.
6707
6708 *'toolbariconsize'* *'tbis'*
6709'toolbariconsize' 'tbis' string (default "small")
6710 global
6711 {not in Vi}
6712 {only in the GTK+ 2 GUI}
6713 Controls the size of toolbar icons. The possible values are:
6714 tiny Use tiny toolbar icons.
6715 small Use small toolbar icons (default).
6716 medium Use medium-sized toolbar icons.
6717 large Use large toolbar icons.
6718 The exact dimensions in pixels of the various icon sizes depend on
6719 the current theme. Common dimensions are large=32x32, medium=24x24,
6720 small=20x20 and tiny=16x16.
6721
6722 If 'toolbariconsize' is empty, the global default size as determined
6723 by user preferences or the current theme is used.
6724
6725 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6726'ttybuiltin' 'tbi' boolean (default on)
6727 global
6728 {not in Vi}
6729 When on, the builtin termcaps are searched before the external ones.
6730 When off the builtin termcaps are searched after the external ones.
6731 When this option is changed, you should set the 'term' option next for
6732 the change to take effect, for example: >
6733 :set notbi term=$TERM
6734< See also |termcap|.
6735 Rationale: The default for this option is "on", because the builtin
6736 termcap entries are generally better (many systems contain faulty
6737 xterm entries...).
6738
6739 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6740'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6741 sun-cmd, screen, rxvt, dtterm or
6742 iris-ansi; also on when running Vim in
6743 a DOS console)
6744 global
6745 {not in Vi}
6746 Indicates a fast terminal connection. More characters will be sent to
6747 the screen for redrawing, instead of using insert/delete line
6748 commands. Improves smoothness of redrawing when there are multiple
6749 windows and the terminal does not support a scrolling region.
6750 Also enables the extra writing of characters at the end of each screen
6751 line for lines that wrap. This helps when using copy/paste with the
6752 mouse in an xterm and other terminals.
6753
6754 *'ttymouse'* *'ttym'*
6755'ttymouse' 'ttym' string (default depends on 'term')
6756 global
6757 {not in Vi}
6758 {only in Unix and VMS, doesn't work in the GUI; not
6759 available when compiled without |+mouse|}
6760 Name of the terminal type for which mouse codes are to be recognized.
6761 Currently these three strings are valid:
6762 *xterm-mouse*
6763 xterm xterm-like mouse handling. The mouse generates
6764 "<Esc>[Mscr", where "scr" is three bytes:
6765 "s" = button state
6766 "c" = column plus 33
6767 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006768 This only works up to 223 columns! See "dec" for a
6769 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 xterm2 Works like "xterm", but with the xterm reporting the
6771 mouse position while the mouse is dragged. This works
6772 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006773 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006774 work. See below for how Vim detects this
6775 automatically.
6776 *netterm-mouse*
6777 netterm NetTerm mouse handling. The mouse generates
6778 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6779 for the row and column.
6780 *dec-mouse*
6781 dec DEC terminal mouse handling. The mouse generates a
6782 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006783 This is also available for an Xterm, if it was
6784 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 *jsbterm-mouse*
6786 jsbterm JSB term mouse handling.
6787 *pterm-mouse*
6788 pterm QNX pterm mouse handling.
6789
6790 The mouse handling must be enabled at compile time |+mouse_xterm|
6791 |+mouse_dec| |+mouse_netterm|.
6792 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6793 recognized, if enabled at compile time. DEC terminal mouse codes
6794 are recognized if enabled at compile time, and 'ttymouse' is not
6795 "xterm" (because the xterm and dec mouse codes conflict).
6796 This option is automatically set to "xterm", when the 'term' option is
6797 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6798 or "xterm2" already. The main use of this option is to set it to
6799 "xterm", when the terminal name doesn't start with "xterm", but it can
6800 handle xterm mouse codes.
6801 The "xterm2" value will be set if the xterm version is reported to be
6802 95 of higher. This only works when compiled with the |+termresponse|
6803 feature and if |t_RV| is set to the escape sequence to request the
6804 xterm version number. Otherwise "xterm2" must be set explicitly.
6805 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6806 t_RV to an empty string: >
6807 :set t_RV=
6808<
6809 *'ttyscroll'* *'tsl'*
6810'ttyscroll' 'tsl' number (default 999)
6811 global
6812 Maximum number of lines to scroll the screen. If there are more lines
6813 to scroll the window is redrawn. For terminals where scrolling is
6814 very slow and redrawing is not slow this can be set to a small number,
6815 e.g., 3, to speed up displaying.
6816
6817 *'ttytype'* *'tty'*
6818'ttytype' 'tty' string (default from $TERM)
6819 global
6820 Alias for 'term', see above.
6821
6822 *'undolevels'* *'ul'*
6823'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6824 Win32 and OS/2)
6825 global
6826 {not in Vi}
6827 Maximum number of changes that can be undone. Since undo information
6828 is kept in memory, higher numbers will cause more memory to be used
6829 (nevertheless, a single change can use an unlimited amount of memory).
6830 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6831 itself: >
6832 set ul=0
6833< But you can also get Vi compatibility by including the 'u' flag in
6834 'cpoptions', and still be able to use CTRL-R to repeat undo.
6835 Set to a negative number for no undo at all: >
6836 set ul=-1
6837< This helps when you run out of memory for a single change.
6838 Also see |undo-two-ways|.
6839
6840 *'updatecount'* *'uc'*
6841'updatecount' 'uc' number (default: 200)
6842 global
6843 {not in Vi}
6844 After typing this many characters the swap file will be written to
6845 disk. When zero, no swap file will be created at all (see chapter on
6846 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6847 Vim with the "-n" option, see |startup|. When editing in readonly
6848 mode this option will be initialized to 10000.
6849 The swapfile can be disabled per buffer with |'swapfile'|.
6850 When 'updatecount' is set from zero to non-zero, swap files are
6851 created for all buffers that have 'swapfile' set. When 'updatecount'
6852 is set to zero, existing swap files are not deleted.
6853 Also see |'swapsync'|.
6854 This option has no meaning in buffers where |'buftype'| is "nofile"
6855 or "nowrite".
6856
6857 *'updatetime'* *'ut'*
6858'updatetime' 'ut' number (default 4000)
6859 global
6860 {not in Vi}
6861 If this many milliseconds nothing is typed the swap file will be
6862 written to disk (see |crash-recovery|). Also used for the
6863 |CursorHold| autocommand event.
6864
6865 *'verbose'* *'vbs'*
6866'verbose' 'vbs' number (default 0)
6867 global
6868 {not in Vi, although some versions have a boolean
6869 verbose option}
6870 When bigger than zero, Vim will give messages about what it is doing.
6871 Currently, these messages are given:
6872 >= 1 When the viminfo file is read or written.
6873 >= 2 When a file is ":source"'ed.
6874 >= 5 Every searched tags file.
6875 >= 8 Files for which a group of autocommands is executed.
6876 >= 9 Every executed autocommand.
6877 >= 12 Every executed function.
6878 >= 13 When an exception is thrown, caught, finished, or discarded.
6879 >= 14 Anything pending in a ":finally" clause.
6880 >= 15 Every executed Ex command (truncated at 200 characters).
6881
6882 This option can also be set with the "-V" argument. See |-V|.
6883 This option is also set by the |:verbose| command.
6884
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006885 When the 'verbosefile' option is set then the verbose messages are not
6886 displayed.
6887
6888 *'verbosefile'* *'vfile'*
6889'verbosefile' 'vfile' string (default empty)
6890 global
6891 {not in Vi}
6892 When not empty all messages are written in a file with this name.
6893 When the file exists messages are appended.
6894 Writing to the file ends when Vim exits or when 'verbosefile' is made
6895 empty.
6896 Setting 'verbosefile' to a new value is like making it empty first.
6897 The difference with |:redir| is that verbose messages are not
6898 displayed when 'verbosefile' is set.
6899
Bram Moolenaar071d4272004-06-13 20:20:40 +00006900 *'viewdir'* *'vdir'*
6901'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6902 "$VIM/vimfiles/view",
6903 for Unix: "~/.vim/view",
6904 for Macintosh: "$VIM:vimfiles:view"
6905 for VMS: "sys$login:vimfiles/view"
6906 for RiscOS: "Choices:vimfiles/view")
6907 global
6908 {not in Vi}
6909 {not available when compiled without the +mksession
6910 feature}
6911 Name of the directory where to store files for |:mkview|.
6912 This option cannot be set from a |modeline| or in the |sandbox|, for
6913 security reasons.
6914
6915 *'viewoptions'* *'vop'*
6916'viewoptions' 'vop' string (default: "folds,options,cursor")
6917 global
6918 {not in Vi}
6919 {not available when compiled without the +mksession
6920 feature}
6921 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006922 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 word save and restore ~
6924 cursor cursor position in file and in window
6925 folds manually created folds, opened/closed folds and local
6926 fold options
6927 options options and mappings local to a window or buffer (not
6928 global values for local options)
6929 slash backslashes in file names replaced with forward
6930 slashes
6931 unix with Unix end-of-line format (single <NL>), even when
6932 on Windows or DOS
6933
6934 "slash" and "unix" are useful on Windows when sharing view files
6935 with Unix. The Unix version of Vim cannot source dos format scripts,
6936 but the Windows version of Vim can source unix format scripts.
6937
6938 *'viminfo'* *'vi'* *E526* *E527* *E528*
6939'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6940 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6941 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6942 for others: '20,<50,s10,h)
6943 global
6944 {not in Vi}
6945 {not available when compiled without the |+viminfo|
6946 feature}
6947 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006948 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 separated list of parameters, each consisting of a single character
6950 identifying the particular parameter, followed by a number or string
6951 which specifies the value of that parameter. If a particular
6952 character is left out, then the default value is used for that
6953 parameter. The following is a list of the identifying characters and
6954 the effect of their value.
6955 CHAR VALUE ~
6956 ! When included, save and restore global variables that start
6957 with an uppercase letter, and don't contain a lowercase
6958 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006959 and "_K_L_M" are not. Only String and Number types are
6960 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006961 " Maximum number of lines saved for each register. Old name of
6962 the '<' item, with the disadvantage that you need to put a
6963 backslash before the ", otherwise it will be recognized as the
6964 start of a comment!
6965 % When included, save and restore the buffer list. If Vim is
6966 started with a file name argument, the buffer list is not
6967 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006968 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006969 without a file name and buffers for help files are not written
6970 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006971 When followed by a number, the number specifies the maximum
6972 number of buffers that are stored. Without a number all
6973 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 ' Maximum number of previously edited files for which the marks
6975 are remembered. This parameter must always be included when
6976 'viminfo' is non-empty.
6977 Including this item also means that the |jumplist| and the
6978 |changelist| are stored in the viminfo file.
6979 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006980 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006981 patterns are also saved. When not included, the value of
6982 'history' is used.
6983 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006984 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 < Maximum number of lines saved for each register. If zero then
6986 registers are not saved. When not included, all lines are
6987 saved. '"' is the old name for this item.
6988 Also see the 's' item below: limit specified in Kbyte.
6989 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006990 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006991 c When included, convert the text in the viminfo file from the
6992 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006993 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006994 f Whether file marks need to be stored. If zero, file marks ('0
6995 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006996 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 cursor position (when exiting or when doing ":wviminfo").
6998 h Disable the effect of 'hlsearch' when loading the viminfo
6999 file. When not included, it depends on whether ":nohlsearch"
7000 has been used since the last search command.
7001 n Name of the viminfo file. The name must immediately follow
7002 the 'n'. Must be the last one! If the "-i" argument was
7003 given when starting Vim, that file name overrides the one
7004 given here with 'viminfo'. Environment variables are expanded
7005 when opening the file, not when setting the option.
7006 r Removable media. The argument is a string (up to the next
7007 ','). This parameter can be given several times. Each
7008 specifies the start of a path for which no marks will be
7009 stored. This is to avoid removable media. For MS-DOS you
7010 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7011 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7012 ignored. Maximum length of each 'r' argument is 50
7013 characters.
7014 s Maximum size of an item in Kbyte. If zero then registers are
7015 not saved. Currently only applies to registers. The default
7016 "s10" will exclude registers with more than 10 Kbyte of text.
7017 Also see the '<' item above: line count limit.
7018
7019 Example: >
7020 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7021<
7022 '50 Marks will be remembered for the last 50 files you
7023 edited.
7024 <1000 Contents of registers (up to 1000 lines each) will be
7025 remembered.
7026 s100 Registers with more than 100 Kbyte text are skipped.
7027 :0 Command-line history will not be saved.
7028 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7029 no / Since '/' is not specified, the default will be used,
7030 that is, save all of the search history, and also the
7031 previous search and substitute patterns.
7032 no % The buffer list will not be saved nor read back.
7033 no h 'hlsearch' highlighting will be restored.
7034
7035 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7036 load the contents of the file, this is not done automatically.
7037
7038 This option cannot be set from a |modeline| or in the |sandbox|, for
7039 security reasons.
7040
7041 *'virtualedit'* *'ve'*
7042'virtualedit' 've' string (default "")
7043 global
7044 {not in Vi}
7045 {not available when compiled without the
7046 |+virtualedit| feature}
7047 A comma separated list of these words:
7048 block Allow virtual editing in Visual block mode.
7049 insert Allow virtual editing in Insert mode.
7050 all Allow virtual editing in all modes.
7051 Virtual editing means that the cursor can be positioned where there is
7052 no actual character. This can be halfway into a Tab or beyond the end
7053 of the line. Useful for selecting a rectangle in Visual mode and
7054 editing a table.
7055
7056 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7057'visualbell' 'vb' boolean (default off)
7058 global
7059 {not in Vi}
7060 Use visual bell instead of beeping. The terminal code to display the
7061 visual bell is given with 't_vb'. When no beep or flash is wanted,
7062 use ":set vb t_vb=".
7063 Note: When the GUI starts, 't_vb' is reset to its default value. You
7064 might want to set it again in your |gvimrc|.
7065 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7066 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7067 where 40 is the time in msec.
7068 Does not work on the Amiga, you always get a screen flash.
7069 Also see 'errorbells'.
7070
7071 *'warn'* *'nowarn'*
7072'warn' boolean (default on)
7073 global
7074 Give a warning message when a shell command is used while the buffer
7075 has been changed.
7076
7077 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7078'weirdinvert' 'wiv' boolean (default off)
7079 global
7080 {not in Vi}
7081 This option has the same effect as the 't_xs' termcap option.
7082 It is provided for backwards compatibility with version 4.x.
7083 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7084 vice versa. Has no effect when the GUI is running.
7085
7086 *'whichwrap'* *'ww'*
7087'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7088 global
7089 {not in Vi}
7090 Allow specified keys that move the cursor left/right to move to the
7091 previous/next line when the cursor is on the first/last character in
7092 the line. Concatenate characters to allow this for these keys:
7093 char key mode ~
7094 b <BS> Normal and Visual
7095 s <Space> Normal and Visual
7096 h "h" Normal and Visual
7097 l "l" Normal and Visual
7098 < <Left> Normal and Visual
7099 > <Right> Normal and Visual
7100 ~ "~" Normal
7101 [ <Left> Insert and Replace
7102 ] <Right> Insert and Replace
7103 For example: >
7104 :set ww=<,>,[,]
7105< allows wrap only when cursor keys are used.
7106 When the movement keys are used in combination with a delete or change
7107 operator, the <EOL> also counts for a character. This makes "3h"
7108 different from "3dh" when the cursor crosses the end of a line. This
7109 is also true for "x" and "X", because they do the same as "dl" and
7110 "dh". If you use this, you may also want to use the mapping
7111 ":map <BS> X" to make backspace delete the character in front of the
7112 cursor.
7113 When 'l' is included, you get a side effect: "yl" on an empty line
7114 will include the <EOL>, so that "p" will insert a new line.
7115 NOTE: This option is set to the Vi default value when 'compatible' is
7116 set and to the Vim default value when 'compatible' is reset.
7117
7118 *'wildchar'* *'wc'*
7119'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7120 global
7121 {not in Vi}
7122 Character you have to type to start wildcard expansion in the
7123 command-line, as specified with 'wildmode'.
7124 The character is not recognized when used inside a macro. See
7125 'wildcharm' for that.
7126 Although 'wc' is a number option, you can set it to a special key: >
7127 :set wc=<Esc>
7128< NOTE: This option is set to the Vi default value when 'compatible' is
7129 set and to the Vim default value when 'compatible' is reset.
7130
7131 *'wildcharm'* *'wcm'*
7132'wildcharm' 'wcm' number (default: none (0))
7133 global
7134 {not in Vi}
7135 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007136 recognized when used inside a macro. You can find "spare" command-line
7137 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007138 you'll never actually type 'wildcharm', just use it in mappings that
7139 automatically invoke completion mode, e.g.: >
7140 :set wcm=<C-Z>
7141 :cmap ss so $vim/sessions/*.vim<C-Z>
7142< Then after typing :ss you can use CTRL-P & CTRL-N.
7143
7144 *'wildignore'* *'wig'*
7145'wildignore' 'wig' string (default "")
7146 global
7147 {not in Vi}
7148 {not available when compiled without the |+wildignore|
7149 feature}
7150 A list of file patterns. A file that matches with one of these
7151 patterns is ignored when completing file or directory names.
7152 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7153 Also see 'suffixes'.
7154 Example: >
7155 :set wildignore=*.o,*.obj
7156< The use of |:set+=| and |:set-=| is preferred when adding or removing
7157 a pattern from the list. This avoids problems when a future version
7158 uses another default.
7159
7160 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7161'wildmenu' 'wmnu' boolean (default off)
7162 global
7163 {not in Vi}
7164 {not available if compiled without the |+wildmenu|
7165 feature}
7166 When 'wildmenu' is on, command-line completion operates in an enhanced
7167 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7168 the possible matches are shown just above the command line, with the
7169 first match highlighted (overwriting the status line, if there is
7170 one). Keys that show the previous/next match, such as <Tab> or
7171 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7172 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7173 specified. "longest" and "list" do not start "wildmenu" mode.
7174 If there are more matches than can fit in the line, a ">" is shown on
7175 the right and/or a "<" is shown on the left. The status line scrolls
7176 as needed.
7177 The "wildmenu" mode is abandoned when a key is hit that is not used
7178 for selecting a completion.
7179 While the "wildmenu" is active the following keys have special
7180 meanings:
7181
7182 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7183 <Down> - in filename/menu name completion: move into a
7184 subdirectory or submenu.
7185 <CR> - in menu completion, when the cursor is just after a
7186 dot: move into a submenu.
7187 <Up> - in filename/menu name completion: move up into
7188 parent directory or parent menu.
7189
7190 This makes the menus accessible from the console |console-menus|.
7191
7192 If you prefer the <Left> and <Right> keys to move the cursor instead
7193 of selecting a different match, use this: >
7194 :cnoremap <Left> <Space><BS><Left>
7195 :cnoremap <Right> <Space><BS><Right>
7196<
7197 The "WildMenu" highlighting is used for displaying the current match
7198 |hl-WildMenu|.
7199
7200 *'wildmode'* *'wim'*
7201'wildmode' 'wim' string (Vim default: "full")
7202 global
7203 {not in Vi}
7204 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007205 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 part specifies what to do for each consecutive use of 'wildchar. The
7207 first part specifies the behavior for the first use of 'wildchar',
7208 The second part for the second use, etc.
7209 These are the possible values for each part:
7210 "" Complete only the first match.
7211 "full" Complete the next full match. After the last match,
7212 the original string is used and then the first match
7213 again.
7214 "longest" Complete till longest common string. If this doesn't
7215 result in a longer string, use the next part.
7216 "longest:full" Like "longest", but also start 'wildmenu' if it is
7217 enabled.
7218 "list" When more than one match, list all matches.
7219 "list:full" When more than one match, list all matches and
7220 complete first match.
7221 "list:longest" When more than one match, list all matches and
7222 complete till longest common string.
7223 When there is only a single match, it is fully completed in all cases.
7224
7225 Examples: >
7226 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007227< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 :set wildmode=longest,full
7229< Complete longest common string, then each full match >
7230 :set wildmode=list:full
7231< List all matches and complete each full match >
7232 :set wildmode=list,full
7233< List all matches without completing, then each full match >
7234 :set wildmode=longest,list
7235< Complete longest common string, then list alternatives.
7236
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007237 *'wildoptions'* *'wop'*
7238'wildoptions' 'wop' string (default "")
7239 global
7240 {not in Vi}
7241 {not available when compiled without the |+wildignore|
7242 feature}
7243 A list of words that change how command line completion is done.
7244 Currently only one word is allowed:
7245 tagfile When using CTRL-D to list matching tags, the kind of
7246 tag and the file of the tag is listed. Only one match
7247 is displayed per line. Often used tag kinds are:
7248 d #define
7249 f function
7250 Also see |cmdline-completion|.
7251
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 *'winaltkeys'* *'wak'*
7253'winaltkeys' 'wak' string (default "menu")
7254 global
7255 {not in Vi}
7256 {only used in Win32, Motif, GTK and Photon GUI}
7257 Some GUI versions allow the access to menu entries by using the ALT
7258 key in combination with a character that appears underlined in the
7259 menu. This conflicts with the use of the ALT key for mappings and
7260 entering special characters. This option tells what to do:
7261 no Don't use ALT keys for menus. ALT key combinations can be
7262 mapped, but there is no automatic handling. This can then be
7263 done with the |:simalt| command.
7264 yes ALT key handling is done by the windowing system. ALT key
7265 combinations cannot be mapped.
7266 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007267 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007268 keys can be mapped.
7269 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7270 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007271 This option is not used for <F10>; on Win32 and with GTK <F10> will
7272 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007274 *'window'* *'wi'*
7275'window' 'wi' number (default screen height - 1)
7276 global
7277 Window height. Do not confuse this with the height of the Vim window,
7278 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007279 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7280 value is smaller than 'lines' minus one. The screen will scroll
7281 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007282 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7283 in a much smarter way, taking care of wrapping lines.
7284 When resizing the Vim window, the value is smaller than 1 or more than
7285 or equal to 'lines' it will be set to 'lines' minus 1.
7286 {Vi also uses the option to specify the number of displayed lines}
7287
Bram Moolenaar071d4272004-06-13 20:20:40 +00007288 *'winheight'* *'wh'* *E591*
7289'winheight' 'wh' number (default 1)
7290 global
7291 {not in Vi}
7292 {not available when compiled without the +windows
7293 feature}
7294 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007295 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 current window is smaller, its size is increased, at the cost of the
7297 height of other windows. Set it to 999 to make the current window
7298 always fill the screen (although this has the drawback that ":all"
7299 will create only two windows). Set it to a small number for normal
7300 editing.
7301 Minimum value is 1.
7302 The height is not adjusted after one of the commands to change the
7303 height of the current window.
7304 'winheight' applies to the current window. Use 'winminheight' to set
7305 the minimal height for other windows.
7306
7307 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7308'winfixheight' 'wfh' boolean (default off)
7309 local to window
7310 {not in Vi}
7311 {not available when compiled without the +windows
7312 feature}
7313 Keep the window height when windows are opened or closed and
7314 'equalalways' is set. Set by default for the |preview-window| and
7315 |quickfix-window|.
7316 The height may be changed anyway when running out of room.
7317
7318 *'winminheight'* *'wmh'*
7319'winminheight' 'wmh' number (default 1)
7320 global
7321 {not in Vi}
7322 {not available when compiled without the +windows
7323 feature}
7324 The minimal height of a window, when it's not the current window.
7325 This is a hard minimum, windows will never become smaller.
7326 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7327 status bar) if necessary. They will return to at least one line when
7328 they become active (since the cursor has to have somewhere to go.)
7329 Use 'winheight' to set the minimal height of the current window.
7330 This option is only checked when making a window smaller. Don't use a
7331 large number, it will cause errors when opening more than a few
7332 windows. A value of 0 to 3 is reasonable.
7333
7334 *'winminwidth'* *'wmw'*
7335'winminwidth' 'wmw' number (default 1)
7336 global
7337 {not in Vi}
7338 {not available when compiled without the +vertsplit
7339 feature}
7340 The minimal width of a window, when it's not the current window.
7341 This is a hard minimum, windows will never become smaller.
7342 When set to zero, windows may be "squashed" to zero columns (i.e. just
7343 a vertical separator) if necessary. They will return to at least one
7344 line when they become active (since the cursor has to have somewhere
7345 to go.)
7346 Use 'winwidth' to set the minimal width of the current window.
7347 This option is only checked when making a window smaller. Don't use a
7348 large number, it will cause errors when opening more than a few
7349 windows. A value of 0 to 12 is reasonable.
7350
7351 *'winwidth'* *'wiw'* *E592*
7352'winwidth' 'wiw' number (default 20)
7353 global
7354 {not in Vi}
7355 {not available when compiled without the +vertsplit
7356 feature}
7357 Minimal number of columns for the current window. This is not a hard
7358 minimum, Vim will use fewer columns if there is not enough room. If
7359 the current window is smaller, its size is increased, at the cost of
7360 the width of other windows. Set it to 999 to make the current window
7361 always fill the screen. Set it to a small number for normal editing.
7362 The width is not adjusted after one of the commands to change the
7363 width of the current window.
7364 'winwidth' applies to the current window. Use 'winminwidth' to set
7365 the minimal width for other windows.
7366
7367 *'wrap'* *'nowrap'*
7368'wrap' boolean (default on)
7369 local to window
7370 {not in Vi}
7371 This option changes how text is displayed. It doesn't change the text
7372 in the buffer, see 'textwidth' for that.
7373 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007374 displaying continues on the next line. When off lines will not wrap
7375 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 moved to a part that is not shown, the screen will scroll
7377 horizontally.
7378 The line will be broken in the middle of a word if necessary. See
7379 'linebreak' to get the break at a word boundary.
7380 To make scrolling horizontally a bit more useful, try this: >
7381 :set sidescroll=5
7382 :set listchars+=precedes:<,extends:>
7383< See 'sidescroll', 'listchars' and |wrap-off|.
7384
7385 *'wrapmargin'* *'wm'*
7386'wrapmargin' 'wm' number (default 0)
7387 local to buffer
7388 Number of characters from the right window border where wrapping
7389 starts. When typing text beyond this limit, an <EOL> will be inserted
7390 and inserting continues on the next line.
7391 Options that add a margin, such as 'number' and 'foldcolumn', cause
7392 the text width to be further reduced. This is Vi compatible.
7393 When 'textwidth' is non-zero, this option is not used.
7394 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7395 and less usefully}
7396
7397 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7398'wrapscan' 'ws' boolean (default on) *E384* *E385*
7399 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007400 Searches wrap around the end of the file. Also applies to |]s| and
7401 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402
7403 *'write'* *'nowrite'*
7404'write' boolean (default on)
7405 global
7406 {not in Vi}
7407 Allows writing files. When not set, writing a file is not allowed.
7408 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007409 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 argument. Filtering text is still possible, even though this requires
7411 writing a temporary file.
7412
7413 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7414'writeany' 'wa' boolean (default off)
7415 global
7416 Allows writing to any file with no need for "!" override.
7417
7418 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7419'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7420 otherwise)
7421 global
7422 {not in Vi}
7423 Make a backup before overwriting a file. The backup is removed after
7424 the file was successfully written, unless the 'backup' option is
7425 also on. Reset this option if your file system is almost full. See
7426 |backup-table| for another explanation.
7427 When the 'backupskip' pattern matches, a backup is not made anyway.
7428 NOTE: This option is set to the default value when 'compatible' is
7429 set.
7430
7431 *'writedelay'* *'wd'*
7432'writedelay' 'wd' number (default 0)
7433 global
7434 {not in Vi}
7435 The number of microseconds to wait for each character sent to the
7436 screen. When non-zero, characters are sent to the terminal one by
7437 one. For MS-DOS pcterm this does not work. For debugging purposes.
7438
7439 vim:tw=78:ts=8:ft=help:norl: