blob: 769a45c707797381419aef8a35704203c7e761d9 [file] [log] [blame]
Bram Moolenaar009b2592004-10-24 19:18:58 +00001*options.txt* For Vim version 7.0aa. Last change: 2004 Oct 21
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.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000921 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 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.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002049 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 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 Moolenaar009b2592004-10-24 19:18:58 +00002190 splitting or closing a window. This also happens the moment the
2191 option is switched on. When off, splitting a window will reduce the
2192 size of the current window and leave the other windows the same. When
2193 closing a window the extra lines are given to the window next to it
2194 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002195 When mixing vertically and horizontally split windows, a minimal size
2196 is computed and some windows may be larger if there is room. The
2197 'eadirection' option tells in which direction the size is affected.
2198 Changing the height of a window can be avoided by setting
2199 'winfixheight'.
2200
2201 *'equalprg'* *'ep'*
2202'equalprg' 'ep' string (default "")
2203 global or local to buffer |global-local|
2204 {not in Vi}
2205 External program to use for "=" command. When this option is empty
2206 the internal formatting functions are used ('lisp', 'cindent' or
2207 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002208 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 about including spaces and backslashes.
2210 This option cannot be set from a |modeline| or in the |sandbox|, for
2211 security reasons.
2212
2213 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2214'errorbells' 'eb' boolean (default off)
2215 global
2216 Ring the bell (beep or screen flash) for error messages. This only
2217 makes a difference for error messages, the bell will be used always
2218 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002219 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 screen flash or do nothing.
2221
2222 *'errorfile'* *'ef'*
2223'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2224 others: "errors.err")
2225 global
2226 {not in Vi}
2227 {not available when compiled without the |+quickfix|
2228 feature}
2229 Name of the errorfile for the QuickFix mode (see |:cf|).
2230 When the "-q" command-line argument is used, 'errorfile' is set to the
2231 following argument. See |-q|.
2232 NOT used for the ":make" command. See 'makeef' for that.
2233 Environment variables are expanded |:set_env|.
2234 See |option-backslash| about including spaces and backslashes.
2235 This option cannot be set from a |modeline| or in the |sandbox|, for
2236 security reasons.
2237
2238 *'errorformat'* *'efm'*
2239'errorformat' 'efm' string (default is very long)
2240 global or local to buffer |global-local|
2241 {not in Vi}
2242 {not available when compiled without the |+quickfix|
2243 feature}
2244 Scanf-like description of the format for the lines in the error file
2245 (see |errorformat|).
2246
2247 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2248'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2249 global
2250 {not in Vi}
2251 Function keys that start with an <Esc> are recognized in Insert
2252 mode. When this option is off, the cursor and function keys cannot be
2253 used in Insert mode if they start with an <Esc>. The advantage of
2254 this is that the single <Esc> is recognized immediately, instead of
2255 after one second. Instead of resetting this option, you might want to
2256 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2257 when 'esckeys' is off, you can still map anything, but the cursor keys
2258 won't work by default.
2259 NOTE: This option is set to the Vi default value when 'compatible' is
2260 set and to the Vim default value when 'compatible' is reset.
2261
2262 *'eventignore'* *'ei'*
2263'eventignore' 'ei' string (default "")
2264 global
2265 {not in Vi}
2266 {not available when compiled without the |+autocmd|
2267 feature}
2268 A list of autocommand event names, which are to be ignored.
2269 When set to "all", all autocommand events are ignored, autocommands
2270 will not be executed.
2271 Otherwise this is a comma separated list of event names. Example: >
2272 :set ei=WinEnter,WinLeave
2273<
2274 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2275'expandtab' 'et' boolean (default off)
2276 local to buffer
2277 {not in Vi}
2278 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002279 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2281 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2282 NOTE: This option is reset when 'compatible' is set.
2283
2284 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2285'exrc' 'ex' boolean (default off)
2286 global
2287 {not in Vi}
2288 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2289 directory. If you switch this option on you should also consider
2290 setting the 'secure' option (see |initialization|). Using a local
2291 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2292 also see |.vimrc| and |gui-init|.
2293 This option cannot be set from a |modeline| or in the |sandbox|, for
2294 security reasons.
2295
2296 *'fileencoding'* *'fenc'* *E213*
2297'fileencoding' 'fenc' string (default: "")
2298 local to buffer
2299 {only available when compiled with the |+multi_byte|
2300 feature}
2301 {not in Vi}
2302 Sets the character encoding for the file of this buffer.
2303 When 'fileencoding' is different from 'encoding', conversion will be
2304 done when reading and writing the file.
2305 When 'fileencoding' is empty, the same value as 'encoding' will be
2306 used (no conversion when reading or writing a file).
2307 WARNING: Conversion can cause loss of information! When
2308 'encoding' is "utf-8" conversion is most likely done in a way
2309 that the reverse conversion results in the same text. When
2310 'encoding' is not "utf-8" some characters may be lost!
2311 See 'encoding' for the possible values. Additionally, values may be
2312 specified that can be handled by the converter, see
2313 |mbyte-conversion|.
2314 When reading a file 'fileencoding' will be set from 'fileencodings'.
2315 To read a file in a certain encoding it won't work by setting
2316 'fileencoding', use the |++enc| argument.
2317 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2318 When the option is set, the value is converted to lowercase. Thus
2319 you can set it with uppercase values too. '_' characters are
2320 replaced with '-'. If a name is recognized from the list for
2321 'encoding', it is replaced by the standard name. For example
2322 "ISO8859-2" becomes "iso-8859-2".
2323 When this option is set, after starting to edit a file, the 'modified'
2324 option is set, because the file would be different when written.
2325 If you do this in a modeline, you might want to set 'nomodified' to
2326 avoid this.
2327 This option can not be changed when 'modifiable' is off.
2328
2329 *'fe'*
2330 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002331 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 old short name was 'fe', which is no longer used.
2333
2334 *'fileencodings'* *'fencs'*
2335'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1"
2336 when 'encoding' is set to a Unicode value)
2337 global
2338 {only available when compiled with the |+multi_byte|
2339 feature}
2340 {not in Vi}
2341 This is a list of character encodings considered when starting to edit
2342 an existing file. When a file is read, Vim tries to use the first
2343 mentioned character encoding. If an error is detected, the next one
2344 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002345 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 an empty string, which means the value of 'encoding' is used.
2347 WARNING: Conversion can cause loss of information! When
2348 'encoding' is "utf-8" (or one of the other Unicode variants)
2349 conversion is most likely done in a way that the reverse
2350 conversion results in the same text. When 'encoding' is not
2351 "utf-8" special characters may be lost!
2352 For an empty file or a file with only ASCII characters most encodings
2353 will work and the first entry of 'fileencodings' will be used (except
2354 "ucs-bom", which requires the BOM to be present). If you prefer
2355 another encoding use an BufReadPost autocommand event to test if your
2356 preferred encoding is to be used. Example: >
2357 au BufReadPost * if search('\S', 'w') == 0 |
2358 \ set fenc=iso-2022-jp | endif
2359< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2360 non-blank characters.
2361 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2362 is always empty then. This means that a non-existing file may get a
2363 different encoding than an empty file.
2364 The special value "ucs-bom" can be used to check for a Unicode BOM
2365 (Byte Order Mark) at the start of the file. It must not be preceded
2366 by "utf-8" or another Unicode encoding for this to work properly.
2367 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2368 because Vim cannot detect an error, thus the encoding is always
2369 accepted.
2370 WRONG VALUES: WHAT'S WRONG:
2371 latin1,utf-8 "latin1" will always be used
2372 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2373 file
2374 cp1250,latin1 "cp1250" will always be used
2375 If 'fileencodings' is empty, 'fileencoding' is not modified.
2376 See 'fileencoding' for the possible values.
2377 Setting this option does not have an effect until the next time a file
2378 is read.
2379
2380 *'fileformat'* *'ff'*
2381'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2382 Unix default: "unix",
2383 Macintosh default: "mac")
2384 local to buffer
2385 {not in Vi}
2386 This gives the <EOL> of the current buffer, which is used for
2387 reading/writing the buffer from/to a file:
2388 dos <CR> <NL>
2389 unix <NL>
2390 mac <CR>
2391 When "dos" is used, CTRL-Z at the end of a file is ignored.
2392 See |file-formats| and |file-read|.
2393 For the character encoding of the file see 'fileencoding'.
2394 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2395 works like it was set to "unix'.
2396 This option is set automatically when starting to edit a file and
2397 'fileformats' is not empty and 'binary' is off.
2398 When this option is set, after starting to edit a file, the 'modified'
2399 option is set, because the file would be different when written.
2400 This option can not be changed when 'modifiable' is off.
2401 For backwards compatibility: When this option is set to "dos",
2402 'textmode' is set, otherwise 'textmode' is reset.
2403
2404 *'fileformats'* *'ffs'*
2405'fileformats' 'ffs' string (default:
2406 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2407 Vim Unix: "unix,dos",
2408 Vim Mac: "mac,unix,dos",
2409 Vi Cygwin: "unix,dos",
2410 Vi others: "")
2411 global
2412 {not in Vi}
2413 This gives the end-of-line (<EOL>) formats that will be tried when
2414 starting to edit a new buffer and when reading a file into an existing
2415 buffer:
2416 - When empty, the format defined with 'fileformat' will be used
2417 always. It is not set automatically.
2418 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002419 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 'fileformats' name will be used when a file is read into an existing
2421 buffer, no matter what 'fileformat' for that buffer is set to.
2422 - When more than one name is present, separated by commas, automatic
2423 <EOL> detection will be done when reading a file. When starting to
2424 edit a file, a check is done for the <EOL>:
2425 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2426 'fileformat' is set to "dos".
2427 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 preceding <CR>, "unix" is preferred over "dos".
2430 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2431 This means that "mac" is only chosen when "unix" is not present,
2432 or when no <NL> is found in the file, and when "dos" is not
2433 present, or no <CR><NL> is present in the file.
2434 Also if "unix" was first chosen, but the first <CR> is before
2435 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2436 the file, then 'fileformat' is set to "mac".
2437 4. If 'fileformat' is still not set, the first name from
2438 'fileformats' is used.
2439 When reading a file into an existing buffer, the same is done, but
2440 this happens like 'fileformat' has been set appropriately for that
2441 file only, the option is not changed.
2442 When 'binary' is set, the value of 'fileformats' is not used.
2443
2444 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2445 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2446 done:
2447 - When 'fileformats' is empty, there is no automatic detection. Dos
2448 format will be used.
2449 - When 'fileformats' is set to one or more names, automatic detection
2450 is done. This is based on the first <NL> in the file: If there is a
2451 <CR> in front of it, Dos format is used, otherwise Unix format is
2452 used.
2453 Also see |file-formats|.
2454 For backwards compatibility: When this option is set to an empty
2455 string or one format (no comma is included), 'textauto' is reset,
2456 otherwise 'textauto' is set.
2457 NOTE: This option is set to the Vi default value when 'compatible' is
2458 set and to the Vim default value when 'compatible' is reset.
2459
2460 *'filetype'* *'ft'*
2461'filetype' 'ft' string (default: "")
2462 local to buffer
2463 {not in Vi}
2464 {not available when compiled without the |+autocmd|
2465 feature}
2466 When this option is set, the FileType autocommand event is triggered.
2467 All autocommands that match with the value of this option will be
2468 executed. Thus the value of 'filetype' is used in place of the file
2469 name.
2470 Otherwise this option does not always reflect the current file type.
2471 This option is normally set when the file type is detected. To enable
2472 this use the ":filetype on" command. |:filetype|
2473 Setting this option to a different value is most useful in a modeline,
2474 for a file for which the file type is not automatically recognized.
2475 Example, for in an IDL file: >
2476 /* vim: set filetype=idl : */
2477< |FileType| |filetypes|
2478 Do not confuse this option with 'osfiletype', which is for the file
2479 type that is actually stored with the file.
2480 This option is not copied to another buffer, independent of the 's' or
2481 'S' flag in 'cpoptions'.
2482
2483 *'fillchars'* *'fcs'*
2484'fillchars' 'fcs' string (default "vert:|,fold:-")
2485 global
2486 {not in Vi}
2487 {not available when compiled without the |+windows|
2488 and |+folding| features}
2489 Characters to fill the statuslines and vertical separators.
2490 It is a comma separated list of items:
2491
2492 item default Used for ~
2493 stl:c ' ' or '^' statusline of the current window
2494 stlnc:c ' ' or '-' statusline of the non-current windows
2495 vert:c '|' vertical separators |:vsplit|
2496 fold:c '-' filling 'foldtext'
2497 diff:c '-' deleted lines of the 'diff' option
2498
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002499 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 "stlnc" the space will be used when there is highlighting, '^' or '-'
2501 otherwise.
2502
2503 Example: >
2504 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2505< This is similar to the default, except that these characters will also
2506 be used when there is highlighting.
2507
2508 The highlighting used for these items:
2509 item highlight group ~
2510 stl:c StatusLine |hl-StatusLine|
2511 stlnc:c StatusLineNC |hl-StatusLineNC|
2512 vert:c VertSplit |hl-VertSplit|
2513 fold:c Folded |hl-Folded|
2514 diff:c DiffDelete |hl-DiffDelete|
2515
2516 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2517'fkmap' 'fk' boolean (default off) *E198*
2518 global
2519 {not in Vi}
2520 {only available when compiled with the |+rightleft|
2521 feature}
2522 When on, the keyboard is mapped for the Farsi character set.
2523 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525
2526 *'foldclose'* *'fcl'*
2527'foldclose' 'fcl' string (default "")
2528 global
2529 {not in Vi}
2530 {not available when compiled without the |+folding|
2531 feature}
2532 When set to "all", a fold is closed when the cursor isn't in it and
2533 its level is higher than 'foldlevel'. Useful if you want folds to
2534 automatically close when moving out of them.
2535
2536 *'foldcolumn'* *'fdc'*
2537'foldcolumn' 'fdc' number (default 0)
2538 local to window
2539 {not in Vi}
2540 {not available when compiled without the |+folding|
2541 feature}
2542 When non-zero, a column with the specified width is shown at the side
2543 of the window which indicates open and closed folds. The maximum
2544 value is 12.
2545 See |folding|.
2546
2547 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2548'foldenable' 'fen' boolean (default on)
2549 local to window
2550 {not in Vi}
2551 {not available when compiled without the |+folding|
2552 feature}
2553 When off, all folds are open. This option can be used to quickly
2554 switch between showing all text unfolded and viewing the text with
2555 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002556 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 'foldenable' is off.
2558 This option is set by commands that create a new fold or close a fold.
2559 See |folding|.
2560
2561 *'foldexpr'* *'fde'*
2562'foldexpr' 'fde' string (default: "0")
2563 local to window
2564 {not in Vi}
2565 {not available when compiled without the |+folding|
2566 or |+eval| feature}
2567 The expression used for when 'foldmethod' is "expr". It is evaluated
2568 for each line to obtain its fold level. See |fold-expr|. Also see
2569 |eval-sandbox|.
2570
2571 *'foldignore'* *'fdi'*
2572'foldignore' 'fdi' string (default: "#")
2573 local to window
2574 {not in Vi}
2575 {not available when compiled without the |+folding|
2576 feature}
2577 Used only when 'foldmethod' is "indent". Lines starting with
2578 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002579 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 The default "#" works well for C programs. See |fold-indent|.
2581
2582 *'foldlevel'* *'fdl'*
2583'foldlevel' 'fdl' number (default: 0)
2584 local to window
2585 {not in Vi}
2586 {not available when compiled without the |+folding|
2587 feature}
2588 Sets the fold level: Folds with a higher level will be closed.
2589 Setting this option to zero will close all folds. Higher numbers will
2590 close fewer folds.
2591 This option is set by commands like |zm|, |zM| and |zR|.
2592 See |fold-foldlevel|.
2593
2594 *'foldlevelstart'* *'fdls'*
2595'foldlevelstart' 'fdls' number (default: -1)
2596 global
2597 {not in Vi}
2598 {not available when compiled without the |+folding|
2599 feature}
2600 Sets 'foldlevel' when starting to edit another buffer in a window.
2601 Useful to always start editing with all folds closed (value zero),
2602 some folds closed (one) or no folds closed (99).
2603 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 ignores this option and closes all folds.
2606 It is also done before BufReadPre autocommands, to allow an autocmd to
2607 overrule the 'foldlevel' value for specific files.
2608 When the value is negative, it is not used.
2609
2610 *'foldmarker'* *'fmr'* *E536*
2611'foldmarker' 'fmr' string (default: "{{{,}}}")
2612 local to window
2613 {not in Vi}
2614 {not available when compiled without the |+folding|
2615 feature}
2616 The start and end marker used when 'foldmethod' is "marker". There
2617 must be one comma, which separates the start and end marker. The
2618 marker is a literal string (a regular expression would be too slow).
2619 See |fold-marker|.
2620
2621 *'foldmethod'* *'fdm'*
2622'foldmethod' 'fdm' string (default: "manual")
2623 local to window
2624 {not in Vi}
2625 {not available when compiled without the |+folding|
2626 feature}
2627 The kind of folding used for the current window. Possible values:
2628 |fold-manual| manual Folds are created manually.
2629 |fold-indent| indent Lines with equal indent form a fold.
2630 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2631 |fold-marker| marker Markers are used to specify folds.
2632 |fold-syntax| syntax Syntax highlighting items specify folds.
2633 |fold-diff| diff Fold text that is not changed.
2634
2635 *'foldminlines'* *'fml'*
2636'foldminlines' 'fml' number (default: 1)
2637 local to window
2638 {not in Vi}
2639 {not available when compiled without the |+folding|
2640 feature}
2641 Sets the minimum number of screen lines for a fold to be displayed
2642 closed. Also for manually closed folds.
2643 Note that this only has an effect of what is displayed. After using
2644 "zc" to close a fold, which is displayed open because it's smaller
2645 than 'foldminlines', a following "zc" may close a containing fold.
2646
2647 *'foldnestmax'* *'fdn'*
2648'foldnestmax' 'fdn' number (default: 20)
2649 local to window
2650 {not in Vi}
2651 {not available when compiled without the |+folding|
2652 feature}
2653 Sets the maximum nesting of folds for the "indent" and "syntax"
2654 methods. This avoids that too many folds will be created. Using more
2655 than 20 doesn't work, because the internal limit is 20.
2656
2657 *'foldopen'* *'fdo'*
2658'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2659 search,tag,undo")
2660 global
2661 {not in Vi}
2662 {not available when compiled without the |+folding|
2663 feature}
2664 Specifies for which type of commands folds will be opened, if the
2665 command moves the cursor into a closed fold. It is a comma separated
2666 list of items.
2667 item commands ~
2668 all any
2669 block "(", "{", "[[", "[{", etc.
2670 hor horizontal movements: "l", "w", "fx", etc.
2671 insert any command in Insert mode
2672 jump far jumps: "G", "gg", etc.
2673 mark jumping to a mark: "'m", CTRL-O, etc.
2674 percent "%"
2675 quickfix ":cn", ":crew", ":make", etc.
2676 search search for a pattern: "/", "n", "*", "gd", etc.
2677 (not for a search pattern in a ":" command)
2678 tag jumping to a tag: ":ta", CTRL-T, etc.
2679 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002680 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 the |zv| command to the mapping to get the same effect.
2682 When a movement command is used for an operator (e.g., "dl" or "y%")
2683 this option is not used. This means the operator will include the
2684 whole closed fold.
2685 Note that vertical movements are not here, because it would make it
2686 very difficult to move onto a closed fold.
2687 In insert mode the folds containing the cursor will always be open
2688 when text is inserted.
2689 To close folds you can re-apply 'foldlevel' with the |zx| command or
2690 set the 'foldclose' option to "all".
2691
2692 *'foldtext'* *'fdt'*
2693'foldtext' 'fdt' string (default: "foldtext()")
2694 local to window
2695 {not in Vi}
2696 {not available when compiled without the |+folding|
2697 feature}
2698 An expression which is used to specify the text displayed for a closed
2699 fold. See |fold-foldtext|.
2700
2701 *'formatoptions'* *'fo'*
2702'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2703 local to buffer
2704 {not in Vi}
2705 This is a sequence of letters which describes how automatic
2706 formatting is to be done. See |fo-table|. When the 'paste' option is
2707 on, no formatting is done (like 'formatoptions' is empty). Commas can
2708 be inserted for readability.
2709 To avoid problems with flags that are added in the future, use the
2710 "+=" and "-=" feature of ":set" |add-option-flags|.
2711 NOTE: This option is set to the Vi default value when 'compatible' is
2712 set and to the Vim default value when 'compatible' is reset.
2713
2714 *'formatprg'* *'fp'*
2715'formatprg' 'fp' string (default "")
2716 global
2717 {not in Vi}
2718 The name of an external program that will be used to format the lines
2719 selected with the "gq" command. The program must take the input on
2720 stdin and produce the output on stdout. The Unix program "fmt" is
2721 such a program. If this option is an empty string, the internal
2722 format function will be used |C-indenting|. Environment variables are
2723 expanded |:set_env|. See |option-backslash| about including spaces
2724 and backslashes.
2725 This option cannot be set from a |modeline| or in the |sandbox|, for
2726 security reasons.
2727
2728 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2729'gdefault' 'gd' boolean (default off)
2730 global
2731 {not in Vi}
2732 When on, the ":substitute" flag 'g' is default on. This means that
2733 all matches in a line are substituted instead of one. When a 'g' flag
2734 is given to a ":substitute" command, this will toggle the substitution
2735 of all or one match. See |complex-change|.
2736
2737 command 'gdefault' on 'gdefault' off ~
2738 :s/// subst. all subst. one
2739 :s///g subst. one subst. all
2740 :s///gg subst. all subst. one
2741
2742 NOTE: This option is reset when 'compatible' is set.
2743
2744 *'grepformat'* *'gfm'*
2745'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2746 global
2747 {not in Vi}
2748 Format to recognize for the ":grep" command output.
2749 This is a scanf-like string that uses the same format as the
2750 'errorformat' option: see |errorformat|.
2751
2752 *'grepprg'* *'gp'*
2753'grepprg' 'gp' string (default "grep -n ",
2754 Unix: "grep -n $* /dev/null",
2755 Win32: "findstr /n" or "grep -n",
2756 VMS: "SEARCH/NUMBERS ")
2757 global or local to buffer |global-local|
2758 {not in Vi}
2759 Program to use for the ":grep" command. This option may contain '%'
2760 and '#' characters, which are expanded like when used in a command-
2761 line. The placeholder "$*" is allowed to specify where the arguments
2762 will be included. Environment variables are expanded |:set_env|. See
2763 |option-backslash| about including spaces and backslashes.
2764 When your "grep" accepts the "-H" argument, use this to make ":grep"
2765 also work well with a single file: >
2766 :set grepprg=grep\ -nH
2767< See also the section |:make_makeprg|, since most of the comments there
2768 apply equally to 'grepprg'.
2769 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2770 otherwise it's "grep -n".
2771 This option cannot be set from a |modeline| or in the |sandbox|, for
2772 security reasons.
2773
2774 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2775'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2776 ve:ver35-Cursor,
2777 o:hor50-Cursor,
2778 i-ci:ver25-Cursor/lCursor,
2779 r-cr:hor20-Cursor/lCursor,
2780 sm:block-Cursor
2781 -blinkwait175-blinkoff150-blinkon175",
2782 for MS-DOS and Win32 console:
2783 "n-v-c:block,o:hor50,i-ci:hor15,
2784 r-cr:hor30,sm:block")
2785 global
2786 {not in Vi}
2787 {only available when compiled with GUI enabled, and
2788 for MS-DOS and Win32 console}
2789 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002790 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 the height of the cursor can be changed. This can be done by
2792 specifying a block cursor, or a percentage for a vertical or
2793 horizontal cursor.
2794
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002795 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 mode-list and an argument-list:
2797 mode-list:argument-list,mode-list:argument-list,..
2798 The mode-list is a dash separated list of these modes:
2799 n Normal mode
2800 v Visual mode
2801 ve Visual mode with 'selection' "exclusive" (same as 'v',
2802 if not specified)
2803 o Operator-pending mode
2804 i Insert mode
2805 r Replace mode
2806 c Command-line Normal (append) mode
2807 ci Command-line Insert mode
2808 cr Command-line Replace mode
2809 sm showmatch in Insert mode
2810 a all modes
2811 The argument-list is a dash separated list of these arguments:
2812 hor{N} horizontal bar, {N} percent of the character height
2813 ver{N} vertical bar, {N} percent of the character width
2814 block block cursor, fills the whole character
2815 [only one of the above three should be present]
2816 blinkwait{N} *cursor-blinking*
2817 blinkon{N}
2818 blinkoff{N}
2819 blink times for cursor: blinkwait is the delay before
2820 the cursor starts blinking, blinkon is the time that
2821 the cursor is shown and blinkoff is the time that the
2822 cursor is not shown. The times are in msec. When one
2823 of the numbers is zero, there is no blinking. The
2824 default is: "blinkwait700-blinkon400-blinkoff250".
2825 These numbers are used for a missing entry. This
2826 means that blinking is enabled by default. To switch
2827 blinking off you can use "blinkon0". The cursor only
2828 blinks when Vim is waiting for input, not while
2829 executing a command.
2830 To make the cursor blink in an xterm, see
2831 |xterm-blink|.
2832 {group-name}
2833 a highlight group name, that sets the color and font
2834 for the cursor
2835 {group-name}/{group-name}
2836 Two highlight group names, the first is used when
2837 no language mappings are used, the other when they
2838 are. |language-mapping|
2839
2840 Examples of parts:
2841 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2842 block cursor with colors from the "nCursor"
2843 highlight group
2844 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2845 In Insert and Command-line Insert mode, use a
2846 30% vertical bar cursor with colors from the
2847 "iCursor" highlight group. Blink a bit
2848 faster.
2849
2850 The 'a' mode is different. It will set the given argument-list for
2851 all modes. It does not reset anything to defaults. This can be used
2852 to do a common setting for all modes. For example, to switch off
2853 blinking: "a:blinkon0"
2854
2855 Examples of cursor highlighting: >
2856 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2857 :highlight Cursor gui=NONE guifg=bg guibg=fg
2858<
2859 *'guifont'* *'gfn'*
2860 *E235* *E596* *E610* *E611*
2861'guifont' 'gfn' string (default "")
2862 global
2863 {not in Vi}
2864 {only available when compiled with GUI enabled}
2865 This is a list of fonts which will be used for the GUI version of Vim.
2866 In its simplest form the value is just one font name. When
2867 the font cannot be found you will get an error message. To try other
2868 font names a list can be specified, font names separated with commas.
2869 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002870
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002872
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 Spaces after a comma are ignored. To include a comma in a font name
2874 precede it with a backslash. Setting an option requires an extra
2875 backslash before a space and a backslash. See also
2876 |option-backslash|. For example: >
2877 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002878< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002880
2881 If none of the fonts can be loaded, Vim will keep the current setting.
2882 If an empty font list is given, Vim will try using other resource
2883 settings (for X, it will use the Vim.font resource), and finally it
2884 will try some builtin default which should always be there ("7x13" in
2885 the case of X). The font names given should be "normal" fonts. Vim
2886 will try to find the related bold and italic fonts.
2887
2888 For Win32, GTK and Photon only: >
2889 :set guifont=*
2890< will bring up a font requester, where you can pick the font you want.
2891
2892 The font name depends on the GUI used. See |setting-guifont| for a
2893 way to set 'guifont' for various systems.
2894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 For the GTK+ 2 GUI the font name looks like this: >
2896 :set guifont=Andale\ Mono\ 11
2897< That's all. XLFDs are no longer accepted.
2898 *E236*
2899 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00002900 width). An exception is GTK 2: all fonts are accepted, but
2901 mono-spaced fonts look best.
2902
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 To preview a font on X11, you might be able to use the "xfontsel"
2904 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00002905
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 For the Win32 GUI *E244* *E245*
2907 - takes these options in the font name:
2908 hXX - height is XX (points, can be floating-point)
2909 wXX - width is XX (points, can be floating-point)
2910 b - bold
2911 i - italic
2912 u - underline
2913 s - strikeout
2914 cXX - character set XX. valid charsets are: ANSI, ARABIC,
2915 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2916 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2917 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002918 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919
2920 Use a ':' to separate the options.
2921 - A '_' can be used in the place of a space, so you don't need to use
2922 backslashes to escape the spaces.
2923 - Examples: >
2924 :set guifont=courier_new:h12:w5:b:cRUSSIAN
2925 :set guifont=Andale_Mono:h7.5:w4.5
2926< See also |font-sizes|.
2927
2928 *'guifontset'* *'gfs'*
2929 *E250* *E252* *E234* *E597* *E598*
2930'guifontset' 'gfs' string (default "")
2931 global
2932 {not in Vi}
2933 {only available when compiled with GUI enabled and
2934 with the |+xfontset| feature}
2935 {not available in the GTK+ 2 GUI}
2936 When not empty, specifies two (or more) fonts to be used. The first
2937 one for normal English, the second one for your special language. See
2938 |xfontset|.
2939 Setting this option also means that all font names will be handled as
2940 a fontset name. Also the ones used for the "font" argument of the
2941 |:highlight| command.
2942 The fonts must match with the current locale. If fonts for the
2943 character sets that the current locale uses are not included, setting
2944 'guifontset' will fail.
2945 Note the difference between 'guifont' and 'guifontset': In 'guifont'
2946 the comma-separated names are alternative names, one of which will be
2947 used. In 'guifontset' the whole string is one fontset name,
2948 including the commas. It is not possible to specify alternative
2949 fontset names.
2950 This example works on many X11 systems: >
2951 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
2952<
2953 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
2954'guifontwide' 'gfw' string (default "")
2955 global
2956 {not in Vi}
2957 {only available when compiled with GUI enabled}
2958 When not empty, specifies a comma-separated list of fonts to be used
2959 for double-width characters. The first font that can be loaded is
2960 used.
2961 Note: The size of these fonts must be exactly twice as wide as the one
2962 specified with 'guifont' and the same height.
2963
2964 All GUI versions but GTK+ 2:
2965
2966 'guifontwide' is only used when 'encoding' is set to "utf-8" and
2967 'guifontset' is empty or invalid.
2968 When 'guifont' is set and a valid font is found in it and
2969 'guifontwide' is empty Vim will attempt to find a matching
2970 double-width font and set 'guifontwide' to it.
2971
2972 GTK+ 2 GUI only: *guifontwide_gtk2*
2973
2974 If set and valid, 'guifontwide' is always used for double width
2975 characters, even if 'encoding' is not set to "utf-8".
2976 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 font for characters not available in 'guifont'. Thus you do not need
2979 to set 'guifontwide' at all unless you want to override the choice
2980 made by Pango/Xft.
2981
2982 *'guiheadroom'* *'ghr'*
2983'guiheadroom' 'ghr' number (default 50)
2984 global
2985 {not in Vi} {only for GTK and X11 GUI}
2986 The number of pixels subtracted from the screen height when fitting
2987 the GUI window on the screen. Set this before the GUI is started,
2988 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002989 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 lines will be left for window decorations and other items on the
2991 screen. Set it to a negative value to allow windows taller than the
2992 screen.
2993
2994 *'guioptions'* *'go'*
2995'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
2996 "agimrLtT" (GTK, Motif and Athena)
2997 global
2998 {not in Vi}
2999 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003000 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 sequence of letters which describes what components and options of the
3002 GUI should be used.
3003 To avoid problems with flags that are added in the future, use the
3004 "+=" and "-=" feature of ":set" |add-option-flags|.
3005
3006 Valid letters are as follows:
3007 *guioptions_a*
3008 'a' Autoselect: If present, then whenever VISUAL mode is started,
3009 or the Visual area extended, Vim tries to become the owner of
3010 the windowing system's global selection. This means that the
3011 Visually highlighted text is available for pasting into other
3012 applications as well as into Vim itself. When the Visual mode
3013 ends, possibly due to an operation on the text, or when an
3014 application wants to paste the selection, the highlighted text
3015 is automatically yanked into the "* selection register.
3016 Thus the selection is still available for pasting into other
3017 applications after the VISUAL mode has ended.
3018 If not present, then Vim won't become the owner of the
3019 windowing system's global selection unless explicitly told to
3020 by a yank or delete operation for the "* register.
3021 The same applies to the modeless selection.
3022
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 applies to the modeless selection.
3025
3026 'guioptions' autoselect Visual autoselect modeless ~
3027 "" - -
3028 "a" yes yes
3029 "A" - yes
3030 "aA" yes yes
3031
3032 'c' Use console dialogs instead of popup dialogs for simple
3033 choices.
3034
3035 'f' Foreground: Don't use fork() to detach the GUI from the shell
3036 where it was started. Use this for programs that wait for the
3037 editor to finish (e.g., an e-mail program). Alternatively you
3038 can use "gvim -f" or ":gui -f" to start the GUI in the
3039 foreground. |gui-fork|
3040 Note: Set this option in the vimrc file. The forking may have
3041 happened already when the gvimrc file is read.
3042
3043 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3044 corner of the window. It's black&white on non-GTK, because of
3045 limitations of X11. For a color icon, see |X11-icon|.
3046
3047 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003048 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 that this flag must be added in the .vimrc file, before
3050 switching on syntax or filetype recognition (when the .gvimrc
3051 file is sourced the system menu has already been loaded; the
3052 ":syntax on" and ":filetype on" commands load the menu too).
3053 'g' Grey menu items: Make menu items that are not active grey. If
3054 'g' is not included inactive menu items are not shown at all.
3055 Exception: Athena will always use grey menu items.
3056
3057 't' Include tearoff menu items. Currently only works for Win32,
3058 GTK+, and Motif 1.2 GUI.
3059 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3060 Athena GUIs.
3061
3062 'r' Right-hand scrollbar is always present.
3063 'R' Right-hand scrollbar is present when there is a vertically
3064 split window.
3065 'l' Left-hand scrollbar is always present.
3066 'L' Left-hand scrollbar is present when there is a vertically
3067 split window.
3068 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3069 the longest visible line, or on the cursor line if the 'h'
3070 flag is included. |gui-horiz-scroll|
3071 'h' Limit horizontal scrollbar size to the length of the cursor
3072 line. Reduces computations. |gui-horiz-scroll|
3073
3074 And yes, you may even have scrollbars on the left AND the right if
3075 you really want to :-). See |gui-scrollbars| for more information.
3076
3077 'v' Use a vertical button layout for dialogs. When not included,
3078 a horizontal layout is preferred, but when it doesn't fit a
3079 vertical layout is used anyway.
3080 'p' Use Pointer callbacks for X11 GUI. This is required for some
3081 window managers. If the cursor is not blinking or hollow at
3082 the right moment, try adding this flag. This must be done
3083 before starting the GUI. Set it in your gvimrc. Adding or
3084 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003085 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086
3087 *'guipty'* *'noguipty'*
3088'guipty' boolean (default on)
3089 global
3090 {not in Vi}
3091 {only available when compiled with GUI enabled}
3092 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3093 I/O to/from shell commands. See |gui-pty|.
3094
3095 *'helpfile'* *'hf'*
3096'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3097 (others) "$VIMRUNTIME/doc/help.txt")
3098 global
3099 {not in Vi}
3100 Name of the main help file. All distributed help files should be
3101 placed together in one directory. Additionally, all "doc" directories
3102 in 'runtimepath' will be used.
3103 Environment variables are expanded |:set_env|. For example:
3104 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003105 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 spaces and backslashes.
3107 This option cannot be set from a |modeline| or in the |sandbox|, for
3108 security reasons.
3109
3110 *'helpheight'* *'hh'*
3111'helpheight' 'hh' number (default 20)
3112 global
3113 {not in Vi}
3114 {not available when compiled without the +windows
3115 feature}
3116 Minimal initial height of the help window when it is opened with the
3117 ":help" command. The initial height of the help window is half of the
3118 current window, or (when the 'ea' option is on) the same as other
3119 windows. When the height is less than 'helpheight', the height is
3120 set to 'helpheight'. Set to zero to disable.
3121
3122 *'helplang'* *'hlg'*
3123'helplang' 'hlg' string (default: messages language or empty)
3124 global
3125 {only available when compiled with the |+multi_lang|
3126 feature}
3127 {not in Vi}
3128 Comma separated list of languages. Vim will use the first language
3129 for which the desired help can be found. The English help will always
3130 be used as a last resort. You can add "en" to prefer English over
3131 another language, but that will only find tags that exist in that
3132 language and not in the English help.
3133 Example: >
3134 :set helplang=de,it
3135< This will first search German, then Italian and finally English help
3136 files.
3137 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3138 try to find the tag in the current language before using this option.
3139 See |help-translated|.
3140
3141 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3142'hidden' 'hid' boolean (default off)
3143 global
3144 {not in Vi}
3145 When off a buffer is unloaded when it is |abandon|ed. When on a
3146 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3147 displayed in another window, it does not become hidden, of course.
3148 The commands that move through the buffer list sometimes make a buffer
3149 hidden although the 'hidden' option is off: When the buffer is
3150 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003151 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003152 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 This option is set for one command with ":hide {command}" |:hide|.
3154 WARNING: It's easy to forget that you have changes in hidden buffers.
3155 Think twice when using ":q!" or ":qa!".
3156
3157 *'highlight'* *'hl'*
3158'highlight' 'hl' string (default (as a single string):
3159 "8:SpecialKey,@:NonText,d:Directory,
3160 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3161 M:ModeMsg,n:LineNr,r:Question,
3162 s:StatusLine,S:StatusLineNC,c:VertSplit
3163 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3164 f:Folded,F:FoldColumn,A:DiffAdd,
3165 C:DiffChange,D:DiffDelete,T:DiffText,
3166 >:SignColumn")
3167 global
3168 {not in Vi}
3169 This option can be used to set highlighting mode for various
3170 occasions. It is a comma separated list of character pairs. The
3171 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003172 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3174 |hl-NonText| @ '~' and '@' at the end of the window and
3175 characters from 'showbreak'
3176 |hl-Directory| d directories in CTRL-D listing and other special
3177 things in listings
3178 |hl-ErrorMsg| e error messages
3179 h (obsolete, ignored)
3180 |hl-IncSearch| i 'incsearch' highlighting
3181 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3182 |hl-MoreMsg| m |more-prompt|
3183 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3184 |hl-LineNr| n line number for ":number" and ":#" commands
3185 |hl-Question| r |hit-enter| prompt and yes/no questions
3186 |hl-StatusLine| s status line of current window |status-line|
3187 |hl-StatusLineNC| S status lines of not-current windows
3188 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3189 |hl-VertSplit| c column used to separate vertically split windows
3190 |hl-Visual| v Visual mode
3191 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3192 Selection" Only X11 Gui's |gui-x11| and
3193 |xterm-clipboard|.
3194 |hl-WarningMsg| w warning messages
3195 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3196 |hl-Folded| f line used for closed folds
3197 |hl-FoldColumn| F 'foldcolumn'
3198 |hl-SignColumn| > column used for |signs|
3199
3200 The display modes are:
3201 r reverse (termcap entry "mr" and "me")
3202 i italic (termcap entry "ZH" and "ZR")
3203 b bold (termcap entry "md" and "me")
3204 s standout (termcap entry "so" and "se")
3205 u underline (termcap entry "us" and "ue")
3206 n no highlighting
3207 - no highlighting
3208 : use a highlight group
3209 The default is used for occasions that are not included.
3210 If you want to change what the display modes do, see |dos-colors|
3211 for an example.
3212 When using the ':' display mode, this must be followed by the name of
3213 a highlight group. A highlight group can be used to define any type
3214 of highlighting, including using color. See |:highlight| on how to
3215 define one. The default uses a different group for each occasion.
3216 See |highlight-default| for the default highlight groups.
3217
3218 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3219'hlsearch' 'hls' boolean (default off)
3220 global
3221 {not in Vi}
3222 {not available when compiled without the
3223 |+extra_search| feature}
3224 When there is a previous search pattern, highlight all its matches.
3225 The type of highlighting used can be set with the 'l' occasion in the
3226 'highlight' option. This uses the "Search" highlight group by
3227 default. Note that only the matching text is highlighted, any offsets
3228 are not applied.
3229 See also: 'incsearch' and |:match|.
3230 When you get bored looking at the highlighted matches, you can turn it
3231 off with |:nohlsearch|. As soon as you use a search command, the
3232 highlighting comes back.
3233 When the search pattern can match an end-of-line, Vim will try to
3234 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003235 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 line below a closed fold. A match in a previous line which is not
3237 drawn may not continue in an newly drawn line.
3238 NOTE: This option is reset when 'compatible' is set.
3239
3240 *'history'* *'hi'*
3241'history' 'hi' number (Vim default: 20, Vi default: 0)
3242 global
3243 {not in Vi}
3244 A history of ":" commands, and a history of previous search patterns
3245 are remembered. This option decides how many entries may be stored in
3246 each of these histories (see |cmdline-editing|).
3247 NOTE: This option is set to the Vi default value when 'compatible' is
3248 set and to the Vim default value when 'compatible' is reset.
3249
3250 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3251'hkmap' 'hk' boolean (default off)
3252 global
3253 {not in Vi}
3254 {only available when compiled with the |+rightleft|
3255 feature}
3256 When on, the keyboard is mapped for the Hebrew character set.
3257 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3258 toggle this option. See |rileft.txt|.
3259 NOTE: This option is reset when 'compatible' is set.
3260
3261 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3262'hkmapp' 'hkp' boolean (default off)
3263 global
3264 {not in Vi}
3265 {only available when compiled with the |+rightleft|
3266 feature}
3267 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3268 This is useful if you have a non-Hebrew keyboard.
3269 See |rileft.txt|.
3270 NOTE: This option is reset when 'compatible' is set.
3271
3272 *'icon'* *'noicon'*
3273'icon' boolean (default off, on when title can be restored)
3274 global
3275 {not in Vi}
3276 {not available when compiled without the |+title|
3277 feature}
3278 When on, the icon text of the window will be set to the value of
3279 'iconstring' (if it is not empty), or to the name of the file
3280 currently being edited. Only the last part of the name is used.
3281 Overridden by the 'iconstring' option.
3282 Only works if the terminal supports setting window icons (currently
3283 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3284 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3285 builtin termcap).
3286 When Vim was compiled with HAVE_X11 defined, the original icon will be
3287 restored if possible |X11|. See |X11-icon| for changing the icon on
3288 X11.
3289
3290 *'iconstring'*
3291'iconstring' string (default "")
3292 global
3293 {not in Vi}
3294 {not available when compiled without the |+title|
3295 feature}
3296 When this option is not empty, it will be used for the icon text of
3297 the window. This happens only when the 'icon' option is on.
3298 Only works if the terminal supports setting window icon text
3299 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3300 Does not work for MS Windows.
3301 When Vim was compiled with HAVE_X11 defined, the original icon will be
3302 restored if possible |X11|.
3303 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003304 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 'titlestring' for example settings.
3306 {not available when compiled without the |+statusline| feature}
3307
3308 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3309'ignorecase' 'ic' boolean (default off)
3310 global
3311 Ignore case in search patterns. Also used when searching in the tags
3312 file.
3313 Also see 'smartcase'.
3314 Can be overruled by using "\c" or "\C" in the pattern, see
3315 |/ignorecase|.
3316
3317 *'imactivatekey'* *'imak'*
3318'imactivatekey' 'imak' string (default "")
3319 global
3320 {not in Vi}
3321 {only available when compiled with |+xim| and
3322 |+GUI_GTK|}
3323 Specifies the key that your Input Method in X-Windows uses for
3324 activation. When this is specified correctly, vim can fully control
3325 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3326 You can't use this option to change the activation key, the option
3327 tells Vim what the key is.
3328 Format:
3329 [MODIFIER_FLAG-]KEY_STRING
3330
3331 These characters can be used for MODIFIER_FLAG (case is ignored):
3332 S Shift key
3333 L Lock key
3334 C Control key
3335 1 Mod1 key
3336 2 Mod2 key
3337 3 Mod3 key
3338 4 Mod4 key
3339 5 Mod5 key
3340 Combinations are allowed, for example "S-C-space" or "SC-space" are
3341 both shift+ctrl+space.
3342 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3343
3344 Example: >
3345 :set imactivatekey=S-space
3346< "S-space" means shift+space. This is the activation key for kinput2 +
3347 canna (Japanese), and ami (Korean).
3348
3349 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3350'imcmdline' 'imc' boolean (default off)
3351 global
3352 {not in Vi}
3353 {only available when compiled with the |+xim|
3354 |+multi_byte_ime| or |global-ime| feature}
3355 When set the Input Method is always on when starting to edit a command
3356 line, unless entering a search pattern (see 'imsearch' for that).
3357 Setting this option is useful when your input method allows entering
3358 English characters directly, e.g., when it's used to type accented
3359 characters with dead keys.
3360
3361 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3362'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3363 global
3364 {not in Vi}
3365 {only available when compiled with the |+xim|
3366 |+multi_byte_ime| or |global-ime| feature}
3367 When set the Input Method is never used. This is useful to disable
3368 the IM when it doesn't work properly.
3369 Currently this option is on by default for SGI/IRIX machines. This
3370 may change in later releases.
3371
3372 *'iminsert'* *'imi'*
3373'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3374 local to buffer
3375 {not in Vi}
3376 Specifies whether :lmap or an Input Method (IM) is to be used in
3377 Insert mode. Valid values:
3378 0 :lmap is off and IM is off
3379 1 :lmap is ON and IM is off
3380 2 :lmap is off and IM is ON
3381 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3382 or |global-ime|.
3383 To always reset the option to zero when leaving Insert mode with <Esc>
3384 this can be used: >
3385 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3386< This makes :lmap and IM turn off automatically when leaving Insert
3387 mode.
3388 Note that this option changes when using CTRL-^ in Insert mode
3389 |i_CTRL-^|.
3390 The value is set to 1 when setting 'keymap' to a valid keymap name.
3391 It is also used for the argument of commands like "r" and "f".
3392 The value 0 may not work correctly with Athena and Motif with some XIM
3393 methods. Use 'imdisable' to disable XIM then.
3394
3395 *'imsearch'* *'ims'*
3396'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3397 local to buffer
3398 {not in Vi}
3399 Specifies whether :lmap or an Input Method (IM) is to be used when
3400 entering a search pattern. Valid values:
3401 -1 the value of 'iminsert' is used, makes it look like
3402 'iminsert' is also used when typing a search pattern
3403 0 :lmap is off and IM is off
3404 1 :lmap is ON and IM is off
3405 2 :lmap is off and IM is ON
3406 Note that this option changes when using CTRL-^ in Command-line mode
3407 |c_CTRL-^|.
3408 The value is set to 1 when it is not -1 and setting the 'keymap'
3409 option to a valid keymap name.
3410 The value 0 may not work correctly with Athena and Motif with some XIM
3411 methods. Use 'imdisable' to disable XIM then.
3412
3413 *'include'* *'inc'*
3414'include' 'inc' string (default "^\s*#\s*include")
3415 global or local to buffer |global-local|
3416 {not in Vi}
3417 {not available when compiled without the
3418 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003419 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 pattern, just like for the "/" command (See |pattern|). The default
3421 value is for C programs. This option is used for the commands "[i",
3422 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3423 name that comes after the matched pattern. See |option-backslash|
3424 about including spaces and backslashes.
3425
3426 *'includeexpr'* *'inex'*
3427'includeexpr' 'inex' string (default "")
3428 local to buffer
3429 {not in Vi}
3430 {not available when compiled without the
3431 |+find_in_path| or |+eval| feature}
3432 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003433 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 :set includeexpr=substitute(v:fname,'\\.','/','g')
3435< The "v:fname" variable will be set to the file name that was detected.
3436 Evaluated in the |sandbox|.
3437 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003438 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439 Also used for |<cfile>|.
3440
3441 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3442'incsearch' 'is' boolean (default off)
3443 global
3444 {not in Vi}
3445 {not available when compiled without the
3446 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003447 While typing a search command, show where the pattern, as it was typed
3448 so far, matches. The matched string is highlighted. If the pattern
3449 is invalid or not found, nothing is shown. The screen will be updated
3450 often, this is only useful on fast terminals.
3451 Note that the match will be shown, but the cursor will return to its
3452 original position when no match is found and when pressing <Esc>. You
3453 still need to finish the search command with <Enter> to move the
3454 cursor to the match.
3455 The highlighting can be set with the 'i' flag in 'highlight'.
3456 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003457 NOTE: This option is reset when 'compatible' is set.
3458
3459 *'indentexpr'* *'inde'*
3460'indentexpr' 'inde' string (default "")
3461 local to buffer
3462 {not in Vi}
3463 {not available when compiled without the |+cindent|
3464 or |+eval| features}
3465 Expression which is evaluated to obtain the proper indent for a line.
3466 It is used when a new line is created, for the |=| operator and
3467 in Insert mode as specified with the 'indentkeys' option.
3468 When this option is not empty, it overrules the 'cindent' and
3469 'smartindent' indenting.
3470 When 'paste' is set this option is not used for indenting.
3471 The expression is evaluated with |v:lnum| set to the line number for
3472 which the indent is to be computed. The cursor is also as this line
3473 when the expression is evaluated (but it may be moved around).
3474 The expression must return the number of spaces worth of indent. It
3475 can return "-1" to keep the current indent (this means 'autoindent' is
3476 used for the indent).
3477 Functions useful for computing the indent are |indent()|, |cindent()|
3478 and |lispindent()|.
3479 The evaluation of the expression must not have side effects! It must
3480 not change the text, jump to another window, etc. Afterwards the
3481 cursor position is always restored, thus the cursor may be moved.
3482 Normally this option would be set to call a function: >
3483 :set indentexpr=GetMyIndent()
3484< Error messages will be suppressed, unless the 'debug' option contains
3485 "msg".
3486 See |indent-expression|. Also see |eval-sandbox|.
3487 NOTE: This option is made empty when 'compatible' is set.
3488
3489 *'indentkeys'* *'indk'*
3490'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3491 local to buffer
3492 {not in Vi}
3493 {not available when compiled without the |+cindent|
3494 feature}
3495 A list of keys that, when typed in Insert mode, cause reindenting of
3496 the current line. Only happens if 'indentexpr' isn't empty.
3497 The format is identical to 'cinkeys', see |indentkeys-format|.
3498 See |C-indenting| and |indent-expression|.
3499
3500 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3501'infercase' 'inf' boolean (default off)
3502 local to buffer
3503 {not in Vi}
3504 When doing keyword completion in insert mode |ins-completion|, and
3505 'ignorecase' is also on, the case of the match is adjusted. If the
3506 typed text contains a lowercase letter where the match has an upper
3507 case letter, the completed part is made lowercase. If the typed text
3508 has no lowercase letters and the match has a lowercase letter where
3509 the typed text has an uppercase letter, and there is a letter before
3510 it, the completed part is made uppercase.
3511
3512 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3513'insertmode' 'im' boolean (default off)
3514 global
3515 {not in Vi}
3516 Makes Vim work in a way that Insert mode is the default mode. Useful
3517 if you want to use Vim as a modeless editor. Used for |evim|.
3518 These Insert mode commands will be useful:
3519 - Use the cursor keys to move around.
3520 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3521 this is a mapping, it is executed as if 'insertmode' was off.
3522 Normal mode remains active until the mapping is finished.
3523 *i_CTRL-L*
3524 - Use CTRL-L to execute a number of Normal mode commands, then use
3525 <Esc> to get back to Insert mode.
3526
3527 These items change when 'insertmode' is set:
3528 - when starting to edit of a file, Vim goes to Insert mode.
3529 - <Esc> in Insert mode is a no-op and beeps.
3530 - <Esc> in Normal mode makes Vim go to Insert mode.
3531 - CTRL-L in Insert mode is a command, it is not inserted.
3532 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3533 However, when <Esc> is used inside a mapping, it behaves like
3534 'insertmode' was not set. This was done to be able to use the same
3535 mappings with 'insertmode' set or not set.
3536 When executing commands with |:normal| 'insertmode' is not used.
3537
3538 NOTE: This option is reset when 'compatible' is set.
3539
3540 *'isfname'* *'isf'*
3541'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3542 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3543 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3544 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3545 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3546 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3547 global
3548 {not in Vi}
3549 The characters specified by this option are included in file names and
3550 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003551 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 Multi-byte characters 256 and above are always included, only the
3553 characters up to 255 are specified with this option.
3554 For UTF-8 the characters 0xa0 to 0xff are included as well.
3555
3556 Note that on systems using a backslash as path separator, Vim tries to
3557 do its best to make it work as you would expect. That is a bit
3558 tricky, since Vi originally used the backslash to escape special
3559 characters. Vim will not remove a backslash in front of a normal file
3560 name character on these systems, but it will on Unix and alikes. The
3561 '&' and '^' are not included by default, because these are special for
3562 cmd.exe.
3563
3564 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 Each part can be a single character number or a range. A range is two
3566 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 decimal number between 0 and 255 or the ASCII character itself (does
3568 not work for digits). Example:
3569 "_,-,128-140,#-43" (include '_' and '-' and the range
3570 128 to 140 and '#' to 43)
3571 If a part starts with '^', the following character number or range
3572 will be excluded from the option. The option is interpreted from left
3573 to right. Put the excluded character after the range where it is
3574 included. To include '^' itself use it as the last character of the
3575 option or the end of a range. Example:
3576 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3577 If the character is '@', all characters where isalpha() returns TRUE
3578 are included. Normally these are the characters a to z and A to Z,
3579 plus accented characters. To include '@' itself use "@-@". Examples:
3580 "@,^a-z" All alphabetic characters, excluding lower
3581 case letters.
3582 "a-z,A-Z,@-@" All letters plus the '@' character.
3583 A comma can be included by using it where a character number is
3584 expected. Example:
3585 "48-57,,,_" Digits, comma and underscore.
3586 A comma can be excluded by prepending a '^'. Example:
3587 " -~,^,,9" All characters from space to '~', excluding
3588 comma, plus <Tab>.
3589 See |option-backslash| about including spaces and backslashes.
3590
3591 *'isident'* *'isi'*
3592'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3593 "@,48-57,_,128-167,224-235"
3594 otherwise: "@,48-57,_,192-255")
3595 global
3596 {not in Vi}
3597 The characters given by this option are included in identifiers.
3598 Identifiers are used in recognizing environment variables and after a
3599 match of the 'define' option. It is also used for "\i" in a
3600 |pattern|. See 'isfname' for a description of the format of this
3601 option.
3602 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003603 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3605
3606 *'iskeyword'* *'isk'*
3607'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3608 "@,48-57,_,128-167,224-235"
3609 otherwise: "@,48-57,_,192-255"
3610 Vi default: "@,48-57,_")
3611 local to buffer
3612 {not in Vi}
3613 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003614 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 'isfname' for a description of the format of this option. For C
3616 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3617 For a help file it is set to all non-blank printable characters except
3618 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3619 command).
3620 When the 'lisp' option is on the '-' character is always included.
3621 NOTE: This option is set to the Vi default value when 'compatible' is
3622 set and to the Vim default value when 'compatible' is reset.
3623
3624 *'isprint'* *'isp'*
3625'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3626 "@,~-255"; otherwise: "@,161-255")
3627 global
3628 {not in Vi}
3629 The characters given by this option are displayed directly on the
3630 screen. It is also used for "\p" in a |pattern|. The characters from
3631 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3632 even when they are not included in 'isprint' or excluded. See
3633 'isfname' for a description of the format of this option.
3634
3635 Non-printable characters are displayed with two characters:
3636 0 - 31 "^@" - "^_"
3637 32 - 126 always single characters
3638 127 "^?"
3639 128 - 159 "~@" - "~_"
3640 160 - 254 "| " - "|~"
3641 255 "~?"
3642 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3643 displayed as <xx>, with the hexadecimal value of the byte.
3644 When 'display' contains "uhex" all unprintable characters are
3645 displayed as <xx>.
3646 The NonText highlighting will be used for unprintable characters.
3647 |hl-NonText|
3648
3649 Multi-byte characters 256 and above are always included, only the
3650 characters up to 255 are specified with this option. When a character
3651 is printable but it is not available in the current font, a
3652 replacement character will be shown.
3653 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3654 There is no option to specify these characters.
3655
3656 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3657'joinspaces' 'js' boolean (default on)
3658 global
3659 {not in Vi}
3660 Insert two spaces after a '.', '?' and '!' with a join command.
3661 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3662 Otherwise only one space is inserted.
3663 NOTE: This option is set when 'compatible' is set.
3664
3665 *'key'*
3666'key' string (default "")
3667 local to buffer
3668 {not in Vi}
3669 The key that is used for encrypting and decrypting the current buffer.
3670 See |encryption|.
3671 Careful: Do not set the key value by hand, someone might see the typed
3672 key. Use the |:X| command. But you can make 'key' empty: >
3673 :set key=
3674< It is not possible to get the value of this option with ":set key" or
3675 "echo &key". This is to avoid showing it to someone who shouldn't
3676 know. It also means you cannot see it yourself once you have set it,
3677 be careful not to make a typing error!
3678
3679 *'keymap'* *'kmp'* *E544*
3680'keymap' 'kmp' string (default "")
3681 local to buffer
3682 {not in Vi}
3683 {only available when compiled with the |+keymap|
3684 feature}
3685 Name of a keyboard mapping. See |mbyte-keymap|.
3686 Setting this option to a valid keymap name has the side effect of
3687 setting 'iminsert' to one, so that the keymap becomes effective.
3688 'imsearch' is also set to one, unless it was -1
3689
3690 *'keymodel'* *'km'*
3691'keymodel' 'km' string (default "")
3692 global
3693 {not in Vi}
3694 List of comma separated words, which enable special things that keys
3695 can do. These values can be used:
3696 startsel Using a shifted special key starts selection (either
3697 Select mode or Visual mode, depending on "key" being
3698 present in 'selectmode').
3699 stopsel Using a not-shifted special key stops selection.
3700 Special keys in this context are the cursor keys, <End>, <Home>,
3701 <PageUp> and <PageDown>.
3702 The 'keymodel' option is set by the |:behave| command.
3703
3704 *'keywordprg'* *'kp'*
3705'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3706 OS/2: "view /", VMS: "help")
3707 global or local to buffer |global-local|
3708 {not in Vi}
3709 Program to use for the |K| command. Environment variables are
3710 expanded |:set_env|. ":help" may be used to access the Vim internal
3711 help. (Note that previously setting the global option to the empty
3712 value did this, which is now deprecated.)
3713 When "man" is used, Vim will automatically translate a count for the
3714 "K" command to a section number. Also for "man -s", in which case the
3715 "-s" is removed when there is no count.
3716 See |option-backslash| about including spaces and backslashes.
3717 Example: >
3718 :set keywordprg=man\ -s
3719< This option cannot be set from a |modeline| or in the |sandbox|, for
3720 security reasons.
3721
3722 *'langmap'* *'lmap'* *E357* *E358*
3723'langmap' 'lmap' string (default "")
3724 global
3725 {not in Vi}
3726 {only available when compiled with the |+langmap|
3727 feature}
3728 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003729 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 inserted directly. When in command mode the 'langmap' option takes
3731 care of translating these special characters to the original meaning
3732 of the key. This means you don't have to change the keyboard mode to
3733 be able to execute Normal mode commands.
3734 This is the opposite of the 'keymap' option, where characters are
3735 mapped in Insert mode.
3736 This only works for 8-bit characters. The value of 'langmap' may be
3737 specified with multi-byte characters (e.g., UTF-8), but only the lower
3738 8 bits of each character will be used.
3739
3740 Example (for Greek): *greek* >
3741 :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
3742< Example (exchanges meaning of z and y for commands): >
3743 :set langmap=zy,yz,ZY,YZ
3744<
3745 The 'langmap' option is a list of parts, separated with commas. Each
3746 part can be in one of two forms:
3747 1. A list of pairs. Each pair is a "from" character immediately
3748 followed by the "to" character. Examples: "aA", "aAbBcC".
3749 2. A list of "from" characters, a semi-colon and a list of "to"
3750 characters. Example: "abc;ABC"
3751 Example: "aA,fgh;FGH,cCdDeE"
3752 Special characters need to be preceded with a backslash. These are
3753 ";", ',' and backslash itself.
3754
3755 This will allow you to activate vim actions without having to switch
3756 back and forth between the languages. Your language characters will
3757 be understood as normal vim English characters (according to the
3758 langmap mappings) in the following cases:
3759 o Normal/Visual mode (commands, buffer/register names, user mappings)
3760 o Insert/Replace Mode: Register names after CTRL-R
3761 o Insert/Replace Mode: Mappings
3762 Characters entered in Command-line mode will NOT be affected by
3763 this option. Note that this option can be changed at any time
3764 allowing to switch between mappings for different languages/encodings.
3765 Use a mapping to avoid having to type it each time!
3766
3767 *'langmenu'* *'lm'*
3768'langmenu' 'lm' string (default "")
3769 global
3770 {not in Vi}
3771 {only available when compiled with the |+menu| and
3772 |+multi_lang| features}
3773 Language to use for menu translation. Tells which file is loaded
3774 from the "lang" directory in 'runtimepath': >
3775 "lang/menu_" . &langmenu . ".vim"
3776< (without the spaces). For example, to always use the Dutch menus, no
3777 matter what $LANG is set to: >
3778 :set langmenu=nl_NL.ISO_8859-1
3779< When 'langmenu' is empty, |v:lang| is used.
3780 If your $LANG is set to a non-English language but you do want to use
3781 the English menus: >
3782 :set langmenu=none
3783< This option must be set before loading menus, switching on filetype
3784 detection or syntax highlighting. Once the menus are defined setting
3785 this option has no effect. But you could do this: >
3786 :source $VIMRUNTIME/delmenu.vim
3787 :set langmenu=de_DE.ISO_8859-1
3788 :source $VIMRUNTIME/menu.vim
3789< Warning: This deletes all menus that you defined yourself!
3790
3791 *'laststatus'* *'ls'*
3792'laststatus' 'ls' number (default 1)
3793 global
3794 {not in Vi}
3795 The value of this option influences when the last window will have a
3796 status line:
3797 0: never
3798 1: only if there are at least two windows
3799 2: always
3800 The screen looks nicer with a status line if you have several
3801 windows, but it takes another screen line. |status-line|
3802
3803 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3804'lazyredraw' 'lz' boolean (default off)
3805 global
3806 {not in Vi}
3807 When this option is set, the screen will not be redrawn while
3808 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003809 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 update use |:redraw|.
3811
3812 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3813'linebreak' 'lbr' boolean (default off)
3814 local to window
3815 {not in Vi}
3816 {not available when compiled without the |+linebreak|
3817 feature}
3818 If on Vim will wrap long lines at a character in 'breakat' rather
3819 than at the last character that fits on the screen. Unlike
3820 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3821 it only affects the way the file is displayed, not its contents. The
3822 value of 'showbreak' is used to put in front of wrapped lines.
3823 This option is not used when the 'wrap' option is off or 'list' is on.
3824 Note that <Tab> characters after an <EOL> are mostly not displayed
3825 with the right amount of white space.
3826
3827 *'lines'* *E593*
3828'lines' number (default 24 or terminal height)
3829 global
3830 Number of lines of the Vim window.
3831 Normally you don't need to set this. It is done automatically by the
3832 terminal initialization code.
3833 When Vim is running in the GUI or in a resizable window, setting this
3834 option will cause the window size to be changed. When you only want
3835 to use the size for the GUI, put the command in your |gvimrc| file.
3836 Vim limits the number of lines to what fits on the screen. You can
3837 use this command to get the tallest window possible: >
3838 :set lines=999
3839< If you get less lines than expected, check the 'guiheadroom' option.
3840 When you set this option and Vim is unable to change the physical
3841 number of lines of the display, the display may be messed up.
3842
3843 *'linespace'* *'lsp'*
3844'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3845 global
3846 {not in Vi}
3847 {only in the GUI}
3848 Number of pixel lines inserted between characters. Useful if the font
3849 uses the full character cell height, making lines touch each other.
3850 When non-zero there is room for underlining.
3851
3852 *'lisp'* *'nolisp'*
3853'lisp' boolean (default off)
3854 local to buffer
3855 {not available when compiled without the |+lispindent|
3856 feature}
3857 Lisp mode: When <Enter> is typed in insert mode set the indent for
3858 the next line to Lisp standards (well, sort of). Also happens with
3859 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3860 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3861 better. Also see 'lispwords'.
3862 The '-' character is included in keyword characters. Redefines the
3863 "=" operator to use this same indentation algorithm rather than
3864 calling an external program if 'equalprg' is empty.
3865 This option is not used when 'paste' is set.
3866 {Vi: Does it a little bit differently}
3867
3868 *'lispwords'* *'lw'*
3869'lispwords' 'lw' string (default is very long)
3870 global
3871 {not in Vi}
3872 {not available when compiled without the |+lispindent|
3873 feature}
3874 Comma separated list of words that influence the Lisp indenting.
3875 |'lisp'|
3876
3877 *'list'* *'nolist'*
3878'list' boolean (default off)
3879 local to window
3880 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
3881 see the difference between tabs and spaces and for trailing blanks.
3882 Note that this will also affect formatting (set with 'textwidth' or
3883 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
3884 changing the way tabs are displayed.
3885
3886 *'listchars'* *'lcs'*
3887'listchars' 'lcs' string (default "eol:$")
3888 global
3889 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003890 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 settings.
3892 eol:c Character to show at the end of each line. When
3893 omitted, there is no extra character at the end of the
3894 line.
3895 tab:xy Two characters to be used to show a Tab. The first
3896 char is used once. The second char is repeated to
3897 fill the space that the Tab normally occupies.
3898 "tab:>-" will show a Tab that takes four spaces as
3899 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 trailing spaces are blank.
3902 extends:c Character to show in the last column, when 'wrap' is
3903 off and the line continues beyond the right of the
3904 screen.
3905 precedes:c Character to show in the first column, when 'wrap'
3906 is off and there is text preceding the character
3907 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003908 nbsp:c Character to show for a non-breakable space (character
3909 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003911 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00003912 be used when 'encoding' is "utf-8", otherwise only printable
3913 characters are allowed.
3914
3915 Examples: >
3916 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003917 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 :set lcs=extends:>,precedes:<
3919< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003920 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921
3922 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3923'loadplugins' 'lpl' boolean (default on)
3924 global
3925 {not in Vi}
3926 When on the plugin scripts are loaded when starting up |load-plugins|.
3927 This option can be reset in your |vimrc| file to disable the loading
3928 of plugins.
3929 Note that using the "-u NONE" and "--noplugin" command line arguments
3930 reset this option. |-u| |--noplugin|
3931
3932 *'magic'* *'nomagic'*
3933'magic' boolean (default on)
3934 global
3935 Changes the special characters that can be used in search patterns.
3936 See |pattern|.
3937 NOTE: To avoid portability problems with using patterns, always keep
3938 this option at the default "on". Only switch it off when working with
3939 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00003940 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941
3942 *'makeef'* *'mef'*
3943'makeef' 'mef' string (default: "")
3944 global
3945 {not in Vi}
3946 {not available when compiled without the |+quickfix|
3947 feature}
3948 Name of the errorfile for the |:make| command (see |:make_makeprg|)
3949 and the |:grep| command.
3950 When it is empty, an internally generated temp file will be used.
3951 When "##" is included, it is replaced by a number to make the name
3952 unique. This makes sure that the ":make" command doesn't overwrite an
3953 existing file.
3954 NOT used for the ":cf" command. See 'errorfile' for that.
3955 Environment variables are expanded |:set_env|.
3956 See |option-backslash| about including spaces and backslashes.
3957 This option cannot be set from a |modeline| or in the |sandbox|, for
3958 security reasons.
3959
3960 *'makeprg'* *'mp'*
3961'makeprg' 'mp' string (default "make", VMS: "MMS")
3962 global or local to buffer |global-local|
3963 {not in Vi}
3964 Program to use for the ":make" command. See |:make_makeprg|. This
3965 option may contain '%' and '#' characters, which are expanded like
3966 when used in a command-line. Environment variables are expanded
3967 |:set_env|. See |option-backslash| about including spaces and
3968 backslashes. Note that a '|' must be escaped twice: once for ":set"
3969 and once for the interpretation of a command. When you use a filter
3970 called "myfilter" do it like this: >
3971 :set makeprg=gmake\ \\\|\ myfilter
3972< The placeholder "$*" can be given (even multiple times) to specify
3973 where the arguments will be included, for example: >
3974 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
3975< This option cannot be set from a |modeline| or in the |sandbox|, for
3976 security reasons.
3977
3978 *'matchpairs'* *'mps'*
3979'matchpairs' 'mps' string (default "(:),{:},[:]")
3980 local to buffer
3981 {not in Vi}
3982 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003983 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 must be different. The characters must be separated by a colon. The
3985 pairs must be separated by a comma. Example for including '<' and '>'
3986 (HTML): >
3987 :set mps+=<:>
3988
3989< A more exotic example, to jump between the '=' and ';' in an
3990 assignment, useful for languages like C and Java: >
3991 :au FileType c,cpp,java set mps+==:;
3992
3993< For a more advanced way of using "%", see the matchit.vim plugin in
3994 the $VIMRUNTIME/macros directory. |add-local-help|
3995
3996 *'matchtime'* *'mat'*
3997'matchtime' 'mat' number (default 5)
3998 global
3999 {not in Vi}{in Nvi}
4000 Tenths of a second to show the matching paren, when 'showmatch' is
4001 set. Note that this is not in milliseconds, like other options that
4002 set a time. This is to be compatible with Nvi.
4003
4004 *'maxfuncdepth'* *'mfd'*
4005'maxfuncdepth' 'mfd' number (default 100)
4006 global
4007 {not in Vi}
4008 Maximum depth of function calls for user functions. This normally
4009 catches endless recursion. When using a recursive function with
4010 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4011 more memory, there is the danger of failing when memory is exhausted.
4012 See also |:function|.
4013
4014 *'maxmapdepth'* *'mmd'* *E223*
4015'maxmapdepth' 'mmd' number (default 1000)
4016 global
4017 {not in Vi}
4018 Maximum number of times a mapping is done without resulting in a
4019 character to be used. This normally catches endless mappings, like
4020 ":map x y" with ":map y x". It still does not catch ":map g wg",
4021 because the 'w' is used before the next mapping is done. See also
4022 |key-mapping|.
4023
4024 *'maxmem'* *'mm'*
4025'maxmem' 'mm' number (default between 256 to 5120 (system
4026 dependent) or half the amount of memory
4027 available)
4028 global
4029 {not in Vi}
4030 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4031 limit is reached allocating extra memory for a buffer will cause
4032 other memory to be freed. Maximum value 2000000. Use this to work
4033 without a limit. Also see 'maxmemtot'.
4034
4035 *'maxmemtot'* *'mmt'*
4036'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4037 dependent) or half the amount of memory
4038 available)
4039 global
4040 {not in Vi}
4041 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004042 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004043 'maxmem'.
4044
4045 *'menuitems'* *'mis'*
4046'menuitems' 'mis' number (default 25)
4047 global
4048 {not in Vi}
4049 {not available when compiled without the |+menu|
4050 feature}
4051 Maximum number of items to use in a menu. Used for menus that are
4052 generated from a list of items, e.g., the Buffers menu. Changing this
4053 option has no direct effect, the menu must be refreshed first.
4054
4055 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4056'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4057 local to buffer
4058 *'modelines'* *'mls'*
4059'modelines' 'mls' number (default 5)
4060 global
4061 {not in Vi}
4062 If 'modeline' is on 'modelines' gives the number of lines that is
4063 checked for set commands. If 'modeline' is off or 'modelines' is zero
4064 no lines are checked. See |modeline|.
4065 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4066 set and to the Vim default value when 'compatible' is reset.
4067
4068 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4069'modifiable' 'ma' boolean (default on)
4070 local to buffer
4071 {not in Vi} *E21*
4072 When off the buffer contents cannot be changed. The 'fileformat' and
4073 'fileencoding' options also can't be changed.
4074 Can be reset with the |-M| command line argument.
4075
4076 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4077'modified' 'mod' boolean (default off)
4078 local to buffer
4079 {not in Vi}
4080 When on, the buffer is considered to be modified. This option is set
4081 when:
4082 1. A change was made to the text since it was last written. Using the
4083 |undo| command to go back to the original text will reset the
4084 option. But undoing changes that were made before writing the
4085 buffer will set the option again, since the text is different from
4086 when it was written.
4087 2. 'fileformat' or 'fileencoding' is different from its original
4088 value. The original value is set when the buffer is read or
4089 written. A ":set nomodified" command also resets the original
4090 values to the current values and the 'modified' option will be
4091 reset.
4092 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4093 will be ignored.
4094
4095 *'more'* *'nomore'*
4096'more' boolean (Vim default: on, Vi default: off)
4097 global
4098 {not in Vi}
4099 When on, listings pause when the whole screen is filled. You will get
4100 the |more-prompt|. When this option is off there are no pauses, the
4101 listing continues until finished.
4102 NOTE: This option is set to the Vi default value when 'compatible' is
4103 set and to the Vim default value when 'compatible' is reset.
4104
4105 *'mouse'* *E538*
4106'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4107 global
4108 {not in Vi}
4109 Enable the use of the mouse. Only works for certain terminals
4110 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4111 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4112 The mouse can be enabled for different modes:
4113 n Normal mode
4114 v Visual mode
4115 i Insert mode
4116 c Command-line mode
4117 h all previous modes when editing a help file
4118 a all previous modes
4119 r for |hit-enter| and |more-prompt| prompt
4120 A auto-select in Visual mode
4121 Normally you would enable the mouse in all four modes with: >
4122 :set mouse=a
4123< When the mouse is not enabled, the GUI will still use the mouse for
4124 modeless selection. This doesn't move the text cursor.
4125
4126 See |mouse-using|. Also see |'clipboard'|.
4127
4128 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004129 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 the mouse buttons can still be used by keeping the shift key pressed.
4131 Also see the 'clipboard' option.
4132
4133 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4134'mousefocus' 'mousef' boolean (default off)
4135 global
4136 {not in Vi}
4137 {only works in the GUI}
4138 The window that the mouse pointer is on is automatically activated.
4139 When changing the window layout or window focus in another way, the
4140 mouse pointer is moved to the window with keyboard focus. Off is the
4141 default because it makes using the pull down menus a little goofy, as
4142 a pointer transit may activate a window unintentionally.
4143
4144 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4145'mousehide' 'mh' boolean (default on)
4146 global
4147 {not in Vi}
4148 {only works in the GUI}
4149 When on, the mouse pointer is hidden when characters are typed.
4150 The mouse pointer is restored when the mouse is moved.
4151
4152 *'mousemodel'* *'mousem'*
4153'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4154 global
4155 {not in Vi}
4156 Sets the model to use for the mouse. The name mostly specifies what
4157 the right mouse button is used for:
4158 extend Right mouse button extends a selection. This works
4159 like in an xterm.
4160 popup Right mouse button pops up a menu. The shifted left
4161 mouse button extends a selection. This works like
4162 with Microsoft Windows
4163 popup_setpos Like "popup", but the cursor will be moved to the
4164 position where the mouse was clicked, and thus the
4165 selected operation will act upon the clicked object.
4166 If clicking inside a selection, that selection will
4167 be acted upon, ie. no cursor move. This implies of
4168 course, that right clicking outside a selection will
4169 end Visual mode.
4170 Overview of what button does what for each model:
4171 mouse extend popup(_setpos) ~
4172 left click place cursor place cursor
4173 left drag start selection start selection
4174 shift-left search word extend selection
4175 right click extend selection popup menu (place cursor)
4176 right drag extend selection -
4177 middle click paste paste
4178
4179 In the "popup" model the right mouse button produces a pop-up menu.
4180 You need to define this first, see |popup-menu|.
4181
4182 Note that you can further refine the meaning of buttons with mappings.
4183 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4184 selection (because that's handled in the GUI code directly).
4185
4186 The 'mousemodel' option is set by the |:behave| command.
4187
4188 *'mouseshape'* *'mouses'* *E547*
4189'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4190 m:no,ml:up-arrow,v:rightup-arrow"
4191 global
4192 {not in Vi}
4193 {only available when compiled with the |+mouseshape|
4194 feature}
4195 This option tells Vim what the mouse pointer should look like in
4196 different modes. The option is a comma separated list of parts, much
4197 like used for 'guicursor'. Each part consist of a mode/location-list
4198 and an argument-list:
4199 mode-list:shape,mode-list:shape,..
4200 The mode-list is a dash separated list of these modes/locations:
4201 In a normal window: ~
4202 n Normal mode
4203 v Visual mode
4204 ve Visual mode with 'selection' "exclusive" (same as 'v',
4205 if not specified)
4206 o Operator-pending mode
4207 i Insert mode
4208 r Replace mode
4209
4210 Others: ~
4211 c appending to the command-line
4212 ci inserting in the command-line
4213 cr replacing in the command-line
4214 m at the 'Hit ENTER' or 'More' prompts
4215 ml idem, but cursor in the last line
4216 e any mode, pointer below last window
4217 s any mode, pointer on a status line
4218 sd any mode, while dragging a status line
4219 vs any mode, pointer on a vertical separator line
4220 vd any mode, while dragging a vertical separator line
4221 a everywhere
4222
4223 The shape is one of the following:
4224 avail name looks like ~
4225 w x arrow Normal mouse pointer
4226 w x blank no pointer at all (use with care!)
4227 w x beam I-beam
4228 w x updown up-down sizing arrows
4229 w x leftright left-right sizing arrows
4230 w x busy The system's usual busy pointer
4231 w x no The system's usual 'no input' pointer
4232 x udsizing indicates up-down resizing
4233 x lrsizing indicates left-right resizing
4234 x crosshair like a big thin +
4235 x hand1 black hand
4236 x hand2 white hand
4237 x pencil what you write with
4238 x question big ?
4239 x rightup-arrow arrow pointing right-up
4240 w x up-arrow arrow pointing up
4241 x <number> any X11 pointer number (see X11/cursorfont.h)
4242
4243 The "avail" column contains a 'w' if the shape is available for Win32,
4244 x for X11.
4245 Any modes not specified or shapes not available use the normal mouse
4246 pointer.
4247
4248 Example: >
4249 :set mouseshape=s:udsizing,m:no
4250< will make the mouse turn to a sizing arrow over the status lines and
4251 indicate no input when the hit-enter prompt is displayed (since
4252 clicking the mouse has no effect in this state.)
4253
4254 *'mousetime'* *'mouset'*
4255'mousetime' 'mouset' number (default 500)
4256 global
4257 {not in Vi}
4258 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4259 time in msec between two mouse clicks for the second click to be
4260 recognized as a multi click.
4261
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004262 *'mzquantum'* *'mzq'*
4263'mzquantum' 'mzq' number (default 100)
4264 global
4265 {not in Vi}
4266 {not available when compiled without the |+mzscheme|
4267 feature}
4268 The number of milliseconds between polls for MzScheme threads.
4269 Negative or zero value means no thread scheduling.
4270
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 *'nrformats'* *'nf'*
4272'nrformats' 'nf' string (default "octal,hex")
4273 local to buffer
4274 {not in Vi}
4275 This defines what bases Vim will consider for numbers when using the
4276 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4277 respectively; see |CTRL-A| for more info on these commands.
4278 alpha if included, single alphabetical characters will be
4279 incremented or decremented. This is useful for a list with a
4280 letter index a), b), etc.
4281 octal if included, numbers that start with a zero will be considered
4282 to be octal. Example: Using CTRL-A on "007" results in "010".
4283 hex if included, numbers starting with "0x" or "0X" will be
4284 considered to be hexadecimal. Example: Using CTRL-X on
4285 "0x100" results in "0x0ff".
4286 Numbers which simply begin with a digit in the range 1-9 are always
4287 considered decimal. This also happens for numbers that are not
4288 recognized as octal or hex.
4289
4290 *'number'* *'nu'* *'nonumber'* *'nonu'*
4291'number' 'nu' boolean (default off)
4292 local to window
4293 Print the line number in front of each line. When the 'n' option is
4294 excluded from 'cpoptions' a wrapped line will not use the column of
4295 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004296 The 'numberwidth' option can be used to set the room used for the line
4297 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 When a long, wrapped line doesn't start with the first character, '-'
4299 characters are put before the number.
4300 See |hl-LineNr| for the highlighting used for the number.
4301
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004302 *'numberwidth'* *'nuw'*
4303'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4304 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004305 {not in Vi}
4306 {only available when compiled with the |+linebreak|
4307 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004308 Minimal number of columns to use for the line number. Only relevant
4309 when the 'number' option is set.
4310 Since one space is always between the number and the text, there is
4311 one less character for the number itself.
4312 The value is the minimum width. A bigger width is used when needed to
4313 fit the highest line number in the buffer. Thus with the Vim default
4314 of 4 there is room for a line number up to 999. When the buffer has
4315 1000 lines five columns will be used.
4316 The minimum value is 1, the maximum value is 10.
4317 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4318
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 *'osfiletype'* *'oft'* *E366*
4320'osfiletype' 'oft' string (RISC-OS default: "Text",
4321 others default: "")
4322 local to buffer
4323 {not in Vi}
4324 {only available when compiled with the |+osfiletype|
4325 feature}
4326 Some operating systems store extra information about files besides
4327 name, datestamp and permissions. This option contains the extra
4328 information, the nature of which will vary between systems.
4329 The value of this option is usually set when the file is loaded, and
4330 use to set the file type when file is written.
4331 It can affect the pattern matching of the automatic commands.
4332 |autocmd-osfiletypes|
4333
4334 *'paragraphs'* *'para'*
4335'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4336 global
4337 Specifies the nroff macros that separate paragraphs. These are pairs
4338 of two letters (see |object-motions|).
4339
4340 *'paste'* *'nopaste'*
4341'paste' boolean (default off)
4342 global
4343 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004344 Put Vim in Paste mode. This is useful if you want to cut or copy
4345 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 unexpected effects.
4347 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004348 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 knows about pasting and will mostly do the right thing without 'paste'
4350 being set. The same is true for a terminal where Vim handles the
4351 mouse clicks itself.
4352 When the 'paste' option is switched on (also when it was already on):
4353 - mapping in Insert mode and Command-line mode is disabled
4354 - abbreviations are disabled
4355 - 'textwidth' is set to 0
4356 - 'wrapmargin' is set to 0
4357 - 'autoindent' is reset
4358 - 'smartindent' is reset
4359 - 'softtabstop' is set to 0
4360 - 'revins' is reset
4361 - 'ruler' is reset
4362 - 'showmatch' is reset
4363 - 'formatoptions' is used like it is empty
4364 These options keep their value, but their effect is disabled:
4365 - 'lisp'
4366 - 'indentexpr'
4367 - 'cindent'
4368 NOTE: When you start editing another file while the 'paste' option is
4369 on, settings from the modelines or autocommands may change the
4370 settings again, causing trouble when pasting text. You might want to
4371 set the 'paste' option again.
4372 When the 'paste' option is reset the mentioned options are restored to
4373 the value before the moment 'paste' was switched from off to on.
4374 Resetting 'paste' before ever setting it does not have any effect.
4375 Since mapping doesn't work while 'paste' is active, you need to use
4376 the 'pastetoggle' option to toggle the 'paste' option with some key.
4377
4378 *'pastetoggle'* *'pt'*
4379'pastetoggle' 'pt' string (default "")
4380 global
4381 {not in Vi}
4382 When non-empty, specifies the key sequence that toggles the 'paste'
4383 option. This is like specifying a mapping: >
4384 :map {keys} :set invpaste<CR>
4385< Where {keys} is the value of 'pastetoggle'.
4386 The difference is that it will work even when 'paste' is set.
4387 'pastetoggle' works in Insert mode and Normal mode, but not in
4388 Command-line mode.
4389 Mappings are checked first, thus overrule 'pastetoggle'. However,
4390 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4391 this: >
4392 :map <F10> :set paste<CR>
4393 :map <F11> :set nopaste<CR>
4394 :imap <F10> <C-O>:set paste<CR>
4395 :imap <F11> <nop>
4396 :set pastetoggle=<F11>
4397< This will make <F10> start paste mode and <F11> stop paste mode.
4398 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4399 mode everything is inserted literally, except the 'pastetoggle' key
4400 sequence.
4401
4402 *'pex'* *'patchexpr'*
4403'patchexpr' 'pex' string (default "")
4404 global
4405 {not in Vi}
4406 {not available when compiled without the |+diff|
4407 feature}
4408 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410
4411 *'patchmode'* *'pm'* *E206*
4412'patchmode' 'pm' string (default "")
4413 global
4414 {not in Vi}
4415 When non-empty the oldest version of a file is kept. This can be used
4416 to keep the original version of a file if you are changing files in a
4417 source distribution. Only the first time that a file is written a
4418 copy of the original file will be kept. The name of the copy is the
4419 name of the original file with the string in the 'patchmode' option
4420 appended. This option should start with a dot. Use a string like
4421 ".org". 'backupdir' must not be empty for this to work (Detail: The
4422 backup file is renamed to the patchmode file after the new file has
4423 been successfully written, that's why it must be possible to write a
4424 backup file). If there was no file to be backed up, an empty file is
4425 created.
4426 When the 'backupskip' pattern matches, a patchmode file is not made.
4427 Using 'patchmode' for compressed files appends the extension at the
4428 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4429 recognized as a compressed file.
4430
4431 *'path'* *'pa'* *E343* *E345* *E347*
4432'path' 'pa' string (default on Unix: ".,/usr/include,,"
4433 on OS/2: ".,/emx/include,,"
4434 other systems: ".,,")
4435 global or local to buffer |global-local|
4436 {not in Vi}
4437 This is a list of directories which will be searched when using the
4438 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4439 being searched for has a relative path (not starting with '/'). The
4440 directories in the 'path' option may be relative or absolute.
4441 - Use commas to separate directory names: >
4442 :set path=.,/usr/local/include,/usr/include
4443< - Spaces can also be used to separate directory names (for backwards
4444 compatibility with version 3.0). To have a space in a directory
4445 name, precede it with an extra backslash, and escape the space: >
4446 :set path=.,/dir/with\\\ space
4447< - To include a comma in a directory name precede it with an extra
4448 backslash: >
4449 :set path=.,/dir/with\\,comma
4450< - To search relative to the directory of the current file, use: >
4451 :set path=.
4452< - To search in the current directory use an empty string between two
4453 commas: >
4454 :set path=,,
4455< - A directory name may end in a ':' or '/'.
4456 - Environment variables are expanded |:set_env|.
4457 - When using |netrw.vim| URLs can be used. For example, adding
4458 "http://www.vim.org" will make ":find index.html" work.
4459 - Search upwards and downwards in a directory tree:
4460 1) "*" matches a sequence of characters, e.g.: >
4461 :set path=/usr/include/*
4462< means all subdirectories in /usr/include (but not /usr/include
4463 itself). >
4464 :set path=/usr/*c
4465< matches /usr/doc and /usr/src.
4466 2) "**" matches a subtree, up to 100 directories deep. Example: >
4467 :set path=/home/user_x/src/**
4468< means search in the whole subtree under "/home/usr_x/src".
4469 3) If the path ends with a ';', this path is the startpoint
4470 for upward search.
4471 See |file-searching| for more info and exact syntax.
4472 {not available when compiled without the |+path_extra| feature}
4473 - Careful with '\' characters, type two to get one in the option: >
4474 :set path=.,c:\\include
4475< Or just use '/' instead: >
4476 :set path=.,c:/include
4477< Don't forget "." or files won't even be found in the same directory as
4478 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004479 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 it is something like 256 or 1024 characters.
4481 You can check if all the include files are found, using the value of
4482 'path', see |:checkpath|.
4483 The use of |:set+=| and |:set-=| is preferred when adding or removing
4484 directories from the list. This avoids problems when a future version
4485 uses another default. To remove the current directory use: >
4486 :set path-=
4487< To add the current directory use: >
4488 :set path+=
4489< To use an environment variable, you probably need to replace the
4490 separator. Here is an example to append $INCL, in which directory
4491 names are separated with a semi-colon: >
4492 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4493< Replace the ';' with a ':' or whatever separator is used. Note that
4494 this doesn't work when $INCL contains a comma or white space.
4495
4496 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4497'preserveindent' 'pi' boolean (default off)
4498 local to buffer
4499 {not in Vi}
4500 When changing the indent of the current line, preserve as much of the
4501 indent structure as possible. Normally the indent is replaced by a
4502 series of tabs followed by spaces as required (unless |'expandtab'| is
4503 enabled, in which case only spaces are used). Enabling this option
4504 means the indent will preserve as many existing characters as possible
4505 for indenting, and only add additional tabs or spaces as required.
4506 NOTE: When using ">>" multiple times the resulting indent is a mix of
4507 tabs and spaces. You might not like this.
4508 NOTE: 'preserveindent' is reset when 'compatible' is set.
4509 Also see 'copyindent'.
4510 Use |:retab| to clean up white space.
4511
4512 *'previewheight'* *'pvh'*
4513'previewheight' 'pvh' number (default 12)
4514 global
4515 {not in Vi}
4516 {not available when compiled without the |+windows| or
4517 |+quickfix| feature}
4518 Default height for a preview window. Used for |:ptag| and associated
4519 commands. Used for |CTRL-W_}| when no count is given.
4520
4521 *'previewwindow'* *'nopreviewwindow'*
4522 *'pvw'* *'nopvw'* *E590*
4523'previewwindow' 'pvw' boolean (default off)
4524 local to window
4525 {not in Vi}
4526 {not available when compiled without the |+windows| or
4527 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004528 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 set. It's normally not set directly, but by using one of the commands
4530 |:ptag|, |:pedit|, etc.
4531
4532 *'printdevice'* *'pdev'*
4533'printdevice' 'pdev' string (default empty)
4534 global
4535 {not in Vi}
4536 {only available when compiled with the |+printer|
4537 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004538 The name of the printer to be used for |:hardcopy|.
4539 See |pdev-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
Bram Moolenaar8299df92004-07-10 09:47:34 +00004541 *'printencoding'* *'penc'*
4542'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 global
4544 {not in Vi}
4545 {only available when compiled with the |+printer|
4546 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004547 Sets the character encoding used when printing.
4548 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549
4550 *'printexpr'* *'pexpr'*
4551'printexpr' 'pexpr' String (default: see below)
4552 global
4553 {not in Vi}
4554 {only available when compiled with the |+printer|
4555 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004556 Expression used to print the PostScript produced with |:hardcopy|.
4557 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
Bram Moolenaar8299df92004-07-10 09:47:34 +00004559 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560'printfont' 'pfn' string (default "courier")
4561 global
4562 {not in Vi}
4563 {only available when compiled with the |+printer|
4564 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004565 The name of the font that will be used for |:hardcopy|.
4566 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
4568 *'printheader'* *'pheader'*
4569'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4570 global
4571 {not in Vi}
4572 {only available when compiled with the |+printer|
4573 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004574 The format of the header produced in |:hardcopy| output.
4575 See |pheader-option|.
4576
4577 *'printmbcharset'* *'pmbcs'*
4578'printmbcharset' 'pmbcs' string (default "")
4579 global
4580 {not in Vi}
4581 {only available when compiled with the |+printer|
4582 and |+multi_byte| features}
4583 The CJK character set to be used for CJK output from |:hardcopy|.
4584 See |pmbcs-option|.
4585
4586 *'printmbfont'* *'pmbfn'*
4587'printmbfont' 'pmbfn' string (default "")
4588 global
4589 {not in Vi}
4590 {only available when compiled with the |+printer|
4591 and |+multi_byte| features}
4592 List of font names to be used for CJK output from |:hardcopy|.
4593 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594
4595 *'printoptions'* *'popt'*
4596'printoptions' 'popt' string (default "")
4597 global
4598 {not in Vi}
4599 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004600 List of items that control the format of the output of |:hardcopy|.
4601 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004603 *'quoteescape''* *'qe'*
4604'quoteescape' 'qe' string (default "\")
4605 local to buffer
4606 {not in Vi}
4607 The characters that are used to escape quotes in a string. Used for
4608 objects like a', a" and a` |a'|.
4609 When one of the characters in this option is found inside a string,
4610 the following character will be skipped. The default value makes the
4611 text "foo\"bar\\" considered to be one string.
4612
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4614'readonly' 'ro' boolean (default off)
4615 local to buffer
4616 If on, writes fail unless you use a '!'. Protects you from
4617 accidentally overwriting a file. Default on when Vim is started
4618 in read-only mode ("vim -R") or when the executable is called "view".
4619 {not in Vi:} When using the ":view" command the 'readonly' option is
4620 set for the newly edited buffer. When using ":w!" the 'readonly'
4621 option is reset for the current buffer.
4622
4623 *'remap'* *'noremap'*
4624'remap' boolean (default on)
4625 global
4626 Allows for mappings to work recursively. If you do not want this for
4627 a single entry, use the :noremap[!] command.
4628
4629 *'report'*
4630'report' number (default 2)
4631 global
4632 Threshold for reporting number of lines changed. When the number of
4633 changed lines is more than 'report' a message will be given for most
4634 ":" commands. If you want it always, set 'report' to 0.
4635 For the ":substitute" command the number of substitutions is used
4636 instead of the number of lines.
4637
4638 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4639'restorescreen' 'rs' boolean (default on)
4640 global
4641 {not in Vi} {only in Windows 95/NT console version}
4642 When set, the screen contents is restored when exiting Vim. This also
4643 happens when executing external commands.
4644
4645 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4646 options in your .vimrc. To disable restoring:
4647 set t_ti= t_te=
4648 To enable restoring (for an xterm):
4649 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4650 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4651
4652 *'revins'* *'ri'* *'norevins'* *'nori'*
4653'revins' 'ri' boolean (default off)
4654 global
4655 {not in Vi}
4656 {only available when compiled with the |+rightleft|
4657 feature}
4658 Inserting characters in Insert mode will work backwards. See "typing
4659 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4660 command in Insert mode, when 'allowrevins' is set.
4661 NOTE: This option is reset when 'compatible' or 'paste' is set.
4662
4663 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4664'rightleft' 'rl' boolean (default off)
4665 local to window
4666 {not in Vi}
4667 {only available when compiled with the |+rightleft|
4668 feature}
4669 When on, display orientation becomes right-to-left, i.e., characters
4670 that are stored in the file appear from the right to the left.
4671 Using this option, it is possible to edit files for languages that
4672 are written from the right to the left such as Hebrew and Arabic.
4673 This option is per window, so it is possible to edit mixed files
4674 simultaneously, or to view the same file in both ways (this is
4675 useful whenever you have a mixed text file with both right-to-left
4676 and left-to-right strings so that both sets are displayed properly
4677 in different windows). Also see |rileft.txt|.
4678
4679 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4680'rightleftcmd' 'rlc' string (default "search")
4681 local to window
4682 {not in Vi}
4683 {only available when compiled with the |+rightleft|
4684 feature}
4685 Each word in this option enables the command line editing to work in
4686 right-to-left mode for a group of commands:
4687
4688 search "/" and "?" commands
4689
4690 This is useful for languages such as Hebrew, Arabic and Farsi.
4691 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4692
4693 *'ruler'* *'ru'* *'noruler'* *'noru'*
4694'ruler' 'ru' boolean (default off)
4695 global
4696 {not in Vi}
4697 {not available when compiled without the
4698 |+cmdline_info| feature}
4699 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004700 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 text in the file is shown on the far right:
4702 Top first line is visible
4703 Bot last line is visible
4704 All first and last line are visible
4705 45% relative position in the file
4706 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004707 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 ruler is shown there. Otherwise it is shown in the last line of the
4709 screen. If the statusline is given by 'statusline' (ie. not empty),
4710 this option takes precedence over 'ruler' and 'rulerformat'
4711 If the number of characters displayed is different from the number of
4712 bytes in the text (e.g., for a TAB or a multi-byte character), both
4713 the text column (byte number) and the screen column are shown,
4714 separated with a dash.
4715 For an empty line "0-1" is shown.
4716 For an empty buffer the line number will also be zero: "0,0-1".
4717 This option is reset when the 'paste' option is set.
4718 If you don't want to see the ruler all the time but want to know where
4719 you are, use "g CTRL-G" |g_CTRL-G|.
4720 NOTE: This option is reset when 'compatible' is set.
4721
4722 *'rulerformat'* *'ruf'*
4723'rulerformat' 'ruf' string (default empty)
4724 global
4725 {not in Vi}
4726 {not available when compiled without the |+statusline|
4727 feature}
4728 When this option is not empty, it determines the content of the ruler
4729 string, as displayed for the 'ruler' option.
4730 The format of this option, is like that of 'statusline'.
4731 The default ruler width is 17 characters. To make the ruler 15
4732 characters wide, put "%15(" at the start and "%)" at the end.
4733 Example: >
4734 :set rulerformat=%15(%c%V\ %p%%%)
4735<
4736 *'runtimepath'* *'rtp'* *vimfiles*
4737'runtimepath' 'rtp' string (default:
4738 Unix: "$HOME/.vim,
4739 $VIM/vimfiles,
4740 $VIMRUNTIME,
4741 $VIM/vimfiles/after,
4742 $HOME/.vim/after"
4743 Amiga: "home:vimfiles,
4744 $VIM/vimfiles,
4745 $VIMRUNTIME,
4746 $VIM/vimfiles/after,
4747 home:vimfiles/after"
4748 PC, OS/2: "$HOME/vimfiles,
4749 $VIM/vimfiles,
4750 $VIMRUNTIME,
4751 $VIM/vimfiles/after,
4752 $HOME/vimfiles/after"
4753 Macintosh: "$VIM:vimfiles,
4754 $VIMRUNTIME,
4755 $VIM:vimfiles:after"
4756 RISC-OS: "Choices:vimfiles,
4757 $VIMRUNTIME,
4758 Choices:vimfiles/after"
4759 VMS: "sys$login:vimfiles,
4760 $VIM/vimfiles,
4761 $VIMRUNTIME,
4762 $VIM/vimfiles/after,
4763 sys$login:vimfiles/after"
4764 global
4765 {not in Vi}
4766 This is a list of directories which will be searched for runtime
4767 files:
4768 filetype.vim filetypes by file name |new-filetype|
4769 scripts.vim filetypes by file contents |new-filetype-scripts|
4770 colors/ color scheme files |:colorscheme|
4771 compiler/ compiler files |:compiler|
4772 doc/ documentation |write-local-help|
4773 ftplugin/ filetype plugins |write-filetype-plugin|
4774 indent/ indent scripts |indent-expression|
4775 keymap/ key mapping files |mbyte-keymap|
4776 lang/ menu translations |:menutrans|
4777 menu.vim GUI menus |menu.vim|
4778 plugin/ plugin scripts |write-plugin|
4779 print/ files for printing |postscript-print-encoding|
4780 syntax/ syntax files |mysyntaxfile|
4781 tutor/ files for vimtutor |tutor|
4782
4783 And any other file searched for with the |:runtime| command.
4784
4785 The defaults for most systems are setup to search five locations:
4786 1. In your home directory, for your personal preferences.
4787 2. In a system-wide Vim directory, for preferences from the system
4788 administrator.
4789 3. In $VIMRUNTIME, for files distributed with Vim.
4790 *after-directory*
4791 4. In the "after" directory in the system-wide Vim directory. This is
4792 for the system administrator to overrule or add to the distributed
4793 defaults (rarely needed)
4794 5. In the "after" directory in your home directory. This is for
4795 personal preferences to overrule or add to the distributed defaults
4796 or system-wide settings (rarely needed).
4797
4798 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4799 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004800 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 wildcards.
4802 See |:runtime|.
4803 Example: >
4804 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4805< This will use the directory "~/vimruntime" first (containing your
4806 personal Vim runtime files), then "/mygroup/vim" (shared between a
4807 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4808 files).
4809 You probably should always include $VIMRUNTIME somewhere, to use the
4810 distributed runtime files. You can put a directory before $VIMRUNTIME
4811 to find files which replace a distributed runtime files. You can put
4812 a directory after $VIMRUNTIME to find files which add to distributed
4813 runtime files.
4814 This option cannot be set from a |modeline| or in the |sandbox|, for
4815 security reasons.
4816
4817 *'scroll'* *'scr'*
4818'scroll' 'scr' number (default: half the window height)
4819 local to window
4820 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4821 set to half the number of lines in the window when the window size
4822 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004823 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4825 the number of screen lines instead of file lines, makes a difference
4826 when lines wrap}
4827
4828 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4829'scrollbind' 'scb' boolean (default off)
4830 local to window
4831 {not in Vi}
4832 {not available when compiled without the |+scrollbind|
4833 feature}
4834 See also |scroll-binding|. When this option is set, the current
4835 window scrolls as other scrollbind windows (windows that also have
4836 this option set) scroll. This option is useful for viewing the
4837 differences between two versions of a file, see 'diff'.
4838 See |'scrollopt'| for options that determine how this option should be
4839 interpreted.
4840 This option is mostly reset when splitting a window to edit another
4841 file. This means that ":split | edit file" results in two windows
4842 with scroll-binding, but ":split file" does not.
4843
4844 *'scrolljump'* *'sj'*
4845'scrolljump' 'sj' number (default 1)
4846 global
4847 {not in Vi}
4848 Minimal number of lines to scroll when the cursor gets off the
4849 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4850 CTRL-D). Useful if your terminal scrolls very slowly.
4851 NOTE: This option is set to 1 when 'compatible' is set.
4852
4853 *'scrolloff'* *'so'*
4854'scrolloff' 'so' number (default 0)
4855 global
4856 {not in Vi}
4857 Minimal number of screen lines to keep above and below the cursor.
4858 This will make some context visible around where you are working. If
4859 you set it to a very large value (999) the cursor line will always be
4860 in the middle of the window (except at the start or end of the file or
4861 when long lines wrap).
4862 For scrolling horizontally see 'sidescrolloff'.
4863 NOTE: This option is set to 0 when 'compatible' is set.
4864
4865 *'scrollopt'* *'sbo'*
4866'scrollopt' 'sbo' string (default "ver,jump")
4867 global
4868 {not available when compiled without the |+scrollbind|
4869 feature}
4870 {not in Vi}
4871 This is a comma-separated list of words that specifies how
4872 'scrollbind' windows should behave.
4873 The following words are available:
4874 ver Bind vertical scrolling for 'scrollbind' windows
4875 hor Bind horizontal scrolling for 'scrollbind' windows
4876 jump Applies to the offset between two windows for vertical
4877 scrolling. This offset is the difference in the first
4878 displayed line of the bound windows. When moving
4879 around in a window, another 'scrollbind' window may
4880 reach a position before the start or after the end of
4881 the buffer. The offset is not changed though, when
4882 moving back the 'scrollbind' window will try to scroll
4883 to the desired position when possible.
4884 When now making that window the current one, two
4885 things can be done with the relative offset:
4886 1. When "jump" is not included, the relative offset is
4887 adjusted for the scroll position in the new current
4888 window. When going back to the other window, the
4889 the new relative offset will be used.
4890 2. When "jump" is included, the other windows are
4891 scrolled to keep the same relative offset. When
4892 going back to the other window, it still uses the
4893 same relative offset.
4894 Also see |scroll-binding|.
4895
4896 *'sections'* *'sect'*
4897'sections' 'sect' string (default "SHNHH HUnhsh")
4898 global
4899 Specifies the nroff macros that separate sections. These are pairs of
4900 two letters (See |object-motions|). The default makes a section start
4901 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
4902
4903 *'secure'* *'nosecure'* *E523*
4904'secure' boolean (default off)
4905 global
4906 {not in Vi}
4907 When on, ":autocmd", shell and write commands are not allowed in
4908 ".vimrc" and ".exrc" in the current directory and map commands are
4909 displayed. Switch it off only if you know that you will not run into
4910 problems, or when the 'exrc' option is off. On Unix this option is
4911 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004912 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 'secure' at the end of your ~/.vimrc then.
4914 This option cannot be set from a |modeline| or in the |sandbox|, for
4915 security reasons.
4916
4917 *'selection'* *'sel'*
4918'selection' 'sel' string (default "inclusive")
4919 global
4920 {not in Vi}
4921 This option defines the behavior of the selection. It is only used
4922 in Visual and Select mode.
4923 Possible values:
4924 value past line inclusive ~
4925 old no yes
4926 inclusive yes yes
4927 exclusive yes no
4928 "past line" means that the cursor is allowed to be positioned one
4929 character past the line.
4930 "inclusive" means that the last character of the selection is included
4931 in an operation. For example, when "x" is used to delete the
4932 selection.
4933 Note that when "exclusive" is used and selecting from the end
4934 backwards, you cannot include the last character of a line, when
4935 starting in Normal mode and 'virtualedit' empty.
4936
4937 The 'selection' option is set by the |:behave| command.
4938
4939 *'selectmode'* *'slm'*
4940'selectmode' 'slm' string (default "")
4941 global
4942 {not in Vi}
4943 This is a comma separated list of words, which specifies when to start
4944 Select mode instead of Visual mode, when a selection is started.
4945 Possible values:
4946 mouse when using the mouse
4947 key when using shifted special keys
4948 cmd when using "v", "V" or CTRL-V
4949 See |Select-mode|.
4950 The 'selectmode' option is set by the |:behave| command.
4951
4952 *'sessionoptions'* *'ssop'*
4953'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
4954 help,options,winsize")
4955 global
4956 {not in Vi}
4957 {not available when compiled without the +mksession
4958 feature}
4959 Changes the effect of the |:mksession| command. It is a comma
4960 separated list of words. Each word enables saving and restoring
4961 something:
4962 word save and restore ~
4963 blank empty windows
4964 buffers hidden and unloaded buffers, not just those in windows
4965 curdir the current directory
4966 folds manually created folds, opened/closed folds and local
4967 fold options
4968 globals global variables that start with an uppercase letter
4969 and contain at least one lowercase letter.
4970 help the help window
4971 localoptions options and mappings local to a window or buffer (not
4972 global values for local options)
4973 options all options and mappings (also global values for local
4974 options)
4975 resize size of the Vim window: 'lines' and 'columns'
4976 sesdir the directory in which the session file is located
4977 will become the current directory (useful with
4978 projects accessed over a network from different
4979 systems)
4980 slash backslashes in file names replaced with forward
4981 slashes
4982 unix with Unix end-of-line format (single <NL>), even when
4983 on Windows or DOS
4984 winpos position of the whole Vim window
4985 winsize window sizes
4986
4987 Don't include both "curdir" and "sesdir".
4988 When "curdir" nor "sesdir" is included, file names are stored with
4989 absolute paths.
4990 "slash" and "unix" are useful on Windows when sharing session files
4991 with Unix. The Unix version of Vim cannot source dos format scripts,
4992 but the Windows version of Vim can source unix format scripts.
4993
4994 *'shell'* *'sh'* *E91*
4995'shell' 'sh' string (default $SHELL or "sh",
4996 MS-DOS and Win32: "command.com" or
4997 "cmd.exe", OS/2: "cmd")
4998 global
4999 Name of the shell to use for ! and :! commands. When changing the
5000 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5001 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005002 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 See |option-backslash| about including spaces and backslashes.
5004 Environment variables are expanded |:set_env|.
5005 If the name of the shell contains a space, you might need to enclose
5006 it in quotes. Example: >
5007 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5008< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005009 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 "-f" is not inside the quotes, because it is not part of the command
5011 name. And Vim automagically recognizes the backslashes that are path
5012 separators.
5013 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5014 variable to change the way external commands are executed. See the
5015 libc.inf file of DJGPP.
5016 Under MS-Windows, when the executable ends in ".com" it must be
5017 included. Thus setting the shell to "command.com" or "4dos.com"
5018 works, but "command" and "4dos" do not work for all commands (e.g.,
5019 filtering).
5020 For unknown reasons, when using "4dos.com" the current directory is
5021 changed to "C:\". To avoid this set 'shell' like this: >
5022 :set shell=command.com\ /c\ 4dos
5023< This option cannot be set from a |modeline| or in the |sandbox|, for
5024 security reasons.
5025
5026 *'shellcmdflag'* *'shcf'*
5027'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5028 does not contain "sh" somewhere: "/c")
5029 global
5030 {not in Vi}
5031 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5032 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5033 systems, the default is set according to the value of 'shell', to
5034 reduce the need to set this option by the user. It's not used for
5035 OS/2 (EMX figures this out itself). See |option-backslash| about
5036 including spaces and backslashes. See |dos-shell|.
5037 This option cannot be set from a |modeline| or in the |sandbox|, for
5038 security reasons.
5039
5040 *'shellpipe'* *'sp'*
5041'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5042 global
5043 {not in Vi}
5044 {not available when compiled without the |+quickfix|
5045 feature}
5046 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005047 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048 including spaces and backslashes.
5049 The name of the temporary file can be represented by "%s" if necessary
5050 (the file name is appended automatically if no %s appears in the value
5051 of this option).
5052 For the Amiga and MS-DOS the default is ">". The output is directly
5053 saved in a file and not echoed to the screen.
5054 For Unix the default it "| tee". The stdout of the compiler is saved
5055 in a file and echoed to the screen. If the 'shell' option is "csh" or
5056 "tcsh" after initializations, the default becomes "|& tee". If the
5057 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5058 "2>&1| tee". This means that stderr is also included.
5059 The initialization of this option is done after reading the ".vimrc"
5060 and the other initializations, so that when the 'shell' option is set
5061 there, the 'shellpipe' option changes automatically, unless it was
5062 explicitly set before.
5063 When 'shellpipe' is set to an empty string, no redirection of the
5064 ":make" output will be done. This is useful if you use a 'makeprg'
5065 that writes to 'makeef' by itself. If you want no piping, but do
5066 want to include the 'makeef', set 'shellpipe' to a single space.
5067 Don't forget to precede the space with a backslash: ":set sp=\ ".
5068 In the future pipes may be used for filtering and this option will
5069 become obsolete (at least for Unix).
5070 This option cannot be set from a |modeline| or in the |sandbox|, for
5071 security reasons.
5072
5073 *'shellquote'* *'shq'*
5074'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5075 contains "sh" somewhere: "\"")
5076 global
5077 {not in Vi}
5078 Quoting character(s), put around the command passed to the shell, for
5079 the "!" and ":!" commands. The redirection is kept outside of the
5080 quoting. See 'shellxquote' to include the redirection. It's
5081 probably not useful to set both options.
5082 This is an empty string by default. Only known to be useful for
5083 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5084 or bash, where it should be "\"". The default is adjusted according
5085 the value of 'shell', to reduce the need to set this option by the
5086 user. See |dos-shell|.
5087 This option cannot be set from a |modeline| or in the |sandbox|, for
5088 security reasons.
5089
5090 *'shellredir'* *'srr'*
5091'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5092 global
5093 {not in Vi}
5094 String to be used to put the output of a filter command in a temporary
5095 file. See also |:!|. See |option-backslash| about including spaces
5096 and backslashes.
5097 The name of the temporary file can be represented by "%s" if necessary
5098 (the file name is appended automatically if no %s appears in the value
5099 of this option).
5100 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5101 or "zsh" during initializations, the default becomes ">&". If the
5102 'shell' option is "sh", "ksh" or "bash" the default becomes
5103 ">%s 2>&1". This means that stderr is also included.
5104 For Win32, the Unix checks are done and additionally "cmd" is checked
5105 for, which makes the default ">%s 2>&1". Also, the same names with
5106 ".exe" appended are checked for.
5107 The initialization of this option is done after reading the ".vimrc"
5108 and the other initializations, so that when the 'shell' option is set
5109 there, the 'shellredir' option changes automatically unless it was
5110 explicitly set before.
5111 In the future pipes may be used for filtering and this option will
5112 become obsolete (at least for Unix).
5113 This option cannot be set from a |modeline| or in the |sandbox|, for
5114 security reasons.
5115
5116 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5117'shellslash' 'ssl' boolean (default off)
5118 global
5119 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5120 When set, a forward slash is used when expanding file names. This is
5121 useful when a Unix-like shell is used instead of command.com or
5122 cmd.exe. Backward slashes can still be typed, but they are changed to
5123 forward slashes by Vim.
5124 Note that setting or resetting this option has no effect for some
5125 existing file names, thus this option needs to be set before opening
5126 any file for best results. This might change in the future.
5127 'shellslash' only works when a backslash can be used as a path
5128 separator. To test if this is so use: >
5129 if exists('+shellslash')
5130<
5131 *'shelltype'* *'st'*
5132'shelltype' 'st' number (default 0)
5133 global
5134 {not in Vi} {only for the Amiga}
5135 On the Amiga this option influences the way how the commands work
5136 which use a shell.
5137 0 and 1: always use the shell
5138 2 and 3: use the shell only to filter lines
5139 4 and 5: use shell only for ':sh' command
5140 When not using the shell, the command is executed directly.
5141
5142 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5143 1 and 3: use "shell cmd" to start external commands
5144
5145 *'shellxquote'* *'sxq'*
5146'shellxquote' 'sxq' string (default: "";
5147 for Win32, when 'shell' contains "sh"
5148 somewhere: "\""
5149 for Unix, when using system(): "\"")
5150 global
5151 {not in Vi}
5152 Quoting character(s), put around the command passed to the shell, for
5153 the "!" and ":!" commands. Includes the redirection. See
5154 'shellquote' to exclude the redirection. It's probably not useful
5155 to set both options.
5156 This is an empty string by default. Known to be useful for
5157 third-party shells when using the Win32 version, such as the MKS Korn
5158 Shell or bash, where it should be "\"". The default is adjusted
5159 according the value of 'shell', to reduce the need to set this option
5160 by the user. See |dos-shell|.
5161 This option cannot be set from a |modeline| or in the |sandbox|, for
5162 security reasons.
5163
5164 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5165'shiftround' 'sr' boolean (default off)
5166 global
5167 {not in Vi}
5168 Round indent to multiple of 'shiftwidth'. Applies to > and <
5169 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5170 a multiple of 'shiftwidth' (this is Vi compatible).
5171 NOTE: This option is reset when 'compatible' is set.
5172
5173 *'shiftwidth'* *'sw'*
5174'shiftwidth' 'sw' number (default 8)
5175 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005176 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 |'cindent'|, |>>|, |<<|, etc.
5178
5179 *'shortmess'* *'shm'*
5180'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "")
5181 global
5182 {not in Vi}
5183 This option helps to avoid all the |hit-enter| prompts caused by file
5184 messages, for example with CTRL-G, and to avoid some other messages.
5185 It is a list of flags:
5186 flag meaning when present ~
5187 f use "(3 of 5)" instead of "(file 3 of 5)"
5188 i use "[noeol]" instead of "[Incomplete last line]"
5189 l use "999L, 888C" instead of "999 lines, 888 characters"
5190 m use "[+]" instead of "[Modified]"
5191 n use "[New]" instead of "[New File]"
5192 r use "[RO]" instead of "[readonly]"
5193 w use "[w]" instead of "written" for file write message
5194 and "[a]" instead of "appended" for ':w >> file' command
5195 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5196 "[unix format]" and "[mac]" instead of "[mac format]".
5197 a all of the above abbreviations
5198
5199 o overwrite message for writing a file with subsequent message
5200 for reading a file (useful for ":wn" or when 'autowrite' on)
5201 O message for reading a file overwrites any previous message.
5202 Also for quickfix message (e.g., ":cn").
5203 s don't give "search hit BOTTOM, continuing at TOP" or "search
5204 hit TOP, continuing at BOTTOM" messages
5205 t truncate file message at the start if it is too long to fit
5206 on the command-line, "<" will appear in the left most column.
5207 Ignored in Ex mode.
5208 T truncate other messages in the middle if they are too long to
5209 fit on the command line. "..." will appear in the middle.
5210 Ignored in Ex mode.
5211 W don't give "written" or "[w]" when writing a file
5212 A don't give the "ATTENTION" message when an existing swap file
5213 is found.
5214 I don't give the intro message when starting Vim |:intro|.
5215
5216 This gives you the opportunity to avoid that a change between buffers
5217 requires you to hit <Enter>, but still gives as useful a message as
5218 possible for the space available. To get the whole message that you
5219 would have got with 'shm' empty, use ":file!"
5220 Useful values:
5221 shm= No abbreviation of message.
5222 shm=a Abbreviation, but no loss of information.
5223 shm=at Abbreviation, and truncate message when necessary.
5224
5225 NOTE: This option is set to the Vi default value when 'compatible' is
5226 set and to the Vim default value when 'compatible' is reset.
5227
5228 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5229'shortname' 'sn' boolean (default off)
5230 local to buffer
5231 {not in Vi, not in MS-DOS versions}
5232 Filenames are assumed to be 8 characters plus one extension of 3
5233 characters. Multiple dots in file names are not allowed. When this
5234 option is on, dots in file names are replaced with underscores when
5235 adding an extension (".~" or ".swp"). This option is not available
5236 for MS-DOS, because then it would always be on. This option is useful
5237 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5238 or crossdos. When running the Win32 GUI version under Win32s, this
5239 option is always on by default.
5240
5241 *'showbreak'* *'sbr'* *E595*
5242'showbreak' 'sbr' string (default "")
5243 global
5244 {not in Vi}
5245 {not available when compiled without the |+linebreak|
5246 feature}
5247 String to put at the start of lines that have been wrapped. Useful
5248 values are "> " or "+++ ".
5249 Only printable single-cell characters are allowed, excluding <Tab> and
5250 comma (in a future version the comma might be used to separate the
5251 part that is shown at the end and at the start of a line).
5252 The characters are highlighted according to the '@' flag in
5253 'highlight'.
5254 Note that tabs after the showbreak will be displayed differently.
5255 If you want the 'showbreak' to appear in between line numbers, add the
5256 "n" flag to 'cpoptions'.
5257
5258 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5259'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5260 off)
5261 global
5262 {not in Vi}
5263 {not available when compiled without the
5264 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005265 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005266 terminal is slow.
5267 In Visual mode the size of the selected area is shown:
5268 - When selecting characters within a line, the number of characters.
5269 - When selecting more than one line, the number of lines.
5270 - When selecting a block, the size in screen characters: linesxcolumns.
5271 NOTE: This option is set to the Vi default value when 'compatible' is
5272 set and to the Vim default value when 'compatible' is reset.
5273
5274 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5275'showfulltag' 'sft' boolean (default off)
5276 global
5277 {not in Vi}
5278 When completing a word in insert mode (see |ins-completion|) from the
5279 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005280 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005281 matched a C function, you can see a template for what arguments are
5282 required (coding style permitting).
5283
5284 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5285'showmatch' 'sm' boolean (default off)
5286 global
5287 When a bracket is inserted, briefly jump to the matching one. The
5288 jump is only done if the match can be seen on the screen. The time to
5289 show the match can be set with 'matchtime'.
5290 A Beep is given if there is no match (no matter if the match can be
5291 seen or not). This option is reset when the 'paste' option is set.
5292 When the 'm' flag is not included in 'cpoptions', typing a character
5293 will immediately move the cursor back to where it belongs.
5294 See the "sm" field in 'guicursor' for setting the cursor shape and
5295 blinking when showing the match.
5296 The 'matchpairs' option can be used to specify the characters to show
5297 matches for. 'rightleft' and 'revins' are used to look for opposite
5298 matches.
5299 Note: For the use of the short form parental guidance is advised.
5300
5301 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5302'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5303 global
5304 If in Insert, Replace or Visual mode put a message on the last line.
5305 Use the 'M' flag in 'highlight' to set the type of highlighting for
5306 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005307 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 doesn't mean XIM is really active, especially when 'imactivatekey' is
5309 not set.
5310 NOTE: This option is set to the Vi default value when 'compatible' is
5311 set and to the Vim default value when 'compatible' is reset.
5312
5313 *'sidescroll'* *'ss'*
5314'sidescroll' 'ss' number (default 0)
5315 global
5316 {not in Vi}
5317 The minimal number of columns to scroll horizontally. Used only when
5318 the 'wrap' option is off and the cursor is moved off of the screen.
5319 When it is zero the cursor will be put in the middle of the screen.
5320 When using a slow terminal set it to a large number or 0. When using
5321 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5322 commands.
5323
5324 *'sidescrolloff'* *'siso'*
5325'sidescrolloff' 'siso' number (default 0)
5326 global
5327 {not in Vi}
5328 The minimal number of screen columns to keep to the left and to the
5329 right of the cursor if 'nowrap' is set. Setting this option to a value
5330 greater than 0 while having |'sidescroll'| also at a non-zero value
5331 makes some context visible in the line you are scrolling in
5332 horizontally (except at the end and beginning of the line). Setting
5333 this option to a large value (like 999) has the effect of keeping the
5334 cursor horizontally centered in the window, as long as one does not
5335 come too close to the beginning or end of the line.
5336 NOTE: This option is set to 0 when 'compatible' is set.
5337
5338 Example: Try this together with 'sidescroll' and 'listchars' as
5339 in the following example to never allow the cursor to move
5340 onto the "extends" character:
5341
5342 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5343 :set sidescrolloff=1
5344
5345
5346 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5347'smartcase' 'scs' boolean (default off)
5348 global
5349 {not in Vi}
5350 Override the 'ignorecase' option if the search pattern contains upper
5351 case characters. Only used when the search pattern is typed and
5352 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005353 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5355 recalling the search pattern from history and hitting <Enter>.
5356 NOTE: This option is reset when 'compatible' is set.
5357
5358 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5359'smartindent' 'si' boolean (default off)
5360 local to buffer
5361 {not in Vi}
5362 {not available when compiled without the
5363 |+smartindent| feature}
5364 Do smart autoindenting when starting a new line. Works for C-like
5365 programs, but can also be used for other languages. 'cindent' does
5366 something like this, works better in most cases, but is more strict,
5367 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5368 'indentexpr' is a more advanced alternative.
5369 Normally 'autoindent' should also be on when using 'smartindent'.
5370 An indent is automatically inserted:
5371 - After a line ending in '{'.
5372 - After a line starting with a keyword from 'cinwords'.
5373 - Before a line starting with '}' (only with the "O" command).
5374 When typing '}' as the first character in a new line, that line is
5375 given the same indent as the matching '{'.
5376 When typing '#' as the first character in a new line, the indent for
5377 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005378 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5380 When using the ">>" command, lines starting with '#' are not shifted
5381 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005382 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 is set smart indenting is disabled.
5384
5385 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5386'smarttab' 'sta' boolean (default off)
5387 global
5388 {not in Vi}
5389 When on, a <Tab> in front of a line inserts blanks according to
5390 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5391 a 'shiftwidth' worth of space at the start of the line.
5392 When off a <Tab> always inserts blanks according to 'tabstop'.
5393 'shiftwidth' is only used for shifting text left or right
5394 |shift-left-right|.
5395 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5396 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005397 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 NOTE: This option is reset when 'compatible' is set.
5399
5400 *'softtabstop'* *'sts'*
5401'softtabstop' 'sts' number (default 0)
5402 local to buffer
5403 {not in Vi}
5404 Number of spaces that a <Tab> counts for while performing editing
5405 operations, like inserting a <Tab> or using <BS>. It "feels" like
5406 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5407 used. This is useful to keep the 'ts' setting at its standard value
5408 of 8, while being able to edit like it is set to 'sts'. However,
5409 commands like "x" still work on the actual characters.
5410 When 'sts' is zero, this feature is off.
5411 'softtabstop' is set to 0 when the 'paste' option is set.
5412 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5413 spaces is minimized by using <Tab>s.
5414 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5415 set.
5416 NOTE: This option is set to 0 when 'compatible' is set.
5417
5418 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5419'splitbelow' 'sb' boolean (default off)
5420 global
5421 {not in Vi}
5422 {not available when compiled without the +windows
5423 feature}
5424 When on, splitting a window will put the new window below the current
5425 one. |:split|
5426
5427 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5428'splitright' 'spr' boolean (default off)
5429 global
5430 {not in Vi}
5431 {not available when compiled without the +vertsplit
5432 feature}
5433 When on, splitting a window will put the new window right of the
5434 current one. |:vsplit|
5435
5436 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5437'startofline' 'sol' boolean (default on)
5438 global
5439 {not in Vi}
5440 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005441 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005442 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005443 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 with a linewise operator, with "%" with a count and to buffer changing
5445 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5446 only has a line number, e.g., ":25" or ":+".
5447 In case of buffer changing commands the cursor is placed at the column
5448 where it was the last time the buffer was edited.
5449 NOTE: This option is set when 'compatible' is set.
5450
5451 *'statusline'* *'stl'* *E540* *E541* *E542*
5452'statusline' 'stl' string (default empty)
5453 global
5454 {not in Vi}
5455 {not available when compiled without the |+statusline|
5456 feature}
5457 When nonempty, this option determines the content of the status line.
5458 Also see |status-line|.
5459
5460 The option consists of printf style '%' items interspersed with
5461 normal text. Each status line item is of the form:
5462 %-0{minwid}.{maxwid}{item}
5463 All fields except the {item} is optional. A single percent sign can
5464 be given as "%%". Up to 80 items can be specified.
5465
5466 Note that the only effect of 'ruler' when this option is set (and
5467 'laststatus' is 2) is controlling the output of |CTRL-G|.
5468
5469 field meaning ~
5470 - Left justify the item. The default is right justified
5471 when minwid is larger than the length of the item.
5472 0 Leading zeroes in numeric items. Overridden by '-'.
5473 minwid Minimum width of the item, padding as set by '-' & '0'.
5474 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005475 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 on the left for text items. Numeric items will be
5477 shifted down to maxwid-2 digits followed by '>'number
5478 where number is the amount of missing digits, much like
5479 an exponential notation.
5480 item A one letter code as described below.
5481
5482 Following is a description of the possible statusline items. The
5483 second character in "item" is the type:
5484 N for number
5485 S for string
5486 F for flags as described below
5487 - not applicable
5488
5489 item meaning ~
5490 f S Path to the file in the buffer, relative to current directory.
5491 F S Full path to the file in the buffer.
5492 t S File name (tail) of file in the buffer.
5493 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5494 M F Modified flag, text is ",+" or ",-".
5495 r F Readonly flag, text is " [RO]".
5496 R F Readonly flag, text is ",RO".
5497 h F Help buffer flag, text is " [help]".
5498 H F Help buffer flag, text is ",HLP".
5499 w F Preview window flag, text is " [Preview]".
5500 W F Preview window flag, text is ",PRV".
5501 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5502 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5503 {not available when compiled without |+autocmd| feature}
5504 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5505 being used: "<keymap>"
5506 n N Buffer number.
5507 b N Value of byte under cursor.
5508 B N As above, in hexadecimal.
5509 o N Byte number in file of byte under cursor, first byte is 1.
5510 Mnemonic: Offset from start of file (with one added)
5511 {not available when compiled without |+byte_offset| feature}
5512 O N As above, in hexadecimal.
5513 N N Printer page number. (Only works in the 'printheader' option.)
5514 l N Line number.
5515 L N Number of lines in buffer.
5516 c N Column number.
5517 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005518 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 p N Percentage through file in lines as in |CTRL-G|.
5520 P S Percentage through file of displayed window. This is like the
5521 percentage described for 'ruler'. Always 3 in length.
5522 a S Argument list status as in default title. ({current} of {max})
5523 Empty if the argument file count is zero or one.
5524 { NF Evaluate expression between '{' and '}' and substitute result.
5525 ( - Start of item group. Can be used for setting the width and
5526 alignment of a section. Must be followed by %) somewhere.
5527 ) - End of item group. No width fields allowed.
5528 < - Where to truncate line if too long. Default is at the start.
5529 No width fields allowed.
5530 = - Separation point between left and right aligned items.
5531 No width fields allowed.
5532 * - Set highlight group to User{N}, where {N} is taken from the
5533 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5534 The difference between User{N} and StatusLine will be applied
5535 to StatusLineNC for the statusline of non-current windows.
5536 The number N must be between 1 and 9. See |hl-User1..9|
5537
5538 Display of flags are controlled by the following heuristic:
5539 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005540 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 with a space it is assumed that it wants to separate itself from
5542 anything but other flags. That is: A leading comma is removed if the
5543 preceding character stems from plaintext. A leading space is removed
5544 if the preceding character stems from another active flag. This will
5545 make a nice display when flags are used like in the examples below.
5546
5547 When all items in a group becomes an empty string (ie. flags that are
5548 not set) and a minwid is not set for the group, the whole group will
5549 become empty. This will make a group like the following disappear
5550 completely from the statusline when none of the flags are set. >
5551 :set statusline=...%(\ [%M%R%H]%)...
5552<
5553 Beware that an expression is evaluated each and every time the status
5554 line is displayed. The current buffer and current window will be set
5555 temporarily to that of the window (and buffer) whose statusline is
5556 currently being drawn. The expression will evaluate in this context.
5557 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5558 real current buffer. The expression is evaluated in the |sandbox|.
5559
5560 If the statusline is not updated when you want it (e.g., after setting
5561 a variable that's used in an expression), you can force an update by
5562 setting an option without changing its value. Example: >
5563 :let &ro = &ro
5564
5565< A result of all digits is regarded a number for display purposes.
5566 Otherwise the result is taken as flag text and applied to the rules
5567 described above.
5568
5569 Watch out for errors in expressions. They may render Vim unusable !
5570 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5571 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5572
5573 Examples:
5574 Emulate standard status line with 'ruler' set >
5575 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5576< Similar, but add ASCII value of char under the cursor (like "ga") >
5577 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5578< Display byte count and byte value, modified flag in red. >
5579 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5580 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5581< Display a ,GZ flag if a compressed file is loaded >
5582 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5583< In the |:autocmd|'s: >
5584 :let b:gzflag = 1
5585< And: >
5586 :unlet b:gzflag
5587< And define this function: >
5588 :function VarExists(var, val)
5589 : if exists(a:var) | return a:val | else | return '' | endif
5590 :endfunction
5591<
5592 *'suffixes'* *'su'*
5593'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5594 global
5595 {not in Vi}
5596 Files with these suffixes get a lower priority when multiple files
5597 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005598 suffixes. Spaces after the comma are ignored. A dot is also seen as
5599 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 separator, precede it with a backslash (see |option-backslash| about
5601 including spaces and backslashes).
5602 See 'wildignore' for completely ignoring files.
5603 The use of |:set+=| and |:set-=| is preferred when adding or removing
5604 suffixes from the list. This avoids problems when a future version
5605 uses another default.
5606
5607 *'suffixesadd'* *'sua'*
5608'suffixesadd' 'sua' string (default "")
5609 local to buffer
5610 {not in Vi}
5611 {not available when compiled without the
5612 |+file_in_path| feature}
5613 Comma separated list of suffixes, which are used when searching for a
5614 file for the "gf", "[I", etc. commands. Example: >
5615 :set suffixesadd=.java
5616<
5617 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5618'swapfile' 'swf' boolean (default on)
5619 local to buffer
5620 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005621 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 swapfile is not wanted for a specific buffer. For example, with
5623 confidential information that even root must not be able to access.
5624 Careful: All text will be in memory:
5625 - Don't use this for big files.
5626 - Recovery will be impossible!
5627 A swapfile will only be present when |'updatecount'| is non-zero and
5628 'swapfile' is set.
5629 When 'swapfile' is reset, the swap file for the current buffer is
5630 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5631 non-zero, a swap file is immediately created.
5632 Also see |swap-file| and |'swapsync'|.
5633
5634 This option is used together with 'bufhidden' and 'buftype' to
5635 specify special kinds of buffers. See |special-buffers|.
5636
5637 *'swapsync'* *'sws'*
5638'swapsync' 'sws' string (default "fsync")
5639 global
5640 {not in Vi}
5641 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005642 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 When this option is empty parts of the swap file may be in memory and
5644 not written to disk. When the system crashes you may lose more work.
5645 On Unix the system does a sync now and then without Vim asking for it,
5646 so the disadvantage of setting this option off is small. On some
5647 systems the swap file will not be written at all. For a unix system
5648 setting it to "sync" will use the sync() call instead of the default
5649 fsync(), which may work better on some systems.
5650
5651 *'switchbuf'* *'swb'*
5652'switchbuf' 'swb' string (default "")
5653 global
5654 {not in Vi}
5655 This option controls the behavior when switching between buffers.
5656 Possible values (comma separated list):
5657 useopen If included, jump to the first open window that
5658 contains the specified buffer (if there is one).
5659 Otherwise: Do not examine other windows.
5660 This setting is checked with |quickfix| commands, when
5661 jumping to errors (":cc", ":cn", "cp", etc.). It is
5662 also used in all buffer related split commands, for
5663 example ":sbuffer", ":sbnext", or ":sbrewind".
5664 split If included, split the current window before loading
5665 a buffer. Otherwise: do not split, use current window.
5666 Supported in |quickfix| commands that display errors.
5667
5668 *'syntax'* *'syn'*
5669'syntax' 'syn' string (default empty)
5670 local to buffer
5671 {not in Vi}
5672 {not available when compiled without the |+syntax|
5673 feature}
5674 When this option is set, the syntax with this name is loaded, unless
5675 syntax highlighting has been switched off with ":syntax off".
5676 Otherwise this option does not always reflect the current syntax (the
5677 b:current_syntax variable does).
5678 This option is most useful in a modeline, for a file which syntax is
5679 not automatically recognized. Example, for in an IDL file: >
5680 /* vim: set syntax=idl : */
5681< To switch off syntax highlighting for the current file, use: >
5682 :set syntax=OFF
5683< To switch syntax highlighting on according to the current value of the
5684 'filetype' option: >
5685 :set syntax=ON
5686< What actually happens when setting the 'syntax' option is that the
5687 Syntax autocommand event is triggered with the value as argument.
5688 This option is not copied to another buffer, independent of the 's' or
5689 'S' flag in 'cpoptions'.
5690
5691 *'tabstop'* *'ts'*
5692'tabstop' 'ts' number (default 8)
5693 local to buffer
5694 Number of spaces that a <Tab> in the file counts for. Also see
5695 |:retab| command, and 'softtabstop' option.
5696
5697 Note: Setting 'tabstop' to any other value than 8 can make your file
5698 appear wrong in many places (e.g., when printing it).
5699
5700 There are four main ways to use tabs in Vim:
5701 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5702 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5703 will use a mix of tabs and spaces, but typing Tab and BS will
5704 behave like a tab appears every 4 (or 3) characters.
5705 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5706 'expandtab'. This way you will always insert spaces. The
5707 formatting will never be messed up when 'tabstop' is changed.
5708 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005709 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 works when using Vim to edit the file.
5711 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5712 'noexpandtab'. This should then work (for initial indents only)
5713 for any tabstop setting that people use. It might be nice to have
5714 tabs after the first non-blank inserted as spaces if you do this
5715 though. Otherwise aligned comments will be wrong when 'tabstop' is
5716 changed.
5717
5718 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5719'tagbsearch' 'tbs' boolean (default on)
5720 global
5721 {not in Vi}
5722 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005723 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 searching makes searching for a tag a LOT faster, but a linear search
5725 will find more tags if the tags file wasn't properly sorted.
5726 Vim normally assumes that your tags files are sorted, or indicate that
5727 they are not sorted. Only when this is not the case does the
5728 'tagbsearch' option need to be switched off.
5729
5730 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005731 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 certain files, or retry all files with a linear search. When
5733 'tagbsearch' is off, only a linear search is done.
5734
5735 Linear searching is done anyway, for one file, when Vim finds a line
5736 at the start of the file indicating that it's not sorted: >
5737 !_TAG_FILE_SORTED 0 /some command/
5738< [The whitespace before and after the '0' must be a single <Tab>]
5739
5740 When a binary search was done and no match was found in any of the
5741 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5742 instead of a normal tag name, a retry is done with a linear search.
5743 Tags in unsorted tags files, and matches with different case will only
5744 be found in the retry.
5745
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005746 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747 linear search can be avoided for the 'ignorecase' case. Use a value
5748 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5749 case-fold sorted with the -f switch to "sort" in most unices, as in
5750 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5751 5.3 or higher the -f or --fold-case-sort switch can be used for this
5752 as well. Note that case must be folded to uppercase for this to work.
5753
5754 When 'tagbsearch' is off, tags searching is slower when a full match
5755 exists, but faster when no full match exists. Tags in unsorted tags
5756 files may only be found with 'tagbsearch' off.
5757 When the tags file is not sorted, or sorted in a wrong way (not on
5758 ASCII byte value), 'tagbsearch' should be off, or the line given above
5759 must be included in the tags file.
5760 This option doesn't affect commands that find all matching tags (e.g.,
5761 command-line completion and ":help").
5762 {Vi: always uses binary search in some versions}
5763
5764 *'taglength'* *'tl'*
5765'taglength' 'tl' number (default 0)
5766 global
5767 If non-zero, tags are significant up to this number of characters.
5768
5769 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5770'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5771 global
5772 {not in Vi}
5773 If on and using a tag file in another directory, file names in that
5774 tag file are relative to the directory where the tag file is.
5775 NOTE: This option is set to the Vi default value when 'compatible' is
5776 set and to the Vim default value when 'compatible' is reset.
5777
5778 *'tags'* *'tag'* *E433*
5779'tags' 'tag' string (default "./tags,tags", when compiled with
5780 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5781 global or local to buffer |global-local|
5782 Filenames for the tag command, separated by spaces or commas. To
5783 include a space or comma in a file name, precede it with a backslash
5784 (see |option-backslash| about including spaces and backslashes).
5785 When a file name starts with "./", the '.' is replaced with the path
5786 of the current file. But only when the 'd' flag is not included in
5787 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5788 |tags-option|.
5789 "*", "**" and other wildcards can be used to search for tags files in
5790 a directory tree. See |file-searching|. {not available when compiled
5791 without the |+path_extra| feature}
5792 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5793 files are also supported. They are automatically recognized. The
5794 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5795 differences are ignored (MS-Windows). |emacs-tags|
5796 The use of |:set+=| and |:set-=| is preferred when adding or removing
5797 file names from the list. This avoids problems when a future version
5798 uses another default.
5799 {Vi: default is "tags /usr/lib/tags"}
5800
5801 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5802'tagstack' 'tgst' boolean (default on)
5803 global
5804 {not in all versions of Vi}
5805 When on, the |tagstack| is used normally. When off, a ":tag" or
5806 ":tselect" command with an argument will not push the tag onto the
5807 tagstack. A following ":tag" without an argument, a ":pop" command or
5808 any other command that uses the tagstack will use the unmodified
5809 tagstack, but does change the pointer to the active entry.
5810 Resetting this option is useful when using a ":tag" command in a
5811 mapping which should not change the tagstack.
5812
5813 *'term'* *E529* *E530* *E531*
5814'term' string (default is $TERM, if that fails:
5815 in the GUI: "builtin_gui"
5816 on Amiga: "amiga"
5817 on BeOS: "beos-ansi"
5818 on Mac: "mac-ansi"
5819 on MiNT: "vt52"
5820 on MS-DOS: "pcterm"
5821 on OS/2: "os2ansi"
5822 on Unix: "ansi"
5823 on VMS: "ansi"
5824 on Win 32: "win32")
5825 global
5826 Name of the terminal. Used for choosing the terminal control
5827 characters. Environment variables are expanded |:set_env|.
5828 For example: >
5829 :set term=$TERM
5830< See |termcap|.
5831
5832 *'termbidi'* *'tbidi'*
5833 *'notermbidi'* *'notbidi'*
5834'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5835 global
5836 {not in Vi}
5837 {only available when compiled with the |+arabic|
5838 feature}
5839 The terminal is in charge of Bi-directionality of text (as specified
5840 by Unicode). The terminal is also expected to do the required shaping
5841 that some languages (such as Arabic) require.
5842 Setting this option implies that 'rightleft' will not be set when
5843 'arabic' is set and the value of 'arabicshape' will be ignored.
5844 Note that setting 'termbidi' has the immediate effect that
5845 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5846 This option is reset when the GUI is started.
5847 For further details see |arabic.txt|.
5848
5849 *'termencoding'* *'tenc'*
5850'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
5851 Macintosh GUI: "macroman")
5852 global
5853 {only available when compiled with the |+multi_byte|
5854 feature}
5855 {not in Vi}
5856 Encoding used for the terminal. This specifies what character
5857 encoding the keyboard produces and the display will understand. For
5858 the GUI it only applies to the keyboard ('encoding' is used for the
5859 display).
5860 In the Win32 console version the default value is the console codepage
5861 when it differs from the ANSI codepage.
5862 *E617*
5863 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
5864 successfully initialized, 'termencoding' is forcibly set to "utf-8".
5865 Any attempts to set a different value will be rejected, and an error
5866 message is shown.
5867 For the Win32 GUI 'termencoding' is not used for typed characters,
5868 because the Win32 system always passes Unicode characters.
5869 When empty, the same encoding is used as for the 'encoding' option.
5870 This is the normal value.
5871 Not all combinations for 'termencoding' and 'encoding' are valid. See
5872 |encoding-table|.
5873 The value for this option must be supported by internal conversions or
5874 iconv(). When this is not possible no conversion will be done and you
5875 will probably experience problems with non-ASCII characters.
5876 Example: You are working with the locale set to euc-jp (Japanese) and
5877 want to edit a UTF-8 file: >
5878 :let &termencoding = &encoding
5879 :set encoding=utf-8
5880< You need to do this when your system has no locale support for UTF-8.
5881
5882 *'terse'* *'noterse'*
5883'terse' boolean (default off)
5884 global
5885 When set: Add 's' flag to 'shortmess' option (this makes the message
5886 for a search that hits the start or end of the file not being
5887 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
5888 shortens a lot of messages}
5889
5890 *'textauto'* *'ta'* *'notextauto'* *'nota'*
5891'textauto' 'ta' boolean (Vim default: on, Vi default: off)
5892 global
5893 {not in Vi}
5894 This option is obsolete. Use 'fileformats'.
5895 For backwards compatibility, when 'textauto' is set, 'fileformats' is
5896 set to the default value for the current system. When 'textauto' is
5897 reset, 'fileformats' is made empty.
5898 NOTE: This option is set to the Vi default value when 'compatible' is
5899 set and to the Vim default value when 'compatible' is reset.
5900
5901 *'textmode'* *'tx'* *'notextmode'* *'notx'*
5902'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
5903 others: default off)
5904 local to buffer
5905 {not in Vi}
5906 This option is obsolete. Use 'fileformat'.
5907 For backwards compatibility, when 'textmode' is set, 'fileformat' is
5908 set to "dos". When 'textmode' is reset, 'fileformat' is set to
5909 "unix".
5910
5911 *'textwidth'* *'tw'*
5912'textwidth' 'tw' number (default 0)
5913 local to buffer
5914 {not in Vi}
5915 Maximum width of text that is being inserted. A longer line will be
5916 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005917 this. 'textwidth' is set to 0 when the 'paste' option is set. When
5918 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 'formatoptions' and |ins-textwidth|.
5920 NOTE: This option is set to 0 when 'compatible' is set.
5921
5922 *'thesaurus'* *'tsr'*
5923'thesaurus' 'tsr' string (default "")
5924 global or local to buffer |global-local|
5925 {not in Vi}
5926 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005927 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005928 the file should contain words with similar meaning, separated by
5929 non-keyword characters (white space is preferred). Maximum line
5930 length is 510 bytes.
5931 To obtain a file to be used here, check out the wordlist FAQ at
5932 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005933 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 after a comma are ignored, otherwise spaces are included in the file
5935 name. See |option-backslash| about using backslashes.
5936 The use of |:set+=| and |:set-=| is preferred when adding or removing
5937 directories from the list. This avoids problems when a future version
5938 uses another default.
5939 Backticks cannot be used in this option for security reasons.
5940
5941 *'tildeop'* *'top'* *'notildeop'* *'notop'*
5942'tildeop' 'top' boolean (default off)
5943 global
5944 {not in Vi}
5945 When on: The tilde command "~" behaves like an operator.
5946 NOTE: This option is reset when 'compatible' is set.
5947
5948 *'timeout'* *'to'* *'notimeout'* *'noto'*
5949'timeout' 'to' boolean (default on)
5950 global
5951 *'ttimeout'* *'nottimeout'*
5952'ttimeout' boolean (default off)
5953 global
5954 {not in Vi}
5955 These two options together determine the behavior when part of a
5956 mapped key sequence or keyboard code has been received:
5957
5958 'timeout' 'ttimeout' action ~
5959 off off do not time out
5960 on on or off time out on :mappings and key codes
5961 off on time out on key codes
5962
5963 If both options are off, Vim will wait until either the complete
5964 mapping or key sequence has been received, or it is clear that there
5965 is no mapping or key sequence for the received characters. For
5966 example: if you have mapped "vl" and Vim has received 'v', the next
5967 character is needed to see if the 'v' is followed by an 'l'.
5968 When one of the options is on, Vim will wait for about 1 second for
5969 the next character to arrive. After that the already received
5970 characters are interpreted as single characters. The waiting time can
5971 be changed with the 'timeoutlen' option.
5972 On slow terminals or very busy systems timing out may cause
5973 malfunctioning cursor keys. If both options are off, Vim waits
5974 forever after an entered <Esc> if there are key codes that start
5975 with <Esc>. You will have to type <Esc> twice. If you do not have
5976 problems with key codes, but would like to have :mapped key
5977 sequences not timing out in 1 second, set the 'ttimeout' option and
5978 reset the 'timeout' option.
5979
5980 NOTE: 'ttimeout' is reset when 'compatible' is set.
5981
5982 *'timeoutlen'* *'tm'*
5983'timeoutlen' 'tm' number (default 1000)
5984 global
5985 {not in all versions of Vi}
5986 *'ttimeoutlen'* *'ttm'*
5987'ttimeoutlen' 'ttm' number (default -1)
5988 global
5989 {not in Vi}
5990 The time in milliseconds that is waited for a key code or mapped key
5991 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
5992 when part of a command has been typed.
5993 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
5994 different timeout value for key codes is desired set 'ttimeoutlen' to
5995 a non-negative number.
5996
5997 ttimeoutlen mapping delay key code delay ~
5998 < 0 'timeoutlen' 'timeoutlen'
5999 >= 0 'timeoutlen' 'ttimeoutlen'
6000
6001 The timeout only happens when the 'timeout' and 'ttimeout' options
6002 tell so. A useful setting would be >
6003 :set timeout timeoutlen=3000 ttimeoutlen=100
6004< (time out on mapping after three seconds, time out on key codes after
6005 a tenth of a second).
6006
6007 *'title'* *'notitle'*
6008'title' boolean (default off, on when title can be restored)
6009 global
6010 {not in Vi}
6011 {not available when compiled without the |+title|
6012 feature}
6013 When on, the title of the window will be set to the value of
6014 'titlestring' (if it is not empty), or to:
6015 filename [+=-] (path) - VIM
6016 Where:
6017 filename the name of the file being edited
6018 - indicates the file cannot be modified, 'ma' off
6019 + indicates the file was modified
6020 = indicates the file is read-only
6021 =+ indicates the file is read-only and modified
6022 (path) is the path of the file being edited
6023 - VIM the server name |v:servername| or "VIM"
6024 Only works if the terminal supports setting window titles
6025 (currently Amiga console, Win32 console, all GUI versions and
6026 terminals with a non- empty 't_ts' option - these are Unix xterm and
6027 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6028 *X11*
6029 When Vim was compiled with HAVE_X11 defined, the original title will
6030 be restored if possible. The output of ":version" will include "+X11"
6031 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6032 works for the icon name |'icon'|.
6033 But: When Vim was started with the |-X| argument, restoring the title
6034 will not work (except in the GUI).
6035 If the title cannot be restored, it is set to the value of 'titleold'.
6036 You might want to restore the title outside of Vim then.
6037 When using an xterm from a remote machine you can use this command:
6038 rsh machine_name xterm -display $DISPLAY &
6039 then the WINDOWID environment variable should be inherited and the
6040 title of the window should change back to what it should be after
6041 exiting Vim.
6042
6043 *'titlelen'*
6044'titlelen' number (default 85)
6045 global
6046 {not in Vi}
6047 {not available when compiled without the |+title|
6048 feature}
6049 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006050 title. When the title is longer, only the end of the path name is
6051 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006052 Using a percentage makes this adapt to the width of the window. But
6053 it won't work perfectly, because the actual number of characters
6054 available also depends on the font used and other things in the title
6055 bar. When 'titlelen' is zero the full path is used. Otherwise,
6056 values from 1 to 30000 percent can be used.
6057 'titlelen' is also used for the 'titlestring' option.
6058
6059 *'titleold'*
6060'titleold' string (default "Thanks for flying Vim")
6061 global
6062 {not in Vi}
6063 {only available when compiled with the |+title|
6064 feature}
6065 This option will be used for the window title when exiting Vim if the
6066 original title cannot be restored. Only happens if 'title' is on or
6067 'titlestring' is not empty.
6068 *'titlestring'*
6069'titlestring' string (default "")
6070 global
6071 {not in Vi}
6072 {not available when compiled without the |+title|
6073 feature}
6074 When this option is not empty, it will be used for the title of the
6075 window. This happens only when the 'title' option is on.
6076 Only works if the terminal supports setting window titles (currently
6077 Amiga console, Win32 console, all GUI versions and terminals with a
6078 non-empty 't_ts' option).
6079 When Vim was compiled with HAVE_X11 defined, the original title will
6080 be restored if possible |X11|.
6081 When this option contains printf-style '%' items, they will be
6082 expanded according to the rules used for 'statusline'.
6083 Example: >
6084 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6085 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6086< The value of 'titlelen' is used to align items in the middle or right
6087 of the available space.
6088 Some people prefer to have the file name first: >
6089 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6090< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006091 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006092 separating space only when needed.
6093 NOTE: Use of special characters in 'titlestring' may cause the display
6094 to be garbled (e.g., when it contains a CR or NL character).
6095 {not available when compiled without the |+statusline| feature}
6096
6097 *'toolbar'* *'tb'*
6098'toolbar' 'tb' string (default "icons,tooltips")
6099 global
6100 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6101 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006102 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 possible values are:
6104 icons Toolbar buttons are shown with icons.
6105 text Toolbar buttons shown with text.
6106 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006107 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 tooltips Tooltips are active for toolbar buttons.
6109 Tooltips refer to the popup help text which appears after the mouse
6110 cursor is placed over a toolbar button for a brief moment.
6111
6112 If you want the toolbar to be shown with icons as well as text, do the
6113 following: >
6114 :set tb=icons,text
6115< Motif and Athena cannot display icons and text at the same time. They
6116 will show icons if both are requested.
6117
6118 If none of the strings specified in 'toolbar' are valid or if
6119 'toolbar' is empty, this option is ignored. If you want to disable
6120 the toolbar, you need to set the 'guioptions' option. For example: >
6121 :set guioptions-=T
6122< Also see |gui-toolbar|.
6123
6124 *'toolbariconsize'* *'tbis'*
6125'toolbariconsize' 'tbis' string (default "small")
6126 global
6127 {not in Vi}
6128 {only in the GTK+ 2 GUI}
6129 Controls the size of toolbar icons. The possible values are:
6130 tiny Use tiny toolbar icons.
6131 small Use small toolbar icons (default).
6132 medium Use medium-sized toolbar icons.
6133 large Use large toolbar icons.
6134 The exact dimensions in pixels of the various icon sizes depend on
6135 the current theme. Common dimensions are large=32x32, medium=24x24,
6136 small=20x20 and tiny=16x16.
6137
6138 If 'toolbariconsize' is empty, the global default size as determined
6139 by user preferences or the current theme is used.
6140
6141 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6142'ttybuiltin' 'tbi' boolean (default on)
6143 global
6144 {not in Vi}
6145 When on, the builtin termcaps are searched before the external ones.
6146 When off the builtin termcaps are searched after the external ones.
6147 When this option is changed, you should set the 'term' option next for
6148 the change to take effect, for example: >
6149 :set notbi term=$TERM
6150< See also |termcap|.
6151 Rationale: The default for this option is "on", because the builtin
6152 termcap entries are generally better (many systems contain faulty
6153 xterm entries...).
6154
6155 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6156'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6157 sun-cmd, screen, rxvt, dtterm or
6158 iris-ansi; also on when running Vim in
6159 a DOS console)
6160 global
6161 {not in Vi}
6162 Indicates a fast terminal connection. More characters will be sent to
6163 the screen for redrawing, instead of using insert/delete line
6164 commands. Improves smoothness of redrawing when there are multiple
6165 windows and the terminal does not support a scrolling region.
6166 Also enables the extra writing of characters at the end of each screen
6167 line for lines that wrap. This helps when using copy/paste with the
6168 mouse in an xterm and other terminals.
6169
6170 *'ttymouse'* *'ttym'*
6171'ttymouse' 'ttym' string (default depends on 'term')
6172 global
6173 {not in Vi}
6174 {only in Unix and VMS, doesn't work in the GUI; not
6175 available when compiled without |+mouse|}
6176 Name of the terminal type for which mouse codes are to be recognized.
6177 Currently these three strings are valid:
6178 *xterm-mouse*
6179 xterm xterm-like mouse handling. The mouse generates
6180 "<Esc>[Mscr", where "scr" is three bytes:
6181 "s" = button state
6182 "c" = column plus 33
6183 "r" = row plus 33
6184 xterm2 Works like "xterm", but with the xterm reporting the
6185 mouse position while the mouse is dragged. This works
6186 much faster and more precise. Your xterm must at
6187 least at patchlevel 88 / XFree 3.3.3 for this to
6188 work. See below for how Vim detects this
6189 automatically.
6190 *netterm-mouse*
6191 netterm NetTerm mouse handling. The mouse generates
6192 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6193 for the row and column.
6194 *dec-mouse*
6195 dec DEC terminal mouse handling. The mouse generates a
6196 rather complex sequence, starting with "<Esc>[".
6197 *jsbterm-mouse*
6198 jsbterm JSB term mouse handling.
6199 *pterm-mouse*
6200 pterm QNX pterm mouse handling.
6201
6202 The mouse handling must be enabled at compile time |+mouse_xterm|
6203 |+mouse_dec| |+mouse_netterm|.
6204 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6205 recognized, if enabled at compile time. DEC terminal mouse codes
6206 are recognized if enabled at compile time, and 'ttymouse' is not
6207 "xterm" (because the xterm and dec mouse codes conflict).
6208 This option is automatically set to "xterm", when the 'term' option is
6209 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6210 or "xterm2" already. The main use of this option is to set it to
6211 "xterm", when the terminal name doesn't start with "xterm", but it can
6212 handle xterm mouse codes.
6213 The "xterm2" value will be set if the xterm version is reported to be
6214 95 of higher. This only works when compiled with the |+termresponse|
6215 feature and if |t_RV| is set to the escape sequence to request the
6216 xterm version number. Otherwise "xterm2" must be set explicitly.
6217 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6218 t_RV to an empty string: >
6219 :set t_RV=
6220<
6221 *'ttyscroll'* *'tsl'*
6222'ttyscroll' 'tsl' number (default 999)
6223 global
6224 Maximum number of lines to scroll the screen. If there are more lines
6225 to scroll the window is redrawn. For terminals where scrolling is
6226 very slow and redrawing is not slow this can be set to a small number,
6227 e.g., 3, to speed up displaying.
6228
6229 *'ttytype'* *'tty'*
6230'ttytype' 'tty' string (default from $TERM)
6231 global
6232 Alias for 'term', see above.
6233
6234 *'undolevels'* *'ul'*
6235'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6236 Win32 and OS/2)
6237 global
6238 {not in Vi}
6239 Maximum number of changes that can be undone. Since undo information
6240 is kept in memory, higher numbers will cause more memory to be used
6241 (nevertheless, a single change can use an unlimited amount of memory).
6242 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6243 itself: >
6244 set ul=0
6245< But you can also get Vi compatibility by including the 'u' flag in
6246 'cpoptions', and still be able to use CTRL-R to repeat undo.
6247 Set to a negative number for no undo at all: >
6248 set ul=-1
6249< This helps when you run out of memory for a single change.
6250 Also see |undo-two-ways|.
6251
6252 *'updatecount'* *'uc'*
6253'updatecount' 'uc' number (default: 200)
6254 global
6255 {not in Vi}
6256 After typing this many characters the swap file will be written to
6257 disk. When zero, no swap file will be created at all (see chapter on
6258 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6259 Vim with the "-n" option, see |startup|. When editing in readonly
6260 mode this option will be initialized to 10000.
6261 The swapfile can be disabled per buffer with |'swapfile'|.
6262 When 'updatecount' is set from zero to non-zero, swap files are
6263 created for all buffers that have 'swapfile' set. When 'updatecount'
6264 is set to zero, existing swap files are not deleted.
6265 Also see |'swapsync'|.
6266 This option has no meaning in buffers where |'buftype'| is "nofile"
6267 or "nowrite".
6268
6269 *'updatetime'* *'ut'*
6270'updatetime' 'ut' number (default 4000)
6271 global
6272 {not in Vi}
6273 If this many milliseconds nothing is typed the swap file will be
6274 written to disk (see |crash-recovery|). Also used for the
6275 |CursorHold| autocommand event.
6276
6277 *'verbose'* *'vbs'*
6278'verbose' 'vbs' number (default 0)
6279 global
6280 {not in Vi, although some versions have a boolean
6281 verbose option}
6282 When bigger than zero, Vim will give messages about what it is doing.
6283 Currently, these messages are given:
6284 >= 1 When the viminfo file is read or written.
6285 >= 2 When a file is ":source"'ed.
6286 >= 5 Every searched tags file.
6287 >= 8 Files for which a group of autocommands is executed.
6288 >= 9 Every executed autocommand.
6289 >= 12 Every executed function.
6290 >= 13 When an exception is thrown, caught, finished, or discarded.
6291 >= 14 Anything pending in a ":finally" clause.
6292 >= 15 Every executed Ex command (truncated at 200 characters).
6293
6294 This option can also be set with the "-V" argument. See |-V|.
6295 This option is also set by the |:verbose| command.
6296
6297 *'viewdir'* *'vdir'*
6298'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6299 "$VIM/vimfiles/view",
6300 for Unix: "~/.vim/view",
6301 for Macintosh: "$VIM:vimfiles:view"
6302 for VMS: "sys$login:vimfiles/view"
6303 for RiscOS: "Choices:vimfiles/view")
6304 global
6305 {not in Vi}
6306 {not available when compiled without the +mksession
6307 feature}
6308 Name of the directory where to store files for |:mkview|.
6309 This option cannot be set from a |modeline| or in the |sandbox|, for
6310 security reasons.
6311
6312 *'viewoptions'* *'vop'*
6313'viewoptions' 'vop' string (default: "folds,options,cursor")
6314 global
6315 {not in Vi}
6316 {not available when compiled without the +mksession
6317 feature}
6318 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006319 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 word save and restore ~
6321 cursor cursor position in file and in window
6322 folds manually created folds, opened/closed folds and local
6323 fold options
6324 options options and mappings local to a window or buffer (not
6325 global values for local options)
6326 slash backslashes in file names replaced with forward
6327 slashes
6328 unix with Unix end-of-line format (single <NL>), even when
6329 on Windows or DOS
6330
6331 "slash" and "unix" are useful on Windows when sharing view files
6332 with Unix. The Unix version of Vim cannot source dos format scripts,
6333 but the Windows version of Vim can source unix format scripts.
6334
6335 *'viminfo'* *'vi'* *E526* *E527* *E528*
6336'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6337 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6338 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6339 for others: '20,<50,s10,h)
6340 global
6341 {not in Vi}
6342 {not available when compiled without the |+viminfo|
6343 feature}
6344 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006345 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 separated list of parameters, each consisting of a single character
6347 identifying the particular parameter, followed by a number or string
6348 which specifies the value of that parameter. If a particular
6349 character is left out, then the default value is used for that
6350 parameter. The following is a list of the identifying characters and
6351 the effect of their value.
6352 CHAR VALUE ~
6353 ! When included, save and restore global variables that start
6354 with an uppercase letter, and don't contain a lowercase
6355 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
6356 and "_K_L_M" are not.
6357 " Maximum number of lines saved for each register. Old name of
6358 the '<' item, with the disadvantage that you need to put a
6359 backslash before the ", otherwise it will be recognized as the
6360 start of a comment!
6361 % When included, save and restore the buffer list. If Vim is
6362 started with a file name argument, the buffer list is not
6363 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006364 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 without a file name and buffers for help files are not written
6366 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006367 When followed by a number, the number specifies the maximum
6368 number of buffers that are stored. Without a number all
6369 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 ' Maximum number of previously edited files for which the marks
6371 are remembered. This parameter must always be included when
6372 'viminfo' is non-empty.
6373 Including this item also means that the |jumplist| and the
6374 |changelist| are stored in the viminfo file.
6375 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006376 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006377 patterns are also saved. When not included, the value of
6378 'history' is used.
6379 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006380 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 < Maximum number of lines saved for each register. If zero then
6382 registers are not saved. When not included, all lines are
6383 saved. '"' is the old name for this item.
6384 Also see the 's' item below: limit specified in Kbyte.
6385 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006386 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 c When included, convert the text in the viminfo file from the
6388 'encoding' used when writing the file to the current
6389 'encoding'. See |viminfo-encoding|.
6390 f Whether file marks need to be stored. If zero, file marks ('0
6391 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006392 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 cursor position (when exiting or when doing ":wviminfo").
6394 h Disable the effect of 'hlsearch' when loading the viminfo
6395 file. When not included, it depends on whether ":nohlsearch"
6396 has been used since the last search command.
6397 n Name of the viminfo file. The name must immediately follow
6398 the 'n'. Must be the last one! If the "-i" argument was
6399 given when starting Vim, that file name overrides the one
6400 given here with 'viminfo'. Environment variables are expanded
6401 when opening the file, not when setting the option.
6402 r Removable media. The argument is a string (up to the next
6403 ','). This parameter can be given several times. Each
6404 specifies the start of a path for which no marks will be
6405 stored. This is to avoid removable media. For MS-DOS you
6406 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6407 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6408 ignored. Maximum length of each 'r' argument is 50
6409 characters.
6410 s Maximum size of an item in Kbyte. If zero then registers are
6411 not saved. Currently only applies to registers. The default
6412 "s10" will exclude registers with more than 10 Kbyte of text.
6413 Also see the '<' item above: line count limit.
6414
6415 Example: >
6416 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6417<
6418 '50 Marks will be remembered for the last 50 files you
6419 edited.
6420 <1000 Contents of registers (up to 1000 lines each) will be
6421 remembered.
6422 s100 Registers with more than 100 Kbyte text are skipped.
6423 :0 Command-line history will not be saved.
6424 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6425 no / Since '/' is not specified, the default will be used,
6426 that is, save all of the search history, and also the
6427 previous search and substitute patterns.
6428 no % The buffer list will not be saved nor read back.
6429 no h 'hlsearch' highlighting will be restored.
6430
6431 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6432 load the contents of the file, this is not done automatically.
6433
6434 This option cannot be set from a |modeline| or in the |sandbox|, for
6435 security reasons.
6436
6437 *'virtualedit'* *'ve'*
6438'virtualedit' 've' string (default "")
6439 global
6440 {not in Vi}
6441 {not available when compiled without the
6442 |+virtualedit| feature}
6443 A comma separated list of these words:
6444 block Allow virtual editing in Visual block mode.
6445 insert Allow virtual editing in Insert mode.
6446 all Allow virtual editing in all modes.
6447 Virtual editing means that the cursor can be positioned where there is
6448 no actual character. This can be halfway into a Tab or beyond the end
6449 of the line. Useful for selecting a rectangle in Visual mode and
6450 editing a table.
6451
6452 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6453'visualbell' 'vb' boolean (default off)
6454 global
6455 {not in Vi}
6456 Use visual bell instead of beeping. The terminal code to display the
6457 visual bell is given with 't_vb'. When no beep or flash is wanted,
6458 use ":set vb t_vb=".
6459 Note: When the GUI starts, 't_vb' is reset to its default value. You
6460 might want to set it again in your |gvimrc|.
6461 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6462 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6463 where 40 is the time in msec.
6464 Does not work on the Amiga, you always get a screen flash.
6465 Also see 'errorbells'.
6466
6467 *'warn'* *'nowarn'*
6468'warn' boolean (default on)
6469 global
6470 Give a warning message when a shell command is used while the buffer
6471 has been changed.
6472
6473 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6474'weirdinvert' 'wiv' boolean (default off)
6475 global
6476 {not in Vi}
6477 This option has the same effect as the 't_xs' termcap option.
6478 It is provided for backwards compatibility with version 4.x.
6479 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6480 vice versa. Has no effect when the GUI is running.
6481
6482 *'whichwrap'* *'ww'*
6483'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6484 global
6485 {not in Vi}
6486 Allow specified keys that move the cursor left/right to move to the
6487 previous/next line when the cursor is on the first/last character in
6488 the line. Concatenate characters to allow this for these keys:
6489 char key mode ~
6490 b <BS> Normal and Visual
6491 s <Space> Normal and Visual
6492 h "h" Normal and Visual
6493 l "l" Normal and Visual
6494 < <Left> Normal and Visual
6495 > <Right> Normal and Visual
6496 ~ "~" Normal
6497 [ <Left> Insert and Replace
6498 ] <Right> Insert and Replace
6499 For example: >
6500 :set ww=<,>,[,]
6501< allows wrap only when cursor keys are used.
6502 When the movement keys are used in combination with a delete or change
6503 operator, the <EOL> also counts for a character. This makes "3h"
6504 different from "3dh" when the cursor crosses the end of a line. This
6505 is also true for "x" and "X", because they do the same as "dl" and
6506 "dh". If you use this, you may also want to use the mapping
6507 ":map <BS> X" to make backspace delete the character in front of the
6508 cursor.
6509 When 'l' is included, you get a side effect: "yl" on an empty line
6510 will include the <EOL>, so that "p" will insert a new line.
6511 NOTE: This option is set to the Vi default value when 'compatible' is
6512 set and to the Vim default value when 'compatible' is reset.
6513
6514 *'wildchar'* *'wc'*
6515'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6516 global
6517 {not in Vi}
6518 Character you have to type to start wildcard expansion in the
6519 command-line, as specified with 'wildmode'.
6520 The character is not recognized when used inside a macro. See
6521 'wildcharm' for that.
6522 Although 'wc' is a number option, you can set it to a special key: >
6523 :set wc=<Esc>
6524< NOTE: This option is set to the Vi default value when 'compatible' is
6525 set and to the Vim default value when 'compatible' is reset.
6526
6527 *'wildcharm'* *'wcm'*
6528'wildcharm' 'wcm' number (default: none (0))
6529 global
6530 {not in Vi}
6531 'wildcharm' works exactly like 'wildchar', except that it is
6532 recognized when used inside a macro. You can find "spare" command-line
6533 keys suitable for this option by looking at |ex-edit-index|. Normally
6534 you'll never actually type 'wildcharm', just use it in mappings that
6535 automatically invoke completion mode, e.g.: >
6536 :set wcm=<C-Z>
6537 :cmap ss so $vim/sessions/*.vim<C-Z>
6538< Then after typing :ss you can use CTRL-P & CTRL-N.
6539
6540 *'wildignore'* *'wig'*
6541'wildignore' 'wig' string (default "")
6542 global
6543 {not in Vi}
6544 {not available when compiled without the |+wildignore|
6545 feature}
6546 A list of file patterns. A file that matches with one of these
6547 patterns is ignored when completing file or directory names.
6548 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6549 Also see 'suffixes'.
6550 Example: >
6551 :set wildignore=*.o,*.obj
6552< The use of |:set+=| and |:set-=| is preferred when adding or removing
6553 a pattern from the list. This avoids problems when a future version
6554 uses another default.
6555
6556 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6557'wildmenu' 'wmnu' boolean (default off)
6558 global
6559 {not in Vi}
6560 {not available if compiled without the |+wildmenu|
6561 feature}
6562 When 'wildmenu' is on, command-line completion operates in an enhanced
6563 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6564 the possible matches are shown just above the command line, with the
6565 first match highlighted (overwriting the status line, if there is
6566 one). Keys that show the previous/next match, such as <Tab> or
6567 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6568 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6569 specified. "longest" and "list" do not start "wildmenu" mode.
6570 If there are more matches than can fit in the line, a ">" is shown on
6571 the right and/or a "<" is shown on the left. The status line scrolls
6572 as needed.
6573 The "wildmenu" mode is abandoned when a key is hit that is not used
6574 for selecting a completion.
6575 While the "wildmenu" is active the following keys have special
6576 meanings:
6577
6578 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6579 <Down> - in filename/menu name completion: move into a
6580 subdirectory or submenu.
6581 <CR> - in menu completion, when the cursor is just after a
6582 dot: move into a submenu.
6583 <Up> - in filename/menu name completion: move up into
6584 parent directory or parent menu.
6585
6586 This makes the menus accessible from the console |console-menus|.
6587
6588 If you prefer the <Left> and <Right> keys to move the cursor instead
6589 of selecting a different match, use this: >
6590 :cnoremap <Left> <Space><BS><Left>
6591 :cnoremap <Right> <Space><BS><Right>
6592<
6593 The "WildMenu" highlighting is used for displaying the current match
6594 |hl-WildMenu|.
6595
6596 *'wildmode'* *'wim'*
6597'wildmode' 'wim' string (Vim default: "full")
6598 global
6599 {not in Vi}
6600 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006601 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 part specifies what to do for each consecutive use of 'wildchar. The
6603 first part specifies the behavior for the first use of 'wildchar',
6604 The second part for the second use, etc.
6605 These are the possible values for each part:
6606 "" Complete only the first match.
6607 "full" Complete the next full match. After the last match,
6608 the original string is used and then the first match
6609 again.
6610 "longest" Complete till longest common string. If this doesn't
6611 result in a longer string, use the next part.
6612 "longest:full" Like "longest", but also start 'wildmenu' if it is
6613 enabled.
6614 "list" When more than one match, list all matches.
6615 "list:full" When more than one match, list all matches and
6616 complete first match.
6617 "list:longest" When more than one match, list all matches and
6618 complete till longest common string.
6619 When there is only a single match, it is fully completed in all cases.
6620
6621 Examples: >
6622 :set wildmode=full
6623< Complete first full match, next match, etc. (the default) >
6624 :set wildmode=longest,full
6625< Complete longest common string, then each full match >
6626 :set wildmode=list:full
6627< List all matches and complete each full match >
6628 :set wildmode=list,full
6629< List all matches without completing, then each full match >
6630 :set wildmode=longest,list
6631< Complete longest common string, then list alternatives.
6632
6633 *'winaltkeys'* *'wak'*
6634'winaltkeys' 'wak' string (default "menu")
6635 global
6636 {not in Vi}
6637 {only used in Win32, Motif, GTK and Photon GUI}
6638 Some GUI versions allow the access to menu entries by using the ALT
6639 key in combination with a character that appears underlined in the
6640 menu. This conflicts with the use of the ALT key for mappings and
6641 entering special characters. This option tells what to do:
6642 no Don't use ALT keys for menus. ALT key combinations can be
6643 mapped, but there is no automatic handling. This can then be
6644 done with the |:simalt| command.
6645 yes ALT key handling is done by the windowing system. ALT key
6646 combinations cannot be mapped.
6647 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006648 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 keys can be mapped.
6650 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6651 key is never used for the menu.
6652 In the Win32 version, the <F10> key is handled like this too, since
6653 Windows uses it to select a menu.
6654
6655 *'winheight'* *'wh'* *E591*
6656'winheight' 'wh' number (default 1)
6657 global
6658 {not in Vi}
6659 {not available when compiled without the +windows
6660 feature}
6661 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006662 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 current window is smaller, its size is increased, at the cost of the
6664 height of other windows. Set it to 999 to make the current window
6665 always fill the screen (although this has the drawback that ":all"
6666 will create only two windows). Set it to a small number for normal
6667 editing.
6668 Minimum value is 1.
6669 The height is not adjusted after one of the commands to change the
6670 height of the current window.
6671 'winheight' applies to the current window. Use 'winminheight' to set
6672 the minimal height for other windows.
6673
6674 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6675'winfixheight' 'wfh' boolean (default off)
6676 local to window
6677 {not in Vi}
6678 {not available when compiled without the +windows
6679 feature}
6680 Keep the window height when windows are opened or closed and
6681 'equalalways' is set. Set by default for the |preview-window| and
6682 |quickfix-window|.
6683 The height may be changed anyway when running out of room.
6684
6685 *'winminheight'* *'wmh'*
6686'winminheight' 'wmh' number (default 1)
6687 global
6688 {not in Vi}
6689 {not available when compiled without the +windows
6690 feature}
6691 The minimal height of a window, when it's not the current window.
6692 This is a hard minimum, windows will never become smaller.
6693 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6694 status bar) if necessary. They will return to at least one line when
6695 they become active (since the cursor has to have somewhere to go.)
6696 Use 'winheight' to set the minimal height of the current window.
6697 This option is only checked when making a window smaller. Don't use a
6698 large number, it will cause errors when opening more than a few
6699 windows. A value of 0 to 3 is reasonable.
6700
6701 *'winminwidth'* *'wmw'*
6702'winminwidth' 'wmw' number (default 1)
6703 global
6704 {not in Vi}
6705 {not available when compiled without the +vertsplit
6706 feature}
6707 The minimal width of a window, when it's not the current window.
6708 This is a hard minimum, windows will never become smaller.
6709 When set to zero, windows may be "squashed" to zero columns (i.e. just
6710 a vertical separator) if necessary. They will return to at least one
6711 line when they become active (since the cursor has to have somewhere
6712 to go.)
6713 Use 'winwidth' to set the minimal width of the current window.
6714 This option is only checked when making a window smaller. Don't use a
6715 large number, it will cause errors when opening more than a few
6716 windows. A value of 0 to 12 is reasonable.
6717
6718 *'winwidth'* *'wiw'* *E592*
6719'winwidth' 'wiw' number (default 20)
6720 global
6721 {not in Vi}
6722 {not available when compiled without the +vertsplit
6723 feature}
6724 Minimal number of columns for the current window. This is not a hard
6725 minimum, Vim will use fewer columns if there is not enough room. If
6726 the current window is smaller, its size is increased, at the cost of
6727 the width of other windows. Set it to 999 to make the current window
6728 always fill the screen. Set it to a small number for normal editing.
6729 The width is not adjusted after one of the commands to change the
6730 width of the current window.
6731 'winwidth' applies to the current window. Use 'winminwidth' to set
6732 the minimal width for other windows.
6733
6734 *'wrap'* *'nowrap'*
6735'wrap' boolean (default on)
6736 local to window
6737 {not in Vi}
6738 This option changes how text is displayed. It doesn't change the text
6739 in the buffer, see 'textwidth' for that.
6740 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006741 displaying continues on the next line. When off lines will not wrap
6742 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 moved to a part that is not shown, the screen will scroll
6744 horizontally.
6745 The line will be broken in the middle of a word if necessary. See
6746 'linebreak' to get the break at a word boundary.
6747 To make scrolling horizontally a bit more useful, try this: >
6748 :set sidescroll=5
6749 :set listchars+=precedes:<,extends:>
6750< See 'sidescroll', 'listchars' and |wrap-off|.
6751
6752 *'wrapmargin'* *'wm'*
6753'wrapmargin' 'wm' number (default 0)
6754 local to buffer
6755 Number of characters from the right window border where wrapping
6756 starts. When typing text beyond this limit, an <EOL> will be inserted
6757 and inserting continues on the next line.
6758 Options that add a margin, such as 'number' and 'foldcolumn', cause
6759 the text width to be further reduced. This is Vi compatible.
6760 When 'textwidth' is non-zero, this option is not used.
6761 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6762 and less usefully}
6763
6764 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6765'wrapscan' 'ws' boolean (default on) *E384* *E385*
6766 global
6767 Searches wrap around the end of the file.
6768
6769 *'write'* *'nowrite'*
6770'write' boolean (default on)
6771 global
6772 {not in Vi}
6773 Allows writing files. When not set, writing a file is not allowed.
6774 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006775 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776 argument. Filtering text is still possible, even though this requires
6777 writing a temporary file.
6778
6779 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6780'writeany' 'wa' boolean (default off)
6781 global
6782 Allows writing to any file with no need for "!" override.
6783
6784 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6785'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6786 otherwise)
6787 global
6788 {not in Vi}
6789 Make a backup before overwriting a file. The backup is removed after
6790 the file was successfully written, unless the 'backup' option is
6791 also on. Reset this option if your file system is almost full. See
6792 |backup-table| for another explanation.
6793 When the 'backupskip' pattern matches, a backup is not made anyway.
6794 NOTE: This option is set to the default value when 'compatible' is
6795 set.
6796
6797 *'writedelay'* *'wd'*
6798'writedelay' 'wd' number (default 0)
6799 global
6800 {not in Vi}
6801 The number of microseconds to wait for each character sent to the
6802 screen. When non-zero, characters are sent to the terminal one by
6803 one. For MS-DOS pcterm this does not work. For debugging purposes.
6804
6805 vim:tw=78:ts=8:ft=help:norl: