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