blob: e1c6f5ae404312fb9f6139fcb90240c41c4dc263 [file] [log] [blame]
Bram Moolenaar7c626922005-02-07 22:01:03 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Feb 07
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
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001099 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1100 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 This option is used together with 'buftype' and 'swapfile' to specify
1102 special kinds of buffers. See |special-buffers|.
1103
1104 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1105'buflisted' 'bl' boolean (default: on)
1106 local to buffer
1107 {not in Vi}
1108 When this option is set, the buffer shows up in the buffer list. If
1109 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1110 This option is reset by Vim for buffers that are only used to remember
1111 a file name or marks. Vim sets it when starting to edit a buffer.
1112 But not when moving to a buffer with ":buffer".
1113
1114 *'buftype'* *'bt'* *E382*
1115'buftype' 'bt' string (default: "")
1116 local to buffer
1117 {not in Vi}
1118 {not available when compiled without the |+quickfix|
1119 feature}
1120 The value of this option specifies the type of a buffer:
1121 <empty> normal buffer
1122 nofile buffer which is not related to a file and will not be
1123 written
1124 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001125 acwrite buffer which will always be written with BufWriteCmd
1126 autocommands. {not available when compiled without the
1127 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128 quickfix quickfix buffer, contains list of errors |:cwindow|
1129 help help buffer (you are not supposed to set this
1130 manually)
1131
1132 This option is used together with 'bufhidden' and 'swapfile' to
1133 specify special kinds of buffers. See |special-buffers|.
1134
1135 Be careful with changing this option, it can have many side effects!
1136
1137 A "quickfix" buffer is only used for the error list. This value is
1138 set by the |:cwindow| command and you are not supposed to change it.
1139
1140 "nofile" and "nowrite" buffers are similar:
1141 both: The buffer is not to be written to disk, ":w" doesn't
1142 work (":w filename" does work though).
1143 both: The buffer is never considered to be |'modified'|.
1144 There is no warning when the changes will be lost, for
1145 example when you quit Vim.
1146 both: A swap file is only created when using too much memory
1147 (when 'swapfile' has been reset there is never a swap
1148 file).
1149 nofile only: The buffer name is fixed, it is not handled like a
1150 file name. It is not modified in response to a |:cd|
1151 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001152 *E676*
1153 "acwrite" implies that the buffer name is not related to a file, like
1154 "nofile", but it will be written. Thus, in contrast to "nofile" and
1155 "nowrite", ":w" does work and a modified buffer can't be abandoned
1156 without saving. For writing there must be matching |BufWriteCmd|,
1157 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158
1159 *'casemap'* *'cmp'*
1160'casemap' 'cmp' string (default: "internal,keepascii")
1161 global
1162 {not in Vi}
1163 Specifies details about changing the case of letters. It may contain
1164 these words, separated by a comma:
1165 internal Use internal case mapping functions, the current
1166 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001167 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 "internal" is omitted, the towupper() and towlower()
1169 system library functions are used when available.
1170 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1171 case mapping, the current locale is not effective.
1172 This probably only matters for Turkish.
1173
1174 *'cdpath'* *'cd'* *E344* *E346*
1175'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1176 global
1177 {not in Vi}
1178 {not available when compiled without the
1179 |+file_in_path| feature}
1180 This is a list of directories which will be searched when using the
1181 |:cd| and |:lcd| commands, provided that the directory being searched
1182 for has a relative path (not starting with "/", "./" or "../").
1183 The 'cdpath' option's value has the same form and semantics as
1184 |'path'|. Also see |file-searching|.
1185 The default value is taken from $CDPATH, with a "," prepended to look
1186 in the current directory first.
1187 If the default value taken from $CDPATH is not what you want, include
1188 a modified version of the following command in your vimrc file to
1189 override it: >
1190 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1191< This option cannot be set from a |modeline| or in the |sandbox|, for
1192 security reasons.
1193 (parts of 'cdpath' can be passed to the shell to expand file names).
1194
1195 *'cedit'*
1196'cedit' string (Vi default: "", Vim default: CTRL-F)
1197 global
1198 {not in Vi}
1199 {not available when compiled without the |+vertsplit|
1200 feature}
1201 The key used in Command-line Mode to open the command-line window.
1202 The default is CTRL-F when 'compatible' is off.
1203 Only non-printable keys are allowed.
1204 The key can be specified as a single character, but it is difficult to
1205 type. The preferred way is to use the <> notation. Examples: >
1206 :set cedit=<C-Y>
1207 :set cedit=<Esc>
1208< |Nvi| also has this option, but it only uses the first character.
1209 See |cmdwin|.
1210
1211 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1212'charconvert' 'ccv' string (default "")
1213 global
1214 {only available when compiled with the |+multi_byte|
1215 feature and the |+eval| feature}
1216 {not in Vi}
1217 An expression that is used for character encoding conversion. It is
1218 evaluated when a file that is to be read or has been written has a
1219 different encoding from what is desired.
1220 'charconvert' is not used when the internal iconv() function is
1221 supported and is able to do the conversion. Using iconv() is
1222 preferred, because it is much faster.
1223 'charconvert' is not used when reading stdin |--|, because there is no
1224 file to convert from. You will have to save the text in a file first.
1225 The expression must return zero or an empty string for success,
1226 non-zero for failure.
1227 The possible encoding names encountered are in 'encoding'.
1228 Additionally, names given in 'fileencodings' and 'fileencoding' are
1229 used.
1230 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1231 is done internally by Vim, 'charconvert' is not used for this.
1232 'charconvert' is also used to convert the viminfo file, if the 'c'
1233 flag is present in 'viminfo'. Also used for Unicode conversion.
1234 Example: >
1235 set charconvert=CharConvert()
1236 fun CharConvert()
1237 system("recode "
1238 \ . v:charconvert_from . ".." . v:charconvert_to
1239 \ . " <" . v:fname_in . " >" v:fname_out)
1240 return v:shell_error
1241 endfun
1242< The related Vim variables are:
1243 v:charconvert_from name of the current encoding
1244 v:charconvert_to name of the desired encoding
1245 v:fname_in name of the input file
1246 v:fname_out name of the output file
1247 Note that v:fname_in and v:fname_out will never be the same.
1248 Note that v:charconvert_from and v:charconvert_to may be different
1249 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1250 Encryption is not done by Vim when using 'charconvert'. If you want
1251 to encrypt the file after conversion, 'charconvert' should take care
1252 of this.
1253 This option cannot be set from a |modeline| or in the |sandbox|, for
1254 security reasons.
1255
1256 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1257'cindent' 'cin' boolean (default off)
1258 local to buffer
1259 {not in Vi}
1260 {not available when compiled without the |+cindent|
1261 feature}
1262 Enables automatic C program indenting See 'cinkeys' to set the keys
1263 that trigger reindenting in insert mode and 'cinoptions' to set your
1264 preferred indent style.
1265 If 'indentexpr' is not empty, it overrules 'cindent'.
1266 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1267 the "=" operator indents using this algorithm rather than calling an
1268 external program.
1269 See |C-indenting|.
1270 When you don't like the way 'cindent' works, try the 'smartindent'
1271 option or 'indentexpr'.
1272 This option is not used when 'paste' is set.
1273 NOTE: This option is reset when 'compatible' is set.
1274
1275 *'cinkeys'* *'cink'*
1276'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1277 local to buffer
1278 {not in Vi}
1279 {not available when compiled without the |+cindent|
1280 feature}
1281 A list of keys that, when typed in Insert mode, cause reindenting of
1282 the current line. Only used if 'cindent' is on and 'indentexpr' is
1283 empty.
1284 For the format of this option see |cinkeys-format|.
1285 See |C-indenting|.
1286
1287 *'cinoptions'* *'cino'*
1288'cinoptions' 'cino' string (default "")
1289 local to buffer
1290 {not in Vi}
1291 {not available when compiled without the |+cindent|
1292 feature}
1293 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1294 program. See |cinoptions-values| for the values of this option, and
1295 |C-indenting| for info on C indenting in general.
1296
1297
1298 *'cinwords'* *'cinw'*
1299'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1300 local to buffer
1301 {not in Vi}
1302 {not available when compiled without both the
1303 |+cindent| and the |+smartindent| features}
1304 These keywords start an extra indent in the next line when
1305 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1306 an appropriate place (inside {}).
1307 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1308 matter, include the keyword both the uppercase and lowercase:
1309 "if,If,IF".
1310
1311 *'clipboard'* *'cb'*
1312'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1313 for X-windows, "" otherwise)
1314 global
1315 {not in Vi}
1316 {only in GUI versions or when the |+xterm_clipboard|
1317 feature is included}
1318 This option is a list of comma separated names.
1319 These names are recognized:
1320
1321 unnamed When included, Vim will use the clipboard register '*'
1322 for all yank, delete, change and put operations which
1323 would normally go to the unnamed register. When a
1324 register is explicitly specified, it will always be
1325 used regardless of whether "unnamed" is in 'clipboard'
1326 or not. The clipboard register can always be
1327 explicitly accessed using the "* notation. Also see
1328 |gui-clipboard|.
1329
1330 autoselect Works like the 'a' flag in 'guioptions': If present,
1331 then whenever Visual mode is started, or the Visual
1332 area extended, Vim tries to become the owner of the
1333 windowing system's global selection or put the
1334 selected text on the clipboard used by the selection
1335 register "*. See |guioptions_a| and |quotestar| for
1336 details. When the GUI is active, the 'a' flag in
1337 'guioptions' is used, when the GUI is not active, this
1338 "autoselect" flag is used.
1339 Also applies to the modeless selection.
1340
1341 autoselectml Like "autoselect", but for the modeless selection
1342 only. Compare to the 'A' flag in 'guioptions'.
1343
1344 exclude:{pattern}
1345 Defines a pattern that is matched against the name of
1346 the terminal 'term'. If there is a match, no
1347 connection will be made to the X server. This is
1348 useful in this situation:
1349 - Running Vim in a console.
1350 - $DISPLAY is set to start applications on another
1351 display.
1352 - You do not want to connect to the X server in the
1353 console, but do want this in a terminal emulator.
1354 To never connect to the X server use: >
1355 exclude:.*
1356< This has the same effect as using the |-X| argument.
1357 Note that when there is no connection to the X server
1358 the window title won't be restored and the clipboard
1359 cannot be accessed.
1360 The value of 'magic' is ignored, {pattern} is
1361 interpreted as if 'magic' was on.
1362 The rest of the option value will be used for
1363 {pattern}, this must be the last entry.
1364
1365 *'cmdheight'* *'ch'*
1366'cmdheight' 'ch' number (default 1)
1367 global
1368 {not in Vi}
1369 Number of screen lines to use for the command-line. Helps avoiding
1370 |hit-enter| prompts.
1371
1372 *'cmdwinheight'* *'cwh'*
1373'cmdwinheight' 'cwh' number (default 7)
1374 global
1375 {not in Vi}
1376 {not available when compiled without the |+vertsplit|
1377 feature}
1378 Number of screen lines to use for the command-line window. |cmdwin|
1379
1380 *'columns'* *'co'* *E594*
1381'columns' 'co' number (default 80 or terminal width)
1382 global
1383 {not in Vi}
1384 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001385 initialization and does not have to be set by hand. Also see
1386 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001387 When Vim is running in the GUI or in a resizable window, setting this
1388 option will cause the window size to be changed. When you only want
1389 to use the size for the GUI, put the command in your |gvimrc| file.
1390 When you set this option and Vim is unable to change the physical
1391 number of columns of the display, the display may be messed up.
1392
1393 *'comments'* *'com'* *E524* *E525*
1394'comments' 'com' string (default
1395 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+comments|
1399 feature}
1400 A comma separated list of strings that can start a comment line. See
1401 |format-comments|. See |option-backslash| about using backslashes to
1402 insert a space.
1403
1404 *'commentstring'* *'cms'* *E537*
1405'commentstring' 'cms' string (default "/*%s*/")
1406 local to buffer
1407 {not in Vi}
1408 {not available when compiled without the |+folding|
1409 feature}
1410 A template for a comment. The "%s" in the value is replaced with the
1411 comment text. Currently only used to add markers for folding, see
1412 |fold-marker|.
1413
1414 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
1415'compatible' 'cp' boolean (default on, off when a .vimrc file is found)
1416 global
1417 {not in Vi}
1418 This option has the effect of making Vim either more Vi-compatible, or
1419 make Vim behave in a more useful way.
1420 This is a special kind of option, because when it's set or reset,
1421 other options are also changed as a side effect. CAREFUL: Setting or
1422 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001423 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 set this option in your vimrc file, you should probably put it at the
1425 very start.
1426 By default this option is on and the Vi defaults are used for the
1427 options. This default was chosen for those people who want to use Vim
1428 just like Vi, and don't even (want to) know about the 'compatible'
1429 option.
1430 When a ".vimrc" file is found while Vim is starting up, this option is
1431 switched off, and all options that have not been modified will be set
1432 to the Vim defaults. Effectively, this means that when a ".vimrc"
1433 file exists, Vim will use the Vim defaults, otherwise it will use the
1434 Vi defaults. (Note: This doesn't happen for the system-wide vimrc
Bram Moolenaar7c626922005-02-07 22:01:03 +00001435 file). Also see |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 You can also set this option with the "-C" argument, and reset it with
1437 "-N". See |-C| and |-N|.
1438 Switching this option off makes the Vim defaults be used for options
1439 that have a different Vi and Vim default value. See the options
1440 marked with a '+' below. Other options are not modified.
1441 At the moment this option is set, several other options will be set
1442 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001443 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001444 editing.
1445 See also 'cpoptions'.
1446
1447 option + set value effect ~
1448
1449 'allowrevins' off no CTRL-_ command
1450 'backupcopy' Unix: "yes" backup file is a copy
1451 others: "auto" copy or rename backup file
1452 'backspace' "" normal backspace
1453 'backup' off no backup file
1454 'cindent' off no C code indentation
1455 'cedit' + "" no key to open the |cmdwin|
1456 'cpoptions' + (all flags) Vi-compatible flags
1457 'cscopetag' off don't use cscope for ":tag"
1458 'cscopetagorder' 0 see |cscopetagorder|
1459 'cscopeverbose' off see |cscopeverbose|
1460 'digraph' off no digraphs
1461 'esckeys' + off no <Esc>-keys in Insert mode
1462 'expandtab' off tabs not expanded to spaces
1463 'fileformats' + "" no automatic file format detection,
1464 "dos,unix" except for DOS, Windows and OS/2
1465 'formatoptions' + "vt" Vi compatible formatting
1466 'gdefault' off no default 'g' flag for ":s"
1467 'history' + 0 no commandline history
1468 'hkmap' off no Hebrew keyboard mapping
1469 'hkmapp' off no phonetic Hebrew keyboard mapping
1470 'hlsearch' off no highlighting of search matches
1471 'incsearch' off no incremental searching
1472 'indentexpr' "" no indenting by expression
1473 'insertmode' off do not start in Insert mode
1474 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1475 characters and '_'
1476 'joinspaces' on insert 2 spaces after period
1477 'modeline' + off no modelines
1478 'more' + off no pauses in listings
1479 'revins' off no reverse insert
1480 'ruler' off no ruler
1481 'scrolljump' 1 no jump scroll
1482 'scrolloff' 0 no scroll offset
1483 'shiftround' off indent not rounded to shiftwidth
1484 'shortmess' + "" no shortening of messages
1485 'showcmd' + off command characters not shown
1486 'showmode' + off current mode not shown
1487 'smartcase' off no automatic ignore case switch
1488 'smartindent' off no smart indentation
1489 'smarttab' off no smart tab size
1490 'softtabstop' 0 tabs are always 'tabstop' positions
1491 'startofline' on goto startofline with some commands
1492 'tagrelative' + off tag file names are not relative
1493 'textauto' + off no automatic textmode detection
1494 'textwidth' 0 no automatic line wrap
1495 'tildeop' off tilde is not an operator
1496 'ttimeout' off no terminal timeout
1497 'whichwrap' + "" left-right movements don't wrap
1498 'wildchar' + CTRL-E only when the current value is <Tab>
1499 use CTRL-E for cmdline completion
1500 'writebackup' on or off depends on +writebackup feature
1501
1502 *'complete'* *'cpt'* *E535*
1503'complete' 'cpt' string (default: ".,w,b,u,t,i")
1504 local to buffer
1505 {not in Vi}
1506 This option specifies how keyword completion |ins-completion| works
1507 when CTRL-P or CTRL-N are used. It is also used for whole-line
1508 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1509 and the places to scan. It is a comma separated list of flags:
1510 . scan the current buffer ('wrapscan' is ignored)
1511 w scan buffers from other windows
1512 b scan other loaded buffers that are in the buffer list
1513 u scan the unloaded buffers that are in the buffer list
1514 U scan the buffers that are not in the buffer list
1515 k scan the files given with the 'dictionary' option
1516 k{dict} scan the file {dict}. Several "k" flags can be given,
1517 patterns are valid too. For example: >
1518 :set cpt=k/usr/dict/*,k~/spanish
1519< s scan the files given with the 'thesaurus' option
1520 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1521 are valid too.
1522 i scan current and included files
1523 d scan current and included files for defined name or macro
1524 |i_CTRL-X_CTRL-D|
1525 ] tag completion
1526 t same as "]"
1527
1528 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1529 not executed, this may lead to unexpected completions from some files
1530 (gzipped files for example). Unloaded buffers are not scanned for
1531 whole-line completion.
1532
1533 The default is ".,w,b,u,t,i", which means to scan:
1534 1. the current buffer
1535 2. buffers in other windows
1536 3. other loaded buffers
1537 4. unloaded buffers
1538 5. tags
1539 6. included files
1540
1541 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
1542 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns
1543 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions)
1544
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001545 *'completefunc'* *'cfu'*
1546'completefunc' 'cfu' string (default: empty)
1547 local to buffer
1548 {not in Vi}
1549 This option specifies a completion function to be used for CTRL-X
1550 CTRL-X. The function will be invoked with four arguments:
1551 a:line the text of the current line
1552 a:base the text with which matches should match
1553 a:col column in a:line where the cursor is, first column is
1554 zero
1555 a:findstart either 1 or 0
1556 When the a:findstart argument is 1, the function must return the
1557 column of where the completion starts. It must be a number between
1558 zero and "a:col". This involves looking at the characters in a:line
1559 before column a:col and include those characters that could be part of
1560 the completed item.
1561 When the a:findstart argument is 0 the function must return a string
1562 with the matching words, separated by newlines. When there are no
1563 matches return an empty string.
1564 An example that completes the names of the months: >
1565 fun! CompleteMonths(line, base, col, findstart)
1566 if a:findstart
1567 " locate start column of word
1568 let start = a:col
1569 while start > 0 && a:line[start - 1] =~ '\a'
1570 let start = start - 1
1571 endwhile
1572 return start
1573 else
1574 " find months matching with "a:base"
1575 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec"
1576 if a:base != ''
1577 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g')
1578 endif
1579 let res = substitute(res, ' \+', "\n", 'g')
1580 return res
1581 endif
1582 endfun
1583 set completefunc=CompleteMonths
1584< Note that a substitute() function is used to reduce the list of
1585 possible values and remove the ones that don't match the base. The
1586 part before the "\|" matches the base, the part after it is used
1587 when there is no match. The "\2" in the replacement is empty if the
1588 part before the "\|" does not match.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001589
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1591'confirm' 'cf' boolean (default off)
1592 global
1593 {not in Vi}
1594 When 'confirm' is on, certain operations that would normally
1595 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1596 instead raise a |dialog| asking if you wish to save the current
1597 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1598 If 'confirm' is off you can still activate confirmation for one
1599 command only (this is most useful in mappings) with the |:confirm|
1600 command.
1601 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1602
1603 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1604'conskey' 'consk' boolean (default off)
1605 global
1606 {not in Vi} {only for MS-DOS}
1607 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001608 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001609 three methods of console input are available:
1610 'conskey' 'bioskey' action ~
1611 on on or off direct console input
1612 off on BIOS
1613 off off STDIN
1614
1615 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1616'copyindent' 'ci' boolean (default off)
1617 local to buffer
1618 {not in Vi}
1619 Copy the structure of the existing lines indent when autoindenting a
1620 new line. Normally the new indent is reconstructed by a series of
1621 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1622 in which case only spaces are used). Enabling this option makes the
1623 new line copy whatever characters were used for indenting on the
1624 existing line. If the new indent is greater than on the existing
1625 line, the remaining space is filled in the normal manner.
1626 NOTE: 'copyindent' is reset when 'compatible' is set.
1627 Also see 'preserveindent'.
1628
1629 *'cpoptions'* *'cpo'*
1630'cpoptions' 'cpo' string (Vim default: "aABceFs",
1631 Vi default: all flags)
1632 global
1633 {not in Vi}
1634 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001635 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 not being vi-compatible is mostly or sometimes preferred.
1637 'cpoptions' stands for "compatible-options".
1638 Commas can be added for readability.
1639 To avoid problems with flags that are added in the future, use the
1640 "+=" and "-=" feature of ":set" |add-option-flags|.
1641 NOTE: This option is set to the Vi default value when 'compatible' is
1642 set and to the Vim default value when 'compatible' is reset.
1643
1644 contains behavior ~
1645 *cpo-a*
1646 a When included, a ":read" command with a file name
1647 argument will set the alternate file name for the
1648 current window.
1649 *cpo-A*
1650 A When included, a ":write" command with a file name
1651 argument will set the alternate file name for the
1652 current window.
1653 *cpo-b*
1654 b "\|" in a ":map" command is recognized as the end of
1655 the map command. The '\' is included in the mapping,
1656 the text after the '|' is interpreted as the next
1657 command. Use a CTRL-V instead of a backslash to
1658 include the '|' in the mapping. Applies to all
1659 mapping, abbreviation, menu and autocmd commands.
1660 See also |map_bar|.
1661 *cpo-B*
1662 B A backslash has no special meaning in mappings,
1663 abbreviations and the "to" part of the menu commands.
1664 Remove this flag to be able to use a backslash like a
1665 CTRL-V. For example, the command ":map X \<Esc>"
1666 results in X being mapped to:
1667 'B' included: "\^[" (^[ is a real <Esc>)
1668 'B' excluded: "<Esc>" (5 characters)
1669 ('<' excluded in both cases)
1670 *cpo-c*
1671 c Searching continues at the end of any match at the
1672 cursor position, but not further than the start of the
1673 next line. When not present searching continues
1674 one character from the cursor position. With 'c'
1675 "abababababab" only gets three matches when repeating
1676 "/abab", without 'c' there are five matches.
1677 *cpo-C*
1678 C Do not concatenate sourced lines that start with a
1679 backslash. See |line-continuation|.
1680 *cpo-d*
1681 d Using "./" in the 'tags' option doesn't mean to use
1682 the tags file relative to the current file, but the
1683 tags file in the current directory.
1684 *cpo-D*
1685 D Can't use CTRL-K to enter a digraph after Normal mode
1686 commands with a character argument, like |r|, |f| and
1687 |t|.
1688 *cpo-e*
1689 e When executing a register with ":@r", always add a
1690 <CR> to the last line, also when the register is not
1691 linewise. If this flag is not present, the register
1692 is not linewise and the last line does not end in a
1693 <CR>, then the last line is put on the command-line
1694 and can be edited before hitting <CR>.
1695 *cpo-E*
1696 E It is an error when using "y", "d", "c", "g~", "gu" or
1697 "gU" on an Empty region. The operators only work when
1698 at least one character is to be operate on. Example:
1699 This makes "y0" fail in the first column.
1700 *cpo-f*
1701 f When included, a ":read" command with a file name
1702 argument will set the file name for the current buffer,
1703 if the current buffer doesn't have a file name yet.
1704 *cpo-F*
1705 F When included, a ":write" command with a file name
1706 argument will set the file name for the current
1707 buffer, if the current buffer doesn't have a file name
1708 yet.
1709 *cpo-g*
1710 g Goto line 1 when using ":edit" without argument.
1711 *cpo-i*
1712 i When included, interrupting the reading of a file will
1713 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001714 *cpo-I*
1715 I When moving the cursor up or down just after inserting
1716 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 *cpo-j*
1718 j When joining lines, only add two spaces after a '.',
1719 not after '!' or '?'. Also see 'joinspaces'.
1720 *cpo-J*
1721 J A |sentence| has to be followed by two spaces after
1722 the '.', '!' or '?'. A <Tab> is not recognized as
1723 white space.
1724 *cpo-k*
1725 k Disable the recognition of raw key codes in
1726 mappings, abbreviations, and the "to" part of menu
1727 commands. For example, if <Key> sends ^[OA (where ^[
1728 is <Esc>), the command ":map X ^[OA" results in X
1729 being mapped to:
1730 'k' included: "^[OA" (3 characters)
1731 'k' excluded: "<Key>" (one key code)
1732 Also see the '<' flag below.
1733 *cpo-K*
1734 K Don't wait for a key code to complete when it is
1735 halfway a mapping. This breaks mapping <F1><F1> when
1736 only part of the second <F1> has been read. It
1737 enables cancelling the mapping by typing <F1><Esc>.
1738 *cpo-l*
1739 l Backslash in a [] range in a search pattern is taken
1740 literally, only "\]" is special See |/[]|
1741 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1742 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1743 *cpo-L*
1744 L When the 'list' option is set, 'wrapmargin',
1745 'textwidth', 'softtabstop' and Virtual Replace mode
1746 (see |gR|) count a <Tab> as two characters, instead of
1747 the normal behavior of a <Tab>.
1748 *cpo-m*
1749 m When included, a showmatch will always wait half a
1750 second. When not included, a showmatch will wait half
1751 a second or until a character is typed. |'showmatch'|
1752 *cpo-M*
1753 M When excluded, "%" matching will take backslashes into
1754 account. Thus in "( \( )" and "\( ( \)" the outer
1755 parenthesis match. When included "%" ignores
1756 backslashes, which is Vi compatible.
1757 *cpo-n*
1758 n When included, the column used for 'number' will also
1759 be used for text of wrapped lines.
1760 *cpo-o*
1761 o Line offset to search command is not remembered for
1762 next search.
1763 *cpo-O*
1764 O Don't complain if a file is being overwritten, even
1765 when it didn't exist when editing it. This is a
1766 protection against a file unexpectedly created by
1767 someone else. Vi didn't complain about this.
1768 *cpo-p*
1769 p Vi compatible Lisp indenting. When not present, a
1770 slightly better algorithm is used.
1771 *cpo-r*
1772 r Redo ("." command) uses "/" to repeat a search
1773 command, instead of the actually used search string.
1774 *cpo-R*
1775 R Remove marks from filtered lines. Without this flag
1776 marks are kept like |:keepmarks| was used.
1777 *cpo-s*
1778 s Set buffer options when entering the buffer for the
1779 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001780 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 set when the buffer is created.
1782 *cpo-S*
1783 S Set buffer options always when entering a buffer
1784 (except 'readonly', 'fileformat', 'filetype' and
1785 'syntax'). This is the (most) Vi compatible setting.
1786 The options are set to the values in the current
1787 buffer. When you change an option and go to another
1788 buffer, the value is copied. Effectively makes the
1789 buffer options global to all buffers.
1790
1791 's' 'S' copy buffer options
1792 no no when buffer created
1793 yes no when buffer first entered (default)
1794 X yes each time when buffer entered (vi comp.)
1795 *cpo-t*
1796 t Search pattern for the tag command is remembered for
1797 "n" command. Otherwise Vim only puts the pattern in
1798 the history for search pattern, but doesn't change the
1799 last used search pattern.
1800 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001801 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 *cpo-v*
1803 v Backspaced characters remain visible on the screen in
1804 Insert mode. Without this flag the characters are
1805 erased from the screen right away. With this flag the
1806 screen newly typed text overwrites backspaced
1807 characters.
1808 *cpo-w*
1809 w When using "cw" on a blank character, only change one
1810 character and not all blanks until the start of the
1811 next word.
1812 *cpo-W*
1813 W Don't overwrite a readonly file. When omitted, ":w!"
1814 overwrites a readonly file, if possible.
1815 *cpo-x*
1816 x <Esc> on the command-line executes the command-line.
1817 The default in Vim is to abandon the command-line,
1818 because <Esc> normally aborts a command. |c_<Esc>|
1819 *cpo-y*
1820 y A yank command can be redone with ".".
1821 *cpo-!*
1822 ! When redoing a filter command, use the last used
1823 external command, whatever it was. Otherwise the last
1824 used -filter- command is used.
1825 *cpo-$*
1826 $ When making a change to one line, don't redisplay the
1827 line, but put a '$' at the end of the changed text.
1828 The changed text will be overwritten when you type the
1829 new text. The line is redisplayed if you type any
1830 command that moves the cursor from the insertion
1831 point.
1832 *cpo-%*
1833 % Vi-compatible matching is done for the "%" command.
1834 Does not recognize "#if", "#endif", etc.
1835 Does not recognize "/*" and "*/".
1836 Parens inside single and double quotes are also
1837 counted, causing a string that contains a paren to
1838 disturb the matching. For example, in a line like
1839 "if (strcmp("foo(", s))" the first paren does not
1840 match the last one. When this flag is not included,
1841 parens inside single and double quotes are treated
1842 specially. When matching a paren outside of quotes,
1843 everything inside quotes is ignored. When matching a
1844 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001845 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001846 This flag is also used for other features, such as
1847 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001848 *cpo--*
1849 - When included, a vertical movement command fails when
1850 it would above the first line or below the last line.
1851 Without it the cursor moves to the first or last line,
1852 unless it already was in that line.
1853 Applies to the commands "-", "k", CTRL-P, "+", "j",
1854 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001855 *cpo-+*
1856 + When included, a ":write file" command will reset the
1857 'modified' flag of the buffer, even though the buffer
1858 itself may still be different from its file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001859 cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 * Use ":*" in the same way as ":@". When not included,
1861 ":*" is an alias for ":'<,'>", select the Visual area.
1862 *cpo-<*
1863 < Disable the recognition of special key codes in |<>|
1864 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001865 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 ":map X <Tab>" results in X being mapped to:
1867 '<' included: "<Tab>" (5 characters)
1868 '<' excluded: "^I" (^I is a real <Tab>)
1869 Also see the 'k' flag above.
1870
1871 *'cscopepathcomp'* *'cspc'*
1872'cscopepathcomp' 'cspc' number (default 0)
1873 global
1874 {not available when compiled without the |+cscope|
1875 feature}
1876 {not in Vi}
1877 Determines how many components of the path to show in a list of tags.
1878 See |cscopepathcomp|.
1879
1880 *'cscopeprg'* *'csprg'*
1881'cscopeprg' 'csprg' string (default "cscope")
1882 global
1883 {not available when compiled without the |+cscope|
1884 feature}
1885 {not in Vi}
1886 Specifies the command to execute cscope. See |cscopeprg|.
1887 This option cannot be set from a |modeline| or in the |sandbox|, for
1888 security reasons.
1889
1890 *'cscopequickfix'* *'csqf'*
1891'cscopequickfix' 'csqf' string (default "")
1892 global
1893 {not available when compiled without the |+cscope|
1894 or |+quickfix| features}
1895 {not in Vi}
1896 Specifies whether to use quickfix window to show cscope results.
1897 See |cscopequickfix|.
1898
1899 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
1900'cscopetag' 'cst' boolean (default off)
1901 global
1902 {not available when compiled without the |+cscope|
1903 feature}
1904 {not in Vi}
1905 Use cscope for tag commands. See |cscope-options|.
1906 NOTE: This option is reset when 'compatible' is set.
1907
1908 *'cscopetagorder'* *'csto'*
1909'cscopetagorder' 'csto' number (default 0)
1910 global
1911 {not available when compiled without the |+cscope|
1912 feature}
1913 {not in Vi}
1914 Determines the order in which ":cstag" performs a search. See
1915 |cscopetagorder|.
1916 NOTE: This option is set to 0 when 'compatible' is set.
1917
1918 *'cscopeverbose'* *'csverb'*
1919 *'nocscopeverbose'* *'nocsverb'*
1920'cscopeverbose' 'csverb' boolean (default off)
1921 global
1922 {not available when compiled without the |+cscope|
1923 feature}
1924 {not in Vi}
1925 Give messages when adding a cscope database. See |cscopeverbose|.
1926 NOTE: This option is reset when 'compatible' is set.
1927
1928 *'debug'*
1929'debug' string (default "")
1930 global
1931 {not in Vi}
1932 When set to "msg", error messages that would otherwise be omitted will
1933 be given anyway. This is useful when debugging 'foldexpr' or
1934 'indentexpr'.
1935
1936 *'define'* *'def'*
1937'define' 'def' string (default "^\s*#\s*define")
1938 global or local to buffer |global-local|
1939 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001940 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00001941 pattern, just like for the "/" command. This option is used for the
1942 commands like "[i" and "[d" |include-search|. The 'isident' option is
1943 used to recognize the defined name after the match:
1944 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
1945 See |option-backslash| about inserting backslashes to include a space
1946 or backslash.
1947 The default value is for C programs. For C++ this value would be
1948 useful, to include const type declarations: >
1949 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
1950< When using the ":set" command, you need to double the backslashes!
1951
1952 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
1953'delcombine' 'deco' boolean (default off)
1954 global
1955 {not in Vi}
1956 {only available when compiled with the |+multi_byte|
1957 feature}
1958 If editing Unicode and this option is set, backspace and Normal mode
1959 "x" delete each combining character on its own. When it is off (the
1960 default) the character along with its combining characters are
1961 deleted.
1962 Note: When 'delcombine' is set "xx" may work different from "2x"!
1963
1964 This is useful for Arabic, Hebrew and many other languages where one
1965 may have combining characters overtop of base characters, and want
1966 to remove only the combining ones.
1967
1968 *'dictionary'* *'dict'*
1969'dictionary' 'dict' string (default "")
1970 global or local to buffer |global-local|
1971 {not in Vi}
1972 List of file names, separated by commas, that are used to lookup words
1973 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
1974 contain a list of words. This can be one word per line, or several
1975 words per line, separated by non-keyword characters (white space is
1976 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001977 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 after a comma are ignored, otherwise spaces are included in the file
1979 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00001980 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 Where to find a list of words?
1982 - On FreeBSD, there is the file "/usr/share/dict/words".
1983 - In the Simtel archive, look in the "msdos/linguist" directory.
1984 - In "miscfiles" of the GNU collection.
1985 The use of |:set+=| and |:set-=| is preferred when adding or removing
1986 directories from the list. This avoids problems when a future version
1987 uses another default.
1988 Backticks cannot be used in this option for security reasons.
1989
1990 *'diff'* *'nodiff'*
1991'diff' boolean (default off)
1992 local to window
1993 {not in Vi}
1994 {not available when compiled without the |+diff|
1995 feature}
1996 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001997 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001998
1999 *'dex'* *'diffexpr'*
2000'diffexpr' 'dex' string (default "")
2001 global
2002 {not in Vi}
2003 {not available when compiled without the |+diff|
2004 feature}
2005 Expression which is evaluated to obtain an ed-style diff file from two
2006 versions of a file. See |diff-diffexpr|.
2007 This option cannot be set from a |modeline| or in the |sandbox|, for
2008 security reasons.
2009
2010 *'dip'* *'diffopt'*
2011'diffopt' 'dip' string (default "filler")
2012 global
2013 {not in Vi}
2014 {not available when compiled without the |+diff|
2015 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002016 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 All are optional. Items must be separated by a comma.
2018
2019 filler Show filler lines, to keep the text
2020 synchronized with a window that has inserted
2021 lines at the same position. Mostly useful
2022 when windows are side-by-side and 'scrollbind'
2023 is set.
2024
2025 context:{n} Use a context of {n} lines between a change
2026 and a fold that contains unchanged lines.
2027 When omitted a context of six lines is used.
2028 See |fold-diff|.
2029
2030 icase Ignore changes in case of text. "a" and "A"
2031 are considered the same. Adds the "-i" flag
2032 to the "diff" command if 'diffexpr' is empty.
2033
2034 iwhite Ignore changes in amount of white space. Adds
2035 the "-b" flag to the "diff" command if
2036 'diffexpr' is empty. Check the documentation
2037 of the "diff" command for what this does
2038 exactly. It should ignore adding trailing
2039 white space, but not leading white space.
2040
2041 Examples: >
2042
2043 :set diffopt=filler,context:4
2044 :set diffopt=
2045 :set diffopt=filler
2046<
2047 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2048'digraph' 'dg' boolean (default off)
2049 global
2050 {not in Vi}
2051 {not available when compiled without the |+digraphs|
2052 feature}
2053 Enable the entering of digraphs in Insert mode with {char1} <BS>
2054 {char2}. See |digraphs|.
2055 NOTE: This option is reset when 'compatible' is set.
2056
2057 *'directory'* *'dir'*
2058'directory' 'dir' string (default for Amiga: ".,t:",
2059 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2060 for Unix: ".,~/tmp,/var/tmp,/tmp")
2061 global
2062 List of directory names for the swap file, separated with commas.
2063 - The swap file will be created in the first directory where this is
2064 possible.
2065 - Empty means that no swap file will be used (recovery is
2066 impossible!).
2067 - A directory "." means to put the swap file in the same directory as
2068 the edited file. On Unix, a dot is prepended to the file name, so
2069 it doesn't show in a directory listing. On MS-Windows the "hidden"
2070 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002071 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 put the swap file relative to where the edited file is. The leading
2073 "." is replaced with the path name of the edited file.
2074 - For Unix and Win32, if a directory ends in two path separators, the
2075 swap file name will be built from the complete path to the file
2076 with all path separators substituted to percent '%' signs. This will
2077 ensure file name uniqueness in the preserve directory.
2078 - Spaces after the comma are ignored, other spaces are considered part
2079 of the directory name. To have a space at the start of a directory
2080 name, precede it with a backslash.
2081 - To include a comma in a directory name precede it with a backslash.
2082 - A directory name may end in an ':' or '/'.
2083 - Environment variables are expanded |:set_env|.
2084 - Careful with '\' characters, type one before a space, type two to
2085 get one in the option (see |option-backslash|), for example: >
2086 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2087< - For backwards compatibility with Vim version 3.0 a '>' at the start
2088 of the option is removed.
2089 Using "." first in the list is recommended. This means that editing
2090 the same file twice will result in a warning. Using "/tmp" on Unix is
2091 discouraged: When the system crashes you lose the swap file.
2092 "/var/tmp" is often not cleared when rebooting, thus is a better
2093 choice than "/tmp". But it can contain a lot of files, your swap
2094 files get lost in the crowd. That is why a "tmp" directory in your
2095 home directory is tried first.
2096 The use of |:set+=| and |:set-=| is preferred when adding or removing
2097 directories from the list. This avoids problems when a future version
2098 uses another default.
2099 This option cannot be set from a |modeline| or in the |sandbox|, for
2100 security reasons.
2101 {Vi: directory to put temp file in, defaults to "/tmp"}
2102
2103 *'display'* *'dy'*
2104'display' 'dy' string (default "")
2105 global
2106 {not in Vi}
2107 Change the way text is displayed. This is comma separated list of
2108 flags:
2109 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002110 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 last line that doesn't fit is replaced with "@" lines.
2112 uhex Show unprintable characters hexadecimal as <xx>
2113 instead of using ^C and ~C.
2114
2115 *'eadirection'* *'ead'*
2116'eadirection' 'ead' string (default "both")
2117 global
2118 {not in Vi}
2119 {not available when compiled without the +vertsplit
2120 feature}
2121 Tells when the 'equalalways' option applies:
2122 ver vertically, width of windows is not affected
2123 hor horizontally, height of windows is not affected
2124 both width and height of windows is affected
2125
2126 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2127'edcompatible' 'ed' boolean (default off)
2128 global
2129 Makes the 'g' and 'c' flags of the ":substitute" command to be
2130 toggled each time the flag is given. See |complex-change|. See
2131 also 'gdefault' option.
2132 Switching this option on is discouraged!
2133
2134 *'encoding'* *'enc'* *E543*
2135'encoding' 'enc' string (default: "latin1" or value from $LANG)
2136 global
2137 {only available when compiled with the |+multi_byte|
2138 feature}
2139 {not in Vi}
2140 Sets the character encoding used inside Vim. It applies to text in
2141 the buffers, registers, Strings in expressions, text stored in the
2142 viminfo file, etc. It sets the kind of characters which Vim can work
2143 with. See |encoding-names| for the possible values.
2144
2145 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002146 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 It should normally be kept at its default value, or set when Vim
2148 starts up. See |multibyte|.
2149
2150 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2151 "utf-8". Although care has been taken to allow different values of
2152 'encoding', "utf-8" is the natural choice for the environment and
2153 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002154 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 versions, and to avoid changing the encoding of newly created files
2156 without your knowledge (in case 'fileencodings' is empty).
2157
2158 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002159 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 iconv() or as specified with 'charconvert'.
2161
2162 Normally 'encoding' will be equal to your current locale. This will
2163 be the default if Vim recognizes your environment settings. If
2164 'encoding' is not set to the current locale, 'termencoding' must be
2165 set to convert typed and displayed text. See |encoding-table|.
2166
2167 When you set this option, it fires the |EncodingChanged| autocommand
2168 event so that you can set up fonts if necessary.
2169
2170 When the option is set, the value is converted to lowercase. Thus
2171 you can set it with uppercase values too. Underscores are translated
2172 to '-' signs.
2173 When the encoding is recognized, it is changed to the standard name.
2174 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2175 "iso-8859-2" and "utf8" becomes "utf-8".
2176
2177 Note: "latin1" is also used when the encoding could not be detected.
2178 This only works when editing files in the same encoding! When the
2179 actual character set is not latin1, make sure 'fileencoding' and
2180 'fileencodings' are empty. When conversion is needed, switch to using
2181 utf-8.
2182
2183 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2184 You don't notice this while editing, but it does matter for the
2185 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2186 setting 'encoding' to one of these values instead of utf-8 only has
2187 effect for encoding used for files when 'fileencoding' is empty.
2188
2189 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2190 not set yet, the default for 'fileencodings' is changed.
2191
2192 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2193'endofline' 'eol' boolean (default on)
2194 local to buffer
2195 {not in Vi}
2196 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002197 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 option is automatically set when starting to edit a new file, unless
2199 the file does not have an <EOL> for the last line in the file, in
2200 which case it is reset. Normally you don't have to set or reset this
2201 option. When 'binary' is off the value is not used when writing the
2202 file. When 'binary' is on it is used to remember the presence of a
2203 <EOL> for the last line in the file, so that when you write the file
2204 the situation from the original file can be kept. But you can change
2205 it if you want to.
2206
2207 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2208'equalalways' 'ea' boolean (default on)
2209 global
2210 {not in Vi}
2211 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002212 splitting or closing a window. This also happens the moment the
2213 option is switched on. When off, splitting a window will reduce the
2214 size of the current window and leave the other windows the same. When
2215 closing a window the extra lines are given to the window next to it
2216 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 When mixing vertically and horizontally split windows, a minimal size
2218 is computed and some windows may be larger if there is room. The
2219 'eadirection' option tells in which direction the size is affected.
2220 Changing the height of a window can be avoided by setting
2221 'winfixheight'.
2222
2223 *'equalprg'* *'ep'*
2224'equalprg' 'ep' string (default "")
2225 global or local to buffer |global-local|
2226 {not in Vi}
2227 External program to use for "=" command. When this option is empty
2228 the internal formatting functions are used ('lisp', 'cindent' or
2229 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002230 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 about including spaces and backslashes.
2232 This option cannot be set from a |modeline| or in the |sandbox|, for
2233 security reasons.
2234
2235 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2236'errorbells' 'eb' boolean (default off)
2237 global
2238 Ring the bell (beep or screen flash) for error messages. This only
2239 makes a difference for error messages, the bell will be used always
2240 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002241 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 screen flash or do nothing.
2243
2244 *'errorfile'* *'ef'*
2245'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2246 others: "errors.err")
2247 global
2248 {not in Vi}
2249 {not available when compiled without the |+quickfix|
2250 feature}
2251 Name of the errorfile for the QuickFix mode (see |:cf|).
2252 When the "-q" command-line argument is used, 'errorfile' is set to the
2253 following argument. See |-q|.
2254 NOT used for the ":make" command. See 'makeef' for that.
2255 Environment variables are expanded |:set_env|.
2256 See |option-backslash| about including spaces and backslashes.
2257 This option cannot be set from a |modeline| or in the |sandbox|, for
2258 security reasons.
2259
2260 *'errorformat'* *'efm'*
2261'errorformat' 'efm' string (default is very long)
2262 global or local to buffer |global-local|
2263 {not in Vi}
2264 {not available when compiled without the |+quickfix|
2265 feature}
2266 Scanf-like description of the format for the lines in the error file
2267 (see |errorformat|).
2268
2269 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2270'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2271 global
2272 {not in Vi}
2273 Function keys that start with an <Esc> are recognized in Insert
2274 mode. When this option is off, the cursor and function keys cannot be
2275 used in Insert mode if they start with an <Esc>. The advantage of
2276 this is that the single <Esc> is recognized immediately, instead of
2277 after one second. Instead of resetting this option, you might want to
2278 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2279 when 'esckeys' is off, you can still map anything, but the cursor keys
2280 won't work by default.
2281 NOTE: This option is set to the Vi default value when 'compatible' is
2282 set and to the Vim default value when 'compatible' is reset.
2283
2284 *'eventignore'* *'ei'*
2285'eventignore' 'ei' string (default "")
2286 global
2287 {not in Vi}
2288 {not available when compiled without the |+autocmd|
2289 feature}
2290 A list of autocommand event names, which are to be ignored.
2291 When set to "all", all autocommand events are ignored, autocommands
2292 will not be executed.
2293 Otherwise this is a comma separated list of event names. Example: >
2294 :set ei=WinEnter,WinLeave
2295<
2296 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2297'expandtab' 'et' boolean (default off)
2298 local to buffer
2299 {not in Vi}
2300 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002301 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2303 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2304 NOTE: This option is reset when 'compatible' is set.
2305
2306 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2307'exrc' 'ex' boolean (default off)
2308 global
2309 {not in Vi}
2310 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2311 directory. If you switch this option on you should also consider
2312 setting the 'secure' option (see |initialization|). Using a local
2313 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2314 also see |.vimrc| and |gui-init|.
2315 This option cannot be set from a |modeline| or in the |sandbox|, for
2316 security reasons.
2317
2318 *'fileencoding'* *'fenc'* *E213*
2319'fileencoding' 'fenc' string (default: "")
2320 local to buffer
2321 {only available when compiled with the |+multi_byte|
2322 feature}
2323 {not in Vi}
2324 Sets the character encoding for the file of this buffer.
2325 When 'fileencoding' is different from 'encoding', conversion will be
2326 done when reading and writing the file.
2327 When 'fileencoding' is empty, the same value as 'encoding' will be
2328 used (no conversion when reading or writing a file).
2329 WARNING: Conversion can cause loss of information! When
2330 'encoding' is "utf-8" conversion is most likely done in a way
2331 that the reverse conversion results in the same text. When
2332 'encoding' is not "utf-8" some characters may be lost!
2333 See 'encoding' for the possible values. Additionally, values may be
2334 specified that can be handled by the converter, see
2335 |mbyte-conversion|.
2336 When reading a file 'fileencoding' will be set from 'fileencodings'.
2337 To read a file in a certain encoding it won't work by setting
2338 'fileencoding', use the |++enc| argument.
2339 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2340 When the option is set, the value is converted to lowercase. Thus
2341 you can set it with uppercase values too. '_' characters are
2342 replaced with '-'. If a name is recognized from the list for
2343 'encoding', it is replaced by the standard name. For example
2344 "ISO8859-2" becomes "iso-8859-2".
2345 When this option is set, after starting to edit a file, the 'modified'
2346 option is set, because the file would be different when written.
2347 If you do this in a modeline, you might want to set 'nomodified' to
2348 avoid this.
2349 This option can not be changed when 'modifiable' is off.
2350
2351 *'fe'*
2352 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002353 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 old short name was 'fe', which is no longer used.
2355
2356 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002357'fileencodings' 'fencs' string (default: "ucs-bom",
2358 "ucs-bom,utf-8,default,latin1" when
2359 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 global
2361 {only available when compiled with the |+multi_byte|
2362 feature}
2363 {not in Vi}
2364 This is a list of character encodings considered when starting to edit
2365 an existing file. When a file is read, Vim tries to use the first
2366 mentioned character encoding. If an error is detected, the next one
2367 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002368 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002369 an empty string, which means the value of 'encoding' is used.
2370 WARNING: Conversion can cause loss of information! When
2371 'encoding' is "utf-8" (or one of the other Unicode variants)
2372 conversion is most likely done in a way that the reverse
2373 conversion results in the same text. When 'encoding' is not
2374 "utf-8" special characters may be lost!
2375 For an empty file or a file with only ASCII characters most encodings
2376 will work and the first entry of 'fileencodings' will be used (except
2377 "ucs-bom", which requires the BOM to be present). If you prefer
2378 another encoding use an BufReadPost autocommand event to test if your
2379 preferred encoding is to be used. Example: >
2380 au BufReadPost * if search('\S', 'w') == 0 |
2381 \ set fenc=iso-2022-jp | endif
2382< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2383 non-blank characters.
2384 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2385 is always empty then. This means that a non-existing file may get a
2386 different encoding than an empty file.
2387 The special value "ucs-bom" can be used to check for a Unicode BOM
2388 (Byte Order Mark) at the start of the file. It must not be preceded
2389 by "utf-8" or another Unicode encoding for this to work properly.
2390 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2391 because Vim cannot detect an error, thus the encoding is always
2392 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002393 The special value "default" can be used for the encoding from the
2394 environment. This is the default value for 'encoding'. It is useful
2395 when 'encoding' is set to "utf-8" and your environment uses a
2396 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 WRONG VALUES: WHAT'S WRONG:
2398 latin1,utf-8 "latin1" will always be used
2399 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2400 file
2401 cp1250,latin1 "cp1250" will always be used
2402 If 'fileencodings' is empty, 'fileencoding' is not modified.
2403 See 'fileencoding' for the possible values.
2404 Setting this option does not have an effect until the next time a file
2405 is read.
2406
2407 *'fileformat'* *'ff'*
2408'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2409 Unix default: "unix",
2410 Macintosh default: "mac")
2411 local to buffer
2412 {not in Vi}
2413 This gives the <EOL> of the current buffer, which is used for
2414 reading/writing the buffer from/to a file:
2415 dos <CR> <NL>
2416 unix <NL>
2417 mac <CR>
2418 When "dos" is used, CTRL-Z at the end of a file is ignored.
2419 See |file-formats| and |file-read|.
2420 For the character encoding of the file see 'fileencoding'.
2421 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2422 works like it was set to "unix'.
2423 This option is set automatically when starting to edit a file and
2424 'fileformats' is not empty and 'binary' is off.
2425 When this option is set, after starting to edit a file, the 'modified'
2426 option is set, because the file would be different when written.
2427 This option can not be changed when 'modifiable' is off.
2428 For backwards compatibility: When this option is set to "dos",
2429 'textmode' is set, otherwise 'textmode' is reset.
2430
2431 *'fileformats'* *'ffs'*
2432'fileformats' 'ffs' string (default:
2433 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2434 Vim Unix: "unix,dos",
2435 Vim Mac: "mac,unix,dos",
2436 Vi Cygwin: "unix,dos",
2437 Vi others: "")
2438 global
2439 {not in Vi}
2440 This gives the end-of-line (<EOL>) formats that will be tried when
2441 starting to edit a new buffer and when reading a file into an existing
2442 buffer:
2443 - When empty, the format defined with 'fileformat' will be used
2444 always. It is not set automatically.
2445 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002446 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 'fileformats' name will be used when a file is read into an existing
2448 buffer, no matter what 'fileformat' for that buffer is set to.
2449 - When more than one name is present, separated by commas, automatic
2450 <EOL> detection will be done when reading a file. When starting to
2451 edit a file, a check is done for the <EOL>:
2452 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2453 'fileformat' is set to "dos".
2454 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002455 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456 preceding <CR>, "unix" is preferred over "dos".
2457 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2458 This means that "mac" is only chosen when "unix" is not present,
2459 or when no <NL> is found in the file, and when "dos" is not
2460 present, or no <CR><NL> is present in the file.
2461 Also if "unix" was first chosen, but the first <CR> is before
2462 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2463 the file, then 'fileformat' is set to "mac".
2464 4. If 'fileformat' is still not set, the first name from
2465 'fileformats' is used.
2466 When reading a file into an existing buffer, the same is done, but
2467 this happens like 'fileformat' has been set appropriately for that
2468 file only, the option is not changed.
2469 When 'binary' is set, the value of 'fileformats' is not used.
2470
2471 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2472 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2473 done:
2474 - When 'fileformats' is empty, there is no automatic detection. Dos
2475 format will be used.
2476 - When 'fileformats' is set to one or more names, automatic detection
2477 is done. This is based on the first <NL> in the file: If there is a
2478 <CR> in front of it, Dos format is used, otherwise Unix format is
2479 used.
2480 Also see |file-formats|.
2481 For backwards compatibility: When this option is set to an empty
2482 string or one format (no comma is included), 'textauto' is reset,
2483 otherwise 'textauto' is set.
2484 NOTE: This option is set to the Vi default value when 'compatible' is
2485 set and to the Vim default value when 'compatible' is reset.
2486
2487 *'filetype'* *'ft'*
2488'filetype' 'ft' string (default: "")
2489 local to buffer
2490 {not in Vi}
2491 {not available when compiled without the |+autocmd|
2492 feature}
2493 When this option is set, the FileType autocommand event is triggered.
2494 All autocommands that match with the value of this option will be
2495 executed. Thus the value of 'filetype' is used in place of the file
2496 name.
2497 Otherwise this option does not always reflect the current file type.
2498 This option is normally set when the file type is detected. To enable
2499 this use the ":filetype on" command. |:filetype|
2500 Setting this option to a different value is most useful in a modeline,
2501 for a file for which the file type is not automatically recognized.
2502 Example, for in an IDL file: >
2503 /* vim: set filetype=idl : */
2504< |FileType| |filetypes|
2505 Do not confuse this option with 'osfiletype', which is for the file
2506 type that is actually stored with the file.
2507 This option is not copied to another buffer, independent of the 's' or
2508 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002509 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510
2511 *'fillchars'* *'fcs'*
2512'fillchars' 'fcs' string (default "vert:|,fold:-")
2513 global
2514 {not in Vi}
2515 {not available when compiled without the |+windows|
2516 and |+folding| features}
2517 Characters to fill the statuslines and vertical separators.
2518 It is a comma separated list of items:
2519
2520 item default Used for ~
2521 stl:c ' ' or '^' statusline of the current window
2522 stlnc:c ' ' or '-' statusline of the non-current windows
2523 vert:c '|' vertical separators |:vsplit|
2524 fold:c '-' filling 'foldtext'
2525 diff:c '-' deleted lines of the 'diff' option
2526
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002527 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528 "stlnc" the space will be used when there is highlighting, '^' or '-'
2529 otherwise.
2530
2531 Example: >
2532 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2533< This is similar to the default, except that these characters will also
2534 be used when there is highlighting.
2535
2536 The highlighting used for these items:
2537 item highlight group ~
2538 stl:c StatusLine |hl-StatusLine|
2539 stlnc:c StatusLineNC |hl-StatusLineNC|
2540 vert:c VertSplit |hl-VertSplit|
2541 fold:c Folded |hl-Folded|
2542 diff:c DiffDelete |hl-DiffDelete|
2543
2544 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2545'fkmap' 'fk' boolean (default off) *E198*
2546 global
2547 {not in Vi}
2548 {only available when compiled with the |+rightleft|
2549 feature}
2550 When on, the keyboard is mapped for the Farsi character set.
2551 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002552 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553
2554 *'foldclose'* *'fcl'*
2555'foldclose' 'fcl' string (default "")
2556 global
2557 {not in Vi}
2558 {not available when compiled without the |+folding|
2559 feature}
2560 When set to "all", a fold is closed when the cursor isn't in it and
2561 its level is higher than 'foldlevel'. Useful if you want folds to
2562 automatically close when moving out of them.
2563
2564 *'foldcolumn'* *'fdc'*
2565'foldcolumn' 'fdc' number (default 0)
2566 local to window
2567 {not in Vi}
2568 {not available when compiled without the |+folding|
2569 feature}
2570 When non-zero, a column with the specified width is shown at the side
2571 of the window which indicates open and closed folds. The maximum
2572 value is 12.
2573 See |folding|.
2574
2575 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2576'foldenable' 'fen' boolean (default on)
2577 local to window
2578 {not in Vi}
2579 {not available when compiled without the |+folding|
2580 feature}
2581 When off, all folds are open. This option can be used to quickly
2582 switch between showing all text unfolded and viewing the text with
2583 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002584 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 'foldenable' is off.
2586 This option is set by commands that create a new fold or close a fold.
2587 See |folding|.
2588
2589 *'foldexpr'* *'fde'*
2590'foldexpr' 'fde' string (default: "0")
2591 local to window
2592 {not in Vi}
2593 {not available when compiled without the |+folding|
2594 or |+eval| feature}
2595 The expression used for when 'foldmethod' is "expr". It is evaluated
2596 for each line to obtain its fold level. See |fold-expr|. Also see
2597 |eval-sandbox|.
2598
2599 *'foldignore'* *'fdi'*
2600'foldignore' 'fdi' string (default: "#")
2601 local to window
2602 {not in Vi}
2603 {not available when compiled without the |+folding|
2604 feature}
2605 Used only when 'foldmethod' is "indent". Lines starting with
2606 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002607 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 The default "#" works well for C programs. See |fold-indent|.
2609
2610 *'foldlevel'* *'fdl'*
2611'foldlevel' 'fdl' number (default: 0)
2612 local to window
2613 {not in Vi}
2614 {not available when compiled without the |+folding|
2615 feature}
2616 Sets the fold level: Folds with a higher level will be closed.
2617 Setting this option to zero will close all folds. Higher numbers will
2618 close fewer folds.
2619 This option is set by commands like |zm|, |zM| and |zR|.
2620 See |fold-foldlevel|.
2621
2622 *'foldlevelstart'* *'fdls'*
2623'foldlevelstart' 'fdls' number (default: -1)
2624 global
2625 {not in Vi}
2626 {not available when compiled without the |+folding|
2627 feature}
2628 Sets 'foldlevel' when starting to edit another buffer in a window.
2629 Useful to always start editing with all folds closed (value zero),
2630 some folds closed (one) or no folds closed (99).
2631 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 ignores this option and closes all folds.
2634 It is also done before BufReadPre autocommands, to allow an autocmd to
2635 overrule the 'foldlevel' value for specific files.
2636 When the value is negative, it is not used.
2637
2638 *'foldmarker'* *'fmr'* *E536*
2639'foldmarker' 'fmr' string (default: "{{{,}}}")
2640 local to window
2641 {not in Vi}
2642 {not available when compiled without the |+folding|
2643 feature}
2644 The start and end marker used when 'foldmethod' is "marker". There
2645 must be one comma, which separates the start and end marker. The
2646 marker is a literal string (a regular expression would be too slow).
2647 See |fold-marker|.
2648
2649 *'foldmethod'* *'fdm'*
2650'foldmethod' 'fdm' string (default: "manual")
2651 local to window
2652 {not in Vi}
2653 {not available when compiled without the |+folding|
2654 feature}
2655 The kind of folding used for the current window. Possible values:
2656 |fold-manual| manual Folds are created manually.
2657 |fold-indent| indent Lines with equal indent form a fold.
2658 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2659 |fold-marker| marker Markers are used to specify folds.
2660 |fold-syntax| syntax Syntax highlighting items specify folds.
2661 |fold-diff| diff Fold text that is not changed.
2662
2663 *'foldminlines'* *'fml'*
2664'foldminlines' 'fml' number (default: 1)
2665 local to window
2666 {not in Vi}
2667 {not available when compiled without the |+folding|
2668 feature}
2669 Sets the minimum number of screen lines for a fold to be displayed
2670 closed. Also for manually closed folds.
2671 Note that this only has an effect of what is displayed. After using
2672 "zc" to close a fold, which is displayed open because it's smaller
2673 than 'foldminlines', a following "zc" may close a containing fold.
2674
2675 *'foldnestmax'* *'fdn'*
2676'foldnestmax' 'fdn' number (default: 20)
2677 local to window
2678 {not in Vi}
2679 {not available when compiled without the |+folding|
2680 feature}
2681 Sets the maximum nesting of folds for the "indent" and "syntax"
2682 methods. This avoids that too many folds will be created. Using more
2683 than 20 doesn't work, because the internal limit is 20.
2684
2685 *'foldopen'* *'fdo'*
2686'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2687 search,tag,undo")
2688 global
2689 {not in Vi}
2690 {not available when compiled without the |+folding|
2691 feature}
2692 Specifies for which type of commands folds will be opened, if the
2693 command moves the cursor into a closed fold. It is a comma separated
2694 list of items.
2695 item commands ~
2696 all any
2697 block "(", "{", "[[", "[{", etc.
2698 hor horizontal movements: "l", "w", "fx", etc.
2699 insert any command in Insert mode
2700 jump far jumps: "G", "gg", etc.
2701 mark jumping to a mark: "'m", CTRL-O, etc.
2702 percent "%"
2703 quickfix ":cn", ":crew", ":make", etc.
2704 search search for a pattern: "/", "n", "*", "gd", etc.
2705 (not for a search pattern in a ":" command)
2706 tag jumping to a tag: ":ta", CTRL-T, etc.
2707 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002708 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 the |zv| command to the mapping to get the same effect.
2710 When a movement command is used for an operator (e.g., "dl" or "y%")
2711 this option is not used. This means the operator will include the
2712 whole closed fold.
2713 Note that vertical movements are not here, because it would make it
2714 very difficult to move onto a closed fold.
2715 In insert mode the folds containing the cursor will always be open
2716 when text is inserted.
2717 To close folds you can re-apply 'foldlevel' with the |zx| command or
2718 set the 'foldclose' option to "all".
2719
2720 *'foldtext'* *'fdt'*
2721'foldtext' 'fdt' string (default: "foldtext()")
2722 local to window
2723 {not in Vi}
2724 {not available when compiled without the |+folding|
2725 feature}
2726 An expression which is used to specify the text displayed for a closed
2727 fold. See |fold-foldtext|.
2728
2729 *'formatoptions'* *'fo'*
2730'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2731 local to buffer
2732 {not in Vi}
2733 This is a sequence of letters which describes how automatic
2734 formatting is to be done. See |fo-table|. When the 'paste' option is
2735 on, no formatting is done (like 'formatoptions' is empty). Commas can
2736 be inserted for readability.
2737 To avoid problems with flags that are added in the future, use the
2738 "+=" and "-=" feature of ":set" |add-option-flags|.
2739 NOTE: This option is set to the Vi default value when 'compatible' is
2740 set and to the Vim default value when 'compatible' is reset.
2741
Bram Moolenaar86b68352004-12-27 21:59:20 +00002742 *'formatlistpat'* *'flp'*
2743'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2744 local to buffer
2745 {not in Vi}
2746 A pattern that is used to recognize a list header. This is used for
2747 the "n" flag in 'formatoptions'.
2748 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002749 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002750 while still checking more characters. There must be a character
2751 following the pattern, when it matches the whole line it is handled
2752 like there is no match.
2753 The default recognizes a number, followed by an optional punctuation
2754 character and white space.
2755
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 *'formatprg'* *'fp'*
2757'formatprg' 'fp' string (default "")
2758 global
2759 {not in Vi}
2760 The name of an external program that will be used to format the lines
2761 selected with the "gq" command. The program must take the input on
2762 stdin and produce the output on stdout. The Unix program "fmt" is
2763 such a program. If this option is an empty string, the internal
2764 format function will be used |C-indenting|. Environment variables are
2765 expanded |:set_env|. See |option-backslash| about including spaces
2766 and backslashes.
2767 This option cannot be set from a |modeline| or in the |sandbox|, for
2768 security reasons.
2769
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002770 *'fsync'* *'fs'*
2771'fsync' 'fs' boolean (default on)
2772 global
2773 {not in Vi}
2774 When on, the library function fsync() will be called after writing a
2775 file. This will flush a file to disk, ensuring that it is safely
2776 written even on filesystems which do metadata-only journaling. This
2777 will force the harddrive to spin up on Linux systems running in laptop
2778 mode, so it may be undesirable in some situations. Be warned that
2779 turning this off increases the chances of data loss after a crash. On
2780 systems without an fsync() implementation, this variable is always
2781 off.
2782 Also see 'swapsync' for controlling fsync() on swap files.
2783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2785'gdefault' 'gd' boolean (default off)
2786 global
2787 {not in Vi}
2788 When on, the ":substitute" flag 'g' is default on. This means that
2789 all matches in a line are substituted instead of one. When a 'g' flag
2790 is given to a ":substitute" command, this will toggle the substitution
2791 of all or one match. See |complex-change|.
2792
2793 command 'gdefault' on 'gdefault' off ~
2794 :s/// subst. all subst. one
2795 :s///g subst. one subst. all
2796 :s///gg subst. all subst. one
2797
2798 NOTE: This option is reset when 'compatible' is set.
2799
2800 *'grepformat'* *'gfm'*
2801'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2802 global
2803 {not in Vi}
2804 Format to recognize for the ":grep" command output.
2805 This is a scanf-like string that uses the same format as the
2806 'errorformat' option: see |errorformat|.
2807
2808 *'grepprg'* *'gp'*
2809'grepprg' 'gp' string (default "grep -n ",
2810 Unix: "grep -n $* /dev/null",
2811 Win32: "findstr /n" or "grep -n",
2812 VMS: "SEARCH/NUMBERS ")
2813 global or local to buffer |global-local|
2814 {not in Vi}
Bram Moolenaar7c626922005-02-07 22:01:03 +00002815 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 and '#' characters, which are expanded like when used in a command-
2817 line. The placeholder "$*" is allowed to specify where the arguments
2818 will be included. Environment variables are expanded |:set_env|. See
2819 |option-backslash| about including spaces and backslashes.
2820 When your "grep" accepts the "-H" argument, use this to make ":grep"
2821 also work well with a single file: >
2822 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002823< Special value: When 'grepprg' is set to "internal" the |:grep| command
2824 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002825 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002826 apply equally to 'grepprg'.
2827 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2828 otherwise it's "grep -n".
2829 This option cannot be set from a |modeline| or in the |sandbox|, for
2830 security reasons.
2831
2832 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2833'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2834 ve:ver35-Cursor,
2835 o:hor50-Cursor,
2836 i-ci:ver25-Cursor/lCursor,
2837 r-cr:hor20-Cursor/lCursor,
2838 sm:block-Cursor
2839 -blinkwait175-blinkoff150-blinkon175",
2840 for MS-DOS and Win32 console:
2841 "n-v-c:block,o:hor50,i-ci:hor15,
2842 r-cr:hor30,sm:block")
2843 global
2844 {not in Vi}
2845 {only available when compiled with GUI enabled, and
2846 for MS-DOS and Win32 console}
2847 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002848 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849 the height of the cursor can be changed. This can be done by
2850 specifying a block cursor, or a percentage for a vertical or
2851 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002852 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002854 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 mode-list and an argument-list:
2856 mode-list:argument-list,mode-list:argument-list,..
2857 The mode-list is a dash separated list of these modes:
2858 n Normal mode
2859 v Visual mode
2860 ve Visual mode with 'selection' "exclusive" (same as 'v',
2861 if not specified)
2862 o Operator-pending mode
2863 i Insert mode
2864 r Replace mode
2865 c Command-line Normal (append) mode
2866 ci Command-line Insert mode
2867 cr Command-line Replace mode
2868 sm showmatch in Insert mode
2869 a all modes
2870 The argument-list is a dash separated list of these arguments:
2871 hor{N} horizontal bar, {N} percent of the character height
2872 ver{N} vertical bar, {N} percent of the character width
2873 block block cursor, fills the whole character
2874 [only one of the above three should be present]
2875 blinkwait{N} *cursor-blinking*
2876 blinkon{N}
2877 blinkoff{N}
2878 blink times for cursor: blinkwait is the delay before
2879 the cursor starts blinking, blinkon is the time that
2880 the cursor is shown and blinkoff is the time that the
2881 cursor is not shown. The times are in msec. When one
2882 of the numbers is zero, there is no blinking. The
2883 default is: "blinkwait700-blinkon400-blinkoff250".
2884 These numbers are used for a missing entry. This
2885 means that blinking is enabled by default. To switch
2886 blinking off you can use "blinkon0". The cursor only
2887 blinks when Vim is waiting for input, not while
2888 executing a command.
2889 To make the cursor blink in an xterm, see
2890 |xterm-blink|.
2891 {group-name}
2892 a highlight group name, that sets the color and font
2893 for the cursor
2894 {group-name}/{group-name}
2895 Two highlight group names, the first is used when
2896 no language mappings are used, the other when they
2897 are. |language-mapping|
2898
2899 Examples of parts:
2900 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
2901 block cursor with colors from the "nCursor"
2902 highlight group
2903 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
2904 In Insert and Command-line Insert mode, use a
2905 30% vertical bar cursor with colors from the
2906 "iCursor" highlight group. Blink a bit
2907 faster.
2908
2909 The 'a' mode is different. It will set the given argument-list for
2910 all modes. It does not reset anything to defaults. This can be used
2911 to do a common setting for all modes. For example, to switch off
2912 blinking: "a:blinkon0"
2913
2914 Examples of cursor highlighting: >
2915 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
2916 :highlight Cursor gui=NONE guifg=bg guibg=fg
2917<
2918 *'guifont'* *'gfn'*
2919 *E235* *E596* *E610* *E611*
2920'guifont' 'gfn' string (default "")
2921 global
2922 {not in Vi}
2923 {only available when compiled with GUI enabled}
2924 This is a list of fonts which will be used for the GUI version of Vim.
2925 In its simplest form the value is just one font name. When
2926 the font cannot be found you will get an error message. To try other
2927 font names a list can be specified, font names separated with commas.
2928 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00002929
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 When 'guifontset' is not empty, 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00002931
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 Spaces after a comma are ignored. To include a comma in a font name
2933 precede it with a backslash. Setting an option requires an extra
2934 backslash before a space and a backslash. See also
2935 |option-backslash|. For example: >
2936 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00002937< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00002939
2940 If none of the fonts can be loaded, Vim will keep the current setting.
2941 If an empty font list is given, Vim will try using other resource
2942 settings (for X, it will use the Vim.font resource), and finally it
2943 will try some builtin default which should always be there ("7x13" in
2944 the case of X). The font names given should be "normal" fonts. Vim
2945 will try to find the related bold and italic fonts.
2946
2947 For Win32, GTK and Photon only: >
2948 :set guifont=*
2949< will bring up a font requester, where you can pick the font you want.
2950
2951 The font name depends on the GUI used. See |setting-guifont| for a
2952 way to set 'guifont' for various systems.
2953
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 For the GTK+ 2 GUI the font name looks like this: >
2955 :set guifont=Andale\ Mono\ 11
2956< That's all. XLFDs are no longer accepted.
2957 *E236*
2958 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00002959 width). An exception is GTK 2: all fonts are accepted, but
2960 mono-spaced fonts look best.
2961
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962 To preview a font on X11, you might be able to use the "xfontsel"
2963 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00002964
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 For the Win32 GUI *E244* *E245*
2966 - takes these options in the font name:
2967 hXX - height is XX (points, can be floating-point)
2968 wXX - width is XX (points, can be floating-point)
2969 b - bold
2970 i - italic
2971 u - underline
2972 s - strikeout
2973 cXX - character set XX. valid charsets are: ANSI, ARABIC,
2974 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
2975 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
2976 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002977 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
2979 Use a ':' to separate the options.
2980 - A '_' can be used in the place of a space, so you don't need to use
2981 backslashes to escape the spaces.
2982 - Examples: >
2983 :set guifont=courier_new:h12:w5:b:cRUSSIAN
2984 :set guifont=Andale_Mono:h7.5:w4.5
2985< See also |font-sizes|.
2986
2987 *'guifontset'* *'gfs'*
2988 *E250* *E252* *E234* *E597* *E598*
2989'guifontset' 'gfs' string (default "")
2990 global
2991 {not in Vi}
2992 {only available when compiled with GUI enabled and
2993 with the |+xfontset| feature}
2994 {not available in the GTK+ 2 GUI}
2995 When not empty, specifies two (or more) fonts to be used. The first
2996 one for normal English, the second one for your special language. See
2997 |xfontset|.
2998 Setting this option also means that all font names will be handled as
2999 a fontset name. Also the ones used for the "font" argument of the
3000 |:highlight| command.
3001 The fonts must match with the current locale. If fonts for the
3002 character sets that the current locale uses are not included, setting
3003 'guifontset' will fail.
3004 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3005 the comma-separated names are alternative names, one of which will be
3006 used. In 'guifontset' the whole string is one fontset name,
3007 including the commas. It is not possible to specify alternative
3008 fontset names.
3009 This example works on many X11 systems: >
3010 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3011<
3012 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3013'guifontwide' 'gfw' string (default "")
3014 global
3015 {not in Vi}
3016 {only available when compiled with GUI enabled}
3017 When not empty, specifies a comma-separated list of fonts to be used
3018 for double-width characters. The first font that can be loaded is
3019 used.
3020 Note: The size of these fonts must be exactly twice as wide as the one
3021 specified with 'guifont' and the same height.
3022
3023 All GUI versions but GTK+ 2:
3024
3025 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3026 'guifontset' is empty or invalid.
3027 When 'guifont' is set and a valid font is found in it and
3028 'guifontwide' is empty Vim will attempt to find a matching
3029 double-width font and set 'guifontwide' to it.
3030
3031 GTK+ 2 GUI only: *guifontwide_gtk2*
3032
3033 If set and valid, 'guifontwide' is always used for double width
3034 characters, even if 'encoding' is not set to "utf-8".
3035 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003036 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 font for characters not available in 'guifont'. Thus you do not need
3038 to set 'guifontwide' at all unless you want to override the choice
3039 made by Pango/Xft.
3040
3041 *'guiheadroom'* *'ghr'*
3042'guiheadroom' 'ghr' number (default 50)
3043 global
3044 {not in Vi} {only for GTK and X11 GUI}
3045 The number of pixels subtracted from the screen height when fitting
3046 the GUI window on the screen. Set this before the GUI is started,
3047 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003048 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 lines will be left for window decorations and other items on the
3050 screen. Set it to a negative value to allow windows taller than the
3051 screen.
3052
3053 *'guioptions'* *'go'*
3054'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
3055 "agimrLtT" (GTK, Motif and Athena)
3056 global
3057 {not in Vi}
3058 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003059 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 sequence of letters which describes what components and options of the
3061 GUI should be used.
3062 To avoid problems with flags that are added in the future, use the
3063 "+=" and "-=" feature of ":set" |add-option-flags|.
3064
3065 Valid letters are as follows:
3066 *guioptions_a*
3067 'a' Autoselect: If present, then whenever VISUAL mode is started,
3068 or the Visual area extended, Vim tries to become the owner of
3069 the windowing system's global selection. This means that the
3070 Visually highlighted text is available for pasting into other
3071 applications as well as into Vim itself. When the Visual mode
3072 ends, possibly due to an operation on the text, or when an
3073 application wants to paste the selection, the highlighted text
3074 is automatically yanked into the "* selection register.
3075 Thus the selection is still available for pasting into other
3076 applications after the VISUAL mode has ended.
3077 If not present, then Vim won't become the owner of the
3078 windowing system's global selection unless explicitly told to
3079 by a yank or delete operation for the "* register.
3080 The same applies to the modeless selection.
3081
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003082 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 applies to the modeless selection.
3084
3085 'guioptions' autoselect Visual autoselect modeless ~
3086 "" - -
3087 "a" yes yes
3088 "A" - yes
3089 "aA" yes yes
3090
3091 'c' Use console dialogs instead of popup dialogs for simple
3092 choices.
3093
3094 'f' Foreground: Don't use fork() to detach the GUI from the shell
3095 where it was started. Use this for programs that wait for the
3096 editor to finish (e.g., an e-mail program). Alternatively you
3097 can use "gvim -f" or ":gui -f" to start the GUI in the
3098 foreground. |gui-fork|
3099 Note: Set this option in the vimrc file. The forking may have
3100 happened already when the gvimrc file is read.
3101
3102 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3103 corner of the window. It's black&white on non-GTK, because of
3104 limitations of X11. For a color icon, see |X11-icon|.
3105
3106 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003107 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 that this flag must be added in the .vimrc file, before
3109 switching on syntax or filetype recognition (when the .gvimrc
3110 file is sourced the system menu has already been loaded; the
3111 ":syntax on" and ":filetype on" commands load the menu too).
3112 'g' Grey menu items: Make menu items that are not active grey. If
3113 'g' is not included inactive menu items are not shown at all.
3114 Exception: Athena will always use grey menu items.
3115
3116 't' Include tearoff menu items. Currently only works for Win32,
3117 GTK+, and Motif 1.2 GUI.
3118 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and
3119 Athena GUIs.
3120
3121 'r' Right-hand scrollbar is always present.
3122 'R' Right-hand scrollbar is present when there is a vertically
3123 split window.
3124 'l' Left-hand scrollbar is always present.
3125 'L' Left-hand scrollbar is present when there is a vertically
3126 split window.
3127 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3128 the longest visible line, or on the cursor line if the 'h'
3129 flag is included. |gui-horiz-scroll|
3130 'h' Limit horizontal scrollbar size to the length of the cursor
3131 line. Reduces computations. |gui-horiz-scroll|
3132
3133 And yes, you may even have scrollbars on the left AND the right if
3134 you really want to :-). See |gui-scrollbars| for more information.
3135
3136 'v' Use a vertical button layout for dialogs. When not included,
3137 a horizontal layout is preferred, but when it doesn't fit a
3138 vertical layout is used anyway.
3139 'p' Use Pointer callbacks for X11 GUI. This is required for some
3140 window managers. If the cursor is not blinking or hollow at
3141 the right moment, try adding this flag. This must be done
3142 before starting the GUI. Set it in your gvimrc. Adding or
3143 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003144 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145
3146 *'guipty'* *'noguipty'*
3147'guipty' boolean (default on)
3148 global
3149 {not in Vi}
3150 {only available when compiled with GUI enabled}
3151 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3152 I/O to/from shell commands. See |gui-pty|.
3153
3154 *'helpfile'* *'hf'*
3155'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3156 (others) "$VIMRUNTIME/doc/help.txt")
3157 global
3158 {not in Vi}
3159 Name of the main help file. All distributed help files should be
3160 placed together in one directory. Additionally, all "doc" directories
3161 in 'runtimepath' will be used.
3162 Environment variables are expanded |:set_env|. For example:
3163 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003164 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 spaces and backslashes.
3166 This option cannot be set from a |modeline| or in the |sandbox|, for
3167 security reasons.
3168
3169 *'helpheight'* *'hh'*
3170'helpheight' 'hh' number (default 20)
3171 global
3172 {not in Vi}
3173 {not available when compiled without the +windows
3174 feature}
3175 Minimal initial height of the help window when it is opened with the
3176 ":help" command. The initial height of the help window is half of the
3177 current window, or (when the 'ea' option is on) the same as other
3178 windows. When the height is less than 'helpheight', the height is
3179 set to 'helpheight'. Set to zero to disable.
3180
3181 *'helplang'* *'hlg'*
3182'helplang' 'hlg' string (default: messages language or empty)
3183 global
3184 {only available when compiled with the |+multi_lang|
3185 feature}
3186 {not in Vi}
3187 Comma separated list of languages. Vim will use the first language
3188 for which the desired help can be found. The English help will always
3189 be used as a last resort. You can add "en" to prefer English over
3190 another language, but that will only find tags that exist in that
3191 language and not in the English help.
3192 Example: >
3193 :set helplang=de,it
3194< This will first search German, then Italian and finally English help
3195 files.
3196 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3197 try to find the tag in the current language before using this option.
3198 See |help-translated|.
3199
3200 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3201'hidden' 'hid' boolean (default off)
3202 global
3203 {not in Vi}
3204 When off a buffer is unloaded when it is |abandon|ed. When on a
3205 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3206 displayed in another window, it does not become hidden, of course.
3207 The commands that move through the buffer list sometimes make a buffer
3208 hidden although the 'hidden' option is off: When the buffer is
3209 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003210 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003211 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 This option is set for one command with ":hide {command}" |:hide|.
3213 WARNING: It's easy to forget that you have changes in hidden buffers.
3214 Think twice when using ":q!" or ":qa!".
3215
3216 *'highlight'* *'hl'*
3217'highlight' 'hl' string (default (as a single string):
3218 "8:SpecialKey,@:NonText,d:Directory,
3219 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3220 M:ModeMsg,n:LineNr,r:Question,
3221 s:StatusLine,S:StatusLineNC,c:VertSplit
3222 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3223 f:Folded,F:FoldColumn,A:DiffAdd,
3224 C:DiffChange,D:DiffDelete,T:DiffText,
3225 >:SignColumn")
3226 global
3227 {not in Vi}
3228 This option can be used to set highlighting mode for various
3229 occasions. It is a comma separated list of character pairs. The
3230 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003231 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3233 |hl-NonText| @ '~' and '@' at the end of the window and
3234 characters from 'showbreak'
3235 |hl-Directory| d directories in CTRL-D listing and other special
3236 things in listings
3237 |hl-ErrorMsg| e error messages
3238 h (obsolete, ignored)
3239 |hl-IncSearch| i 'incsearch' highlighting
3240 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3241 |hl-MoreMsg| m |more-prompt|
3242 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3243 |hl-LineNr| n line number for ":number" and ":#" commands
3244 |hl-Question| r |hit-enter| prompt and yes/no questions
3245 |hl-StatusLine| s status line of current window |status-line|
3246 |hl-StatusLineNC| S status lines of not-current windows
3247 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3248 |hl-VertSplit| c column used to separate vertically split windows
3249 |hl-Visual| v Visual mode
3250 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3251 Selection" Only X11 Gui's |gui-x11| and
3252 |xterm-clipboard|.
3253 |hl-WarningMsg| w warning messages
3254 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3255 |hl-Folded| f line used for closed folds
3256 |hl-FoldColumn| F 'foldcolumn'
3257 |hl-SignColumn| > column used for |signs|
3258
3259 The display modes are:
3260 r reverse (termcap entry "mr" and "me")
3261 i italic (termcap entry "ZH" and "ZR")
3262 b bold (termcap entry "md" and "me")
3263 s standout (termcap entry "so" and "se")
3264 u underline (termcap entry "us" and "ue")
3265 n no highlighting
3266 - no highlighting
3267 : use a highlight group
3268 The default is used for occasions that are not included.
3269 If you want to change what the display modes do, see |dos-colors|
3270 for an example.
3271 When using the ':' display mode, this must be followed by the name of
3272 a highlight group. A highlight group can be used to define any type
3273 of highlighting, including using color. See |:highlight| on how to
3274 define one. The default uses a different group for each occasion.
3275 See |highlight-default| for the default highlight groups.
3276
3277 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3278'hlsearch' 'hls' boolean (default off)
3279 global
3280 {not in Vi}
3281 {not available when compiled without the
3282 |+extra_search| feature}
3283 When there is a previous search pattern, highlight all its matches.
3284 The type of highlighting used can be set with the 'l' occasion in the
3285 'highlight' option. This uses the "Search" highlight group by
3286 default. Note that only the matching text is highlighted, any offsets
3287 are not applied.
3288 See also: 'incsearch' and |:match|.
3289 When you get bored looking at the highlighted matches, you can turn it
3290 off with |:nohlsearch|. As soon as you use a search command, the
3291 highlighting comes back.
3292 When the search pattern can match an end-of-line, Vim will try to
3293 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003294 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 line below a closed fold. A match in a previous line which is not
3296 drawn may not continue in an newly drawn line.
3297 NOTE: This option is reset when 'compatible' is set.
3298
3299 *'history'* *'hi'*
3300'history' 'hi' number (Vim default: 20, Vi default: 0)
3301 global
3302 {not in Vi}
3303 A history of ":" commands, and a history of previous search patterns
3304 are remembered. This option decides how many entries may be stored in
3305 each of these histories (see |cmdline-editing|).
3306 NOTE: This option is set to the Vi default value when 'compatible' is
3307 set and to the Vim default value when 'compatible' is reset.
3308
3309 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3310'hkmap' 'hk' boolean (default off)
3311 global
3312 {not in Vi}
3313 {only available when compiled with the |+rightleft|
3314 feature}
3315 When on, the keyboard is mapped for the Hebrew character set.
3316 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3317 toggle this option. See |rileft.txt|.
3318 NOTE: This option is reset when 'compatible' is set.
3319
3320 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3321'hkmapp' 'hkp' boolean (default off)
3322 global
3323 {not in Vi}
3324 {only available when compiled with the |+rightleft|
3325 feature}
3326 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3327 This is useful if you have a non-Hebrew keyboard.
3328 See |rileft.txt|.
3329 NOTE: This option is reset when 'compatible' is set.
3330
3331 *'icon'* *'noicon'*
3332'icon' boolean (default off, on when title can be restored)
3333 global
3334 {not in Vi}
3335 {not available when compiled without the |+title|
3336 feature}
3337 When on, the icon text of the window will be set to the value of
3338 'iconstring' (if it is not empty), or to the name of the file
3339 currently being edited. Only the last part of the name is used.
3340 Overridden by the 'iconstring' option.
3341 Only works if the terminal supports setting window icons (currently
3342 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3343 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3344 builtin termcap).
3345 When Vim was compiled with HAVE_X11 defined, the original icon will be
3346 restored if possible |X11|. See |X11-icon| for changing the icon on
3347 X11.
3348
3349 *'iconstring'*
3350'iconstring' string (default "")
3351 global
3352 {not in Vi}
3353 {not available when compiled without the |+title|
3354 feature}
3355 When this option is not empty, it will be used for the icon text of
3356 the window. This happens only when the 'icon' option is on.
3357 Only works if the terminal supports setting window icon text
3358 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3359 Does not work for MS Windows.
3360 When Vim was compiled with HAVE_X11 defined, the original icon will be
3361 restored if possible |X11|.
3362 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003363 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 'titlestring' for example settings.
3365 {not available when compiled without the |+statusline| feature}
3366
3367 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3368'ignorecase' 'ic' boolean (default off)
3369 global
3370 Ignore case in search patterns. Also used when searching in the tags
3371 file.
3372 Also see 'smartcase'.
3373 Can be overruled by using "\c" or "\C" in the pattern, see
3374 |/ignorecase|.
3375
3376 *'imactivatekey'* *'imak'*
3377'imactivatekey' 'imak' string (default "")
3378 global
3379 {not in Vi}
3380 {only available when compiled with |+xim| and
3381 |+GUI_GTK|}
3382 Specifies the key that your Input Method in X-Windows uses for
3383 activation. When this is specified correctly, vim can fully control
3384 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3385 You can't use this option to change the activation key, the option
3386 tells Vim what the key is.
3387 Format:
3388 [MODIFIER_FLAG-]KEY_STRING
3389
3390 These characters can be used for MODIFIER_FLAG (case is ignored):
3391 S Shift key
3392 L Lock key
3393 C Control key
3394 1 Mod1 key
3395 2 Mod2 key
3396 3 Mod3 key
3397 4 Mod4 key
3398 5 Mod5 key
3399 Combinations are allowed, for example "S-C-space" or "SC-space" are
3400 both shift+ctrl+space.
3401 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3402
3403 Example: >
3404 :set imactivatekey=S-space
3405< "S-space" means shift+space. This is the activation key for kinput2 +
3406 canna (Japanese), and ami (Korean).
3407
3408 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3409'imcmdline' 'imc' boolean (default off)
3410 global
3411 {not in Vi}
3412 {only available when compiled with the |+xim|
3413 |+multi_byte_ime| or |global-ime| feature}
3414 When set the Input Method is always on when starting to edit a command
3415 line, unless entering a search pattern (see 'imsearch' for that).
3416 Setting this option is useful when your input method allows entering
3417 English characters directly, e.g., when it's used to type accented
3418 characters with dead keys.
3419
3420 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3421'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3422 global
3423 {not in Vi}
3424 {only available when compiled with the |+xim|
3425 |+multi_byte_ime| or |global-ime| feature}
3426 When set the Input Method is never used. This is useful to disable
3427 the IM when it doesn't work properly.
3428 Currently this option is on by default for SGI/IRIX machines. This
3429 may change in later releases.
3430
3431 *'iminsert'* *'imi'*
3432'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3433 local to buffer
3434 {not in Vi}
3435 Specifies whether :lmap or an Input Method (IM) is to be used in
3436 Insert mode. Valid values:
3437 0 :lmap is off and IM is off
3438 1 :lmap is ON and IM is off
3439 2 :lmap is off and IM is ON
3440 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3441 or |global-ime|.
3442 To always reset the option to zero when leaving Insert mode with <Esc>
3443 this can be used: >
3444 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3445< This makes :lmap and IM turn off automatically when leaving Insert
3446 mode.
3447 Note that this option changes when using CTRL-^ in Insert mode
3448 |i_CTRL-^|.
3449 The value is set to 1 when setting 'keymap' to a valid keymap name.
3450 It is also used for the argument of commands like "r" and "f".
3451 The value 0 may not work correctly with Athena and Motif with some XIM
3452 methods. Use 'imdisable' to disable XIM then.
3453
3454 *'imsearch'* *'ims'*
3455'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3456 local to buffer
3457 {not in Vi}
3458 Specifies whether :lmap or an Input Method (IM) is to be used when
3459 entering a search pattern. Valid values:
3460 -1 the value of 'iminsert' is used, makes it look like
3461 'iminsert' is also used when typing a search pattern
3462 0 :lmap is off and IM is off
3463 1 :lmap is ON and IM is off
3464 2 :lmap is off and IM is ON
3465 Note that this option changes when using CTRL-^ in Command-line mode
3466 |c_CTRL-^|.
3467 The value is set to 1 when it is not -1 and setting the 'keymap'
3468 option to a valid keymap name.
3469 The value 0 may not work correctly with Athena and Motif with some XIM
3470 methods. Use 'imdisable' to disable XIM then.
3471
3472 *'include'* *'inc'*
3473'include' 'inc' string (default "^\s*#\s*include")
3474 global or local to buffer |global-local|
3475 {not in Vi}
3476 {not available when compiled without the
3477 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003478 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 pattern, just like for the "/" command (See |pattern|). The default
3480 value is for C programs. This option is used for the commands "[i",
3481 "]I", "[d", etc.. The 'isfname' option is used to recognize the file
3482 name that comes after the matched pattern. See |option-backslash|
3483 about including spaces and backslashes.
3484
3485 *'includeexpr'* *'inex'*
3486'includeexpr' 'inex' string (default "")
3487 local to buffer
3488 {not in Vi}
3489 {not available when compiled without the
3490 |+find_in_path| or |+eval| feature}
3491 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003492 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 :set includeexpr=substitute(v:fname,'\\.','/','g')
3494< The "v:fname" variable will be set to the file name that was detected.
3495 Evaluated in the |sandbox|.
3496 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003497 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 Also used for |<cfile>|.
3499
3500 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3501'incsearch' 'is' boolean (default off)
3502 global
3503 {not in Vi}
3504 {not available when compiled without the
3505 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003506 While typing a search command, show where the pattern, as it was typed
3507 so far, matches. The matched string is highlighted. If the pattern
3508 is invalid or not found, nothing is shown. The screen will be updated
3509 often, this is only useful on fast terminals.
3510 Note that the match will be shown, but the cursor will return to its
3511 original position when no match is found and when pressing <Esc>. You
3512 still need to finish the search command with <Enter> to move the
3513 cursor to the match.
3514 The highlighting can be set with the 'i' flag in 'highlight'.
3515 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 NOTE: This option is reset when 'compatible' is set.
3517
3518 *'indentexpr'* *'inde'*
3519'indentexpr' 'inde' string (default "")
3520 local to buffer
3521 {not in Vi}
3522 {not available when compiled without the |+cindent|
3523 or |+eval| features}
3524 Expression which is evaluated to obtain the proper indent for a line.
3525 It is used when a new line is created, for the |=| operator and
3526 in Insert mode as specified with the 'indentkeys' option.
3527 When this option is not empty, it overrules the 'cindent' and
3528 'smartindent' indenting.
3529 When 'paste' is set this option is not used for indenting.
3530 The expression is evaluated with |v:lnum| set to the line number for
3531 which the indent is to be computed. The cursor is also as this line
3532 when the expression is evaluated (but it may be moved around).
3533 The expression must return the number of spaces worth of indent. It
3534 can return "-1" to keep the current indent (this means 'autoindent' is
3535 used for the indent).
3536 Functions useful for computing the indent are |indent()|, |cindent()|
3537 and |lispindent()|.
3538 The evaluation of the expression must not have side effects! It must
3539 not change the text, jump to another window, etc. Afterwards the
3540 cursor position is always restored, thus the cursor may be moved.
3541 Normally this option would be set to call a function: >
3542 :set indentexpr=GetMyIndent()
3543< Error messages will be suppressed, unless the 'debug' option contains
3544 "msg".
3545 See |indent-expression|. Also see |eval-sandbox|.
3546 NOTE: This option is made empty when 'compatible' is set.
3547
3548 *'indentkeys'* *'indk'*
3549'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3550 local to buffer
3551 {not in Vi}
3552 {not available when compiled without the |+cindent|
3553 feature}
3554 A list of keys that, when typed in Insert mode, cause reindenting of
3555 the current line. Only happens if 'indentexpr' isn't empty.
3556 The format is identical to 'cinkeys', see |indentkeys-format|.
3557 See |C-indenting| and |indent-expression|.
3558
3559 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3560'infercase' 'inf' boolean (default off)
3561 local to buffer
3562 {not in Vi}
3563 When doing keyword completion in insert mode |ins-completion|, and
3564 'ignorecase' is also on, the case of the match is adjusted. If the
3565 typed text contains a lowercase letter where the match has an upper
3566 case letter, the completed part is made lowercase. If the typed text
3567 has no lowercase letters and the match has a lowercase letter where
3568 the typed text has an uppercase letter, and there is a letter before
3569 it, the completed part is made uppercase.
3570
3571 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3572'insertmode' 'im' boolean (default off)
3573 global
3574 {not in Vi}
3575 Makes Vim work in a way that Insert mode is the default mode. Useful
3576 if you want to use Vim as a modeless editor. Used for |evim|.
3577 These Insert mode commands will be useful:
3578 - Use the cursor keys to move around.
3579 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3580 this is a mapping, it is executed as if 'insertmode' was off.
3581 Normal mode remains active until the mapping is finished.
3582 *i_CTRL-L*
3583 - Use CTRL-L to execute a number of Normal mode commands, then use
3584 <Esc> to get back to Insert mode.
3585
3586 These items change when 'insertmode' is set:
3587 - when starting to edit of a file, Vim goes to Insert mode.
3588 - <Esc> in Insert mode is a no-op and beeps.
3589 - <Esc> in Normal mode makes Vim go to Insert mode.
3590 - CTRL-L in Insert mode is a command, it is not inserted.
3591 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3592 However, when <Esc> is used inside a mapping, it behaves like
3593 'insertmode' was not set. This was done to be able to use the same
3594 mappings with 'insertmode' set or not set.
3595 When executing commands with |:normal| 'insertmode' is not used.
3596
3597 NOTE: This option is reset when 'compatible' is set.
3598
3599 *'isfname'* *'isf'*
3600'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3601 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3602 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3603 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3604 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3605 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3606 global
3607 {not in Vi}
3608 The characters specified by this option are included in file names and
3609 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003610 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 Multi-byte characters 256 and above are always included, only the
3612 characters up to 255 are specified with this option.
3613 For UTF-8 the characters 0xa0 to 0xff are included as well.
3614
3615 Note that on systems using a backslash as path separator, Vim tries to
3616 do its best to make it work as you would expect. That is a bit
3617 tricky, since Vi originally used the backslash to escape special
3618 characters. Vim will not remove a backslash in front of a normal file
3619 name character on these systems, but it will on Unix and alikes. The
3620 '&' and '^' are not included by default, because these are special for
3621 cmd.exe.
3622
3623 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003624 Each part can be a single character number or a range. A range is two
3625 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 decimal number between 0 and 255 or the ASCII character itself (does
3627 not work for digits). Example:
3628 "_,-,128-140,#-43" (include '_' and '-' and the range
3629 128 to 140 and '#' to 43)
3630 If a part starts with '^', the following character number or range
3631 will be excluded from the option. The option is interpreted from left
3632 to right. Put the excluded character after the range where it is
3633 included. To include '^' itself use it as the last character of the
3634 option or the end of a range. Example:
3635 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3636 If the character is '@', all characters where isalpha() returns TRUE
3637 are included. Normally these are the characters a to z and A to Z,
3638 plus accented characters. To include '@' itself use "@-@". Examples:
3639 "@,^a-z" All alphabetic characters, excluding lower
3640 case letters.
3641 "a-z,A-Z,@-@" All letters plus the '@' character.
3642 A comma can be included by using it where a character number is
3643 expected. Example:
3644 "48-57,,,_" Digits, comma and underscore.
3645 A comma can be excluded by prepending a '^'. Example:
3646 " -~,^,,9" All characters from space to '~', excluding
3647 comma, plus <Tab>.
3648 See |option-backslash| about including spaces and backslashes.
3649
3650 *'isident'* *'isi'*
3651'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3652 "@,48-57,_,128-167,224-235"
3653 otherwise: "@,48-57,_,192-255")
3654 global
3655 {not in Vi}
3656 The characters given by this option are included in identifiers.
3657 Identifiers are used in recognizing environment variables and after a
3658 match of the 'define' option. It is also used for "\i" in a
3659 |pattern|. See 'isfname' for a description of the format of this
3660 option.
3661 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003662 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3664
3665 *'iskeyword'* *'isk'*
3666'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3667 "@,48-57,_,128-167,224-235"
3668 otherwise: "@,48-57,_,192-255"
3669 Vi default: "@,48-57,_")
3670 local to buffer
3671 {not in Vi}
3672 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 'isfname' for a description of the format of this option. For C
3675 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3676 For a help file it is set to all non-blank printable characters except
3677 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3678 command).
3679 When the 'lisp' option is on the '-' character is always included.
3680 NOTE: This option is set to the Vi default value when 'compatible' is
3681 set and to the Vim default value when 'compatible' is reset.
3682
3683 *'isprint'* *'isp'*
3684'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3685 "@,~-255"; otherwise: "@,161-255")
3686 global
3687 {not in Vi}
3688 The characters given by this option are displayed directly on the
3689 screen. It is also used for "\p" in a |pattern|. The characters from
3690 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3691 even when they are not included in 'isprint' or excluded. See
3692 'isfname' for a description of the format of this option.
3693
3694 Non-printable characters are displayed with two characters:
3695 0 - 31 "^@" - "^_"
3696 32 - 126 always single characters
3697 127 "^?"
3698 128 - 159 "~@" - "~_"
3699 160 - 254 "| " - "|~"
3700 255 "~?"
3701 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3702 displayed as <xx>, with the hexadecimal value of the byte.
3703 When 'display' contains "uhex" all unprintable characters are
3704 displayed as <xx>.
3705 The NonText highlighting will be used for unprintable characters.
3706 |hl-NonText|
3707
3708 Multi-byte characters 256 and above are always included, only the
3709 characters up to 255 are specified with this option. When a character
3710 is printable but it is not available in the current font, a
3711 replacement character will be shown.
3712 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3713 There is no option to specify these characters.
3714
3715 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3716'joinspaces' 'js' boolean (default on)
3717 global
3718 {not in Vi}
3719 Insert two spaces after a '.', '?' and '!' with a join command.
3720 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3721 Otherwise only one space is inserted.
3722 NOTE: This option is set when 'compatible' is set.
3723
3724 *'key'*
3725'key' string (default "")
3726 local to buffer
3727 {not in Vi}
3728 The key that is used for encrypting and decrypting the current buffer.
3729 See |encryption|.
3730 Careful: Do not set the key value by hand, someone might see the typed
3731 key. Use the |:X| command. But you can make 'key' empty: >
3732 :set key=
3733< It is not possible to get the value of this option with ":set key" or
3734 "echo &key". This is to avoid showing it to someone who shouldn't
3735 know. It also means you cannot see it yourself once you have set it,
3736 be careful not to make a typing error!
3737
3738 *'keymap'* *'kmp'* *E544*
3739'keymap' 'kmp' string (default "")
3740 local to buffer
3741 {not in Vi}
3742 {only available when compiled with the |+keymap|
3743 feature}
3744 Name of a keyboard mapping. See |mbyte-keymap|.
3745 Setting this option to a valid keymap name has the side effect of
3746 setting 'iminsert' to one, so that the keymap becomes effective.
3747 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003748 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003749
3750 *'keymodel'* *'km'*
3751'keymodel' 'km' string (default "")
3752 global
3753 {not in Vi}
3754 List of comma separated words, which enable special things that keys
3755 can do. These values can be used:
3756 startsel Using a shifted special key starts selection (either
3757 Select mode or Visual mode, depending on "key" being
3758 present in 'selectmode').
3759 stopsel Using a not-shifted special key stops selection.
3760 Special keys in this context are the cursor keys, <End>, <Home>,
3761 <PageUp> and <PageDown>.
3762 The 'keymodel' option is set by the |:behave| command.
3763
3764 *'keywordprg'* *'kp'*
3765'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3766 OS/2: "view /", VMS: "help")
3767 global or local to buffer |global-local|
3768 {not in Vi}
3769 Program to use for the |K| command. Environment variables are
3770 expanded |:set_env|. ":help" may be used to access the Vim internal
3771 help. (Note that previously setting the global option to the empty
3772 value did this, which is now deprecated.)
3773 When "man" is used, Vim will automatically translate a count for the
3774 "K" command to a section number. Also for "man -s", in which case the
3775 "-s" is removed when there is no count.
3776 See |option-backslash| about including spaces and backslashes.
3777 Example: >
3778 :set keywordprg=man\ -s
3779< This option cannot be set from a |modeline| or in the |sandbox|, for
3780 security reasons.
3781
3782 *'langmap'* *'lmap'* *E357* *E358*
3783'langmap' 'lmap' string (default "")
3784 global
3785 {not in Vi}
3786 {only available when compiled with the |+langmap|
3787 feature}
3788 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003789 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 inserted directly. When in command mode the 'langmap' option takes
3791 care of translating these special characters to the original meaning
3792 of the key. This means you don't have to change the keyboard mode to
3793 be able to execute Normal mode commands.
3794 This is the opposite of the 'keymap' option, where characters are
3795 mapped in Insert mode.
3796 This only works for 8-bit characters. The value of 'langmap' may be
3797 specified with multi-byte characters (e.g., UTF-8), but only the lower
3798 8 bits of each character will be used.
3799
3800 Example (for Greek): *greek* >
3801 :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
3802< Example (exchanges meaning of z and y for commands): >
3803 :set langmap=zy,yz,ZY,YZ
3804<
3805 The 'langmap' option is a list of parts, separated with commas. Each
3806 part can be in one of two forms:
3807 1. A list of pairs. Each pair is a "from" character immediately
3808 followed by the "to" character. Examples: "aA", "aAbBcC".
3809 2. A list of "from" characters, a semi-colon and a list of "to"
3810 characters. Example: "abc;ABC"
3811 Example: "aA,fgh;FGH,cCdDeE"
3812 Special characters need to be preceded with a backslash. These are
3813 ";", ',' and backslash itself.
3814
3815 This will allow you to activate vim actions without having to switch
3816 back and forth between the languages. Your language characters will
3817 be understood as normal vim English characters (according to the
3818 langmap mappings) in the following cases:
3819 o Normal/Visual mode (commands, buffer/register names, user mappings)
3820 o Insert/Replace Mode: Register names after CTRL-R
3821 o Insert/Replace Mode: Mappings
3822 Characters entered in Command-line mode will NOT be affected by
3823 this option. Note that this option can be changed at any time
3824 allowing to switch between mappings for different languages/encodings.
3825 Use a mapping to avoid having to type it each time!
3826
3827 *'langmenu'* *'lm'*
3828'langmenu' 'lm' string (default "")
3829 global
3830 {not in Vi}
3831 {only available when compiled with the |+menu| and
3832 |+multi_lang| features}
3833 Language to use for menu translation. Tells which file is loaded
3834 from the "lang" directory in 'runtimepath': >
3835 "lang/menu_" . &langmenu . ".vim"
3836< (without the spaces). For example, to always use the Dutch menus, no
3837 matter what $LANG is set to: >
3838 :set langmenu=nl_NL.ISO_8859-1
3839< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003840 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 If your $LANG is set to a non-English language but you do want to use
3842 the English menus: >
3843 :set langmenu=none
3844< This option must be set before loading menus, switching on filetype
3845 detection or syntax highlighting. Once the menus are defined setting
3846 this option has no effect. But you could do this: >
3847 :source $VIMRUNTIME/delmenu.vim
3848 :set langmenu=de_DE.ISO_8859-1
3849 :source $VIMRUNTIME/menu.vim
3850< Warning: This deletes all menus that you defined yourself!
3851
3852 *'laststatus'* *'ls'*
3853'laststatus' 'ls' number (default 1)
3854 global
3855 {not in Vi}
3856 The value of this option influences when the last window will have a
3857 status line:
3858 0: never
3859 1: only if there are at least two windows
3860 2: always
3861 The screen looks nicer with a status line if you have several
3862 windows, but it takes another screen line. |status-line|
3863
3864 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3865'lazyredraw' 'lz' boolean (default off)
3866 global
3867 {not in Vi}
3868 When this option is set, the screen will not be redrawn while
3869 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003870 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 update use |:redraw|.
3872
3873 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3874'linebreak' 'lbr' boolean (default off)
3875 local to window
3876 {not in Vi}
3877 {not available when compiled without the |+linebreak|
3878 feature}
3879 If on Vim will wrap long lines at a character in 'breakat' rather
3880 than at the last character that fits on the screen. Unlike
3881 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
3882 it only affects the way the file is displayed, not its contents. The
3883 value of 'showbreak' is used to put in front of wrapped lines.
3884 This option is not used when the 'wrap' option is off or 'list' is on.
3885 Note that <Tab> characters after an <EOL> are mostly not displayed
3886 with the right amount of white space.
3887
3888 *'lines'* *E593*
3889'lines' number (default 24 or terminal height)
3890 global
3891 Number of lines of the Vim window.
3892 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00003893 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894 When Vim is running in the GUI or in a resizable window, setting this
3895 option will cause the window size to be changed. When you only want
3896 to use the size for the GUI, put the command in your |gvimrc| file.
3897 Vim limits the number of lines to what fits on the screen. You can
3898 use this command to get the tallest window possible: >
3899 :set lines=999
3900< If you get less lines than expected, check the 'guiheadroom' option.
3901 When you set this option and Vim is unable to change the physical
3902 number of lines of the display, the display may be messed up.
3903
3904 *'linespace'* *'lsp'*
3905'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
3906 global
3907 {not in Vi}
3908 {only in the GUI}
3909 Number of pixel lines inserted between characters. Useful if the font
3910 uses the full character cell height, making lines touch each other.
3911 When non-zero there is room for underlining.
3912
3913 *'lisp'* *'nolisp'*
3914'lisp' boolean (default off)
3915 local to buffer
3916 {not available when compiled without the |+lispindent|
3917 feature}
3918 Lisp mode: When <Enter> is typed in insert mode set the indent for
3919 the next line to Lisp standards (well, sort of). Also happens with
3920 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
3921 flag in 'cpoptions' changes the method of indenting: Vi compatible or
3922 better. Also see 'lispwords'.
3923 The '-' character is included in keyword characters. Redefines the
3924 "=" operator to use this same indentation algorithm rather than
3925 calling an external program if 'equalprg' is empty.
3926 This option is not used when 'paste' is set.
3927 {Vi: Does it a little bit differently}
3928
3929 *'lispwords'* *'lw'*
3930'lispwords' 'lw' string (default is very long)
3931 global
3932 {not in Vi}
3933 {not available when compiled without the |+lispindent|
3934 feature}
3935 Comma separated list of words that influence the Lisp indenting.
3936 |'lisp'|
3937
3938 *'list'* *'nolist'*
3939'list' boolean (default off)
3940 local to window
3941 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
3942 see the difference between tabs and spaces and for trailing blanks.
3943 Note that this will also affect formatting (set with 'textwidth' or
3944 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
3945 changing the way tabs are displayed.
3946
3947 *'listchars'* *'lcs'*
3948'listchars' 'lcs' string (default "eol:$")
3949 global
3950 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003951 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00003952 settings.
3953 eol:c Character to show at the end of each line. When
3954 omitted, there is no extra character at the end of the
3955 line.
3956 tab:xy Two characters to be used to show a Tab. The first
3957 char is used once. The second char is repeated to
3958 fill the space that the Tab normally occupies.
3959 "tab:>-" will show a Tab that takes four spaces as
3960 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003961 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 trailing spaces are blank.
3963 extends:c Character to show in the last column, when 'wrap' is
3964 off and the line continues beyond the right of the
3965 screen.
3966 precedes:c Character to show in the first column, when 'wrap'
3967 is off and there is text preceding the character
3968 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00003969 nbsp:c Character to show for a non-breakable space (character
3970 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003972 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 be used when 'encoding' is "utf-8", otherwise only printable
3974 characters are allowed.
3975
3976 Examples: >
3977 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003978 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 :set lcs=extends:>,precedes:<
3980< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003981 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982
3983 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
3984'loadplugins' 'lpl' boolean (default on)
3985 global
3986 {not in Vi}
3987 When on the plugin scripts are loaded when starting up |load-plugins|.
3988 This option can be reset in your |vimrc| file to disable the loading
3989 of plugins.
3990 Note that using the "-u NONE" and "--noplugin" command line arguments
3991 reset this option. |-u| |--noplugin|
3992
3993 *'magic'* *'nomagic'*
3994'magic' boolean (default on)
3995 global
3996 Changes the special characters that can be used in search patterns.
3997 See |pattern|.
3998 NOTE: To avoid portability problems with using patterns, always keep
3999 this option at the default "on". Only switch it off when working with
4000 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004001 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002
4003 *'makeef'* *'mef'*
4004'makeef' 'mef' string (default: "")
4005 global
4006 {not in Vi}
4007 {not available when compiled without the |+quickfix|
4008 feature}
4009 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4010 and the |:grep| command.
4011 When it is empty, an internally generated temp file will be used.
4012 When "##" is included, it is replaced by a number to make the name
4013 unique. This makes sure that the ":make" command doesn't overwrite an
4014 existing file.
4015 NOT used for the ":cf" command. See 'errorfile' for that.
4016 Environment variables are expanded |:set_env|.
4017 See |option-backslash| about including spaces and backslashes.
4018 This option cannot be set from a |modeline| or in the |sandbox|, for
4019 security reasons.
4020
4021 *'makeprg'* *'mp'*
4022'makeprg' 'mp' string (default "make", VMS: "MMS")
4023 global or local to buffer |global-local|
4024 {not in Vi}
4025 Program to use for the ":make" command. See |:make_makeprg|. This
4026 option may contain '%' and '#' characters, which are expanded like
4027 when used in a command-line. Environment variables are expanded
4028 |:set_env|. See |option-backslash| about including spaces and
4029 backslashes. Note that a '|' must be escaped twice: once for ":set"
4030 and once for the interpretation of a command. When you use a filter
4031 called "myfilter" do it like this: >
4032 :set makeprg=gmake\ \\\|\ myfilter
4033< The placeholder "$*" can be given (even multiple times) to specify
4034 where the arguments will be included, for example: >
4035 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4036< This option cannot be set from a |modeline| or in the |sandbox|, for
4037 security reasons.
4038
4039 *'matchpairs'* *'mps'*
4040'matchpairs' 'mps' string (default "(:),{:},[:]")
4041 local to buffer
4042 {not in Vi}
4043 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004044 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 must be different. The characters must be separated by a colon. The
4046 pairs must be separated by a comma. Example for including '<' and '>'
4047 (HTML): >
4048 :set mps+=<:>
4049
4050< A more exotic example, to jump between the '=' and ';' in an
4051 assignment, useful for languages like C and Java: >
4052 :au FileType c,cpp,java set mps+==:;
4053
4054< For a more advanced way of using "%", see the matchit.vim plugin in
4055 the $VIMRUNTIME/macros directory. |add-local-help|
4056
4057 *'matchtime'* *'mat'*
4058'matchtime' 'mat' number (default 5)
4059 global
4060 {not in Vi}{in Nvi}
4061 Tenths of a second to show the matching paren, when 'showmatch' is
4062 set. Note that this is not in milliseconds, like other options that
4063 set a time. This is to be compatible with Nvi.
4064
4065 *'maxfuncdepth'* *'mfd'*
4066'maxfuncdepth' 'mfd' number (default 100)
4067 global
4068 {not in Vi}
4069 Maximum depth of function calls for user functions. This normally
4070 catches endless recursion. When using a recursive function with
4071 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4072 more memory, there is the danger of failing when memory is exhausted.
4073 See also |:function|.
4074
4075 *'maxmapdepth'* *'mmd'* *E223*
4076'maxmapdepth' 'mmd' number (default 1000)
4077 global
4078 {not in Vi}
4079 Maximum number of times a mapping is done without resulting in a
4080 character to be used. This normally catches endless mappings, like
4081 ":map x y" with ":map y x". It still does not catch ":map g wg",
4082 because the 'w' is used before the next mapping is done. See also
4083 |key-mapping|.
4084
4085 *'maxmem'* *'mm'*
4086'maxmem' 'mm' number (default between 256 to 5120 (system
4087 dependent) or half the amount of memory
4088 available)
4089 global
4090 {not in Vi}
4091 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4092 limit is reached allocating extra memory for a buffer will cause
4093 other memory to be freed. Maximum value 2000000. Use this to work
4094 without a limit. Also see 'maxmemtot'.
4095
4096 *'maxmemtot'* *'mmt'*
4097'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4098 dependent) or half the amount of memory
4099 available)
4100 global
4101 {not in Vi}
4102 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 'maxmem'.
4105
4106 *'menuitems'* *'mis'*
4107'menuitems' 'mis' number (default 25)
4108 global
4109 {not in Vi}
4110 {not available when compiled without the |+menu|
4111 feature}
4112 Maximum number of items to use in a menu. Used for menus that are
4113 generated from a list of items, e.g., the Buffers menu. Changing this
4114 option has no direct effect, the menu must be refreshed first.
4115
4116 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4117'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4118 local to buffer
4119 *'modelines'* *'mls'*
4120'modelines' 'mls' number (default 5)
4121 global
4122 {not in Vi}
4123 If 'modeline' is on 'modelines' gives the number of lines that is
4124 checked for set commands. If 'modeline' is off or 'modelines' is zero
4125 no lines are checked. See |modeline|.
4126 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4127 set and to the Vim default value when 'compatible' is reset.
4128
4129 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4130'modifiable' 'ma' boolean (default on)
4131 local to buffer
4132 {not in Vi} *E21*
4133 When off the buffer contents cannot be changed. The 'fileformat' and
4134 'fileencoding' options also can't be changed.
4135 Can be reset with the |-M| command line argument.
4136
4137 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4138'modified' 'mod' boolean (default off)
4139 local to buffer
4140 {not in Vi}
4141 When on, the buffer is considered to be modified. This option is set
4142 when:
4143 1. A change was made to the text since it was last written. Using the
4144 |undo| command to go back to the original text will reset the
4145 option. But undoing changes that were made before writing the
4146 buffer will set the option again, since the text is different from
4147 when it was written.
4148 2. 'fileformat' or 'fileencoding' is different from its original
4149 value. The original value is set when the buffer is read or
4150 written. A ":set nomodified" command also resets the original
4151 values to the current values and the 'modified' option will be
4152 reset.
4153 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4154 will be ignored.
4155
4156 *'more'* *'nomore'*
4157'more' boolean (Vim default: on, Vi default: off)
4158 global
4159 {not in Vi}
4160 When on, listings pause when the whole screen is filled. You will get
4161 the |more-prompt|. When this option is off there are no pauses, the
4162 listing continues until finished.
4163 NOTE: This option is set to the Vi default value when 'compatible' is
4164 set and to the Vim default value when 'compatible' is reset.
4165
4166 *'mouse'* *E538*
4167'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4168 global
4169 {not in Vi}
4170 Enable the use of the mouse. Only works for certain terminals
4171 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4172 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4173 The mouse can be enabled for different modes:
4174 n Normal mode
4175 v Visual mode
4176 i Insert mode
4177 c Command-line mode
4178 h all previous modes when editing a help file
4179 a all previous modes
4180 r for |hit-enter| and |more-prompt| prompt
4181 A auto-select in Visual mode
4182 Normally you would enable the mouse in all four modes with: >
4183 :set mouse=a
4184< When the mouse is not enabled, the GUI will still use the mouse for
4185 modeless selection. This doesn't move the text cursor.
4186
4187 See |mouse-using|. Also see |'clipboard'|.
4188
4189 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004190 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 the mouse buttons can still be used by keeping the shift key pressed.
4192 Also see the 'clipboard' option.
4193
4194 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4195'mousefocus' 'mousef' boolean (default off)
4196 global
4197 {not in Vi}
4198 {only works in the GUI}
4199 The window that the mouse pointer is on is automatically activated.
4200 When changing the window layout or window focus in another way, the
4201 mouse pointer is moved to the window with keyboard focus. Off is the
4202 default because it makes using the pull down menus a little goofy, as
4203 a pointer transit may activate a window unintentionally.
4204
4205 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4206'mousehide' 'mh' boolean (default on)
4207 global
4208 {not in Vi}
4209 {only works in the GUI}
4210 When on, the mouse pointer is hidden when characters are typed.
4211 The mouse pointer is restored when the mouse is moved.
4212
4213 *'mousemodel'* *'mousem'*
4214'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4215 global
4216 {not in Vi}
4217 Sets the model to use for the mouse. The name mostly specifies what
4218 the right mouse button is used for:
4219 extend Right mouse button extends a selection. This works
4220 like in an xterm.
4221 popup Right mouse button pops up a menu. The shifted left
4222 mouse button extends a selection. This works like
4223 with Microsoft Windows
4224 popup_setpos Like "popup", but the cursor will be moved to the
4225 position where the mouse was clicked, and thus the
4226 selected operation will act upon the clicked object.
4227 If clicking inside a selection, that selection will
4228 be acted upon, ie. no cursor move. This implies of
4229 course, that right clicking outside a selection will
4230 end Visual mode.
4231 Overview of what button does what for each model:
4232 mouse extend popup(_setpos) ~
4233 left click place cursor place cursor
4234 left drag start selection start selection
4235 shift-left search word extend selection
4236 right click extend selection popup menu (place cursor)
4237 right drag extend selection -
4238 middle click paste paste
4239
4240 In the "popup" model the right mouse button produces a pop-up menu.
4241 You need to define this first, see |popup-menu|.
4242
4243 Note that you can further refine the meaning of buttons with mappings.
4244 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4245 selection (because that's handled in the GUI code directly).
4246
4247 The 'mousemodel' option is set by the |:behave| command.
4248
4249 *'mouseshape'* *'mouses'* *E547*
4250'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
4251 m:no,ml:up-arrow,v:rightup-arrow"
4252 global
4253 {not in Vi}
4254 {only available when compiled with the |+mouseshape|
4255 feature}
4256 This option tells Vim what the mouse pointer should look like in
4257 different modes. The option is a comma separated list of parts, much
4258 like used for 'guicursor'. Each part consist of a mode/location-list
4259 and an argument-list:
4260 mode-list:shape,mode-list:shape,..
4261 The mode-list is a dash separated list of these modes/locations:
4262 In a normal window: ~
4263 n Normal mode
4264 v Visual mode
4265 ve Visual mode with 'selection' "exclusive" (same as 'v',
4266 if not specified)
4267 o Operator-pending mode
4268 i Insert mode
4269 r Replace mode
4270
4271 Others: ~
4272 c appending to the command-line
4273 ci inserting in the command-line
4274 cr replacing in the command-line
4275 m at the 'Hit ENTER' or 'More' prompts
4276 ml idem, but cursor in the last line
4277 e any mode, pointer below last window
4278 s any mode, pointer on a status line
4279 sd any mode, while dragging a status line
4280 vs any mode, pointer on a vertical separator line
4281 vd any mode, while dragging a vertical separator line
4282 a everywhere
4283
4284 The shape is one of the following:
4285 avail name looks like ~
4286 w x arrow Normal mouse pointer
4287 w x blank no pointer at all (use with care!)
4288 w x beam I-beam
4289 w x updown up-down sizing arrows
4290 w x leftright left-right sizing arrows
4291 w x busy The system's usual busy pointer
4292 w x no The system's usual 'no input' pointer
4293 x udsizing indicates up-down resizing
4294 x lrsizing indicates left-right resizing
4295 x crosshair like a big thin +
4296 x hand1 black hand
4297 x hand2 white hand
4298 x pencil what you write with
4299 x question big ?
4300 x rightup-arrow arrow pointing right-up
4301 w x up-arrow arrow pointing up
4302 x <number> any X11 pointer number (see X11/cursorfont.h)
4303
4304 The "avail" column contains a 'w' if the shape is available for Win32,
4305 x for X11.
4306 Any modes not specified or shapes not available use the normal mouse
4307 pointer.
4308
4309 Example: >
4310 :set mouseshape=s:udsizing,m:no
4311< will make the mouse turn to a sizing arrow over the status lines and
4312 indicate no input when the hit-enter prompt is displayed (since
4313 clicking the mouse has no effect in this state.)
4314
4315 *'mousetime'* *'mouset'*
4316'mousetime' 'mouset' number (default 500)
4317 global
4318 {not in Vi}
4319 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4320 time in msec between two mouse clicks for the second click to be
4321 recognized as a multi click.
4322
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004323 *'mzquantum'* *'mzq'*
4324'mzquantum' 'mzq' number (default 100)
4325 global
4326 {not in Vi}
4327 {not available when compiled without the |+mzscheme|
4328 feature}
4329 The number of milliseconds between polls for MzScheme threads.
4330 Negative or zero value means no thread scheduling.
4331
Bram Moolenaar071d4272004-06-13 20:20:40 +00004332 *'nrformats'* *'nf'*
4333'nrformats' 'nf' string (default "octal,hex")
4334 local to buffer
4335 {not in Vi}
4336 This defines what bases Vim will consider for numbers when using the
4337 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4338 respectively; see |CTRL-A| for more info on these commands.
4339 alpha if included, single alphabetical characters will be
4340 incremented or decremented. This is useful for a list with a
4341 letter index a), b), etc.
4342 octal if included, numbers that start with a zero will be considered
4343 to be octal. Example: Using CTRL-A on "007" results in "010".
4344 hex if included, numbers starting with "0x" or "0X" will be
4345 considered to be hexadecimal. Example: Using CTRL-X on
4346 "0x100" results in "0x0ff".
4347 Numbers which simply begin with a digit in the range 1-9 are always
4348 considered decimal. This also happens for numbers that are not
4349 recognized as octal or hex.
4350
4351 *'number'* *'nu'* *'nonumber'* *'nonu'*
4352'number' 'nu' boolean (default off)
4353 local to window
4354 Print the line number in front of each line. When the 'n' option is
4355 excluded from 'cpoptions' a wrapped line will not use the column of
4356 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004357 The 'numberwidth' option can be used to set the room used for the line
4358 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 When a long, wrapped line doesn't start with the first character, '-'
4360 characters are put before the number.
4361 See |hl-LineNr| for the highlighting used for the number.
4362
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004363 *'numberwidth'* *'nuw'*
4364'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4365 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004366 {not in Vi}
4367 {only available when compiled with the |+linebreak|
4368 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004369 Minimal number of columns to use for the line number. Only relevant
4370 when the 'number' option is set.
4371 Since one space is always between the number and the text, there is
4372 one less character for the number itself.
4373 The value is the minimum width. A bigger width is used when needed to
4374 fit the highest line number in the buffer. Thus with the Vim default
4375 of 4 there is room for a line number up to 999. When the buffer has
4376 1000 lines five columns will be used.
4377 The minimum value is 1, the maximum value is 10.
4378 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4379
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 *'osfiletype'* *'oft'* *E366*
4381'osfiletype' 'oft' string (RISC-OS default: "Text",
4382 others default: "")
4383 local to buffer
4384 {not in Vi}
4385 {only available when compiled with the |+osfiletype|
4386 feature}
4387 Some operating systems store extra information about files besides
4388 name, datestamp and permissions. This option contains the extra
4389 information, the nature of which will vary between systems.
4390 The value of this option is usually set when the file is loaded, and
4391 use to set the file type when file is written.
4392 It can affect the pattern matching of the automatic commands.
4393 |autocmd-osfiletypes|
4394
4395 *'paragraphs'* *'para'*
4396'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4397 global
4398 Specifies the nroff macros that separate paragraphs. These are pairs
4399 of two letters (see |object-motions|).
4400
4401 *'paste'* *'nopaste'*
4402'paste' boolean (default off)
4403 global
4404 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004405 Put Vim in Paste mode. This is useful if you want to cut or copy
4406 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 unexpected effects.
4408 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004409 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 knows about pasting and will mostly do the right thing without 'paste'
4411 being set. The same is true for a terminal where Vim handles the
4412 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004413 This option is reset when starting the GUI. Thus if you set it in
4414 your .vimrc it will work in a terminal, but not in the GUI. Setting
4415 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4416 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417 When the 'paste' option is switched on (also when it was already on):
4418 - mapping in Insert mode and Command-line mode is disabled
4419 - abbreviations are disabled
4420 - 'textwidth' is set to 0
4421 - 'wrapmargin' is set to 0
4422 - 'autoindent' is reset
4423 - 'smartindent' is reset
4424 - 'softtabstop' is set to 0
4425 - 'revins' is reset
4426 - 'ruler' is reset
4427 - 'showmatch' is reset
4428 - 'formatoptions' is used like it is empty
4429 These options keep their value, but their effect is disabled:
4430 - 'lisp'
4431 - 'indentexpr'
4432 - 'cindent'
4433 NOTE: When you start editing another file while the 'paste' option is
4434 on, settings from the modelines or autocommands may change the
4435 settings again, causing trouble when pasting text. You might want to
4436 set the 'paste' option again.
4437 When the 'paste' option is reset the mentioned options are restored to
4438 the value before the moment 'paste' was switched from off to on.
4439 Resetting 'paste' before ever setting it does not have any effect.
4440 Since mapping doesn't work while 'paste' is active, you need to use
4441 the 'pastetoggle' option to toggle the 'paste' option with some key.
4442
4443 *'pastetoggle'* *'pt'*
4444'pastetoggle' 'pt' string (default "")
4445 global
4446 {not in Vi}
4447 When non-empty, specifies the key sequence that toggles the 'paste'
4448 option. This is like specifying a mapping: >
4449 :map {keys} :set invpaste<CR>
4450< Where {keys} is the value of 'pastetoggle'.
4451 The difference is that it will work even when 'paste' is set.
4452 'pastetoggle' works in Insert mode and Normal mode, but not in
4453 Command-line mode.
4454 Mappings are checked first, thus overrule 'pastetoggle'. However,
4455 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4456 this: >
4457 :map <F10> :set paste<CR>
4458 :map <F11> :set nopaste<CR>
4459 :imap <F10> <C-O>:set paste<CR>
4460 :imap <F11> <nop>
4461 :set pastetoggle=<F11>
4462< This will make <F10> start paste mode and <F11> stop paste mode.
4463 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4464 mode everything is inserted literally, except the 'pastetoggle' key
4465 sequence.
4466
4467 *'pex'* *'patchexpr'*
4468'patchexpr' 'pex' string (default "")
4469 global
4470 {not in Vi}
4471 {not available when compiled without the |+diff|
4472 feature}
4473 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004474 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475
4476 *'patchmode'* *'pm'* *E206*
4477'patchmode' 'pm' string (default "")
4478 global
4479 {not in Vi}
4480 When non-empty the oldest version of a file is kept. This can be used
4481 to keep the original version of a file if you are changing files in a
4482 source distribution. Only the first time that a file is written a
4483 copy of the original file will be kept. The name of the copy is the
4484 name of the original file with the string in the 'patchmode' option
4485 appended. This option should start with a dot. Use a string like
4486 ".org". 'backupdir' must not be empty for this to work (Detail: The
4487 backup file is renamed to the patchmode file after the new file has
4488 been successfully written, that's why it must be possible to write a
4489 backup file). If there was no file to be backed up, an empty file is
4490 created.
4491 When the 'backupskip' pattern matches, a patchmode file is not made.
4492 Using 'patchmode' for compressed files appends the extension at the
4493 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4494 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004495 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496
4497 *'path'* *'pa'* *E343* *E345* *E347*
4498'path' 'pa' string (default on Unix: ".,/usr/include,,"
4499 on OS/2: ".,/emx/include,,"
4500 other systems: ".,,")
4501 global or local to buffer |global-local|
4502 {not in Vi}
4503 This is a list of directories which will be searched when using the
4504 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4505 being searched for has a relative path (not starting with '/'). The
4506 directories in the 'path' option may be relative or absolute.
4507 - Use commas to separate directory names: >
4508 :set path=.,/usr/local/include,/usr/include
4509< - Spaces can also be used to separate directory names (for backwards
4510 compatibility with version 3.0). To have a space in a directory
4511 name, precede it with an extra backslash, and escape the space: >
4512 :set path=.,/dir/with\\\ space
4513< - To include a comma in a directory name precede it with an extra
4514 backslash: >
4515 :set path=.,/dir/with\\,comma
4516< - To search relative to the directory of the current file, use: >
4517 :set path=.
4518< - To search in the current directory use an empty string between two
4519 commas: >
4520 :set path=,,
4521< - A directory name may end in a ':' or '/'.
4522 - Environment variables are expanded |:set_env|.
4523 - When using |netrw.vim| URLs can be used. For example, adding
4524 "http://www.vim.org" will make ":find index.html" work.
4525 - Search upwards and downwards in a directory tree:
4526 1) "*" matches a sequence of characters, e.g.: >
4527 :set path=/usr/include/*
4528< means all subdirectories in /usr/include (but not /usr/include
4529 itself). >
4530 :set path=/usr/*c
4531< matches /usr/doc and /usr/src.
4532 2) "**" matches a subtree, up to 100 directories deep. Example: >
4533 :set path=/home/user_x/src/**
4534< means search in the whole subtree under "/home/usr_x/src".
4535 3) If the path ends with a ';', this path is the startpoint
4536 for upward search.
4537 See |file-searching| for more info and exact syntax.
4538 {not available when compiled without the |+path_extra| feature}
4539 - Careful with '\' characters, type two to get one in the option: >
4540 :set path=.,c:\\include
4541< Or just use '/' instead: >
4542 :set path=.,c:/include
4543< Don't forget "." or files won't even be found in the same directory as
4544 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004545 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 it is something like 256 or 1024 characters.
4547 You can check if all the include files are found, using the value of
4548 'path', see |:checkpath|.
4549 The use of |:set+=| and |:set-=| is preferred when adding or removing
4550 directories from the list. This avoids problems when a future version
4551 uses another default. To remove the current directory use: >
4552 :set path-=
4553< To add the current directory use: >
4554 :set path+=
4555< To use an environment variable, you probably need to replace the
4556 separator. Here is an example to append $INCL, in which directory
4557 names are separated with a semi-colon: >
4558 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4559< Replace the ';' with a ':' or whatever separator is used. Note that
4560 this doesn't work when $INCL contains a comma or white space.
4561
4562 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4563'preserveindent' 'pi' boolean (default off)
4564 local to buffer
4565 {not in Vi}
4566 When changing the indent of the current line, preserve as much of the
4567 indent structure as possible. Normally the indent is replaced by a
4568 series of tabs followed by spaces as required (unless |'expandtab'| is
4569 enabled, in which case only spaces are used). Enabling this option
4570 means the indent will preserve as many existing characters as possible
4571 for indenting, and only add additional tabs or spaces as required.
4572 NOTE: When using ">>" multiple times the resulting indent is a mix of
4573 tabs and spaces. You might not like this.
4574 NOTE: 'preserveindent' is reset when 'compatible' is set.
4575 Also see 'copyindent'.
4576 Use |:retab| to clean up white space.
4577
4578 *'previewheight'* *'pvh'*
4579'previewheight' 'pvh' number (default 12)
4580 global
4581 {not in Vi}
4582 {not available when compiled without the |+windows| or
4583 |+quickfix| feature}
4584 Default height for a preview window. Used for |:ptag| and associated
4585 commands. Used for |CTRL-W_}| when no count is given.
4586
4587 *'previewwindow'* *'nopreviewwindow'*
4588 *'pvw'* *'nopvw'* *E590*
4589'previewwindow' 'pvw' boolean (default off)
4590 local to window
4591 {not in Vi}
4592 {not available when compiled without the |+windows| or
4593 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004594 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 set. It's normally not set directly, but by using one of the commands
4596 |:ptag|, |:pedit|, etc.
4597
4598 *'printdevice'* *'pdev'*
4599'printdevice' 'pdev' string (default empty)
4600 global
4601 {not in Vi}
4602 {only available when compiled with the |+printer|
4603 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004604 The name of the printer to be used for |:hardcopy|.
4605 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004606 This option cannot be set from a |modeline| or in the |sandbox|, for
4607 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608
Bram Moolenaar8299df92004-07-10 09:47:34 +00004609 *'printencoding'* *'penc'*
4610'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611 global
4612 {not in Vi}
4613 {only available when compiled with the |+printer|
4614 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004615 Sets the character encoding used when printing.
4616 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617
4618 *'printexpr'* *'pexpr'*
4619'printexpr' 'pexpr' String (default: see below)
4620 global
4621 {not in Vi}
4622 {only available when compiled with the |+printer|
4623 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004624 Expression used to print the PostScript produced with |:hardcopy|.
4625 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626
Bram Moolenaar8299df92004-07-10 09:47:34 +00004627 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628'printfont' 'pfn' string (default "courier")
4629 global
4630 {not in Vi}
4631 {only available when compiled with the |+printer|
4632 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004633 The name of the font that will be used for |:hardcopy|.
4634 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635
4636 *'printheader'* *'pheader'*
4637'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4638 global
4639 {not in Vi}
4640 {only available when compiled with the |+printer|
4641 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004642 The format of the header produced in |:hardcopy| output.
4643 See |pheader-option|.
4644
4645 *'printmbcharset'* *'pmbcs'*
4646'printmbcharset' 'pmbcs' string (default "")
4647 global
4648 {not in Vi}
4649 {only available when compiled with the |+printer|
4650 and |+multi_byte| features}
4651 The CJK character set to be used for CJK output from |:hardcopy|.
4652 See |pmbcs-option|.
4653
4654 *'printmbfont'* *'pmbfn'*
4655'printmbfont' 'pmbfn' string (default "")
4656 global
4657 {not in Vi}
4658 {only available when compiled with the |+printer|
4659 and |+multi_byte| features}
4660 List of font names to be used for CJK output from |:hardcopy|.
4661 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662
4663 *'printoptions'* *'popt'*
4664'printoptions' 'popt' string (default "")
4665 global
4666 {not in Vi}
4667 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004668 List of items that control the format of the output of |:hardcopy|.
4669 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670
Bram Moolenaar677ee682005-01-27 14:41:15 +00004671 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004672'quoteescape' 'qe' string (default "\")
4673 local to buffer
4674 {not in Vi}
4675 The characters that are used to escape quotes in a string. Used for
4676 objects like a', a" and a` |a'|.
4677 When one of the characters in this option is found inside a string,
4678 the following character will be skipped. The default value makes the
4679 text "foo\"bar\\" considered to be one string.
4680
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4682'readonly' 'ro' boolean (default off)
4683 local to buffer
4684 If on, writes fail unless you use a '!'. Protects you from
4685 accidentally overwriting a file. Default on when Vim is started
4686 in read-only mode ("vim -R") or when the executable is called "view".
4687 {not in Vi:} When using the ":view" command the 'readonly' option is
4688 set for the newly edited buffer. When using ":w!" the 'readonly'
4689 option is reset for the current buffer.
4690
4691 *'remap'* *'noremap'*
4692'remap' boolean (default on)
4693 global
4694 Allows for mappings to work recursively. If you do not want this for
4695 a single entry, use the :noremap[!] command.
4696
4697 *'report'*
4698'report' number (default 2)
4699 global
4700 Threshold for reporting number of lines changed. When the number of
4701 changed lines is more than 'report' a message will be given for most
4702 ":" commands. If you want it always, set 'report' to 0.
4703 For the ":substitute" command the number of substitutions is used
4704 instead of the number of lines.
4705
4706 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4707'restorescreen' 'rs' boolean (default on)
4708 global
4709 {not in Vi} {only in Windows 95/NT console version}
4710 When set, the screen contents is restored when exiting Vim. This also
4711 happens when executing external commands.
4712
4713 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4714 options in your .vimrc. To disable restoring:
4715 set t_ti= t_te=
4716 To enable restoring (for an xterm):
4717 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4718 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4719
4720 *'revins'* *'ri'* *'norevins'* *'nori'*
4721'revins' 'ri' boolean (default off)
4722 global
4723 {not in Vi}
4724 {only available when compiled with the |+rightleft|
4725 feature}
4726 Inserting characters in Insert mode will work backwards. See "typing
4727 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4728 command in Insert mode, when 'allowrevins' is set.
4729 NOTE: This option is reset when 'compatible' or 'paste' is set.
4730
4731 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4732'rightleft' 'rl' boolean (default off)
4733 local to window
4734 {not in Vi}
4735 {only available when compiled with the |+rightleft|
4736 feature}
4737 When on, display orientation becomes right-to-left, i.e., characters
4738 that are stored in the file appear from the right to the left.
4739 Using this option, it is possible to edit files for languages that
4740 are written from the right to the left such as Hebrew and Arabic.
4741 This option is per window, so it is possible to edit mixed files
4742 simultaneously, or to view the same file in both ways (this is
4743 useful whenever you have a mixed text file with both right-to-left
4744 and left-to-right strings so that both sets are displayed properly
4745 in different windows). Also see |rileft.txt|.
4746
4747 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4748'rightleftcmd' 'rlc' string (default "search")
4749 local to window
4750 {not in Vi}
4751 {only available when compiled with the |+rightleft|
4752 feature}
4753 Each word in this option enables the command line editing to work in
4754 right-to-left mode for a group of commands:
4755
4756 search "/" and "?" commands
4757
4758 This is useful for languages such as Hebrew, Arabic and Farsi.
4759 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4760
4761 *'ruler'* *'ru'* *'noruler'* *'noru'*
4762'ruler' 'ru' boolean (default off)
4763 global
4764 {not in Vi}
4765 {not available when compiled without the
4766 |+cmdline_info| feature}
4767 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004768 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769 text in the file is shown on the far right:
4770 Top first line is visible
4771 Bot last line is visible
4772 All first and last line are visible
4773 45% relative position in the file
4774 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004775 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 ruler is shown there. Otherwise it is shown in the last line of the
4777 screen. If the statusline is given by 'statusline' (ie. not empty),
4778 this option takes precedence over 'ruler' and 'rulerformat'
4779 If the number of characters displayed is different from the number of
4780 bytes in the text (e.g., for a TAB or a multi-byte character), both
4781 the text column (byte number) and the screen column are shown,
4782 separated with a dash.
4783 For an empty line "0-1" is shown.
4784 For an empty buffer the line number will also be zero: "0,0-1".
4785 This option is reset when the 'paste' option is set.
4786 If you don't want to see the ruler all the time but want to know where
4787 you are, use "g CTRL-G" |g_CTRL-G|.
4788 NOTE: This option is reset when 'compatible' is set.
4789
4790 *'rulerformat'* *'ruf'*
4791'rulerformat' 'ruf' string (default empty)
4792 global
4793 {not in Vi}
4794 {not available when compiled without the |+statusline|
4795 feature}
4796 When this option is not empty, it determines the content of the ruler
4797 string, as displayed for the 'ruler' option.
4798 The format of this option, is like that of 'statusline'.
4799 The default ruler width is 17 characters. To make the ruler 15
4800 characters wide, put "%15(" at the start and "%)" at the end.
4801 Example: >
4802 :set rulerformat=%15(%c%V\ %p%%%)
4803<
4804 *'runtimepath'* *'rtp'* *vimfiles*
4805'runtimepath' 'rtp' string (default:
4806 Unix: "$HOME/.vim,
4807 $VIM/vimfiles,
4808 $VIMRUNTIME,
4809 $VIM/vimfiles/after,
4810 $HOME/.vim/after"
4811 Amiga: "home:vimfiles,
4812 $VIM/vimfiles,
4813 $VIMRUNTIME,
4814 $VIM/vimfiles/after,
4815 home:vimfiles/after"
4816 PC, OS/2: "$HOME/vimfiles,
4817 $VIM/vimfiles,
4818 $VIMRUNTIME,
4819 $VIM/vimfiles/after,
4820 $HOME/vimfiles/after"
4821 Macintosh: "$VIM:vimfiles,
4822 $VIMRUNTIME,
4823 $VIM:vimfiles:after"
4824 RISC-OS: "Choices:vimfiles,
4825 $VIMRUNTIME,
4826 Choices:vimfiles/after"
4827 VMS: "sys$login:vimfiles,
4828 $VIM/vimfiles,
4829 $VIMRUNTIME,
4830 $VIM/vimfiles/after,
4831 sys$login:vimfiles/after"
4832 global
4833 {not in Vi}
4834 This is a list of directories which will be searched for runtime
4835 files:
4836 filetype.vim filetypes by file name |new-filetype|
4837 scripts.vim filetypes by file contents |new-filetype-scripts|
4838 colors/ color scheme files |:colorscheme|
4839 compiler/ compiler files |:compiler|
4840 doc/ documentation |write-local-help|
4841 ftplugin/ filetype plugins |write-filetype-plugin|
4842 indent/ indent scripts |indent-expression|
4843 keymap/ key mapping files |mbyte-keymap|
4844 lang/ menu translations |:menutrans|
4845 menu.vim GUI menus |menu.vim|
4846 plugin/ plugin scripts |write-plugin|
4847 print/ files for printing |postscript-print-encoding|
4848 syntax/ syntax files |mysyntaxfile|
4849 tutor/ files for vimtutor |tutor|
4850
4851 And any other file searched for with the |:runtime| command.
4852
4853 The defaults for most systems are setup to search five locations:
4854 1. In your home directory, for your personal preferences.
4855 2. In a system-wide Vim directory, for preferences from the system
4856 administrator.
4857 3. In $VIMRUNTIME, for files distributed with Vim.
4858 *after-directory*
4859 4. In the "after" directory in the system-wide Vim directory. This is
4860 for the system administrator to overrule or add to the distributed
4861 defaults (rarely needed)
4862 5. In the "after" directory in your home directory. This is for
4863 personal preferences to overrule or add to the distributed defaults
4864 or system-wide settings (rarely needed).
4865
4866 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
4867 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004868 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 wildcards.
4870 See |:runtime|.
4871 Example: >
4872 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
4873< This will use the directory "~/vimruntime" first (containing your
4874 personal Vim runtime files), then "/mygroup/vim" (shared between a
4875 group of people) and finally "$VIMRUNTIME" (the distributed runtime
4876 files).
4877 You probably should always include $VIMRUNTIME somewhere, to use the
4878 distributed runtime files. You can put a directory before $VIMRUNTIME
4879 to find files which replace a distributed runtime files. You can put
4880 a directory after $VIMRUNTIME to find files which add to distributed
4881 runtime files.
4882 This option cannot be set from a |modeline| or in the |sandbox|, for
4883 security reasons.
4884
4885 *'scroll'* *'scr'*
4886'scroll' 'scr' number (default: half the window height)
4887 local to window
4888 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
4889 set to half the number of lines in the window when the window size
4890 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004891 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
4893 the number of screen lines instead of file lines, makes a difference
4894 when lines wrap}
4895
4896 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
4897'scrollbind' 'scb' boolean (default off)
4898 local to window
4899 {not in Vi}
4900 {not available when compiled without the |+scrollbind|
4901 feature}
4902 See also |scroll-binding|. When this option is set, the current
4903 window scrolls as other scrollbind windows (windows that also have
4904 this option set) scroll. This option is useful for viewing the
4905 differences between two versions of a file, see 'diff'.
4906 See |'scrollopt'| for options that determine how this option should be
4907 interpreted.
4908 This option is mostly reset when splitting a window to edit another
4909 file. This means that ":split | edit file" results in two windows
4910 with scroll-binding, but ":split file" does not.
4911
4912 *'scrolljump'* *'sj'*
4913'scrolljump' 'sj' number (default 1)
4914 global
4915 {not in Vi}
4916 Minimal number of lines to scroll when the cursor gets off the
4917 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
4918 CTRL-D). Useful if your terminal scrolls very slowly.
4919 NOTE: This option is set to 1 when 'compatible' is set.
4920
4921 *'scrolloff'* *'so'*
4922'scrolloff' 'so' number (default 0)
4923 global
4924 {not in Vi}
4925 Minimal number of screen lines to keep above and below the cursor.
4926 This will make some context visible around where you are working. If
4927 you set it to a very large value (999) the cursor line will always be
4928 in the middle of the window (except at the start or end of the file or
4929 when long lines wrap).
4930 For scrolling horizontally see 'sidescrolloff'.
4931 NOTE: This option is set to 0 when 'compatible' is set.
4932
4933 *'scrollopt'* *'sbo'*
4934'scrollopt' 'sbo' string (default "ver,jump")
4935 global
4936 {not available when compiled without the |+scrollbind|
4937 feature}
4938 {not in Vi}
4939 This is a comma-separated list of words that specifies how
4940 'scrollbind' windows should behave.
4941 The following words are available:
4942 ver Bind vertical scrolling for 'scrollbind' windows
4943 hor Bind horizontal scrolling for 'scrollbind' windows
4944 jump Applies to the offset between two windows for vertical
4945 scrolling. This offset is the difference in the first
4946 displayed line of the bound windows. When moving
4947 around in a window, another 'scrollbind' window may
4948 reach a position before the start or after the end of
4949 the buffer. The offset is not changed though, when
4950 moving back the 'scrollbind' window will try to scroll
4951 to the desired position when possible.
4952 When now making that window the current one, two
4953 things can be done with the relative offset:
4954 1. When "jump" is not included, the relative offset is
4955 adjusted for the scroll position in the new current
4956 window. When going back to the other window, the
4957 the new relative offset will be used.
4958 2. When "jump" is included, the other windows are
4959 scrolled to keep the same relative offset. When
4960 going back to the other window, it still uses the
4961 same relative offset.
4962 Also see |scroll-binding|.
4963
4964 *'sections'* *'sect'*
4965'sections' 'sect' string (default "SHNHH HUnhsh")
4966 global
4967 Specifies the nroff macros that separate sections. These are pairs of
4968 two letters (See |object-motions|). The default makes a section start
4969 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
4970
4971 *'secure'* *'nosecure'* *E523*
4972'secure' boolean (default off)
4973 global
4974 {not in Vi}
4975 When on, ":autocmd", shell and write commands are not allowed in
4976 ".vimrc" and ".exrc" in the current directory and map commands are
4977 displayed. Switch it off only if you know that you will not run into
4978 problems, or when the 'exrc' option is off. On Unix this option is
4979 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004980 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 'secure' at the end of your ~/.vimrc then.
4982 This option cannot be set from a |modeline| or in the |sandbox|, for
4983 security reasons.
4984
4985 *'selection'* *'sel'*
4986'selection' 'sel' string (default "inclusive")
4987 global
4988 {not in Vi}
4989 This option defines the behavior of the selection. It is only used
4990 in Visual and Select mode.
4991 Possible values:
4992 value past line inclusive ~
4993 old no yes
4994 inclusive yes yes
4995 exclusive yes no
4996 "past line" means that the cursor is allowed to be positioned one
4997 character past the line.
4998 "inclusive" means that the last character of the selection is included
4999 in an operation. For example, when "x" is used to delete the
5000 selection.
5001 Note that when "exclusive" is used and selecting from the end
5002 backwards, you cannot include the last character of a line, when
5003 starting in Normal mode and 'virtualedit' empty.
5004
5005 The 'selection' option is set by the |:behave| command.
5006
5007 *'selectmode'* *'slm'*
5008'selectmode' 'slm' string (default "")
5009 global
5010 {not in Vi}
5011 This is a comma separated list of words, which specifies when to start
5012 Select mode instead of Visual mode, when a selection is started.
5013 Possible values:
5014 mouse when using the mouse
5015 key when using shifted special keys
5016 cmd when using "v", "V" or CTRL-V
5017 See |Select-mode|.
5018 The 'selectmode' option is set by the |:behave| command.
5019
5020 *'sessionoptions'* *'ssop'*
5021'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5022 help,options,winsize")
5023 global
5024 {not in Vi}
5025 {not available when compiled without the +mksession
5026 feature}
5027 Changes the effect of the |:mksession| command. It is a comma
5028 separated list of words. Each word enables saving and restoring
5029 something:
5030 word save and restore ~
5031 blank empty windows
5032 buffers hidden and unloaded buffers, not just those in windows
5033 curdir the current directory
5034 folds manually created folds, opened/closed folds and local
5035 fold options
5036 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005037 and contain at least one lowercase letter. Only
5038 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 help the help window
5040 localoptions options and mappings local to a window or buffer (not
5041 global values for local options)
5042 options all options and mappings (also global values for local
5043 options)
5044 resize size of the Vim window: 'lines' and 'columns'
5045 sesdir the directory in which the session file is located
5046 will become the current directory (useful with
5047 projects accessed over a network from different
5048 systems)
5049 slash backslashes in file names replaced with forward
5050 slashes
5051 unix with Unix end-of-line format (single <NL>), even when
5052 on Windows or DOS
5053 winpos position of the whole Vim window
5054 winsize window sizes
5055
5056 Don't include both "curdir" and "sesdir".
5057 When "curdir" nor "sesdir" is included, file names are stored with
5058 absolute paths.
5059 "slash" and "unix" are useful on Windows when sharing session files
5060 with Unix. The Unix version of Vim cannot source dos format scripts,
5061 but the Windows version of Vim can source unix format scripts.
5062
5063 *'shell'* *'sh'* *E91*
5064'shell' 'sh' string (default $SHELL or "sh",
5065 MS-DOS and Win32: "command.com" or
5066 "cmd.exe", OS/2: "cmd")
5067 global
5068 Name of the shell to use for ! and :! commands. When changing the
5069 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5070 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005071 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 See |option-backslash| about including spaces and backslashes.
5073 Environment variables are expanded |:set_env|.
5074 If the name of the shell contains a space, you might need to enclose
5075 it in quotes. Example: >
5076 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5077< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005078 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 "-f" is not inside the quotes, because it is not part of the command
5080 name. And Vim automagically recognizes the backslashes that are path
5081 separators.
5082 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5083 variable to change the way external commands are executed. See the
5084 libc.inf file of DJGPP.
5085 Under MS-Windows, when the executable ends in ".com" it must be
5086 included. Thus setting the shell to "command.com" or "4dos.com"
5087 works, but "command" and "4dos" do not work for all commands (e.g.,
5088 filtering).
5089 For unknown reasons, when using "4dos.com" the current directory is
5090 changed to "C:\". To avoid this set 'shell' like this: >
5091 :set shell=command.com\ /c\ 4dos
5092< This option cannot be set from a |modeline| or in the |sandbox|, for
5093 security reasons.
5094
5095 *'shellcmdflag'* *'shcf'*
5096'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5097 does not contain "sh" somewhere: "/c")
5098 global
5099 {not in Vi}
5100 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5101 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5102 systems, the default is set according to the value of 'shell', to
5103 reduce the need to set this option by the user. It's not used for
5104 OS/2 (EMX figures this out itself). See |option-backslash| about
5105 including spaces and backslashes. See |dos-shell|.
5106 This option cannot be set from a |modeline| or in the |sandbox|, for
5107 security reasons.
5108
5109 *'shellpipe'* *'sp'*
5110'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5111 global
5112 {not in Vi}
5113 {not available when compiled without the |+quickfix|
5114 feature}
5115 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005116 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 including spaces and backslashes.
5118 The name of the temporary file can be represented by "%s" if necessary
5119 (the file name is appended automatically if no %s appears in the value
5120 of this option).
5121 For the Amiga and MS-DOS the default is ">". The output is directly
5122 saved in a file and not echoed to the screen.
5123 For Unix the default it "| tee". The stdout of the compiler is saved
5124 in a file and echoed to the screen. If the 'shell' option is "csh" or
5125 "tcsh" after initializations, the default becomes "|& tee". If the
5126 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5127 "2>&1| tee". This means that stderr is also included.
5128 The initialization of this option is done after reading the ".vimrc"
5129 and the other initializations, so that when the 'shell' option is set
5130 there, the 'shellpipe' option changes automatically, unless it was
5131 explicitly set before.
5132 When 'shellpipe' is set to an empty string, no redirection of the
5133 ":make" output will be done. This is useful if you use a 'makeprg'
5134 that writes to 'makeef' by itself. If you want no piping, but do
5135 want to include the 'makeef', set 'shellpipe' to a single space.
5136 Don't forget to precede the space with a backslash: ":set sp=\ ".
5137 In the future pipes may be used for filtering and this option will
5138 become obsolete (at least for Unix).
5139 This option cannot be set from a |modeline| or in the |sandbox|, for
5140 security reasons.
5141
5142 *'shellquote'* *'shq'*
5143'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5144 contains "sh" somewhere: "\"")
5145 global
5146 {not in Vi}
5147 Quoting character(s), put around the command passed to the shell, for
5148 the "!" and ":!" commands. The redirection is kept outside of the
5149 quoting. See 'shellxquote' to include the redirection. It's
5150 probably not useful to set both options.
5151 This is an empty string by default. Only known to be useful for
5152 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5153 or bash, where it should be "\"". The default is adjusted according
5154 the value of 'shell', to reduce the need to set this option by the
5155 user. See |dos-shell|.
5156 This option cannot be set from a |modeline| or in the |sandbox|, for
5157 security reasons.
5158
5159 *'shellredir'* *'srr'*
5160'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5161 global
5162 {not in Vi}
5163 String to be used to put the output of a filter command in a temporary
5164 file. See also |:!|. See |option-backslash| about including spaces
5165 and backslashes.
5166 The name of the temporary file can be represented by "%s" if necessary
5167 (the file name is appended automatically if no %s appears in the value
5168 of this option).
5169 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5170 or "zsh" during initializations, the default becomes ">&". If the
5171 'shell' option is "sh", "ksh" or "bash" the default becomes
5172 ">%s 2>&1". This means that stderr is also included.
5173 For Win32, the Unix checks are done and additionally "cmd" is checked
5174 for, which makes the default ">%s 2>&1". Also, the same names with
5175 ".exe" appended are checked for.
5176 The initialization of this option is done after reading the ".vimrc"
5177 and the other initializations, so that when the 'shell' option is set
5178 there, the 'shellredir' option changes automatically unless it was
5179 explicitly set before.
5180 In the future pipes may be used for filtering and this option will
5181 become obsolete (at least for Unix).
5182 This option cannot be set from a |modeline| or in the |sandbox|, for
5183 security reasons.
5184
5185 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5186'shellslash' 'ssl' boolean (default off)
5187 global
5188 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5189 When set, a forward slash is used when expanding file names. This is
5190 useful when a Unix-like shell is used instead of command.com or
5191 cmd.exe. Backward slashes can still be typed, but they are changed to
5192 forward slashes by Vim.
5193 Note that setting or resetting this option has no effect for some
5194 existing file names, thus this option needs to be set before opening
5195 any file for best results. This might change in the future.
5196 'shellslash' only works when a backslash can be used as a path
5197 separator. To test if this is so use: >
5198 if exists('+shellslash')
5199<
5200 *'shelltype'* *'st'*
5201'shelltype' 'st' number (default 0)
5202 global
5203 {not in Vi} {only for the Amiga}
5204 On the Amiga this option influences the way how the commands work
5205 which use a shell.
5206 0 and 1: always use the shell
5207 2 and 3: use the shell only to filter lines
5208 4 and 5: use shell only for ':sh' command
5209 When not using the shell, the command is executed directly.
5210
5211 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5212 1 and 3: use "shell cmd" to start external commands
5213
5214 *'shellxquote'* *'sxq'*
5215'shellxquote' 'sxq' string (default: "";
5216 for Win32, when 'shell' contains "sh"
5217 somewhere: "\""
5218 for Unix, when using system(): "\"")
5219 global
5220 {not in Vi}
5221 Quoting character(s), put around the command passed to the shell, for
5222 the "!" and ":!" commands. Includes the redirection. See
5223 'shellquote' to exclude the redirection. It's probably not useful
5224 to set both options.
5225 This is an empty string by default. Known to be useful for
5226 third-party shells when using the Win32 version, such as the MKS Korn
5227 Shell or bash, where it should be "\"". The default is adjusted
5228 according the value of 'shell', to reduce the need to set this option
5229 by the user. See |dos-shell|.
5230 This option cannot be set from a |modeline| or in the |sandbox|, for
5231 security reasons.
5232
5233 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5234'shiftround' 'sr' boolean (default off)
5235 global
5236 {not in Vi}
5237 Round indent to multiple of 'shiftwidth'. Applies to > and <
5238 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5239 a multiple of 'shiftwidth' (this is Vi compatible).
5240 NOTE: This option is reset when 'compatible' is set.
5241
5242 *'shiftwidth'* *'sw'*
5243'shiftwidth' 'sw' number (default 8)
5244 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005245 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 |'cindent'|, |>>|, |<<|, etc.
5247
5248 *'shortmess'* *'shm'*
5249'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "")
5250 global
5251 {not in Vi}
5252 This option helps to avoid all the |hit-enter| prompts caused by file
5253 messages, for example with CTRL-G, and to avoid some other messages.
5254 It is a list of flags:
5255 flag meaning when present ~
5256 f use "(3 of 5)" instead of "(file 3 of 5)"
5257 i use "[noeol]" instead of "[Incomplete last line]"
5258 l use "999L, 888C" instead of "999 lines, 888 characters"
5259 m use "[+]" instead of "[Modified]"
5260 n use "[New]" instead of "[New File]"
5261 r use "[RO]" instead of "[readonly]"
5262 w use "[w]" instead of "written" for file write message
5263 and "[a]" instead of "appended" for ':w >> file' command
5264 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5265 "[unix format]" and "[mac]" instead of "[mac format]".
5266 a all of the above abbreviations
5267
5268 o overwrite message for writing a file with subsequent message
5269 for reading a file (useful for ":wn" or when 'autowrite' on)
5270 O message for reading a file overwrites any previous message.
5271 Also for quickfix message (e.g., ":cn").
5272 s don't give "search hit BOTTOM, continuing at TOP" or "search
5273 hit TOP, continuing at BOTTOM" messages
5274 t truncate file message at the start if it is too long to fit
5275 on the command-line, "<" will appear in the left most column.
5276 Ignored in Ex mode.
5277 T truncate other messages in the middle if they are too long to
5278 fit on the command line. "..." will appear in the middle.
5279 Ignored in Ex mode.
5280 W don't give "written" or "[w]" when writing a file
5281 A don't give the "ATTENTION" message when an existing swap file
5282 is found.
5283 I don't give the intro message when starting Vim |:intro|.
5284
5285 This gives you the opportunity to avoid that a change between buffers
5286 requires you to hit <Enter>, but still gives as useful a message as
5287 possible for the space available. To get the whole message that you
5288 would have got with 'shm' empty, use ":file!"
5289 Useful values:
5290 shm= No abbreviation of message.
5291 shm=a Abbreviation, but no loss of information.
5292 shm=at Abbreviation, and truncate message when necessary.
5293
5294 NOTE: This option is set to the Vi default value when 'compatible' is
5295 set and to the Vim default value when 'compatible' is reset.
5296
5297 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5298'shortname' 'sn' boolean (default off)
5299 local to buffer
5300 {not in Vi, not in MS-DOS versions}
5301 Filenames are assumed to be 8 characters plus one extension of 3
5302 characters. Multiple dots in file names are not allowed. When this
5303 option is on, dots in file names are replaced with underscores when
5304 adding an extension (".~" or ".swp"). This option is not available
5305 for MS-DOS, because then it would always be on. This option is useful
5306 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5307 or crossdos. When running the Win32 GUI version under Win32s, this
5308 option is always on by default.
5309
5310 *'showbreak'* *'sbr'* *E595*
5311'showbreak' 'sbr' string (default "")
5312 global
5313 {not in Vi}
5314 {not available when compiled without the |+linebreak|
5315 feature}
5316 String to put at the start of lines that have been wrapped. Useful
5317 values are "> " or "+++ ".
5318 Only printable single-cell characters are allowed, excluding <Tab> and
5319 comma (in a future version the comma might be used to separate the
5320 part that is shown at the end and at the start of a line).
5321 The characters are highlighted according to the '@' flag in
5322 'highlight'.
5323 Note that tabs after the showbreak will be displayed differently.
5324 If you want the 'showbreak' to appear in between line numbers, add the
5325 "n" flag to 'cpoptions'.
5326
5327 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5328'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5329 off)
5330 global
5331 {not in Vi}
5332 {not available when compiled without the
5333 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005334 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335 terminal is slow.
5336 In Visual mode the size of the selected area is shown:
5337 - When selecting characters within a line, the number of characters.
5338 - When selecting more than one line, the number of lines.
5339 - When selecting a block, the size in screen characters: linesxcolumns.
5340 NOTE: This option is set to the Vi default value when 'compatible' is
5341 set and to the Vim default value when 'compatible' is reset.
5342
5343 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5344'showfulltag' 'sft' boolean (default off)
5345 global
5346 {not in Vi}
5347 When completing a word in insert mode (see |ins-completion|) from the
5348 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005349 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 matched a C function, you can see a template for what arguments are
5351 required (coding style permitting).
5352
5353 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5354'showmatch' 'sm' boolean (default off)
5355 global
5356 When a bracket is inserted, briefly jump to the matching one. The
5357 jump is only done if the match can be seen on the screen. The time to
5358 show the match can be set with 'matchtime'.
5359 A Beep is given if there is no match (no matter if the match can be
5360 seen or not). This option is reset when the 'paste' option is set.
5361 When the 'm' flag is not included in 'cpoptions', typing a character
5362 will immediately move the cursor back to where it belongs.
5363 See the "sm" field in 'guicursor' for setting the cursor shape and
5364 blinking when showing the match.
5365 The 'matchpairs' option can be used to specify the characters to show
5366 matches for. 'rightleft' and 'revins' are used to look for opposite
5367 matches.
5368 Note: For the use of the short form parental guidance is advised.
5369
5370 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5371'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5372 global
5373 If in Insert, Replace or Visual mode put a message on the last line.
5374 Use the 'M' flag in 'highlight' to set the type of highlighting for
5375 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005376 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 doesn't mean XIM is really active, especially when 'imactivatekey' is
5378 not set.
5379 NOTE: This option is set to the Vi default value when 'compatible' is
5380 set and to the Vim default value when 'compatible' is reset.
5381
5382 *'sidescroll'* *'ss'*
5383'sidescroll' 'ss' number (default 0)
5384 global
5385 {not in Vi}
5386 The minimal number of columns to scroll horizontally. Used only when
5387 the 'wrap' option is off and the cursor is moved off of the screen.
5388 When it is zero the cursor will be put in the middle of the screen.
5389 When using a slow terminal set it to a large number or 0. When using
5390 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5391 commands.
5392
5393 *'sidescrolloff'* *'siso'*
5394'sidescrolloff' 'siso' number (default 0)
5395 global
5396 {not in Vi}
5397 The minimal number of screen columns to keep to the left and to the
5398 right of the cursor if 'nowrap' is set. Setting this option to a value
5399 greater than 0 while having |'sidescroll'| also at a non-zero value
5400 makes some context visible in the line you are scrolling in
5401 horizontally (except at the end and beginning of the line). Setting
5402 this option to a large value (like 999) has the effect of keeping the
5403 cursor horizontally centered in the window, as long as one does not
5404 come too close to the beginning or end of the line.
5405 NOTE: This option is set to 0 when 'compatible' is set.
5406
5407 Example: Try this together with 'sidescroll' and 'listchars' as
5408 in the following example to never allow the cursor to move
5409 onto the "extends" character:
5410
5411 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5412 :set sidescrolloff=1
5413
5414
5415 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5416'smartcase' 'scs' boolean (default off)
5417 global
5418 {not in Vi}
5419 Override the 'ignorecase' option if the search pattern contains upper
5420 case characters. Only used when the search pattern is typed and
5421 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005422 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5424 recalling the search pattern from history and hitting <Enter>.
5425 NOTE: This option is reset when 'compatible' is set.
5426
5427 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5428'smartindent' 'si' boolean (default off)
5429 local to buffer
5430 {not in Vi}
5431 {not available when compiled without the
5432 |+smartindent| feature}
5433 Do smart autoindenting when starting a new line. Works for C-like
5434 programs, but can also be used for other languages. 'cindent' does
5435 something like this, works better in most cases, but is more strict,
5436 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5437 'indentexpr' is a more advanced alternative.
5438 Normally 'autoindent' should also be on when using 'smartindent'.
5439 An indent is automatically inserted:
5440 - After a line ending in '{'.
5441 - After a line starting with a keyword from 'cinwords'.
5442 - Before a line starting with '}' (only with the "O" command).
5443 When typing '}' as the first character in a new line, that line is
5444 given the same indent as the matching '{'.
5445 When typing '#' as the first character in a new line, the indent for
5446 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005447 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005448 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5449 When using the ">>" command, lines starting with '#' are not shifted
5450 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005451 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452 is set smart indenting is disabled.
5453
5454 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5455'smarttab' 'sta' boolean (default off)
5456 global
5457 {not in Vi}
5458 When on, a <Tab> in front of a line inserts blanks according to
5459 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5460 a 'shiftwidth' worth of space at the start of the line.
5461 When off a <Tab> always inserts blanks according to 'tabstop'.
5462 'shiftwidth' is only used for shifting text left or right
5463 |shift-left-right|.
5464 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5465 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005466 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 NOTE: This option is reset when 'compatible' is set.
5468
5469 *'softtabstop'* *'sts'*
5470'softtabstop' 'sts' number (default 0)
5471 local to buffer
5472 {not in Vi}
5473 Number of spaces that a <Tab> counts for while performing editing
5474 operations, like inserting a <Tab> or using <BS>. It "feels" like
5475 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5476 used. This is useful to keep the 'ts' setting at its standard value
5477 of 8, while being able to edit like it is set to 'sts'. However,
5478 commands like "x" still work on the actual characters.
5479 When 'sts' is zero, this feature is off.
5480 'softtabstop' is set to 0 when the 'paste' option is set.
5481 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5482 spaces is minimized by using <Tab>s.
5483 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5484 set.
5485 NOTE: This option is set to 0 when 'compatible' is set.
5486
5487 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5488'splitbelow' 'sb' boolean (default off)
5489 global
5490 {not in Vi}
5491 {not available when compiled without the +windows
5492 feature}
5493 When on, splitting a window will put the new window below the current
5494 one. |:split|
5495
5496 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5497'splitright' 'spr' boolean (default off)
5498 global
5499 {not in Vi}
5500 {not available when compiled without the +vertsplit
5501 feature}
5502 When on, splitting a window will put the new window right of the
5503 current one. |:vsplit|
5504
5505 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5506'startofline' 'sol' boolean (default on)
5507 global
5508 {not in Vi}
5509 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005510 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005511 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005512 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 with a linewise operator, with "%" with a count and to buffer changing
5514 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5515 only has a line number, e.g., ":25" or ":+".
5516 In case of buffer changing commands the cursor is placed at the column
5517 where it was the last time the buffer was edited.
5518 NOTE: This option is set when 'compatible' is set.
5519
5520 *'statusline'* *'stl'* *E540* *E541* *E542*
5521'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005522 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 {not in Vi}
5524 {not available when compiled without the |+statusline|
5525 feature}
5526 When nonempty, this option determines the content of the status line.
5527 Also see |status-line|.
5528
5529 The option consists of printf style '%' items interspersed with
5530 normal text. Each status line item is of the form:
5531 %-0{minwid}.{maxwid}{item}
5532 All fields except the {item} is optional. A single percent sign can
5533 be given as "%%". Up to 80 items can be specified.
5534
5535 Note that the only effect of 'ruler' when this option is set (and
5536 'laststatus' is 2) is controlling the output of |CTRL-G|.
5537
5538 field meaning ~
5539 - Left justify the item. The default is right justified
5540 when minwid is larger than the length of the item.
5541 0 Leading zeroes in numeric items. Overridden by '-'.
5542 minwid Minimum width of the item, padding as set by '-' & '0'.
5543 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005544 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 on the left for text items. Numeric items will be
5546 shifted down to maxwid-2 digits followed by '>'number
5547 where number is the amount of missing digits, much like
5548 an exponential notation.
5549 item A one letter code as described below.
5550
5551 Following is a description of the possible statusline items. The
5552 second character in "item" is the type:
5553 N for number
5554 S for string
5555 F for flags as described below
5556 - not applicable
5557
5558 item meaning ~
5559 f S Path to the file in the buffer, relative to current directory.
5560 F S Full path to the file in the buffer.
5561 t S File name (tail) of file in the buffer.
5562 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5563 M F Modified flag, text is ",+" or ",-".
5564 r F Readonly flag, text is " [RO]".
5565 R F Readonly flag, text is ",RO".
5566 h F Help buffer flag, text is " [help]".
5567 H F Help buffer flag, text is ",HLP".
5568 w F Preview window flag, text is " [Preview]".
5569 W F Preview window flag, text is ",PRV".
5570 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5571 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5572 {not available when compiled without |+autocmd| feature}
5573 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5574 being used: "<keymap>"
5575 n N Buffer number.
5576 b N Value of byte under cursor.
5577 B N As above, in hexadecimal.
5578 o N Byte number in file of byte under cursor, first byte is 1.
5579 Mnemonic: Offset from start of file (with one added)
5580 {not available when compiled without |+byte_offset| feature}
5581 O N As above, in hexadecimal.
5582 N N Printer page number. (Only works in the 'printheader' option.)
5583 l N Line number.
5584 L N Number of lines in buffer.
5585 c N Column number.
5586 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005587 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 p N Percentage through file in lines as in |CTRL-G|.
5589 P S Percentage through file of displayed window. This is like the
5590 percentage described for 'ruler'. Always 3 in length.
5591 a S Argument list status as in default title. ({current} of {max})
5592 Empty if the argument file count is zero or one.
5593 { NF Evaluate expression between '{' and '}' and substitute result.
5594 ( - Start of item group. Can be used for setting the width and
5595 alignment of a section. Must be followed by %) somewhere.
5596 ) - End of item group. No width fields allowed.
5597 < - Where to truncate line if too long. Default is at the start.
5598 No width fields allowed.
5599 = - Separation point between left and right aligned items.
5600 No width fields allowed.
5601 * - Set highlight group to User{N}, where {N} is taken from the
5602 minwid field. eg. %1*. Restore normal highlight with %* or %0*.
5603 The difference between User{N} and StatusLine will be applied
5604 to StatusLineNC for the statusline of non-current windows.
5605 The number N must be between 1 and 9. See |hl-User1..9|
5606
5607 Display of flags are controlled by the following heuristic:
5608 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005609 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 with a space it is assumed that it wants to separate itself from
5611 anything but other flags. That is: A leading comma is removed if the
5612 preceding character stems from plaintext. A leading space is removed
5613 if the preceding character stems from another active flag. This will
5614 make a nice display when flags are used like in the examples below.
5615
5616 When all items in a group becomes an empty string (ie. flags that are
5617 not set) and a minwid is not set for the group, the whole group will
5618 become empty. This will make a group like the following disappear
5619 completely from the statusline when none of the flags are set. >
5620 :set statusline=...%(\ [%M%R%H]%)...
5621<
5622 Beware that an expression is evaluated each and every time the status
5623 line is displayed. The current buffer and current window will be set
5624 temporarily to that of the window (and buffer) whose statusline is
5625 currently being drawn. The expression will evaluate in this context.
5626 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5627 real current buffer. The expression is evaluated in the |sandbox|.
5628
5629 If the statusline is not updated when you want it (e.g., after setting
5630 a variable that's used in an expression), you can force an update by
5631 setting an option without changing its value. Example: >
5632 :let &ro = &ro
5633
5634< A result of all digits is regarded a number for display purposes.
5635 Otherwise the result is taken as flag text and applied to the rules
5636 described above.
5637
5638 Watch out for errors in expressions. They may render Vim unusable !
5639 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5640 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5641
5642 Examples:
5643 Emulate standard status line with 'ruler' set >
5644 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5645< Similar, but add ASCII value of char under the cursor (like "ga") >
5646 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5647< Display byte count and byte value, modified flag in red. >
5648 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5649 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5650< Display a ,GZ flag if a compressed file is loaded >
5651 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5652< In the |:autocmd|'s: >
5653 :let b:gzflag = 1
5654< And: >
5655 :unlet b:gzflag
5656< And define this function: >
5657 :function VarExists(var, val)
5658 : if exists(a:var) | return a:val | else | return '' | endif
5659 :endfunction
5660<
5661 *'suffixes'* *'su'*
5662'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5663 global
5664 {not in Vi}
5665 Files with these suffixes get a lower priority when multiple files
5666 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005667 suffixes. Spaces after the comma are ignored. A dot is also seen as
5668 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 separator, precede it with a backslash (see |option-backslash| about
5670 including spaces and backslashes).
5671 See 'wildignore' for completely ignoring files.
5672 The use of |:set+=| and |:set-=| is preferred when adding or removing
5673 suffixes from the list. This avoids problems when a future version
5674 uses another default.
5675
5676 *'suffixesadd'* *'sua'*
5677'suffixesadd' 'sua' string (default "")
5678 local to buffer
5679 {not in Vi}
5680 {not available when compiled without the
5681 |+file_in_path| feature}
5682 Comma separated list of suffixes, which are used when searching for a
5683 file for the "gf", "[I", etc. commands. Example: >
5684 :set suffixesadd=.java
5685<
5686 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5687'swapfile' 'swf' boolean (default on)
5688 local to buffer
5689 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005690 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 swapfile is not wanted for a specific buffer. For example, with
5692 confidential information that even root must not be able to access.
5693 Careful: All text will be in memory:
5694 - Don't use this for big files.
5695 - Recovery will be impossible!
5696 A swapfile will only be present when |'updatecount'| is non-zero and
5697 'swapfile' is set.
5698 When 'swapfile' is reset, the swap file for the current buffer is
5699 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5700 non-zero, a swap file is immediately created.
5701 Also see |swap-file| and |'swapsync'|.
5702
5703 This option is used together with 'bufhidden' and 'buftype' to
5704 specify special kinds of buffers. See |special-buffers|.
5705
5706 *'swapsync'* *'sws'*
5707'swapsync' 'sws' string (default "fsync")
5708 global
5709 {not in Vi}
5710 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005711 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 When this option is empty parts of the swap file may be in memory and
5713 not written to disk. When the system crashes you may lose more work.
5714 On Unix the system does a sync now and then without Vim asking for it,
5715 so the disadvantage of setting this option off is small. On some
5716 systems the swap file will not be written at all. For a unix system
5717 setting it to "sync" will use the sync() call instead of the default
5718 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005719 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720
5721 *'switchbuf'* *'swb'*
5722'switchbuf' 'swb' string (default "")
5723 global
5724 {not in Vi}
5725 This option controls the behavior when switching between buffers.
5726 Possible values (comma separated list):
5727 useopen If included, jump to the first open window that
5728 contains the specified buffer (if there is one).
5729 Otherwise: Do not examine other windows.
5730 This setting is checked with |quickfix| commands, when
5731 jumping to errors (":cc", ":cn", "cp", etc.). It is
5732 also used in all buffer related split commands, for
5733 example ":sbuffer", ":sbnext", or ":sbrewind".
5734 split If included, split the current window before loading
5735 a buffer. Otherwise: do not split, use current window.
5736 Supported in |quickfix| commands that display errors.
5737
5738 *'syntax'* *'syn'*
5739'syntax' 'syn' string (default empty)
5740 local to buffer
5741 {not in Vi}
5742 {not available when compiled without the |+syntax|
5743 feature}
5744 When this option is set, the syntax with this name is loaded, unless
5745 syntax highlighting has been switched off with ":syntax off".
5746 Otherwise this option does not always reflect the current syntax (the
5747 b:current_syntax variable does).
5748 This option is most useful in a modeline, for a file which syntax is
5749 not automatically recognized. Example, for in an IDL file: >
5750 /* vim: set syntax=idl : */
5751< To switch off syntax highlighting for the current file, use: >
5752 :set syntax=OFF
5753< To switch syntax highlighting on according to the current value of the
5754 'filetype' option: >
5755 :set syntax=ON
5756< What actually happens when setting the 'syntax' option is that the
5757 Syntax autocommand event is triggered with the value as argument.
5758 This option is not copied to another buffer, independent of the 's' or
5759 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005760 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761
5762 *'tabstop'* *'ts'*
5763'tabstop' 'ts' number (default 8)
5764 local to buffer
5765 Number of spaces that a <Tab> in the file counts for. Also see
5766 |:retab| command, and 'softtabstop' option.
5767
5768 Note: Setting 'tabstop' to any other value than 8 can make your file
5769 appear wrong in many places (e.g., when printing it).
5770
5771 There are four main ways to use tabs in Vim:
5772 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
5773 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
5774 will use a mix of tabs and spaces, but typing Tab and BS will
5775 behave like a tab appears every 4 (or 3) characters.
5776 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
5777 'expandtab'. This way you will always insert spaces. The
5778 formatting will never be messed up when 'tabstop' is changed.
5779 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005780 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 works when using Vim to edit the file.
5782 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
5783 'noexpandtab'. This should then work (for initial indents only)
5784 for any tabstop setting that people use. It might be nice to have
5785 tabs after the first non-blank inserted as spaces if you do this
5786 though. Otherwise aligned comments will be wrong when 'tabstop' is
5787 changed.
5788
5789 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
5790'tagbsearch' 'tbs' boolean (default on)
5791 global
5792 {not in Vi}
5793 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005794 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00005795 searching makes searching for a tag a LOT faster, but a linear search
5796 will find more tags if the tags file wasn't properly sorted.
5797 Vim normally assumes that your tags files are sorted, or indicate that
5798 they are not sorted. Only when this is not the case does the
5799 'tagbsearch' option need to be switched off.
5800
5801 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005802 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 certain files, or retry all files with a linear search. When
5804 'tagbsearch' is off, only a linear search is done.
5805
5806 Linear searching is done anyway, for one file, when Vim finds a line
5807 at the start of the file indicating that it's not sorted: >
5808 !_TAG_FILE_SORTED 0 /some command/
5809< [The whitespace before and after the '0' must be a single <Tab>]
5810
5811 When a binary search was done and no match was found in any of the
5812 files listed in 'tags', and 'ignorecase' is set or a pattern is used
5813 instead of a normal tag name, a retry is done with a linear search.
5814 Tags in unsorted tags files, and matches with different case will only
5815 be found in the retry.
5816
Bram Moolenaard4755bb2004-09-02 19:12:26 +00005817 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 linear search can be avoided for the 'ignorecase' case. Use a value
5819 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
5820 case-fold sorted with the -f switch to "sort" in most unices, as in
5821 the command: "sort -f -o tags tags". For "Exuberant ctags" version
5822 5.3 or higher the -f or --fold-case-sort switch can be used for this
5823 as well. Note that case must be folded to uppercase for this to work.
5824
5825 When 'tagbsearch' is off, tags searching is slower when a full match
5826 exists, but faster when no full match exists. Tags in unsorted tags
5827 files may only be found with 'tagbsearch' off.
5828 When the tags file is not sorted, or sorted in a wrong way (not on
5829 ASCII byte value), 'tagbsearch' should be off, or the line given above
5830 must be included in the tags file.
5831 This option doesn't affect commands that find all matching tags (e.g.,
5832 command-line completion and ":help").
5833 {Vi: always uses binary search in some versions}
5834
5835 *'taglength'* *'tl'*
5836'taglength' 'tl' number (default 0)
5837 global
5838 If non-zero, tags are significant up to this number of characters.
5839
5840 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
5841'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
5842 global
5843 {not in Vi}
5844 If on and using a tag file in another directory, file names in that
5845 tag file are relative to the directory where the tag file is.
5846 NOTE: This option is set to the Vi default value when 'compatible' is
5847 set and to the Vim default value when 'compatible' is reset.
5848
5849 *'tags'* *'tag'* *E433*
5850'tags' 'tag' string (default "./tags,tags", when compiled with
5851 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
5852 global or local to buffer |global-local|
5853 Filenames for the tag command, separated by spaces or commas. To
5854 include a space or comma in a file name, precede it with a backslash
5855 (see |option-backslash| about including spaces and backslashes).
5856 When a file name starts with "./", the '.' is replaced with the path
5857 of the current file. But only when the 'd' flag is not included in
5858 'cpoptions'. Environment variables are expanded |:set_env|. Also see
5859 |tags-option|.
5860 "*", "**" and other wildcards can be used to search for tags files in
5861 a directory tree. See |file-searching|. {not available when compiled
5862 without the |+path_extra| feature}
5863 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
5864 files are also supported. They are automatically recognized. The
5865 default value becomes "./tags,./TAGS,tags,TAGS", unless case
5866 differences are ignored (MS-Windows). |emacs-tags|
5867 The use of |:set+=| and |:set-=| is preferred when adding or removing
5868 file names from the list. This avoids problems when a future version
5869 uses another default.
5870 {Vi: default is "tags /usr/lib/tags"}
5871
5872 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
5873'tagstack' 'tgst' boolean (default on)
5874 global
5875 {not in all versions of Vi}
5876 When on, the |tagstack| is used normally. When off, a ":tag" or
5877 ":tselect" command with an argument will not push the tag onto the
5878 tagstack. A following ":tag" without an argument, a ":pop" command or
5879 any other command that uses the tagstack will use the unmodified
5880 tagstack, but does change the pointer to the active entry.
5881 Resetting this option is useful when using a ":tag" command in a
5882 mapping which should not change the tagstack.
5883
5884 *'term'* *E529* *E530* *E531*
5885'term' string (default is $TERM, if that fails:
5886 in the GUI: "builtin_gui"
5887 on Amiga: "amiga"
5888 on BeOS: "beos-ansi"
5889 on Mac: "mac-ansi"
5890 on MiNT: "vt52"
5891 on MS-DOS: "pcterm"
5892 on OS/2: "os2ansi"
5893 on Unix: "ansi"
5894 on VMS: "ansi"
5895 on Win 32: "win32")
5896 global
5897 Name of the terminal. Used for choosing the terminal control
5898 characters. Environment variables are expanded |:set_env|.
5899 For example: >
5900 :set term=$TERM
5901< See |termcap|.
5902
5903 *'termbidi'* *'tbidi'*
5904 *'notermbidi'* *'notbidi'*
5905'termbidi' 'tbidi' boolean (default off, on for "mlterm")
5906 global
5907 {not in Vi}
5908 {only available when compiled with the |+arabic|
5909 feature}
5910 The terminal is in charge of Bi-directionality of text (as specified
5911 by Unicode). The terminal is also expected to do the required shaping
5912 that some languages (such as Arabic) require.
5913 Setting this option implies that 'rightleft' will not be set when
5914 'arabic' is set and the value of 'arabicshape' will be ignored.
5915 Note that setting 'termbidi' has the immediate effect that
5916 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
5917 This option is reset when the GUI is started.
5918 For further details see |arabic.txt|.
5919
5920 *'termencoding'* *'tenc'*
5921'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
5922 Macintosh GUI: "macroman")
5923 global
5924 {only available when compiled with the |+multi_byte|
5925 feature}
5926 {not in Vi}
5927 Encoding used for the terminal. This specifies what character
5928 encoding the keyboard produces and the display will understand. For
5929 the GUI it only applies to the keyboard ('encoding' is used for the
5930 display).
5931 In the Win32 console version the default value is the console codepage
5932 when it differs from the ANSI codepage.
5933 *E617*
5934 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
5935 successfully initialized, 'termencoding' is forcibly set to "utf-8".
5936 Any attempts to set a different value will be rejected, and an error
5937 message is shown.
5938 For the Win32 GUI 'termencoding' is not used for typed characters,
5939 because the Win32 system always passes Unicode characters.
5940 When empty, the same encoding is used as for the 'encoding' option.
5941 This is the normal value.
5942 Not all combinations for 'termencoding' and 'encoding' are valid. See
5943 |encoding-table|.
5944 The value for this option must be supported by internal conversions or
5945 iconv(). When this is not possible no conversion will be done and you
5946 will probably experience problems with non-ASCII characters.
5947 Example: You are working with the locale set to euc-jp (Japanese) and
5948 want to edit a UTF-8 file: >
5949 :let &termencoding = &encoding
5950 :set encoding=utf-8
5951< You need to do this when your system has no locale support for UTF-8.
5952
5953 *'terse'* *'noterse'*
5954'terse' boolean (default off)
5955 global
5956 When set: Add 's' flag to 'shortmess' option (this makes the message
5957 for a search that hits the start or end of the file not being
5958 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
5959 shortens a lot of messages}
5960
5961 *'textauto'* *'ta'* *'notextauto'* *'nota'*
5962'textauto' 'ta' boolean (Vim default: on, Vi default: off)
5963 global
5964 {not in Vi}
5965 This option is obsolete. Use 'fileformats'.
5966 For backwards compatibility, when 'textauto' is set, 'fileformats' is
5967 set to the default value for the current system. When 'textauto' is
5968 reset, 'fileformats' is made empty.
5969 NOTE: This option is set to the Vi default value when 'compatible' is
5970 set and to the Vim default value when 'compatible' is reset.
5971
5972 *'textmode'* *'tx'* *'notextmode'* *'notx'*
5973'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
5974 others: default off)
5975 local to buffer
5976 {not in Vi}
5977 This option is obsolete. Use 'fileformat'.
5978 For backwards compatibility, when 'textmode' is set, 'fileformat' is
5979 set to "dos". When 'textmode' is reset, 'fileformat' is set to
5980 "unix".
5981
5982 *'textwidth'* *'tw'*
5983'textwidth' 'tw' number (default 0)
5984 local to buffer
5985 {not in Vi}
5986 Maximum width of text that is being inserted. A longer line will be
5987 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005988 this. 'textwidth' is set to 0 when the 'paste' option is set. When
5989 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00005990 'formatoptions' and |ins-textwidth|.
5991 NOTE: This option is set to 0 when 'compatible' is set.
5992
5993 *'thesaurus'* *'tsr'*
5994'thesaurus' 'tsr' string (default "")
5995 global or local to buffer |global-local|
5996 {not in Vi}
5997 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005998 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 the file should contain words with similar meaning, separated by
6000 non-keyword characters (white space is preferred). Maximum line
6001 length is 510 bytes.
6002 To obtain a file to be used here, check out the wordlist FAQ at
6003 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006004 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005 after a comma are ignored, otherwise spaces are included in the file
6006 name. See |option-backslash| about using backslashes.
6007 The use of |:set+=| and |:set-=| is preferred when adding or removing
6008 directories from the list. This avoids problems when a future version
6009 uses another default.
6010 Backticks cannot be used in this option for security reasons.
6011
6012 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6013'tildeop' 'top' boolean (default off)
6014 global
6015 {not in Vi}
6016 When on: The tilde command "~" behaves like an operator.
6017 NOTE: This option is reset when 'compatible' is set.
6018
6019 *'timeout'* *'to'* *'notimeout'* *'noto'*
6020'timeout' 'to' boolean (default on)
6021 global
6022 *'ttimeout'* *'nottimeout'*
6023'ttimeout' boolean (default off)
6024 global
6025 {not in Vi}
6026 These two options together determine the behavior when part of a
6027 mapped key sequence or keyboard code has been received:
6028
6029 'timeout' 'ttimeout' action ~
6030 off off do not time out
6031 on on or off time out on :mappings and key codes
6032 off on time out on key codes
6033
6034 If both options are off, Vim will wait until either the complete
6035 mapping or key sequence has been received, or it is clear that there
6036 is no mapping or key sequence for the received characters. For
6037 example: if you have mapped "vl" and Vim has received 'v', the next
6038 character is needed to see if the 'v' is followed by an 'l'.
6039 When one of the options is on, Vim will wait for about 1 second for
6040 the next character to arrive. After that the already received
6041 characters are interpreted as single characters. The waiting time can
6042 be changed with the 'timeoutlen' option.
6043 On slow terminals or very busy systems timing out may cause
6044 malfunctioning cursor keys. If both options are off, Vim waits
6045 forever after an entered <Esc> if there are key codes that start
6046 with <Esc>. You will have to type <Esc> twice. If you do not have
6047 problems with key codes, but would like to have :mapped key
6048 sequences not timing out in 1 second, set the 'ttimeout' option and
6049 reset the 'timeout' option.
6050
6051 NOTE: 'ttimeout' is reset when 'compatible' is set.
6052
6053 *'timeoutlen'* *'tm'*
6054'timeoutlen' 'tm' number (default 1000)
6055 global
6056 {not in all versions of Vi}
6057 *'ttimeoutlen'* *'ttm'*
6058'ttimeoutlen' 'ttm' number (default -1)
6059 global
6060 {not in Vi}
6061 The time in milliseconds that is waited for a key code or mapped key
6062 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6063 when part of a command has been typed.
6064 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6065 different timeout value for key codes is desired set 'ttimeoutlen' to
6066 a non-negative number.
6067
6068 ttimeoutlen mapping delay key code delay ~
6069 < 0 'timeoutlen' 'timeoutlen'
6070 >= 0 'timeoutlen' 'ttimeoutlen'
6071
6072 The timeout only happens when the 'timeout' and 'ttimeout' options
6073 tell so. A useful setting would be >
6074 :set timeout timeoutlen=3000 ttimeoutlen=100
6075< (time out on mapping after three seconds, time out on key codes after
6076 a tenth of a second).
6077
6078 *'title'* *'notitle'*
6079'title' boolean (default off, on when title can be restored)
6080 global
6081 {not in Vi}
6082 {not available when compiled without the |+title|
6083 feature}
6084 When on, the title of the window will be set to the value of
6085 'titlestring' (if it is not empty), or to:
6086 filename [+=-] (path) - VIM
6087 Where:
6088 filename the name of the file being edited
6089 - indicates the file cannot be modified, 'ma' off
6090 + indicates the file was modified
6091 = indicates the file is read-only
6092 =+ indicates the file is read-only and modified
6093 (path) is the path of the file being edited
6094 - VIM the server name |v:servername| or "VIM"
6095 Only works if the terminal supports setting window titles
6096 (currently Amiga console, Win32 console, all GUI versions and
6097 terminals with a non- empty 't_ts' option - these are Unix xterm and
6098 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6099 *X11*
6100 When Vim was compiled with HAVE_X11 defined, the original title will
6101 be restored if possible. The output of ":version" will include "+X11"
6102 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6103 works for the icon name |'icon'|.
6104 But: When Vim was started with the |-X| argument, restoring the title
6105 will not work (except in the GUI).
6106 If the title cannot be restored, it is set to the value of 'titleold'.
6107 You might want to restore the title outside of Vim then.
6108 When using an xterm from a remote machine you can use this command:
6109 rsh machine_name xterm -display $DISPLAY &
6110 then the WINDOWID environment variable should be inherited and the
6111 title of the window should change back to what it should be after
6112 exiting Vim.
6113
6114 *'titlelen'*
6115'titlelen' number (default 85)
6116 global
6117 {not in Vi}
6118 {not available when compiled without the |+title|
6119 feature}
6120 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006121 title. When the title is longer, only the end of the path name is
6122 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006123 Using a percentage makes this adapt to the width of the window. But
6124 it won't work perfectly, because the actual number of characters
6125 available also depends on the font used and other things in the title
6126 bar. When 'titlelen' is zero the full path is used. Otherwise,
6127 values from 1 to 30000 percent can be used.
6128 'titlelen' is also used for the 'titlestring' option.
6129
6130 *'titleold'*
6131'titleold' string (default "Thanks for flying Vim")
6132 global
6133 {not in Vi}
6134 {only available when compiled with the |+title|
6135 feature}
6136 This option will be used for the window title when exiting Vim if the
6137 original title cannot be restored. Only happens if 'title' is on or
6138 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006139 This option cannot be set from a |modeline| or in the |sandbox|, for
6140 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 *'titlestring'*
6142'titlestring' string (default "")
6143 global
6144 {not in Vi}
6145 {not available when compiled without the |+title|
6146 feature}
6147 When this option is not empty, it will be used for the title of the
6148 window. This happens only when the 'title' option is on.
6149 Only works if the terminal supports setting window titles (currently
6150 Amiga console, Win32 console, all GUI versions and terminals with a
6151 non-empty 't_ts' option).
6152 When Vim was compiled with HAVE_X11 defined, the original title will
6153 be restored if possible |X11|.
6154 When this option contains printf-style '%' items, they will be
6155 expanded according to the rules used for 'statusline'.
6156 Example: >
6157 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6158 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6159< The value of 'titlelen' is used to align items in the middle or right
6160 of the available space.
6161 Some people prefer to have the file name first: >
6162 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6163< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006164 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 separating space only when needed.
6166 NOTE: Use of special characters in 'titlestring' may cause the display
6167 to be garbled (e.g., when it contains a CR or NL character).
6168 {not available when compiled without the |+statusline| feature}
6169
6170 *'toolbar'* *'tb'*
6171'toolbar' 'tb' string (default "icons,tooltips")
6172 global
6173 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6174 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006175 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 possible values are:
6177 icons Toolbar buttons are shown with icons.
6178 text Toolbar buttons shown with text.
6179 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006180 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 tooltips Tooltips are active for toolbar buttons.
6182 Tooltips refer to the popup help text which appears after the mouse
6183 cursor is placed over a toolbar button for a brief moment.
6184
6185 If you want the toolbar to be shown with icons as well as text, do the
6186 following: >
6187 :set tb=icons,text
6188< Motif and Athena cannot display icons and text at the same time. They
6189 will show icons if both are requested.
6190
6191 If none of the strings specified in 'toolbar' are valid or if
6192 'toolbar' is empty, this option is ignored. If you want to disable
6193 the toolbar, you need to set the 'guioptions' option. For example: >
6194 :set guioptions-=T
6195< Also see |gui-toolbar|.
6196
6197 *'toolbariconsize'* *'tbis'*
6198'toolbariconsize' 'tbis' string (default "small")
6199 global
6200 {not in Vi}
6201 {only in the GTK+ 2 GUI}
6202 Controls the size of toolbar icons. The possible values are:
6203 tiny Use tiny toolbar icons.
6204 small Use small toolbar icons (default).
6205 medium Use medium-sized toolbar icons.
6206 large Use large toolbar icons.
6207 The exact dimensions in pixels of the various icon sizes depend on
6208 the current theme. Common dimensions are large=32x32, medium=24x24,
6209 small=20x20 and tiny=16x16.
6210
6211 If 'toolbariconsize' is empty, the global default size as determined
6212 by user preferences or the current theme is used.
6213
6214 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6215'ttybuiltin' 'tbi' boolean (default on)
6216 global
6217 {not in Vi}
6218 When on, the builtin termcaps are searched before the external ones.
6219 When off the builtin termcaps are searched after the external ones.
6220 When this option is changed, you should set the 'term' option next for
6221 the change to take effect, for example: >
6222 :set notbi term=$TERM
6223< See also |termcap|.
6224 Rationale: The default for this option is "on", because the builtin
6225 termcap entries are generally better (many systems contain faulty
6226 xterm entries...).
6227
6228 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6229'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6230 sun-cmd, screen, rxvt, dtterm or
6231 iris-ansi; also on when running Vim in
6232 a DOS console)
6233 global
6234 {not in Vi}
6235 Indicates a fast terminal connection. More characters will be sent to
6236 the screen for redrawing, instead of using insert/delete line
6237 commands. Improves smoothness of redrawing when there are multiple
6238 windows and the terminal does not support a scrolling region.
6239 Also enables the extra writing of characters at the end of each screen
6240 line for lines that wrap. This helps when using copy/paste with the
6241 mouse in an xterm and other terminals.
6242
6243 *'ttymouse'* *'ttym'*
6244'ttymouse' 'ttym' string (default depends on 'term')
6245 global
6246 {not in Vi}
6247 {only in Unix and VMS, doesn't work in the GUI; not
6248 available when compiled without |+mouse|}
6249 Name of the terminal type for which mouse codes are to be recognized.
6250 Currently these three strings are valid:
6251 *xterm-mouse*
6252 xterm xterm-like mouse handling. The mouse generates
6253 "<Esc>[Mscr", where "scr" is three bytes:
6254 "s" = button state
6255 "c" = column plus 33
6256 "r" = row plus 33
6257 xterm2 Works like "xterm", but with the xterm reporting the
6258 mouse position while the mouse is dragged. This works
6259 much faster and more precise. Your xterm must at
6260 least at patchlevel 88 / XFree 3.3.3 for this to
6261 work. See below for how Vim detects this
6262 automatically.
6263 *netterm-mouse*
6264 netterm NetTerm mouse handling. The mouse generates
6265 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6266 for the row and column.
6267 *dec-mouse*
6268 dec DEC terminal mouse handling. The mouse generates a
6269 rather complex sequence, starting with "<Esc>[".
6270 *jsbterm-mouse*
6271 jsbterm JSB term mouse handling.
6272 *pterm-mouse*
6273 pterm QNX pterm mouse handling.
6274
6275 The mouse handling must be enabled at compile time |+mouse_xterm|
6276 |+mouse_dec| |+mouse_netterm|.
6277 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6278 recognized, if enabled at compile time. DEC terminal mouse codes
6279 are recognized if enabled at compile time, and 'ttymouse' is not
6280 "xterm" (because the xterm and dec mouse codes conflict).
6281 This option is automatically set to "xterm", when the 'term' option is
6282 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6283 or "xterm2" already. The main use of this option is to set it to
6284 "xterm", when the terminal name doesn't start with "xterm", but it can
6285 handle xterm mouse codes.
6286 The "xterm2" value will be set if the xterm version is reported to be
6287 95 of higher. This only works when compiled with the |+termresponse|
6288 feature and if |t_RV| is set to the escape sequence to request the
6289 xterm version number. Otherwise "xterm2" must be set explicitly.
6290 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6291 t_RV to an empty string: >
6292 :set t_RV=
6293<
6294 *'ttyscroll'* *'tsl'*
6295'ttyscroll' 'tsl' number (default 999)
6296 global
6297 Maximum number of lines to scroll the screen. If there are more lines
6298 to scroll the window is redrawn. For terminals where scrolling is
6299 very slow and redrawing is not slow this can be set to a small number,
6300 e.g., 3, to speed up displaying.
6301
6302 *'ttytype'* *'tty'*
6303'ttytype' 'tty' string (default from $TERM)
6304 global
6305 Alias for 'term', see above.
6306
6307 *'undolevels'* *'ul'*
6308'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6309 Win32 and OS/2)
6310 global
6311 {not in Vi}
6312 Maximum number of changes that can be undone. Since undo information
6313 is kept in memory, higher numbers will cause more memory to be used
6314 (nevertheless, a single change can use an unlimited amount of memory).
6315 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6316 itself: >
6317 set ul=0
6318< But you can also get Vi compatibility by including the 'u' flag in
6319 'cpoptions', and still be able to use CTRL-R to repeat undo.
6320 Set to a negative number for no undo at all: >
6321 set ul=-1
6322< This helps when you run out of memory for a single change.
6323 Also see |undo-two-ways|.
6324
6325 *'updatecount'* *'uc'*
6326'updatecount' 'uc' number (default: 200)
6327 global
6328 {not in Vi}
6329 After typing this many characters the swap file will be written to
6330 disk. When zero, no swap file will be created at all (see chapter on
6331 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6332 Vim with the "-n" option, see |startup|. When editing in readonly
6333 mode this option will be initialized to 10000.
6334 The swapfile can be disabled per buffer with |'swapfile'|.
6335 When 'updatecount' is set from zero to non-zero, swap files are
6336 created for all buffers that have 'swapfile' set. When 'updatecount'
6337 is set to zero, existing swap files are not deleted.
6338 Also see |'swapsync'|.
6339 This option has no meaning in buffers where |'buftype'| is "nofile"
6340 or "nowrite".
6341
6342 *'updatetime'* *'ut'*
6343'updatetime' 'ut' number (default 4000)
6344 global
6345 {not in Vi}
6346 If this many milliseconds nothing is typed the swap file will be
6347 written to disk (see |crash-recovery|). Also used for the
6348 |CursorHold| autocommand event.
6349
6350 *'verbose'* *'vbs'*
6351'verbose' 'vbs' number (default 0)
6352 global
6353 {not in Vi, although some versions have a boolean
6354 verbose option}
6355 When bigger than zero, Vim will give messages about what it is doing.
6356 Currently, these messages are given:
6357 >= 1 When the viminfo file is read or written.
6358 >= 2 When a file is ":source"'ed.
6359 >= 5 Every searched tags file.
6360 >= 8 Files for which a group of autocommands is executed.
6361 >= 9 Every executed autocommand.
6362 >= 12 Every executed function.
6363 >= 13 When an exception is thrown, caught, finished, or discarded.
6364 >= 14 Anything pending in a ":finally" clause.
6365 >= 15 Every executed Ex command (truncated at 200 characters).
6366
6367 This option can also be set with the "-V" argument. See |-V|.
6368 This option is also set by the |:verbose| command.
6369
6370 *'viewdir'* *'vdir'*
6371'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6372 "$VIM/vimfiles/view",
6373 for Unix: "~/.vim/view",
6374 for Macintosh: "$VIM:vimfiles:view"
6375 for VMS: "sys$login:vimfiles/view"
6376 for RiscOS: "Choices:vimfiles/view")
6377 global
6378 {not in Vi}
6379 {not available when compiled without the +mksession
6380 feature}
6381 Name of the directory where to store files for |:mkview|.
6382 This option cannot be set from a |modeline| or in the |sandbox|, for
6383 security reasons.
6384
6385 *'viewoptions'* *'vop'*
6386'viewoptions' 'vop' string (default: "folds,options,cursor")
6387 global
6388 {not in Vi}
6389 {not available when compiled without the +mksession
6390 feature}
6391 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006392 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 word save and restore ~
6394 cursor cursor position in file and in window
6395 folds manually created folds, opened/closed folds and local
6396 fold options
6397 options options and mappings local to a window or buffer (not
6398 global values for local options)
6399 slash backslashes in file names replaced with forward
6400 slashes
6401 unix with Unix end-of-line format (single <NL>), even when
6402 on Windows or DOS
6403
6404 "slash" and "unix" are useful on Windows when sharing view files
6405 with Unix. The Unix version of Vim cannot source dos format scripts,
6406 but the Windows version of Vim can source unix format scripts.
6407
6408 *'viminfo'* *'vi'* *E526* *E527* *E528*
6409'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6410 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6411 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6412 for others: '20,<50,s10,h)
6413 global
6414 {not in Vi}
6415 {not available when compiled without the |+viminfo|
6416 feature}
6417 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006418 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006419 separated list of parameters, each consisting of a single character
6420 identifying the particular parameter, followed by a number or string
6421 which specifies the value of that parameter. If a particular
6422 character is left out, then the default value is used for that
6423 parameter. The following is a list of the identifying characters and
6424 the effect of their value.
6425 CHAR VALUE ~
6426 ! When included, save and restore global variables that start
6427 with an uppercase letter, and don't contain a lowercase
6428 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006429 and "_K_L_M" are not. Only String and Number types are
6430 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006431 " Maximum number of lines saved for each register. Old name of
6432 the '<' item, with the disadvantage that you need to put a
6433 backslash before the ", otherwise it will be recognized as the
6434 start of a comment!
6435 % When included, save and restore the buffer list. If Vim is
6436 started with a file name argument, the buffer list is not
6437 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006438 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 without a file name and buffers for help files are not written
6440 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006441 When followed by a number, the number specifies the maximum
6442 number of buffers that are stored. Without a number all
6443 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 ' Maximum number of previously edited files for which the marks
6445 are remembered. This parameter must always be included when
6446 'viminfo' is non-empty.
6447 Including this item also means that the |jumplist| and the
6448 |changelist| are stored in the viminfo file.
6449 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006450 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 patterns are also saved. When not included, the value of
6452 'history' is used.
6453 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006454 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 < Maximum number of lines saved for each register. If zero then
6456 registers are not saved. When not included, all lines are
6457 saved. '"' is the old name for this item.
6458 Also see the 's' item below: limit specified in Kbyte.
6459 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006460 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 c When included, convert the text in the viminfo file from the
6462 'encoding' used when writing the file to the current
6463 'encoding'. See |viminfo-encoding|.
6464 f Whether file marks need to be stored. If zero, file marks ('0
6465 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006466 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 cursor position (when exiting or when doing ":wviminfo").
6468 h Disable the effect of 'hlsearch' when loading the viminfo
6469 file. When not included, it depends on whether ":nohlsearch"
6470 has been used since the last search command.
6471 n Name of the viminfo file. The name must immediately follow
6472 the 'n'. Must be the last one! If the "-i" argument was
6473 given when starting Vim, that file name overrides the one
6474 given here with 'viminfo'. Environment variables are expanded
6475 when opening the file, not when setting the option.
6476 r Removable media. The argument is a string (up to the next
6477 ','). This parameter can be given several times. Each
6478 specifies the start of a path for which no marks will be
6479 stored. This is to avoid removable media. For MS-DOS you
6480 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6481 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6482 ignored. Maximum length of each 'r' argument is 50
6483 characters.
6484 s Maximum size of an item in Kbyte. If zero then registers are
6485 not saved. Currently only applies to registers. The default
6486 "s10" will exclude registers with more than 10 Kbyte of text.
6487 Also see the '<' item above: line count limit.
6488
6489 Example: >
6490 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6491<
6492 '50 Marks will be remembered for the last 50 files you
6493 edited.
6494 <1000 Contents of registers (up to 1000 lines each) will be
6495 remembered.
6496 s100 Registers with more than 100 Kbyte text are skipped.
6497 :0 Command-line history will not be saved.
6498 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6499 no / Since '/' is not specified, the default will be used,
6500 that is, save all of the search history, and also the
6501 previous search and substitute patterns.
6502 no % The buffer list will not be saved nor read back.
6503 no h 'hlsearch' highlighting will be restored.
6504
6505 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6506 load the contents of the file, this is not done automatically.
6507
6508 This option cannot be set from a |modeline| or in the |sandbox|, for
6509 security reasons.
6510
6511 *'virtualedit'* *'ve'*
6512'virtualedit' 've' string (default "")
6513 global
6514 {not in Vi}
6515 {not available when compiled without the
6516 |+virtualedit| feature}
6517 A comma separated list of these words:
6518 block Allow virtual editing in Visual block mode.
6519 insert Allow virtual editing in Insert mode.
6520 all Allow virtual editing in all modes.
6521 Virtual editing means that the cursor can be positioned where there is
6522 no actual character. This can be halfway into a Tab or beyond the end
6523 of the line. Useful for selecting a rectangle in Visual mode and
6524 editing a table.
6525
6526 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6527'visualbell' 'vb' boolean (default off)
6528 global
6529 {not in Vi}
6530 Use visual bell instead of beeping. The terminal code to display the
6531 visual bell is given with 't_vb'. When no beep or flash is wanted,
6532 use ":set vb t_vb=".
6533 Note: When the GUI starts, 't_vb' is reset to its default value. You
6534 might want to set it again in your |gvimrc|.
6535 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6536 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6537 where 40 is the time in msec.
6538 Does not work on the Amiga, you always get a screen flash.
6539 Also see 'errorbells'.
6540
6541 *'warn'* *'nowarn'*
6542'warn' boolean (default on)
6543 global
6544 Give a warning message when a shell command is used while the buffer
6545 has been changed.
6546
6547 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6548'weirdinvert' 'wiv' boolean (default off)
6549 global
6550 {not in Vi}
6551 This option has the same effect as the 't_xs' termcap option.
6552 It is provided for backwards compatibility with version 4.x.
6553 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6554 vice versa. Has no effect when the GUI is running.
6555
6556 *'whichwrap'* *'ww'*
6557'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6558 global
6559 {not in Vi}
6560 Allow specified keys that move the cursor left/right to move to the
6561 previous/next line when the cursor is on the first/last character in
6562 the line. Concatenate characters to allow this for these keys:
6563 char key mode ~
6564 b <BS> Normal and Visual
6565 s <Space> Normal and Visual
6566 h "h" Normal and Visual
6567 l "l" Normal and Visual
6568 < <Left> Normal and Visual
6569 > <Right> Normal and Visual
6570 ~ "~" Normal
6571 [ <Left> Insert and Replace
6572 ] <Right> Insert and Replace
6573 For example: >
6574 :set ww=<,>,[,]
6575< allows wrap only when cursor keys are used.
6576 When the movement keys are used in combination with a delete or change
6577 operator, the <EOL> also counts for a character. This makes "3h"
6578 different from "3dh" when the cursor crosses the end of a line. This
6579 is also true for "x" and "X", because they do the same as "dl" and
6580 "dh". If you use this, you may also want to use the mapping
6581 ":map <BS> X" to make backspace delete the character in front of the
6582 cursor.
6583 When 'l' is included, you get a side effect: "yl" on an empty line
6584 will include the <EOL>, so that "p" will insert a new line.
6585 NOTE: This option is set to the Vi default value when 'compatible' is
6586 set and to the Vim default value when 'compatible' is reset.
6587
6588 *'wildchar'* *'wc'*
6589'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6590 global
6591 {not in Vi}
6592 Character you have to type to start wildcard expansion in the
6593 command-line, as specified with 'wildmode'.
6594 The character is not recognized when used inside a macro. See
6595 'wildcharm' for that.
6596 Although 'wc' is a number option, you can set it to a special key: >
6597 :set wc=<Esc>
6598< NOTE: This option is set to the Vi default value when 'compatible' is
6599 set and to the Vim default value when 'compatible' is reset.
6600
6601 *'wildcharm'* *'wcm'*
6602'wildcharm' 'wcm' number (default: none (0))
6603 global
6604 {not in Vi}
6605 'wildcharm' works exactly like 'wildchar', except that it is
6606 recognized when used inside a macro. You can find "spare" command-line
6607 keys suitable for this option by looking at |ex-edit-index|. Normally
6608 you'll never actually type 'wildcharm', just use it in mappings that
6609 automatically invoke completion mode, e.g.: >
6610 :set wcm=<C-Z>
6611 :cmap ss so $vim/sessions/*.vim<C-Z>
6612< Then after typing :ss you can use CTRL-P & CTRL-N.
6613
6614 *'wildignore'* *'wig'*
6615'wildignore' 'wig' string (default "")
6616 global
6617 {not in Vi}
6618 {not available when compiled without the |+wildignore|
6619 feature}
6620 A list of file patterns. A file that matches with one of these
6621 patterns is ignored when completing file or directory names.
6622 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6623 Also see 'suffixes'.
6624 Example: >
6625 :set wildignore=*.o,*.obj
6626< The use of |:set+=| and |:set-=| is preferred when adding or removing
6627 a pattern from the list. This avoids problems when a future version
6628 uses another default.
6629
6630 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6631'wildmenu' 'wmnu' boolean (default off)
6632 global
6633 {not in Vi}
6634 {not available if compiled without the |+wildmenu|
6635 feature}
6636 When 'wildmenu' is on, command-line completion operates in an enhanced
6637 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6638 the possible matches are shown just above the command line, with the
6639 first match highlighted (overwriting the status line, if there is
6640 one). Keys that show the previous/next match, such as <Tab> or
6641 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6642 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6643 specified. "longest" and "list" do not start "wildmenu" mode.
6644 If there are more matches than can fit in the line, a ">" is shown on
6645 the right and/or a "<" is shown on the left. The status line scrolls
6646 as needed.
6647 The "wildmenu" mode is abandoned when a key is hit that is not used
6648 for selecting a completion.
6649 While the "wildmenu" is active the following keys have special
6650 meanings:
6651
6652 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6653 <Down> - in filename/menu name completion: move into a
6654 subdirectory or submenu.
6655 <CR> - in menu completion, when the cursor is just after a
6656 dot: move into a submenu.
6657 <Up> - in filename/menu name completion: move up into
6658 parent directory or parent menu.
6659
6660 This makes the menus accessible from the console |console-menus|.
6661
6662 If you prefer the <Left> and <Right> keys to move the cursor instead
6663 of selecting a different match, use this: >
6664 :cnoremap <Left> <Space><BS><Left>
6665 :cnoremap <Right> <Space><BS><Right>
6666<
6667 The "WildMenu" highlighting is used for displaying the current match
6668 |hl-WildMenu|.
6669
6670 *'wildmode'* *'wim'*
6671'wildmode' 'wim' string (Vim default: "full")
6672 global
6673 {not in Vi}
6674 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006675 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 part specifies what to do for each consecutive use of 'wildchar. The
6677 first part specifies the behavior for the first use of 'wildchar',
6678 The second part for the second use, etc.
6679 These are the possible values for each part:
6680 "" Complete only the first match.
6681 "full" Complete the next full match. After the last match,
6682 the original string is used and then the first match
6683 again.
6684 "longest" Complete till longest common string. If this doesn't
6685 result in a longer string, use the next part.
6686 "longest:full" Like "longest", but also start 'wildmenu' if it is
6687 enabled.
6688 "list" When more than one match, list all matches.
6689 "list:full" When more than one match, list all matches and
6690 complete first match.
6691 "list:longest" When more than one match, list all matches and
6692 complete till longest common string.
6693 When there is only a single match, it is fully completed in all cases.
6694
6695 Examples: >
6696 :set wildmode=full
6697< Complete first full match, next match, etc. (the default) >
6698 :set wildmode=longest,full
6699< Complete longest common string, then each full match >
6700 :set wildmode=list:full
6701< List all matches and complete each full match >
6702 :set wildmode=list,full
6703< List all matches without completing, then each full match >
6704 :set wildmode=longest,list
6705< Complete longest common string, then list alternatives.
6706
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006707 *'wildoptions'* *'wop'*
6708'wildoptions' 'wop' string (default "")
6709 global
6710 {not in Vi}
6711 {not available when compiled without the |+wildignore|
6712 feature}
6713 A list of words that change how command line completion is done.
6714 Currently only one word is allowed:
6715 tagfile When using CTRL-D to list matching tags, the kind of
6716 tag and the file of the tag is listed. Only one match
6717 is displayed per line. Often used tag kinds are:
6718 d #define
6719 f function
6720 Also see |cmdline-completion|.
6721
Bram Moolenaar071d4272004-06-13 20:20:40 +00006722 *'winaltkeys'* *'wak'*
6723'winaltkeys' 'wak' string (default "menu")
6724 global
6725 {not in Vi}
6726 {only used in Win32, Motif, GTK and Photon GUI}
6727 Some GUI versions allow the access to menu entries by using the ALT
6728 key in combination with a character that appears underlined in the
6729 menu. This conflicts with the use of the ALT key for mappings and
6730 entering special characters. This option tells what to do:
6731 no Don't use ALT keys for menus. ALT key combinations can be
6732 mapped, but there is no automatic handling. This can then be
6733 done with the |:simalt| command.
6734 yes ALT key handling is done by the windowing system. ALT key
6735 combinations cannot be mapped.
6736 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006737 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00006738 keys can be mapped.
6739 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
6740 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006741 This option is not used for <F10>; on Win32 and with GTK <F10> will
6742 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743
6744 *'winheight'* *'wh'* *E591*
6745'winheight' 'wh' number (default 1)
6746 global
6747 {not in Vi}
6748 {not available when compiled without the +windows
6749 feature}
6750 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006751 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 current window is smaller, its size is increased, at the cost of the
6753 height of other windows. Set it to 999 to make the current window
6754 always fill the screen (although this has the drawback that ":all"
6755 will create only two windows). Set it to a small number for normal
6756 editing.
6757 Minimum value is 1.
6758 The height is not adjusted after one of the commands to change the
6759 height of the current window.
6760 'winheight' applies to the current window. Use 'winminheight' to set
6761 the minimal height for other windows.
6762
6763 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
6764'winfixheight' 'wfh' boolean (default off)
6765 local to window
6766 {not in Vi}
6767 {not available when compiled without the +windows
6768 feature}
6769 Keep the window height when windows are opened or closed and
6770 'equalalways' is set. Set by default for the |preview-window| and
6771 |quickfix-window|.
6772 The height may be changed anyway when running out of room.
6773
6774 *'winminheight'* *'wmh'*
6775'winminheight' 'wmh' number (default 1)
6776 global
6777 {not in Vi}
6778 {not available when compiled without the +windows
6779 feature}
6780 The minimal height of a window, when it's not the current window.
6781 This is a hard minimum, windows will never become smaller.
6782 When set to zero, windows may be "squashed" to zero lines (i.e. just a
6783 status bar) if necessary. They will return to at least one line when
6784 they become active (since the cursor has to have somewhere to go.)
6785 Use 'winheight' to set the minimal height of the current window.
6786 This option is only checked when making a window smaller. Don't use a
6787 large number, it will cause errors when opening more than a few
6788 windows. A value of 0 to 3 is reasonable.
6789
6790 *'winminwidth'* *'wmw'*
6791'winminwidth' 'wmw' number (default 1)
6792 global
6793 {not in Vi}
6794 {not available when compiled without the +vertsplit
6795 feature}
6796 The minimal width of a window, when it's not the current window.
6797 This is a hard minimum, windows will never become smaller.
6798 When set to zero, windows may be "squashed" to zero columns (i.e. just
6799 a vertical separator) if necessary. They will return to at least one
6800 line when they become active (since the cursor has to have somewhere
6801 to go.)
6802 Use 'winwidth' to set the minimal width of the current window.
6803 This option is only checked when making a window smaller. Don't use a
6804 large number, it will cause errors when opening more than a few
6805 windows. A value of 0 to 12 is reasonable.
6806
6807 *'winwidth'* *'wiw'* *E592*
6808'winwidth' 'wiw' number (default 20)
6809 global
6810 {not in Vi}
6811 {not available when compiled without the +vertsplit
6812 feature}
6813 Minimal number of columns for the current window. This is not a hard
6814 minimum, Vim will use fewer columns if there is not enough room. If
6815 the current window is smaller, its size is increased, at the cost of
6816 the width of other windows. Set it to 999 to make the current window
6817 always fill the screen. Set it to a small number for normal editing.
6818 The width is not adjusted after one of the commands to change the
6819 width of the current window.
6820 'winwidth' applies to the current window. Use 'winminwidth' to set
6821 the minimal width for other windows.
6822
6823 *'wrap'* *'nowrap'*
6824'wrap' boolean (default on)
6825 local to window
6826 {not in Vi}
6827 This option changes how text is displayed. It doesn't change the text
6828 in the buffer, see 'textwidth' for that.
6829 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006830 displaying continues on the next line. When off lines will not wrap
6831 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 moved to a part that is not shown, the screen will scroll
6833 horizontally.
6834 The line will be broken in the middle of a word if necessary. See
6835 'linebreak' to get the break at a word boundary.
6836 To make scrolling horizontally a bit more useful, try this: >
6837 :set sidescroll=5
6838 :set listchars+=precedes:<,extends:>
6839< See 'sidescroll', 'listchars' and |wrap-off|.
6840
6841 *'wrapmargin'* *'wm'*
6842'wrapmargin' 'wm' number (default 0)
6843 local to buffer
6844 Number of characters from the right window border where wrapping
6845 starts. When typing text beyond this limit, an <EOL> will be inserted
6846 and inserting continues on the next line.
6847 Options that add a margin, such as 'number' and 'foldcolumn', cause
6848 the text width to be further reduced. This is Vi compatible.
6849 When 'textwidth' is non-zero, this option is not used.
6850 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
6851 and less usefully}
6852
6853 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
6854'wrapscan' 'ws' boolean (default on) *E384* *E385*
6855 global
6856 Searches wrap around the end of the file.
6857
6858 *'write'* *'nowrite'*
6859'write' boolean (default on)
6860 global
6861 {not in Vi}
6862 Allows writing files. When not set, writing a file is not allowed.
6863 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006864 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00006865 argument. Filtering text is still possible, even though this requires
6866 writing a temporary file.
6867
6868 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
6869'writeany' 'wa' boolean (default off)
6870 global
6871 Allows writing to any file with no need for "!" override.
6872
6873 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
6874'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
6875 otherwise)
6876 global
6877 {not in Vi}
6878 Make a backup before overwriting a file. The backup is removed after
6879 the file was successfully written, unless the 'backup' option is
6880 also on. Reset this option if your file system is almost full. See
6881 |backup-table| for another explanation.
6882 When the 'backupskip' pattern matches, a backup is not made anyway.
6883 NOTE: This option is set to the default value when 'compatible' is
6884 set.
6885
6886 *'writedelay'* *'wd'*
6887'writedelay' 'wd' number (default 0)
6888 global
6889 {not in Vi}
6890 The number of microseconds to wait for each character sent to the
6891 screen. When non-zero, characters are sent to the terminal one by
6892 one. For MS-DOS pcterm this does not work. For debugging purposes.
6893
6894 vim:tw=78:ts=8:ft=help:norl: