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