blob: 6001909d01d05385e5f53b20bdcc87c750bde426 [file] [log] [blame]
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001*options.txt* For Vim version 7.0aa. Last change: 2004 Oct 08
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==============================================================================
221. Setting options *set-option*
23
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
79 are removed. Otherwise there is no check for doubled
80 values. You can avoid this by removing a value first.
81 Example: >
82 :set guioptions-=T guioptions+=T
83< Also see |:set-args| above.
84 {not in Vi}
85
86:se[t] {option}^={value} *:set^=*
87 Multiply the {value} to a number option, or prepend
88 the {value} to a string option. When the option is a
89 comma separated list, a comma is added, unless the
90 value was empty.
91 Also see |:set-args| above.
92 {not in Vi}
93
94:se[t] {option}-={value} *:set-=*
95 Subtract the {value} from a number option, or remove
96 the {value} from a string option, if it is there.
97 If the {value} is not found in a string option, there
98 is no error or warning. When the option is a comma
99 separated list, a comma is deleted, unless the option
100 becomes empty.
101 When the option is a list of flags, {value} must be
102 exactly as they appear in the option. Remove flags
103 one by one to avoid problems.
104 Also see |:set-args| above.
105 {not in Vi}
106
107The {option} arguments to ":set" may be repeated. For example: >
108 :set ai nosi sw=3 ts=3
109If you make an error in one of the arguments, an error message will be given
110and the following arguments will be ignored.
111
112 *:set-verbose*
113When 'verbose' is non-zero, displaying an option value will also tell where it
114was last set. Example: >
115 :verbose set shiftwidth cindent?
116 shiftwidth=4
117 Last set from modeline
118 cindent
119 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
120This is only done when specific option values are requested, not for ":set
121all" or ":set" without an argument.
122When the option was set by hand there is no "Last set" message. There is only
123one value for all local options with the same name. Thus the message applies
124to the option name, not necessarily its value.
125When the option was set while executing a function, user command or
126autocommand, the script in which it was defined is reported.
127Note that an option may also have been set as a side effect of setting
128'compatible'.
129{not available when compiled without the +eval feature}
130
131 *:set-termcap* *E522*
132For {option} the form "t_xx" may be used to set a termcap option. This will
133override the value from the termcap. You can then use it in a mapping. If
134the "xx" part contains special characters, use the <t_xx> form: >
135 :set <t_#4>=^[Ot
136This can also be used to translate a special code for a normal key. For
137example, if Alt-b produces <Esc>b, use this: >
138 :set <M-b>=^[b
139(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
140The advantage over a mapping is that it works in all situations.
141
142The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000143at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144"set all" probably does not fit on the screen, causing Vim to give the
145|more-prompt|.
146
147 *option-backslash*
148To include white space in a string option value it has to be preceded with a
149backslash. To include a backslash you have to use two. Effectively this
150means that the number of backslashes in an option value is halved (rounded
151down).
152A few examples: >
153 :set tags=tags\ /usr/tags results in "tags /usr/tags"
154 :set tags=tags\\,file results in "tags\,file"
155 :set tags=tags\\\ file results in "tags\ file"
156
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157The "|" character separates a ":set" command from a following command. To
158include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159'titlestring' option to "hi|there": >
160 :set titlestring=hi\|there
161This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
162 :set titlestring=hi|set iconstring=there
163
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000164For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000165precise: For options that expect a file name (those where environment
166variables are expanded) a backslash before a normal file name character is not
167removed. But a backslash before a special character (space, backslash, comma,
168etc.) is used like explained above.
169There is one special situation, when the value starts with "\\": >
170 :set dir=\\machine\path results in "\\machine\path"
171 :set dir=\\\\machine\\path results in "\\machine\path"
172 :set dir=\\path\\file results in "\\path\file" (wrong!)
173For the first one the start is kept, but for the second one the backslashes
174are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000175halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176result which is probably not what you want. Avoid it.
177
178 *add-option-flags* *remove-option-flags*
179 *E539* *E550* *E551* *E552*
180Some options are a list of flags. When you want to add a flag to such an
181option, without changing the existing ones, you can do it like this: >
182 :set guioptions+=a
183Remove a flag from an option like this: >
184 :set guioptions-=a
185This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000186Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000187the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
188doesn't appear.
189
190 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000191Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192environment variable exists the '$' and the following environment variable
193name is replaced with its value. If it does not exist the '$' and the name
194are not modified. Any non-id character (not a letter, digit or '_') may
195follow the environment variable name. That character and what follows is
196appended to the value of the environment variable. Examples: >
197 :set term=$TERM.new
198 :set path=/usr/$INCLUDE,$HOME/include,.
199When adding or removing a string from an option with ":set opt-=val" or ":set
200opt+=val" the expansion is done before the adding or removing.
201
202
203Handling of local options *local-options*
204
205Some of the options only apply to a window or buffer. Each window or buffer
206has its own copy of this option, thus can each have their own value. This
207allows you to set 'list' in one window but not in another. And set
208'shiftwidth' to 3 in one buffer and 4 in another.
209
210The following explains what happens to these local options in specific
211situations. You don't really need to know all of this, since Vim mostly uses
212the option values you would expect. Unfortunately, doing what the user
213expects is a bit complicated...
214
215When splitting a window, the local options are copied to the new window. Thus
216right after the split the contents of the two windows look the same.
217
218When editing a new buffer, its local option values must be initialized. Since
219the local options of the current buffer might be specifically for that buffer,
220these are not used. Instead, for each buffer-local option there also is a
221global value, which is used for new buffers. With ":set" both the local and
222global value is changed. With "setlocal" only the local value is changed,
223thus this value is not used when editing a new buffer.
224
225When editing a buffer that has been edited before, the last used window
226options are used again. If this buffer has been edited in this window, the
227values from back then are used. Otherwise the values from the window where
228the buffer was edited last are used.
229
230It's possible to set a local window option specifically for a type of buffer.
231When you edit another buffer in the same window, you don't want to keep
232using these local window options. Therefore Vim keeps a global value of the
233local window options, which is used when editing another buffer. Each window
234has its own copy of these values. Thus these are local to the window, but
235global to all buffers in the window. With this you can do: >
236 :e one
237 :set list
238 :e two
239Now the 'list' option will also be set in "two", since with the ":set list"
240command you have also set the global value. >
241 :set nolist
242 :e one
243 :setlocal list
244 :e two
245Now the 'list' option is not set, because ":set nolist" resets the global
246value, ":setlocal list" only changes the local value and ":e two" gets the
247global value. Note that if you do this next: >
248 :e one
249You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000250"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000251
252 *:setl* *:setlocal*
253:setl[ocal] ... Like ":set" but set only the value local to the
254 current buffer or window. Not all options have a
255 local value. If the option does not have a local
256 value the global value is set.
257 With the "all" argument: display all local option's
258 local values.
259 Without argument: Display all local option's local
260 values which are different from the default.
261 When displaying a specific local option, show the
262 local value. For a global option the global value is
263 shown (but that might change in the future).
264 {not in Vi}
265
266:setl[ocal] {option}< Set the local value of {option} to its global value.
267 {not in Vi}
268
269 *:setg* *:setglobal*
270:setg[lobal] ... Like ":set" but set only the global value for a local
271 option without changing the local value.
272 When displaying an option, the global value is shown.
273 With the "all" argument: display all local option's
274 global values.
275 Without argument: display all local option's global
276 values which are different from the default.
277 {not in Vi}
278
279For buffer-local and window-local options:
280 Command global value local value ~
281 :set option=value set set
282 :setlocal option=value - set
283:setglobal option=value set -
284 :set option? - display
285 :setlocal option? - display
286:setglobal option? display -
287
288
289Global options with a local value *global-local*
290
291Options are global when you mostly use one value for all buffers. For some
292global options it's useful to sometimes have a different local value. You can
293set the local value with ":setlocal". That buffer will then use the local
294value, while other buffers continue using the global value.
295
296For example, you have two windows, both on C source code. They use the global
297'makeprg' option. If you do this in one of the two windows: >
298 :set makeprg=gmake
299then the other window will switch to the same value. There is no need to set
300the 'makeprg' option in the other C source window too.
301However, if you start editing a Perl file in a new window, you want to use
302another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000303files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304 :setlocal makeprg=perlmake
305You can switch back to using the global value by making the local value empty: >
306 :setlocal makeprg=
307This only works for a string option. For a boolean option you need to use the
308"<" flag, like this: >
309 :setlocal autoread<
310Note that for non-boolean options using "<" copies the global value to the
311local value, it doesn't switch back to using the global value (that matters
312when changing the global value later).
313Note: In the future more global options can be made global-local. Using
314":setlocal" on a global option might work differently then.
315
316
317Setting the filetype
318
319:setf[iletype] {filetype} *:setf* *:setfiletype*
320 Set the 'filetype' option to {filetype}, but only if
321 not done yet in a sequence of (nested) autocommands.
322 This is short for: >
323 :if !did_filetype()
324 : setlocal filetype={filetype}
325 :endif
326< This command is used in a filetype.vim file to avoid
327 setting the 'filetype' option twice, causing different
328 settings and syntax files to be loaded.
329 {not in Vi}
330
331:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
332:opt[ions] Open a window for viewing and setting all options.
333 Options are grouped by function.
334 Offers short help for each option. Hit <CR> on the
335 short help to open a help window with more help for
336 the option.
337 Modify the value of the option and hit <CR> on the
338 "set" line to set the new value. For window and
339 buffer specific options, the last accessed window is
340 used to set the option value in, unless this is a help
341 window, in which case the window below help window is
342 used (skipping the option-window).
343 {not available when compiled without the |+eval| or
344 |+autocmd| features}
345
346 *$HOME*
347Using "~" is like using "$HOME", but it is only recognized at the start of an
348option and after a space or comma.
349
350On Unix systems "~user" can be used too. It is replaced by the home directory
351of user "user". Example: >
352 :set path=~mool/include,/usr/include,.
353
354On Unix systems the form "${HOME}" can be used too. The name between {} can
355contain non-id characters then. Note that if you want to use this for the
356"gf" command, you need to add the '{' and '}' characters to 'isfname'.
357
358NOTE: expanding environment variables and "~/" is only done with the ":set"
359command, not when assigning a value to an option with ":let".
360
361
362Note the maximum length of an expanded option is limited. How much depends on
363the system, mostly it is something like 256 or 1024 characters.
364
365 *:fix* *:fixdel*
366:fix[del] Set the value of 't_kD':
367 't_kb' is 't_kD' becomes ~
368 CTRL-? CTRL-H
369 not CTRL-? CTRL-?
370
371 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
372
373 If your delete key terminal code is wrong, but the
374 code for backspace is alright, you can put this in
375 your .vimrc: >
376 :fixdel
377< This works no matter what the actual code for
378 backspace is.
379
380 If the backspace key terminal code is wrong you can
381 use this: >
382 :if &term == "termname"
383 : set t_kb=^V<BS>
384 : fixdel
385 :endif
386< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000387 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000388 with your terminal name.
389
390 If your <Delete> key sends a strange key sequence (not
391 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
392 :if &term == "termname"
393 : set t_kD=^V<Delete>
394 :endif
395< Where "^V" is CTRL-V and "<Delete>" is the delete key
396 (don't type eight characters!). Replace "termname"
397 with your terminal name.
398
399 *Linux-backspace*
400 Note about Linux: By default the backspace key
401 produces CTRL-?, which is wrong. You can fix it by
402 putting this line in your rc.local: >
403 echo "keycode 14 = BackSpace" | loadkeys
404<
405 *NetBSD-backspace*
406 Note about NetBSD: If your backspace doesn't produce
407 the right code, try this: >
408 xmodmap -e "keycode 22 = BackSpace"
409< If this works, add this in your .Xmodmap file: >
410 keysym 22 = BackSpace
411< You need to restart for this to take effect.
412
413==============================================================================
4142. Automatically setting options *auto-setting*
415
416Besides changing options with the ":set" command, there are three alternatives
417to set options automatically for one or more files:
418
4191. When starting Vim initializations are read from various places. See
420 |initialization|. Most of them are performed for all editing sessions,
421 and some of them depend on the directory where Vim is started.
422 You can create an initialization file with |:mkvimrc|, |:mkview| and
423 |:mksession|.
4242. If you start editing a new file, the automatic commands are executed.
425 This can be used to set options for files matching a particular pattern and
426 many other things. See |autocommand|.
4273. If you start editing a new file, and the 'modeline' option is on, a
428 number of lines at the beginning and end of the file are checked for
429 modelines. This is explained here.
430
431 *modeline* *vim:* *vi:* *ex:* *E520*
432There are two forms of modelines. The first form:
433 [text]{white}{vi:|vim:|ex:}[white]{options}
434
435[text] any text or empty
436{white} at least one blank character (<Space> or <Tab>)
437{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
438[white] optional white space
439{options} a list of option settings, separated with white space or ':',
440 where each part between ':' is the argument for a ":set"
441 command
442
443Example: >
444 vi:noai:sw=3 ts=6
445
446The second form (this is compatible with some versions of Vi):
447
448 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
449
450[text] any text or empty
451{white} at least one blank character (<Space> or <Tab>)
452{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
453[white] optional white space
454se[t] the string "set " or "se " (note the space)
455{options} a list of options, separated with white space, which is the
456 argument for a ":set" command
457: a colon
458[text] any text or empty
459
460Example: >
461 /* vim: set ai tw=75: */
462
463The white space before {vi:|vim:|ex:} is required. This minimizes the chance
464that a normal word like "lex:" is caught. There is one exception: "vi:" and
465"vim:" can also be at the start of the line (for compatibility with version
4663.0). Using "ex:" at the start of the line will be ignored (this could be
467short for "example:").
468
469 *modeline-local*
470The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000471buffer and window that contain the file. Although it's possible to set global
472options from a modeline, this is unusual. If you have two windows open and
473the files in it set the same global option to a different value, the result
474depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000476When editing a file that was already loaded, only the window-local options
477from the modeline are used. Thus if you manually changed a buffer-local
478option after opening the file, it won't be changed if you edit the same buffer
479in another window. But window-local options will be set.
480
Bram Moolenaar071d4272004-06-13 20:20:40 +0000481 *modeline-version*
482If the modeline is only to be used for some versions of Vim, the version
483number can be specified where "vim:" is used:
484 vim{vers}: version {vers} or later
485 vim<{vers}: version before {vers}
486 vim={vers}: version {vers}
487 vim>{vers}: version after {vers}
488{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
489For example, to use a modeline only for Vim 6.0 and later: >
490 /* vim600: set foldmethod=marker: */
491To use a modeline for Vim before version 5.7: >
492 /* vim<570: set sw=4: */
493There can be no blanks between "vim" and the ":".
494
495
496The number of lines that are checked can be set with the 'modelines' option.
497If 'modeline' is off or 'modelines' is 0 no lines are checked.
498
499Note that for the first form all of the rest of the line is used, thus a line
500like: >
501 /* vi:ts=4: */
502will give an error message for the trailing "*/". This line is OK: >
503 /* vi:set ts=4: */
504
505If an error is detected the rest of the line is skipped.
506
507If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000508backslash in front of the ':' will be removed. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509 /* vi:set dir=c\:\tmp: */
510This sets the 'dir' option to "c:\tmp". Only a single backslash before the
511':' is removed. Thus to include "\:" you have to specify "\\:".
512
513No other commands than "set" are supported, for security reasons (somebody
514might create a Trojan horse text file with modelines).
515
516Hint: If you would like to do something else than setting an option, you could
517define an autocommand that checks the file for a specific string. For
518example: >
519 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
520And define a function SetVar() that does something with the line containing
521"VAR".
522
523==============================================================================
5243. Options summary *option-summary*
525
526In the list below all the options are mentioned with their full name and with
527an abbreviation if there is one. Both forms may be used.
528
529In this document when a boolean option is "set" that means that ":set option"
530is entered. When an option is "reset", ":set nooption" is used.
531
532For some options there are two default values: The "Vim default", which is
533used when 'compatible' is not set, and the "Vi default", which is used when
534'compatible' is set.
535
536Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000537are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538different value in each window. For example the 'list' option can be set in
539one window and reset in another for the same text, giving both types of view
540at the same time. There are a few options that are specific to a certain
541file. These can have a different value for each file or buffer. For example
542the 'textwidth' option can be 78 for a normal text file and 0 for a C
543program.
544
545 global one option for all buffers and windows
546 local to window each window has its own copy of this option
547 local to buffer each buffer has its own copy of this option
548
549When creating a new window the option values from the currently active window
550are used as a default value for the window-specific options. For the
551buffer-specific options this depends on the 's' and 'S' flags in the
552'cpoptions' option. If 's' is included (which is the default) the values for
553buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000554first entered. If 'S' is present the options are copied each time the buffer
555is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000556present, the options are copied from the currently active buffer when the
557buffer is created.
558
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000559Not all options are supported in all versions. To test if option "foo" can be
560used with ":set" use "exists('&foo')". This doesn't mean the value is
561actually remembered and works. Some options are hidden, which means that you
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562can set them but the value is not remembered. To test if option "foo" is
563really supported use "exists('+foo')".
564
565 *E355*
566A jump table for the options with a short description can be found at |Q_op|.
567
568 *'aleph'* *'al'* *aleph* *Aleph*
569'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
570 global
571 {not in Vi}
572 {only available when compiled with the |+rightleft|
573 feature}
574 The ASCII code for the first letter of the Hebrew alphabet. The
575 routine that maps the keyboard in Hebrew mode, both in Insert mode
576 (when hkmap is set) and on the command-line (when hitting CTRL-_)
577 outputs the Hebrew characters in the range [aleph..aleph+26].
578 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
579 See |rileft.txt|.
580
581 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
582'allowrevins' 'ari' boolean (default off)
583 global
584 {not in Vi}
585 {only available when compiled with the |+rightleft|
586 feature}
587 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
588 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
589 into reverse Insert mode, and don't know how to get out. See
590 'revins'.
591 NOTE: This option is reset when 'compatible' is set.
592
593 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
594'altkeymap' 'akm' boolean (default off)
595 global
596 {not in Vi}
597 {only available when compiled with the |+farsi|
598 feature}
599 When on, the second language is Farsi. In editing mode CTRL-_ toggles
600 the keyboard map between Farsi and English, when 'allowrevins' set.
601
602 When off, the keyboard map toggles between Hebrew and English. This
603 is useful to start the Vim in native mode i.e. English (left-to-right
604 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000605 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606
607 *'ambiwidth'* *'ambw'*
608'ambiwidth' 'ambw' string (default: "single")
609 global
610 {not in Vi}
611 {only available when compiled with the |+multi_byte|
612 feature}
613 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
614 Tells Vim what to do with characters with East Asian Width Class
615 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
616 letters, Cyrillic letters).
617
618 There are currently two possible values:
619 "single": Use the same width as characters in US-ASCII. This is
620 expected by most users.
621 "double": Use twice the width of ASCII characters.
622
623 There are a number of CJK fonts for which the width of glyphs for
624 those characters are solely based on how many octets they take in
625 legacy/traditional CJK encodings. In those encodings, Euro,
626 Registered sign, Greek/Cyrillic letters are represented by two octets,
627 therefore those fonts have "wide" glyphs for them. This is also
628 true of some line drawing characters used to make tables in text
629 file. Therefore, when a CJK font is used for GUI Vim or
630 Vim is running inside a terminal (emulators) that uses a CJK font
631 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
632 this option should be set to "double" to match the width perceived
633 by Vim with the width of glyphs in the font. Perhaps it also has
634 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
635 when the system locale is set to one of CJK locales. See Unicode
636 Standard Annex #11 (http://www.unicode.org/reports/tr11).
637
638 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
639'antialias' 'anti' boolean (default: off)
640 global
641 {not in Vi}
642 {only available when compiled with GUI enabled
643 on Mac OS X}
644 This option only has an effect in the GUI version of Vim on Mac OS X
645 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
646 which can be easier to read at certain sizes on certain displays.
647 Setting this option can sometimes cause problems if 'guifont' is set
648 to its default (empty string).
649
650 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
651'autochdir' 'acd' boolean (default off)
652 global
653 {not in Vi}
654 {only available when compiled with the
655 |+netbeans_intg| or |+sun_workshop| feature}
656 When on, Vim will change its value for the current working directory
657 whenever you open a file, switch buffers, delete a buffer or
658 open/close a window. It will change to the directory containing the
659 file which was opened or selected. This option is provided for
660 backward compatibility with the Vim released with Sun ONE Studio 4
661 Enterprise Edition.
662
663 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
664'arabic' 'arab' boolean (default off)
665 local to window
666 {not in Vi}
667 {only available when compiled with the |+arabic|
668 feature}
669 This option can be set to start editing Arabic text.
670 Setting this option will:
671 - Set the 'rightleft' option, unless 'termbidi' is set.
672 - Set the 'arabicshape' option, unless 'termbidi' is set.
673 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
674 between typing English and Arabic key mapping.
675 - Set the 'delcombine' option
676 Note that 'encoding' must be "utf-8" for working with Arabic text.
677
678 Resetting this option will:
679 - Reset the 'rightleft' option.
680 - Disable the use of 'keymap' (without changing its value).
681 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
682 option.
683 Also see |arabic.txt|.
684
685 *'arabicshape'* *'arshape'*
686 *'noarabicshape'* *'noarshape'*
687'arabicshape' 'arshape' boolean (default on)
688 global
689 {not in Vi}
690 {only available when compiled with the |+arabic|
691 feature}
692 When on and 'termbidi' is off, the required visual character
693 corrections that need to take place for displaying the Arabic language
694 take affect. Shaping, in essence, gets enabled; the term is a broad
695 one which encompasses:
696 a) the changing/morphing of characters based on their location
697 within a word (initial, medial, final and stand-alone).
698 b) the enabling of the ability to compose characters
699 c) the enabling of the required combining of some characters
700 When disabled the character display reverts back to each character's
701 true stand-alone form.
702 Arabic is a complex language which requires other settings, for
703 further details see |arabic.txt|.
704
705 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
706'autoindent' 'ai' boolean (default off)
707 local to buffer
708 Copy indent from current line when starting a new line (typing <CR>
709 in Insert mode or when using the "o" or "O" command). If you do not
710 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000711 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
712 another line has the same effect, unless the 'I' flag is included in
713 'cpoptions'.
714 When autoindent is on, formatting (with the "gq" command or when you
715 reach 'textwidth' in Insert mode) uses the indentation of the first
716 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717 When 'smartindent' or 'cindent' is on the indent is changed in
718 a different way.
719 The 'autoindent' option is reset when the 'paste' option is set.
720 {small difference from Vi: After the indent is deleted when typing
721 <Esc> or <CR>, the cursor position when moving up or down is after the
722 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
723
724 *'autoread'* *'ar'* *'noautoread'* *'noar'*
725'autoread' 'ar' boolean (default off)
726 global or local to buffer |global-local|
727 {not in Vi}
728 When a file has been detected to have been changed outside of Vim and
729 it has not been changed inside of Vim, automatically read it again.
730 When the file has been deleted this is not done. |timestamp|
731 If this option has a local value, use this command to switch back to
732 using the global value: >
733 :set autoread<
734<
735 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
736'autowrite' 'aw' boolean (default off)
737 global
738 Write the contents of the file, if it has been modified, on each
739 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
740 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
741 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
742 Note that for some commands the 'autowrite' option is not used, see
743 'autowriteall' for that.
744
745 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
746'autowriteall' 'awa' boolean (default off)
747 global
748 {not in Vi}
749 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
750 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
751 Setting this option also implies that Vim behaves like 'autowrite' has
752 been set.
753
754 *'background'* *'bg'*
755'background' 'bg' string (default "dark" or "light")
756 global
757 {not in Vi}
758 When set to "dark", Vim will try to use colors that look good on a
759 dark background. When set to "light", Vim will try to use colors that
760 look good on a light background. Any other value is illegal.
761 Vim tries to set the default value according to the terminal used.
762 This will not always be correct.
763 Setting this option does not change the background color, it tells Vim
764 what the background color looks like. For changing the background
765 color, see |:hi-normal|.
766
767 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000768 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 change.
770 When a color scheme is loaded (the "colors_name" variable is set)
771 setting 'background' will cause the color scheme to be reloaded. If
772 the color scheme adjusts to the value of 'background' this will work.
773 However, if the color scheme sets 'background' itself the effect may
774 be undone. First delete the "colors_name" variable when needed.
775
776 When setting 'background' to the default value with: >
777 :set background&
778< Vim will guess the value. In the GUI this should work correctly,
779 in other cases Vim might not be able to guess the right value.
780
781 When starting the GUI, the default value for 'background' will be
782 "light". When the value is not set in the .gvimrc, and Vim detects
783 that the background is actually quite dark, 'background' is set to
784 "dark". But this happens only AFTER the .gvimrc file has been read
785 (because the window needs to be opened to find the actual background
786 color). To get around this, force the GUI window to be opened by
787 putting a ":gui" command in the .gvimrc file, before where the value
788 of 'background' is used (e.g., before ":syntax on").
789 Normally this option would be set in the .vimrc file. Possibly
790 depending on the terminal name. Example: >
791 :if &term == "pcterm"
792 : set background=dark
793 :endif
794< When this option is set, the default settings for the highlight groups
795 will change. To use other settings, place ":highlight" commands AFTER
796 the setting of the 'background' option.
797 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
798 to select the colors for syntax highlighting. After changing this
799 option, you must load syntax.vim again to see the result. This can be
800 done with ":syntax on".
801
802 *'backspace'* *'bs'*
803'backspace' 'bs' string (default "")
804 global
805 {not in Vi}
806 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
807 mode. This is a list of items, separated by commas. Each item allows
808 a way to backspace over something:
809 value effect ~
810 indent allow backspacing over autoindent
811 eol allow backspacing over line breaks (join lines)
812 start allow backspacing over the start of insert; CTRL-W and CTRL-U
813 stop once at the start of insert.
814
815 When the value is empty, Vi compatible backspacing is used.
816
817 For backwards compatibility with version 5.4 and earlier:
818 value effect ~
819 0 same as ":set backspace=" (Vi compatible)
820 1 same as ":set backspace=indent,eol"
821 2 same as ":set backspace=indent,eol,start"
822
823 See |:fixdel| if your <BS> or <Del> key does not do what you want.
824 NOTE: This option is set to "" when 'compatible' is set.
825
826 *'backup'* *'bk'* *'nobackup'* *'nobk'*
827'backup' 'bk' boolean (default off)
828 global
829 {not in Vi}
830 Make a backup before overwriting a file. Leave it around after the
831 file has been successfully written. If you do not want to keep the
832 backup file, but you do want a backup while the file is being
833 written, reset this option and set the 'writebackup' option (this is
834 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000835 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 |backup-table| for more explanations.
837 When the 'backupskip' pattern matches, a backup is not made anyway.
838 When 'patchmode' is set, the backup may be renamed to become the
839 oldest version of a file.
840 NOTE: This option is reset when 'compatible' is set.
841
842 *'backupcopy'* *'bkc'*
843'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
844 global
845 {not in Vi}
846 When writing a file and a backup is made, this option tells how it's
847 done. This is a comma separated list of words.
848
849 The main values are:
850 "yes" make a copy of the file and overwrite the original one
851 "no" rename the file and write a new one
852 "auto" one of the previous, what works best
853
854 Extra values that can be combined with the ones above are:
855 "breaksymlink" always break symlinks when writing
856 "breakhardlink" always break hardlinks when writing
857
858 Making a copy and overwriting the original file:
859 - Takes extra time to copy the file.
860 + When the file has special attributes, is a (hard/symbolic) link or
861 has a resource fork, all this is preserved.
862 - When the file is a link the backup will have the name of the link,
863 not of the real file.
864
865 Renaming the file and writing a new one:
866 + It's fast.
867 - Sometimes not all attributes of the file can be copied to the new
868 file.
869 - When the file is a link the new file will not be a link.
870
871 The "auto" value is the middle way: When Vim sees that renaming file
872 is possible without side effects (the attributes can be passed on and
873 and the file is not a link) that is used. When problems are expected,
874 a copy will be made.
875
876 The "breaksymlink" and "breakhardlink" values can be used in
877 combination with any of "yes", "no" and "auto". When included, they
878 force Vim to always break either symbolic or hard links by doing
879 exactly what the "no" option does, renaming the original file to
880 become the backup and writing a new file in its place. This can be
881 useful for example in source trees where all the files are symbolic or
882 hard links and any changes should stay in the local source tree, not
883 be propagated back to the original source.
884 *crontab*
885 One situation where "no" and "auto" will cause problems: A program
886 that opens a file, invokes Vim to edit that file, and then tests if
887 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000888 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000889 example.
890
891 When a copy is made, the original file is truncated and then filled
892 with the new text. This means that protection bits, owner and
893 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 group of the backup is set to the group of the original file. If this
896 fails, the protection bits for the group are made the same as for
897 others.
898
899 When the file is renamed this is the other way around: The backup has
900 the same attributes of the original file, and the newly written file
901 is owned by the current user. When the file was a (hard/symbolic)
902 link, the new file will not! That's why the "auto" value doesn't
903 rename when the file is a link. The owner and group of the newly
904 written file will be set to the same ones as the original file, but
905 the system may refuse to do this. In that case the "auto" value will
906 again not rename the file.
907
908 *'backupdir'* *'bdir'*
909'backupdir' 'bdir' string (default for Amiga: ".,t:",
910 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
911 for Unix: ".,~/tmp,~/")
912 global
913 {not in Vi}
914 List of directories for the backup file, separated with commas.
915 - The backup file will be created in the first directory in the list
916 where this is possible.
917 - Empty means that no backup file will be created ('patchmode' is
918 impossible!). Writing may fail because of this.
919 - A directory "." means to put the backup file in the same directory
920 as the edited file.
921 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
922 put the backup file relative to where the edited file is. The
923 leading "." is replaced with the path name of the edited file.
924 ("." inside a directory name has no special meaning).
925 - Spaces after the comma are ignored, other spaces are considered part
926 of the directory name. To have a space at the start of a directory
927 name, precede it with a backslash.
928 - To include a comma in a directory name precede it with a backslash.
929 - A directory name may end in an '/'.
930 - Environment variables are expanded |:set_env|.
931 - Careful with '\' characters, type one before a space, type two to
932 get one in the option (see |option-backslash|), for example: >
933 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
934< - For backwards compatibility with Vim version 3.0 a '>' at the start
935 of the option is removed.
936 See also 'backup' and 'writebackup' options.
937 If you want to hide your backup files on Unix, consider this value: >
938 :set backupdir=./.backup,~/.backup,.,/tmp
939< You must create a ".backup" directory in each directory and in your
940 home directory for this to work properly.
941 The use of |:set+=| and |:set-=| is preferred when adding or removing
942 directories from the list. This avoids problems when a future version
943 uses another default.
944 This option cannot be set from a |modeline| or in the |sandbox|, for
945 security reasons.
946
947 *'backupext'* *'bex'* *E589*
948'backupext' 'bex' string (default "~", for VMS: "_")
949 global
950 {not in Vi}
951 String which is appended to a file name to make the name of the
952 backup file. The default is quite unusual, because this avoids
953 accidentally overwriting existing files with a backup file. You might
954 prefer using ".bak", but make sure that you don't have files with
955 ".bak" that you want to keep.
956
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000957 If you like to keep a lot of backups, you could use a BufWritePre
958 autocommand to change 'backupext' just before writing the file to
959 include a timestamp. >
960 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
961< Use 'backupdir' to put the backup in a different directory.
962
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 *'backupskip'* *'bsk'*
964'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
965 global
966 {not in Vi}
967 {not available when compiled without the |+wildignore|
968 feature}
969 A list of file patterns. When one of the patterns matches with the
970 name of the file which is written, no backup file is created. Both
971 the specified file name and the full path name of the file are used.
972 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
973 Watch out for special characters, see |option-backslash|.
974 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
975 default value. "/tmp/*" is only used for Unix.
976
977 *'balloondelay'* *'bdlay'*
978'balloondelay' 'bdlay' number (default: 600)
979 global
980 {not in Vi}
981 {only available when compiled with the |+balloon_eval|
982 feature}
983 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
984
985 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
986'ballooneval' 'beval' boolean (default off)
987 global
988 {not in Vi}
989 {only available when compiled with the |+balloon_eval|
990 and |+sun_workshop| or |+netbeans_intg| features}
991 Switch on the |balloon-eval| functionality.
992
993 *'binary'* *'bin'* *'nobinary'* *'nobin'*
994'binary' 'bin' boolean (default off)
995 local to buffer
996 {not in Vi}
997 This option should be set before editing a binary file. You can also
998 use the |-b| Vim argument. When this option is switched on a few
999 options will be changed (also when it already was on):
1000 'textwidth' will be set to 0
1001 'wrapmargin' will be set to 0
1002 'modeline' will be off
1003 'expandtab' will be off
1004 Also, 'fileformat' and 'fileformats' options will not be used, the
1005 file is read and written like 'fileformat' was "unix" (a single <NL>
1006 separates lines).
1007 The 'fileencoding' and 'fileencodings' options will not be used, the
1008 file is read without conversion.
1009 NOTE: When you start editing a(nother) file while the 'bin' option is
1010 on, settings from autocommands may change the settings again (e.g.,
1011 'textwidth'), causing trouble when editing. You might want to set
1012 'bin' again when the file has been loaded.
1013 The previous values of these options are remembered and restored when
1014 'bin' is switched from on to off. Each buffer has its own set of
1015 saved option values.
1016 To edit a file with 'binary' set you can use the |++bin| argument.
1017 This avoids you have to do ":set bin", which would have effect for all
1018 files you edit.
1019 When writing a file the <EOL> for the last line is only written if
1020 there was one in the original file (normally Vim appends an <EOL> to
1021 the last line if there is none; this would make the file longer). See
1022 the 'endofline' option.
1023
1024 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1025'bioskey' 'biosk' boolean (default on)
1026 global
1027 {not in Vi} {only for MS-DOS}
1028 When on the bios is called to obtain a keyboard character. This works
1029 better to detect CTRL-C, but only works for the console. When using a
1030 terminal over a serial port reset this option.
1031 Also see |'conskey'|.
1032
1033 *'bomb'* *'nobomb'*
1034'bomb' boolean (default off)
1035 local to buffer
1036 {not in Vi}
1037 {only available when compiled with the |+multi_byte|
1038 feature}
1039 When writing a file and the following conditions are met, a BOM (Byte
1040 Order Mark) is prepended to the file:
1041 - this option is on
1042 - the 'binary' option is off
1043 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1044 endian variants.
1045 Some applications use the BOM to recognize the encoding of the file.
1046 Often used for UCS-2 files on MS-Windows. For other applications it
1047 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1048 appear halfway the resulting file.
1049 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1050 check for the presence of the BOM is done and 'bomb' set accordingly.
1051 Unless 'binary' is set, it is removed from the first line, so that you
1052 don't see it when editing. When you don't change the options, the BOM
1053 will be restored when writing the file.
1054
1055 *'breakat'* *'brk'*
1056'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1057 global
1058 {not in Vi}
1059 {not available when compiled without the |+linebreak|
1060 feature}
1061 This option lets you choose which characters might cause a line
1062 break if 'linebreak' is on.
1063
1064 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001065'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 global
1067 {not in Vi} {only for Motif and Win32 GUI}
1068 Which directory to use for the file browser:
1069 last Use same directory as with last file browser.
1070 buffer Use the directory of the related buffer.
1071 current Use the current directory.
1072 {path} Use the specified directory
1073
1074 *'bufhidden'* *'bh'*
1075'bufhidden' 'bh' string (default: "")
1076 local to buffer
1077 {not in Vi}
1078 {not available when compiled without the |+quickfix|
1079 feature}
1080 This option specifies what happens when a buffer is no longer
1081 displayed in a window:
1082 <empty> follow the global 'hidden' option
1083 hide hide the buffer (don't unload it), also when 'hidden'
1084 is not set
1085 unload unload the buffer, also when 'hidden' is set or using
1086 |:hide|
1087 delete delete the buffer from the buffer list, also when
1088 'hidden' is set or using |:hide|, like using
1089 |:bdelete|
1090 wipe wipe out the buffer from the buffer list, also when
1091 'hidden' is set or using |:hide|, like using
1092 |:bwipeout|
1093
1094 This option is used together with 'buftype' and 'swapfile' to specify
1095 special kinds of buffers. See |special-buffers|.
1096
1097 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1098'buflisted' 'bl' boolean (default: on)
1099 local to buffer
1100 {not in Vi}
1101 When this option is set, the buffer shows up in the buffer list. If
1102 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1103 This option is reset by Vim for buffers that are only used to remember
1104 a file name or marks. Vim sets it when starting to edit a buffer.
1105 But not when moving to a buffer with ":buffer".
1106
1107 *'buftype'* *'bt'* *E382*
1108'buftype' 'bt' string (default: "")
1109 local to buffer
1110 {not in Vi}
1111 {not available when compiled without the |+quickfix|
1112 feature}
1113 The value of this option specifies the type of a buffer:
1114 <empty> normal buffer
1115 nofile buffer which is not related to a file and will not be
1116 written
1117 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001118 acwrite buffer which will always be written with BufWriteCmd
1119 autocommands. {not available when compiled without the
1120 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121 quickfix quickfix buffer, contains list of errors |:cwindow|
1122 help help buffer (you are not supposed to set this
1123 manually)
1124
1125 This option is used together with 'bufhidden' and 'swapfile' to
1126 specify special kinds of buffers. See |special-buffers|.
1127
1128 Be careful with changing this option, it can have many side effects!
1129
1130 A "quickfix" buffer is only used for the error list. This value is
1131 set by the |:cwindow| command and you are not supposed to change it.
1132
1133 "nofile" and "nowrite" buffers are similar:
1134 both: The buffer is not to be written to disk, ":w" doesn't
1135 work (":w filename" does work though).
1136 both: The buffer is never considered to be |'modified'|.
1137 There is no warning when the changes will be lost, for
1138 example when you quit Vim.
1139 both: A swap file is only created when using too much memory
1140 (when 'swapfile' has been reset there is never a swap
1141 file).
1142 nofile only: The buffer name is fixed, it is not handled like a
1143 file name. It is not modified in response to a |:cd|
1144 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001145 *E676*
1146 "acwrite" implies that the buffer name is not related to a file, like
1147 "nofile", but it will be written. Thus, in contrast to "nofile" and
1148 "nowrite", ":w" does work and a modified buffer can't be abandoned
1149 without saving. For writing there must be matching |BufWriteCmd|,
1150 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
1152 *'casemap'* *'cmp'*
1153'casemap' 'cmp' string (default: "internal,keepascii")
1154 global
1155 {not in Vi}
1156 Specifies details about changing the case of letters. It may contain
1157 these words, separated by a comma:
1158 internal Use internal case mapping functions, the current
1159 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001160 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001161 "internal" is omitted, the towupper() and towlower()
1162 system library functions are used when available.
1163 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1164 case mapping, the current locale is not effective.
1165 This probably only matters for Turkish.
1166
1167 *'cdpath'* *'cd'* *E344* *E346*
1168'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1169 global
1170 {not in Vi}
1171 {not available when compiled without the
1172 |+file_in_path| feature}
1173 This is a list of directories which will be searched when using the
1174 |:cd| and |:lcd| commands, provided that the directory being searched
1175 for has a relative path (not starting with "/", "./" or "../").
1176 The 'cdpath' option's value has the same form and semantics as
1177 |'path'|. Also see |file-searching|.
1178 The default value is taken from $CDPATH, with a "," prepended to look
1179 in the current directory first.
1180 If the default value taken from $CDPATH is not what you want, include
1181 a modified version of the following command in your vimrc file to
1182 override it: >
1183 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1184< This option cannot be set from a |modeline| or in the |sandbox|, for
1185 security reasons.
1186 (parts of 'cdpath' can be passed to the shell to expand file names).
1187
1188 *'cedit'*
1189'cedit' string (Vi default: "", Vim default: CTRL-F)
1190 global
1191 {not in Vi}
1192 {not available when compiled without the |+vertsplit|
1193 feature}
1194 The key used in Command-line Mode to open the command-line window.
1195 The default is CTRL-F when 'compatible' is off.
1196 Only non-printable keys are allowed.
1197 The key can be specified as a single character, but it is difficult to
1198 type. The preferred way is to use the <> notation. Examples: >
1199 :set cedit=<C-Y>
1200 :set cedit=<Esc>
1201< |Nvi| also has this option, but it only uses the first character.
1202 See |cmdwin|.
1203
1204 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1205'charconvert' 'ccv' string (default "")
1206 global
1207 {only available when compiled with the |+multi_byte|
1208 feature and the |+eval| feature}
1209 {not in Vi}
1210 An expression that is used for character encoding conversion. It is
1211 evaluated when a file that is to be read or has been written has a
1212 different encoding from what is desired.
1213 'charconvert' is not used when the internal iconv() function is
1214 supported and is able to do the conversion. Using iconv() is
1215 preferred, because it is much faster.
1216 'charconvert' is not used when reading stdin |--|, because there is no
1217 file to convert from. You will have to save the text in a file first.
1218 The expression must return zero or an empty string for success,
1219 non-zero for failure.
1220 The possible encoding names encountered are in 'encoding'.
1221 Additionally, names given in 'fileencodings' and 'fileencoding' are
1222 used.
1223 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1224 is done internally by Vim, 'charconvert' is not used for this.
1225 'charconvert' is also used to convert the viminfo file, if the 'c'
1226 flag is present in 'viminfo'. Also used for Unicode conversion.
1227 Example: >
1228 set charconvert=CharConvert()
1229 fun CharConvert()
1230 system("recode "
1231 \ . v:charconvert_from . ".." . v:charconvert_to
1232 \ . " <" . v:fname_in . " >" v:fname_out)
1233 return v:shell_error
1234 endfun
1235< The related Vim variables are:
1236 v:charconvert_from name of the current encoding
1237 v:charconvert_to name of the desired encoding
1238 v:fname_in name of the input file
1239 v:fname_out name of the output file
1240 Note that v:fname_in and v:fname_out will never be the same.
1241 Note that v:charconvert_from and v:charconvert_to may be different
1242 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1243 Encryption is not done by Vim when using 'charconvert'. If you want
1244 to encrypt the file after conversion, 'charconvert' should take care
1245 of this.
1246 This option cannot be set from a |modeline| or in the |sandbox|, for
1247 security reasons.
1248
1249 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1250'cindent' 'cin' boolean (default off)
1251 local to buffer
1252 {not in Vi}
1253 {not available when compiled without the |+cindent|
1254 feature}
1255 Enables automatic C program indenting See 'cinkeys' to set the keys
1256 that trigger reindenting in insert mode and 'cinoptions' to set your
1257 preferred indent style.
1258 If 'indentexpr' is not empty, it overrules 'cindent'.
1259 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1260 the "=" operator indents using this algorithm rather than calling an
1261 external program.
1262 See |C-indenting|.
1263 When you don't like the way 'cindent' works, try the 'smartindent'
1264 option or 'indentexpr'.
1265 This option is not used when 'paste' is set.
1266 NOTE: This option is reset when 'compatible' is set.
1267
1268 *'cinkeys'* *'cink'*
1269'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1270 local to buffer
1271 {not in Vi}
1272 {not available when compiled without the |+cindent|
1273 feature}
1274 A list of keys that, when typed in Insert mode, cause reindenting of
1275 the current line. Only used if 'cindent' is on and 'indentexpr' is
1276 empty.
1277 For the format of this option see |cinkeys-format|.
1278 See |C-indenting|.
1279
1280 *'cinoptions'* *'cino'*
1281'cinoptions' 'cino' string (default "")
1282 local to buffer
1283 {not in Vi}
1284 {not available when compiled without the |+cindent|
1285 feature}
1286 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1287 program. See |cinoptions-values| for the values of this option, and
1288 |C-indenting| for info on C indenting in general.
1289
1290
1291 *'cinwords'* *'cinw'*
1292'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1293 local to buffer
1294 {not in Vi}
1295 {not available when compiled without both the
1296 |+cindent| and the |+smartindent| features}
1297 These keywords start an extra indent in the next line when
1298 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1299 an appropriate place (inside {}).
1300 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1301 matter, include the keyword both the uppercase and lowercase:
1302 "if,If,IF".
1303
1304 *'clipboard'* *'cb'*
1305'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1306 for X-windows, "" otherwise)
1307 global
1308 {not in Vi}
1309 {only in GUI versions or when the |+xterm_clipboard|
1310 feature is included}
1311 This option is a list of comma separated names.
1312 These names are recognized:
1313
1314 unnamed When included, Vim will use the clipboard register '*'
1315 for all yank, delete, change and put operations which
1316 would normally go to the unnamed register. When a
1317 register is explicitly specified, it will always be
1318 used regardless of whether "unnamed" is in 'clipboard'
1319 or not. The clipboard register can always be
1320 explicitly accessed using the "* notation. Also see
1321 |gui-clipboard|.
1322
1323 autoselect Works like the 'a' flag in 'guioptions': If present,
1324 then whenever Visual mode is started, or the Visual
1325 area extended, Vim tries to become the owner of the
1326 windowing system's global selection or put the
1327 selected text on the clipboard used by the selection
1328 register "*. See |guioptions_a| and |quotestar| for
1329 details. When the GUI is active, the 'a' flag in
1330 'guioptions' is used, when the GUI is not active, this
1331 "autoselect" flag is used.
1332 Also applies to the modeless selection.
1333
1334 autoselectml Like "autoselect", but for the modeless selection
1335 only. Compare to the 'A' flag in 'guioptions'.
1336
1337 exclude:{pattern}
1338 Defines a pattern that is matched against the name of
1339 the terminal 'term'. If there is a match, no
1340 connection will be made to the X server. This is
1341 useful in this situation:
1342 - Running Vim in a console.
1343 - $DISPLAY is set to start applications on another
1344 display.
1345 - You do not want to connect to the X server in the
1346 console, but do want this in a terminal emulator.
1347 To never connect to the X server use: >
1348 exclude:.*
1349< This has the same effect as using the |-X| argument.
1350 Note that when there is no connection to the X server
1351 the window title won't be restored and the clipboard
1352 cannot be accessed.
1353 The value of 'magic' is ignored, {pattern} is
1354 interpreted as if 'magic' was on.
1355 The rest of the option value will be used for
1356 {pattern}, this must be the last entry.
1357
1358 *'cmdheight'* *'ch'*
1359'cmdheight' 'ch' number (default 1)
1360 global
1361 {not in Vi}
1362 Number of screen lines to use for the command-line. Helps avoiding
1363 |hit-enter| prompts.
1364
1365 *'cmdwinheight'* *'cwh'*
1366'cmdwinheight' 'cwh' number (default 7)
1367 global
1368 {not in Vi}
1369 {not available when compiled without the |+vertsplit|
1370 feature}
1371 Number of screen lines to use for the command-line window. |cmdwin|
1372
1373 *'columns'* *'co'* *E594*
1374'columns' 'co' number (default 80 or terminal width)
1375 global
1376 {not in Vi}
1377 Number of columns of the screen. Normally this is set by the terminal
1378 initialization and does not have to be set by hand.
1379 When Vim is running in the GUI or in a resizable window, setting this
1380 option will cause the window size to be changed. When you only want
1381 to use the size for the GUI, put the command in your |gvimrc| file.
1382 When you set this option and Vim is unable to change the physical
1383 number of columns of the display, the display may be messed up.
1384
1385 *'comments'* *'com'* *E524* *E525*
1386'comments' 'com' string (default
1387 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1388 local to buffer
1389 {not in Vi}
1390 {not available when compiled without the |+comments|
1391 feature}
1392 A comma separated list of strings that can start a comment line. See
1393 |format-comments|. See |option-backslash| about using backslashes to
1394 insert a space.
1395
1396 *'commentstring'* *'cms'* *E537*
1397'commentstring' 'cms' string (default "/*%s*/")
1398 local to buffer
1399 {not in Vi}
1400 {not available when compiled without the |+folding|
1401 feature}
1402 A template for a comment. The "%s" in the value is replaced with the
1403 comment text. Currently only used to add markers for folding, see
1404 |fold-marker|.
1405
1406 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1407'compatible' 'cp' boolean (default on, off when a .vimrc file is found)
1408 global
1409 {not in Vi}
1410 This option has the effect of making Vim either more Vi-compatible, or
1411 make Vim behave in a more useful way.
1412 This is a special kind of option, because when it's set or reset,
1413 other options are also changed as a side effect. CAREFUL: Setting or
1414 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001415 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 set this option in your vimrc file, you should probably put it at the
1417 very start.
1418 By default this option is on and the Vi defaults are used for the
1419 options. This default was chosen for those people who want to use Vim
1420 just like Vi, and don't even (want to) know about the 'compatible'
1421 option.
1422 When a ".vimrc" file is found while Vim is starting up, this option is
1423 switched off, and all options that have not been modified will be set
1424 to the Vim defaults. Effectively, this means that when a ".vimrc"
1425 file exists, Vim will use the Vim defaults, otherwise it will use the
1426 Vi defaults. (Note: This doesn't happen for the system-wide vimrc
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001427 file). Also see |compatible-default|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 You can also set this option with the "-C" argument, and reset it with
1429 "-N". See |-C| and |-N|.
1430 Switching this option off makes the Vim defaults be used for options
1431 that have a different Vi and Vim default value. See the options
1432 marked with a '+' below. Other options are not modified.
1433 At the moment this option is set, several other options will be set
1434 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001435 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 editing.
1437 See also 'cpoptions'.
1438
1439 option + set value effect ~
1440
1441 'allowrevins' off no CTRL-_ command
1442 'backupcopy' Unix: "yes" backup file is a copy
1443 others: "auto" copy or rename backup file
1444 'backspace' "" normal backspace
1445 'backup' off no backup file
1446 'cindent' off no C code indentation
1447 'cedit' + "" no key to open the |cmdwin|
1448 'cpoptions' + (all flags) Vi-compatible flags
1449 'cscopetag' off don't use cscope for ":tag"
1450 'cscopetagorder' 0 see |cscopetagorder|
1451 'cscopeverbose' off see |cscopeverbose|
1452 'digraph' off no digraphs
1453 'esckeys' + off no <Esc>-keys in Insert mode
1454 'expandtab' off tabs not expanded to spaces
1455 'fileformats' + "" no automatic file format detection,
1456 "dos,unix" except for DOS, Windows and OS/2
1457 'formatoptions' + "vt" Vi compatible formatting
1458 'gdefault' off no default 'g' flag for ":s"
1459 'history' + 0 no commandline history
1460 'hkmap' off no Hebrew keyboard mapping
1461 'hkmapp' off no phonetic Hebrew keyboard mapping
1462 'hlsearch' off no highlighting of search matches
1463 'incsearch' off no incremental searching
1464 'indentexpr' "" no indenting by expression
1465 'insertmode' off do not start in Insert mode
1466 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1467 characters and '_'
1468 'joinspaces' on insert 2 spaces after period
1469 'modeline' + off no modelines
1470 'more' + off no pauses in listings
1471 'revins' off no reverse insert
1472 'ruler' off no ruler
1473 'scrolljump' 1 no jump scroll
1474 'scrolloff' 0 no scroll offset
1475 'shiftround' off indent not rounded to shiftwidth
1476 'shortmess' + "" no shortening of messages
1477 'showcmd' + off command characters not shown
1478 'showmode' + off current mode not shown
1479 'smartcase' off no automatic ignore case switch
1480 'smartindent' off no smart indentation
1481 'smarttab' off no smart tab size
1482 'softtabstop' 0 tabs are always 'tabstop' positions
1483 'startofline' on goto startofline with some commands
1484 'tagrelative' + off tag file names are not relative
1485 'textauto' + off no automatic textmode detection
1486 'textwidth' 0 no automatic line wrap
1487 'tildeop' off tilde is not an operator
1488 'ttimeout' off no terminal timeout
1489 'whichwrap' + "" left-right movements don't wrap
1490 'wildchar' + CTRL-E only when the current value is <Tab>
1491 use CTRL-E for cmdline completion
1492 'writebackup' on or off depends on +writebackup feature
1493
1494 *'complete'* *'cpt'* *E535*
1495'complete' 'cpt' string (default: ".,w,b,u,t,i")
1496 local to buffer
1497 {not in Vi}
1498 This option specifies how keyword completion |ins-completion| works
1499 when CTRL-P or CTRL-N are used. It is also used for whole-line
1500 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1501 and the places to scan. It is a comma separated list of flags:
1502 . scan the current buffer ('wrapscan' is ignored)
1503 w scan buffers from other windows
1504 b scan other loaded buffers that are in the buffer list
1505 u scan the unloaded buffers that are in the buffer list
1506 U scan the buffers that are not in the buffer list
1507 k scan the files given with the 'dictionary' option
1508 k{dict} scan the file {dict}. Several "k" flags can be given,
1509 patterns are valid too. For example: >
1510 :set cpt=k/usr/dict/*,k~/spanish
1511< s scan the files given with the 'thesaurus' option
1512 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1513 are valid too.
1514 i scan current and included files
1515 d scan current and included files for defined name or macro
1516 |i_CTRL-X_CTRL-D|
1517 ] tag completion
1518 t same as "]"
1519
1520 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1521 not executed, this may lead to unexpected completions from some files
1522 (gzipped files for example). Unloaded buffers are not scanned for
1523 whole-line completion.
1524
1525 The default is ".,w,b,u,t,i", which means to scan:
1526 1. the current buffer
1527 2. buffers in other windows
1528 3. other loaded buffers
1529 4. unloaded buffers
1530 5. tags
1531 6. included files
1532
1533 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1534 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1535 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1536
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001537 *'completefunc'* *'cfu'*
1538'completefunc' 'cfu' string (default: empty)
1539 local to buffer
1540 {not in Vi}
1541 This option specifies a completion function to be used for CTRL-X
1542 CTRL-X. The function will be invoked with four arguments:
1543 a:line the text of the current line
1544 a:base the text with which matches should match
1545 a:col column in a:line where the cursor is, first column is
1546 zero
1547 a:findstart either 1 or 0
1548 When the a:findstart argument is 1, the function must return the
1549 column of where the completion starts. It must be a number between
1550 zero and "a:col". This involves looking at the characters in a:line
1551 before column a:col and include those characters that could be part of
1552 the completed item.
1553 When the a:findstart argument is 0 the function must return a string
1554 with the matching words, separated by newlines. When there are no
1555 matches return an empty string.
1556 An example that completes the names of the months: >
1557 fun! CompleteMonths(line, base, col, findstart)
1558 if a:findstart
1559 " locate start column of word
1560 let start = a:col
1561 while start > 0 && a:line[start - 1] =~ '\a'
1562 let start = start - 1
1563 endwhile
1564 return start
1565 else
1566 " find months matching with "a:base"
1567 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1568 if a:base != ''
1569 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1570 endif
1571 let res = substitute(res, ' \+', "\n", 'g')
1572 return res
1573 endif
1574 endfun
1575 set completefunc=CompleteMonths
1576< Note that a substitute() function is used to reduce the list of
1577 possible values and remove the ones that don't match the base. The
1578 part before the "\|" matches the base, the part after it is used
1579 when there is no match. The "\2" in the replacement is empty if the
1580 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001581
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1583'confirm' 'cf' boolean (default off)
1584 global
1585 {not in Vi}
1586 When 'confirm' is on, certain operations that would normally
1587 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1588 instead raise a |dialog| asking if you wish to save the current
1589 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1590 If 'confirm' is off you can still activate confirmation for one
1591 command only (this is most useful in mappings) with the |:confirm|
1592 command.
1593 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1594
1595 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1596'conskey' 'consk' boolean (default off)
1597 global
1598 {not in Vi} {only for MS-DOS}
1599 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001600 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 three methods of console input are available:
1602 'conskey' 'bioskey' action ~
1603 on on or off direct console input
1604 off on BIOS
1605 off off STDIN
1606
1607 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1608'copyindent' 'ci' boolean (default off)
1609 local to buffer
1610 {not in Vi}
1611 Copy the structure of the existing lines indent when autoindenting a
1612 new line. Normally the new indent is reconstructed by a series of
1613 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1614 in which case only spaces are used). Enabling this option makes the
1615 new line copy whatever characters were used for indenting on the
1616 existing line. If the new indent is greater than on the existing
1617 line, the remaining space is filled in the normal manner.
1618 NOTE: 'copyindent' is reset when 'compatible' is set.
1619 Also see 'preserveindent'.
1620
1621 *'cpoptions'* *'cpo'*
1622'cpoptions' 'cpo' string (Vim default: "aABceFs",
1623 Vi default: all flags)
1624 global
1625 {not in Vi}
1626 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001627 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 not being vi-compatible is mostly or sometimes preferred.
1629 'cpoptions' stands for "compatible-options".
1630 Commas can be added for readability.
1631 To avoid problems with flags that are added in the future, use the
1632 "+=" and "-=" feature of ":set" |add-option-flags|.
1633 NOTE: This option is set to the Vi default value when 'compatible' is
1634 set and to the Vim default value when 'compatible' is reset.
1635
1636 contains behavior ~
1637 *cpo-a*
1638 a When included, a ":read" command with a file name
1639 argument will set the alternate file name for the
1640 current window.
1641 *cpo-A*
1642 A When included, a ":write" command with a file name
1643 argument will set the alternate file name for the
1644 current window.
1645 *cpo-b*
1646 b "\|" in a ":map" command is recognized as the end of
1647 the map command. The '\' is included in the mapping,
1648 the text after the '|' is interpreted as the next
1649 command. Use a CTRL-V instead of a backslash to
1650 include the '|' in the mapping. Applies to all
1651 mapping, abbreviation, menu and autocmd commands.
1652 See also |map_bar|.
1653 *cpo-B*
1654 B A backslash has no special meaning in mappings,
1655 abbreviations and the "to" part of the menu commands.
1656 Remove this flag to be able to use a backslash like a
1657 CTRL-V. For example, the command ":map X \<Esc>"
1658 results in X being mapped to:
1659 'B' included: "\^[" (^[ is a real <Esc>)
1660 'B' excluded: "<Esc>" (5 characters)
1661 ('<' excluded in both cases)
1662 *cpo-c*
1663 c Searching continues at the end of any match at the
1664 cursor position, but not further than the start of the
1665 next line. When not present searching continues
1666 one character from the cursor position. With 'c'
1667 "abababababab" only gets three matches when repeating
1668 "/abab", without 'c' there are five matches.
1669 *cpo-C*
1670 C Do not concatenate sourced lines that start with a
1671 backslash. See |line-continuation|.
1672 *cpo-d*
1673 d Using "./" in the 'tags' option doesn't mean to use
1674 the tags file relative to the current file, but the
1675 tags file in the current directory.
1676 *cpo-D*
1677 D Can't use CTRL-K to enter a digraph after Normal mode
1678 commands with a character argument, like |r|, |f| and
1679 |t|.
1680 *cpo-e*
1681 e When executing a register with ":@r", always add a
1682 <CR> to the last line, also when the register is not
1683 linewise. If this flag is not present, the register
1684 is not linewise and the last line does not end in a
1685 <CR>, then the last line is put on the command-line
1686 and can be edited before hitting <CR>.
1687 *cpo-E*
1688 E It is an error when using "y", "d", "c", "g~", "gu" or
1689 "gU" on an Empty region. The operators only work when
1690 at least one character is to be operate on. Example:
1691 This makes "y0" fail in the first column.
1692 *cpo-f*
1693 f When included, a ":read" command with a file name
1694 argument will set the file name for the current buffer,
1695 if the current buffer doesn't have a file name yet.
1696 *cpo-F*
1697 F When included, a ":write" command with a file name
1698 argument will set the file name for the current
1699 buffer, if the current buffer doesn't have a file name
1700 yet.
1701 *cpo-g*
1702 g Goto line 1 when using ":edit" without argument.
1703 *cpo-i*
1704 i When included, interrupting the reading of a file will
1705 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001706 *cpo-I*
1707 I When moving the cursor up or down just after inserting
1708 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 *cpo-j*
1710 j When joining lines, only add two spaces after a '.',
1711 not after '!' or '?'. Also see 'joinspaces'.
1712 *cpo-J*
1713 J A |sentence| has to be followed by two spaces after
1714 the '.', '!' or '?'. A <Tab> is not recognized as
1715 white space.
1716 *cpo-k*
1717 k Disable the recognition of raw key codes in
1718 mappings, abbreviations, and the "to" part of menu
1719 commands. For example, if <Key> sends ^[OA (where ^[
1720 is <Esc>), the command ":map X ^[OA" results in X
1721 being mapped to:
1722 'k' included: "^[OA" (3 characters)
1723 'k' excluded: "<Key>" (one key code)
1724 Also see the '<' flag below.
1725 *cpo-K*
1726 K Don't wait for a key code to complete when it is
1727 halfway a mapping. This breaks mapping <F1><F1> when
1728 only part of the second <F1> has been read. It
1729 enables cancelling the mapping by typing <F1><Esc>.
1730 *cpo-l*
1731 l Backslash in a [] range in a search pattern is taken
1732 literally, only "\]" is special See |/[]|
1733 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1734 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1735 *cpo-L*
1736 L When the 'list' option is set, 'wrapmargin',
1737 'textwidth', 'softtabstop' and Virtual Replace mode
1738 (see |gR|) count a <Tab> as two characters, instead of
1739 the normal behavior of a <Tab>.
1740 *cpo-m*
1741 m When included, a showmatch will always wait half a
1742 second. When not included, a showmatch will wait half
1743 a second or until a character is typed. |'showmatch'|
1744 *cpo-M*
1745 M When excluded, "%" matching will take backslashes into
1746 account. Thus in "( \( )" and "\( ( \)" the outer
1747 parenthesis match. When included "%" ignores
1748 backslashes, which is Vi compatible.
1749 *cpo-n*
1750 n When included, the column used for 'number' will also
1751 be used for text of wrapped lines.
1752 *cpo-o*
1753 o Line offset to search command is not remembered for
1754 next search.
1755 *cpo-O*
1756 O Don't complain if a file is being overwritten, even
1757 when it didn't exist when editing it. This is a
1758 protection against a file unexpectedly created by
1759 someone else. Vi didn't complain about this.
1760 *cpo-p*
1761 p Vi compatible Lisp indenting. When not present, a
1762 slightly better algorithm is used.
1763 *cpo-r*
1764 r Redo ("." command) uses "/" to repeat a search
1765 command, instead of the actually used search string.
1766 *cpo-R*
1767 R Remove marks from filtered lines. Without this flag
1768 marks are kept like |:keepmarks| was used.
1769 *cpo-s*
1770 s Set buffer options when entering the buffer for the
1771 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001772 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 set when the buffer is created.
1774 *cpo-S*
1775 S Set buffer options always when entering a buffer
1776 (except 'readonly', 'fileformat', 'filetype' and
1777 'syntax'). This is the (most) Vi compatible setting.
1778 The options are set to the values in the current
1779 buffer. When you change an option and go to another
1780 buffer, the value is copied. Effectively makes the
1781 buffer options global to all buffers.
1782
1783 's' 'S' copy buffer options
1784 no no when buffer created
1785 yes no when buffer first entered (default)
1786 X yes each time when buffer entered (vi comp.)
1787 *cpo-t*
1788 t Search pattern for the tag command is remembered for
1789 "n" command. Otherwise Vim only puts the pattern in
1790 the history for search pattern, but doesn't change the
1791 last used search pattern.
1792 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001793 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 *cpo-v*
1795 v Backspaced characters remain visible on the screen in
1796 Insert mode. Without this flag the characters are
1797 erased from the screen right away. With this flag the
1798 screen newly typed text overwrites backspaced
1799 characters.
1800 *cpo-w*
1801 w When using "cw" on a blank character, only change one
1802 character and not all blanks until the start of the
1803 next word.
1804 *cpo-W*
1805 W Don't overwrite a readonly file. When omitted, ":w!"
1806 overwrites a readonly file, if possible.
1807 *cpo-x*
1808 x <Esc> on the command-line executes the command-line.
1809 The default in Vim is to abandon the command-line,
1810 because <Esc> normally aborts a command. |c_<Esc>|
1811 *cpo-y*
1812 y A yank command can be redone with ".".
1813 *cpo-!*
1814 ! When redoing a filter command, use the last used
1815 external command, whatever it was. Otherwise the last
1816 used -filter- command is used.
1817 *cpo-$*
1818 $ When making a change to one line, don't redisplay the
1819 line, but put a '$' at the end of the changed text.
1820 The changed text will be overwritten when you type the
1821 new text. The line is redisplayed if you type any
1822 command that moves the cursor from the insertion
1823 point.
1824 *cpo-%*
1825 % Vi-compatible matching is done for the "%" command.
1826 Does not recognize "#if", "#endif", etc.
1827 Does not recognize "/*" and "*/".
1828 Parens inside single and double quotes are also
1829 counted, causing a string that contains a paren to
1830 disturb the matching. For example, in a line like
1831 "if (strcmp("foo(", s))" the first paren does not
1832 match the last one. When this flag is not included,
1833 parens inside single and double quotes are treated
1834 specially. When matching a paren outside of quotes,
1835 everything inside quotes is ignored. When matching a
1836 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001837 there is one). This works very well for C programs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 *cpo-star*
1839 * Use ":*" in the same way as ":@". When not included,
1840 ":*" is an alias for ":'<,'>", select the Visual area.
1841 *cpo-<*
1842 < Disable the recognition of special key codes in |<>|
1843 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001844 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 ":map X <Tab>" results in X being mapped to:
1846 '<' included: "<Tab>" (5 characters)
1847 '<' excluded: "^I" (^I is a real <Tab>)
1848 Also see the 'k' flag above.
1849
1850 *'cscopepathcomp'* *'cspc'*
1851'cscopepathcomp' 'cspc' number (default 0)
1852 global
1853 {not available when compiled without the |+cscope|
1854 feature}
1855 {not in Vi}
1856 Determines how many components of the path to show in a list of tags.
1857 See |cscopepathcomp|.
1858
1859 *'cscopeprg'* *'csprg'*
1860'cscopeprg' 'csprg' string (default "cscope")
1861 global
1862 {not available when compiled without the |+cscope|
1863 feature}
1864 {not in Vi}
1865 Specifies the command to execute cscope. See |cscopeprg|.
1866 This option cannot be set from a |modeline| or in the |sandbox|, for
1867 security reasons.
1868
1869 *'cscopequickfix'* *'csqf'*
1870'cscopequickfix' 'csqf' string (default "")
1871 global
1872 {not available when compiled without the |+cscope|
1873 or |+quickfix| features}
1874 {not in Vi}
1875 Specifies whether to use quickfix window to show cscope results.
1876 See |cscopequickfix|.
1877
1878 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1879'cscopetag' 'cst' boolean (default off)
1880 global
1881 {not available when compiled without the |+cscope|
1882 feature}
1883 {not in Vi}
1884 Use cscope for tag commands. See |cscope-options|.
1885 NOTE: This option is reset when 'compatible' is set.
1886
1887 *'cscopetagorder'* *'csto'*
1888'cscopetagorder' 'csto' number (default 0)
1889 global
1890 {not available when compiled without the |+cscope|
1891 feature}
1892 {not in Vi}
1893 Determines the order in which ":cstag" performs a search. See
1894 |cscopetagorder|.
1895 NOTE: This option is set to 0 when 'compatible' is set.
1896
1897 *'cscopeverbose'* *'csverb'*
1898 *'nocscopeverbose'* *'nocsverb'*
1899'cscopeverbose' 'csverb' boolean (default off)
1900 global
1901 {not available when compiled without the |+cscope|
1902 feature}
1903 {not in Vi}
1904 Give messages when adding a cscope database. See |cscopeverbose|.
1905 NOTE: This option is reset when 'compatible' is set.
1906
1907 *'debug'*
1908'debug' string (default "")
1909 global
1910 {not in Vi}
1911 When set to "msg", error messages that would otherwise be omitted will
1912 be given anyway. This is useful when debugging 'foldexpr' or
1913 'indentexpr'.
1914
1915 *'define'* *'def'*
1916'define' 'def' string (default "^\s*#\s*define")
1917 global or local to buffer |global-local|
1918 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001919 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 pattern, just like for the "/" command. This option is used for the
1921 commands like "[i" and "[d" |include-search|. The 'isident' option is
1922 used to recognize the defined name after the match:
1923 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
1924 See |option-backslash| about inserting backslashes to include a space
1925 or backslash.
1926 The default value is for C programs. For C++ this value would be
1927 useful, to include const type declarations: >
1928 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
1929< When using the ":set" command, you need to double the backslashes!
1930
1931 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
1932'delcombine' 'deco' boolean (default off)
1933 global
1934 {not in Vi}
1935 {only available when compiled with the |+multi_byte|
1936 feature}
1937 If editing Unicode and this option is set, backspace and Normal mode
1938 "x" delete each combining character on its own. When it is off (the
1939 default) the character along with its combining characters are
1940 deleted.
1941 Note: When 'delcombine' is set "xx" may work different from "2x"!
1942
1943 This is useful for Arabic, Hebrew and many other languages where one
1944 may have combining characters overtop of base characters, and want
1945 to remove only the combining ones.
1946
1947 *'dictionary'* *'dict'*
1948'dictionary' 'dict' string (default "")
1949 global or local to buffer |global-local|
1950 {not in Vi}
1951 List of file names, separated by commas, that are used to lookup words
1952 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
1953 contain a list of words. This can be one word per line, or several
1954 words per line, separated by non-keyword characters (white space is
1955 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001956 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 after a comma are ignored, otherwise spaces are included in the file
1958 name. See |option-backslash| about using backslashes.
1959 Where to find a list of words?
1960 - On FreeBSD, there is the file "/usr/share/dict/words".
1961 - In the Simtel archive, look in the "msdos/linguist" directory.
1962 - In "miscfiles" of the GNU collection.
1963 The use of |:set+=| and |:set-=| is preferred when adding or removing
1964 directories from the list. This avoids problems when a future version
1965 uses another default.
1966 Backticks cannot be used in this option for security reasons.
1967
1968 *'diff'* *'nodiff'*
1969'diff' boolean (default off)
1970 local to window
1971 {not in Vi}
1972 {not available when compiled without the |+diff|
1973 feature}
1974 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001975 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976
1977 *'dex'* *'diffexpr'*
1978'diffexpr' 'dex' string (default "")
1979 global
1980 {not in Vi}
1981 {not available when compiled without the |+diff|
1982 feature}
1983 Expression which is evaluated to obtain an ed-style diff file from two
1984 versions of a file. See |diff-diffexpr|.
1985 This option cannot be set from a |modeline| or in the |sandbox|, for
1986 security reasons.
1987
1988 *'dip'* *'diffopt'*
1989'diffopt' 'dip' string (default "filler")
1990 global
1991 {not in Vi}
1992 {not available when compiled without the |+diff|
1993 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001994 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001995 All are optional. Items must be separated by a comma.
1996
1997 filler Show filler lines, to keep the text
1998 synchronized with a window that has inserted
1999 lines at the same position. Mostly useful
2000 when windows are side-by-side and 'scrollbind'
2001 is set.
2002
2003 context:{n} Use a context of {n} lines between a change
2004 and a fold that contains unchanged lines.
2005 When omitted a context of six lines is used.
2006 See |fold-diff|.
2007
2008 icase Ignore changes in case of text. "a" and "A"
2009 are considered the same. Adds the "-i" flag
2010 to the "diff" command if 'diffexpr' is empty.
2011
2012 iwhite Ignore changes in amount of white space. Adds
2013 the "-b" flag to the "diff" command if
2014 'diffexpr' is empty. Check the documentation
2015 of the "diff" command for what this does
2016 exactly. It should ignore adding trailing
2017 white space, but not leading white space.
2018
2019 Examples: >
2020
2021 :set diffopt=filler,context:4
2022 :set diffopt=
2023 :set diffopt=filler
2024<
2025 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2026'digraph' 'dg' boolean (default off)
2027 global
2028 {not in Vi}
2029 {not available when compiled without the |+digraphs|
2030 feature}
2031 Enable the entering of digraphs in Insert mode with {char1} <BS>
2032 {char2}. See |digraphs|.
2033 NOTE: This option is reset when 'compatible' is set.
2034
2035 *'directory'* *'dir'*
2036'directory' 'dir' string (default for Amiga: ".,t:",
2037 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2038 for Unix: ".,~/tmp,/var/tmp,/tmp")
2039 global
2040 List of directory names for the swap file, separated with commas.
2041 - The swap file will be created in the first directory where this is
2042 possible.
2043 - Empty means that no swap file will be used (recovery is
2044 impossible!).
2045 - A directory "." means to put the swap file in the same directory as
2046 the edited file. On Unix, a dot is prepended to the file name, so
2047 it doesn't show in a directory listing. On MS-Windows the "hidden"
2048 attribute is set and a dot prepended if possible.
2049 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to
2050 put the swap file relative to where the edited file is. The leading
2051 "." is replaced with the path name of the edited file.
2052 - For Unix and Win32, if a directory ends in two path separators, the
2053 swap file name will be built from the complete path to the file
2054 with all path separators substituted to percent '%' signs. This will
2055 ensure file name uniqueness in the preserve directory.
2056 - Spaces after the comma are ignored, other spaces are considered part
2057 of the directory name. To have a space at the start of a directory
2058 name, precede it with a backslash.
2059 - To include a comma in a directory name precede it with a backslash.
2060 - A directory name may end in an ':' or '/'.
2061 - Environment variables are expanded |:set_env|.
2062 - Careful with '\' characters, type one before a space, type two to
2063 get one in the option (see |option-backslash|), for example: >
2064 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2065< - For backwards compatibility with Vim version 3.0 a '>' at the start
2066 of the option is removed.
2067 Using "." first in the list is recommended. This means that editing
2068 the same file twice will result in a warning. Using "/tmp" on Unix is
2069 discouraged: When the system crashes you lose the swap file.
2070 "/var/tmp" is often not cleared when rebooting, thus is a better
2071 choice than "/tmp". But it can contain a lot of files, your swap
2072 files get lost in the crowd. That is why a "tmp" directory in your
2073 home directory is tried first.
2074 The use of |:set+=| and |:set-=| is preferred when adding or removing
2075 directories from the list. This avoids problems when a future version
2076 uses another default.
2077 This option cannot be set from a |modeline| or in the |sandbox|, for
2078 security reasons.
2079 {Vi: directory to put temp file in, defaults to "/tmp"}
2080
2081 *'display'* *'dy'*
2082'display' 'dy' string (default "")
2083 global
2084 {not in Vi}
2085 Change the way text is displayed. This is comma separated list of
2086 flags:
2087 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002088 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 last line that doesn't fit is replaced with "@" lines.
2090 uhex Show unprintable characters hexadecimal as <xx>
2091 instead of using ^C and ~C.
2092
2093 *'eadirection'* *'ead'*
2094'eadirection' 'ead' string (default "both")
2095 global
2096 {not in Vi}
2097 {not available when compiled without the +vertsplit
2098 feature}
2099 Tells when the 'equalalways' option applies:
2100 ver vertically, width of windows is not affected
2101 hor horizontally, height of windows is not affected
2102 both width and height of windows is affected
2103
2104 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2105'edcompatible' 'ed' boolean (default off)
2106 global
2107 Makes the 'g' and 'c' flags of the ":substitute" command to be
2108 toggled each time the flag is given. See |complex-change|. See
2109 also 'gdefault' option.
2110 Switching this option on is discouraged!
2111
2112 *'encoding'* *'enc'* *E543*
2113'encoding' 'enc' string (default: "latin1" or value from $LANG)
2114 global
2115 {only available when compiled with the |+multi_byte|
2116 feature}
2117 {not in Vi}
2118 Sets the character encoding used inside Vim. It applies to text in
2119 the buffers, registers, Strings in expressions, text stored in the
2120 viminfo file, etc. It sets the kind of characters which Vim can work
2121 with. See |encoding-names| for the possible values.
2122
2123 NOTE: Changing this option will not change the encoding of the
2124 existing text in Vim. It may cause multi-byte text to become invalid.
2125 It should normally be kept at its default value, or set when Vim
2126 starts up. See |multibyte|.
2127
2128 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2129 "utf-8". Although care has been taken to allow different values of
2130 'encoding', "utf-8" is the natural choice for the environment and
2131 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002132 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 versions, and to avoid changing the encoding of newly created files
2134 without your knowledge (in case 'fileencodings' is empty).
2135
2136 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002137 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 iconv() or as specified with 'charconvert'.
2139
2140 Normally 'encoding' will be equal to your current locale. This will
2141 be the default if Vim recognizes your environment settings. If
2142 'encoding' is not set to the current locale, 'termencoding' must be
2143 set to convert typed and displayed text. See |encoding-table|.
2144
2145 When you set this option, it fires the |EncodingChanged| autocommand
2146 event so that you can set up fonts if necessary.
2147
2148 When the option is set, the value is converted to lowercase. Thus
2149 you can set it with uppercase values too. Underscores are translated
2150 to '-' signs.
2151 When the encoding is recognized, it is changed to the standard name.
2152 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2153 "iso-8859-2" and "utf8" becomes "utf-8".
2154
2155 Note: "latin1" is also used when the encoding could not be detected.
2156 This only works when editing files in the same encoding! When the
2157 actual character set is not latin1, make sure 'fileencoding' and
2158 'fileencodings' are empty. When conversion is needed, switch to using
2159 utf-8.
2160
2161 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2162 You don't notice this while editing, but it does matter for the
2163 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2164 setting 'encoding' to one of these values instead of utf-8 only has
2165 effect for encoding used for files when 'fileencoding' is empty.
2166
2167 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2168 not set yet, the default for 'fileencodings' is changed.
2169
2170 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2171'endofline' 'eol' boolean (default on)
2172 local to buffer
2173 {not in Vi}
2174 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002175 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176 option is automatically set when starting to edit a new file, unless
2177 the file does not have an <EOL> for the last line in the file, in
2178 which case it is reset. Normally you don't have to set or reset this
2179 option. When 'binary' is off the value is not used when writing the
2180 file. When 'binary' is on it is used to remember the presence of a
2181 <EOL> for the last line in the file, so that when you write the file
2182 the situation from the original file can be kept. But you can change
2183 it if you want to.
2184
2185 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2186'equalalways' 'ea' boolean (default on)
2187 global
2188 {not in Vi}
2189 When on, all the windows are automatically made the same size after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002190 splitting or closing a window. When off, splitting a window will
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 reduce the size of the current window and leave the other windows the
2192 same. When closing a window the extra lines are given to the window
2193 next to it (depending on 'splitbelow' and 'splitright').
2194 When mixing vertically and horizontally split windows, a minimal size
2195 is computed and some windows may be larger if there is room. The
2196 'eadirection' option tells in which direction the size is affected.
2197 Changing the height of a window can be avoided by setting
2198 'winfixheight'.
2199
2200 *'equalprg'* *'ep'*
2201'equalprg' 'ep' string (default "")
2202 global or local to buffer |global-local|
2203 {not in Vi}
2204 External program to use for "=" command. When this option is empty
2205 the internal formatting functions are used ('lisp', 'cindent' or
2206 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002207 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 about including spaces and backslashes.
2209 This option cannot be set from a |modeline| or in the |sandbox|, for
2210 security reasons.
2211
2212 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2213'errorbells' 'eb' boolean (default off)
2214 global
2215 Ring the bell (beep or screen flash) for error messages. This only
2216 makes a difference for error messages, the bell will be used always
2217 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002218 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 screen flash or do nothing.
2220
2221 *'errorfile'* *'ef'*
2222'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2223 others: "errors.err")
2224 global
2225 {not in Vi}
2226 {not available when compiled without the |+quickfix|
2227 feature}
2228 Name of the errorfile for the QuickFix mode (see |:cf|).
2229 When the "-q" command-line argument is used, 'errorfile' is set to the
2230 following argument. See |-q|.
2231 NOT used for the ":make" command. See 'makeef' for that.
2232 Environment variables are expanded |:set_env|.
2233 See |option-backslash| about including spaces and backslashes.
2234 This option cannot be set from a |modeline| or in the |sandbox|, for
2235 security reasons.
2236
2237 *'errorformat'* *'efm'*
2238'errorformat' 'efm' string (default is very long)
2239 global or local to buffer |global-local|
2240 {not in Vi}
2241 {not available when compiled without the |+quickfix|
2242 feature}
2243 Scanf-like description of the format for the lines in the error file
2244 (see |errorformat|).
2245
2246 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2247'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2248 global
2249 {not in Vi}
2250 Function keys that start with an <Esc> are recognized in Insert
2251 mode. When this option is off, the cursor and function keys cannot be
2252 used in Insert mode if they start with an <Esc>. The advantage of
2253 this is that the single <Esc> is recognized immediately, instead of
2254 after one second. Instead of resetting this option, you might want to
2255 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2256 when 'esckeys' is off, you can still map anything, but the cursor keys
2257 won't work by default.
2258 NOTE: This option is set to the Vi default value when 'compatible' is
2259 set and to the Vim default value when 'compatible' is reset.
2260
2261 *'eventignore'* *'ei'*
2262'eventignore' 'ei' string (default "")
2263 global
2264 {not in Vi}
2265 {not available when compiled without the |+autocmd|
2266 feature}
2267 A list of autocommand event names, which are to be ignored.
2268 When set to "all", all autocommand events are ignored, autocommands
2269 will not be executed.
2270 Otherwise this is a comma separated list of event names. Example: >
2271 :set ei=WinEnter,WinLeave
2272<
2273 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2274'expandtab' 'et' boolean (default off)
2275 local to buffer
2276 {not in Vi}
2277 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002278 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2280 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2281 NOTE: This option is reset when 'compatible' is set.
2282
2283 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2284'exrc' 'ex' boolean (default off)
2285 global
2286 {not in Vi}
2287 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2288 directory. If you switch this option on you should also consider
2289 setting the 'secure' option (see |initialization|). Using a local
2290 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2291 also see |.vimrc| and |gui-init|.
2292 This option cannot be set from a |modeline| or in the |sandbox|, for
2293 security reasons.
2294
2295 *'fileencoding'* *'fenc'* *E213*
2296'fileencoding' 'fenc' string (default: "")
2297 local to buffer
2298 {only available when compiled with the |+multi_byte|
2299 feature}
2300 {not in Vi}
2301 Sets the character encoding for the file of this buffer.
2302 When 'fileencoding' is different from 'encoding', conversion will be
2303 done when reading and writing the file.
2304 When 'fileencoding' is empty, the same value as 'encoding' will be
2305 used (no conversion when reading or writing a file).
2306 WARNING: Conversion can cause loss of information! When
2307 'encoding' is "utf-8" conversion is most likely done in a way
2308 that the reverse conversion results in the same text. When
2309 'encoding' is not "utf-8" some characters may be lost!
2310 See 'encoding' for the possible values. Additionally, values may be
2311 specified that can be handled by the converter, see
2312 |mbyte-conversion|.
2313 When reading a file 'fileencoding' will be set from 'fileencodings'.
2314 To read a file in a certain encoding it won't work by setting
2315 'fileencoding', use the |++enc| argument.
2316 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2317 When the option is set, the value is converted to lowercase. Thus
2318 you can set it with uppercase values too. '_' characters are
2319 replaced with '-'. If a name is recognized from the list for
2320 'encoding', it is replaced by the standard name. For example
2321 "ISO8859-2" becomes "iso-8859-2".
2322 When this option is set, after starting to edit a file, the 'modified'
2323 option is set, because the file would be different when written.
2324 If you do this in a modeline, you might want to set 'nomodified' to
2325 avoid this.
2326 This option can not be changed when 'modifiable' is off.
2327
2328 *'fe'*
2329 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002330 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 old short name was 'fe', which is no longer used.
2332
2333 *'fileencodings'* *'fencs'*
2334'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
2335 when 'encoding' is set to a Unicode value)
2336 global
2337 {only available when compiled with the |+multi_byte|
2338 feature}
2339 {not in Vi}
2340 This is a list of character encodings considered when starting to edit
2341 an existing file. When a file is read, Vim tries to use the first
2342 mentioned character encoding. If an error is detected, the next one
2343 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002344 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 an empty string, which means the value of 'encoding' is used.
2346 WARNING: Conversion can cause loss of information! When
2347 'encoding' is "utf-8" (or one of the other Unicode variants)
2348 conversion is most likely done in a way that the reverse
2349 conversion results in the same text. When 'encoding' is not
2350 "utf-8" special characters may be lost!
2351 For an empty file or a file with only ASCII characters most encodings
2352 will work and the first entry of 'fileencodings' will be used (except
2353 "ucs-bom", which requires the BOM to be present). If you prefer
2354 another encoding use an BufReadPost autocommand event to test if your
2355 preferred encoding is to be used. Example: >
2356 au BufReadPost * if search('\S', 'w') == 0 |
2357 \ set fenc=iso-2022-jp | endif
2358< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2359 non-blank characters.
2360 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2361 is always empty then. This means that a non-existing file may get a
2362 different encoding than an empty file.
2363 The special value "ucs-bom" can be used to check for a Unicode BOM
2364 (Byte Order Mark) at the start of the file. It must not be preceded
2365 by "utf-8" or another Unicode encoding for this to work properly.
2366 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2367 because Vim cannot detect an error, thus the encoding is always
2368 accepted.
2369 WRONG VALUES: WHAT'S WRONG:
2370 latin1,utf-8 "latin1" will always be used
2371 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2372 file
2373 cp1250,latin1 "cp1250" will always be used
2374 If 'fileencodings' is empty, 'fileencoding' is not modified.
2375 See 'fileencoding' for the possible values.
2376 Setting this option does not have an effect until the next time a file
2377 is read.
2378
2379 *'fileformat'* *'ff'*
2380'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2381 Unix default: "unix",
2382 Macintosh default: "mac")
2383 local to buffer
2384 {not in Vi}
2385 This gives the <EOL> of the current buffer, which is used for
2386 reading/writing the buffer from/to a file:
2387 dos <CR> <NL>
2388 unix <NL>
2389 mac <CR>
2390 When "dos" is used, CTRL-Z at the end of a file is ignored.
2391 See |file-formats| and |file-read|.
2392 For the character encoding of the file see 'fileencoding'.
2393 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2394 works like it was set to "unix'.
2395 This option is set automatically when starting to edit a file and
2396 'fileformats' is not empty and 'binary' is off.
2397 When this option is set, after starting to edit a file, the 'modified'
2398 option is set, because the file would be different when written.
2399 This option can not be changed when 'modifiable' is off.
2400 For backwards compatibility: When this option is set to "dos",
2401 'textmode' is set, otherwise 'textmode' is reset.
2402
2403 *'fileformats'* *'ffs'*
2404'fileformats' 'ffs' string (default:
2405 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2406 Vim Unix: "unix,dos",
2407 Vim Mac: "mac,unix,dos",
2408 Vi Cygwin: "unix,dos",
2409 Vi others: "")
2410 global
2411 {not in Vi}
2412 This gives the end-of-line (<EOL>) formats that will be tried when
2413 starting to edit a new buffer and when reading a file into an existing
2414 buffer:
2415 - When empty, the format defined with 'fileformat' will be used
2416 always. It is not set automatically.
2417 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002418 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 'fileformats' name will be used when a file is read into an existing
2420 buffer, no matter what 'fileformat' for that buffer is set to.
2421 - When more than one name is present, separated by commas, automatic
2422 <EOL> detection will be done when reading a file. When starting to
2423 edit a file, a check is done for the <EOL>:
2424 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2425 'fileformat' is set to "dos".
2426 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002427 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 preceding <CR>, "unix" is preferred over "dos".
2429 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2430 This means that "mac" is only chosen when "unix" is not present,
2431 or when no <NL> is found in the file, and when "dos" is not
2432 present, or no <CR><NL> is present in the file.
2433 Also if "unix" was first chosen, but the first <CR> is before
2434 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2435 the file, then 'fileformat' is set to "mac".
2436 4. If 'fileformat' is still not set, the first name from
2437 'fileformats' is used.
2438 When reading a file into an existing buffer, the same is done, but
2439 this happens like 'fileformat' has been set appropriately for that
2440 file only, the option is not changed.
2441 When 'binary' is set, the value of 'fileformats' is not used.
2442
2443 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2444 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2445 done:
2446 - When 'fileformats' is empty, there is no automatic detection. Dos
2447 format will be used.
2448 - When 'fileformats' is set to one or more names, automatic detection
2449 is done. This is based on the first <NL> in the file: If there is a
2450 <CR> in front of it, Dos format is used, otherwise Unix format is
2451 used.
2452 Also see |file-formats|.
2453 For backwards compatibility: When this option is set to an empty
2454 string or one format (no comma is included), 'textauto' is reset,
2455 otherwise 'textauto' is set.
2456 NOTE: This option is set to the Vi default value when 'compatible' is
2457 set and to the Vim default value when 'compatible' is reset.
2458
2459 *'filetype'* *'ft'*
2460'filetype' 'ft' string (default: "")
2461 local to buffer
2462 {not in Vi}
2463 {not available when compiled without the |+autocmd|
2464 feature}
2465 When this option is set, the FileType autocommand event is triggered.
2466 All autocommands that match with the value of this option will be
2467 executed. Thus the value of 'filetype' is used in place of the file
2468 name.
2469 Otherwise this option does not always reflect the current file type.
2470 This option is normally set when the file type is detected. To enable
2471 this use the ":filetype on" command. |:filetype|
2472 Setting this option to a different value is most useful in a modeline,
2473 for a file for which the file type is not automatically recognized.
2474 Example, for in an IDL file: >
2475 /* vim: set filetype=idl : */
2476< |FileType| |filetypes|
2477 Do not confuse this option with 'osfiletype', which is for the file
2478 type that is actually stored with the file.
2479 This option is not copied to another buffer, independent of the 's' or
2480 'S' flag in 'cpoptions'.
2481
2482 *'fillchars'* *'fcs'*
2483'fillchars' 'fcs' string (default "vert:|,fold:-")
2484 global
2485 {not in Vi}
2486 {not available when compiled without the |+windows|
2487 and |+folding| features}
2488 Characters to fill the statuslines and vertical separators.
2489 It is a comma separated list of items:
2490
2491 item default Used for ~
2492 stl:c ' ' or '^' statusline of the current window
2493 stlnc:c ' ' or '-' statusline of the non-current windows
2494 vert:c '|' vertical separators |:vsplit|
2495 fold:c '-' filling 'foldtext'
2496 diff:c '-' deleted lines of the 'diff' option
2497
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002498 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 "stlnc" the space will be used when there is highlighting, '^' or '-'
2500 otherwise.
2501
2502 Example: >
2503 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2504< This is similar to the default, except that these characters will also
2505 be used when there is highlighting.
2506
2507 The highlighting used for these items:
2508 item highlight group ~
2509 stl:c StatusLine |hl-StatusLine|
2510 stlnc:c StatusLineNC |hl-StatusLineNC|
2511 vert:c VertSplit |hl-VertSplit|
2512 fold:c Folded |hl-Folded|
2513 diff:c DiffDelete |hl-DiffDelete|
2514
2515 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2516'fkmap' 'fk' boolean (default off) *E198*
2517 global
2518 {not in Vi}
2519 {only available when compiled with the |+rightleft|
2520 feature}
2521 When on, the keyboard is mapped for the Farsi character set.
2522 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524
2525 *'foldclose'* *'fcl'*
2526'foldclose' 'fcl' string (default "")
2527 global
2528 {not in Vi}
2529 {not available when compiled without the |+folding|
2530 feature}
2531 When set to "all", a fold is closed when the cursor isn't in it and
2532 its level is higher than 'foldlevel'. Useful if you want folds to
2533 automatically close when moving out of them.
2534
2535 *'foldcolumn'* *'fdc'*
2536'foldcolumn' 'fdc' number (default 0)
2537 local to window
2538 {not in Vi}
2539 {not available when compiled without the |+folding|
2540 feature}
2541 When non-zero, a column with the specified width is shown at the side
2542 of the window which indicates open and closed folds. The maximum
2543 value is 12.
2544 See |folding|.
2545
2546 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2547'foldenable' 'fen' boolean (default on)
2548 local to window
2549 {not in Vi}
2550 {not available when compiled without the |+folding|
2551 feature}
2552 When off, all folds are open. This option can be used to quickly
2553 switch between showing all text unfolded and viewing the text with
2554 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002555 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 'foldenable' is off.
2557 This option is set by commands that create a new fold or close a fold.
2558 See |folding|.
2559
2560 *'foldexpr'* *'fde'*
2561'foldexpr' 'fde' string (default: "0")
2562 local to window
2563 {not in Vi}
2564 {not available when compiled without the |+folding|
2565 or |+eval| feature}
2566 The expression used for when 'foldmethod' is "expr". It is evaluated
2567 for each line to obtain its fold level. See |fold-expr|. Also see
2568 |eval-sandbox|.
2569
2570 *'foldignore'* *'fdi'*
2571'foldignore' 'fdi' string (default: "#")
2572 local to window
2573 {not in Vi}
2574 {not available when compiled without the |+folding|
2575 feature}
2576 Used only when 'foldmethod' is "indent". Lines starting with
2577 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002578 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 The default "#" works well for C programs. See |fold-indent|.
2580
2581 *'foldlevel'* *'fdl'*
2582'foldlevel' 'fdl' number (default: 0)
2583 local to window
2584 {not in Vi}
2585 {not available when compiled without the |+folding|
2586 feature}
2587 Sets the fold level: Folds with a higher level will be closed.
2588 Setting this option to zero will close all folds. Higher numbers will
2589 close fewer folds.
2590 This option is set by commands like |zm|, |zM| and |zR|.
2591 See |fold-foldlevel|.
2592
2593 *'foldlevelstart'* *'fdls'*
2594'foldlevelstart' 'fdls' number (default: -1)
2595 global
2596 {not in Vi}
2597 {not available when compiled without the |+folding|
2598 feature}
2599 Sets 'foldlevel' when starting to edit another buffer in a window.
2600 Useful to always start editing with all folds closed (value zero),
2601 some folds closed (one) or no folds closed (99).
2602 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002603 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 ignores this option and closes all folds.
2605 It is also done before BufReadPre autocommands, to allow an autocmd to
2606 overrule the 'foldlevel' value for specific files.
2607 When the value is negative, it is not used.
2608
2609 *'foldmarker'* *'fmr'* *E536*
2610'foldmarker' 'fmr' string (default: "{{{,}}}")
2611 local to window
2612 {not in Vi}
2613 {not available when compiled without the |+folding|
2614 feature}
2615 The start and end marker used when 'foldmethod' is "marker". There
2616 must be one comma, which separates the start and end marker. The
2617 marker is a literal string (a regular expression would be too slow).
2618 See |fold-marker|.
2619
2620 *'foldmethod'* *'fdm'*
2621'foldmethod' 'fdm' string (default: "manual")
2622 local to window
2623 {not in Vi}
2624 {not available when compiled without the |+folding|
2625 feature}
2626 The kind of folding used for the current window. Possible values:
2627 |fold-manual| manual Folds are created manually.
2628 |fold-indent| indent Lines with equal indent form a fold.
2629 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2630 |fold-marker| marker Markers are used to specify folds.
2631 |fold-syntax| syntax Syntax highlighting items specify folds.
2632 |fold-diff| diff Fold text that is not changed.
2633
2634 *'foldminlines'* *'fml'*
2635'foldminlines' 'fml' number (default: 1)
2636 local to window
2637 {not in Vi}
2638 {not available when compiled without the |+folding|
2639 feature}
2640 Sets the minimum number of screen lines for a fold to be displayed
2641 closed. Also for manually closed folds.
2642 Note that this only has an effect of what is displayed. After using
2643 "zc" to close a fold, which is displayed open because it's smaller
2644 than 'foldminlines', a following "zc" may close a containing fold.
2645
2646 *'foldnestmax'* *'fdn'*
2647'foldnestmax' 'fdn' number (default: 20)
2648 local to window
2649 {not in Vi}
2650 {not available when compiled without the |+folding|
2651 feature}
2652 Sets the maximum nesting of folds for the "indent" and "syntax"
2653 methods. This avoids that too many folds will be created. Using more
2654 than 20 doesn't work, because the internal limit is 20.
2655
2656 *'foldopen'* *'fdo'*
2657'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2658 search,tag,undo")
2659 global
2660 {not in Vi}
2661 {not available when compiled without the |+folding|
2662 feature}
2663 Specifies for which type of commands folds will be opened, if the
2664 command moves the cursor into a closed fold. It is a comma separated
2665 list of items.
2666 item commands ~
2667 all any
2668 block "(", "{", "[[", "[{", etc.
2669 hor horizontal movements: "l", "w", "fx", etc.
2670 insert any command in Insert mode
2671 jump far jumps: "G", "gg", etc.
2672 mark jumping to a mark: "'m", CTRL-O, etc.
2673 percent "%"
2674 quickfix ":cn", ":crew", ":make", etc.
2675 search search for a pattern: "/", "n", "*", "gd", etc.
2676 (not for a search pattern in a ":" command)
2677 tag jumping to a tag: ":ta", CTRL-T, etc.
2678 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002679 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680 the |zv| command to the mapping to get the same effect.
2681 When a movement command is used for an operator (e.g., "dl" or "y%")
2682 this option is not used. This means the operator will include the
2683 whole closed fold.
2684 Note that vertical movements are not here, because it would make it
2685 very difficult to move onto a closed fold.
2686 In insert mode the folds containing the cursor will always be open
2687 when text is inserted.
2688 To close folds you can re-apply 'foldlevel' with the |zx| command or
2689 set the 'foldclose' option to "all".
2690
2691 *'foldtext'* *'fdt'*
2692'foldtext' 'fdt' string (default: "foldtext()")
2693 local to window
2694 {not in Vi}
2695 {not available when compiled without the |+folding|
2696 feature}
2697 An expression which is used to specify the text displayed for a closed
2698 fold. See |fold-foldtext|.
2699
2700 *'formatoptions'* *'fo'*
2701'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2702 local to buffer
2703 {not in Vi}
2704 This is a sequence of letters which describes how automatic
2705 formatting is to be done. See |fo-table|. When the 'paste' option is
2706 on, no formatting is done (like 'formatoptions' is empty). Commas can
2707 be inserted for readability.
2708 To avoid problems with flags that are added in the future, use the
2709 "+=" and "-=" feature of ":set" |add-option-flags|.
2710 NOTE: This option is set to the Vi default value when 'compatible' is
2711 set and to the Vim default value when 'compatible' is reset.
2712
2713 *'formatprg'* *'fp'*
2714'formatprg' 'fp' string (default "")
2715 global
2716 {not in Vi}
2717 The name of an external program that will be used to format the lines
2718 selected with the "gq" command. The program must take the input on
2719 stdin and produce the output on stdout. The Unix program "fmt" is
2720 such a program. If this option is an empty string, the internal
2721 format function will be used |C-indenting|. Environment variables are
2722 expanded |:set_env|. See |option-backslash| about including spaces
2723 and backslashes.
2724 This option cannot be set from a |modeline| or in the |sandbox|, for
2725 security reasons.
2726
2727 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2728'gdefault' 'gd' boolean (default off)
2729 global
2730 {not in Vi}
2731 When on, the ":substitute" flag 'g' is default on. This means that
2732 all matches in a line are substituted instead of one. When a 'g' flag
2733 is given to a ":substitute" command, this will toggle the substitution
2734 of all or one match. See |complex-change|.
2735
2736 command 'gdefault' on 'gdefault' off ~
2737 :s/// subst. all subst. one
2738 :s///g subst. one subst. all
2739 :s///gg subst. all subst. one
2740
2741 NOTE: This option is reset when 'compatible' is set.
2742
2743 *'grepformat'* *'gfm'*
2744'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2745 global
2746 {not in Vi}
2747 Format to recognize for the ":grep" command output.
2748 This is a scanf-like string that uses the same format as the
2749 'errorformat' option: see |errorformat|.
2750
2751 *'grepprg'* *'gp'*
2752'grepprg' 'gp' string (default "grep -n ",
2753 Unix: "grep -n $* /dev/null",
2754 Win32: "findstr /n" or "grep -n",
2755 VMS: "SEARCH/NUMBERS ")
2756 global or local to buffer |global-local|
2757 {not in Vi}
2758 Program to use for the ":grep" command. This option may contain '%'
2759 and '#' characters, which are expanded like when used in a command-
2760 line. The placeholder "$*" is allowed to specify where the arguments
2761 will be included. Environment variables are expanded |:set_env|. See
2762 |option-backslash| about including spaces and backslashes.
2763 When your "grep" accepts the "-H" argument, use this to make ":grep"
2764 also work well with a single file: >
2765 :set grepprg=grep\ -nH
2766< See also the section |:make_makeprg|, since most of the comments there
2767 apply equally to 'grepprg'.
2768 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2769 otherwise it's "grep -n".
2770 This option cannot be set from a |modeline| or in the |sandbox|, for
2771 security reasons.
2772
2773 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2774'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2775 ve:ver35-Cursor,
2776 o:hor50-Cursor,
2777 i-ci:ver25-Cursor/lCursor,
2778 r-cr:hor20-Cursor/lCursor,
2779 sm:block-Cursor
2780 -blinkwait175-blinkoff150-blinkon175",
2781 for MS-DOS and Win32 console:
2782 "n-v-c:block,o:hor50,i-ci:hor15,
2783 r-cr:hor30,sm:block")
2784 global
2785 {not in Vi}
2786 {only available when compiled with GUI enabled, and
2787 for MS-DOS and Win32 console}
2788 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002789 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 the height of the cursor can be changed. This can be done by
2791 specifying a block cursor, or a percentage for a vertical or
2792 horizontal cursor.
2793
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002794 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 mode-list and an argument-list:
2796 mode-list:argument-list,mode-list:argument-list,..
2797 The mode-list is a dash separated list of these modes:
2798 n Normal mode
2799 v Visual mode
2800 ve Visual mode with 'selection' "exclusive" (same as 'v',
2801 if not specified)
2802 o Operator-pending mode
2803 i Insert mode
2804 r Replace mode
2805 c Command-line Normal (append) mode
2806 ci Command-line Insert mode
2807 cr Command-line Replace mode
2808 sm showmatch in Insert mode
2809 a all modes
2810 The argument-list is a dash separated list of these arguments:
2811 hor{N} horizontal bar, {N} percent of the character height
2812 ver{N} vertical bar, {N} percent of the character width
2813 block block cursor, fills the whole character
2814 [only one of the above three should be present]
2815 blinkwait{N} *cursor-blinking*
2816 blinkon{N}
2817 blinkoff{N}
2818 blink times for cursor: blinkwait is the delay before
2819 the cursor starts blinking, blinkon is the time that
2820 the cursor is shown and blinkoff is the time that the
2821 cursor is not shown. The times are in msec. When one
2822 of the numbers is zero, there is no blinking. The
2823 default is: "blinkwait700-blinkon400-blinkoff250".
2824 These numbers are used for a missing entry. This
2825 means that blinking is enabled by default. To switch
2826 blinking off you can use "blinkon0". The cursor only
2827 blinks when Vim is waiting for input, not while
2828 executing a command.
2829 To make the cursor blink in an xterm, see
2830 |xterm-blink|.
2831 {group-name}
2832 a highlight group name, that sets the color and font
2833 for the cursor
2834 {group-name}/{group-name}
2835 Two highlight group names, the first is used when
2836 no language mappings are used, the other when they
2837 are. |language-mapping|
2838
2839 Examples of parts:
2840 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2841 block cursor with colors from the "nCursor"
2842 highlight group
2843 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2844 In Insert and Command-line Insert mode, use a
2845 30% vertical bar cursor with colors from the
2846 "iCursor" highlight group. Blink a bit
2847 faster.
2848
2849 The 'a' mode is different. It will set the given argument-list for
2850 all modes. It does not reset anything to defaults. This can be used
2851 to do a common setting for all modes. For example, to switch off
2852 blinking: "a:blinkon0"
2853
2854 Examples of cursor highlighting: >
2855 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2856 :highlight Cursor gui=NONE guifg=bg guibg=fg
2857<
2858 *'guifont'* *'gfn'*
2859 *E235* *E596* *E610* *E611*
2860'guifont' 'gfn' string (default "")
2861 global
2862 {not in Vi}
2863 {only available when compiled with GUI enabled}
2864 This is a list of fonts which will be used for the GUI version of Vim.
2865 In its simplest form the value is just one font name. When
2866 the font cannot be found you will get an error message. To try other
2867 font names a list can be specified, font names separated with commas.
2868 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002869
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002871
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 Spaces after a comma are ignored. To include a comma in a font name
2873 precede it with a backslash. Setting an option requires an extra
2874 backslash before a space and a backslash. See also
2875 |option-backslash|. For example: >
2876 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002877< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002879
2880 If none of the fonts can be loaded, Vim will keep the current setting.
2881 If an empty font list is given, Vim will try using other resource
2882 settings (for X, it will use the Vim.font resource), and finally it
2883 will try some builtin default which should always be there ("7x13" in
2884 the case of X). The font names given should be "normal" fonts. Vim
2885 will try to find the related bold and italic fonts.
2886
2887 For Win32, GTK and Photon only: >
2888 :set guifont=*
2889< will bring up a font requester, where you can pick the font you want.
2890
2891 The font name depends on the GUI used. See |setting-guifont| for a
2892 way to set 'guifont' for various systems.
2893
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 For the GTK+ 2 GUI the font name looks like this: >
2895 :set guifont=Andale\ Mono\ 11
2896< That's all. XLFDs are no longer accepted.
2897 *E236*
2898 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00002899 width). An exception is GTK 2: all fonts are accepted, but
2900 mono-spaced fonts look best.
2901
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 To preview a font on X11, you might be able to use the "xfontsel"
2903 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00002904
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 For the Win32 GUI *E244* *E245*
2906 - takes these options in the font name:
2907 hXX - height is XX (points, can be floating-point)
2908 wXX - width is XX (points, can be floating-point)
2909 b - bold
2910 i - italic
2911 u - underline
2912 s - strikeout
2913 cXX - character set XX. valid charsets are: ANSI, ARABIC,
2914 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2915 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2916 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002917 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918
2919 Use a ':' to separate the options.
2920 - A '_' can be used in the place of a space, so you don't need to use
2921 backslashes to escape the spaces.
2922 - Examples: >
2923 :set guifont=courier_new:h12:w5:b:cRUSSIAN
2924 :set guifont=Andale_Mono:h7.5:w4.5
2925< See also |font-sizes|.
2926
2927 *'guifontset'* *'gfs'*
2928 *E250* *E252* *E234* *E597* *E598*
2929'guifontset' 'gfs' string (default "")
2930 global
2931 {not in Vi}
2932 {only available when compiled with GUI enabled and
2933 with the |+xfontset| feature}
2934 {not available in the GTK+ 2 GUI}
2935 When not empty, specifies two (or more) fonts to be used. The first
2936 one for normal English, the second one for your special language. See
2937 |xfontset|.
2938 Setting this option also means that all font names will be handled as
2939 a fontset name. Also the ones used for the "font" argument of the
2940 |:highlight| command.
2941 The fonts must match with the current locale. If fonts for the
2942 character sets that the current locale uses are not included, setting
2943 'guifontset' will fail.
2944 Note the difference between 'guifont' and 'guifontset': In 'guifont'
2945 the comma-separated names are alternative names, one of which will be
2946 used. In 'guifontset' the whole string is one fontset name,
2947 including the commas. It is not possible to specify alternative
2948 fontset names.
2949 This example works on many X11 systems: >
2950 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
2951<
2952 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
2953'guifontwide' 'gfw' string (default "")
2954 global
2955 {not in Vi}
2956 {only available when compiled with GUI enabled}
2957 When not empty, specifies a comma-separated list of fonts to be used
2958 for double-width characters. The first font that can be loaded is
2959 used.
2960 Note: The size of these fonts must be exactly twice as wide as the one
2961 specified with 'guifont' and the same height.
2962
2963 All GUI versions but GTK+ 2:
2964
2965 'guifontwide' is only used when 'encoding' is set to "utf-8" and
2966 'guifontset' is empty or invalid.
2967 When 'guifont' is set and a valid font is found in it and
2968 'guifontwide' is empty Vim will attempt to find a matching
2969 double-width font and set 'guifontwide' to it.
2970
2971 GTK+ 2 GUI only: *guifontwide_gtk2*
2972
2973 If set and valid, 'guifontwide' is always used for double width
2974 characters, even if 'encoding' is not set to "utf-8".
2975 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002976 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 font for characters not available in 'guifont'. Thus you do not need
2978 to set 'guifontwide' at all unless you want to override the choice
2979 made by Pango/Xft.
2980
2981 *'guiheadroom'* *'ghr'*
2982'guiheadroom' 'ghr' number (default 50)
2983 global
2984 {not in Vi} {only for GTK and X11 GUI}
2985 The number of pixels subtracted from the screen height when fitting
2986 the GUI window on the screen. Set this before the GUI is started,
2987 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002988 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 lines will be left for window decorations and other items on the
2990 screen. Set it to a negative value to allow windows taller than the
2991 screen.
2992
2993 *'guioptions'* *'go'*
2994'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
2995 "agimrLtT" (GTK, Motif and Athena)
2996 global
2997 {not in Vi}
2998 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00002999 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 sequence of letters which describes what components and options of the
3001 GUI should be used.
3002 To avoid problems with flags that are added in the future, use the
3003 "+=" and "-=" feature of ":set" |add-option-flags|.
3004
3005 Valid letters are as follows:
3006 *guioptions_a*
3007 'a' Autoselect: If present, then whenever VISUAL mode is started,
3008 or the Visual area extended, Vim tries to become the owner of
3009 the windowing system's global selection. This means that the
3010 Visually highlighted text is available for pasting into other
3011 applications as well as into Vim itself. When the Visual mode
3012 ends, possibly due to an operation on the text, or when an
3013 application wants to paste the selection, the highlighted text
3014 is automatically yanked into the "* selection register.
3015 Thus the selection is still available for pasting into other
3016 applications after the VISUAL mode has ended.
3017 If not present, then Vim won't become the owner of the
3018 windowing system's global selection unless explicitly told to
3019 by a yank or delete operation for the "* register.
3020 The same applies to the modeless selection.
3021
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003022 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 applies to the modeless selection.
3024
3025 'guioptions' autoselect Visual autoselect modeless ~
3026 "" - -
3027 "a" yes yes
3028 "A" - yes
3029 "aA" yes yes
3030
3031 'c' Use console dialogs instead of popup dialogs for simple
3032 choices.
3033
3034 'f' Foreground: Don't use fork() to detach the GUI from the shell
3035 where it was started. Use this for programs that wait for the
3036 editor to finish (e.g., an e-mail program). Alternatively you
3037 can use "gvim -f" or ":gui -f" to start the GUI in the
3038 foreground. |gui-fork|
3039 Note: Set this option in the vimrc file. The forking may have
3040 happened already when the gvimrc file is read.
3041
3042 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3043 corner of the window. It's black&white on non-GTK, because of
3044 limitations of X11. For a color icon, see |X11-icon|.
3045
3046 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003047 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 that this flag must be added in the .vimrc file, before
3049 switching on syntax or filetype recognition (when the .gvimrc
3050 file is sourced the system menu has already been loaded; the
3051 ":syntax on" and ":filetype on" commands load the menu too).
3052 'g' Grey menu items: Make menu items that are not active grey. If
3053 'g' is not included inactive menu items are not shown at all.
3054 Exception: Athena will always use grey menu items.
3055
3056 't' Include tearoff menu items. Currently only works for Win32,
3057 GTK+, and Motif 1.2 GUI.
3058 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3059 Athena GUIs.
3060
3061 'r' Right-hand scrollbar is always present.
3062 'R' Right-hand scrollbar is present when there is a vertically
3063 split window.
3064 'l' Left-hand scrollbar is always present.
3065 'L' Left-hand scrollbar is present when there is a vertically
3066 split window.
3067 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3068 the longest visible line, or on the cursor line if the 'h'
3069 flag is included. |gui-horiz-scroll|
3070 'h' Limit horizontal scrollbar size to the length of the cursor
3071 line. Reduces computations. |gui-horiz-scroll|
3072
3073 And yes, you may even have scrollbars on the left AND the right if
3074 you really want to :-). See |gui-scrollbars| for more information.
3075
3076 'v' Use a vertical button layout for dialogs. When not included,
3077 a horizontal layout is preferred, but when it doesn't fit a
3078 vertical layout is used anyway.
3079 'p' Use Pointer callbacks for X11 GUI. This is required for some
3080 window managers. If the cursor is not blinking or hollow at
3081 the right moment, try adding this flag. This must be done
3082 before starting the GUI. Set it in your gvimrc. Adding or
3083 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003084 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085
3086 *'guipty'* *'noguipty'*
3087'guipty' boolean (default on)
3088 global
3089 {not in Vi}
3090 {only available when compiled with GUI enabled}
3091 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3092 I/O to/from shell commands. See |gui-pty|.
3093
3094 *'helpfile'* *'hf'*
3095'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3096 (others) "$VIMRUNTIME/doc/help.txt")
3097 global
3098 {not in Vi}
3099 Name of the main help file. All distributed help files should be
3100 placed together in one directory. Additionally, all "doc" directories
3101 in 'runtimepath' will be used.
3102 Environment variables are expanded |:set_env|. For example:
3103 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003104 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 spaces and backslashes.
3106 This option cannot be set from a |modeline| or in the |sandbox|, for
3107 security reasons.
3108
3109 *'helpheight'* *'hh'*
3110'helpheight' 'hh' number (default 20)
3111 global
3112 {not in Vi}
3113 {not available when compiled without the +windows
3114 feature}
3115 Minimal initial height of the help window when it is opened with the
3116 ":help" command. The initial height of the help window is half of the
3117 current window, or (when the 'ea' option is on) the same as other
3118 windows. When the height is less than 'helpheight', the height is
3119 set to 'helpheight'. Set to zero to disable.
3120
3121 *'helplang'* *'hlg'*
3122'helplang' 'hlg' string (default: messages language or empty)
3123 global
3124 {only available when compiled with the |+multi_lang|
3125 feature}
3126 {not in Vi}
3127 Comma separated list of languages. Vim will use the first language
3128 for which the desired help can be found. The English help will always
3129 be used as a last resort. You can add "en" to prefer English over
3130 another language, but that will only find tags that exist in that
3131 language and not in the English help.
3132 Example: >
3133 :set helplang=de,it
3134< This will first search German, then Italian and finally English help
3135 files.
3136 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3137 try to find the tag in the current language before using this option.
3138 See |help-translated|.
3139
3140 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3141'hidden' 'hid' boolean (default off)
3142 global
3143 {not in Vi}
3144 When off a buffer is unloaded when it is |abandon|ed. When on a
3145 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3146 displayed in another window, it does not become hidden, of course.
3147 The commands that move through the buffer list sometimes make a buffer
3148 hidden although the 'hidden' option is off: When the buffer is
3149 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003150 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003151 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 This option is set for one command with ":hide {command}" |:hide|.
3153 WARNING: It's easy to forget that you have changes in hidden buffers.
3154 Think twice when using ":q!" or ":qa!".
3155
3156 *'highlight'* *'hl'*
3157'highlight' 'hl' string (default (as a single string):
3158 "8:SpecialKey,@:NonText,d:Directory,
3159 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3160 M:ModeMsg,n:LineNr,r:Question,
3161 s:StatusLine,S:StatusLineNC,c:VertSplit
3162 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3163 f:Folded,F:FoldColumn,A:DiffAdd,
3164 C:DiffChange,D:DiffDelete,T:DiffText,
3165 >:SignColumn")
3166 global
3167 {not in Vi}
3168 This option can be used to set highlighting mode for various
3169 occasions. It is a comma separated list of character pairs. The
3170 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003171 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3173 |hl-NonText| @ '~' and '@' at the end of the window and
3174 characters from 'showbreak'
3175 |hl-Directory| d directories in CTRL-D listing and other special
3176 things in listings
3177 |hl-ErrorMsg| e error messages
3178 h (obsolete, ignored)
3179 |hl-IncSearch| i 'incsearch' highlighting
3180 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3181 |hl-MoreMsg| m |more-prompt|
3182 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3183 |hl-LineNr| n line number for ":number" and ":#" commands
3184 |hl-Question| r |hit-enter| prompt and yes/no questions
3185 |hl-StatusLine| s status line of current window |status-line|
3186 |hl-StatusLineNC| S status lines of not-current windows
3187 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3188 |hl-VertSplit| c column used to separate vertically split windows
3189 |hl-Visual| v Visual mode
3190 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3191 Selection" Only X11 Gui's |gui-x11| and
3192 |xterm-clipboard|.
3193 |hl-WarningMsg| w warning messages
3194 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3195 |hl-Folded| f line used for closed folds
3196 |hl-FoldColumn| F 'foldcolumn'
3197 |hl-SignColumn| > column used for |signs|
3198
3199 The display modes are:
3200 r reverse (termcap entry "mr" and "me")
3201 i italic (termcap entry "ZH" and "ZR")
3202 b bold (termcap entry "md" and "me")
3203 s standout (termcap entry "so" and "se")
3204 u underline (termcap entry "us" and "ue")
3205 n no highlighting
3206 - no highlighting
3207 : use a highlight group
3208 The default is used for occasions that are not included.
3209 If you want to change what the display modes do, see |dos-colors|
3210 for an example.
3211 When using the ':' display mode, this must be followed by the name of
3212 a highlight group. A highlight group can be used to define any type
3213 of highlighting, including using color. See |:highlight| on how to
3214 define one. The default uses a different group for each occasion.
3215 See |highlight-default| for the default highlight groups.
3216
3217 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3218'hlsearch' 'hls' boolean (default off)
3219 global
3220 {not in Vi}
3221 {not available when compiled without the
3222 |+extra_search| feature}
3223 When there is a previous search pattern, highlight all its matches.
3224 The type of highlighting used can be set with the 'l' occasion in the
3225 'highlight' option. This uses the "Search" highlight group by
3226 default. Note that only the matching text is highlighted, any offsets
3227 are not applied.
3228 See also: 'incsearch' and |:match|.
3229 When you get bored looking at the highlighted matches, you can turn it
3230 off with |:nohlsearch|. As soon as you use a search command, the
3231 highlighting comes back.
3232 When the search pattern can match an end-of-line, Vim will try to
3233 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003234 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003235 line below a closed fold. A match in a previous line which is not
3236 drawn may not continue in an newly drawn line.
3237 NOTE: This option is reset when 'compatible' is set.
3238
3239 *'history'* *'hi'*
3240'history' 'hi' number (Vim default: 20, Vi default: 0)
3241 global
3242 {not in Vi}
3243 A history of ":" commands, and a history of previous search patterns
3244 are remembered. This option decides how many entries may be stored in
3245 each of these histories (see |cmdline-editing|).
3246 NOTE: This option is set to the Vi default value when 'compatible' is
3247 set and to the Vim default value when 'compatible' is reset.
3248
3249 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3250'hkmap' 'hk' boolean (default off)
3251 global
3252 {not in Vi}
3253 {only available when compiled with the |+rightleft|
3254 feature}
3255 When on, the keyboard is mapped for the Hebrew character set.
3256 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3257 toggle this option. See |rileft.txt|.
3258 NOTE: This option is reset when 'compatible' is set.
3259
3260 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3261'hkmapp' 'hkp' boolean (default off)
3262 global
3263 {not in Vi}
3264 {only available when compiled with the |+rightleft|
3265 feature}
3266 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3267 This is useful if you have a non-Hebrew keyboard.
3268 See |rileft.txt|.
3269 NOTE: This option is reset when 'compatible' is set.
3270
3271 *'icon'* *'noicon'*
3272'icon' boolean (default off, on when title can be restored)
3273 global
3274 {not in Vi}
3275 {not available when compiled without the |+title|
3276 feature}
3277 When on, the icon text of the window will be set to the value of
3278 'iconstring' (if it is not empty), or to the name of the file
3279 currently being edited. Only the last part of the name is used.
3280 Overridden by the 'iconstring' option.
3281 Only works if the terminal supports setting window icons (currently
3282 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3283 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3284 builtin termcap).
3285 When Vim was compiled with HAVE_X11 defined, the original icon will be
3286 restored if possible |X11|. See |X11-icon| for changing the icon on
3287 X11.
3288
3289 *'iconstring'*
3290'iconstring' string (default "")
3291 global
3292 {not in Vi}
3293 {not available when compiled without the |+title|
3294 feature}
3295 When this option is not empty, it will be used for the icon text of
3296 the window. This happens only when the 'icon' option is on.
3297 Only works if the terminal supports setting window icon text
3298 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3299 Does not work for MS Windows.
3300 When Vim was compiled with HAVE_X11 defined, the original icon will be
3301 restored if possible |X11|.
3302 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003303 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 'titlestring' for example settings.
3305 {not available when compiled without the |+statusline| feature}
3306
3307 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3308'ignorecase' 'ic' boolean (default off)
3309 global
3310 Ignore case in search patterns. Also used when searching in the tags
3311 file.
3312 Also see 'smartcase'.
3313 Can be overruled by using "\c" or "\C" in the pattern, see
3314 |/ignorecase|.
3315
3316 *'imactivatekey'* *'imak'*
3317'imactivatekey' 'imak' string (default "")
3318 global
3319 {not in Vi}
3320 {only available when compiled with |+xim| and
3321 |+GUI_GTK|}
3322 Specifies the key that your Input Method in X-Windows uses for
3323 activation. When this is specified correctly, vim can fully control
3324 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3325 You can't use this option to change the activation key, the option
3326 tells Vim what the key is.
3327 Format:
3328 [MODIFIER_FLAG-]KEY_STRING
3329
3330 These characters can be used for MODIFIER_FLAG (case is ignored):
3331 S Shift key
3332 L Lock key
3333 C Control key
3334 1 Mod1 key
3335 2 Mod2 key
3336 3 Mod3 key
3337 4 Mod4 key
3338 5 Mod5 key
3339 Combinations are allowed, for example "S-C-space" or "SC-space" are
3340 both shift+ctrl+space.
3341 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3342
3343 Example: >
3344 :set imactivatekey=S-space
3345< "S-space" means shift+space. This is the activation key for kinput2 +
3346 canna (Japanese), and ami (Korean).
3347
3348 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3349'imcmdline' 'imc' boolean (default off)
3350 global
3351 {not in Vi}
3352 {only available when compiled with the |+xim|
3353 |+multi_byte_ime| or |global-ime| feature}
3354 When set the Input Method is always on when starting to edit a command
3355 line, unless entering a search pattern (see 'imsearch' for that).
3356 Setting this option is useful when your input method allows entering
3357 English characters directly, e.g., when it's used to type accented
3358 characters with dead keys.
3359
3360 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3361'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3362 global
3363 {not in Vi}
3364 {only available when compiled with the |+xim|
3365 |+multi_byte_ime| or |global-ime| feature}
3366 When set the Input Method is never used. This is useful to disable
3367 the IM when it doesn't work properly.
3368 Currently this option is on by default for SGI/IRIX machines. This
3369 may change in later releases.
3370
3371 *'iminsert'* *'imi'*
3372'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3373 local to buffer
3374 {not in Vi}
3375 Specifies whether :lmap or an Input Method (IM) is to be used in
3376 Insert mode. Valid values:
3377 0 :lmap is off and IM is off
3378 1 :lmap is ON and IM is off
3379 2 :lmap is off and IM is ON
3380 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3381 or |global-ime|.
3382 To always reset the option to zero when leaving Insert mode with <Esc>
3383 this can be used: >
3384 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3385< This makes :lmap and IM turn off automatically when leaving Insert
3386 mode.
3387 Note that this option changes when using CTRL-^ in Insert mode
3388 |i_CTRL-^|.
3389 The value is set to 1 when setting 'keymap' to a valid keymap name.
3390 It is also used for the argument of commands like "r" and "f".
3391 The value 0 may not work correctly with Athena and Motif with some XIM
3392 methods. Use 'imdisable' to disable XIM then.
3393
3394 *'imsearch'* *'ims'*
3395'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3396 local to buffer
3397 {not in Vi}
3398 Specifies whether :lmap or an Input Method (IM) is to be used when
3399 entering a search pattern. Valid values:
3400 -1 the value of 'iminsert' is used, makes it look like
3401 'iminsert' is also used when typing a search pattern
3402 0 :lmap is off and IM is off
3403 1 :lmap is ON and IM is off
3404 2 :lmap is off and IM is ON
3405 Note that this option changes when using CTRL-^ in Command-line mode
3406 |c_CTRL-^|.
3407 The value is set to 1 when it is not -1 and setting the 'keymap'
3408 option to a valid keymap name.
3409 The value 0 may not work correctly with Athena and Motif with some XIM
3410 methods. Use 'imdisable' to disable XIM then.
3411
3412 *'include'* *'inc'*
3413'include' 'inc' string (default "^\s*#\s*include")
3414 global or local to buffer |global-local|
3415 {not in Vi}
3416 {not available when compiled without the
3417 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003418 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419 pattern, just like for the "/" command (See |pattern|). The default
3420 value is for C programs. This option is used for the commands "[i",
3421 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3422 name that comes after the matched pattern. See |option-backslash|
3423 about including spaces and backslashes.
3424
3425 *'includeexpr'* *'inex'*
3426'includeexpr' 'inex' string (default "")
3427 local to buffer
3428 {not in Vi}
3429 {not available when compiled without the
3430 |+find_in_path| or |+eval| feature}
3431 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003432 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 :set includeexpr=substitute(v:fname,'\\.','/','g')
3434< The "v:fname" variable will be set to the file name that was detected.
3435 Evaluated in the |sandbox|.
3436 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003437 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 Also used for |<cfile>|.
3439
3440 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3441'incsearch' 'is' boolean (default off)
3442 global
3443 {not in Vi}
3444 {not available when compiled without the
3445 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003446 While typing a search command, show where the pattern, as it was typed
3447 so far, matches. The matched string is highlighted. If the pattern
3448 is invalid or not found, nothing is shown. The screen will be updated
3449 often, this is only useful on fast terminals.
3450 Note that the match will be shown, but the cursor will return to its
3451 original position when no match is found and when pressing <Esc>. You
3452 still need to finish the search command with <Enter> to move the
3453 cursor to the match.
3454 The highlighting can be set with the 'i' flag in 'highlight'.
3455 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 NOTE: This option is reset when 'compatible' is set.
3457
3458 *'indentexpr'* *'inde'*
3459'indentexpr' 'inde' string (default "")
3460 local to buffer
3461 {not in Vi}
3462 {not available when compiled without the |+cindent|
3463 or |+eval| features}
3464 Expression which is evaluated to obtain the proper indent for a line.
3465 It is used when a new line is created, for the |=| operator and
3466 in Insert mode as specified with the 'indentkeys' option.
3467 When this option is not empty, it overrules the 'cindent' and
3468 'smartindent' indenting.
3469 When 'paste' is set this option is not used for indenting.
3470 The expression is evaluated with |v:lnum| set to the line number for
3471 which the indent is to be computed. The cursor is also as this line
3472 when the expression is evaluated (but it may be moved around).
3473 The expression must return the number of spaces worth of indent. It
3474 can return "-1" to keep the current indent (this means 'autoindent' is
3475 used for the indent).
3476 Functions useful for computing the indent are |indent()|, |cindent()|
3477 and |lispindent()|.
3478 The evaluation of the expression must not have side effects! It must
3479 not change the text, jump to another window, etc. Afterwards the
3480 cursor position is always restored, thus the cursor may be moved.
3481 Normally this option would be set to call a function: >
3482 :set indentexpr=GetMyIndent()
3483< Error messages will be suppressed, unless the 'debug' option contains
3484 "msg".
3485 See |indent-expression|. Also see |eval-sandbox|.
3486 NOTE: This option is made empty when 'compatible' is set.
3487
3488 *'indentkeys'* *'indk'*
3489'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3490 local to buffer
3491 {not in Vi}
3492 {not available when compiled without the |+cindent|
3493 feature}
3494 A list of keys that, when typed in Insert mode, cause reindenting of
3495 the current line. Only happens if 'indentexpr' isn't empty.
3496 The format is identical to 'cinkeys', see |indentkeys-format|.
3497 See |C-indenting| and |indent-expression|.
3498
3499 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3500'infercase' 'inf' boolean (default off)
3501 local to buffer
3502 {not in Vi}
3503 When doing keyword completion in insert mode |ins-completion|, and
3504 'ignorecase' is also on, the case of the match is adjusted. If the
3505 typed text contains a lowercase letter where the match has an upper
3506 case letter, the completed part is made lowercase. If the typed text
3507 has no lowercase letters and the match has a lowercase letter where
3508 the typed text has an uppercase letter, and there is a letter before
3509 it, the completed part is made uppercase.
3510
3511 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3512'insertmode' 'im' boolean (default off)
3513 global
3514 {not in Vi}
3515 Makes Vim work in a way that Insert mode is the default mode. Useful
3516 if you want to use Vim as a modeless editor. Used for |evim|.
3517 These Insert mode commands will be useful:
3518 - Use the cursor keys to move around.
3519 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3520 this is a mapping, it is executed as if 'insertmode' was off.
3521 Normal mode remains active until the mapping is finished.
3522 *i_CTRL-L*
3523 - Use CTRL-L to execute a number of Normal mode commands, then use
3524 <Esc> to get back to Insert mode.
3525
3526 These items change when 'insertmode' is set:
3527 - when starting to edit of a file, Vim goes to Insert mode.
3528 - <Esc> in Insert mode is a no-op and beeps.
3529 - <Esc> in Normal mode makes Vim go to Insert mode.
3530 - CTRL-L in Insert mode is a command, it is not inserted.
3531 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3532 However, when <Esc> is used inside a mapping, it behaves like
3533 'insertmode' was not set. This was done to be able to use the same
3534 mappings with 'insertmode' set or not set.
3535 When executing commands with |:normal| 'insertmode' is not used.
3536
3537 NOTE: This option is reset when 'compatible' is set.
3538
3539 *'isfname'* *'isf'*
3540'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3541 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3542 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3543 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3544 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3545 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3546 global
3547 {not in Vi}
3548 The characters specified by this option are included in file names and
3549 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003550 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 Multi-byte characters 256 and above are always included, only the
3552 characters up to 255 are specified with this option.
3553 For UTF-8 the characters 0xa0 to 0xff are included as well.
3554
3555 Note that on systems using a backslash as path separator, Vim tries to
3556 do its best to make it work as you would expect. That is a bit
3557 tricky, since Vi originally used the backslash to escape special
3558 characters. Vim will not remove a backslash in front of a normal file
3559 name character on these systems, but it will on Unix and alikes. The
3560 '&' and '^' are not included by default, because these are special for
3561 cmd.exe.
3562
3563 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003564 Each part can be a single character number or a range. A range is two
3565 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 decimal number between 0 and 255 or the ASCII character itself (does
3567 not work for digits). Example:
3568 "_,-,128-140,#-43" (include '_' and '-' and the range
3569 128 to 140 and '#' to 43)
3570 If a part starts with '^', the following character number or range
3571 will be excluded from the option. The option is interpreted from left
3572 to right. Put the excluded character after the range where it is
3573 included. To include '^' itself use it as the last character of the
3574 option or the end of a range. Example:
3575 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3576 If the character is '@', all characters where isalpha() returns TRUE
3577 are included. Normally these are the characters a to z and A to Z,
3578 plus accented characters. To include '@' itself use "@-@". Examples:
3579 "@,^a-z" All alphabetic characters, excluding lower
3580 case letters.
3581 "a-z,A-Z,@-@" All letters plus the '@' character.
3582 A comma can be included by using it where a character number is
3583 expected. Example:
3584 "48-57,,,_" Digits, comma and underscore.
3585 A comma can be excluded by prepending a '^'. Example:
3586 " -~,^,,9" All characters from space to '~', excluding
3587 comma, plus <Tab>.
3588 See |option-backslash| about including spaces and backslashes.
3589
3590 *'isident'* *'isi'*
3591'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3592 "@,48-57,_,128-167,224-235"
3593 otherwise: "@,48-57,_,192-255")
3594 global
3595 {not in Vi}
3596 The characters given by this option are included in identifiers.
3597 Identifiers are used in recognizing environment variables and after a
3598 match of the 'define' option. It is also used for "\i" in a
3599 |pattern|. See 'isfname' for a description of the format of this
3600 option.
3601 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003602 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3604
3605 *'iskeyword'* *'isk'*
3606'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3607 "@,48-57,_,128-167,224-235"
3608 otherwise: "@,48-57,_,192-255"
3609 Vi default: "@,48-57,_")
3610 local to buffer
3611 {not in Vi}
3612 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003613 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 'isfname' for a description of the format of this option. For C
3615 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3616 For a help file it is set to all non-blank printable characters except
3617 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3618 command).
3619 When the 'lisp' option is on the '-' character is always included.
3620 NOTE: This option is set to the Vi default value when 'compatible' is
3621 set and to the Vim default value when 'compatible' is reset.
3622
3623 *'isprint'* *'isp'*
3624'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3625 "@,~-255"; otherwise: "@,161-255")
3626 global
3627 {not in Vi}
3628 The characters given by this option are displayed directly on the
3629 screen. It is also used for "\p" in a |pattern|. The characters from
3630 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3631 even when they are not included in 'isprint' or excluded. See
3632 'isfname' for a description of the format of this option.
3633
3634 Non-printable characters are displayed with two characters:
3635 0 - 31 "^@" - "^_"
3636 32 - 126 always single characters
3637 127 "^?"
3638 128 - 159 "~@" - "~_"
3639 160 - 254 "| " - "|~"
3640 255 "~?"
3641 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3642 displayed as <xx>, with the hexadecimal value of the byte.
3643 When 'display' contains "uhex" all unprintable characters are
3644 displayed as <xx>.
3645 The NonText highlighting will be used for unprintable characters.
3646 |hl-NonText|
3647
3648 Multi-byte characters 256 and above are always included, only the
3649 characters up to 255 are specified with this option. When a character
3650 is printable but it is not available in the current font, a
3651 replacement character will be shown.
3652 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3653 There is no option to specify these characters.
3654
3655 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3656'joinspaces' 'js' boolean (default on)
3657 global
3658 {not in Vi}
3659 Insert two spaces after a '.', '?' and '!' with a join command.
3660 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3661 Otherwise only one space is inserted.
3662 NOTE: This option is set when 'compatible' is set.
3663
3664 *'key'*
3665'key' string (default "")
3666 local to buffer
3667 {not in Vi}
3668 The key that is used for encrypting and decrypting the current buffer.
3669 See |encryption|.
3670 Careful: Do not set the key value by hand, someone might see the typed
3671 key. Use the |:X| command. But you can make 'key' empty: >
3672 :set key=
3673< It is not possible to get the value of this option with ":set key" or
3674 "echo &key". This is to avoid showing it to someone who shouldn't
3675 know. It also means you cannot see it yourself once you have set it,
3676 be careful not to make a typing error!
3677
3678 *'keymap'* *'kmp'* *E544*
3679'keymap' 'kmp' string (default "")
3680 local to buffer
3681 {not in Vi}
3682 {only available when compiled with the |+keymap|
3683 feature}
3684 Name of a keyboard mapping. See |mbyte-keymap|.
3685 Setting this option to a valid keymap name has the side effect of
3686 setting 'iminsert' to one, so that the keymap becomes effective.
3687 'imsearch' is also set to one, unless it was -1
3688
3689 *'keymodel'* *'km'*
3690'keymodel' 'km' string (default "")
3691 global
3692 {not in Vi}
3693 List of comma separated words, which enable special things that keys
3694 can do. These values can be used:
3695 startsel Using a shifted special key starts selection (either
3696 Select mode or Visual mode, depending on "key" being
3697 present in 'selectmode').
3698 stopsel Using a not-shifted special key stops selection.
3699 Special keys in this context are the cursor keys, <End>, <Home>,
3700 <PageUp> and <PageDown>.
3701 The 'keymodel' option is set by the |:behave| command.
3702
3703 *'keywordprg'* *'kp'*
3704'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3705 OS/2: "view /", VMS: "help")
3706 global or local to buffer |global-local|
3707 {not in Vi}
3708 Program to use for the |K| command. Environment variables are
3709 expanded |:set_env|. ":help" may be used to access the Vim internal
3710 help. (Note that previously setting the global option to the empty
3711 value did this, which is now deprecated.)
3712 When "man" is used, Vim will automatically translate a count for the
3713 "K" command to a section number. Also for "man -s", in which case the
3714 "-s" is removed when there is no count.
3715 See |option-backslash| about including spaces and backslashes.
3716 Example: >
3717 :set keywordprg=man\ -s
3718< This option cannot be set from a |modeline| or in the |sandbox|, for
3719 security reasons.
3720
3721 *'langmap'* *'lmap'* *E357* *E358*
3722'langmap' 'lmap' string (default "")
3723 global
3724 {not in Vi}
3725 {only available when compiled with the |+langmap|
3726 feature}
3727 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003728 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 inserted directly. When in command mode the 'langmap' option takes
3730 care of translating these special characters to the original meaning
3731 of the key. This means you don't have to change the keyboard mode to
3732 be able to execute Normal mode commands.
3733 This is the opposite of the 'keymap' option, where characters are
3734 mapped in Insert mode.
3735 This only works for 8-bit characters. The value of 'langmap' may be
3736 specified with multi-byte characters (e.g., UTF-8), but only the lower
3737 8 bits of each character will be used.
3738
3739 Example (for Greek): *greek* >
3740 :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
3741< Example (exchanges meaning of z and y for commands): >
3742 :set langmap=zy,yz,ZY,YZ
3743<
3744 The 'langmap' option is a list of parts, separated with commas. Each
3745 part can be in one of two forms:
3746 1. A list of pairs. Each pair is a "from" character immediately
3747 followed by the "to" character. Examples: "aA", "aAbBcC".
3748 2. A list of "from" characters, a semi-colon and a list of "to"
3749 characters. Example: "abc;ABC"
3750 Example: "aA,fgh;FGH,cCdDeE"
3751 Special characters need to be preceded with a backslash. These are
3752 ";", ',' and backslash itself.
3753
3754 This will allow you to activate vim actions without having to switch
3755 back and forth between the languages. Your language characters will
3756 be understood as normal vim English characters (according to the
3757 langmap mappings) in the following cases:
3758 o Normal/Visual mode (commands, buffer/register names, user mappings)
3759 o Insert/Replace Mode: Register names after CTRL-R
3760 o Insert/Replace Mode: Mappings
3761 Characters entered in Command-line mode will NOT be affected by
3762 this option. Note that this option can be changed at any time
3763 allowing to switch between mappings for different languages/encodings.
3764 Use a mapping to avoid having to type it each time!
3765
3766 *'langmenu'* *'lm'*
3767'langmenu' 'lm' string (default "")
3768 global
3769 {not in Vi}
3770 {only available when compiled with the |+menu| and
3771 |+multi_lang| features}
3772 Language to use for menu translation. Tells which file is loaded
3773 from the "lang" directory in 'runtimepath': >
3774 "lang/menu_" . &langmenu . ".vim"
3775< (without the spaces). For example, to always use the Dutch menus, no
3776 matter what $LANG is set to: >
3777 :set langmenu=nl_NL.ISO_8859-1
3778< When 'langmenu' is empty, |v:lang| is used.
3779 If your $LANG is set to a non-English language but you do want to use
3780 the English menus: >
3781 :set langmenu=none
3782< This option must be set before loading menus, switching on filetype
3783 detection or syntax highlighting. Once the menus are defined setting
3784 this option has no effect. But you could do this: >
3785 :source $VIMRUNTIME/delmenu.vim
3786 :set langmenu=de_DE.ISO_8859-1
3787 :source $VIMRUNTIME/menu.vim
3788< Warning: This deletes all menus that you defined yourself!
3789
3790 *'laststatus'* *'ls'*
3791'laststatus' 'ls' number (default 1)
3792 global
3793 {not in Vi}
3794 The value of this option influences when the last window will have a
3795 status line:
3796 0: never
3797 1: only if there are at least two windows
3798 2: always
3799 The screen looks nicer with a status line if you have several
3800 windows, but it takes another screen line. |status-line|
3801
3802 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3803'lazyredraw' 'lz' boolean (default off)
3804 global
3805 {not in Vi}
3806 When this option is set, the screen will not be redrawn while
3807 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003808 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 update use |:redraw|.
3810
3811 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3812'linebreak' 'lbr' boolean (default off)
3813 local to window
3814 {not in Vi}
3815 {not available when compiled without the |+linebreak|
3816 feature}
3817 If on Vim will wrap long lines at a character in 'breakat' rather
3818 than at the last character that fits on the screen. Unlike
3819 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3820 it only affects the way the file is displayed, not its contents. The
3821 value of 'showbreak' is used to put in front of wrapped lines.
3822 This option is not used when the 'wrap' option is off or 'list' is on.
3823 Note that <Tab> characters after an <EOL> are mostly not displayed
3824 with the right amount of white space.
3825
3826 *'lines'* *E593*
3827'lines' number (default 24 or terminal height)
3828 global
3829 Number of lines of the Vim window.
3830 Normally you don't need to set this. It is done automatically by the
3831 terminal initialization code.
3832 When Vim is running in the GUI or in a resizable window, setting this
3833 option will cause the window size to be changed. When you only want
3834 to use the size for the GUI, put the command in your |gvimrc| file.
3835 Vim limits the number of lines to what fits on the screen. You can
3836 use this command to get the tallest window possible: >
3837 :set lines=999
3838< If you get less lines than expected, check the 'guiheadroom' option.
3839 When you set this option and Vim is unable to change the physical
3840 number of lines of the display, the display may be messed up.
3841
3842 *'linespace'* *'lsp'*
3843'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3844 global
3845 {not in Vi}
3846 {only in the GUI}
3847 Number of pixel lines inserted between characters. Useful if the font
3848 uses the full character cell height, making lines touch each other.
3849 When non-zero there is room for underlining.
3850
3851 *'lisp'* *'nolisp'*
3852'lisp' boolean (default off)
3853 local to buffer
3854 {not available when compiled without the |+lispindent|
3855 feature}
3856 Lisp mode: When <Enter> is typed in insert mode set the indent for
3857 the next line to Lisp standards (well, sort of). Also happens with
3858 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3859 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3860 better. Also see 'lispwords'.
3861 The '-' character is included in keyword characters. Redefines the
3862 "=" operator to use this same indentation algorithm rather than
3863 calling an external program if 'equalprg' is empty.
3864 This option is not used when 'paste' is set.
3865 {Vi: Does it a little bit differently}
3866
3867 *'lispwords'* *'lw'*
3868'lispwords' 'lw' string (default is very long)
3869 global
3870 {not in Vi}
3871 {not available when compiled without the |+lispindent|
3872 feature}
3873 Comma separated list of words that influence the Lisp indenting.
3874 |'lisp'|
3875
3876 *'list'* *'nolist'*
3877'list' boolean (default off)
3878 local to window
3879 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
3880 see the difference between tabs and spaces and for trailing blanks.
3881 Note that this will also affect formatting (set with 'textwidth' or
3882 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
3883 changing the way tabs are displayed.
3884
3885 *'listchars'* *'lcs'*
3886'listchars' 'lcs' string (default "eol:$")
3887 global
3888 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003889 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 settings.
3891 eol:c Character to show at the end of each line. When
3892 omitted, there is no extra character at the end of the
3893 line.
3894 tab:xy Two characters to be used to show a Tab. The first
3895 char is used once. The second char is repeated to
3896 fill the space that the Tab normally occupies.
3897 "tab:>-" will show a Tab that takes four spaces as
3898 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 trailing spaces are blank.
3901 extends:c Character to show in the last column, when 'wrap' is
3902 off and the line continues beyond the right of the
3903 screen.
3904 precedes:c Character to show in the first column, when 'wrap'
3905 is off and there is text preceding the character
3906 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003907 nbsp:c Character to show for a non-breakable space (character
3908 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 be used when 'encoding' is "utf-8", otherwise only printable
3912 characters are allowed.
3913
3914 Examples: >
3915 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003916 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 :set lcs=extends:>,precedes:<
3918< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003919 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920
3921 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3922'loadplugins' 'lpl' boolean (default on)
3923 global
3924 {not in Vi}
3925 When on the plugin scripts are loaded when starting up |load-plugins|.
3926 This option can be reset in your |vimrc| file to disable the loading
3927 of plugins.
3928 Note that using the "-u NONE" and "--noplugin" command line arguments
3929 reset this option. |-u| |--noplugin|
3930
3931 *'magic'* *'nomagic'*
3932'magic' boolean (default on)
3933 global
3934 Changes the special characters that can be used in search patterns.
3935 See |pattern|.
3936 NOTE: To avoid portability problems with using patterns, always keep
3937 this option at the default "on". Only switch it off when working with
3938 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003939 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940
3941 *'makeef'* *'mef'*
3942'makeef' 'mef' string (default: "")
3943 global
3944 {not in Vi}
3945 {not available when compiled without the |+quickfix|
3946 feature}
3947 Name of the errorfile for the |:make| command (see |:make_makeprg|)
3948 and the |:grep| command.
3949 When it is empty, an internally generated temp file will be used.
3950 When "##" is included, it is replaced by a number to make the name
3951 unique. This makes sure that the ":make" command doesn't overwrite an
3952 existing file.
3953 NOT used for the ":cf" command. See 'errorfile' for that.
3954 Environment variables are expanded |:set_env|.
3955 See |option-backslash| about including spaces and backslashes.
3956 This option cannot be set from a |modeline| or in the |sandbox|, for
3957 security reasons.
3958
3959 *'makeprg'* *'mp'*
3960'makeprg' 'mp' string (default "make", VMS: "MMS")
3961 global or local to buffer |global-local|
3962 {not in Vi}
3963 Program to use for the ":make" command. See |:make_makeprg|. This
3964 option may contain '%' and '#' characters, which are expanded like
3965 when used in a command-line. Environment variables are expanded
3966 |:set_env|. See |option-backslash| about including spaces and
3967 backslashes. Note that a '|' must be escaped twice: once for ":set"
3968 and once for the interpretation of a command. When you use a filter
3969 called "myfilter" do it like this: >
3970 :set makeprg=gmake\ \\\|\ myfilter
3971< The placeholder "$*" can be given (even multiple times) to specify
3972 where the arguments will be included, for example: >
3973 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3974< This option cannot be set from a |modeline| or in the |sandbox|, for
3975 security reasons.
3976
3977 *'matchpairs'* *'mps'*
3978'matchpairs' 'mps' string (default "(:),{:},[:]")
3979 local to buffer
3980 {not in Vi}
3981 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003982 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983 must be different. The characters must be separated by a colon. The
3984 pairs must be separated by a comma. Example for including '<' and '>'
3985 (HTML): >
3986 :set mps+=<:>
3987
3988< A more exotic example, to jump between the '=' and ';' in an
3989 assignment, useful for languages like C and Java: >
3990 :au FileType c,cpp,java set mps+==:;
3991
3992< For a more advanced way of using "%", see the matchit.vim plugin in
3993 the $VIMRUNTIME/macros directory. |add-local-help|
3994
3995 *'matchtime'* *'mat'*
3996'matchtime' 'mat' number (default 5)
3997 global
3998 {not in Vi}{in Nvi}
3999 Tenths of a second to show the matching paren, when 'showmatch' is
4000 set. Note that this is not in milliseconds, like other options that
4001 set a time. This is to be compatible with Nvi.
4002
4003 *'maxfuncdepth'* *'mfd'*
4004'maxfuncdepth' 'mfd' number (default 100)
4005 global
4006 {not in Vi}
4007 Maximum depth of function calls for user functions. This normally
4008 catches endless recursion. When using a recursive function with
4009 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4010 more memory, there is the danger of failing when memory is exhausted.
4011 See also |:function|.
4012
4013 *'maxmapdepth'* *'mmd'* *E223*
4014'maxmapdepth' 'mmd' number (default 1000)
4015 global
4016 {not in Vi}
4017 Maximum number of times a mapping is done without resulting in a
4018 character to be used. This normally catches endless mappings, like
4019 ":map x y" with ":map y x". It still does not catch ":map g wg",
4020 because the 'w' is used before the next mapping is done. See also
4021 |key-mapping|.
4022
4023 *'maxmem'* *'mm'*
4024'maxmem' 'mm' number (default between 256 to 5120 (system
4025 dependent) or half the amount of memory
4026 available)
4027 global
4028 {not in Vi}
4029 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4030 limit is reached allocating extra memory for a buffer will cause
4031 other memory to be freed. Maximum value 2000000. Use this to work
4032 without a limit. Also see 'maxmemtot'.
4033
4034 *'maxmemtot'* *'mmt'*
4035'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4036 dependent) or half the amount of memory
4037 available)
4038 global
4039 {not in Vi}
4040 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004041 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 'maxmem'.
4043
4044 *'menuitems'* *'mis'*
4045'menuitems' 'mis' number (default 25)
4046 global
4047 {not in Vi}
4048 {not available when compiled without the |+menu|
4049 feature}
4050 Maximum number of items to use in a menu. Used for menus that are
4051 generated from a list of items, e.g., the Buffers menu. Changing this
4052 option has no direct effect, the menu must be refreshed first.
4053
4054 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4055'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4056 local to buffer
4057 *'modelines'* *'mls'*
4058'modelines' 'mls' number (default 5)
4059 global
4060 {not in Vi}
4061 If 'modeline' is on 'modelines' gives the number of lines that is
4062 checked for set commands. If 'modeline' is off or 'modelines' is zero
4063 no lines are checked. See |modeline|.
4064 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4065 set and to the Vim default value when 'compatible' is reset.
4066
4067 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4068'modifiable' 'ma' boolean (default on)
4069 local to buffer
4070 {not in Vi} *E21*
4071 When off the buffer contents cannot be changed. The 'fileformat' and
4072 'fileencoding' options also can't be changed.
4073 Can be reset with the |-M| command line argument.
4074
4075 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4076'modified' 'mod' boolean (default off)
4077 local to buffer
4078 {not in Vi}
4079 When on, the buffer is considered to be modified. This option is set
4080 when:
4081 1. A change was made to the text since it was last written. Using the
4082 |undo| command to go back to the original text will reset the
4083 option. But undoing changes that were made before writing the
4084 buffer will set the option again, since the text is different from
4085 when it was written.
4086 2. 'fileformat' or 'fileencoding' is different from its original
4087 value. The original value is set when the buffer is read or
4088 written. A ":set nomodified" command also resets the original
4089 values to the current values and the 'modified' option will be
4090 reset.
4091 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4092 will be ignored.
4093
4094 *'more'* *'nomore'*
4095'more' boolean (Vim default: on, Vi default: off)
4096 global
4097 {not in Vi}
4098 When on, listings pause when the whole screen is filled. You will get
4099 the |more-prompt|. When this option is off there are no pauses, the
4100 listing continues until finished.
4101 NOTE: This option is set to the Vi default value when 'compatible' is
4102 set and to the Vim default value when 'compatible' is reset.
4103
4104 *'mouse'* *E538*
4105'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4106 global
4107 {not in Vi}
4108 Enable the use of the mouse. Only works for certain terminals
4109 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4110 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4111 The mouse can be enabled for different modes:
4112 n Normal mode
4113 v Visual mode
4114 i Insert mode
4115 c Command-line mode
4116 h all previous modes when editing a help file
4117 a all previous modes
4118 r for |hit-enter| and |more-prompt| prompt
4119 A auto-select in Visual mode
4120 Normally you would enable the mouse in all four modes with: >
4121 :set mouse=a
4122< When the mouse is not enabled, the GUI will still use the mouse for
4123 modeless selection. This doesn't move the text cursor.
4124
4125 See |mouse-using|. Also see |'clipboard'|.
4126
4127 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004128 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 the mouse buttons can still be used by keeping the shift key pressed.
4130 Also see the 'clipboard' option.
4131
4132 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4133'mousefocus' 'mousef' boolean (default off)
4134 global
4135 {not in Vi}
4136 {only works in the GUI}
4137 The window that the mouse pointer is on is automatically activated.
4138 When changing the window layout or window focus in another way, the
4139 mouse pointer is moved to the window with keyboard focus. Off is the
4140 default because it makes using the pull down menus a little goofy, as
4141 a pointer transit may activate a window unintentionally.
4142
4143 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4144'mousehide' 'mh' boolean (default on)
4145 global
4146 {not in Vi}
4147 {only works in the GUI}
4148 When on, the mouse pointer is hidden when characters are typed.
4149 The mouse pointer is restored when the mouse is moved.
4150
4151 *'mousemodel'* *'mousem'*
4152'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4153 global
4154 {not in Vi}
4155 Sets the model to use for the mouse. The name mostly specifies what
4156 the right mouse button is used for:
4157 extend Right mouse button extends a selection. This works
4158 like in an xterm.
4159 popup Right mouse button pops up a menu. The shifted left
4160 mouse button extends a selection. This works like
4161 with Microsoft Windows
4162 popup_setpos Like "popup", but the cursor will be moved to the
4163 position where the mouse was clicked, and thus the
4164 selected operation will act upon the clicked object.
4165 If clicking inside a selection, that selection will
4166 be acted upon, ie. no cursor move. This implies of
4167 course, that right clicking outside a selection will
4168 end Visual mode.
4169 Overview of what button does what for each model:
4170 mouse extend popup(_setpos) ~
4171 left click place cursor place cursor
4172 left drag start selection start selection
4173 shift-left search word extend selection
4174 right click extend selection popup menu (place cursor)
4175 right drag extend selection -
4176 middle click paste paste
4177
4178 In the "popup" model the right mouse button produces a pop-up menu.
4179 You need to define this first, see |popup-menu|.
4180
4181 Note that you can further refine the meaning of buttons with mappings.
4182 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4183 selection (because that's handled in the GUI code directly).
4184
4185 The 'mousemodel' option is set by the |:behave| command.
4186
4187 *'mouseshape'* *'mouses'* *E547*
4188'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4189 m:no,ml:up-arrow,v:rightup-arrow"
4190 global
4191 {not in Vi}
4192 {only available when compiled with the |+mouseshape|
4193 feature}
4194 This option tells Vim what the mouse pointer should look like in
4195 different modes. The option is a comma separated list of parts, much
4196 like used for 'guicursor'. Each part consist of a mode/location-list
4197 and an argument-list:
4198 mode-list:shape,mode-list:shape,..
4199 The mode-list is a dash separated list of these modes/locations:
4200 In a normal window: ~
4201 n Normal mode
4202 v Visual mode
4203 ve Visual mode with 'selection' "exclusive" (same as 'v',
4204 if not specified)
4205 o Operator-pending mode
4206 i Insert mode
4207 r Replace mode
4208
4209 Others: ~
4210 c appending to the command-line
4211 ci inserting in the command-line
4212 cr replacing in the command-line
4213 m at the 'Hit ENTER' or 'More' prompts
4214 ml idem, but cursor in the last line
4215 e any mode, pointer below last window
4216 s any mode, pointer on a status line
4217 sd any mode, while dragging a status line
4218 vs any mode, pointer on a vertical separator line
4219 vd any mode, while dragging a vertical separator line
4220 a everywhere
4221
4222 The shape is one of the following:
4223 avail name looks like ~
4224 w x arrow Normal mouse pointer
4225 w x blank no pointer at all (use with care!)
4226 w x beam I-beam
4227 w x updown up-down sizing arrows
4228 w x leftright left-right sizing arrows
4229 w x busy The system's usual busy pointer
4230 w x no The system's usual 'no input' pointer
4231 x udsizing indicates up-down resizing
4232 x lrsizing indicates left-right resizing
4233 x crosshair like a big thin +
4234 x hand1 black hand
4235 x hand2 white hand
4236 x pencil what you write with
4237 x question big ?
4238 x rightup-arrow arrow pointing right-up
4239 w x up-arrow arrow pointing up
4240 x <number> any X11 pointer number (see X11/cursorfont.h)
4241
4242 The "avail" column contains a 'w' if the shape is available for Win32,
4243 x for X11.
4244 Any modes not specified or shapes not available use the normal mouse
4245 pointer.
4246
4247 Example: >
4248 :set mouseshape=s:udsizing,m:no
4249< will make the mouse turn to a sizing arrow over the status lines and
4250 indicate no input when the hit-enter prompt is displayed (since
4251 clicking the mouse has no effect in this state.)
4252
4253 *'mousetime'* *'mouset'*
4254'mousetime' 'mouset' number (default 500)
4255 global
4256 {not in Vi}
4257 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4258 time in msec between two mouse clicks for the second click to be
4259 recognized as a multi click.
4260
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004261 *'mzquantum'* *'mzq'*
4262'mzquantum' 'mzq' number (default 100)
4263 global
4264 {not in Vi}
4265 {not available when compiled without the |+mzscheme|
4266 feature}
4267 The number of milliseconds between polls for MzScheme threads.
4268 Negative or zero value means no thread scheduling.
4269
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 *'nrformats'* *'nf'*
4271'nrformats' 'nf' string (default "octal,hex")
4272 local to buffer
4273 {not in Vi}
4274 This defines what bases Vim will consider for numbers when using the
4275 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4276 respectively; see |CTRL-A| for more info on these commands.
4277 alpha if included, single alphabetical characters will be
4278 incremented or decremented. This is useful for a list with a
4279 letter index a), b), etc.
4280 octal if included, numbers that start with a zero will be considered
4281 to be octal. Example: Using CTRL-A on "007" results in "010".
4282 hex if included, numbers starting with "0x" or "0X" will be
4283 considered to be hexadecimal. Example: Using CTRL-X on
4284 "0x100" results in "0x0ff".
4285 Numbers which simply begin with a digit in the range 1-9 are always
4286 considered decimal. This also happens for numbers that are not
4287 recognized as octal or hex.
4288
4289 *'number'* *'nu'* *'nonumber'* *'nonu'*
4290'number' 'nu' boolean (default off)
4291 local to window
4292 Print the line number in front of each line. When the 'n' option is
4293 excluded from 'cpoptions' a wrapped line will not use the column of
4294 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004295 The 'numberwidth' option can be used to set the room used for the line
4296 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 When a long, wrapped line doesn't start with the first character, '-'
4298 characters are put before the number.
4299 See |hl-LineNr| for the highlighting used for the number.
4300
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004301 *'numberwidth'* *'nuw'*
4302'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4303 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004304 {not in Vi}
4305 {only available when compiled with the |+linebreak|
4306 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004307 Minimal number of columns to use for the line number. Only relevant
4308 when the 'number' option is set.
4309 Since one space is always between the number and the text, there is
4310 one less character for the number itself.
4311 The value is the minimum width. A bigger width is used when needed to
4312 fit the highest line number in the buffer. Thus with the Vim default
4313 of 4 there is room for a line number up to 999. When the buffer has
4314 1000 lines five columns will be used.
4315 The minimum value is 1, the maximum value is 10.
4316 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4317
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 *'osfiletype'* *'oft'* *E366*
4319'osfiletype' 'oft' string (RISC-OS default: "Text",
4320 others default: "")
4321 local to buffer
4322 {not in Vi}
4323 {only available when compiled with the |+osfiletype|
4324 feature}
4325 Some operating systems store extra information about files besides
4326 name, datestamp and permissions. This option contains the extra
4327 information, the nature of which will vary between systems.
4328 The value of this option is usually set when the file is loaded, and
4329 use to set the file type when file is written.
4330 It can affect the pattern matching of the automatic commands.
4331 |autocmd-osfiletypes|
4332
4333 *'paragraphs'* *'para'*
4334'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4335 global
4336 Specifies the nroff macros that separate paragraphs. These are pairs
4337 of two letters (see |object-motions|).
4338
4339 *'paste'* *'nopaste'*
4340'paste' boolean (default off)
4341 global
4342 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004343 Put Vim in Paste mode. This is useful if you want to cut or copy
4344 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 unexpected effects.
4346 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004347 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 knows about pasting and will mostly do the right thing without 'paste'
4349 being set. The same is true for a terminal where Vim handles the
4350 mouse clicks itself.
4351 When the 'paste' option is switched on (also when it was already on):
4352 - mapping in Insert mode and Command-line mode is disabled
4353 - abbreviations are disabled
4354 - 'textwidth' is set to 0
4355 - 'wrapmargin' is set to 0
4356 - 'autoindent' is reset
4357 - 'smartindent' is reset
4358 - 'softtabstop' is set to 0
4359 - 'revins' is reset
4360 - 'ruler' is reset
4361 - 'showmatch' is reset
4362 - 'formatoptions' is used like it is empty
4363 These options keep their value, but their effect is disabled:
4364 - 'lisp'
4365 - 'indentexpr'
4366 - 'cindent'
4367 NOTE: When you start editing another file while the 'paste' option is
4368 on, settings from the modelines or autocommands may change the
4369 settings again, causing trouble when pasting text. You might want to
4370 set the 'paste' option again.
4371 When the 'paste' option is reset the mentioned options are restored to
4372 the value before the moment 'paste' was switched from off to on.
4373 Resetting 'paste' before ever setting it does not have any effect.
4374 Since mapping doesn't work while 'paste' is active, you need to use
4375 the 'pastetoggle' option to toggle the 'paste' option with some key.
4376
4377 *'pastetoggle'* *'pt'*
4378'pastetoggle' 'pt' string (default "")
4379 global
4380 {not in Vi}
4381 When non-empty, specifies the key sequence that toggles the 'paste'
4382 option. This is like specifying a mapping: >
4383 :map {keys} :set invpaste<CR>
4384< Where {keys} is the value of 'pastetoggle'.
4385 The difference is that it will work even when 'paste' is set.
4386 'pastetoggle' works in Insert mode and Normal mode, but not in
4387 Command-line mode.
4388 Mappings are checked first, thus overrule 'pastetoggle'. However,
4389 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4390 this: >
4391 :map <F10> :set paste<CR>
4392 :map <F11> :set nopaste<CR>
4393 :imap <F10> <C-O>:set paste<CR>
4394 :imap <F11> <nop>
4395 :set pastetoggle=<F11>
4396< This will make <F10> start paste mode and <F11> stop paste mode.
4397 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4398 mode everything is inserted literally, except the 'pastetoggle' key
4399 sequence.
4400
4401 *'pex'* *'patchexpr'*
4402'patchexpr' 'pex' string (default "")
4403 global
4404 {not in Vi}
4405 {not available when compiled without the |+diff|
4406 feature}
4407 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004408 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409
4410 *'patchmode'* *'pm'* *E206*
4411'patchmode' 'pm' string (default "")
4412 global
4413 {not in Vi}
4414 When non-empty the oldest version of a file is kept. This can be used
4415 to keep the original version of a file if you are changing files in a
4416 source distribution. Only the first time that a file is written a
4417 copy of the original file will be kept. The name of the copy is the
4418 name of the original file with the string in the 'patchmode' option
4419 appended. This option should start with a dot. Use a string like
4420 ".org". 'backupdir' must not be empty for this to work (Detail: The
4421 backup file is renamed to the patchmode file after the new file has
4422 been successfully written, that's why it must be possible to write a
4423 backup file). If there was no file to be backed up, an empty file is
4424 created.
4425 When the 'backupskip' pattern matches, a patchmode file is not made.
4426 Using 'patchmode' for compressed files appends the extension at the
4427 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4428 recognized as a compressed file.
4429
4430 *'path'* *'pa'* *E343* *E345* *E347*
4431'path' 'pa' string (default on Unix: ".,/usr/include,,"
4432 on OS/2: ".,/emx/include,,"
4433 other systems: ".,,")
4434 global or local to buffer |global-local|
4435 {not in Vi}
4436 This is a list of directories which will be searched when using the
4437 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4438 being searched for has a relative path (not starting with '/'). The
4439 directories in the 'path' option may be relative or absolute.
4440 - Use commas to separate directory names: >
4441 :set path=.,/usr/local/include,/usr/include
4442< - Spaces can also be used to separate directory names (for backwards
4443 compatibility with version 3.0). To have a space in a directory
4444 name, precede it with an extra backslash, and escape the space: >
4445 :set path=.,/dir/with\\\ space
4446< - To include a comma in a directory name precede it with an extra
4447 backslash: >
4448 :set path=.,/dir/with\\,comma
4449< - To search relative to the directory of the current file, use: >
4450 :set path=.
4451< - To search in the current directory use an empty string between two
4452 commas: >
4453 :set path=,,
4454< - A directory name may end in a ':' or '/'.
4455 - Environment variables are expanded |:set_env|.
4456 - When using |netrw.vim| URLs can be used. For example, adding
4457 "http://www.vim.org" will make ":find index.html" work.
4458 - Search upwards and downwards in a directory tree:
4459 1) "*" matches a sequence of characters, e.g.: >
4460 :set path=/usr/include/*
4461< means all subdirectories in /usr/include (but not /usr/include
4462 itself). >
4463 :set path=/usr/*c
4464< matches /usr/doc and /usr/src.
4465 2) "**" matches a subtree, up to 100 directories deep. Example: >
4466 :set path=/home/user_x/src/**
4467< means search in the whole subtree under "/home/usr_x/src".
4468 3) If the path ends with a ';', this path is the startpoint
4469 for upward search.
4470 See |file-searching| for more info and exact syntax.
4471 {not available when compiled without the |+path_extra| feature}
4472 - Careful with '\' characters, type two to get one in the option: >
4473 :set path=.,c:\\include
4474< Or just use '/' instead: >
4475 :set path=.,c:/include
4476< Don't forget "." or files won't even be found in the same directory as
4477 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004478 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 it is something like 256 or 1024 characters.
4480 You can check if all the include files are found, using the value of
4481 'path', see |:checkpath|.
4482 The use of |:set+=| and |:set-=| is preferred when adding or removing
4483 directories from the list. This avoids problems when a future version
4484 uses another default. To remove the current directory use: >
4485 :set path-=
4486< To add the current directory use: >
4487 :set path+=
4488< To use an environment variable, you probably need to replace the
4489 separator. Here is an example to append $INCL, in which directory
4490 names are separated with a semi-colon: >
4491 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4492< Replace the ';' with a ':' or whatever separator is used. Note that
4493 this doesn't work when $INCL contains a comma or white space.
4494
4495 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4496'preserveindent' 'pi' boolean (default off)
4497 local to buffer
4498 {not in Vi}
4499 When changing the indent of the current line, preserve as much of the
4500 indent structure as possible. Normally the indent is replaced by a
4501 series of tabs followed by spaces as required (unless |'expandtab'| is
4502 enabled, in which case only spaces are used). Enabling this option
4503 means the indent will preserve as many existing characters as possible
4504 for indenting, and only add additional tabs or spaces as required.
4505 NOTE: When using ">>" multiple times the resulting indent is a mix of
4506 tabs and spaces. You might not like this.
4507 NOTE: 'preserveindent' is reset when 'compatible' is set.
4508 Also see 'copyindent'.
4509 Use |:retab| to clean up white space.
4510
4511 *'previewheight'* *'pvh'*
4512'previewheight' 'pvh' number (default 12)
4513 global
4514 {not in Vi}
4515 {not available when compiled without the |+windows| or
4516 |+quickfix| feature}
4517 Default height for a preview window. Used for |:ptag| and associated
4518 commands. Used for |CTRL-W_}| when no count is given.
4519
4520 *'previewwindow'* *'nopreviewwindow'*
4521 *'pvw'* *'nopvw'* *E590*
4522'previewwindow' 'pvw' boolean (default off)
4523 local to window
4524 {not in Vi}
4525 {not available when compiled without the |+windows| or
4526 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004527 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 set. It's normally not set directly, but by using one of the commands
4529 |:ptag|, |:pedit|, etc.
4530
4531 *'printdevice'* *'pdev'*
4532'printdevice' 'pdev' string (default empty)
4533 global
4534 {not in Vi}
4535 {only available when compiled with the |+printer|
4536 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004537 The name of the printer to be used for |:hardcopy|.
4538 See |pdev-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539
Bram Moolenaar8299df92004-07-10 09:47:34 +00004540 *'printencoding'* *'penc'*
4541'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 global
4543 {not in Vi}
4544 {only available when compiled with the |+printer|
4545 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004546 Sets the character encoding used when printing.
4547 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
4549 *'printexpr'* *'pexpr'*
4550'printexpr' 'pexpr' String (default: see below)
4551 global
4552 {not in Vi}
4553 {only available when compiled with the |+printer|
4554 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004555 Expression used to print the PostScript produced with |:hardcopy|.
4556 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557
Bram Moolenaar8299df92004-07-10 09:47:34 +00004558 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559'printfont' 'pfn' string (default "courier")
4560 global
4561 {not in Vi}
4562 {only available when compiled with the |+printer|
4563 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004564 The name of the font that will be used for |:hardcopy|.
4565 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
4567 *'printheader'* *'pheader'*
4568'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4569 global
4570 {not in Vi}
4571 {only available when compiled with the |+printer|
4572 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004573 The format of the header produced in |:hardcopy| output.
4574 See |pheader-option|.
4575
4576 *'printmbcharset'* *'pmbcs'*
4577'printmbcharset' 'pmbcs' string (default "")
4578 global
4579 {not in Vi}
4580 {only available when compiled with the |+printer|
4581 and |+multi_byte| features}
4582 The CJK character set to be used for CJK output from |:hardcopy|.
4583 See |pmbcs-option|.
4584
4585 *'printmbfont'* *'pmbfn'*
4586'printmbfont' 'pmbfn' string (default "")
4587 global
4588 {not in Vi}
4589 {only available when compiled with the |+printer|
4590 and |+multi_byte| features}
4591 List of font names to be used for CJK output from |:hardcopy|.
4592 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593
4594 *'printoptions'* *'popt'*
4595'printoptions' 'popt' string (default "")
4596 global
4597 {not in Vi}
4598 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004599 List of items that control the format of the output of |:hardcopy|.
4600 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004602 *'quoteescape''* *'qe'*
4603'quoteescape' 'qe' string (default "\")
4604 local to buffer
4605 {not in Vi}
4606 The characters that are used to escape quotes in a string. Used for
4607 objects like a', a" and a` |a'|.
4608 When one of the characters in this option is found inside a string,
4609 the following character will be skipped. The default value makes the
4610 text "foo\"bar\\" considered to be one string.
4611
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4613'readonly' 'ro' boolean (default off)
4614 local to buffer
4615 If on, writes fail unless you use a '!'. Protects you from
4616 accidentally overwriting a file. Default on when Vim is started
4617 in read-only mode ("vim -R") or when the executable is called "view".
4618 {not in Vi:} When using the ":view" command the 'readonly' option is
4619 set for the newly edited buffer. When using ":w!" the 'readonly'
4620 option is reset for the current buffer.
4621
4622 *'remap'* *'noremap'*
4623'remap' boolean (default on)
4624 global
4625 Allows for mappings to work recursively. If you do not want this for
4626 a single entry, use the :noremap[!] command.
4627
4628 *'report'*
4629'report' number (default 2)
4630 global
4631 Threshold for reporting number of lines changed. When the number of
4632 changed lines is more than 'report' a message will be given for most
4633 ":" commands. If you want it always, set 'report' to 0.
4634 For the ":substitute" command the number of substitutions is used
4635 instead of the number of lines.
4636
4637 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4638'restorescreen' 'rs' boolean (default on)
4639 global
4640 {not in Vi} {only in Windows 95/NT console version}
4641 When set, the screen contents is restored when exiting Vim. This also
4642 happens when executing external commands.
4643
4644 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4645 options in your .vimrc. To disable restoring:
4646 set t_ti= t_te=
4647 To enable restoring (for an xterm):
4648 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4649 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4650
4651 *'revins'* *'ri'* *'norevins'* *'nori'*
4652'revins' 'ri' boolean (default off)
4653 global
4654 {not in Vi}
4655 {only available when compiled with the |+rightleft|
4656 feature}
4657 Inserting characters in Insert mode will work backwards. See "typing
4658 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4659 command in Insert mode, when 'allowrevins' is set.
4660 NOTE: This option is reset when 'compatible' or 'paste' is set.
4661
4662 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4663'rightleft' 'rl' boolean (default off)
4664 local to window
4665 {not in Vi}
4666 {only available when compiled with the |+rightleft|
4667 feature}
4668 When on, display orientation becomes right-to-left, i.e., characters
4669 that are stored in the file appear from the right to the left.
4670 Using this option, it is possible to edit files for languages that
4671 are written from the right to the left such as Hebrew and Arabic.
4672 This option is per window, so it is possible to edit mixed files
4673 simultaneously, or to view the same file in both ways (this is
4674 useful whenever you have a mixed text file with both right-to-left
4675 and left-to-right strings so that both sets are displayed properly
4676 in different windows). Also see |rileft.txt|.
4677
4678 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4679'rightleftcmd' 'rlc' string (default "search")
4680 local to window
4681 {not in Vi}
4682 {only available when compiled with the |+rightleft|
4683 feature}
4684 Each word in this option enables the command line editing to work in
4685 right-to-left mode for a group of commands:
4686
4687 search "/" and "?" commands
4688
4689 This is useful for languages such as Hebrew, Arabic and Farsi.
4690 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4691
4692 *'ruler'* *'ru'* *'noruler'* *'noru'*
4693'ruler' 'ru' boolean (default off)
4694 global
4695 {not in Vi}
4696 {not available when compiled without the
4697 |+cmdline_info| feature}
4698 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004699 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 text in the file is shown on the far right:
4701 Top first line is visible
4702 Bot last line is visible
4703 All first and last line are visible
4704 45% relative position in the file
4705 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004706 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707 ruler is shown there. Otherwise it is shown in the last line of the
4708 screen. If the statusline is given by 'statusline' (ie. not empty),
4709 this option takes precedence over 'ruler' and 'rulerformat'
4710 If the number of characters displayed is different from the number of
4711 bytes in the text (e.g., for a TAB or a multi-byte character), both
4712 the text column (byte number) and the screen column are shown,
4713 separated with a dash.
4714 For an empty line "0-1" is shown.
4715 For an empty buffer the line number will also be zero: "0,0-1".
4716 This option is reset when the 'paste' option is set.
4717 If you don't want to see the ruler all the time but want to know where
4718 you are, use "g CTRL-G" |g_CTRL-G|.
4719 NOTE: This option is reset when 'compatible' is set.
4720
4721 *'rulerformat'* *'ruf'*
4722'rulerformat' 'ruf' string (default empty)
4723 global
4724 {not in Vi}
4725 {not available when compiled without the |+statusline|
4726 feature}
4727 When this option is not empty, it determines the content of the ruler
4728 string, as displayed for the 'ruler' option.
4729 The format of this option, is like that of 'statusline'.
4730 The default ruler width is 17 characters. To make the ruler 15
4731 characters wide, put "%15(" at the start and "%)" at the end.
4732 Example: >
4733 :set rulerformat=%15(%c%V\ %p%%%)
4734<
4735 *'runtimepath'* *'rtp'* *vimfiles*
4736'runtimepath' 'rtp' string (default:
4737 Unix: "$HOME/.vim,
4738 $VIM/vimfiles,
4739 $VIMRUNTIME,
4740 $VIM/vimfiles/after,
4741 $HOME/.vim/after"
4742 Amiga: "home:vimfiles,
4743 $VIM/vimfiles,
4744 $VIMRUNTIME,
4745 $VIM/vimfiles/after,
4746 home:vimfiles/after"
4747 PC, OS/2: "$HOME/vimfiles,
4748 $VIM/vimfiles,
4749 $VIMRUNTIME,
4750 $VIM/vimfiles/after,
4751 $HOME/vimfiles/after"
4752 Macintosh: "$VIM:vimfiles,
4753 $VIMRUNTIME,
4754 $VIM:vimfiles:after"
4755 RISC-OS: "Choices:vimfiles,
4756 $VIMRUNTIME,
4757 Choices:vimfiles/after"
4758 VMS: "sys$login:vimfiles,
4759 $VIM/vimfiles,
4760 $VIMRUNTIME,
4761 $VIM/vimfiles/after,
4762 sys$login:vimfiles/after"
4763 global
4764 {not in Vi}
4765 This is a list of directories which will be searched for runtime
4766 files:
4767 filetype.vim filetypes by file name |new-filetype|
4768 scripts.vim filetypes by file contents |new-filetype-scripts|
4769 colors/ color scheme files |:colorscheme|
4770 compiler/ compiler files |:compiler|
4771 doc/ documentation |write-local-help|
4772 ftplugin/ filetype plugins |write-filetype-plugin|
4773 indent/ indent scripts |indent-expression|
4774 keymap/ key mapping files |mbyte-keymap|
4775 lang/ menu translations |:menutrans|
4776 menu.vim GUI menus |menu.vim|
4777 plugin/ plugin scripts |write-plugin|
4778 print/ files for printing |postscript-print-encoding|
4779 syntax/ syntax files |mysyntaxfile|
4780 tutor/ files for vimtutor |tutor|
4781
4782 And any other file searched for with the |:runtime| command.
4783
4784 The defaults for most systems are setup to search five locations:
4785 1. In your home directory, for your personal preferences.
4786 2. In a system-wide Vim directory, for preferences from the system
4787 administrator.
4788 3. In $VIMRUNTIME, for files distributed with Vim.
4789 *after-directory*
4790 4. In the "after" directory in the system-wide Vim directory. This is
4791 for the system administrator to overrule or add to the distributed
4792 defaults (rarely needed)
4793 5. In the "after" directory in your home directory. This is for
4794 personal preferences to overrule or add to the distributed defaults
4795 or system-wide settings (rarely needed).
4796
4797 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4798 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004799 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 wildcards.
4801 See |:runtime|.
4802 Example: >
4803 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4804< This will use the directory "~/vimruntime" first (containing your
4805 personal Vim runtime files), then "/mygroup/vim" (shared between a
4806 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4807 files).
4808 You probably should always include $VIMRUNTIME somewhere, to use the
4809 distributed runtime files. You can put a directory before $VIMRUNTIME
4810 to find files which replace a distributed runtime files. You can put
4811 a directory after $VIMRUNTIME to find files which add to distributed
4812 runtime files.
4813 This option cannot be set from a |modeline| or in the |sandbox|, for
4814 security reasons.
4815
4816 *'scroll'* *'scr'*
4817'scroll' 'scr' number (default: half the window height)
4818 local to window
4819 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4820 set to half the number of lines in the window when the window size
4821 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004822 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004823 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4824 the number of screen lines instead of file lines, makes a difference
4825 when lines wrap}
4826
4827 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4828'scrollbind' 'scb' boolean (default off)
4829 local to window
4830 {not in Vi}
4831 {not available when compiled without the |+scrollbind|
4832 feature}
4833 See also |scroll-binding|. When this option is set, the current
4834 window scrolls as other scrollbind windows (windows that also have
4835 this option set) scroll. This option is useful for viewing the
4836 differences between two versions of a file, see 'diff'.
4837 See |'scrollopt'| for options that determine how this option should be
4838 interpreted.
4839 This option is mostly reset when splitting a window to edit another
4840 file. This means that ":split | edit file" results in two windows
4841 with scroll-binding, but ":split file" does not.
4842
4843 *'scrolljump'* *'sj'*
4844'scrolljump' 'sj' number (default 1)
4845 global
4846 {not in Vi}
4847 Minimal number of lines to scroll when the cursor gets off the
4848 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4849 CTRL-D). Useful if your terminal scrolls very slowly.
4850 NOTE: This option is set to 1 when 'compatible' is set.
4851
4852 *'scrolloff'* *'so'*
4853'scrolloff' 'so' number (default 0)
4854 global
4855 {not in Vi}
4856 Minimal number of screen lines to keep above and below the cursor.
4857 This will make some context visible around where you are working. If
4858 you set it to a very large value (999) the cursor line will always be
4859 in the middle of the window (except at the start or end of the file or
4860 when long lines wrap).
4861 For scrolling horizontally see 'sidescrolloff'.
4862 NOTE: This option is set to 0 when 'compatible' is set.
4863
4864 *'scrollopt'* *'sbo'*
4865'scrollopt' 'sbo' string (default "ver,jump")
4866 global
4867 {not available when compiled without the |+scrollbind|
4868 feature}
4869 {not in Vi}
4870 This is a comma-separated list of words that specifies how
4871 'scrollbind' windows should behave.
4872 The following words are available:
4873 ver Bind vertical scrolling for 'scrollbind' windows
4874 hor Bind horizontal scrolling for 'scrollbind' windows
4875 jump Applies to the offset between two windows for vertical
4876 scrolling. This offset is the difference in the first
4877 displayed line of the bound windows. When moving
4878 around in a window, another 'scrollbind' window may
4879 reach a position before the start or after the end of
4880 the buffer. The offset is not changed though, when
4881 moving back the 'scrollbind' window will try to scroll
4882 to the desired position when possible.
4883 When now making that window the current one, two
4884 things can be done with the relative offset:
4885 1. When "jump" is not included, the relative offset is
4886 adjusted for the scroll position in the new current
4887 window. When going back to the other window, the
4888 the new relative offset will be used.
4889 2. When "jump" is included, the other windows are
4890 scrolled to keep the same relative offset. When
4891 going back to the other window, it still uses the
4892 same relative offset.
4893 Also see |scroll-binding|.
4894
4895 *'sections'* *'sect'*
4896'sections' 'sect' string (default "SHNHH HUnhsh")
4897 global
4898 Specifies the nroff macros that separate sections. These are pairs of
4899 two letters (See |object-motions|). The default makes a section start
4900 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
4901
4902 *'secure'* *'nosecure'* *E523*
4903'secure' boolean (default off)
4904 global
4905 {not in Vi}
4906 When on, ":autocmd", shell and write commands are not allowed in
4907 ".vimrc" and ".exrc" in the current directory and map commands are
4908 displayed. Switch it off only if you know that you will not run into
4909 problems, or when the 'exrc' option is off. On Unix this option is
4910 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004911 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 'secure' at the end of your ~/.vimrc then.
4913 This option cannot be set from a |modeline| or in the |sandbox|, for
4914 security reasons.
4915
4916 *'selection'* *'sel'*
4917'selection' 'sel' string (default "inclusive")
4918 global
4919 {not in Vi}
4920 This option defines the behavior of the selection. It is only used
4921 in Visual and Select mode.
4922 Possible values:
4923 value past line inclusive ~
4924 old no yes
4925 inclusive yes yes
4926 exclusive yes no
4927 "past line" means that the cursor is allowed to be positioned one
4928 character past the line.
4929 "inclusive" means that the last character of the selection is included
4930 in an operation. For example, when "x" is used to delete the
4931 selection.
4932 Note that when "exclusive" is used and selecting from the end
4933 backwards, you cannot include the last character of a line, when
4934 starting in Normal mode and 'virtualedit' empty.
4935
4936 The 'selection' option is set by the |:behave| command.
4937
4938 *'selectmode'* *'slm'*
4939'selectmode' 'slm' string (default "")
4940 global
4941 {not in Vi}
4942 This is a comma separated list of words, which specifies when to start
4943 Select mode instead of Visual mode, when a selection is started.
4944 Possible values:
4945 mouse when using the mouse
4946 key when using shifted special keys
4947 cmd when using "v", "V" or CTRL-V
4948 See |Select-mode|.
4949 The 'selectmode' option is set by the |:behave| command.
4950
4951 *'sessionoptions'* *'ssop'*
4952'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
4953 help,options,winsize")
4954 global
4955 {not in Vi}
4956 {not available when compiled without the +mksession
4957 feature}
4958 Changes the effect of the |:mksession| command. It is a comma
4959 separated list of words. Each word enables saving and restoring
4960 something:
4961 word save and restore ~
4962 blank empty windows
4963 buffers hidden and unloaded buffers, not just those in windows
4964 curdir the current directory
4965 folds manually created folds, opened/closed folds and local
4966 fold options
4967 globals global variables that start with an uppercase letter
4968 and contain at least one lowercase letter.
4969 help the help window
4970 localoptions options and mappings local to a window or buffer (not
4971 global values for local options)
4972 options all options and mappings (also global values for local
4973 options)
4974 resize size of the Vim window: 'lines' and 'columns'
4975 sesdir the directory in which the session file is located
4976 will become the current directory (useful with
4977 projects accessed over a network from different
4978 systems)
4979 slash backslashes in file names replaced with forward
4980 slashes
4981 unix with Unix end-of-line format (single <NL>), even when
4982 on Windows or DOS
4983 winpos position of the whole Vim window
4984 winsize window sizes
4985
4986 Don't include both "curdir" and "sesdir".
4987 When "curdir" nor "sesdir" is included, file names are stored with
4988 absolute paths.
4989 "slash" and "unix" are useful on Windows when sharing session files
4990 with Unix. The Unix version of Vim cannot source dos format scripts,
4991 but the Windows version of Vim can source unix format scripts.
4992
4993 *'shell'* *'sh'* *E91*
4994'shell' 'sh' string (default $SHELL or "sh",
4995 MS-DOS and Win32: "command.com" or
4996 "cmd.exe", OS/2: "cmd")
4997 global
4998 Name of the shell to use for ! and :! commands. When changing the
4999 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5000 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005001 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005002 See |option-backslash| about including spaces and backslashes.
5003 Environment variables are expanded |:set_env|.
5004 If the name of the shell contains a space, you might need to enclose
5005 it in quotes. Example: >
5006 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5007< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005008 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 "-f" is not inside the quotes, because it is not part of the command
5010 name. And Vim automagically recognizes the backslashes that are path
5011 separators.
5012 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5013 variable to change the way external commands are executed. See the
5014 libc.inf file of DJGPP.
5015 Under MS-Windows, when the executable ends in ".com" it must be
5016 included. Thus setting the shell to "command.com" or "4dos.com"
5017 works, but "command" and "4dos" do not work for all commands (e.g.,
5018 filtering).
5019 For unknown reasons, when using "4dos.com" the current directory is
5020 changed to "C:\". To avoid this set 'shell' like this: >
5021 :set shell=command.com\ /c\ 4dos
5022< This option cannot be set from a |modeline| or in the |sandbox|, for
5023 security reasons.
5024
5025 *'shellcmdflag'* *'shcf'*
5026'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5027 does not contain "sh" somewhere: "/c")
5028 global
5029 {not in Vi}
5030 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5031 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5032 systems, the default is set according to the value of 'shell', to
5033 reduce the need to set this option by the user. It's not used for
5034 OS/2 (EMX figures this out itself). See |option-backslash| about
5035 including spaces and backslashes. See |dos-shell|.
5036 This option cannot be set from a |modeline| or in the |sandbox|, for
5037 security reasons.
5038
5039 *'shellpipe'* *'sp'*
5040'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5041 global
5042 {not in Vi}
5043 {not available when compiled without the |+quickfix|
5044 feature}
5045 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005046 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047 including spaces and backslashes.
5048 The name of the temporary file can be represented by "%s" if necessary
5049 (the file name is appended automatically if no %s appears in the value
5050 of this option).
5051 For the Amiga and MS-DOS the default is ">". The output is directly
5052 saved in a file and not echoed to the screen.
5053 For Unix the default it "| tee". The stdout of the compiler is saved
5054 in a file and echoed to the screen. If the 'shell' option is "csh" or
5055 "tcsh" after initializations, the default becomes "|& tee". If the
5056 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5057 "2>&1| tee". This means that stderr is also included.
5058 The initialization of this option is done after reading the ".vimrc"
5059 and the other initializations, so that when the 'shell' option is set
5060 there, the 'shellpipe' option changes automatically, unless it was
5061 explicitly set before.
5062 When 'shellpipe' is set to an empty string, no redirection of the
5063 ":make" output will be done. This is useful if you use a 'makeprg'
5064 that writes to 'makeef' by itself. If you want no piping, but do
5065 want to include the 'makeef', set 'shellpipe' to a single space.
5066 Don't forget to precede the space with a backslash: ":set sp=\ ".
5067 In the future pipes may be used for filtering and this option will
5068 become obsolete (at least for Unix).
5069 This option cannot be set from a |modeline| or in the |sandbox|, for
5070 security reasons.
5071
5072 *'shellquote'* *'shq'*
5073'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5074 contains "sh" somewhere: "\"")
5075 global
5076 {not in Vi}
5077 Quoting character(s), put around the command passed to the shell, for
5078 the "!" and ":!" commands. The redirection is kept outside of the
5079 quoting. See 'shellxquote' to include the redirection. It's
5080 probably not useful to set both options.
5081 This is an empty string by default. Only known to be useful for
5082 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5083 or bash, where it should be "\"". The default is adjusted according
5084 the value of 'shell', to reduce the need to set this option by the
5085 user. See |dos-shell|.
5086 This option cannot be set from a |modeline| or in the |sandbox|, for
5087 security reasons.
5088
5089 *'shellredir'* *'srr'*
5090'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5091 global
5092 {not in Vi}
5093 String to be used to put the output of a filter command in a temporary
5094 file. See also |:!|. See |option-backslash| about including spaces
5095 and backslashes.
5096 The name of the temporary file can be represented by "%s" if necessary
5097 (the file name is appended automatically if no %s appears in the value
5098 of this option).
5099 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5100 or "zsh" during initializations, the default becomes ">&". If the
5101 'shell' option is "sh", "ksh" or "bash" the default becomes
5102 ">%s 2>&1". This means that stderr is also included.
5103 For Win32, the Unix checks are done and additionally "cmd" is checked
5104 for, which makes the default ">%s 2>&1". Also, the same names with
5105 ".exe" appended are checked for.
5106 The initialization of this option is done after reading the ".vimrc"
5107 and the other initializations, so that when the 'shell' option is set
5108 there, the 'shellredir' option changes automatically unless it was
5109 explicitly set before.
5110 In the future pipes may be used for filtering and this option will
5111 become obsolete (at least for Unix).
5112 This option cannot be set from a |modeline| or in the |sandbox|, for
5113 security reasons.
5114
5115 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5116'shellslash' 'ssl' boolean (default off)
5117 global
5118 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5119 When set, a forward slash is used when expanding file names. This is
5120 useful when a Unix-like shell is used instead of command.com or
5121 cmd.exe. Backward slashes can still be typed, but they are changed to
5122 forward slashes by Vim.
5123 Note that setting or resetting this option has no effect for some
5124 existing file names, thus this option needs to be set before opening
5125 any file for best results. This might change in the future.
5126 'shellslash' only works when a backslash can be used as a path
5127 separator. To test if this is so use: >
5128 if exists('+shellslash')
5129<
5130 *'shelltype'* *'st'*
5131'shelltype' 'st' number (default 0)
5132 global
5133 {not in Vi} {only for the Amiga}
5134 On the Amiga this option influences the way how the commands work
5135 which use a shell.
5136 0 and 1: always use the shell
5137 2 and 3: use the shell only to filter lines
5138 4 and 5: use shell only for ':sh' command
5139 When not using the shell, the command is executed directly.
5140
5141 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5142 1 and 3: use "shell cmd" to start external commands
5143
5144 *'shellxquote'* *'sxq'*
5145'shellxquote' 'sxq' string (default: "";
5146 for Win32, when 'shell' contains "sh"
5147 somewhere: "\""
5148 for Unix, when using system(): "\"")
5149 global
5150 {not in Vi}
5151 Quoting character(s), put around the command passed to the shell, for
5152 the "!" and ":!" commands. Includes the redirection. See
5153 'shellquote' to exclude the redirection. It's probably not useful
5154 to set both options.
5155 This is an empty string by default. Known to be useful for
5156 third-party shells when using the Win32 version, such as the MKS Korn
5157 Shell or bash, where it should be "\"". The default is adjusted
5158 according the value of 'shell', to reduce the need to set this option
5159 by the user. See |dos-shell|.
5160 This option cannot be set from a |modeline| or in the |sandbox|, for
5161 security reasons.
5162
5163 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5164'shiftround' 'sr' boolean (default off)
5165 global
5166 {not in Vi}
5167 Round indent to multiple of 'shiftwidth'. Applies to > and <
5168 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5169 a multiple of 'shiftwidth' (this is Vi compatible).
5170 NOTE: This option is reset when 'compatible' is set.
5171
5172 *'shiftwidth'* *'sw'*
5173'shiftwidth' 'sw' number (default 8)
5174 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005175 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 |'cindent'|, |>>|, |<<|, etc.
5177
5178 *'shortmess'* *'shm'*
5179'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "")
5180 global
5181 {not in Vi}
5182 This option helps to avoid all the |hit-enter| prompts caused by file
5183 messages, for example with CTRL-G, and to avoid some other messages.
5184 It is a list of flags:
5185 flag meaning when present ~
5186 f use "(3 of 5)" instead of "(file 3 of 5)"
5187 i use "[noeol]" instead of "[Incomplete last line]"
5188 l use "999L, 888C" instead of "999 lines, 888 characters"
5189 m use "[+]" instead of "[Modified]"
5190 n use "[New]" instead of "[New File]"
5191 r use "[RO]" instead of "[readonly]"
5192 w use "[w]" instead of "written" for file write message
5193 and "[a]" instead of "appended" for ':w >> file' command
5194 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5195 "[unix format]" and "[mac]" instead of "[mac format]".
5196 a all of the above abbreviations
5197
5198 o overwrite message for writing a file with subsequent message
5199 for reading a file (useful for ":wn" or when 'autowrite' on)
5200 O message for reading a file overwrites any previous message.
5201 Also for quickfix message (e.g., ":cn").
5202 s don't give "search hit BOTTOM, continuing at TOP" or "search
5203 hit TOP, continuing at BOTTOM" messages
5204 t truncate file message at the start if it is too long to fit
5205 on the command-line, "<" will appear in the left most column.
5206 Ignored in Ex mode.
5207 T truncate other messages in the middle if they are too long to
5208 fit on the command line. "..." will appear in the middle.
5209 Ignored in Ex mode.
5210 W don't give "written" or "[w]" when writing a file
5211 A don't give the "ATTENTION" message when an existing swap file
5212 is found.
5213 I don't give the intro message when starting Vim |:intro|.
5214
5215 This gives you the opportunity to avoid that a change between buffers
5216 requires you to hit <Enter>, but still gives as useful a message as
5217 possible for the space available. To get the whole message that you
5218 would have got with 'shm' empty, use ":file!"
5219 Useful values:
5220 shm= No abbreviation of message.
5221 shm=a Abbreviation, but no loss of information.
5222 shm=at Abbreviation, and truncate message when necessary.
5223
5224 NOTE: This option is set to the Vi default value when 'compatible' is
5225 set and to the Vim default value when 'compatible' is reset.
5226
5227 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5228'shortname' 'sn' boolean (default off)
5229 local to buffer
5230 {not in Vi, not in MS-DOS versions}
5231 Filenames are assumed to be 8 characters plus one extension of 3
5232 characters. Multiple dots in file names are not allowed. When this
5233 option is on, dots in file names are replaced with underscores when
5234 adding an extension (".~" or ".swp"). This option is not available
5235 for MS-DOS, because then it would always be on. This option is useful
5236 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5237 or crossdos. When running the Win32 GUI version under Win32s, this
5238 option is always on by default.
5239
5240 *'showbreak'* *'sbr'* *E595*
5241'showbreak' 'sbr' string (default "")
5242 global
5243 {not in Vi}
5244 {not available when compiled without the |+linebreak|
5245 feature}
5246 String to put at the start of lines that have been wrapped. Useful
5247 values are "> " or "+++ ".
5248 Only printable single-cell characters are allowed, excluding <Tab> and
5249 comma (in a future version the comma might be used to separate the
5250 part that is shown at the end and at the start of a line).
5251 The characters are highlighted according to the '@' flag in
5252 'highlight'.
5253 Note that tabs after the showbreak will be displayed differently.
5254 If you want the 'showbreak' to appear in between line numbers, add the
5255 "n" flag to 'cpoptions'.
5256
5257 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5258'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5259 off)
5260 global
5261 {not in Vi}
5262 {not available when compiled without the
5263 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005264 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265 terminal is slow.
5266 In Visual mode the size of the selected area is shown:
5267 - When selecting characters within a line, the number of characters.
5268 - When selecting more than one line, the number of lines.
5269 - When selecting a block, the size in screen characters: linesxcolumns.
5270 NOTE: This option is set to the Vi default value when 'compatible' is
5271 set and to the Vim default value when 'compatible' is reset.
5272
5273 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5274'showfulltag' 'sft' boolean (default off)
5275 global
5276 {not in Vi}
5277 When completing a word in insert mode (see |ins-completion|) from the
5278 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005279 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 matched a C function, you can see a template for what arguments are
5281 required (coding style permitting).
5282
5283 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5284'showmatch' 'sm' boolean (default off)
5285 global
5286 When a bracket is inserted, briefly jump to the matching one. The
5287 jump is only done if the match can be seen on the screen. The time to
5288 show the match can be set with 'matchtime'.
5289 A Beep is given if there is no match (no matter if the match can be
5290 seen or not). This option is reset when the 'paste' option is set.
5291 When the 'm' flag is not included in 'cpoptions', typing a character
5292 will immediately move the cursor back to where it belongs.
5293 See the "sm" field in 'guicursor' for setting the cursor shape and
5294 blinking when showing the match.
5295 The 'matchpairs' option can be used to specify the characters to show
5296 matches for. 'rightleft' and 'revins' are used to look for opposite
5297 matches.
5298 Note: For the use of the short form parental guidance is advised.
5299
5300 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5301'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5302 global
5303 If in Insert, Replace or Visual mode put a message on the last line.
5304 Use the 'M' flag in 'highlight' to set the type of highlighting for
5305 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005306 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 doesn't mean XIM is really active, especially when 'imactivatekey' is
5308 not set.
5309 NOTE: This option is set to the Vi default value when 'compatible' is
5310 set and to the Vim default value when 'compatible' is reset.
5311
5312 *'sidescroll'* *'ss'*
5313'sidescroll' 'ss' number (default 0)
5314 global
5315 {not in Vi}
5316 The minimal number of columns to scroll horizontally. Used only when
5317 the 'wrap' option is off and the cursor is moved off of the screen.
5318 When it is zero the cursor will be put in the middle of the screen.
5319 When using a slow terminal set it to a large number or 0. When using
5320 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5321 commands.
5322
5323 *'sidescrolloff'* *'siso'*
5324'sidescrolloff' 'siso' number (default 0)
5325 global
5326 {not in Vi}
5327 The minimal number of screen columns to keep to the left and to the
5328 right of the cursor if 'nowrap' is set. Setting this option to a value
5329 greater than 0 while having |'sidescroll'| also at a non-zero value
5330 makes some context visible in the line you are scrolling in
5331 horizontally (except at the end and beginning of the line). Setting
5332 this option to a large value (like 999) has the effect of keeping the
5333 cursor horizontally centered in the window, as long as one does not
5334 come too close to the beginning or end of the line.
5335 NOTE: This option is set to 0 when 'compatible' is set.
5336
5337 Example: Try this together with 'sidescroll' and 'listchars' as
5338 in the following example to never allow the cursor to move
5339 onto the "extends" character:
5340
5341 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5342 :set sidescrolloff=1
5343
5344
5345 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5346'smartcase' 'scs' boolean (default off)
5347 global
5348 {not in Vi}
5349 Override the 'ignorecase' option if the search pattern contains upper
5350 case characters. Only used when the search pattern is typed and
5351 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005352 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005353 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5354 recalling the search pattern from history and hitting <Enter>.
5355 NOTE: This option is reset when 'compatible' is set.
5356
5357 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5358'smartindent' 'si' boolean (default off)
5359 local to buffer
5360 {not in Vi}
5361 {not available when compiled without the
5362 |+smartindent| feature}
5363 Do smart autoindenting when starting a new line. Works for C-like
5364 programs, but can also be used for other languages. 'cindent' does
5365 something like this, works better in most cases, but is more strict,
5366 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5367 'indentexpr' is a more advanced alternative.
5368 Normally 'autoindent' should also be on when using 'smartindent'.
5369 An indent is automatically inserted:
5370 - After a line ending in '{'.
5371 - After a line starting with a keyword from 'cinwords'.
5372 - Before a line starting with '}' (only with the "O" command).
5373 When typing '}' as the first character in a new line, that line is
5374 given the same indent as the matching '{'.
5375 When typing '#' as the first character in a new line, the indent for
5376 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005377 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5379 When using the ">>" command, lines starting with '#' are not shifted
5380 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005381 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 is set smart indenting is disabled.
5383
5384 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5385'smarttab' 'sta' boolean (default off)
5386 global
5387 {not in Vi}
5388 When on, a <Tab> in front of a line inserts blanks according to
5389 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5390 a 'shiftwidth' worth of space at the start of the line.
5391 When off a <Tab> always inserts blanks according to 'tabstop'.
5392 'shiftwidth' is only used for shifting text left or right
5393 |shift-left-right|.
5394 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5395 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005396 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 NOTE: This option is reset when 'compatible' is set.
5398
5399 *'softtabstop'* *'sts'*
5400'softtabstop' 'sts' number (default 0)
5401 local to buffer
5402 {not in Vi}
5403 Number of spaces that a <Tab> counts for while performing editing
5404 operations, like inserting a <Tab> or using <BS>. It "feels" like
5405 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5406 used. This is useful to keep the 'ts' setting at its standard value
5407 of 8, while being able to edit like it is set to 'sts'. However,
5408 commands like "x" still work on the actual characters.
5409 When 'sts' is zero, this feature is off.
5410 'softtabstop' is set to 0 when the 'paste' option is set.
5411 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5412 spaces is minimized by using <Tab>s.
5413 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5414 set.
5415 NOTE: This option is set to 0 when 'compatible' is set.
5416
5417 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5418'splitbelow' 'sb' boolean (default off)
5419 global
5420 {not in Vi}
5421 {not available when compiled without the +windows
5422 feature}
5423 When on, splitting a window will put the new window below the current
5424 one. |:split|
5425
5426 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5427'splitright' 'spr' boolean (default off)
5428 global
5429 {not in Vi}
5430 {not available when compiled without the +vertsplit
5431 feature}
5432 When on, splitting a window will put the new window right of the
5433 current one. |:vsplit|
5434
5435 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5436'startofline' 'sol' boolean (default on)
5437 global
5438 {not in Vi}
5439 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005440 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005441 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005442 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443 with a linewise operator, with "%" with a count and to buffer changing
5444 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5445 only has a line number, e.g., ":25" or ":+".
5446 In case of buffer changing commands the cursor is placed at the column
5447 where it was the last time the buffer was edited.
5448 NOTE: This option is set when 'compatible' is set.
5449
5450 *'statusline'* *'stl'* *E540* *E541* *E542*
5451'statusline' 'stl' string (default empty)
5452 global
5453 {not in Vi}
5454 {not available when compiled without the |+statusline|
5455 feature}
5456 When nonempty, this option determines the content of the status line.
5457 Also see |status-line|.
5458
5459 The option consists of printf style '%' items interspersed with
5460 normal text. Each status line item is of the form:
5461 %-0{minwid}.{maxwid}{item}
5462 All fields except the {item} is optional. A single percent sign can
5463 be given as "%%". Up to 80 items can be specified.
5464
5465 Note that the only effect of 'ruler' when this option is set (and
5466 'laststatus' is 2) is controlling the output of |CTRL-G|.
5467
5468 field meaning ~
5469 - Left justify the item. The default is right justified
5470 when minwid is larger than the length of the item.
5471 0 Leading zeroes in numeric items. Overridden by '-'.
5472 minwid Minimum width of the item, padding as set by '-' & '0'.
5473 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005474 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005475 on the left for text items. Numeric items will be
5476 shifted down to maxwid-2 digits followed by '>'number
5477 where number is the amount of missing digits, much like
5478 an exponential notation.
5479 item A one letter code as described below.
5480
5481 Following is a description of the possible statusline items. The
5482 second character in "item" is the type:
5483 N for number
5484 S for string
5485 F for flags as described below
5486 - not applicable
5487
5488 item meaning ~
5489 f S Path to the file in the buffer, relative to current directory.
5490 F S Full path to the file in the buffer.
5491 t S File name (tail) of file in the buffer.
5492 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5493 M F Modified flag, text is ",+" or ",-".
5494 r F Readonly flag, text is " [RO]".
5495 R F Readonly flag, text is ",RO".
5496 h F Help buffer flag, text is " [help]".
5497 H F Help buffer flag, text is ",HLP".
5498 w F Preview window flag, text is " [Preview]".
5499 W F Preview window flag, text is ",PRV".
5500 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5501 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5502 {not available when compiled without |+autocmd| feature}
5503 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5504 being used: "<keymap>"
5505 n N Buffer number.
5506 b N Value of byte under cursor.
5507 B N As above, in hexadecimal.
5508 o N Byte number in file of byte under cursor, first byte is 1.
5509 Mnemonic: Offset from start of file (with one added)
5510 {not available when compiled without |+byte_offset| feature}
5511 O N As above, in hexadecimal.
5512 N N Printer page number. (Only works in the 'printheader' option.)
5513 l N Line number.
5514 L N Number of lines in buffer.
5515 c N Column number.
5516 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005517 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 p N Percentage through file in lines as in |CTRL-G|.
5519 P S Percentage through file of displayed window. This is like the
5520 percentage described for 'ruler'. Always 3 in length.
5521 a S Argument list status as in default title. ({current} of {max})
5522 Empty if the argument file count is zero or one.
5523 { NF Evaluate expression between '{' and '}' and substitute result.
5524 ( - Start of item group. Can be used for setting the width and
5525 alignment of a section. Must be followed by %) somewhere.
5526 ) - End of item group. No width fields allowed.
5527 < - Where to truncate line if too long. Default is at the start.
5528 No width fields allowed.
5529 = - Separation point between left and right aligned items.
5530 No width fields allowed.
5531 * - Set highlight group to User{N}, where {N} is taken from the
5532 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5533 The difference between User{N} and StatusLine will be applied
5534 to StatusLineNC for the statusline of non-current windows.
5535 The number N must be between 1 and 9. See |hl-User1..9|
5536
5537 Display of flags are controlled by the following heuristic:
5538 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005539 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 with a space it is assumed that it wants to separate itself from
5541 anything but other flags. That is: A leading comma is removed if the
5542 preceding character stems from plaintext. A leading space is removed
5543 if the preceding character stems from another active flag. This will
5544 make a nice display when flags are used like in the examples below.
5545
5546 When all items in a group becomes an empty string (ie. flags that are
5547 not set) and a minwid is not set for the group, the whole group will
5548 become empty. This will make a group like the following disappear
5549 completely from the statusline when none of the flags are set. >
5550 :set statusline=...%(\ [%M%R%H]%)...
5551<
5552 Beware that an expression is evaluated each and every time the status
5553 line is displayed. The current buffer and current window will be set
5554 temporarily to that of the window (and buffer) whose statusline is
5555 currently being drawn. The expression will evaluate in this context.
5556 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5557 real current buffer. The expression is evaluated in the |sandbox|.
5558
5559 If the statusline is not updated when you want it (e.g., after setting
5560 a variable that's used in an expression), you can force an update by
5561 setting an option without changing its value. Example: >
5562 :let &ro = &ro
5563
5564< A result of all digits is regarded a number for display purposes.
5565 Otherwise the result is taken as flag text and applied to the rules
5566 described above.
5567
5568 Watch out for errors in expressions. They may render Vim unusable !
5569 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5570 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5571
5572 Examples:
5573 Emulate standard status line with 'ruler' set >
5574 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5575< Similar, but add ASCII value of char under the cursor (like "ga") >
5576 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5577< Display byte count and byte value, modified flag in red. >
5578 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5579 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5580< Display a ,GZ flag if a compressed file is loaded >
5581 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5582< In the |:autocmd|'s: >
5583 :let b:gzflag = 1
5584< And: >
5585 :unlet b:gzflag
5586< And define this function: >
5587 :function VarExists(var, val)
5588 : if exists(a:var) | return a:val | else | return '' | endif
5589 :endfunction
5590<
5591 *'suffixes'* *'su'*
5592'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5593 global
5594 {not in Vi}
5595 Files with these suffixes get a lower priority when multiple files
5596 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005597 suffixes. Spaces after the comma are ignored. A dot is also seen as
5598 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 separator, precede it with a backslash (see |option-backslash| about
5600 including spaces and backslashes).
5601 See 'wildignore' for completely ignoring files.
5602 The use of |:set+=| and |:set-=| is preferred when adding or removing
5603 suffixes from the list. This avoids problems when a future version
5604 uses another default.
5605
5606 *'suffixesadd'* *'sua'*
5607'suffixesadd' 'sua' string (default "")
5608 local to buffer
5609 {not in Vi}
5610 {not available when compiled without the
5611 |+file_in_path| feature}
5612 Comma separated list of suffixes, which are used when searching for a
5613 file for the "gf", "[I", etc. commands. Example: >
5614 :set suffixesadd=.java
5615<
5616 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5617'swapfile' 'swf' boolean (default on)
5618 local to buffer
5619 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005620 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005621 swapfile is not wanted for a specific buffer. For example, with
5622 confidential information that even root must not be able to access.
5623 Careful: All text will be in memory:
5624 - Don't use this for big files.
5625 - Recovery will be impossible!
5626 A swapfile will only be present when |'updatecount'| is non-zero and
5627 'swapfile' is set.
5628 When 'swapfile' is reset, the swap file for the current buffer is
5629 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5630 non-zero, a swap file is immediately created.
5631 Also see |swap-file| and |'swapsync'|.
5632
5633 This option is used together with 'bufhidden' and 'buftype' to
5634 specify special kinds of buffers. See |special-buffers|.
5635
5636 *'swapsync'* *'sws'*
5637'swapsync' 'sws' string (default "fsync")
5638 global
5639 {not in Vi}
5640 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005641 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 When this option is empty parts of the swap file may be in memory and
5643 not written to disk. When the system crashes you may lose more work.
5644 On Unix the system does a sync now and then without Vim asking for it,
5645 so the disadvantage of setting this option off is small. On some
5646 systems the swap file will not be written at all. For a unix system
5647 setting it to "sync" will use the sync() call instead of the default
5648 fsync(), which may work better on some systems.
5649
5650 *'switchbuf'* *'swb'*
5651'switchbuf' 'swb' string (default "")
5652 global
5653 {not in Vi}
5654 This option controls the behavior when switching between buffers.
5655 Possible values (comma separated list):
5656 useopen If included, jump to the first open window that
5657 contains the specified buffer (if there is one).
5658 Otherwise: Do not examine other windows.
5659 This setting is checked with |quickfix| commands, when
5660 jumping to errors (":cc", ":cn", "cp", etc.). It is
5661 also used in all buffer related split commands, for
5662 example ":sbuffer", ":sbnext", or ":sbrewind".
5663 split If included, split the current window before loading
5664 a buffer. Otherwise: do not split, use current window.
5665 Supported in |quickfix| commands that display errors.
5666
5667 *'syntax'* *'syn'*
5668'syntax' 'syn' string (default empty)
5669 local to buffer
5670 {not in Vi}
5671 {not available when compiled without the |+syntax|
5672 feature}
5673 When this option is set, the syntax with this name is loaded, unless
5674 syntax highlighting has been switched off with ":syntax off".
5675 Otherwise this option does not always reflect the current syntax (the
5676 b:current_syntax variable does).
5677 This option is most useful in a modeline, for a file which syntax is
5678 not automatically recognized. Example, for in an IDL file: >
5679 /* vim: set syntax=idl : */
5680< To switch off syntax highlighting for the current file, use: >
5681 :set syntax=OFF
5682< To switch syntax highlighting on according to the current value of the
5683 'filetype' option: >
5684 :set syntax=ON
5685< What actually happens when setting the 'syntax' option is that the
5686 Syntax autocommand event is triggered with the value as argument.
5687 This option is not copied to another buffer, independent of the 's' or
5688 'S' flag in 'cpoptions'.
5689
5690 *'tabstop'* *'ts'*
5691'tabstop' 'ts' number (default 8)
5692 local to buffer
5693 Number of spaces that a <Tab> in the file counts for. Also see
5694 |:retab| command, and 'softtabstop' option.
5695
5696 Note: Setting 'tabstop' to any other value than 8 can make your file
5697 appear wrong in many places (e.g., when printing it).
5698
5699 There are four main ways to use tabs in Vim:
5700 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5701 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5702 will use a mix of tabs and spaces, but typing Tab and BS will
5703 behave like a tab appears every 4 (or 3) characters.
5704 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5705 'expandtab'. This way you will always insert spaces. The
5706 formatting will never be messed up when 'tabstop' is changed.
5707 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005708 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 works when using Vim to edit the file.
5710 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5711 'noexpandtab'. This should then work (for initial indents only)
5712 for any tabstop setting that people use. It might be nice to have
5713 tabs after the first non-blank inserted as spaces if you do this
5714 though. Otherwise aligned comments will be wrong when 'tabstop' is
5715 changed.
5716
5717 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5718'tagbsearch' 'tbs' boolean (default on)
5719 global
5720 {not in Vi}
5721 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005722 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723 searching makes searching for a tag a LOT faster, but a linear search
5724 will find more tags if the tags file wasn't properly sorted.
5725 Vim normally assumes that your tags files are sorted, or indicate that
5726 they are not sorted. Only when this is not the case does the
5727 'tagbsearch' option need to be switched off.
5728
5729 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005730 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 certain files, or retry all files with a linear search. When
5732 'tagbsearch' is off, only a linear search is done.
5733
5734 Linear searching is done anyway, for one file, when Vim finds a line
5735 at the start of the file indicating that it's not sorted: >
5736 !_TAG_FILE_SORTED 0 /some command/
5737< [The whitespace before and after the '0' must be a single <Tab>]
5738
5739 When a binary search was done and no match was found in any of the
5740 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5741 instead of a normal tag name, a retry is done with a linear search.
5742 Tags in unsorted tags files, and matches with different case will only
5743 be found in the retry.
5744
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005745 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 linear search can be avoided for the 'ignorecase' case. Use a value
5747 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5748 case-fold sorted with the -f switch to "sort" in most unices, as in
5749 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5750 5.3 or higher the -f or --fold-case-sort switch can be used for this
5751 as well. Note that case must be folded to uppercase for this to work.
5752
5753 When 'tagbsearch' is off, tags searching is slower when a full match
5754 exists, but faster when no full match exists. Tags in unsorted tags
5755 files may only be found with 'tagbsearch' off.
5756 When the tags file is not sorted, or sorted in a wrong way (not on
5757 ASCII byte value), 'tagbsearch' should be off, or the line given above
5758 must be included in the tags file.
5759 This option doesn't affect commands that find all matching tags (e.g.,
5760 command-line completion and ":help").
5761 {Vi: always uses binary search in some versions}
5762
5763 *'taglength'* *'tl'*
5764'taglength' 'tl' number (default 0)
5765 global
5766 If non-zero, tags are significant up to this number of characters.
5767
5768 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5769'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5770 global
5771 {not in Vi}
5772 If on and using a tag file in another directory, file names in that
5773 tag file are relative to the directory where the tag file is.
5774 NOTE: This option is set to the Vi default value when 'compatible' is
5775 set and to the Vim default value when 'compatible' is reset.
5776
5777 *'tags'* *'tag'* *E433*
5778'tags' 'tag' string (default "./tags,tags", when compiled with
5779 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5780 global or local to buffer |global-local|
5781 Filenames for the tag command, separated by spaces or commas. To
5782 include a space or comma in a file name, precede it with a backslash
5783 (see |option-backslash| about including spaces and backslashes).
5784 When a file name starts with "./", the '.' is replaced with the path
5785 of the current file. But only when the 'd' flag is not included in
5786 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5787 |tags-option|.
5788 "*", "**" and other wildcards can be used to search for tags files in
5789 a directory tree. See |file-searching|. {not available when compiled
5790 without the |+path_extra| feature}
5791 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5792 files are also supported. They are automatically recognized. The
5793 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5794 differences are ignored (MS-Windows). |emacs-tags|
5795 The use of |:set+=| and |:set-=| is preferred when adding or removing
5796 file names from the list. This avoids problems when a future version
5797 uses another default.
5798 {Vi: default is "tags /usr/lib/tags"}
5799
5800 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5801'tagstack' 'tgst' boolean (default on)
5802 global
5803 {not in all versions of Vi}
5804 When on, the |tagstack| is used normally. When off, a ":tag" or
5805 ":tselect" command with an argument will not push the tag onto the
5806 tagstack. A following ":tag" without an argument, a ":pop" command or
5807 any other command that uses the tagstack will use the unmodified
5808 tagstack, but does change the pointer to the active entry.
5809 Resetting this option is useful when using a ":tag" command in a
5810 mapping which should not change the tagstack.
5811
5812 *'term'* *E529* *E530* *E531*
5813'term' string (default is $TERM, if that fails:
5814 in the GUI: "builtin_gui"
5815 on Amiga: "amiga"
5816 on BeOS: "beos-ansi"
5817 on Mac: "mac-ansi"
5818 on MiNT: "vt52"
5819 on MS-DOS: "pcterm"
5820 on OS/2: "os2ansi"
5821 on Unix: "ansi"
5822 on VMS: "ansi"
5823 on Win 32: "win32")
5824 global
5825 Name of the terminal. Used for choosing the terminal control
5826 characters. Environment variables are expanded |:set_env|.
5827 For example: >
5828 :set term=$TERM
5829< See |termcap|.
5830
5831 *'termbidi'* *'tbidi'*
5832 *'notermbidi'* *'notbidi'*
5833'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5834 global
5835 {not in Vi}
5836 {only available when compiled with the |+arabic|
5837 feature}
5838 The terminal is in charge of Bi-directionality of text (as specified
5839 by Unicode). The terminal is also expected to do the required shaping
5840 that some languages (such as Arabic) require.
5841 Setting this option implies that 'rightleft' will not be set when
5842 'arabic' is set and the value of 'arabicshape' will be ignored.
5843 Note that setting 'termbidi' has the immediate effect that
5844 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5845 This option is reset when the GUI is started.
5846 For further details see |arabic.txt|.
5847
5848 *'termencoding'* *'tenc'*
5849'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
5850 Macintosh GUI: "macroman")
5851 global
5852 {only available when compiled with the |+multi_byte|
5853 feature}
5854 {not in Vi}
5855 Encoding used for the terminal. This specifies what character
5856 encoding the keyboard produces and the display will understand. For
5857 the GUI it only applies to the keyboard ('encoding' is used for the
5858 display).
5859 In the Win32 console version the default value is the console codepage
5860 when it differs from the ANSI codepage.
5861 *E617*
5862 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
5863 successfully initialized, 'termencoding' is forcibly set to "utf-8".
5864 Any attempts to set a different value will be rejected, and an error
5865 message is shown.
5866 For the Win32 GUI 'termencoding' is not used for typed characters,
5867 because the Win32 system always passes Unicode characters.
5868 When empty, the same encoding is used as for the 'encoding' option.
5869 This is the normal value.
5870 Not all combinations for 'termencoding' and 'encoding' are valid. See
5871 |encoding-table|.
5872 The value for this option must be supported by internal conversions or
5873 iconv(). When this is not possible no conversion will be done and you
5874 will probably experience problems with non-ASCII characters.
5875 Example: You are working with the locale set to euc-jp (Japanese) and
5876 want to edit a UTF-8 file: >
5877 :let &termencoding = &encoding
5878 :set encoding=utf-8
5879< You need to do this when your system has no locale support for UTF-8.
5880
5881 *'terse'* *'noterse'*
5882'terse' boolean (default off)
5883 global
5884 When set: Add 's' flag to 'shortmess' option (this makes the message
5885 for a search that hits the start or end of the file not being
5886 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
5887 shortens a lot of messages}
5888
5889 *'textauto'* *'ta'* *'notextauto'* *'nota'*
5890'textauto' 'ta' boolean (Vim default: on, Vi default: off)
5891 global
5892 {not in Vi}
5893 This option is obsolete. Use 'fileformats'.
5894 For backwards compatibility, when 'textauto' is set, 'fileformats' is
5895 set to the default value for the current system. When 'textauto' is
5896 reset, 'fileformats' is made empty.
5897 NOTE: This option is set to the Vi default value when 'compatible' is
5898 set and to the Vim default value when 'compatible' is reset.
5899
5900 *'textmode'* *'tx'* *'notextmode'* *'notx'*
5901'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
5902 others: default off)
5903 local to buffer
5904 {not in Vi}
5905 This option is obsolete. Use 'fileformat'.
5906 For backwards compatibility, when 'textmode' is set, 'fileformat' is
5907 set to "dos". When 'textmode' is reset, 'fileformat' is set to
5908 "unix".
5909
5910 *'textwidth'* *'tw'*
5911'textwidth' 'tw' number (default 0)
5912 local to buffer
5913 {not in Vi}
5914 Maximum width of text that is being inserted. A longer line will be
5915 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005916 this. 'textwidth' is set to 0 when the 'paste' option is set. When
5917 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 'formatoptions' and |ins-textwidth|.
5919 NOTE: This option is set to 0 when 'compatible' is set.
5920
5921 *'thesaurus'* *'tsr'*
5922'thesaurus' 'tsr' string (default "")
5923 global or local to buffer |global-local|
5924 {not in Vi}
5925 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005926 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 the file should contain words with similar meaning, separated by
5928 non-keyword characters (white space is preferred). Maximum line
5929 length is 510 bytes.
5930 To obtain a file to be used here, check out the wordlist FAQ at
5931 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005932 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 after a comma are ignored, otherwise spaces are included in the file
5934 name. See |option-backslash| about using backslashes.
5935 The use of |:set+=| and |:set-=| is preferred when adding or removing
5936 directories from the list. This avoids problems when a future version
5937 uses another default.
5938 Backticks cannot be used in this option for security reasons.
5939
5940 *'tildeop'* *'top'* *'notildeop'* *'notop'*
5941'tildeop' 'top' boolean (default off)
5942 global
5943 {not in Vi}
5944 When on: The tilde command "~" behaves like an operator.
5945 NOTE: This option is reset when 'compatible' is set.
5946
5947 *'timeout'* *'to'* *'notimeout'* *'noto'*
5948'timeout' 'to' boolean (default on)
5949 global
5950 *'ttimeout'* *'nottimeout'*
5951'ttimeout' boolean (default off)
5952 global
5953 {not in Vi}
5954 These two options together determine the behavior when part of a
5955 mapped key sequence or keyboard code has been received:
5956
5957 'timeout' 'ttimeout' action ~
5958 off off do not time out
5959 on on or off time out on :mappings and key codes
5960 off on time out on key codes
5961
5962 If both options are off, Vim will wait until either the complete
5963 mapping or key sequence has been received, or it is clear that there
5964 is no mapping or key sequence for the received characters. For
5965 example: if you have mapped "vl" and Vim has received 'v', the next
5966 character is needed to see if the 'v' is followed by an 'l'.
5967 When one of the options is on, Vim will wait for about 1 second for
5968 the next character to arrive. After that the already received
5969 characters are interpreted as single characters. The waiting time can
5970 be changed with the 'timeoutlen' option.
5971 On slow terminals or very busy systems timing out may cause
5972 malfunctioning cursor keys. If both options are off, Vim waits
5973 forever after an entered <Esc> if there are key codes that start
5974 with <Esc>. You will have to type <Esc> twice. If you do not have
5975 problems with key codes, but would like to have :mapped key
5976 sequences not timing out in 1 second, set the 'ttimeout' option and
5977 reset the 'timeout' option.
5978
5979 NOTE: 'ttimeout' is reset when 'compatible' is set.
5980
5981 *'timeoutlen'* *'tm'*
5982'timeoutlen' 'tm' number (default 1000)
5983 global
5984 {not in all versions of Vi}
5985 *'ttimeoutlen'* *'ttm'*
5986'ttimeoutlen' 'ttm' number (default -1)
5987 global
5988 {not in Vi}
5989 The time in milliseconds that is waited for a key code or mapped key
5990 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
5991 when part of a command has been typed.
5992 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
5993 different timeout value for key codes is desired set 'ttimeoutlen' to
5994 a non-negative number.
5995
5996 ttimeoutlen mapping delay key code delay ~
5997 < 0 'timeoutlen' 'timeoutlen'
5998 >= 0 'timeoutlen' 'ttimeoutlen'
5999
6000 The timeout only happens when the 'timeout' and 'ttimeout' options
6001 tell so. A useful setting would be >
6002 :set timeout timeoutlen=3000 ttimeoutlen=100
6003< (time out on mapping after three seconds, time out on key codes after
6004 a tenth of a second).
6005
6006 *'title'* *'notitle'*
6007'title' boolean (default off, on when title can be restored)
6008 global
6009 {not in Vi}
6010 {not available when compiled without the |+title|
6011 feature}
6012 When on, the title of the window will be set to the value of
6013 'titlestring' (if it is not empty), or to:
6014 filename [+=-] (path) - VIM
6015 Where:
6016 filename the name of the file being edited
6017 - indicates the file cannot be modified, 'ma' off
6018 + indicates the file was modified
6019 = indicates the file is read-only
6020 =+ indicates the file is read-only and modified
6021 (path) is the path of the file being edited
6022 - VIM the server name |v:servername| or "VIM"
6023 Only works if the terminal supports setting window titles
6024 (currently Amiga console, Win32 console, all GUI versions and
6025 terminals with a non- empty 't_ts' option - these are Unix xterm and
6026 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6027 *X11*
6028 When Vim was compiled with HAVE_X11 defined, the original title will
6029 be restored if possible. The output of ":version" will include "+X11"
6030 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6031 works for the icon name |'icon'|.
6032 But: When Vim was started with the |-X| argument, restoring the title
6033 will not work (except in the GUI).
6034 If the title cannot be restored, it is set to the value of 'titleold'.
6035 You might want to restore the title outside of Vim then.
6036 When using an xterm from a remote machine you can use this command:
6037 rsh machine_name xterm -display $DISPLAY &
6038 then the WINDOWID environment variable should be inherited and the
6039 title of the window should change back to what it should be after
6040 exiting Vim.
6041
6042 *'titlelen'*
6043'titlelen' number (default 85)
6044 global
6045 {not in Vi}
6046 {not available when compiled without the |+title|
6047 feature}
6048 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006049 title. When the title is longer, only the end of the path name is
6050 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 Using a percentage makes this adapt to the width of the window. But
6052 it won't work perfectly, because the actual number of characters
6053 available also depends on the font used and other things in the title
6054 bar. When 'titlelen' is zero the full path is used. Otherwise,
6055 values from 1 to 30000 percent can be used.
6056 'titlelen' is also used for the 'titlestring' option.
6057
6058 *'titleold'*
6059'titleold' string (default "Thanks for flying Vim")
6060 global
6061 {not in Vi}
6062 {only available when compiled with the |+title|
6063 feature}
6064 This option will be used for the window title when exiting Vim if the
6065 original title cannot be restored. Only happens if 'title' is on or
6066 'titlestring' is not empty.
6067 *'titlestring'*
6068'titlestring' string (default "")
6069 global
6070 {not in Vi}
6071 {not available when compiled without the |+title|
6072 feature}
6073 When this option is not empty, it will be used for the title of the
6074 window. This happens only when the 'title' option is on.
6075 Only works if the terminal supports setting window titles (currently
6076 Amiga console, Win32 console, all GUI versions and terminals with a
6077 non-empty 't_ts' option).
6078 When Vim was compiled with HAVE_X11 defined, the original title will
6079 be restored if possible |X11|.
6080 When this option contains printf-style '%' items, they will be
6081 expanded according to the rules used for 'statusline'.
6082 Example: >
6083 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6084 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6085< The value of 'titlelen' is used to align items in the middle or right
6086 of the available space.
6087 Some people prefer to have the file name first: >
6088 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6089< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006090 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 separating space only when needed.
6092 NOTE: Use of special characters in 'titlestring' may cause the display
6093 to be garbled (e.g., when it contains a CR or NL character).
6094 {not available when compiled without the |+statusline| feature}
6095
6096 *'toolbar'* *'tb'*
6097'toolbar' 'tb' string (default "icons,tooltips")
6098 global
6099 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6100 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006101 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 possible values are:
6103 icons Toolbar buttons are shown with icons.
6104 text Toolbar buttons shown with text.
6105 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006106 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006107 tooltips Tooltips are active for toolbar buttons.
6108 Tooltips refer to the popup help text which appears after the mouse
6109 cursor is placed over a toolbar button for a brief moment.
6110
6111 If you want the toolbar to be shown with icons as well as text, do the
6112 following: >
6113 :set tb=icons,text
6114< Motif and Athena cannot display icons and text at the same time. They
6115 will show icons if both are requested.
6116
6117 If none of the strings specified in 'toolbar' are valid or if
6118 'toolbar' is empty, this option is ignored. If you want to disable
6119 the toolbar, you need to set the 'guioptions' option. For example: >
6120 :set guioptions-=T
6121< Also see |gui-toolbar|.
6122
6123 *'toolbariconsize'* *'tbis'*
6124'toolbariconsize' 'tbis' string (default "small")
6125 global
6126 {not in Vi}
6127 {only in the GTK+ 2 GUI}
6128 Controls the size of toolbar icons. The possible values are:
6129 tiny Use tiny toolbar icons.
6130 small Use small toolbar icons (default).
6131 medium Use medium-sized toolbar icons.
6132 large Use large toolbar icons.
6133 The exact dimensions in pixels of the various icon sizes depend on
6134 the current theme. Common dimensions are large=32x32, medium=24x24,
6135 small=20x20 and tiny=16x16.
6136
6137 If 'toolbariconsize' is empty, the global default size as determined
6138 by user preferences or the current theme is used.
6139
6140 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6141'ttybuiltin' 'tbi' boolean (default on)
6142 global
6143 {not in Vi}
6144 When on, the builtin termcaps are searched before the external ones.
6145 When off the builtin termcaps are searched after the external ones.
6146 When this option is changed, you should set the 'term' option next for
6147 the change to take effect, for example: >
6148 :set notbi term=$TERM
6149< See also |termcap|.
6150 Rationale: The default for this option is "on", because the builtin
6151 termcap entries are generally better (many systems contain faulty
6152 xterm entries...).
6153
6154 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6155'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6156 sun-cmd, screen, rxvt, dtterm or
6157 iris-ansi; also on when running Vim in
6158 a DOS console)
6159 global
6160 {not in Vi}
6161 Indicates a fast terminal connection. More characters will be sent to
6162 the screen for redrawing, instead of using insert/delete line
6163 commands. Improves smoothness of redrawing when there are multiple
6164 windows and the terminal does not support a scrolling region.
6165 Also enables the extra writing of characters at the end of each screen
6166 line for lines that wrap. This helps when using copy/paste with the
6167 mouse in an xterm and other terminals.
6168
6169 *'ttymouse'* *'ttym'*
6170'ttymouse' 'ttym' string (default depends on 'term')
6171 global
6172 {not in Vi}
6173 {only in Unix and VMS, doesn't work in the GUI; not
6174 available when compiled without |+mouse|}
6175 Name of the terminal type for which mouse codes are to be recognized.
6176 Currently these three strings are valid:
6177 *xterm-mouse*
6178 xterm xterm-like mouse handling. The mouse generates
6179 "<Esc>[Mscr", where "scr" is three bytes:
6180 "s" = button state
6181 "c" = column plus 33
6182 "r" = row plus 33
6183 xterm2 Works like "xterm", but with the xterm reporting the
6184 mouse position while the mouse is dragged. This works
6185 much faster and more precise. Your xterm must at
6186 least at patchlevel 88 / XFree 3.3.3 for this to
6187 work. See below for how Vim detects this
6188 automatically.
6189 *netterm-mouse*
6190 netterm NetTerm mouse handling. The mouse generates
6191 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6192 for the row and column.
6193 *dec-mouse*
6194 dec DEC terminal mouse handling. The mouse generates a
6195 rather complex sequence, starting with "<Esc>[".
6196 *jsbterm-mouse*
6197 jsbterm JSB term mouse handling.
6198 *pterm-mouse*
6199 pterm QNX pterm mouse handling.
6200
6201 The mouse handling must be enabled at compile time |+mouse_xterm|
6202 |+mouse_dec| |+mouse_netterm|.
6203 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6204 recognized, if enabled at compile time. DEC terminal mouse codes
6205 are recognized if enabled at compile time, and 'ttymouse' is not
6206 "xterm" (because the xterm and dec mouse codes conflict).
6207 This option is automatically set to "xterm", when the 'term' option is
6208 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6209 or "xterm2" already. The main use of this option is to set it to
6210 "xterm", when the terminal name doesn't start with "xterm", but it can
6211 handle xterm mouse codes.
6212 The "xterm2" value will be set if the xterm version is reported to be
6213 95 of higher. This only works when compiled with the |+termresponse|
6214 feature and if |t_RV| is set to the escape sequence to request the
6215 xterm version number. Otherwise "xterm2" must be set explicitly.
6216 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6217 t_RV to an empty string: >
6218 :set t_RV=
6219<
6220 *'ttyscroll'* *'tsl'*
6221'ttyscroll' 'tsl' number (default 999)
6222 global
6223 Maximum number of lines to scroll the screen. If there are more lines
6224 to scroll the window is redrawn. For terminals where scrolling is
6225 very slow and redrawing is not slow this can be set to a small number,
6226 e.g., 3, to speed up displaying.
6227
6228 *'ttytype'* *'tty'*
6229'ttytype' 'tty' string (default from $TERM)
6230 global
6231 Alias for 'term', see above.
6232
6233 *'undolevels'* *'ul'*
6234'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6235 Win32 and OS/2)
6236 global
6237 {not in Vi}
6238 Maximum number of changes that can be undone. Since undo information
6239 is kept in memory, higher numbers will cause more memory to be used
6240 (nevertheless, a single change can use an unlimited amount of memory).
6241 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6242 itself: >
6243 set ul=0
6244< But you can also get Vi compatibility by including the 'u' flag in
6245 'cpoptions', and still be able to use CTRL-R to repeat undo.
6246 Set to a negative number for no undo at all: >
6247 set ul=-1
6248< This helps when you run out of memory for a single change.
6249 Also see |undo-two-ways|.
6250
6251 *'updatecount'* *'uc'*
6252'updatecount' 'uc' number (default: 200)
6253 global
6254 {not in Vi}
6255 After typing this many characters the swap file will be written to
6256 disk. When zero, no swap file will be created at all (see chapter on
6257 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6258 Vim with the "-n" option, see |startup|. When editing in readonly
6259 mode this option will be initialized to 10000.
6260 The swapfile can be disabled per buffer with |'swapfile'|.
6261 When 'updatecount' is set from zero to non-zero, swap files are
6262 created for all buffers that have 'swapfile' set. When 'updatecount'
6263 is set to zero, existing swap files are not deleted.
6264 Also see |'swapsync'|.
6265 This option has no meaning in buffers where |'buftype'| is "nofile"
6266 or "nowrite".
6267
6268 *'updatetime'* *'ut'*
6269'updatetime' 'ut' number (default 4000)
6270 global
6271 {not in Vi}
6272 If this many milliseconds nothing is typed the swap file will be
6273 written to disk (see |crash-recovery|). Also used for the
6274 |CursorHold| autocommand event.
6275
6276 *'verbose'* *'vbs'*
6277'verbose' 'vbs' number (default 0)
6278 global
6279 {not in Vi, although some versions have a boolean
6280 verbose option}
6281 When bigger than zero, Vim will give messages about what it is doing.
6282 Currently, these messages are given:
6283 >= 1 When the viminfo file is read or written.
6284 >= 2 When a file is ":source"'ed.
6285 >= 5 Every searched tags file.
6286 >= 8 Files for which a group of autocommands is executed.
6287 >= 9 Every executed autocommand.
6288 >= 12 Every executed function.
6289 >= 13 When an exception is thrown, caught, finished, or discarded.
6290 >= 14 Anything pending in a ":finally" clause.
6291 >= 15 Every executed Ex command (truncated at 200 characters).
6292
6293 This option can also be set with the "-V" argument. See |-V|.
6294 This option is also set by the |:verbose| command.
6295
6296 *'viewdir'* *'vdir'*
6297'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6298 "$VIM/vimfiles/view",
6299 for Unix: "~/.vim/view",
6300 for Macintosh: "$VIM:vimfiles:view"
6301 for VMS: "sys$login:vimfiles/view"
6302 for RiscOS: "Choices:vimfiles/view")
6303 global
6304 {not in Vi}
6305 {not available when compiled without the +mksession
6306 feature}
6307 Name of the directory where to store files for |:mkview|.
6308 This option cannot be set from a |modeline| or in the |sandbox|, for
6309 security reasons.
6310
6311 *'viewoptions'* *'vop'*
6312'viewoptions' 'vop' string (default: "folds,options,cursor")
6313 global
6314 {not in Vi}
6315 {not available when compiled without the +mksession
6316 feature}
6317 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006318 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 word save and restore ~
6320 cursor cursor position in file and in window
6321 folds manually created folds, opened/closed folds and local
6322 fold options
6323 options options and mappings local to a window or buffer (not
6324 global values for local options)
6325 slash backslashes in file names replaced with forward
6326 slashes
6327 unix with Unix end-of-line format (single <NL>), even when
6328 on Windows or DOS
6329
6330 "slash" and "unix" are useful on Windows when sharing view files
6331 with Unix. The Unix version of Vim cannot source dos format scripts,
6332 but the Windows version of Vim can source unix format scripts.
6333
6334 *'viminfo'* *'vi'* *E526* *E527* *E528*
6335'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6336 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6337 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6338 for others: '20,<50,s10,h)
6339 global
6340 {not in Vi}
6341 {not available when compiled without the |+viminfo|
6342 feature}
6343 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006344 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 separated list of parameters, each consisting of a single character
6346 identifying the particular parameter, followed by a number or string
6347 which specifies the value of that parameter. If a particular
6348 character is left out, then the default value is used for that
6349 parameter. The following is a list of the identifying characters and
6350 the effect of their value.
6351 CHAR VALUE ~
6352 ! When included, save and restore global variables that start
6353 with an uppercase letter, and don't contain a lowercase
6354 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
6355 and "_K_L_M" are not.
6356 " Maximum number of lines saved for each register. Old name of
6357 the '<' item, with the disadvantage that you need to put a
6358 backslash before the ", otherwise it will be recognized as the
6359 start of a comment!
6360 % When included, save and restore the buffer list. If Vim is
6361 started with a file name argument, the buffer list is not
6362 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006363 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 without a file name and buffers for help files are not written
6365 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006366 When followed by a number, the number specifies the maximum
6367 number of buffers that are stored. Without a number all
6368 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 ' Maximum number of previously edited files for which the marks
6370 are remembered. This parameter must always be included when
6371 'viminfo' is non-empty.
6372 Including this item also means that the |jumplist| and the
6373 |changelist| are stored in the viminfo file.
6374 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006375 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 patterns are also saved. When not included, the value of
6377 'history' is used.
6378 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 < Maximum number of lines saved for each register. If zero then
6381 registers are not saved. When not included, all lines are
6382 saved. '"' is the old name for this item.
6383 Also see the 's' item below: limit specified in Kbyte.
6384 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006385 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 c When included, convert the text in the viminfo file from the
6387 'encoding' used when writing the file to the current
6388 'encoding'. See |viminfo-encoding|.
6389 f Whether file marks need to be stored. If zero, file marks ('0
6390 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006391 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 cursor position (when exiting or when doing ":wviminfo").
6393 h Disable the effect of 'hlsearch' when loading the viminfo
6394 file. When not included, it depends on whether ":nohlsearch"
6395 has been used since the last search command.
6396 n Name of the viminfo file. The name must immediately follow
6397 the 'n'. Must be the last one! If the "-i" argument was
6398 given when starting Vim, that file name overrides the one
6399 given here with 'viminfo'. Environment variables are expanded
6400 when opening the file, not when setting the option.
6401 r Removable media. The argument is a string (up to the next
6402 ','). This parameter can be given several times. Each
6403 specifies the start of a path for which no marks will be
6404 stored. This is to avoid removable media. For MS-DOS you
6405 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6406 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6407 ignored. Maximum length of each 'r' argument is 50
6408 characters.
6409 s Maximum size of an item in Kbyte. If zero then registers are
6410 not saved. Currently only applies to registers. The default
6411 "s10" will exclude registers with more than 10 Kbyte of text.
6412 Also see the '<' item above: line count limit.
6413
6414 Example: >
6415 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6416<
6417 '50 Marks will be remembered for the last 50 files you
6418 edited.
6419 <1000 Contents of registers (up to 1000 lines each) will be
6420 remembered.
6421 s100 Registers with more than 100 Kbyte text are skipped.
6422 :0 Command-line history will not be saved.
6423 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6424 no / Since '/' is not specified, the default will be used,
6425 that is, save all of the search history, and also the
6426 previous search and substitute patterns.
6427 no % The buffer list will not be saved nor read back.
6428 no h 'hlsearch' highlighting will be restored.
6429
6430 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6431 load the contents of the file, this is not done automatically.
6432
6433 This option cannot be set from a |modeline| or in the |sandbox|, for
6434 security reasons.
6435
6436 *'virtualedit'* *'ve'*
6437'virtualedit' 've' string (default "")
6438 global
6439 {not in Vi}
6440 {not available when compiled without the
6441 |+virtualedit| feature}
6442 A comma separated list of these words:
6443 block Allow virtual editing in Visual block mode.
6444 insert Allow virtual editing in Insert mode.
6445 all Allow virtual editing in all modes.
6446 Virtual editing means that the cursor can be positioned where there is
6447 no actual character. This can be halfway into a Tab or beyond the end
6448 of the line. Useful for selecting a rectangle in Visual mode and
6449 editing a table.
6450
6451 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6452'visualbell' 'vb' boolean (default off)
6453 global
6454 {not in Vi}
6455 Use visual bell instead of beeping. The terminal code to display the
6456 visual bell is given with 't_vb'. When no beep or flash is wanted,
6457 use ":set vb t_vb=".
6458 Note: When the GUI starts, 't_vb' is reset to its default value. You
6459 might want to set it again in your |gvimrc|.
6460 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6461 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6462 where 40 is the time in msec.
6463 Does not work on the Amiga, you always get a screen flash.
6464 Also see 'errorbells'.
6465
6466 *'warn'* *'nowarn'*
6467'warn' boolean (default on)
6468 global
6469 Give a warning message when a shell command is used while the buffer
6470 has been changed.
6471
6472 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6473'weirdinvert' 'wiv' boolean (default off)
6474 global
6475 {not in Vi}
6476 This option has the same effect as the 't_xs' termcap option.
6477 It is provided for backwards compatibility with version 4.x.
6478 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6479 vice versa. Has no effect when the GUI is running.
6480
6481 *'whichwrap'* *'ww'*
6482'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6483 global
6484 {not in Vi}
6485 Allow specified keys that move the cursor left/right to move to the
6486 previous/next line when the cursor is on the first/last character in
6487 the line. Concatenate characters to allow this for these keys:
6488 char key mode ~
6489 b <BS> Normal and Visual
6490 s <Space> Normal and Visual
6491 h "h" Normal and Visual
6492 l "l" Normal and Visual
6493 < <Left> Normal and Visual
6494 > <Right> Normal and Visual
6495 ~ "~" Normal
6496 [ <Left> Insert and Replace
6497 ] <Right> Insert and Replace
6498 For example: >
6499 :set ww=<,>,[,]
6500< allows wrap only when cursor keys are used.
6501 When the movement keys are used in combination with a delete or change
6502 operator, the <EOL> also counts for a character. This makes "3h"
6503 different from "3dh" when the cursor crosses the end of a line. This
6504 is also true for "x" and "X", because they do the same as "dl" and
6505 "dh". If you use this, you may also want to use the mapping
6506 ":map <BS> X" to make backspace delete the character in front of the
6507 cursor.
6508 When 'l' is included, you get a side effect: "yl" on an empty line
6509 will include the <EOL>, so that "p" will insert a new line.
6510 NOTE: This option is set to the Vi default value when 'compatible' is
6511 set and to the Vim default value when 'compatible' is reset.
6512
6513 *'wildchar'* *'wc'*
6514'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6515 global
6516 {not in Vi}
6517 Character you have to type to start wildcard expansion in the
6518 command-line, as specified with 'wildmode'.
6519 The character is not recognized when used inside a macro. See
6520 'wildcharm' for that.
6521 Although 'wc' is a number option, you can set it to a special key: >
6522 :set wc=<Esc>
6523< NOTE: This option is set to the Vi default value when 'compatible' is
6524 set and to the Vim default value when 'compatible' is reset.
6525
6526 *'wildcharm'* *'wcm'*
6527'wildcharm' 'wcm' number (default: none (0))
6528 global
6529 {not in Vi}
6530 'wildcharm' works exactly like 'wildchar', except that it is
6531 recognized when used inside a macro. You can find "spare" command-line
6532 keys suitable for this option by looking at |ex-edit-index|. Normally
6533 you'll never actually type 'wildcharm', just use it in mappings that
6534 automatically invoke completion mode, e.g.: >
6535 :set wcm=<C-Z>
6536 :cmap ss so $vim/sessions/*.vim<C-Z>
6537< Then after typing :ss you can use CTRL-P & CTRL-N.
6538
6539 *'wildignore'* *'wig'*
6540'wildignore' 'wig' string (default "")
6541 global
6542 {not in Vi}
6543 {not available when compiled without the |+wildignore|
6544 feature}
6545 A list of file patterns. A file that matches with one of these
6546 patterns is ignored when completing file or directory names.
6547 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6548 Also see 'suffixes'.
6549 Example: >
6550 :set wildignore=*.o,*.obj
6551< The use of |:set+=| and |:set-=| is preferred when adding or removing
6552 a pattern from the list. This avoids problems when a future version
6553 uses another default.
6554
6555 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6556'wildmenu' 'wmnu' boolean (default off)
6557 global
6558 {not in Vi}
6559 {not available if compiled without the |+wildmenu|
6560 feature}
6561 When 'wildmenu' is on, command-line completion operates in an enhanced
6562 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6563 the possible matches are shown just above the command line, with the
6564 first match highlighted (overwriting the status line, if there is
6565 one). Keys that show the previous/next match, such as <Tab> or
6566 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6567 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6568 specified. "longest" and "list" do not start "wildmenu" mode.
6569 If there are more matches than can fit in the line, a ">" is shown on
6570 the right and/or a "<" is shown on the left. The status line scrolls
6571 as needed.
6572 The "wildmenu" mode is abandoned when a key is hit that is not used
6573 for selecting a completion.
6574 While the "wildmenu" is active the following keys have special
6575 meanings:
6576
6577 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6578 <Down> - in filename/menu name completion: move into a
6579 subdirectory or submenu.
6580 <CR> - in menu completion, when the cursor is just after a
6581 dot: move into a submenu.
6582 <Up> - in filename/menu name completion: move up into
6583 parent directory or parent menu.
6584
6585 This makes the menus accessible from the console |console-menus|.
6586
6587 If you prefer the <Left> and <Right> keys to move the cursor instead
6588 of selecting a different match, use this: >
6589 :cnoremap <Left> <Space><BS><Left>
6590 :cnoremap <Right> <Space><BS><Right>
6591<
6592 The "WildMenu" highlighting is used for displaying the current match
6593 |hl-WildMenu|.
6594
6595 *'wildmode'* *'wim'*
6596'wildmode' 'wim' string (Vim default: "full")
6597 global
6598 {not in Vi}
6599 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 part specifies what to do for each consecutive use of 'wildchar. The
6602 first part specifies the behavior for the first use of 'wildchar',
6603 The second part for the second use, etc.
6604 These are the possible values for each part:
6605 "" Complete only the first match.
6606 "full" Complete the next full match. After the last match,
6607 the original string is used and then the first match
6608 again.
6609 "longest" Complete till longest common string. If this doesn't
6610 result in a longer string, use the next part.
6611 "longest:full" Like "longest", but also start 'wildmenu' if it is
6612 enabled.
6613 "list" When more than one match, list all matches.
6614 "list:full" When more than one match, list all matches and
6615 complete first match.
6616 "list:longest" When more than one match, list all matches and
6617 complete till longest common string.
6618 When there is only a single match, it is fully completed in all cases.
6619
6620 Examples: >
6621 :set wildmode=full
6622< Complete first full match, next match, etc. (the default) >
6623 :set wildmode=longest,full
6624< Complete longest common string, then each full match >
6625 :set wildmode=list:full
6626< List all matches and complete each full match >
6627 :set wildmode=list,full
6628< List all matches without completing, then each full match >
6629 :set wildmode=longest,list
6630< Complete longest common string, then list alternatives.
6631
6632 *'winaltkeys'* *'wak'*
6633'winaltkeys' 'wak' string (default "menu")
6634 global
6635 {not in Vi}
6636 {only used in Win32, Motif, GTK and Photon GUI}
6637 Some GUI versions allow the access to menu entries by using the ALT
6638 key in combination with a character that appears underlined in the
6639 menu. This conflicts with the use of the ALT key for mappings and
6640 entering special characters. This option tells what to do:
6641 no Don't use ALT keys for menus. ALT key combinations can be
6642 mapped, but there is no automatic handling. This can then be
6643 done with the |:simalt| command.
6644 yes ALT key handling is done by the windowing system. ALT key
6645 combinations cannot be mapped.
6646 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 keys can be mapped.
6649 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6650 key is never used for the menu.
6651 In the Win32 version, the <F10> key is handled like this too, since
6652 Windows uses it to select a menu.
6653
6654 *'winheight'* *'wh'* *E591*
6655'winheight' 'wh' number (default 1)
6656 global
6657 {not in Vi}
6658 {not available when compiled without the +windows
6659 feature}
6660 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006661 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 current window is smaller, its size is increased, at the cost of the
6663 height of other windows. Set it to 999 to make the current window
6664 always fill the screen (although this has the drawback that ":all"
6665 will create only two windows). Set it to a small number for normal
6666 editing.
6667 Minimum value is 1.
6668 The height is not adjusted after one of the commands to change the
6669 height of the current window.
6670 'winheight' applies to the current window. Use 'winminheight' to set
6671 the minimal height for other windows.
6672
6673 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6674'winfixheight' 'wfh' boolean (default off)
6675 local to window
6676 {not in Vi}
6677 {not available when compiled without the +windows
6678 feature}
6679 Keep the window height when windows are opened or closed and
6680 'equalalways' is set. Set by default for the |preview-window| and
6681 |quickfix-window|.
6682 The height may be changed anyway when running out of room.
6683
6684 *'winminheight'* *'wmh'*
6685'winminheight' 'wmh' number (default 1)
6686 global
6687 {not in Vi}
6688 {not available when compiled without the +windows
6689 feature}
6690 The minimal height of a window, when it's not the current window.
6691 This is a hard minimum, windows will never become smaller.
6692 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6693 status bar) if necessary. They will return to at least one line when
6694 they become active (since the cursor has to have somewhere to go.)
6695 Use 'winheight' to set the minimal height of the current window.
6696 This option is only checked when making a window smaller. Don't use a
6697 large number, it will cause errors when opening more than a few
6698 windows. A value of 0 to 3 is reasonable.
6699
6700 *'winminwidth'* *'wmw'*
6701'winminwidth' 'wmw' number (default 1)
6702 global
6703 {not in Vi}
6704 {not available when compiled without the +vertsplit
6705 feature}
6706 The minimal width of a window, when it's not the current window.
6707 This is a hard minimum, windows will never become smaller.
6708 When set to zero, windows may be "squashed" to zero columns (i.e. just
6709 a vertical separator) if necessary. They will return to at least one
6710 line when they become active (since the cursor has to have somewhere
6711 to go.)
6712 Use 'winwidth' to set the minimal width of the current window.
6713 This option is only checked when making a window smaller. Don't use a
6714 large number, it will cause errors when opening more than a few
6715 windows. A value of 0 to 12 is reasonable.
6716
6717 *'winwidth'* *'wiw'* *E592*
6718'winwidth' 'wiw' number (default 20)
6719 global
6720 {not in Vi}
6721 {not available when compiled without the +vertsplit
6722 feature}
6723 Minimal number of columns for the current window. This is not a hard
6724 minimum, Vim will use fewer columns if there is not enough room. If
6725 the current window is smaller, its size is increased, at the cost of
6726 the width of other windows. Set it to 999 to make the current window
6727 always fill the screen. Set it to a small number for normal editing.
6728 The width is not adjusted after one of the commands to change the
6729 width of the current window.
6730 'winwidth' applies to the current window. Use 'winminwidth' to set
6731 the minimal width for other windows.
6732
6733 *'wrap'* *'nowrap'*
6734'wrap' boolean (default on)
6735 local to window
6736 {not in Vi}
6737 This option changes how text is displayed. It doesn't change the text
6738 in the buffer, see 'textwidth' for that.
6739 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006740 displaying continues on the next line. When off lines will not wrap
6741 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006742 moved to a part that is not shown, the screen will scroll
6743 horizontally.
6744 The line will be broken in the middle of a word if necessary. See
6745 'linebreak' to get the break at a word boundary.
6746 To make scrolling horizontally a bit more useful, try this: >
6747 :set sidescroll=5
6748 :set listchars+=precedes:<,extends:>
6749< See 'sidescroll', 'listchars' and |wrap-off|.
6750
6751 *'wrapmargin'* *'wm'*
6752'wrapmargin' 'wm' number (default 0)
6753 local to buffer
6754 Number of characters from the right window border where wrapping
6755 starts. When typing text beyond this limit, an <EOL> will be inserted
6756 and inserting continues on the next line.
6757 Options that add a margin, such as 'number' and 'foldcolumn', cause
6758 the text width to be further reduced. This is Vi compatible.
6759 When 'textwidth' is non-zero, this option is not used.
6760 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6761 and less usefully}
6762
6763 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6764'wrapscan' 'ws' boolean (default on) *E384* *E385*
6765 global
6766 Searches wrap around the end of the file.
6767
6768 *'write'* *'nowrite'*
6769'write' boolean (default on)
6770 global
6771 {not in Vi}
6772 Allows writing files. When not set, writing a file is not allowed.
6773 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006774 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 argument. Filtering text is still possible, even though this requires
6776 writing a temporary file.
6777
6778 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6779'writeany' 'wa' boolean (default off)
6780 global
6781 Allows writing to any file with no need for "!" override.
6782
6783 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6784'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6785 otherwise)
6786 global
6787 {not in Vi}
6788 Make a backup before overwriting a file. The backup is removed after
6789 the file was successfully written, unless the 'backup' option is
6790 also on. Reset this option if your file system is almost full. See
6791 |backup-table| for another explanation.
6792 When the 'backupskip' pattern matches, a backup is not made anyway.
6793 NOTE: This option is set to the default value when 'compatible' is
6794 set.
6795
6796 *'writedelay'* *'wd'*
6797'writedelay' 'wd' number (default 0)
6798 global
6799 {not in Vi}
6800 The number of microseconds to wait for each character sent to the
6801 screen. When non-zero, characters are sent to the terminal one by
6802 one. For MS-DOS pcterm this does not work. For debugging purposes.
6803
6804 vim:tw=78:ts=8:ft=help:norl: