blob: b15d7c40f8c773d25391547fb76846d0e76930d2 [file] [log] [blame]
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Jul 30
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}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000603 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604 the keyboard map between Farsi and English, when 'allowrevins' set.
605
Bram Moolenaar582fd852005-03-28 20:58:01 +0000606 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 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:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000623 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 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,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000631 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000633 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 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}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000660 When on, Vim will change the current working directory whenever you
661 open a file, switch buffers, delete a buffer or open/close a window.
662 It will change to the directory containing the file which was opened
663 or selected.
664 This option is provided for backward compatibility with the Vim
665 released with Sun ONE Studio 4 Enterprise Edition.
666 Note: When this option is on some plugins may not work. The directory
667 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668
669 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
670'arabic' 'arab' boolean (default off)
671 local to window
672 {not in Vi}
673 {only available when compiled with the |+arabic|
674 feature}
675 This option can be set to start editing Arabic text.
676 Setting this option will:
677 - Set the 'rightleft' option, unless 'termbidi' is set.
678 - Set the 'arabicshape' option, unless 'termbidi' is set.
679 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
680 between typing English and Arabic key mapping.
681 - Set the 'delcombine' option
682 Note that 'encoding' must be "utf-8" for working with Arabic text.
683
684 Resetting this option will:
685 - Reset the 'rightleft' option.
686 - Disable the use of 'keymap' (without changing its value).
687 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
688 option.
689 Also see |arabic.txt|.
690
691 *'arabicshape'* *'arshape'*
692 *'noarabicshape'* *'noarshape'*
693'arabicshape' 'arshape' boolean (default on)
694 global
695 {not in Vi}
696 {only available when compiled with the |+arabic|
697 feature}
698 When on and 'termbidi' is off, the required visual character
699 corrections that need to take place for displaying the Arabic language
700 take affect. Shaping, in essence, gets enabled; the term is a broad
701 one which encompasses:
702 a) the changing/morphing of characters based on their location
703 within a word (initial, medial, final and stand-alone).
704 b) the enabling of the ability to compose characters
705 c) the enabling of the required combining of some characters
706 When disabled the character display reverts back to each character's
707 true stand-alone form.
708 Arabic is a complex language which requires other settings, for
709 further details see |arabic.txt|.
710
711 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
712'autoindent' 'ai' boolean (default off)
713 local to buffer
714 Copy indent from current line when starting a new line (typing <CR>
715 in Insert mode or when using the "o" or "O" command). If you do not
716 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000717 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
718 another line has the same effect, unless the 'I' flag is included in
719 'cpoptions'.
720 When autoindent is on, formatting (with the "gq" command or when you
721 reach 'textwidth' in Insert mode) uses the indentation of the first
722 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 When 'smartindent' or 'cindent' is on the indent is changed in
724 a different way.
725 The 'autoindent' option is reset when the 'paste' option is set.
726 {small difference from Vi: After the indent is deleted when typing
727 <Esc> or <CR>, the cursor position when moving up or down is after the
728 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
729
730 *'autoread'* *'ar'* *'noautoread'* *'noar'*
731'autoread' 'ar' boolean (default off)
732 global or local to buffer |global-local|
733 {not in Vi}
734 When a file has been detected to have been changed outside of Vim and
735 it has not been changed inside of Vim, automatically read it again.
736 When the file has been deleted this is not done. |timestamp|
737 If this option has a local value, use this command to switch back to
738 using the global value: >
739 :set autoread<
740<
741 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
742'autowrite' 'aw' boolean (default off)
743 global
744 Write the contents of the file, if it has been modified, on each
745 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
746 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
747 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
748 Note that for some commands the 'autowrite' option is not used, see
749 'autowriteall' for that.
750
751 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
752'autowriteall' 'awa' boolean (default off)
753 global
754 {not in Vi}
755 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
756 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
757 Setting this option also implies that Vim behaves like 'autowrite' has
758 been set.
759
760 *'background'* *'bg'*
761'background' 'bg' string (default "dark" or "light")
762 global
763 {not in Vi}
764 When set to "dark", Vim will try to use colors that look good on a
765 dark background. When set to "light", Vim will try to use colors that
766 look good on a light background. Any other value is illegal.
767 Vim tries to set the default value according to the terminal used.
768 This will not always be correct.
769 Setting this option does not change the background color, it tells Vim
770 what the background color looks like. For changing the background
771 color, see |:hi-normal|.
772
773 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000774 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 change.
776 When a color scheme is loaded (the "colors_name" variable is set)
777 setting 'background' will cause the color scheme to be reloaded. If
778 the color scheme adjusts to the value of 'background' this will work.
779 However, if the color scheme sets 'background' itself the effect may
780 be undone. First delete the "colors_name" variable when needed.
781
782 When setting 'background' to the default value with: >
783 :set background&
784< Vim will guess the value. In the GUI this should work correctly,
785 in other cases Vim might not be able to guess the right value.
786
787 When starting the GUI, the default value for 'background' will be
788 "light". When the value is not set in the .gvimrc, and Vim detects
789 that the background is actually quite dark, 'background' is set to
790 "dark". But this happens only AFTER the .gvimrc file has been read
791 (because the window needs to be opened to find the actual background
792 color). To get around this, force the GUI window to be opened by
793 putting a ":gui" command in the .gvimrc file, before where the value
794 of 'background' is used (e.g., before ":syntax on").
795 Normally this option would be set in the .vimrc file. Possibly
796 depending on the terminal name. Example: >
797 :if &term == "pcterm"
798 : set background=dark
799 :endif
800< When this option is set, the default settings for the highlight groups
801 will change. To use other settings, place ":highlight" commands AFTER
802 the setting of the 'background' option.
803 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
804 to select the colors for syntax highlighting. After changing this
805 option, you must load syntax.vim again to see the result. This can be
806 done with ":syntax on".
807
808 *'backspace'* *'bs'*
809'backspace' 'bs' string (default "")
810 global
811 {not in Vi}
812 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
813 mode. This is a list of items, separated by commas. Each item allows
814 a way to backspace over something:
815 value effect ~
816 indent allow backspacing over autoindent
817 eol allow backspacing over line breaks (join lines)
818 start allow backspacing over the start of insert; CTRL-W and CTRL-U
819 stop once at the start of insert.
820
821 When the value is empty, Vi compatible backspacing is used.
822
823 For backwards compatibility with version 5.4 and earlier:
824 value effect ~
825 0 same as ":set backspace=" (Vi compatible)
826 1 same as ":set backspace=indent,eol"
827 2 same as ":set backspace=indent,eol,start"
828
829 See |:fixdel| if your <BS> or <Del> key does not do what you want.
830 NOTE: This option is set to "" when 'compatible' is set.
831
832 *'backup'* *'bk'* *'nobackup'* *'nobk'*
833'backup' 'bk' boolean (default off)
834 global
835 {not in Vi}
836 Make a backup before overwriting a file. Leave it around after the
837 file has been successfully written. If you do not want to keep the
838 backup file, but you do want a backup while the file is being
839 written, reset this option and set the 'writebackup' option (this is
840 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000841 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000842 |backup-table| for more explanations.
843 When the 'backupskip' pattern matches, a backup is not made anyway.
844 When 'patchmode' is set, the backup may be renamed to become the
845 oldest version of a file.
846 NOTE: This option is reset when 'compatible' is set.
847
848 *'backupcopy'* *'bkc'*
849'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
850 global
851 {not in Vi}
852 When writing a file and a backup is made, this option tells how it's
853 done. This is a comma separated list of words.
854
855 The main values are:
856 "yes" make a copy of the file and overwrite the original one
857 "no" rename the file and write a new one
858 "auto" one of the previous, what works best
859
860 Extra values that can be combined with the ones above are:
861 "breaksymlink" always break symlinks when writing
862 "breakhardlink" always break hardlinks when writing
863
864 Making a copy and overwriting the original file:
865 - Takes extra time to copy the file.
866 + When the file has special attributes, is a (hard/symbolic) link or
867 has a resource fork, all this is preserved.
868 - When the file is a link the backup will have the name of the link,
869 not of the real file.
870
871 Renaming the file and writing a new one:
872 + It's fast.
873 - Sometimes not all attributes of the file can be copied to the new
874 file.
875 - When the file is a link the new file will not be a link.
876
877 The "auto" value is the middle way: When Vim sees that renaming file
878 is possible without side effects (the attributes can be passed on and
879 and the file is not a link) that is used. When problems are expected,
880 a copy will be made.
881
882 The "breaksymlink" and "breakhardlink" values can be used in
883 combination with any of "yes", "no" and "auto". When included, they
884 force Vim to always break either symbolic or hard links by doing
885 exactly what the "no" option does, renaming the original file to
886 become the backup and writing a new file in its place. This can be
887 useful for example in source trees where all the files are symbolic or
888 hard links and any changes should stay in the local source tree, not
889 be propagated back to the original source.
890 *crontab*
891 One situation where "no" and "auto" will cause problems: A program
892 that opens a file, invokes Vim to edit that file, and then tests if
893 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000894 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 example.
896
897 When a copy is made, the original file is truncated and then filled
898 with the new text. This means that protection bits, owner and
899 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000900 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 group of the backup is set to the group of the original file. If this
902 fails, the protection bits for the group are made the same as for
903 others.
904
905 When the file is renamed this is the other way around: The backup has
906 the same attributes of the original file, and the newly written file
907 is owned by the current user. When the file was a (hard/symbolic)
908 link, the new file will not! That's why the "auto" value doesn't
909 rename when the file is a link. The owner and group of the newly
910 written file will be set to the same ones as the original file, but
911 the system may refuse to do this. In that case the "auto" value will
912 again not rename the file.
913
914 *'backupdir'* *'bdir'*
915'backupdir' 'bdir' string (default for Amiga: ".,t:",
916 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
917 for Unix: ".,~/tmp,~/")
918 global
919 {not in Vi}
920 List of directories for the backup file, separated with commas.
921 - The backup file will be created in the first directory in the list
922 where this is possible.
923 - Empty means that no backup file will be created ('patchmode' is
924 impossible!). Writing may fail because of this.
925 - A directory "." means to put the backup file in the same directory
926 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000927 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 put the backup file relative to where the edited file is. The
929 leading "." is replaced with the path name of the edited file.
930 ("." inside a directory name has no special meaning).
931 - Spaces after the comma are ignored, other spaces are considered part
932 of the directory name. To have a space at the start of a directory
933 name, precede it with a backslash.
934 - To include a comma in a directory name precede it with a backslash.
935 - A directory name may end in an '/'.
936 - Environment variables are expanded |:set_env|.
937 - Careful with '\' characters, type one before a space, type two to
938 get one in the option (see |option-backslash|), for example: >
939 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
940< - For backwards compatibility with Vim version 3.0 a '>' at the start
941 of the option is removed.
942 See also 'backup' and 'writebackup' options.
943 If you want to hide your backup files on Unix, consider this value: >
944 :set backupdir=./.backup,~/.backup,.,/tmp
945< You must create a ".backup" directory in each directory and in your
946 home directory for this to work properly.
947 The use of |:set+=| and |:set-=| is preferred when adding or removing
948 directories from the list. This avoids problems when a future version
949 uses another default.
950 This option cannot be set from a |modeline| or in the |sandbox|, for
951 security reasons.
952
953 *'backupext'* *'bex'* *E589*
954'backupext' 'bex' string (default "~", for VMS: "_")
955 global
956 {not in Vi}
957 String which is appended to a file name to make the name of the
958 backup file. The default is quite unusual, because this avoids
959 accidentally overwriting existing files with a backup file. You might
960 prefer using ".bak", but make sure that you don't have files with
961 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000962 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000964 If you like to keep a lot of backups, you could use a BufWritePre
965 autocommand to change 'backupext' just before writing the file to
966 include a timestamp. >
967 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
968< Use 'backupdir' to put the backup in a different directory.
969
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 *'backupskip'* *'bsk'*
971'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
972 global
973 {not in Vi}
974 {not available when compiled without the |+wildignore|
975 feature}
976 A list of file patterns. When one of the patterns matches with the
977 name of the file which is written, no backup file is created. Both
978 the specified file name and the full path name of the file are used.
979 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
980 Watch out for special characters, see |option-backslash|.
981 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000982 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983
984 *'balloondelay'* *'bdlay'*
985'balloondelay' 'bdlay' number (default: 600)
986 global
987 {not in Vi}
988 {only available when compiled with the |+balloon_eval|
989 feature}
990 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
991
992 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
993'ballooneval' 'beval' boolean (default off)
994 global
995 {not in Vi}
996 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +0000997 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 Switch on the |balloon-eval| functionality.
999
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001000 *'balloonexpr'* *'bexpr'*
1001'balloonexpr' 'bexpr' string (default "")
1002 global
1003 {not in Vi}
1004 {only available when compiled with the |+balloon_eval|
1005 feature}
1006 Expression to show in evaluation balloon. It is only used when
1007 'ballooneval' is on. These variables can be used:
1008
1009 v:beval_bufnr number of the buffer in which balloon is going to show
1010 v:beval_winnr number of the window
1011 v:beval_lnum line number
1012 v:beval_col column number (byte index)
1013 v:beval_text word under or after the mouse pointer
1014
1015 The evaluation of the expression must not have side effects!
1016 Example: >
1017 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001018 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001019 \', column ' . v:beval_col .
1020 \ ' of file ' . bufname(v:beval_bufnr) .
1021 \ ' on word "' . v:beval_text . '"'
1022 endfunction
1023 set bexpr=MyBalloonExpr()
1024 set ballooneval
1025<
1026 NOTE: The balloon is displayed only if the cursor is on a text
1027 character. If the result of evaluating 'balloonexpr' is not empty,
1028 Vim does not try to send a message to an external debugger (Netbeans
1029 or Sun Workshop).
1030
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001031 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001032 if has("balloon_multiline")
1033<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1035'binary' 'bin' boolean (default off)
1036 local to buffer
1037 {not in Vi}
1038 This option should be set before editing a binary file. You can also
1039 use the |-b| Vim argument. When this option is switched on a few
1040 options will be changed (also when it already was on):
1041 'textwidth' will be set to 0
1042 'wrapmargin' will be set to 0
1043 'modeline' will be off
1044 'expandtab' will be off
1045 Also, 'fileformat' and 'fileformats' options will not be used, the
1046 file is read and written like 'fileformat' was "unix" (a single <NL>
1047 separates lines).
1048 The 'fileencoding' and 'fileencodings' options will not be used, the
1049 file is read without conversion.
1050 NOTE: When you start editing a(nother) file while the 'bin' option is
1051 on, settings from autocommands may change the settings again (e.g.,
1052 'textwidth'), causing trouble when editing. You might want to set
1053 'bin' again when the file has been loaded.
1054 The previous values of these options are remembered and restored when
1055 'bin' is switched from on to off. Each buffer has its own set of
1056 saved option values.
1057 To edit a file with 'binary' set you can use the |++bin| argument.
1058 This avoids you have to do ":set bin", which would have effect for all
1059 files you edit.
1060 When writing a file the <EOL> for the last line is only written if
1061 there was one in the original file (normally Vim appends an <EOL> to
1062 the last line if there is none; this would make the file longer). See
1063 the 'endofline' option.
1064
1065 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1066'bioskey' 'biosk' boolean (default on)
1067 global
1068 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001069 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 better to detect CTRL-C, but only works for the console. When using a
1071 terminal over a serial port reset this option.
1072 Also see |'conskey'|.
1073
1074 *'bomb'* *'nobomb'*
1075'bomb' boolean (default off)
1076 local to buffer
1077 {not in Vi}
1078 {only available when compiled with the |+multi_byte|
1079 feature}
1080 When writing a file and the following conditions are met, a BOM (Byte
1081 Order Mark) is prepended to the file:
1082 - this option is on
1083 - the 'binary' option is off
1084 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1085 endian variants.
1086 Some applications use the BOM to recognize the encoding of the file.
1087 Often used for UCS-2 files on MS-Windows. For other applications it
1088 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1089 appear halfway the resulting file.
1090 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1091 check for the presence of the BOM is done and 'bomb' set accordingly.
1092 Unless 'binary' is set, it is removed from the first line, so that you
1093 don't see it when editing. When you don't change the options, the BOM
1094 will be restored when writing the file.
1095
1096 *'breakat'* *'brk'*
1097'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1098 global
1099 {not in Vi}
1100 {not available when compiled without the |+linebreak|
1101 feature}
1102 This option lets you choose which characters might cause a line
1103 break if 'linebreak' is on.
1104
1105 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001106'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 global
1108 {not in Vi} {only for Motif and Win32 GUI}
1109 Which directory to use for the file browser:
1110 last Use same directory as with last file browser.
1111 buffer Use the directory of the related buffer.
1112 current Use the current directory.
1113 {path} Use the specified directory
1114
1115 *'bufhidden'* *'bh'*
1116'bufhidden' 'bh' string (default: "")
1117 local to buffer
1118 {not in Vi}
1119 {not available when compiled without the |+quickfix|
1120 feature}
1121 This option specifies what happens when a buffer is no longer
1122 displayed in a window:
1123 <empty> follow the global 'hidden' option
1124 hide hide the buffer (don't unload it), also when 'hidden'
1125 is not set
1126 unload unload the buffer, also when 'hidden' is set or using
1127 |:hide|
1128 delete delete the buffer from the buffer list, also when
1129 'hidden' is set or using |:hide|, like using
1130 |:bdelete|
1131 wipe wipe out the buffer from the buffer list, also when
1132 'hidden' is set or using |:hide|, like using
1133 |:bwipeout|
1134
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001135 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1136 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001137 This option is used together with 'buftype' and 'swapfile' to specify
1138 special kinds of buffers. See |special-buffers|.
1139
1140 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1141'buflisted' 'bl' boolean (default: on)
1142 local to buffer
1143 {not in Vi}
1144 When this option is set, the buffer shows up in the buffer list. If
1145 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1146 This option is reset by Vim for buffers that are only used to remember
1147 a file name or marks. Vim sets it when starting to edit a buffer.
1148 But not when moving to a buffer with ":buffer".
1149
1150 *'buftype'* *'bt'* *E382*
1151'buftype' 'bt' string (default: "")
1152 local to buffer
1153 {not in Vi}
1154 {not available when compiled without the |+quickfix|
1155 feature}
1156 The value of this option specifies the type of a buffer:
1157 <empty> normal buffer
1158 nofile buffer which is not related to a file and will not be
1159 written
1160 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001161 acwrite buffer which will always be written with BufWriteCmd
1162 autocommands. {not available when compiled without the
1163 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 quickfix quickfix buffer, contains list of errors |:cwindow|
1165 help help buffer (you are not supposed to set this
1166 manually)
1167
1168 This option is used together with 'bufhidden' and 'swapfile' to
1169 specify special kinds of buffers. See |special-buffers|.
1170
1171 Be careful with changing this option, it can have many side effects!
1172
1173 A "quickfix" buffer is only used for the error list. This value is
1174 set by the |:cwindow| command and you are not supposed to change it.
1175
1176 "nofile" and "nowrite" buffers are similar:
1177 both: The buffer is not to be written to disk, ":w" doesn't
1178 work (":w filename" does work though).
1179 both: The buffer is never considered to be |'modified'|.
1180 There is no warning when the changes will be lost, for
1181 example when you quit Vim.
1182 both: A swap file is only created when using too much memory
1183 (when 'swapfile' has been reset there is never a swap
1184 file).
1185 nofile only: The buffer name is fixed, it is not handled like a
1186 file name. It is not modified in response to a |:cd|
1187 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001188 *E676*
1189 "acwrite" implies that the buffer name is not related to a file, like
1190 "nofile", but it will be written. Thus, in contrast to "nofile" and
1191 "nowrite", ":w" does work and a modified buffer can't be abandoned
1192 without saving. For writing there must be matching |BufWriteCmd|,
1193 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001194
1195 *'casemap'* *'cmp'*
1196'casemap' 'cmp' string (default: "internal,keepascii")
1197 global
1198 {not in Vi}
1199 Specifies details about changing the case of letters. It may contain
1200 these words, separated by a comma:
1201 internal Use internal case mapping functions, the current
1202 locale does not change the case mapping. This only
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001203 matters when 'encoding' is a Unicode encoding. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 "internal" is omitted, the towupper() and towlower()
1205 system library functions are used when available.
1206 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1207 case mapping, the current locale is not effective.
1208 This probably only matters for Turkish.
1209
1210 *'cdpath'* *'cd'* *E344* *E346*
1211'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1212 global
1213 {not in Vi}
1214 {not available when compiled without the
1215 |+file_in_path| feature}
1216 This is a list of directories which will be searched when using the
1217 |:cd| and |:lcd| commands, provided that the directory being searched
1218 for has a relative path (not starting with "/", "./" or "../").
1219 The 'cdpath' option's value has the same form and semantics as
1220 |'path'|. Also see |file-searching|.
1221 The default value is taken from $CDPATH, with a "," prepended to look
1222 in the current directory first.
1223 If the default value taken from $CDPATH is not what you want, include
1224 a modified version of the following command in your vimrc file to
1225 override it: >
1226 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1227< This option cannot be set from a |modeline| or in the |sandbox|, for
1228 security reasons.
1229 (parts of 'cdpath' can be passed to the shell to expand file names).
1230
1231 *'cedit'*
1232'cedit' string (Vi default: "", Vim default: CTRL-F)
1233 global
1234 {not in Vi}
1235 {not available when compiled without the |+vertsplit|
1236 feature}
1237 The key used in Command-line Mode to open the command-line window.
1238 The default is CTRL-F when 'compatible' is off.
1239 Only non-printable keys are allowed.
1240 The key can be specified as a single character, but it is difficult to
1241 type. The preferred way is to use the <> notation. Examples: >
1242 :set cedit=<C-Y>
1243 :set cedit=<Esc>
1244< |Nvi| also has this option, but it only uses the first character.
1245 See |cmdwin|.
1246
1247 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1248'charconvert' 'ccv' string (default "")
1249 global
1250 {only available when compiled with the |+multi_byte|
1251 feature and the |+eval| feature}
1252 {not in Vi}
1253 An expression that is used for character encoding conversion. It is
1254 evaluated when a file that is to be read or has been written has a
1255 different encoding from what is desired.
1256 'charconvert' is not used when the internal iconv() function is
1257 supported and is able to do the conversion. Using iconv() is
1258 preferred, because it is much faster.
1259 'charconvert' is not used when reading stdin |--|, because there is no
1260 file to convert from. You will have to save the text in a file first.
1261 The expression must return zero or an empty string for success,
1262 non-zero for failure.
1263 The possible encoding names encountered are in 'encoding'.
1264 Additionally, names given in 'fileencodings' and 'fileencoding' are
1265 used.
1266 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1267 is done internally by Vim, 'charconvert' is not used for this.
1268 'charconvert' is also used to convert the viminfo file, if the 'c'
1269 flag is present in 'viminfo'. Also used for Unicode conversion.
1270 Example: >
1271 set charconvert=CharConvert()
1272 fun CharConvert()
1273 system("recode "
1274 \ . v:charconvert_from . ".." . v:charconvert_to
1275 \ . " <" . v:fname_in . " >" v:fname_out)
1276 return v:shell_error
1277 endfun
1278< The related Vim variables are:
1279 v:charconvert_from name of the current encoding
1280 v:charconvert_to name of the desired encoding
1281 v:fname_in name of the input file
1282 v:fname_out name of the output file
1283 Note that v:fname_in and v:fname_out will never be the same.
1284 Note that v:charconvert_from and v:charconvert_to may be different
1285 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1286 Encryption is not done by Vim when using 'charconvert'. If you want
1287 to encrypt the file after conversion, 'charconvert' should take care
1288 of this.
1289 This option cannot be set from a |modeline| or in the |sandbox|, for
1290 security reasons.
1291
1292 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1293'cindent' 'cin' boolean (default off)
1294 local to buffer
1295 {not in Vi}
1296 {not available when compiled without the |+cindent|
1297 feature}
1298 Enables automatic C program indenting See 'cinkeys' to set the keys
1299 that trigger reindenting in insert mode and 'cinoptions' to set your
1300 preferred indent style.
1301 If 'indentexpr' is not empty, it overrules 'cindent'.
1302 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1303 the "=" operator indents using this algorithm rather than calling an
1304 external program.
1305 See |C-indenting|.
1306 When you don't like the way 'cindent' works, try the 'smartindent'
1307 option or 'indentexpr'.
1308 This option is not used when 'paste' is set.
1309 NOTE: This option is reset when 'compatible' is set.
1310
1311 *'cinkeys'* *'cink'*
1312'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1313 local to buffer
1314 {not in Vi}
1315 {not available when compiled without the |+cindent|
1316 feature}
1317 A list of keys that, when typed in Insert mode, cause reindenting of
1318 the current line. Only used if 'cindent' is on and 'indentexpr' is
1319 empty.
1320 For the format of this option see |cinkeys-format|.
1321 See |C-indenting|.
1322
1323 *'cinoptions'* *'cino'*
1324'cinoptions' 'cino' string (default "")
1325 local to buffer
1326 {not in Vi}
1327 {not available when compiled without the |+cindent|
1328 feature}
1329 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1330 program. See |cinoptions-values| for the values of this option, and
1331 |C-indenting| for info on C indenting in general.
1332
1333
1334 *'cinwords'* *'cinw'*
1335'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1336 local to buffer
1337 {not in Vi}
1338 {not available when compiled without both the
1339 |+cindent| and the |+smartindent| features}
1340 These keywords start an extra indent in the next line when
1341 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1342 an appropriate place (inside {}).
1343 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1344 matter, include the keyword both the uppercase and lowercase:
1345 "if,If,IF".
1346
1347 *'clipboard'* *'cb'*
1348'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1349 for X-windows, "" otherwise)
1350 global
1351 {not in Vi}
1352 {only in GUI versions or when the |+xterm_clipboard|
1353 feature is included}
1354 This option is a list of comma separated names.
1355 These names are recognized:
1356
1357 unnamed When included, Vim will use the clipboard register '*'
1358 for all yank, delete, change and put operations which
1359 would normally go to the unnamed register. When a
1360 register is explicitly specified, it will always be
1361 used regardless of whether "unnamed" is in 'clipboard'
1362 or not. The clipboard register can always be
1363 explicitly accessed using the "* notation. Also see
1364 |gui-clipboard|.
1365
1366 autoselect Works like the 'a' flag in 'guioptions': If present,
1367 then whenever Visual mode is started, or the Visual
1368 area extended, Vim tries to become the owner of the
1369 windowing system's global selection or put the
1370 selected text on the clipboard used by the selection
1371 register "*. See |guioptions_a| and |quotestar| for
1372 details. When the GUI is active, the 'a' flag in
1373 'guioptions' is used, when the GUI is not active, this
1374 "autoselect" flag is used.
1375 Also applies to the modeless selection.
1376
1377 autoselectml Like "autoselect", but for the modeless selection
1378 only. Compare to the 'A' flag in 'guioptions'.
1379
1380 exclude:{pattern}
1381 Defines a pattern that is matched against the name of
1382 the terminal 'term'. If there is a match, no
1383 connection will be made to the X server. This is
1384 useful in this situation:
1385 - Running Vim in a console.
1386 - $DISPLAY is set to start applications on another
1387 display.
1388 - You do not want to connect to the X server in the
1389 console, but do want this in a terminal emulator.
1390 To never connect to the X server use: >
1391 exclude:.*
1392< This has the same effect as using the |-X| argument.
1393 Note that when there is no connection to the X server
1394 the window title won't be restored and the clipboard
1395 cannot be accessed.
1396 The value of 'magic' is ignored, {pattern} is
1397 interpreted as if 'magic' was on.
1398 The rest of the option value will be used for
1399 {pattern}, this must be the last entry.
1400
1401 *'cmdheight'* *'ch'*
1402'cmdheight' 'ch' number (default 1)
1403 global
1404 {not in Vi}
1405 Number of screen lines to use for the command-line. Helps avoiding
1406 |hit-enter| prompts.
1407
1408 *'cmdwinheight'* *'cwh'*
1409'cmdwinheight' 'cwh' number (default 7)
1410 global
1411 {not in Vi}
1412 {not available when compiled without the |+vertsplit|
1413 feature}
1414 Number of screen lines to use for the command-line window. |cmdwin|
1415
1416 *'columns'* *'co'* *E594*
1417'columns' 'co' number (default 80 or terminal width)
1418 global
1419 {not in Vi}
1420 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001421 initialization and does not have to be set by hand. Also see
1422 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 When Vim is running in the GUI or in a resizable window, setting this
1424 option will cause the window size to be changed. When you only want
1425 to use the size for the GUI, put the command in your |gvimrc| file.
1426 When you set this option and Vim is unable to change the physical
1427 number of columns of the display, the display may be messed up.
1428
1429 *'comments'* *'com'* *E524* *E525*
1430'comments' 'com' string (default
1431 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1432 local to buffer
1433 {not in Vi}
1434 {not available when compiled without the |+comments|
1435 feature}
1436 A comma separated list of strings that can start a comment line. See
1437 |format-comments|. See |option-backslash| about using backslashes to
1438 insert a space.
1439
1440 *'commentstring'* *'cms'* *E537*
1441'commentstring' 'cms' string (default "/*%s*/")
1442 local to buffer
1443 {not in Vi}
1444 {not available when compiled without the |+folding|
1445 feature}
1446 A template for a comment. The "%s" in the value is replaced with the
1447 comment text. Currently only used to add markers for folding, see
1448 |fold-marker|.
1449
1450 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001451'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1452 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 global
1454 {not in Vi}
1455 This option has the effect of making Vim either more Vi-compatible, or
1456 make Vim behave in a more useful way.
1457 This is a special kind of option, because when it's set or reset,
1458 other options are also changed as a side effect. CAREFUL: Setting or
1459 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001460 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 set this option in your vimrc file, you should probably put it at the
1462 very start.
1463 By default this option is on and the Vi defaults are used for the
1464 options. This default was chosen for those people who want to use Vim
1465 just like Vi, and don't even (want to) know about the 'compatible'
1466 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001467 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1468 this option is switched off, and all options that have not been
1469 modified will be set to the Vim defaults. Effectively, this means
1470 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1471 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1472 happen for the system-wide vimrc or gvimrc file). Also see
1473 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 You can also set this option with the "-C" argument, and reset it with
1475 "-N". See |-C| and |-N|.
1476 Switching this option off makes the Vim defaults be used for options
1477 that have a different Vi and Vim default value. See the options
1478 marked with a '+' below. Other options are not modified.
1479 At the moment this option is set, several other options will be set
1480 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001481 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001482 editing.
1483 See also 'cpoptions'.
1484
1485 option + set value effect ~
1486
1487 'allowrevins' off no CTRL-_ command
1488 'backupcopy' Unix: "yes" backup file is a copy
1489 others: "auto" copy or rename backup file
1490 'backspace' "" normal backspace
1491 'backup' off no backup file
1492 'cindent' off no C code indentation
1493 'cedit' + "" no key to open the |cmdwin|
1494 'cpoptions' + (all flags) Vi-compatible flags
1495 'cscopetag' off don't use cscope for ":tag"
1496 'cscopetagorder' 0 see |cscopetagorder|
1497 'cscopeverbose' off see |cscopeverbose|
1498 'digraph' off no digraphs
1499 'esckeys' + off no <Esc>-keys in Insert mode
1500 'expandtab' off tabs not expanded to spaces
1501 'fileformats' + "" no automatic file format detection,
1502 "dos,unix" except for DOS, Windows and OS/2
1503 'formatoptions' + "vt" Vi compatible formatting
1504 'gdefault' off no default 'g' flag for ":s"
1505 'history' + 0 no commandline history
1506 'hkmap' off no Hebrew keyboard mapping
1507 'hkmapp' off no phonetic Hebrew keyboard mapping
1508 'hlsearch' off no highlighting of search matches
1509 'incsearch' off no incremental searching
1510 'indentexpr' "" no indenting by expression
1511 'insertmode' off do not start in Insert mode
1512 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1513 characters and '_'
1514 'joinspaces' on insert 2 spaces after period
1515 'modeline' + off no modelines
1516 'more' + off no pauses in listings
1517 'revins' off no reverse insert
1518 'ruler' off no ruler
1519 'scrolljump' 1 no jump scroll
1520 'scrolloff' 0 no scroll offset
1521 'shiftround' off indent not rounded to shiftwidth
1522 'shortmess' + "" no shortening of messages
1523 'showcmd' + off command characters not shown
1524 'showmode' + off current mode not shown
1525 'smartcase' off no automatic ignore case switch
1526 'smartindent' off no smart indentation
1527 'smarttab' off no smart tab size
1528 'softtabstop' 0 tabs are always 'tabstop' positions
1529 'startofline' on goto startofline with some commands
1530 'tagrelative' + off tag file names are not relative
1531 'textauto' + off no automatic textmode detection
1532 'textwidth' 0 no automatic line wrap
1533 'tildeop' off tilde is not an operator
1534 'ttimeout' off no terminal timeout
1535 'whichwrap' + "" left-right movements don't wrap
1536 'wildchar' + CTRL-E only when the current value is <Tab>
1537 use CTRL-E for cmdline completion
1538 'writebackup' on or off depends on +writebackup feature
1539
1540 *'complete'* *'cpt'* *E535*
1541'complete' 'cpt' string (default: ".,w,b,u,t,i")
1542 local to buffer
1543 {not in Vi}
1544 This option specifies how keyword completion |ins-completion| works
1545 when CTRL-P or CTRL-N are used. It is also used for whole-line
1546 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1547 and the places to scan. It is a comma separated list of flags:
1548 . scan the current buffer ('wrapscan' is ignored)
1549 w scan buffers from other windows
1550 b scan other loaded buffers that are in the buffer list
1551 u scan the unloaded buffers that are in the buffer list
1552 U scan the buffers that are not in the buffer list
1553 k scan the files given with the 'dictionary' option
1554 k{dict} scan the file {dict}. Several "k" flags can be given,
1555 patterns are valid too. For example: >
1556 :set cpt=k/usr/dict/*,k~/spanish
1557< s scan the files given with the 'thesaurus' option
1558 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1559 are valid too.
1560 i scan current and included files
1561 d scan current and included files for defined name or macro
1562 |i_CTRL-X_CTRL-D|
1563 ] tag completion
1564 t same as "]"
1565
1566 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1567 not executed, this may lead to unexpected completions from some files
1568 (gzipped files for example). Unloaded buffers are not scanned for
1569 whole-line completion.
1570
1571 The default is ".,w,b,u,t,i", which means to scan:
1572 1. the current buffer
1573 2. buffers in other windows
1574 3. other loaded buffers
1575 4. unloaded buffers
1576 5. tags
1577 6. included files
1578
1579 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001580 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1581 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001583 *'completefunc'* *'cfu'*
1584'completefunc' 'cfu' string (default: empty)
1585 local to buffer
1586 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001587 {not available when compiled without the +eval
1588 or +insert_expand feature}
1589 This option specifies a function to be used for CTRL-X CTRL-U
1590 completion. |i_CTRL-X_CTRL-U|
1591
1592 The function will be invoked with three arguments:
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001593 a:findstart either 1 or 0
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001594 a:col column in the cursor line where the completion ends,
1595 first column is zero
1596 a:base the text with which matches should match
1597
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001598 When the a:findstart argument is 1, the function must return the
1599 column of where the completion starts. It must be a number between
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001600 zero and "a:col". This involves looking at the characters in the
1601 cursor line before column a:col and include those characters that
1602 could be part of the completed item. The text between this column and
1603 a:col will be replaced with the matches. Return -1 if no completion
1604 can be done.
1605
1606 When the a:findstart argument is 0 the function must return a List
1607 with the matching words. These matches should include the "a:base"
1608 text. When there are no matches return an empty List.
1609
1610 The function must not move the cursor!
1611
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001612 An example that completes the names of the months: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001613 fun! CompleteMonths(findstart, col, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001614 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001615 " locate the start of the word
1616 let line = getline('.')
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001617 let start = a:col
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001618 while start > 0 && line[start - 1] =~ '\a'
1619 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001620 endwhile
1621 return start
1622 else
1623 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001624 let res = []
1625 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1626 if m =~ '^' . a:base
1627 call add(res, m)
1628 endif
1629 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001630 return res
1631 endif
1632 endfun
1633 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001634<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001635
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1637'confirm' 'cf' boolean (default off)
1638 global
1639 {not in Vi}
1640 When 'confirm' is on, certain operations that would normally
1641 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1642 instead raise a |dialog| asking if you wish to save the current
1643 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1644 If 'confirm' is off you can still activate confirmation for one
1645 command only (this is most useful in mappings) with the |:confirm|
1646 command.
1647 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1648
1649 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1650'conskey' 'consk' boolean (default off)
1651 global
1652 {not in Vi} {only for MS-DOS}
1653 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001654 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 three methods of console input are available:
1656 'conskey' 'bioskey' action ~
1657 on on or off direct console input
1658 off on BIOS
1659 off off STDIN
1660
1661 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1662'copyindent' 'ci' boolean (default off)
1663 local to buffer
1664 {not in Vi}
1665 Copy the structure of the existing lines indent when autoindenting a
1666 new line. Normally the new indent is reconstructed by a series of
1667 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1668 in which case only spaces are used). Enabling this option makes the
1669 new line copy whatever characters were used for indenting on the
1670 existing line. If the new indent is greater than on the existing
1671 line, the remaining space is filled in the normal manner.
1672 NOTE: 'copyindent' is reset when 'compatible' is set.
1673 Also see 'preserveindent'.
1674
1675 *'cpoptions'* *'cpo'*
1676'cpoptions' 'cpo' string (Vim default: "aABceFs",
1677 Vi default: all flags)
1678 global
1679 {not in Vi}
1680 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001681 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001682 not being vi-compatible is mostly or sometimes preferred.
1683 'cpoptions' stands for "compatible-options".
1684 Commas can be added for readability.
1685 To avoid problems with flags that are added in the future, use the
1686 "+=" and "-=" feature of ":set" |add-option-flags|.
1687 NOTE: This option is set to the Vi default value when 'compatible' is
1688 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001689 NOTE: This option is set to the POSIX default value at startup when
1690 the Vi default value would be used and the $VIM_POSIX environment
1691 variable exists |posix|. This means tries to behave like the POSIX
1692 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693
1694 contains behavior ~
1695 *cpo-a*
1696 a When included, a ":read" command with a file name
1697 argument will set the alternate file name for the
1698 current window.
1699 *cpo-A*
1700 A When included, a ":write" command with a file name
1701 argument will set the alternate file name for the
1702 current window.
1703 *cpo-b*
1704 b "\|" in a ":map" command is recognized as the end of
1705 the map command. The '\' is included in the mapping,
1706 the text after the '|' is interpreted as the next
1707 command. Use a CTRL-V instead of a backslash to
1708 include the '|' in the mapping. Applies to all
1709 mapping, abbreviation, menu and autocmd commands.
1710 See also |map_bar|.
1711 *cpo-B*
1712 B A backslash has no special meaning in mappings,
1713 abbreviations and the "to" part of the menu commands.
1714 Remove this flag to be able to use a backslash like a
1715 CTRL-V. For example, the command ":map X \<Esc>"
1716 results in X being mapped to:
1717 'B' included: "\^[" (^[ is a real <Esc>)
1718 'B' excluded: "<Esc>" (5 characters)
1719 ('<' excluded in both cases)
1720 *cpo-c*
1721 c Searching continues at the end of any match at the
1722 cursor position, but not further than the start of the
1723 next line. When not present searching continues
1724 one character from the cursor position. With 'c'
1725 "abababababab" only gets three matches when repeating
1726 "/abab", without 'c' there are five matches.
1727 *cpo-C*
1728 C Do not concatenate sourced lines that start with a
1729 backslash. See |line-continuation|.
1730 *cpo-d*
1731 d Using "./" in the 'tags' option doesn't mean to use
1732 the tags file relative to the current file, but the
1733 tags file in the current directory.
1734 *cpo-D*
1735 D Can't use CTRL-K to enter a digraph after Normal mode
1736 commands with a character argument, like |r|, |f| and
1737 |t|.
1738 *cpo-e*
1739 e When executing a register with ":@r", always add a
1740 <CR> to the last line, also when the register is not
1741 linewise. If this flag is not present, the register
1742 is not linewise and the last line does not end in a
1743 <CR>, then the last line is put on the command-line
1744 and can be edited before hitting <CR>.
1745 *cpo-E*
1746 E It is an error when using "y", "d", "c", "g~", "gu" or
1747 "gU" on an Empty region. The operators only work when
1748 at least one character is to be operate on. Example:
1749 This makes "y0" fail in the first column.
1750 *cpo-f*
1751 f When included, a ":read" command with a file name
1752 argument will set the file name for the current buffer,
1753 if the current buffer doesn't have a file name yet.
1754 *cpo-F*
1755 F When included, a ":write" command with a file name
1756 argument will set the file name for the current
1757 buffer, if the current buffer doesn't have a file name
1758 yet.
1759 *cpo-g*
1760 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001761 *cpo-H*
1762 H When using "I" on a line with only blanks, insert
1763 before the last blank. Without this flag insert after
1764 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001765 *cpo-i*
1766 i When included, interrupting the reading of a file will
1767 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001768 *cpo-I*
1769 I When moving the cursor up or down just after inserting
1770 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001771 *cpo-j*
1772 j When joining lines, only add two spaces after a '.',
1773 not after '!' or '?'. Also see 'joinspaces'.
1774 *cpo-J*
1775 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001776 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777 white space.
1778 *cpo-k*
1779 k Disable the recognition of raw key codes in
1780 mappings, abbreviations, and the "to" part of menu
1781 commands. For example, if <Key> sends ^[OA (where ^[
1782 is <Esc>), the command ":map X ^[OA" results in X
1783 being mapped to:
1784 'k' included: "^[OA" (3 characters)
1785 'k' excluded: "<Key>" (one key code)
1786 Also see the '<' flag below.
1787 *cpo-K*
1788 K Don't wait for a key code to complete when it is
1789 halfway a mapping. This breaks mapping <F1><F1> when
1790 only part of the second <F1> has been read. It
1791 enables cancelling the mapping by typing <F1><Esc>.
1792 *cpo-l*
1793 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001794 literally, only "\]", "\^", "\-" and "\\" are special.
1795 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1797 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001798 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 *cpo-L*
1800 L When the 'list' option is set, 'wrapmargin',
1801 'textwidth', 'softtabstop' and Virtual Replace mode
1802 (see |gR|) count a <Tab> as two characters, instead of
1803 the normal behavior of a <Tab>.
1804 *cpo-m*
1805 m When included, a showmatch will always wait half a
1806 second. When not included, a showmatch will wait half
1807 a second or until a character is typed. |'showmatch'|
1808 *cpo-M*
1809 M When excluded, "%" matching will take backslashes into
1810 account. Thus in "( \( )" and "\( ( \)" the outer
1811 parenthesis match. When included "%" ignores
1812 backslashes, which is Vi compatible.
1813 *cpo-n*
1814 n When included, the column used for 'number' will also
1815 be used for text of wrapped lines.
1816 *cpo-o*
1817 o Line offset to search command is not remembered for
1818 next search.
1819 *cpo-O*
1820 O Don't complain if a file is being overwritten, even
1821 when it didn't exist when editing it. This is a
1822 protection against a file unexpectedly created by
1823 someone else. Vi didn't complain about this.
1824 *cpo-p*
1825 p Vi compatible Lisp indenting. When not present, a
1826 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001827 *cpo-q*
1828 q When joining multiple lines leave the cursor at the
1829 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 *cpo-r*
1831 r Redo ("." command) uses "/" to repeat a search
1832 command, instead of the actually used search string.
1833 *cpo-R*
1834 R Remove marks from filtered lines. Without this flag
1835 marks are kept like |:keepmarks| was used.
1836 *cpo-s*
1837 s Set buffer options when entering the buffer for the
1838 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001839 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 set when the buffer is created.
1841 *cpo-S*
1842 S Set buffer options always when entering a buffer
1843 (except 'readonly', 'fileformat', 'filetype' and
1844 'syntax'). This is the (most) Vi compatible setting.
1845 The options are set to the values in the current
1846 buffer. When you change an option and go to another
1847 buffer, the value is copied. Effectively makes the
1848 buffer options global to all buffers.
1849
1850 's' 'S' copy buffer options
1851 no no when buffer created
1852 yes no when buffer first entered (default)
1853 X yes each time when buffer entered (vi comp.)
1854 *cpo-t*
1855 t Search pattern for the tag command is remembered for
1856 "n" command. Otherwise Vim only puts the pattern in
1857 the history for search pattern, but doesn't change the
1858 last used search pattern.
1859 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001860 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 *cpo-v*
1862 v Backspaced characters remain visible on the screen in
1863 Insert mode. Without this flag the characters are
1864 erased from the screen right away. With this flag the
1865 screen newly typed text overwrites backspaced
1866 characters.
1867 *cpo-w*
1868 w When using "cw" on a blank character, only change one
1869 character and not all blanks until the start of the
1870 next word.
1871 *cpo-W*
1872 W Don't overwrite a readonly file. When omitted, ":w!"
1873 overwrites a readonly file, if possible.
1874 *cpo-x*
1875 x <Esc> on the command-line executes the command-line.
1876 The default in Vim is to abandon the command-line,
1877 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001878 *cpo-X*
1879 X When using a count with "R" the replaced text is
1880 deleted only once. Also when repeating "R" with "."
1881 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001882 *cpo-y*
1883 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001884 *cpo-Z*
1885 Z When using "w!" while the 'readonly' option is set,
1886 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887 *cpo-!*
1888 ! When redoing a filter command, use the last used
1889 external command, whatever it was. Otherwise the last
1890 used -filter- command is used.
1891 *cpo-$*
1892 $ When making a change to one line, don't redisplay the
1893 line, but put a '$' at the end of the changed text.
1894 The changed text will be overwritten when you type the
1895 new text. The line is redisplayed if you type any
1896 command that moves the cursor from the insertion
1897 point.
1898 *cpo-%*
1899 % Vi-compatible matching is done for the "%" command.
1900 Does not recognize "#if", "#endif", etc.
1901 Does not recognize "/*" and "*/".
1902 Parens inside single and double quotes are also
1903 counted, causing a string that contains a paren to
1904 disturb the matching. For example, in a line like
1905 "if (strcmp("foo(", s))" the first paren does not
1906 match the last one. When this flag is not included,
1907 parens inside single and double quotes are treated
1908 specially. When matching a paren outside of quotes,
1909 everything inside quotes is ignored. When matching a
1910 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001911 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001912 This flag is also used for other features, such as
1913 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001914 *cpo--*
1915 - When included, a vertical movement command fails when
1916 it would above the first line or below the last line.
1917 Without it the cursor moves to the first or last line,
1918 unless it already was in that line.
1919 Applies to the commands "-", "k", CTRL-P, "+", "j",
1920 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001921 *cpo-+*
1922 + When included, a ":write file" command will reset the
1923 'modified' flag of the buffer, even though the buffer
1924 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001925 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 * Use ":*" in the same way as ":@". When not included,
1927 ":*" is an alias for ":'<,'>", select the Visual area.
1928 *cpo-<*
1929 < Disable the recognition of special key codes in |<>|
1930 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001931 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 ":map X <Tab>" results in X being mapped to:
1933 '<' included: "<Tab>" (5 characters)
1934 '<' excluded: "^I" (^I is a real <Tab>)
1935 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001936 *cpo->*
1937 > When appending to a register, put a line break before
1938 the appended text.
1939
1940 POSIX flags. These are not included in the Vi default value, except
1941 when $VIM_POSIX was set on startup. |posix|
1942
1943 contains behavior ~
1944 *cpo-#*
1945 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001946 *cpo-&*
1947 & When ":preserve" was used keep the swap file when
1948 exiting normally while this buffer is still loaded.
1949 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001950 *cpo-\*
1951 \ Backslash in a [] range in a search pattern is taken
1952 literally, only "\]" is special See |/[]|
1953 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1954 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1955 Also see |cpo-\|.
1956 *cpo-/*
1957 / When "%" is used as the replacement string in a |:s|
1958 command, use the previous replacement string. |:s%|
1959 *cpo-{*
1960 { The |{| and |}| commands also stop at a "{" character
1961 at the start of a line.
1962 *cpo-.*
1963 . The ":chdir" and ":cd" commands fail if the current
1964 buffer is modified, unless ! is used. Vim doesn't
1965 need this, since it remembers the full path of an
1966 opened file.
1967 *cpo-bar*
1968 | The value of the $LINES and $COLUMNS environment
1969 variables overrule the terminal size values obtained
1970 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001971
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972
1973 *'cscopepathcomp'* *'cspc'*
1974'cscopepathcomp' 'cspc' number (default 0)
1975 global
1976 {not available when compiled without the |+cscope|
1977 feature}
1978 {not in Vi}
1979 Determines how many components of the path to show in a list of tags.
1980 See |cscopepathcomp|.
1981
1982 *'cscopeprg'* *'csprg'*
1983'cscopeprg' 'csprg' string (default "cscope")
1984 global
1985 {not available when compiled without the |+cscope|
1986 feature}
1987 {not in Vi}
1988 Specifies the command to execute cscope. See |cscopeprg|.
1989 This option cannot be set from a |modeline| or in the |sandbox|, for
1990 security reasons.
1991
1992 *'cscopequickfix'* *'csqf'*
1993'cscopequickfix' 'csqf' string (default "")
1994 global
1995 {not available when compiled without the |+cscope|
1996 or |+quickfix| features}
1997 {not in Vi}
1998 Specifies whether to use quickfix window to show cscope results.
1999 See |cscopequickfix|.
2000
2001 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2002'cscopetag' 'cst' boolean (default off)
2003 global
2004 {not available when compiled without the |+cscope|
2005 feature}
2006 {not in Vi}
2007 Use cscope for tag commands. See |cscope-options|.
2008 NOTE: This option is reset when 'compatible' is set.
2009
2010 *'cscopetagorder'* *'csto'*
2011'cscopetagorder' 'csto' number (default 0)
2012 global
2013 {not available when compiled without the |+cscope|
2014 feature}
2015 {not in Vi}
2016 Determines the order in which ":cstag" performs a search. See
2017 |cscopetagorder|.
2018 NOTE: This option is set to 0 when 'compatible' is set.
2019
2020 *'cscopeverbose'* *'csverb'*
2021 *'nocscopeverbose'* *'nocsverb'*
2022'cscopeverbose' 'csverb' boolean (default off)
2023 global
2024 {not available when compiled without the |+cscope|
2025 feature}
2026 {not in Vi}
2027 Give messages when adding a cscope database. See |cscopeverbose|.
2028 NOTE: This option is reset when 'compatible' is set.
2029
2030 *'debug'*
2031'debug' string (default "")
2032 global
2033 {not in Vi}
2034 When set to "msg", error messages that would otherwise be omitted will
2035 be given anyway. This is useful when debugging 'foldexpr' or
2036 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002037 When set to "beep", a message will be given when otherwise only a beep
2038 would be produced.
2039 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040
2041 *'define'* *'def'*
2042'define' 'def' string (default "^\s*#\s*define")
2043 global or local to buffer |global-local|
2044 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002045 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 pattern, just like for the "/" command. This option is used for the
2047 commands like "[i" and "[d" |include-search|. The 'isident' option is
2048 used to recognize the defined name after the match:
2049 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2050 See |option-backslash| about inserting backslashes to include a space
2051 or backslash.
2052 The default value is for C programs. For C++ this value would be
2053 useful, to include const type declarations: >
2054 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2055< When using the ":set" command, you need to double the backslashes!
2056
2057 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2058'delcombine' 'deco' boolean (default off)
2059 global
2060 {not in Vi}
2061 {only available when compiled with the |+multi_byte|
2062 feature}
2063 If editing Unicode and this option is set, backspace and Normal mode
2064 "x" delete each combining character on its own. When it is off (the
2065 default) the character along with its combining characters are
2066 deleted.
2067 Note: When 'delcombine' is set "xx" may work different from "2x"!
2068
2069 This is useful for Arabic, Hebrew and many other languages where one
2070 may have combining characters overtop of base characters, and want
2071 to remove only the combining ones.
2072
2073 *'dictionary'* *'dict'*
2074'dictionary' 'dict' string (default "")
2075 global or local to buffer |global-local|
2076 {not in Vi}
2077 List of file names, separated by commas, that are used to lookup words
2078 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2079 contain a list of words. This can be one word per line, or several
2080 words per line, separated by non-keyword characters (white space is
2081 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002082 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 after a comma are ignored, otherwise spaces are included in the file
2084 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002085 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002086 Where to find a list of words?
2087 - On FreeBSD, there is the file "/usr/share/dict/words".
2088 - In the Simtel archive, look in the "msdos/linguist" directory.
2089 - In "miscfiles" of the GNU collection.
2090 The use of |:set+=| and |:set-=| is preferred when adding or removing
2091 directories from the list. This avoids problems when a future version
2092 uses another default.
2093 Backticks cannot be used in this option for security reasons.
2094
2095 *'diff'* *'nodiff'*
2096'diff' boolean (default off)
2097 local to window
2098 {not in Vi}
2099 {not available when compiled without the |+diff|
2100 feature}
2101 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002102 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103
2104 *'dex'* *'diffexpr'*
2105'diffexpr' 'dex' string (default "")
2106 global
2107 {not in Vi}
2108 {not available when compiled without the |+diff|
2109 feature}
2110 Expression which is evaluated to obtain an ed-style diff file from two
2111 versions of a file. See |diff-diffexpr|.
2112 This option cannot be set from a |modeline| or in the |sandbox|, for
2113 security reasons.
2114
2115 *'dip'* *'diffopt'*
2116'diffopt' 'dip' string (default "filler")
2117 global
2118 {not in Vi}
2119 {not available when compiled without the |+diff|
2120 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002121 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 All are optional. Items must be separated by a comma.
2123
2124 filler Show filler lines, to keep the text
2125 synchronized with a window that has inserted
2126 lines at the same position. Mostly useful
2127 when windows are side-by-side and 'scrollbind'
2128 is set.
2129
2130 context:{n} Use a context of {n} lines between a change
2131 and a fold that contains unchanged lines.
2132 When omitted a context of six lines is used.
2133 See |fold-diff|.
2134
2135 icase Ignore changes in case of text. "a" and "A"
2136 are considered the same. Adds the "-i" flag
2137 to the "diff" command if 'diffexpr' is empty.
2138
2139 iwhite Ignore changes in amount of white space. Adds
2140 the "-b" flag to the "diff" command if
2141 'diffexpr' is empty. Check the documentation
2142 of the "diff" command for what this does
2143 exactly. It should ignore adding trailing
2144 white space, but not leading white space.
2145
2146 Examples: >
2147
2148 :set diffopt=filler,context:4
2149 :set diffopt=
2150 :set diffopt=filler
2151<
2152 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2153'digraph' 'dg' boolean (default off)
2154 global
2155 {not in Vi}
2156 {not available when compiled without the |+digraphs|
2157 feature}
2158 Enable the entering of digraphs in Insert mode with {char1} <BS>
2159 {char2}. See |digraphs|.
2160 NOTE: This option is reset when 'compatible' is set.
2161
2162 *'directory'* *'dir'*
2163'directory' 'dir' string (default for Amiga: ".,t:",
2164 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2165 for Unix: ".,~/tmp,/var/tmp,/tmp")
2166 global
2167 List of directory names for the swap file, separated with commas.
2168 - The swap file will be created in the first directory where this is
2169 possible.
2170 - Empty means that no swap file will be used (recovery is
2171 impossible!).
2172 - A directory "." means to put the swap file in the same directory as
2173 the edited file. On Unix, a dot is prepended to the file name, so
2174 it doesn't show in a directory listing. On MS-Windows the "hidden"
2175 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002176 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 put the swap file relative to where the edited file is. The leading
2178 "." is replaced with the path name of the edited file.
2179 - For Unix and Win32, if a directory ends in two path separators, the
2180 swap file name will be built from the complete path to the file
Bram Moolenaar582fd852005-03-28 20:58:01 +00002181 with all path separators substituted to percent '%' signs. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 ensure file name uniqueness in the preserve directory.
2183 - Spaces after the comma are ignored, other spaces are considered part
2184 of the directory name. To have a space at the start of a directory
2185 name, precede it with a backslash.
2186 - To include a comma in a directory name precede it with a backslash.
2187 - A directory name may end in an ':' or '/'.
2188 - Environment variables are expanded |:set_env|.
2189 - Careful with '\' characters, type one before a space, type two to
2190 get one in the option (see |option-backslash|), for example: >
2191 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2192< - For backwards compatibility with Vim version 3.0 a '>' at the start
2193 of the option is removed.
2194 Using "." first in the list is recommended. This means that editing
2195 the same file twice will result in a warning. Using "/tmp" on Unix is
2196 discouraged: When the system crashes you lose the swap file.
2197 "/var/tmp" is often not cleared when rebooting, thus is a better
2198 choice than "/tmp". But it can contain a lot of files, your swap
2199 files get lost in the crowd. That is why a "tmp" directory in your
2200 home directory is tried first.
2201 The use of |:set+=| and |:set-=| is preferred when adding or removing
2202 directories from the list. This avoids problems when a future version
2203 uses another default.
2204 This option cannot be set from a |modeline| or in the |sandbox|, for
2205 security reasons.
2206 {Vi: directory to put temp file in, defaults to "/tmp"}
2207
2208 *'display'* *'dy'*
2209'display' 'dy' string (default "")
2210 global
2211 {not in Vi}
2212 Change the way text is displayed. This is comma separated list of
2213 flags:
2214 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002215 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 last line that doesn't fit is replaced with "@" lines.
2217 uhex Show unprintable characters hexadecimal as <xx>
2218 instead of using ^C and ~C.
2219
2220 *'eadirection'* *'ead'*
2221'eadirection' 'ead' string (default "both")
2222 global
2223 {not in Vi}
2224 {not available when compiled without the +vertsplit
2225 feature}
2226 Tells when the 'equalalways' option applies:
2227 ver vertically, width of windows is not affected
2228 hor horizontally, height of windows is not affected
2229 both width and height of windows is affected
2230
2231 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2232'edcompatible' 'ed' boolean (default off)
2233 global
2234 Makes the 'g' and 'c' flags of the ":substitute" command to be
2235 toggled each time the flag is given. See |complex-change|. See
2236 also 'gdefault' option.
2237 Switching this option on is discouraged!
2238
2239 *'encoding'* *'enc'* *E543*
2240'encoding' 'enc' string (default: "latin1" or value from $LANG)
2241 global
2242 {only available when compiled with the |+multi_byte|
2243 feature}
2244 {not in Vi}
2245 Sets the character encoding used inside Vim. It applies to text in
2246 the buffers, registers, Strings in expressions, text stored in the
2247 viminfo file, etc. It sets the kind of characters which Vim can work
2248 with. See |encoding-names| for the possible values.
2249
2250 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002251 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002252 It should normally be kept at its default value, or set when Vim
2253 starts up. See |multibyte|.
2254
2255 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2256 "utf-8". Although care has been taken to allow different values of
2257 'encoding', "utf-8" is the natural choice for the environment and
2258 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002259 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260 versions, and to avoid changing the encoding of newly created files
2261 without your knowledge (in case 'fileencodings' is empty).
2262
2263 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002264 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 iconv() or as specified with 'charconvert'.
2266
2267 Normally 'encoding' will be equal to your current locale. This will
2268 be the default if Vim recognizes your environment settings. If
2269 'encoding' is not set to the current locale, 'termencoding' must be
2270 set to convert typed and displayed text. See |encoding-table|.
2271
2272 When you set this option, it fires the |EncodingChanged| autocommand
2273 event so that you can set up fonts if necessary.
2274
2275 When the option is set, the value is converted to lowercase. Thus
2276 you can set it with uppercase values too. Underscores are translated
2277 to '-' signs.
2278 When the encoding is recognized, it is changed to the standard name.
2279 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2280 "iso-8859-2" and "utf8" becomes "utf-8".
2281
2282 Note: "latin1" is also used when the encoding could not be detected.
2283 This only works when editing files in the same encoding! When the
2284 actual character set is not latin1, make sure 'fileencoding' and
2285 'fileencodings' are empty. When conversion is needed, switch to using
2286 utf-8.
2287
2288 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2289 You don't notice this while editing, but it does matter for the
2290 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2291 setting 'encoding' to one of these values instead of utf-8 only has
2292 effect for encoding used for files when 'fileencoding' is empty.
2293
Bram Moolenaar661b1822005-07-28 22:36:45 +00002294 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2295 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296
2297 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2298'endofline' 'eol' boolean (default on)
2299 local to buffer
2300 {not in Vi}
2301 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002302 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 option is automatically set when starting to edit a new file, unless
2304 the file does not have an <EOL> for the last line in the file, in
2305 which case it is reset. Normally you don't have to set or reset this
2306 option. When 'binary' is off the value is not used when writing the
2307 file. When 'binary' is on it is used to remember the presence of a
2308 <EOL> for the last line in the file, so that when you write the file
2309 the situation from the original file can be kept. But you can change
2310 it if you want to.
2311
2312 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2313'equalalways' 'ea' boolean (default on)
2314 global
2315 {not in Vi}
2316 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002317 splitting or closing a window. This also happens the moment the
2318 option is switched on. When off, splitting a window will reduce the
2319 size of the current window and leave the other windows the same. When
2320 closing a window the extra lines are given to the window next to it
2321 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 When mixing vertically and horizontally split windows, a minimal size
2323 is computed and some windows may be larger if there is room. The
2324 'eadirection' option tells in which direction the size is affected.
2325 Changing the height of a window can be avoided by setting
2326 'winfixheight'.
2327
2328 *'equalprg'* *'ep'*
2329'equalprg' 'ep' string (default "")
2330 global or local to buffer |global-local|
2331 {not in Vi}
2332 External program to use for "=" command. When this option is empty
2333 the internal formatting functions are used ('lisp', 'cindent' or
2334 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002335 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 about including spaces and backslashes.
2337 This option cannot be set from a |modeline| or in the |sandbox|, for
2338 security reasons.
2339
2340 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2341'errorbells' 'eb' boolean (default off)
2342 global
2343 Ring the bell (beep or screen flash) for error messages. This only
2344 makes a difference for error messages, the bell will be used always
2345 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002346 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 screen flash or do nothing.
2348
2349 *'errorfile'* *'ef'*
2350'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2351 others: "errors.err")
2352 global
2353 {not in Vi}
2354 {not available when compiled without the |+quickfix|
2355 feature}
2356 Name of the errorfile for the QuickFix mode (see |:cf|).
2357 When the "-q" command-line argument is used, 'errorfile' is set to the
2358 following argument. See |-q|.
2359 NOT used for the ":make" command. See 'makeef' for that.
2360 Environment variables are expanded |:set_env|.
2361 See |option-backslash| about including spaces and backslashes.
2362 This option cannot be set from a |modeline| or in the |sandbox|, for
2363 security reasons.
2364
2365 *'errorformat'* *'efm'*
2366'errorformat' 'efm' string (default is very long)
2367 global or local to buffer |global-local|
2368 {not in Vi}
2369 {not available when compiled without the |+quickfix|
2370 feature}
2371 Scanf-like description of the format for the lines in the error file
2372 (see |errorformat|).
2373
2374 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2375'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2376 global
2377 {not in Vi}
2378 Function keys that start with an <Esc> are recognized in Insert
2379 mode. When this option is off, the cursor and function keys cannot be
2380 used in Insert mode if they start with an <Esc>. The advantage of
2381 this is that the single <Esc> is recognized immediately, instead of
2382 after one second. Instead of resetting this option, you might want to
2383 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2384 when 'esckeys' is off, you can still map anything, but the cursor keys
2385 won't work by default.
2386 NOTE: This option is set to the Vi default value when 'compatible' is
2387 set and to the Vim default value when 'compatible' is reset.
2388
2389 *'eventignore'* *'ei'*
2390'eventignore' 'ei' string (default "")
2391 global
2392 {not in Vi}
2393 {not available when compiled without the |+autocmd|
2394 feature}
2395 A list of autocommand event names, which are to be ignored.
2396 When set to "all", all autocommand events are ignored, autocommands
2397 will not be executed.
2398 Otherwise this is a comma separated list of event names. Example: >
2399 :set ei=WinEnter,WinLeave
2400<
2401 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2402'expandtab' 'et' boolean (default off)
2403 local to buffer
2404 {not in Vi}
2405 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002406 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2408 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2409 NOTE: This option is reset when 'compatible' is set.
2410
2411 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2412'exrc' 'ex' boolean (default off)
2413 global
2414 {not in Vi}
2415 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2416 directory. If you switch this option on you should also consider
2417 setting the 'secure' option (see |initialization|). Using a local
2418 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2419 also see |.vimrc| and |gui-init|.
2420 This option cannot be set from a |modeline| or in the |sandbox|, for
2421 security reasons.
2422
2423 *'fileencoding'* *'fenc'* *E213*
2424'fileencoding' 'fenc' string (default: "")
2425 local to buffer
2426 {only available when compiled with the |+multi_byte|
2427 feature}
2428 {not in Vi}
2429 Sets the character encoding for the file of this buffer.
2430 When 'fileencoding' is different from 'encoding', conversion will be
2431 done when reading and writing the file.
2432 When 'fileencoding' is empty, the same value as 'encoding' will be
2433 used (no conversion when reading or writing a file).
2434 WARNING: Conversion can cause loss of information! When
2435 'encoding' is "utf-8" conversion is most likely done in a way
2436 that the reverse conversion results in the same text. When
2437 'encoding' is not "utf-8" some characters may be lost!
2438 See 'encoding' for the possible values. Additionally, values may be
2439 specified that can be handled by the converter, see
2440 |mbyte-conversion|.
2441 When reading a file 'fileencoding' will be set from 'fileencodings'.
2442 To read a file in a certain encoding it won't work by setting
2443 'fileencoding', use the |++enc| argument.
2444 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2445 When the option is set, the value is converted to lowercase. Thus
2446 you can set it with uppercase values too. '_' characters are
2447 replaced with '-'. If a name is recognized from the list for
2448 'encoding', it is replaced by the standard name. For example
2449 "ISO8859-2" becomes "iso-8859-2".
2450 When this option is set, after starting to edit a file, the 'modified'
2451 option is set, because the file would be different when written.
2452 If you do this in a modeline, you might want to set 'nomodified' to
2453 avoid this.
2454 This option can not be changed when 'modifiable' is off.
2455
2456 *'fe'*
2457 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002458 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 old short name was 'fe', which is no longer used.
2460
2461 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002462'fileencodings' 'fencs' string (default: "ucs-bom",
2463 "ucs-bom,utf-8,default,latin1" when
2464 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 global
2466 {only available when compiled with the |+multi_byte|
2467 feature}
2468 {not in Vi}
2469 This is a list of character encodings considered when starting to edit
2470 an existing file. When a file is read, Vim tries to use the first
2471 mentioned character encoding. If an error is detected, the next one
2472 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002473 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 an empty string, which means the value of 'encoding' is used.
2475 WARNING: Conversion can cause loss of information! When
2476 'encoding' is "utf-8" (or one of the other Unicode variants)
2477 conversion is most likely done in a way that the reverse
2478 conversion results in the same text. When 'encoding' is not
2479 "utf-8" special characters may be lost!
2480 For an empty file or a file with only ASCII characters most encodings
2481 will work and the first entry of 'fileencodings' will be used (except
2482 "ucs-bom", which requires the BOM to be present). If you prefer
2483 another encoding use an BufReadPost autocommand event to test if your
2484 preferred encoding is to be used. Example: >
2485 au BufReadPost * if search('\S', 'w') == 0 |
2486 \ set fenc=iso-2022-jp | endif
2487< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2488 non-blank characters.
2489 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2490 is always empty then. This means that a non-existing file may get a
2491 different encoding than an empty file.
2492 The special value "ucs-bom" can be used to check for a Unicode BOM
2493 (Byte Order Mark) at the start of the file. It must not be preceded
2494 by "utf-8" or another Unicode encoding for this to work properly.
2495 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2496 because Vim cannot detect an error, thus the encoding is always
2497 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002498 The special value "default" can be used for the encoding from the
2499 environment. This is the default value for 'encoding'. It is useful
2500 when 'encoding' is set to "utf-8" and your environment uses a
2501 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 WRONG VALUES: WHAT'S WRONG:
2503 latin1,utf-8 "latin1" will always be used
2504 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2505 file
2506 cp1250,latin1 "cp1250" will always be used
2507 If 'fileencodings' is empty, 'fileencoding' is not modified.
2508 See 'fileencoding' for the possible values.
2509 Setting this option does not have an effect until the next time a file
2510 is read.
2511
2512 *'fileformat'* *'ff'*
2513'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2514 Unix default: "unix",
2515 Macintosh default: "mac")
2516 local to buffer
2517 {not in Vi}
2518 This gives the <EOL> of the current buffer, which is used for
2519 reading/writing the buffer from/to a file:
2520 dos <CR> <NL>
2521 unix <NL>
2522 mac <CR>
2523 When "dos" is used, CTRL-Z at the end of a file is ignored.
2524 See |file-formats| and |file-read|.
2525 For the character encoding of the file see 'fileencoding'.
2526 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2527 works like it was set to "unix'.
2528 This option is set automatically when starting to edit a file and
2529 'fileformats' is not empty and 'binary' is off.
2530 When this option is set, after starting to edit a file, the 'modified'
2531 option is set, because the file would be different when written.
2532 This option can not be changed when 'modifiable' is off.
2533 For backwards compatibility: When this option is set to "dos",
2534 'textmode' is set, otherwise 'textmode' is reset.
2535
2536 *'fileformats'* *'ffs'*
2537'fileformats' 'ffs' string (default:
2538 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2539 Vim Unix: "unix,dos",
2540 Vim Mac: "mac,unix,dos",
2541 Vi Cygwin: "unix,dos",
2542 Vi others: "")
2543 global
2544 {not in Vi}
2545 This gives the end-of-line (<EOL>) formats that will be tried when
2546 starting to edit a new buffer and when reading a file into an existing
2547 buffer:
2548 - When empty, the format defined with 'fileformat' will be used
2549 always. It is not set automatically.
2550 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002551 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 'fileformats' name will be used when a file is read into an existing
2553 buffer, no matter what 'fileformat' for that buffer is set to.
2554 - When more than one name is present, separated by commas, automatic
2555 <EOL> detection will be done when reading a file. When starting to
2556 edit a file, a check is done for the <EOL>:
2557 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2558 'fileformat' is set to "dos".
2559 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002560 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 preceding <CR>, "unix" is preferred over "dos".
2562 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2563 This means that "mac" is only chosen when "unix" is not present,
2564 or when no <NL> is found in the file, and when "dos" is not
2565 present, or no <CR><NL> is present in the file.
2566 Also if "unix" was first chosen, but the first <CR> is before
2567 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2568 the file, then 'fileformat' is set to "mac".
2569 4. If 'fileformat' is still not set, the first name from
2570 'fileformats' is used.
2571 When reading a file into an existing buffer, the same is done, but
2572 this happens like 'fileformat' has been set appropriately for that
2573 file only, the option is not changed.
2574 When 'binary' is set, the value of 'fileformats' is not used.
2575
2576 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2577 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2578 done:
2579 - When 'fileformats' is empty, there is no automatic detection. Dos
2580 format will be used.
2581 - When 'fileformats' is set to one or more names, automatic detection
2582 is done. This is based on the first <NL> in the file: If there is a
2583 <CR> in front of it, Dos format is used, otherwise Unix format is
2584 used.
2585 Also see |file-formats|.
2586 For backwards compatibility: When this option is set to an empty
2587 string or one format (no comma is included), 'textauto' is reset,
2588 otherwise 'textauto' is set.
2589 NOTE: This option is set to the Vi default value when 'compatible' is
2590 set and to the Vim default value when 'compatible' is reset.
2591
2592 *'filetype'* *'ft'*
2593'filetype' 'ft' string (default: "")
2594 local to buffer
2595 {not in Vi}
2596 {not available when compiled without the |+autocmd|
2597 feature}
2598 When this option is set, the FileType autocommand event is triggered.
2599 All autocommands that match with the value of this option will be
2600 executed. Thus the value of 'filetype' is used in place of the file
2601 name.
2602 Otherwise this option does not always reflect the current file type.
2603 This option is normally set when the file type is detected. To enable
2604 this use the ":filetype on" command. |:filetype|
2605 Setting this option to a different value is most useful in a modeline,
2606 for a file for which the file type is not automatically recognized.
2607 Example, for in an IDL file: >
2608 /* vim: set filetype=idl : */
2609< |FileType| |filetypes|
2610 Do not confuse this option with 'osfiletype', which is for the file
2611 type that is actually stored with the file.
2612 This option is not copied to another buffer, independent of the 's' or
2613 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002614 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615
2616 *'fillchars'* *'fcs'*
2617'fillchars' 'fcs' string (default "vert:|,fold:-")
2618 global
2619 {not in Vi}
2620 {not available when compiled without the |+windows|
2621 and |+folding| features}
2622 Characters to fill the statuslines and vertical separators.
2623 It is a comma separated list of items:
2624
2625 item default Used for ~
2626 stl:c ' ' or '^' statusline of the current window
2627 stlnc:c ' ' or '-' statusline of the non-current windows
2628 vert:c '|' vertical separators |:vsplit|
2629 fold:c '-' filling 'foldtext'
2630 diff:c '-' deleted lines of the 'diff' option
2631
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002632 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 "stlnc" the space will be used when there is highlighting, '^' or '-'
2634 otherwise.
2635
2636 Example: >
2637 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2638< This is similar to the default, except that these characters will also
2639 be used when there is highlighting.
2640
2641 The highlighting used for these items:
2642 item highlight group ~
2643 stl:c StatusLine |hl-StatusLine|
2644 stlnc:c StatusLineNC |hl-StatusLineNC|
2645 vert:c VertSplit |hl-VertSplit|
2646 fold:c Folded |hl-Folded|
2647 diff:c DiffDelete |hl-DiffDelete|
2648
2649 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2650'fkmap' 'fk' boolean (default off) *E198*
2651 global
2652 {not in Vi}
2653 {only available when compiled with the |+rightleft|
2654 feature}
2655 When on, the keyboard is mapped for the Farsi character set.
2656 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002657 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002658
2659 *'foldclose'* *'fcl'*
2660'foldclose' 'fcl' string (default "")
2661 global
2662 {not in Vi}
2663 {not available when compiled without the |+folding|
2664 feature}
2665 When set to "all", a fold is closed when the cursor isn't in it and
2666 its level is higher than 'foldlevel'. Useful if you want folds to
2667 automatically close when moving out of them.
2668
2669 *'foldcolumn'* *'fdc'*
2670'foldcolumn' 'fdc' number (default 0)
2671 local to window
2672 {not in Vi}
2673 {not available when compiled without the |+folding|
2674 feature}
2675 When non-zero, a column with the specified width is shown at the side
2676 of the window which indicates open and closed folds. The maximum
2677 value is 12.
2678 See |folding|.
2679
2680 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2681'foldenable' 'fen' boolean (default on)
2682 local to window
2683 {not in Vi}
2684 {not available when compiled without the |+folding|
2685 feature}
2686 When off, all folds are open. This option can be used to quickly
2687 switch between showing all text unfolded and viewing the text with
2688 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002689 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 'foldenable' is off.
2691 This option is set by commands that create a new fold or close a fold.
2692 See |folding|.
2693
2694 *'foldexpr'* *'fde'*
2695'foldexpr' 'fde' string (default: "0")
2696 local to window
2697 {not in Vi}
2698 {not available when compiled without the |+folding|
2699 or |+eval| feature}
2700 The expression used for when 'foldmethod' is "expr". It is evaluated
2701 for each line to obtain its fold level. See |fold-expr|. Also see
2702 |eval-sandbox|.
2703
2704 *'foldignore'* *'fdi'*
2705'foldignore' 'fdi' string (default: "#")
2706 local to window
2707 {not in Vi}
2708 {not available when compiled without the |+folding|
2709 feature}
2710 Used only when 'foldmethod' is "indent". Lines starting with
2711 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 The default "#" works well for C programs. See |fold-indent|.
2714
2715 *'foldlevel'* *'fdl'*
2716'foldlevel' 'fdl' number (default: 0)
2717 local to window
2718 {not in Vi}
2719 {not available when compiled without the |+folding|
2720 feature}
2721 Sets the fold level: Folds with a higher level will be closed.
2722 Setting this option to zero will close all folds. Higher numbers will
2723 close fewer folds.
2724 This option is set by commands like |zm|, |zM| and |zR|.
2725 See |fold-foldlevel|.
2726
2727 *'foldlevelstart'* *'fdls'*
2728'foldlevelstart' 'fdls' number (default: -1)
2729 global
2730 {not in Vi}
2731 {not available when compiled without the |+folding|
2732 feature}
2733 Sets 'foldlevel' when starting to edit another buffer in a window.
2734 Useful to always start editing with all folds closed (value zero),
2735 some folds closed (one) or no folds closed (99).
2736 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002737 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 ignores this option and closes all folds.
2739 It is also done before BufReadPre autocommands, to allow an autocmd to
2740 overrule the 'foldlevel' value for specific files.
2741 When the value is negative, it is not used.
2742
2743 *'foldmarker'* *'fmr'* *E536*
2744'foldmarker' 'fmr' string (default: "{{{,}}}")
2745 local to window
2746 {not in Vi}
2747 {not available when compiled without the |+folding|
2748 feature}
2749 The start and end marker used when 'foldmethod' is "marker". There
2750 must be one comma, which separates the start and end marker. The
2751 marker is a literal string (a regular expression would be too slow).
2752 See |fold-marker|.
2753
2754 *'foldmethod'* *'fdm'*
2755'foldmethod' 'fdm' string (default: "manual")
2756 local to window
2757 {not in Vi}
2758 {not available when compiled without the |+folding|
2759 feature}
2760 The kind of folding used for the current window. Possible values:
2761 |fold-manual| manual Folds are created manually.
2762 |fold-indent| indent Lines with equal indent form a fold.
2763 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2764 |fold-marker| marker Markers are used to specify folds.
2765 |fold-syntax| syntax Syntax highlighting items specify folds.
2766 |fold-diff| diff Fold text that is not changed.
2767
2768 *'foldminlines'* *'fml'*
2769'foldminlines' 'fml' number (default: 1)
2770 local to window
2771 {not in Vi}
2772 {not available when compiled without the |+folding|
2773 feature}
2774 Sets the minimum number of screen lines for a fold to be displayed
2775 closed. Also for manually closed folds.
2776 Note that this only has an effect of what is displayed. After using
2777 "zc" to close a fold, which is displayed open because it's smaller
2778 than 'foldminlines', a following "zc" may close a containing fold.
2779
2780 *'foldnestmax'* *'fdn'*
2781'foldnestmax' 'fdn' number (default: 20)
2782 local to window
2783 {not in Vi}
2784 {not available when compiled without the |+folding|
2785 feature}
2786 Sets the maximum nesting of folds for the "indent" and "syntax"
2787 methods. This avoids that too many folds will be created. Using more
2788 than 20 doesn't work, because the internal limit is 20.
2789
2790 *'foldopen'* *'fdo'*
2791'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2792 search,tag,undo")
2793 global
2794 {not in Vi}
2795 {not available when compiled without the |+folding|
2796 feature}
2797 Specifies for which type of commands folds will be opened, if the
2798 command moves the cursor into a closed fold. It is a comma separated
2799 list of items.
2800 item commands ~
2801 all any
2802 block "(", "{", "[[", "[{", etc.
2803 hor horizontal movements: "l", "w", "fx", etc.
2804 insert any command in Insert mode
2805 jump far jumps: "G", "gg", etc.
2806 mark jumping to a mark: "'m", CTRL-O, etc.
2807 percent "%"
2808 quickfix ":cn", ":crew", ":make", etc.
2809 search search for a pattern: "/", "n", "*", "gd", etc.
2810 (not for a search pattern in a ":" command)
2811 tag jumping to a tag: ":ta", CTRL-T, etc.
2812 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002813 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 the |zv| command to the mapping to get the same effect.
2815 When a movement command is used for an operator (e.g., "dl" or "y%")
2816 this option is not used. This means the operator will include the
2817 whole closed fold.
2818 Note that vertical movements are not here, because it would make it
2819 very difficult to move onto a closed fold.
2820 In insert mode the folds containing the cursor will always be open
2821 when text is inserted.
2822 To close folds you can re-apply 'foldlevel' with the |zx| command or
2823 set the 'foldclose' option to "all".
2824
2825 *'foldtext'* *'fdt'*
2826'foldtext' 'fdt' string (default: "foldtext()")
2827 local to window
2828 {not in Vi}
2829 {not available when compiled without the |+folding|
2830 feature}
2831 An expression which is used to specify the text displayed for a closed
2832 fold. See |fold-foldtext|.
2833
2834 *'formatoptions'* *'fo'*
2835'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2836 local to buffer
2837 {not in Vi}
2838 This is a sequence of letters which describes how automatic
2839 formatting is to be done. See |fo-table|. When the 'paste' option is
2840 on, no formatting is done (like 'formatoptions' is empty). Commas can
2841 be inserted for readability.
2842 To avoid problems with flags that are added in the future, use the
2843 "+=" and "-=" feature of ":set" |add-option-flags|.
2844 NOTE: This option is set to the Vi default value when 'compatible' is
2845 set and to the Vim default value when 'compatible' is reset.
2846
Bram Moolenaar86b68352004-12-27 21:59:20 +00002847 *'formatlistpat'* *'flp'*
2848'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2849 local to buffer
2850 {not in Vi}
2851 A pattern that is used to recognize a list header. This is used for
2852 the "n" flag in 'formatoptions'.
2853 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002854 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002855 while still checking more characters. There must be a character
2856 following the pattern, when it matches the whole line it is handled
2857 like there is no match.
2858 The default recognizes a number, followed by an optional punctuation
2859 character and white space.
2860
Bram Moolenaar071d4272004-06-13 20:20:40 +00002861 *'formatprg'* *'fp'*
2862'formatprg' 'fp' string (default "")
2863 global
2864 {not in Vi}
2865 The name of an external program that will be used to format the lines
2866 selected with the "gq" command. The program must take the input on
2867 stdin and produce the output on stdout. The Unix program "fmt" is
2868 such a program. If this option is an empty string, the internal
2869 format function will be used |C-indenting|. Environment variables are
2870 expanded |:set_env|. See |option-backslash| about including spaces
2871 and backslashes.
2872 This option cannot be set from a |modeline| or in the |sandbox|, for
2873 security reasons.
2874
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002875 *'fsync'* *'fs'*
2876'fsync' 'fs' boolean (default on)
2877 global
2878 {not in Vi}
2879 When on, the library function fsync() will be called after writing a
2880 file. This will flush a file to disk, ensuring that it is safely
2881 written even on filesystems which do metadata-only journaling. This
2882 will force the harddrive to spin up on Linux systems running in laptop
2883 mode, so it may be undesirable in some situations. Be warned that
2884 turning this off increases the chances of data loss after a crash. On
2885 systems without an fsync() implementation, this variable is always
2886 off.
2887 Also see 'swapsync' for controlling fsync() on swap files.
2888
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2890'gdefault' 'gd' boolean (default off)
2891 global
2892 {not in Vi}
2893 When on, the ":substitute" flag 'g' is default on. This means that
2894 all matches in a line are substituted instead of one. When a 'g' flag
2895 is given to a ":substitute" command, this will toggle the substitution
2896 of all or one match. See |complex-change|.
2897
2898 command 'gdefault' on 'gdefault' off ~
2899 :s/// subst. all subst. one
2900 :s///g subst. one subst. all
2901 :s///gg subst. all subst. one
2902
2903 NOTE: This option is reset when 'compatible' is set.
2904
2905 *'grepformat'* *'gfm'*
2906'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2907 global
2908 {not in Vi}
2909 Format to recognize for the ":grep" command output.
2910 This is a scanf-like string that uses the same format as the
2911 'errorformat' option: see |errorformat|.
2912
2913 *'grepprg'* *'gp'*
2914'grepprg' 'gp' string (default "grep -n ",
2915 Unix: "grep -n $* /dev/null",
2916 Win32: "findstr /n" or "grep -n",
2917 VMS: "SEARCH/NUMBERS ")
2918 global or local to buffer |global-local|
2919 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002920 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 and '#' characters, which are expanded like when used in a command-
2922 line. The placeholder "$*" is allowed to specify where the arguments
2923 will be included. Environment variables are expanded |:set_env|. See
2924 |option-backslash| about including spaces and backslashes.
2925 When your "grep" accepts the "-H" argument, use this to make ":grep"
2926 also work well with a single file: >
2927 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002928< Special value: When 'grepprg' is set to "internal" the |:grep| command
2929 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002930 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002931 apply equally to 'grepprg'.
2932 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2933 otherwise it's "grep -n".
2934 This option cannot be set from a |modeline| or in the |sandbox|, for
2935 security reasons.
2936
2937 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2938'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2939 ve:ver35-Cursor,
2940 o:hor50-Cursor,
2941 i-ci:ver25-Cursor/lCursor,
2942 r-cr:hor20-Cursor/lCursor,
2943 sm:block-Cursor
2944 -blinkwait175-blinkoff150-blinkon175",
2945 for MS-DOS and Win32 console:
2946 "n-v-c:block,o:hor50,i-ci:hor15,
2947 r-cr:hor30,sm:block")
2948 global
2949 {not in Vi}
2950 {only available when compiled with GUI enabled, and
2951 for MS-DOS and Win32 console}
2952 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002953 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954 the height of the cursor can be changed. This can be done by
2955 specifying a block cursor, or a percentage for a vertical or
2956 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002957 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002959 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 mode-list and an argument-list:
2961 mode-list:argument-list,mode-list:argument-list,..
2962 The mode-list is a dash separated list of these modes:
2963 n Normal mode
2964 v Visual mode
2965 ve Visual mode with 'selection' "exclusive" (same as 'v',
2966 if not specified)
2967 o Operator-pending mode
2968 i Insert mode
2969 r Replace mode
2970 c Command-line Normal (append) mode
2971 ci Command-line Insert mode
2972 cr Command-line Replace mode
2973 sm showmatch in Insert mode
2974 a all modes
2975 The argument-list is a dash separated list of these arguments:
2976 hor{N} horizontal bar, {N} percent of the character height
2977 ver{N} vertical bar, {N} percent of the character width
2978 block block cursor, fills the whole character
2979 [only one of the above three should be present]
2980 blinkwait{N} *cursor-blinking*
2981 blinkon{N}
2982 blinkoff{N}
2983 blink times for cursor: blinkwait is the delay before
2984 the cursor starts blinking, blinkon is the time that
2985 the cursor is shown and blinkoff is the time that the
2986 cursor is not shown. The times are in msec. When one
2987 of the numbers is zero, there is no blinking. The
2988 default is: "blinkwait700-blinkon400-blinkoff250".
2989 These numbers are used for a missing entry. This
2990 means that blinking is enabled by default. To switch
2991 blinking off you can use "blinkon0". The cursor only
2992 blinks when Vim is waiting for input, not while
2993 executing a command.
2994 To make the cursor blink in an xterm, see
2995 |xterm-blink|.
2996 {group-name}
2997 a highlight group name, that sets the color and font
2998 for the cursor
2999 {group-name}/{group-name}
3000 Two highlight group names, the first is used when
3001 no language mappings are used, the other when they
3002 are. |language-mapping|
3003
3004 Examples of parts:
3005 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3006 block cursor with colors from the "nCursor"
3007 highlight group
3008 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3009 In Insert and Command-line Insert mode, use a
3010 30% vertical bar cursor with colors from the
3011 "iCursor" highlight group. Blink a bit
3012 faster.
3013
3014 The 'a' mode is different. It will set the given argument-list for
3015 all modes. It does not reset anything to defaults. This can be used
3016 to do a common setting for all modes. For example, to switch off
3017 blinking: "a:blinkon0"
3018
3019 Examples of cursor highlighting: >
3020 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3021 :highlight Cursor gui=NONE guifg=bg guibg=fg
3022<
3023 *'guifont'* *'gfn'*
3024 *E235* *E596* *E610* *E611*
3025'guifont' 'gfn' string (default "")
3026 global
3027 {not in Vi}
3028 {only available when compiled with GUI enabled}
3029 This is a list of fonts which will be used for the GUI version of Vim.
3030 In its simplest form the value is just one font name. When
3031 the font cannot be found you will get an error message. To try other
3032 font names a list can be specified, font names separated with commas.
3033 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003034
Bram Moolenaar05159a02005-02-26 23:04:13 +00003035 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3036 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003037
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 Spaces after a comma are ignored. To include a comma in a font name
3039 precede it with a backslash. Setting an option requires an extra
3040 backslash before a space and a backslash. See also
3041 |option-backslash|. For example: >
3042 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003043< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003045
3046 If none of the fonts can be loaded, Vim will keep the current setting.
3047 If an empty font list is given, Vim will try using other resource
3048 settings (for X, it will use the Vim.font resource), and finally it
3049 will try some builtin default which should always be there ("7x13" in
3050 the case of X). The font names given should be "normal" fonts. Vim
3051 will try to find the related bold and italic fonts.
3052
Bram Moolenaar05159a02005-02-26 23:04:13 +00003053 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003054 :set guifont=*
3055< will bring up a font requester, where you can pick the font you want.
3056
3057 The font name depends on the GUI used. See |setting-guifont| for a
3058 way to set 'guifont' for various systems.
3059
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 For the GTK+ 2 GUI the font name looks like this: >
3061 :set guifont=Andale\ Mono\ 11
3062< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003063
3064 For Mac OSX you can use something like this: >
3065 :set guifont=Monaco:h10
3066< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003068 width). An exception is GTK 2: all fonts are accepted, but
3069 mono-spaced fonts look best.
3070
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 To preview a font on X11, you might be able to use the "xfontsel"
3072 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003073
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 For the Win32 GUI *E244* *E245*
3075 - takes these options in the font name:
3076 hXX - height is XX (points, can be floating-point)
3077 wXX - width is XX (points, can be floating-point)
3078 b - bold
3079 i - italic
3080 u - underline
3081 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003082 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3084 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3085 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003086 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087
3088 Use a ':' to separate the options.
3089 - A '_' can be used in the place of a space, so you don't need to use
3090 backslashes to escape the spaces.
3091 - Examples: >
3092 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3093 :set guifont=Andale_Mono:h7.5:w4.5
3094< See also |font-sizes|.
3095
3096 *'guifontset'* *'gfs'*
3097 *E250* *E252* *E234* *E597* *E598*
3098'guifontset' 'gfs' string (default "")
3099 global
3100 {not in Vi}
3101 {only available when compiled with GUI enabled and
3102 with the |+xfontset| feature}
3103 {not available in the GTK+ 2 GUI}
3104 When not empty, specifies two (or more) fonts to be used. The first
3105 one for normal English, the second one for your special language. See
3106 |xfontset|.
3107 Setting this option also means that all font names will be handled as
3108 a fontset name. Also the ones used for the "font" argument of the
3109 |:highlight| command.
3110 The fonts must match with the current locale. If fonts for the
3111 character sets that the current locale uses are not included, setting
3112 'guifontset' will fail.
3113 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3114 the comma-separated names are alternative names, one of which will be
3115 used. In 'guifontset' the whole string is one fontset name,
3116 including the commas. It is not possible to specify alternative
3117 fontset names.
3118 This example works on many X11 systems: >
3119 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3120<
3121 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3122'guifontwide' 'gfw' string (default "")
3123 global
3124 {not in Vi}
3125 {only available when compiled with GUI enabled}
3126 When not empty, specifies a comma-separated list of fonts to be used
3127 for double-width characters. The first font that can be loaded is
3128 used.
3129 Note: The size of these fonts must be exactly twice as wide as the one
3130 specified with 'guifont' and the same height.
3131
3132 All GUI versions but GTK+ 2:
3133
3134 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3135 'guifontset' is empty or invalid.
3136 When 'guifont' is set and a valid font is found in it and
3137 'guifontwide' is empty Vim will attempt to find a matching
3138 double-width font and set 'guifontwide' to it.
3139
3140 GTK+ 2 GUI only: *guifontwide_gtk2*
3141
3142 If set and valid, 'guifontwide' is always used for double width
3143 characters, even if 'encoding' is not set to "utf-8".
3144 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003145 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 font for characters not available in 'guifont'. Thus you do not need
3147 to set 'guifontwide' at all unless you want to override the choice
3148 made by Pango/Xft.
3149
3150 *'guiheadroom'* *'ghr'*
3151'guiheadroom' 'ghr' number (default 50)
3152 global
3153 {not in Vi} {only for GTK and X11 GUI}
3154 The number of pixels subtracted from the screen height when fitting
3155 the GUI window on the screen. Set this before the GUI is started,
3156 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003157 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 lines will be left for window decorations and other items on the
3159 screen. Set it to a negative value to allow windows taller than the
3160 screen.
3161
3162 *'guioptions'* *'go'*
3163'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003164 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 global
3166 {not in Vi}
3167 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003168 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 sequence of letters which describes what components and options of the
3170 GUI should be used.
3171 To avoid problems with flags that are added in the future, use the
3172 "+=" and "-=" feature of ":set" |add-option-flags|.
3173
3174 Valid letters are as follows:
3175 *guioptions_a*
3176 'a' Autoselect: If present, then whenever VISUAL mode is started,
3177 or the Visual area extended, Vim tries to become the owner of
3178 the windowing system's global selection. This means that the
3179 Visually highlighted text is available for pasting into other
3180 applications as well as into Vim itself. When the Visual mode
3181 ends, possibly due to an operation on the text, or when an
3182 application wants to paste the selection, the highlighted text
3183 is automatically yanked into the "* selection register.
3184 Thus the selection is still available for pasting into other
3185 applications after the VISUAL mode has ended.
3186 If not present, then Vim won't become the owner of the
3187 windowing system's global selection unless explicitly told to
3188 by a yank or delete operation for the "* register.
3189 The same applies to the modeless selection.
3190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003191 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 applies to the modeless selection.
3193
3194 'guioptions' autoselect Visual autoselect modeless ~
3195 "" - -
3196 "a" yes yes
3197 "A" - yes
3198 "aA" yes yes
3199
3200 'c' Use console dialogs instead of popup dialogs for simple
3201 choices.
3202
3203 'f' Foreground: Don't use fork() to detach the GUI from the shell
3204 where it was started. Use this for programs that wait for the
3205 editor to finish (e.g., an e-mail program). Alternatively you
3206 can use "gvim -f" or ":gui -f" to start the GUI in the
3207 foreground. |gui-fork|
3208 Note: Set this option in the vimrc file. The forking may have
3209 happened already when the gvimrc file is read.
3210
3211 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3212 corner of the window. It's black&white on non-GTK, because of
3213 limitations of X11. For a color icon, see |X11-icon|.
3214
3215 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003216 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 that this flag must be added in the .vimrc file, before
3218 switching on syntax or filetype recognition (when the .gvimrc
3219 file is sourced the system menu has already been loaded; the
3220 ":syntax on" and ":filetype on" commands load the menu too).
3221 'g' Grey menu items: Make menu items that are not active grey. If
3222 'g' is not included inactive menu items are not shown at all.
3223 Exception: Athena will always use grey menu items.
3224
3225 't' Include tearoff menu items. Currently only works for Win32,
3226 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003227 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3228 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229
3230 'r' Right-hand scrollbar is always present.
3231 'R' Right-hand scrollbar is present when there is a vertically
3232 split window.
3233 'l' Left-hand scrollbar is always present.
3234 'L' Left-hand scrollbar is present when there is a vertically
3235 split window.
3236 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3237 the longest visible line, or on the cursor line if the 'h'
3238 flag is included. |gui-horiz-scroll|
3239 'h' Limit horizontal scrollbar size to the length of the cursor
3240 line. Reduces computations. |gui-horiz-scroll|
3241
3242 And yes, you may even have scrollbars on the left AND the right if
3243 you really want to :-). See |gui-scrollbars| for more information.
3244
3245 'v' Use a vertical button layout for dialogs. When not included,
3246 a horizontal layout is preferred, but when it doesn't fit a
3247 vertical layout is used anyway.
3248 'p' Use Pointer callbacks for X11 GUI. This is required for some
3249 window managers. If the cursor is not blinking or hollow at
3250 the right moment, try adding this flag. This must be done
3251 before starting the GUI. Set it in your gvimrc. Adding or
3252 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003253 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254
3255 *'guipty'* *'noguipty'*
3256'guipty' boolean (default on)
3257 global
3258 {not in Vi}
3259 {only available when compiled with GUI enabled}
3260 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3261 I/O to/from shell commands. See |gui-pty|.
3262
3263 *'helpfile'* *'hf'*
3264'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3265 (others) "$VIMRUNTIME/doc/help.txt")
3266 global
3267 {not in Vi}
3268 Name of the main help file. All distributed help files should be
3269 placed together in one directory. Additionally, all "doc" directories
3270 in 'runtimepath' will be used.
3271 Environment variables are expanded |:set_env|. For example:
3272 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003273 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 spaces and backslashes.
3275 This option cannot be set from a |modeline| or in the |sandbox|, for
3276 security reasons.
3277
3278 *'helpheight'* *'hh'*
3279'helpheight' 'hh' number (default 20)
3280 global
3281 {not in Vi}
3282 {not available when compiled without the +windows
3283 feature}
3284 Minimal initial height of the help window when it is opened with the
3285 ":help" command. The initial height of the help window is half of the
3286 current window, or (when the 'ea' option is on) the same as other
3287 windows. When the height is less than 'helpheight', the height is
3288 set to 'helpheight'. Set to zero to disable.
3289
3290 *'helplang'* *'hlg'*
3291'helplang' 'hlg' string (default: messages language or empty)
3292 global
3293 {only available when compiled with the |+multi_lang|
3294 feature}
3295 {not in Vi}
3296 Comma separated list of languages. Vim will use the first language
3297 for which the desired help can be found. The English help will always
3298 be used as a last resort. You can add "en" to prefer English over
3299 another language, but that will only find tags that exist in that
3300 language and not in the English help.
3301 Example: >
3302 :set helplang=de,it
3303< This will first search German, then Italian and finally English help
3304 files.
3305 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3306 try to find the tag in the current language before using this option.
3307 See |help-translated|.
3308
3309 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3310'hidden' 'hid' boolean (default off)
3311 global
3312 {not in Vi}
3313 When off a buffer is unloaded when it is |abandon|ed. When on a
3314 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3315 displayed in another window, it does not become hidden, of course.
3316 The commands that move through the buffer list sometimes make a buffer
3317 hidden although the 'hidden' option is off: When the buffer is
3318 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003319 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003320 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 This option is set for one command with ":hide {command}" |:hide|.
3322 WARNING: It's easy to forget that you have changes in hidden buffers.
3323 Think twice when using ":q!" or ":qa!".
3324
3325 *'highlight'* *'hl'*
3326'highlight' 'hl' string (default (as a single string):
3327 "8:SpecialKey,@:NonText,d:Directory,
3328 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3329 M:ModeMsg,n:LineNr,r:Question,
3330 s:StatusLine,S:StatusLineNC,c:VertSplit
3331 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3332 f:Folded,F:FoldColumn,A:DiffAdd,
3333 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003334 >:SignColumn,B:SpellBad,P:SpellCap,
3335 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 global
3337 {not in Vi}
3338 This option can be used to set highlighting mode for various
3339 occasions. It is a comma separated list of character pairs. The
3340 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003341 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3343 |hl-NonText| @ '~' and '@' at the end of the window and
3344 characters from 'showbreak'
3345 |hl-Directory| d directories in CTRL-D listing and other special
3346 things in listings
3347 |hl-ErrorMsg| e error messages
3348 h (obsolete, ignored)
3349 |hl-IncSearch| i 'incsearch' highlighting
3350 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3351 |hl-MoreMsg| m |more-prompt|
3352 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3353 |hl-LineNr| n line number for ":number" and ":#" commands
3354 |hl-Question| r |hit-enter| prompt and yes/no questions
3355 |hl-StatusLine| s status line of current window |status-line|
3356 |hl-StatusLineNC| S status lines of not-current windows
3357 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3358 |hl-VertSplit| c column used to separate vertically split windows
3359 |hl-Visual| v Visual mode
3360 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3361 Selection" Only X11 Gui's |gui-x11| and
3362 |xterm-clipboard|.
3363 |hl-WarningMsg| w warning messages
3364 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3365 |hl-Folded| f line used for closed folds
3366 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003367 |hl-DiffAdd| A added line in diff mode
3368 |hl-DiffChange| C changed line in diff mode
3369 |hl-DiffDelete| D deleted line in diff mode
3370 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003372 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003373 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003374 |hl-SpellRare| R rare word |spell|
3375 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
3377 The display modes are:
3378 r reverse (termcap entry "mr" and "me")
3379 i italic (termcap entry "ZH" and "ZR")
3380 b bold (termcap entry "md" and "me")
3381 s standout (termcap entry "so" and "se")
3382 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003383 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 n no highlighting
3385 - no highlighting
3386 : use a highlight group
3387 The default is used for occasions that are not included.
3388 If you want to change what the display modes do, see |dos-colors|
3389 for an example.
3390 When using the ':' display mode, this must be followed by the name of
3391 a highlight group. A highlight group can be used to define any type
3392 of highlighting, including using color. See |:highlight| on how to
3393 define one. The default uses a different group for each occasion.
3394 See |highlight-default| for the default highlight groups.
3395
3396 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3397'hlsearch' 'hls' boolean (default off)
3398 global
3399 {not in Vi}
3400 {not available when compiled without the
3401 |+extra_search| feature}
3402 When there is a previous search pattern, highlight all its matches.
3403 The type of highlighting used can be set with the 'l' occasion in the
3404 'highlight' option. This uses the "Search" highlight group by
3405 default. Note that only the matching text is highlighted, any offsets
3406 are not applied.
3407 See also: 'incsearch' and |:match|.
3408 When you get bored looking at the highlighted matches, you can turn it
3409 off with |:nohlsearch|. As soon as you use a search command, the
3410 highlighting comes back.
3411 When the search pattern can match an end-of-line, Vim will try to
3412 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003413 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 line below a closed fold. A match in a previous line which is not
3415 drawn may not continue in an newly drawn line.
3416 NOTE: This option is reset when 'compatible' is set.
3417
3418 *'history'* *'hi'*
3419'history' 'hi' number (Vim default: 20, Vi default: 0)
3420 global
3421 {not in Vi}
3422 A history of ":" commands, and a history of previous search patterns
3423 are remembered. This option decides how many entries may be stored in
3424 each of these histories (see |cmdline-editing|).
3425 NOTE: This option is set to the Vi default value when 'compatible' is
3426 set and to the Vim default value when 'compatible' is reset.
3427
3428 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3429'hkmap' 'hk' boolean (default off)
3430 global
3431 {not in Vi}
3432 {only available when compiled with the |+rightleft|
3433 feature}
3434 When on, the keyboard is mapped for the Hebrew character set.
3435 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3436 toggle this option. See |rileft.txt|.
3437 NOTE: This option is reset when 'compatible' is set.
3438
3439 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3440'hkmapp' 'hkp' boolean (default off)
3441 global
3442 {not in Vi}
3443 {only available when compiled with the |+rightleft|
3444 feature}
3445 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3446 This is useful if you have a non-Hebrew keyboard.
3447 See |rileft.txt|.
3448 NOTE: This option is reset when 'compatible' is set.
3449
3450 *'icon'* *'noicon'*
3451'icon' boolean (default off, on when title can be restored)
3452 global
3453 {not in Vi}
3454 {not available when compiled without the |+title|
3455 feature}
3456 When on, the icon text of the window will be set to the value of
3457 'iconstring' (if it is not empty), or to the name of the file
3458 currently being edited. Only the last part of the name is used.
3459 Overridden by the 'iconstring' option.
3460 Only works if the terminal supports setting window icons (currently
3461 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3462 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3463 builtin termcap).
3464 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003465 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 X11.
3467
3468 *'iconstring'*
3469'iconstring' string (default "")
3470 global
3471 {not in Vi}
3472 {not available when compiled without the |+title|
3473 feature}
3474 When this option is not empty, it will be used for the icon text of
3475 the window. This happens only when the 'icon' option is on.
3476 Only works if the terminal supports setting window icon text
3477 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3478 Does not work for MS Windows.
3479 When Vim was compiled with HAVE_X11 defined, the original icon will be
3480 restored if possible |X11|.
3481 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003482 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 'titlestring' for example settings.
3484 {not available when compiled without the |+statusline| feature}
3485
3486 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3487'ignorecase' 'ic' boolean (default off)
3488 global
3489 Ignore case in search patterns. Also used when searching in the tags
3490 file.
3491 Also see 'smartcase'.
3492 Can be overruled by using "\c" or "\C" in the pattern, see
3493 |/ignorecase|.
3494
3495 *'imactivatekey'* *'imak'*
3496'imactivatekey' 'imak' string (default "")
3497 global
3498 {not in Vi}
3499 {only available when compiled with |+xim| and
3500 |+GUI_GTK|}
3501 Specifies the key that your Input Method in X-Windows uses for
3502 activation. When this is specified correctly, vim can fully control
3503 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3504 You can't use this option to change the activation key, the option
3505 tells Vim what the key is.
3506 Format:
3507 [MODIFIER_FLAG-]KEY_STRING
3508
3509 These characters can be used for MODIFIER_FLAG (case is ignored):
3510 S Shift key
3511 L Lock key
3512 C Control key
3513 1 Mod1 key
3514 2 Mod2 key
3515 3 Mod3 key
3516 4 Mod4 key
3517 5 Mod5 key
3518 Combinations are allowed, for example "S-C-space" or "SC-space" are
3519 both shift+ctrl+space.
3520 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3521
3522 Example: >
3523 :set imactivatekey=S-space
3524< "S-space" means shift+space. This is the activation key for kinput2 +
3525 canna (Japanese), and ami (Korean).
3526
3527 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3528'imcmdline' 'imc' boolean (default off)
3529 global
3530 {not in Vi}
3531 {only available when compiled with the |+xim|
3532 |+multi_byte_ime| or |global-ime| feature}
3533 When set the Input Method is always on when starting to edit a command
3534 line, unless entering a search pattern (see 'imsearch' for that).
3535 Setting this option is useful when your input method allows entering
3536 English characters directly, e.g., when it's used to type accented
3537 characters with dead keys.
3538
3539 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3540'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3541 global
3542 {not in Vi}
3543 {only available when compiled with the |+xim|
3544 |+multi_byte_ime| or |global-ime| feature}
3545 When set the Input Method is never used. This is useful to disable
3546 the IM when it doesn't work properly.
3547 Currently this option is on by default for SGI/IRIX machines. This
3548 may change in later releases.
3549
3550 *'iminsert'* *'imi'*
3551'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3552 local to buffer
3553 {not in Vi}
3554 Specifies whether :lmap or an Input Method (IM) is to be used in
3555 Insert mode. Valid values:
3556 0 :lmap is off and IM is off
3557 1 :lmap is ON and IM is off
3558 2 :lmap is off and IM is ON
3559 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3560 or |global-ime|.
3561 To always reset the option to zero when leaving Insert mode with <Esc>
3562 this can be used: >
3563 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3564< This makes :lmap and IM turn off automatically when leaving Insert
3565 mode.
3566 Note that this option changes when using CTRL-^ in Insert mode
3567 |i_CTRL-^|.
3568 The value is set to 1 when setting 'keymap' to a valid keymap name.
3569 It is also used for the argument of commands like "r" and "f".
3570 The value 0 may not work correctly with Athena and Motif with some XIM
3571 methods. Use 'imdisable' to disable XIM then.
3572
3573 *'imsearch'* *'ims'*
3574'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3575 local to buffer
3576 {not in Vi}
3577 Specifies whether :lmap or an Input Method (IM) is to be used when
3578 entering a search pattern. Valid values:
3579 -1 the value of 'iminsert' is used, makes it look like
3580 'iminsert' is also used when typing a search pattern
3581 0 :lmap is off and IM is off
3582 1 :lmap is ON and IM is off
3583 2 :lmap is off and IM is ON
3584 Note that this option changes when using CTRL-^ in Command-line mode
3585 |c_CTRL-^|.
3586 The value is set to 1 when it is not -1 and setting the 'keymap'
3587 option to a valid keymap name.
3588 The value 0 may not work correctly with Athena and Motif with some XIM
3589 methods. Use 'imdisable' to disable XIM then.
3590
3591 *'include'* *'inc'*
3592'include' 'inc' string (default "^\s*#\s*include")
3593 global or local to buffer |global-local|
3594 {not in Vi}
3595 {not available when compiled without the
3596 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003597 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 pattern, just like for the "/" command (See |pattern|). The default
3599 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003600 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 name that comes after the matched pattern. See |option-backslash|
3602 about including spaces and backslashes.
3603
3604 *'includeexpr'* *'inex'*
3605'includeexpr' 'inex' string (default "")
3606 local to buffer
3607 {not in Vi}
3608 {not available when compiled without the
3609 |+find_in_path| or |+eval| feature}
3610 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003611 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 :set includeexpr=substitute(v:fname,'\\.','/','g')
3613< The "v:fname" variable will be set to the file name that was detected.
3614 Evaluated in the |sandbox|.
3615 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003616 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003617 Also used for |<cfile>|.
3618
3619 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3620'incsearch' 'is' boolean (default off)
3621 global
3622 {not in Vi}
3623 {not available when compiled without the
3624 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003625 While typing a search command, show where the pattern, as it was typed
3626 so far, matches. The matched string is highlighted. If the pattern
3627 is invalid or not found, nothing is shown. The screen will be updated
3628 often, this is only useful on fast terminals.
3629 Note that the match will be shown, but the cursor will return to its
3630 original position when no match is found and when pressing <Esc>. You
3631 still need to finish the search command with <Enter> to move the
3632 cursor to the match.
3633 The highlighting can be set with the 'i' flag in 'highlight'.
3634 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 NOTE: This option is reset when 'compatible' is set.
3636
3637 *'indentexpr'* *'inde'*
3638'indentexpr' 'inde' string (default "")
3639 local to buffer
3640 {not in Vi}
3641 {not available when compiled without the |+cindent|
3642 or |+eval| features}
3643 Expression which is evaluated to obtain the proper indent for a line.
3644 It is used when a new line is created, for the |=| operator and
3645 in Insert mode as specified with the 'indentkeys' option.
3646 When this option is not empty, it overrules the 'cindent' and
3647 'smartindent' indenting.
3648 When 'paste' is set this option is not used for indenting.
3649 The expression is evaluated with |v:lnum| set to the line number for
3650 which the indent is to be computed. The cursor is also as this line
3651 when the expression is evaluated (but it may be moved around).
3652 The expression must return the number of spaces worth of indent. It
3653 can return "-1" to keep the current indent (this means 'autoindent' is
3654 used for the indent).
3655 Functions useful for computing the indent are |indent()|, |cindent()|
3656 and |lispindent()|.
3657 The evaluation of the expression must not have side effects! It must
3658 not change the text, jump to another window, etc. Afterwards the
3659 cursor position is always restored, thus the cursor may be moved.
3660 Normally this option would be set to call a function: >
3661 :set indentexpr=GetMyIndent()
3662< Error messages will be suppressed, unless the 'debug' option contains
3663 "msg".
3664 See |indent-expression|. Also see |eval-sandbox|.
3665 NOTE: This option is made empty when 'compatible' is set.
3666
3667 *'indentkeys'* *'indk'*
3668'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3669 local to buffer
3670 {not in Vi}
3671 {not available when compiled without the |+cindent|
3672 feature}
3673 A list of keys that, when typed in Insert mode, cause reindenting of
3674 the current line. Only happens if 'indentexpr' isn't empty.
3675 The format is identical to 'cinkeys', see |indentkeys-format|.
3676 See |C-indenting| and |indent-expression|.
3677
3678 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3679'infercase' 'inf' boolean (default off)
3680 local to buffer
3681 {not in Vi}
3682 When doing keyword completion in insert mode |ins-completion|, and
3683 'ignorecase' is also on, the case of the match is adjusted. If the
3684 typed text contains a lowercase letter where the match has an upper
3685 case letter, the completed part is made lowercase. If the typed text
3686 has no lowercase letters and the match has a lowercase letter where
3687 the typed text has an uppercase letter, and there is a letter before
3688 it, the completed part is made uppercase.
3689
3690 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3691'insertmode' 'im' boolean (default off)
3692 global
3693 {not in Vi}
3694 Makes Vim work in a way that Insert mode is the default mode. Useful
3695 if you want to use Vim as a modeless editor. Used for |evim|.
3696 These Insert mode commands will be useful:
3697 - Use the cursor keys to move around.
3698 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3699 this is a mapping, it is executed as if 'insertmode' was off.
3700 Normal mode remains active until the mapping is finished.
3701 *i_CTRL-L*
3702 - Use CTRL-L to execute a number of Normal mode commands, then use
3703 <Esc> to get back to Insert mode.
3704
3705 These items change when 'insertmode' is set:
3706 - when starting to edit of a file, Vim goes to Insert mode.
3707 - <Esc> in Insert mode is a no-op and beeps.
3708 - <Esc> in Normal mode makes Vim go to Insert mode.
3709 - CTRL-L in Insert mode is a command, it is not inserted.
3710 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3711 However, when <Esc> is used inside a mapping, it behaves like
3712 'insertmode' was not set. This was done to be able to use the same
3713 mappings with 'insertmode' set or not set.
3714 When executing commands with |:normal| 'insertmode' is not used.
3715
3716 NOTE: This option is reset when 'compatible' is set.
3717
3718 *'isfname'* *'isf'*
3719'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3720 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3721 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3722 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3723 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3724 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3725 global
3726 {not in Vi}
3727 The characters specified by this option are included in file names and
3728 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003729 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 Multi-byte characters 256 and above are always included, only the
3731 characters up to 255 are specified with this option.
3732 For UTF-8 the characters 0xa0 to 0xff are included as well.
3733
3734 Note that on systems using a backslash as path separator, Vim tries to
3735 do its best to make it work as you would expect. That is a bit
3736 tricky, since Vi originally used the backslash to escape special
3737 characters. Vim will not remove a backslash in front of a normal file
3738 name character on these systems, but it will on Unix and alikes. The
3739 '&' and '^' are not included by default, because these are special for
3740 cmd.exe.
3741
3742 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003743 Each part can be a single character number or a range. A range is two
3744 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003745 decimal number between 0 and 255 or the ASCII character itself (does
3746 not work for digits). Example:
3747 "_,-,128-140,#-43" (include '_' and '-' and the range
3748 128 to 140 and '#' to 43)
3749 If a part starts with '^', the following character number or range
3750 will be excluded from the option. The option is interpreted from left
3751 to right. Put the excluded character after the range where it is
3752 included. To include '^' itself use it as the last character of the
3753 option or the end of a range. Example:
3754 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3755 If the character is '@', all characters where isalpha() returns TRUE
3756 are included. Normally these are the characters a to z and A to Z,
3757 plus accented characters. To include '@' itself use "@-@". Examples:
3758 "@,^a-z" All alphabetic characters, excluding lower
3759 case letters.
3760 "a-z,A-Z,@-@" All letters plus the '@' character.
3761 A comma can be included by using it where a character number is
3762 expected. Example:
3763 "48-57,,,_" Digits, comma and underscore.
3764 A comma can be excluded by prepending a '^'. Example:
3765 " -~,^,,9" All characters from space to '~', excluding
3766 comma, plus <Tab>.
3767 See |option-backslash| about including spaces and backslashes.
3768
3769 *'isident'* *'isi'*
3770'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3771 "@,48-57,_,128-167,224-235"
3772 otherwise: "@,48-57,_,192-255")
3773 global
3774 {not in Vi}
3775 The characters given by this option are included in identifiers.
3776 Identifiers are used in recognizing environment variables and after a
3777 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003778 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 option.
3780 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003781 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3783
3784 *'iskeyword'* *'isk'*
3785'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3786 "@,48-57,_,128-167,224-235"
3787 otherwise: "@,48-57,_,192-255"
3788 Vi default: "@,48-57,_")
3789 local to buffer
3790 {not in Vi}
3791 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003792 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 'isfname' for a description of the format of this option. For C
3794 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3795 For a help file it is set to all non-blank printable characters except
3796 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3797 command).
3798 When the 'lisp' option is on the '-' character is always included.
3799 NOTE: This option is set to the Vi default value when 'compatible' is
3800 set and to the Vim default value when 'compatible' is reset.
3801
3802 *'isprint'* *'isp'*
3803'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3804 "@,~-255"; otherwise: "@,161-255")
3805 global
3806 {not in Vi}
3807 The characters given by this option are displayed directly on the
3808 screen. It is also used for "\p" in a |pattern|. The characters from
3809 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3810 even when they are not included in 'isprint' or excluded. See
3811 'isfname' for a description of the format of this option.
3812
3813 Non-printable characters are displayed with two characters:
3814 0 - 31 "^@" - "^_"
3815 32 - 126 always single characters
3816 127 "^?"
3817 128 - 159 "~@" - "~_"
3818 160 - 254 "| " - "|~"
3819 255 "~?"
3820 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3821 displayed as <xx>, with the hexadecimal value of the byte.
3822 When 'display' contains "uhex" all unprintable characters are
3823 displayed as <xx>.
3824 The NonText highlighting will be used for unprintable characters.
3825 |hl-NonText|
3826
3827 Multi-byte characters 256 and above are always included, only the
3828 characters up to 255 are specified with this option. When a character
3829 is printable but it is not available in the current font, a
3830 replacement character will be shown.
3831 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3832 There is no option to specify these characters.
3833
3834 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3835'joinspaces' 'js' boolean (default on)
3836 global
3837 {not in Vi}
3838 Insert two spaces after a '.', '?' and '!' with a join command.
3839 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3840 Otherwise only one space is inserted.
3841 NOTE: This option is set when 'compatible' is set.
3842
3843 *'key'*
3844'key' string (default "")
3845 local to buffer
3846 {not in Vi}
3847 The key that is used for encrypting and decrypting the current buffer.
3848 See |encryption|.
3849 Careful: Do not set the key value by hand, someone might see the typed
3850 key. Use the |:X| command. But you can make 'key' empty: >
3851 :set key=
3852< It is not possible to get the value of this option with ":set key" or
3853 "echo &key". This is to avoid showing it to someone who shouldn't
3854 know. It also means you cannot see it yourself once you have set it,
3855 be careful not to make a typing error!
3856
3857 *'keymap'* *'kmp'* *E544*
3858'keymap' 'kmp' string (default "")
3859 local to buffer
3860 {not in Vi}
3861 {only available when compiled with the |+keymap|
3862 feature}
3863 Name of a keyboard mapping. See |mbyte-keymap|.
3864 Setting this option to a valid keymap name has the side effect of
3865 setting 'iminsert' to one, so that the keymap becomes effective.
3866 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003867 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868
3869 *'keymodel'* *'km'*
3870'keymodel' 'km' string (default "")
3871 global
3872 {not in Vi}
3873 List of comma separated words, which enable special things that keys
3874 can do. These values can be used:
3875 startsel Using a shifted special key starts selection (either
3876 Select mode or Visual mode, depending on "key" being
3877 present in 'selectmode').
3878 stopsel Using a not-shifted special key stops selection.
3879 Special keys in this context are the cursor keys, <End>, <Home>,
3880 <PageUp> and <PageDown>.
3881 The 'keymodel' option is set by the |:behave| command.
3882
3883 *'keywordprg'* *'kp'*
3884'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3885 OS/2: "view /", VMS: "help")
3886 global or local to buffer |global-local|
3887 {not in Vi}
3888 Program to use for the |K| command. Environment variables are
3889 expanded |:set_env|. ":help" may be used to access the Vim internal
3890 help. (Note that previously setting the global option to the empty
3891 value did this, which is now deprecated.)
3892 When "man" is used, Vim will automatically translate a count for the
3893 "K" command to a section number. Also for "man -s", in which case the
3894 "-s" is removed when there is no count.
3895 See |option-backslash| about including spaces and backslashes.
3896 Example: >
3897 :set keywordprg=man\ -s
3898< This option cannot be set from a |modeline| or in the |sandbox|, for
3899 security reasons.
3900
3901 *'langmap'* *'lmap'* *E357* *E358*
3902'langmap' 'lmap' string (default "")
3903 global
3904 {not in Vi}
3905 {only available when compiled with the |+langmap|
3906 feature}
3907 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003908 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 inserted directly. When in command mode the 'langmap' option takes
3910 care of translating these special characters to the original meaning
3911 of the key. This means you don't have to change the keyboard mode to
3912 be able to execute Normal mode commands.
3913 This is the opposite of the 'keymap' option, where characters are
3914 mapped in Insert mode.
3915 This only works for 8-bit characters. The value of 'langmap' may be
3916 specified with multi-byte characters (e.g., UTF-8), but only the lower
3917 8 bits of each character will be used.
3918
3919 Example (for Greek): *greek* >
3920 :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
3921< Example (exchanges meaning of z and y for commands): >
3922 :set langmap=zy,yz,ZY,YZ
3923<
3924 The 'langmap' option is a list of parts, separated with commas. Each
3925 part can be in one of two forms:
3926 1. A list of pairs. Each pair is a "from" character immediately
3927 followed by the "to" character. Examples: "aA", "aAbBcC".
3928 2. A list of "from" characters, a semi-colon and a list of "to"
3929 characters. Example: "abc;ABC"
3930 Example: "aA,fgh;FGH,cCdDeE"
3931 Special characters need to be preceded with a backslash. These are
3932 ";", ',' and backslash itself.
3933
3934 This will allow you to activate vim actions without having to switch
3935 back and forth between the languages. Your language characters will
3936 be understood as normal vim English characters (according to the
3937 langmap mappings) in the following cases:
3938 o Normal/Visual mode (commands, buffer/register names, user mappings)
3939 o Insert/Replace Mode: Register names after CTRL-R
3940 o Insert/Replace Mode: Mappings
3941 Characters entered in Command-line mode will NOT be affected by
3942 this option. Note that this option can be changed at any time
3943 allowing to switch between mappings for different languages/encodings.
3944 Use a mapping to avoid having to type it each time!
3945
3946 *'langmenu'* *'lm'*
3947'langmenu' 'lm' string (default "")
3948 global
3949 {not in Vi}
3950 {only available when compiled with the |+menu| and
3951 |+multi_lang| features}
3952 Language to use for menu translation. Tells which file is loaded
3953 from the "lang" directory in 'runtimepath': >
3954 "lang/menu_" . &langmenu . ".vim"
3955< (without the spaces). For example, to always use the Dutch menus, no
3956 matter what $LANG is set to: >
3957 :set langmenu=nl_NL.ISO_8859-1
3958< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003959 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 If your $LANG is set to a non-English language but you do want to use
3961 the English menus: >
3962 :set langmenu=none
3963< This option must be set before loading menus, switching on filetype
3964 detection or syntax highlighting. Once the menus are defined setting
3965 this option has no effect. But you could do this: >
3966 :source $VIMRUNTIME/delmenu.vim
3967 :set langmenu=de_DE.ISO_8859-1
3968 :source $VIMRUNTIME/menu.vim
3969< Warning: This deletes all menus that you defined yourself!
3970
3971 *'laststatus'* *'ls'*
3972'laststatus' 'ls' number (default 1)
3973 global
3974 {not in Vi}
3975 The value of this option influences when the last window will have a
3976 status line:
3977 0: never
3978 1: only if there are at least two windows
3979 2: always
3980 The screen looks nicer with a status line if you have several
3981 windows, but it takes another screen line. |status-line|
3982
3983 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
3984'lazyredraw' 'lz' boolean (default off)
3985 global
3986 {not in Vi}
3987 When this option is set, the screen will not be redrawn while
3988 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003989 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 update use |:redraw|.
3991
3992 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
3993'linebreak' 'lbr' boolean (default off)
3994 local to window
3995 {not in Vi}
3996 {not available when compiled without the |+linebreak|
3997 feature}
3998 If on Vim will wrap long lines at a character in 'breakat' rather
3999 than at the last character that fits on the screen. Unlike
4000 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4001 it only affects the way the file is displayed, not its contents. The
4002 value of 'showbreak' is used to put in front of wrapped lines.
4003 This option is not used when the 'wrap' option is off or 'list' is on.
4004 Note that <Tab> characters after an <EOL> are mostly not displayed
4005 with the right amount of white space.
4006
4007 *'lines'* *E593*
4008'lines' number (default 24 or terminal height)
4009 global
4010 Number of lines of the Vim window.
4011 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004012 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013 When Vim is running in the GUI or in a resizable window, setting this
4014 option will cause the window size to be changed. When you only want
4015 to use the size for the GUI, put the command in your |gvimrc| file.
4016 Vim limits the number of lines to what fits on the screen. You can
4017 use this command to get the tallest window possible: >
4018 :set lines=999
4019< If you get less lines than expected, check the 'guiheadroom' option.
4020 When you set this option and Vim is unable to change the physical
4021 number of lines of the display, the display may be messed up.
4022
4023 *'linespace'* *'lsp'*
4024'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4025 global
4026 {not in Vi}
4027 {only in the GUI}
4028 Number of pixel lines inserted between characters. Useful if the font
4029 uses the full character cell height, making lines touch each other.
4030 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004031 With some fonts there can be too much room between lines (to have
4032 space for ascents and descents). Then it makes sense to set
4033 'linespace' to a negative value. This may cause display problems
4034 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035
4036 *'lisp'* *'nolisp'*
4037'lisp' boolean (default off)
4038 local to buffer
4039 {not available when compiled without the |+lispindent|
4040 feature}
4041 Lisp mode: When <Enter> is typed in insert mode set the indent for
4042 the next line to Lisp standards (well, sort of). Also happens with
4043 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4044 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4045 better. Also see 'lispwords'.
4046 The '-' character is included in keyword characters. Redefines the
4047 "=" operator to use this same indentation algorithm rather than
4048 calling an external program if 'equalprg' is empty.
4049 This option is not used when 'paste' is set.
4050 {Vi: Does it a little bit differently}
4051
4052 *'lispwords'* *'lw'*
4053'lispwords' 'lw' string (default is very long)
4054 global
4055 {not in Vi}
4056 {not available when compiled without the |+lispindent|
4057 feature}
4058 Comma separated list of words that influence the Lisp indenting.
4059 |'lisp'|
4060
4061 *'list'* *'nolist'*
4062'list' boolean (default off)
4063 local to window
4064 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4065 see the difference between tabs and spaces and for trailing blanks.
4066 Note that this will also affect formatting (set with 'textwidth' or
4067 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4068 changing the way tabs are displayed.
4069
4070 *'listchars'* *'lcs'*
4071'listchars' 'lcs' string (default "eol:$")
4072 global
4073 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004074 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 settings.
4076 eol:c Character to show at the end of each line. When
4077 omitted, there is no extra character at the end of the
4078 line.
4079 tab:xy Two characters to be used to show a Tab. The first
4080 char is used once. The second char is repeated to
4081 fill the space that the Tab normally occupies.
4082 "tab:>-" will show a Tab that takes four spaces as
4083 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004084 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 trailing spaces are blank.
4086 extends:c Character to show in the last column, when 'wrap' is
4087 off and the line continues beyond the right of the
4088 screen.
4089 precedes:c Character to show in the first column, when 'wrap'
4090 is off and there is text preceding the character
4091 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004092 nbsp:c Character to show for a non-breakable space (character
4093 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004095 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004096 be used when 'encoding' is "utf-8", otherwise only printable
4097 characters are allowed.
4098
4099 Examples: >
4100 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004101 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 :set lcs=extends:>,precedes:<
4103< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004104 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105
4106 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4107'loadplugins' 'lpl' boolean (default on)
4108 global
4109 {not in Vi}
4110 When on the plugin scripts are loaded when starting up |load-plugins|.
4111 This option can be reset in your |vimrc| file to disable the loading
4112 of plugins.
4113 Note that using the "-u NONE" and "--noplugin" command line arguments
4114 reset this option. |-u| |--noplugin|
4115
4116 *'magic'* *'nomagic'*
4117'magic' boolean (default on)
4118 global
4119 Changes the special characters that can be used in search patterns.
4120 See |pattern|.
4121 NOTE: To avoid portability problems with using patterns, always keep
4122 this option at the default "on". Only switch it off when working with
4123 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004124 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125
4126 *'makeef'* *'mef'*
4127'makeef' 'mef' string (default: "")
4128 global
4129 {not in Vi}
4130 {not available when compiled without the |+quickfix|
4131 feature}
4132 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4133 and the |:grep| command.
4134 When it is empty, an internally generated temp file will be used.
4135 When "##" is included, it is replaced by a number to make the name
4136 unique. This makes sure that the ":make" command doesn't overwrite an
4137 existing file.
4138 NOT used for the ":cf" command. See 'errorfile' for that.
4139 Environment variables are expanded |:set_env|.
4140 See |option-backslash| about including spaces and backslashes.
4141 This option cannot be set from a |modeline| or in the |sandbox|, for
4142 security reasons.
4143
4144 *'makeprg'* *'mp'*
4145'makeprg' 'mp' string (default "make", VMS: "MMS")
4146 global or local to buffer |global-local|
4147 {not in Vi}
4148 Program to use for the ":make" command. See |:make_makeprg|. This
4149 option may contain '%' and '#' characters, which are expanded like
4150 when used in a command-line. Environment variables are expanded
4151 |:set_env|. See |option-backslash| about including spaces and
4152 backslashes. Note that a '|' must be escaped twice: once for ":set"
4153 and once for the interpretation of a command. When you use a filter
4154 called "myfilter" do it like this: >
4155 :set makeprg=gmake\ \\\|\ myfilter
4156< The placeholder "$*" can be given (even multiple times) to specify
4157 where the arguments will be included, for example: >
4158 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4159< This option cannot be set from a |modeline| or in the |sandbox|, for
4160 security reasons.
4161
4162 *'matchpairs'* *'mps'*
4163'matchpairs' 'mps' string (default "(:),{:},[:]")
4164 local to buffer
4165 {not in Vi}
4166 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004167 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 must be different. The characters must be separated by a colon. The
4169 pairs must be separated by a comma. Example for including '<' and '>'
4170 (HTML): >
4171 :set mps+=<:>
4172
4173< A more exotic example, to jump between the '=' and ';' in an
4174 assignment, useful for languages like C and Java: >
4175 :au FileType c,cpp,java set mps+==:;
4176
4177< For a more advanced way of using "%", see the matchit.vim plugin in
4178 the $VIMRUNTIME/macros directory. |add-local-help|
4179
4180 *'matchtime'* *'mat'*
4181'matchtime' 'mat' number (default 5)
4182 global
4183 {not in Vi}{in Nvi}
4184 Tenths of a second to show the matching paren, when 'showmatch' is
4185 set. Note that this is not in milliseconds, like other options that
4186 set a time. This is to be compatible with Nvi.
4187
4188 *'maxfuncdepth'* *'mfd'*
4189'maxfuncdepth' 'mfd' number (default 100)
4190 global
4191 {not in Vi}
4192 Maximum depth of function calls for user functions. This normally
4193 catches endless recursion. When using a recursive function with
4194 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4195 more memory, there is the danger of failing when memory is exhausted.
4196 See also |:function|.
4197
4198 *'maxmapdepth'* *'mmd'* *E223*
4199'maxmapdepth' 'mmd' number (default 1000)
4200 global
4201 {not in Vi}
4202 Maximum number of times a mapping is done without resulting in a
4203 character to be used. This normally catches endless mappings, like
4204 ":map x y" with ":map y x". It still does not catch ":map g wg",
4205 because the 'w' is used before the next mapping is done. See also
4206 |key-mapping|.
4207
4208 *'maxmem'* *'mm'*
4209'maxmem' 'mm' number (default between 256 to 5120 (system
4210 dependent) or half the amount of memory
4211 available)
4212 global
4213 {not in Vi}
4214 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4215 limit is reached allocating extra memory for a buffer will cause
4216 other memory to be freed. Maximum value 2000000. Use this to work
4217 without a limit. Also see 'maxmemtot'.
4218
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004219 *'maxmempattern'* *'mmp'*
4220'maxmempattern' 'mmp' number (default 1000)
4221 global
4222 {not in Vi}
4223 Maximum amount of memory (in Kbyte) to use for pattern matching.
4224 Maximum value 2000000. Use this to work without a limit.
4225 *E363*
4226 When Vim runs into the limit it gives an error message mostly behaves
4227 like CTRL-C was typed.
4228 Running into the limit often means that the pattern is very
4229 inefficient or too complex. This may already happen with the pattern
4230 "\(.\)*" on a very long line. ".*" works much better.
4231 Vim may run out of memory before hitting the 'maxmempattern' limit.
4232
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 *'maxmemtot'* *'mmt'*
4234'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4235 dependent) or half the amount of memory
4236 available)
4237 global
4238 {not in Vi}
4239 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004240 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241 'maxmem'.
4242
4243 *'menuitems'* *'mis'*
4244'menuitems' 'mis' number (default 25)
4245 global
4246 {not in Vi}
4247 {not available when compiled without the |+menu|
4248 feature}
4249 Maximum number of items to use in a menu. Used for menus that are
4250 generated from a list of items, e.g., the Buffers menu. Changing this
4251 option has no direct effect, the menu must be refreshed first.
4252
4253 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4254'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4255 local to buffer
4256 *'modelines'* *'mls'*
4257'modelines' 'mls' number (default 5)
4258 global
4259 {not in Vi}
4260 If 'modeline' is on 'modelines' gives the number of lines that is
4261 checked for set commands. If 'modeline' is off or 'modelines' is zero
4262 no lines are checked. See |modeline|.
4263 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4264 set and to the Vim default value when 'compatible' is reset.
4265
4266 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4267'modifiable' 'ma' boolean (default on)
4268 local to buffer
4269 {not in Vi} *E21*
4270 When off the buffer contents cannot be changed. The 'fileformat' and
4271 'fileencoding' options also can't be changed.
4272 Can be reset with the |-M| command line argument.
4273
4274 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4275'modified' 'mod' boolean (default off)
4276 local to buffer
4277 {not in Vi}
4278 When on, the buffer is considered to be modified. This option is set
4279 when:
4280 1. A change was made to the text since it was last written. Using the
4281 |undo| command to go back to the original text will reset the
4282 option. But undoing changes that were made before writing the
4283 buffer will set the option again, since the text is different from
4284 when it was written.
4285 2. 'fileformat' or 'fileencoding' is different from its original
4286 value. The original value is set when the buffer is read or
4287 written. A ":set nomodified" command also resets the original
4288 values to the current values and the 'modified' option will be
4289 reset.
4290 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4291 will be ignored.
4292
4293 *'more'* *'nomore'*
4294'more' boolean (Vim default: on, Vi default: off)
4295 global
4296 {not in Vi}
4297 When on, listings pause when the whole screen is filled. You will get
4298 the |more-prompt|. When this option is off there are no pauses, the
4299 listing continues until finished.
4300 NOTE: This option is set to the Vi default value when 'compatible' is
4301 set and to the Vim default value when 'compatible' is reset.
4302
4303 *'mouse'* *E538*
4304'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4305 global
4306 {not in Vi}
4307 Enable the use of the mouse. Only works for certain terminals
4308 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4309 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4310 The mouse can be enabled for different modes:
4311 n Normal mode
4312 v Visual mode
4313 i Insert mode
4314 c Command-line mode
4315 h all previous modes when editing a help file
4316 a all previous modes
4317 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 Normally you would enable the mouse in all four modes with: >
4319 :set mouse=a
4320< When the mouse is not enabled, the GUI will still use the mouse for
4321 modeless selection. This doesn't move the text cursor.
4322
4323 See |mouse-using|. Also see |'clipboard'|.
4324
4325 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004326 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 the mouse buttons can still be used by keeping the shift key pressed.
4328 Also see the 'clipboard' option.
4329
4330 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4331'mousefocus' 'mousef' boolean (default off)
4332 global
4333 {not in Vi}
4334 {only works in the GUI}
4335 The window that the mouse pointer is on is automatically activated.
4336 When changing the window layout or window focus in another way, the
4337 mouse pointer is moved to the window with keyboard focus. Off is the
4338 default because it makes using the pull down menus a little goofy, as
4339 a pointer transit may activate a window unintentionally.
4340
4341 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4342'mousehide' 'mh' boolean (default on)
4343 global
4344 {not in Vi}
4345 {only works in the GUI}
4346 When on, the mouse pointer is hidden when characters are typed.
4347 The mouse pointer is restored when the mouse is moved.
4348
4349 *'mousemodel'* *'mousem'*
4350'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4351 global
4352 {not in Vi}
4353 Sets the model to use for the mouse. The name mostly specifies what
4354 the right mouse button is used for:
4355 extend Right mouse button extends a selection. This works
4356 like in an xterm.
4357 popup Right mouse button pops up a menu. The shifted left
4358 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004359 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 popup_setpos Like "popup", but the cursor will be moved to the
4361 position where the mouse was clicked, and thus the
4362 selected operation will act upon the clicked object.
4363 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004364 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 course, that right clicking outside a selection will
4366 end Visual mode.
4367 Overview of what button does what for each model:
4368 mouse extend popup(_setpos) ~
4369 left click place cursor place cursor
4370 left drag start selection start selection
4371 shift-left search word extend selection
4372 right click extend selection popup menu (place cursor)
4373 right drag extend selection -
4374 middle click paste paste
4375
4376 In the "popup" model the right mouse button produces a pop-up menu.
4377 You need to define this first, see |popup-menu|.
4378
4379 Note that you can further refine the meaning of buttons with mappings.
4380 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4381 selection (because that's handled in the GUI code directly).
4382
4383 The 'mousemodel' option is set by the |:behave| command.
4384
4385 *'mouseshape'* *'mouses'* *E547*
4386'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004387 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 global
4389 {not in Vi}
4390 {only available when compiled with the |+mouseshape|
4391 feature}
4392 This option tells Vim what the mouse pointer should look like in
4393 different modes. The option is a comma separated list of parts, much
4394 like used for 'guicursor'. Each part consist of a mode/location-list
4395 and an argument-list:
4396 mode-list:shape,mode-list:shape,..
4397 The mode-list is a dash separated list of these modes/locations:
4398 In a normal window: ~
4399 n Normal mode
4400 v Visual mode
4401 ve Visual mode with 'selection' "exclusive" (same as 'v',
4402 if not specified)
4403 o Operator-pending mode
4404 i Insert mode
4405 r Replace mode
4406
4407 Others: ~
4408 c appending to the command-line
4409 ci inserting in the command-line
4410 cr replacing in the command-line
4411 m at the 'Hit ENTER' or 'More' prompts
4412 ml idem, but cursor in the last line
4413 e any mode, pointer below last window
4414 s any mode, pointer on a status line
4415 sd any mode, while dragging a status line
4416 vs any mode, pointer on a vertical separator line
4417 vd any mode, while dragging a vertical separator line
4418 a everywhere
4419
4420 The shape is one of the following:
4421 avail name looks like ~
4422 w x arrow Normal mouse pointer
4423 w x blank no pointer at all (use with care!)
4424 w x beam I-beam
4425 w x updown up-down sizing arrows
4426 w x leftright left-right sizing arrows
4427 w x busy The system's usual busy pointer
4428 w x no The system's usual 'no input' pointer
4429 x udsizing indicates up-down resizing
4430 x lrsizing indicates left-right resizing
4431 x crosshair like a big thin +
4432 x hand1 black hand
4433 x hand2 white hand
4434 x pencil what you write with
4435 x question big ?
4436 x rightup-arrow arrow pointing right-up
4437 w x up-arrow arrow pointing up
4438 x <number> any X11 pointer number (see X11/cursorfont.h)
4439
4440 The "avail" column contains a 'w' if the shape is available for Win32,
4441 x for X11.
4442 Any modes not specified or shapes not available use the normal mouse
4443 pointer.
4444
4445 Example: >
4446 :set mouseshape=s:udsizing,m:no
4447< will make the mouse turn to a sizing arrow over the status lines and
4448 indicate no input when the hit-enter prompt is displayed (since
4449 clicking the mouse has no effect in this state.)
4450
4451 *'mousetime'* *'mouset'*
4452'mousetime' 'mouset' number (default 500)
4453 global
4454 {not in Vi}
4455 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4456 time in msec between two mouse clicks for the second click to be
4457 recognized as a multi click.
4458
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004459 *'mzquantum'* *'mzq'*
4460'mzquantum' 'mzq' number (default 100)
4461 global
4462 {not in Vi}
4463 {not available when compiled without the |+mzscheme|
4464 feature}
4465 The number of milliseconds between polls for MzScheme threads.
4466 Negative or zero value means no thread scheduling.
4467
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 *'nrformats'* *'nf'*
4469'nrformats' 'nf' string (default "octal,hex")
4470 local to buffer
4471 {not in Vi}
4472 This defines what bases Vim will consider for numbers when using the
4473 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4474 respectively; see |CTRL-A| for more info on these commands.
4475 alpha if included, single alphabetical characters will be
4476 incremented or decremented. This is useful for a list with a
4477 letter index a), b), etc.
4478 octal if included, numbers that start with a zero will be considered
4479 to be octal. Example: Using CTRL-A on "007" results in "010".
4480 hex if included, numbers starting with "0x" or "0X" will be
4481 considered to be hexadecimal. Example: Using CTRL-X on
4482 "0x100" results in "0x0ff".
4483 Numbers which simply begin with a digit in the range 1-9 are always
4484 considered decimal. This also happens for numbers that are not
4485 recognized as octal or hex.
4486
4487 *'number'* *'nu'* *'nonumber'* *'nonu'*
4488'number' 'nu' boolean (default off)
4489 local to window
4490 Print the line number in front of each line. When the 'n' option is
4491 excluded from 'cpoptions' a wrapped line will not use the column of
4492 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004493 The 'numberwidth' option can be used to set the room used for the line
4494 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 When a long, wrapped line doesn't start with the first character, '-'
4496 characters are put before the number.
4497 See |hl-LineNr| for the highlighting used for the number.
4498
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004499 *'numberwidth'* *'nuw'*
4500'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4501 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004502 {not in Vi}
4503 {only available when compiled with the |+linebreak|
4504 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004505 Minimal number of columns to use for the line number. Only relevant
4506 when the 'number' option is set.
4507 Since one space is always between the number and the text, there is
4508 one less character for the number itself.
4509 The value is the minimum width. A bigger width is used when needed to
4510 fit the highest line number in the buffer. Thus with the Vim default
4511 of 4 there is room for a line number up to 999. When the buffer has
4512 1000 lines five columns will be used.
4513 The minimum value is 1, the maximum value is 10.
4514 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4515
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 *'osfiletype'* *'oft'* *E366*
4517'osfiletype' 'oft' string (RISC-OS default: "Text",
4518 others default: "")
4519 local to buffer
4520 {not in Vi}
4521 {only available when compiled with the |+osfiletype|
4522 feature}
4523 Some operating systems store extra information about files besides
4524 name, datestamp and permissions. This option contains the extra
4525 information, the nature of which will vary between systems.
4526 The value of this option is usually set when the file is loaded, and
4527 use to set the file type when file is written.
4528 It can affect the pattern matching of the automatic commands.
4529 |autocmd-osfiletypes|
4530
4531 *'paragraphs'* *'para'*
4532'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4533 global
4534 Specifies the nroff macros that separate paragraphs. These are pairs
4535 of two letters (see |object-motions|).
4536
4537 *'paste'* *'nopaste'*
4538'paste' boolean (default off)
4539 global
4540 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004541 Put Vim in Paste mode. This is useful if you want to cut or copy
4542 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 unexpected effects.
4544 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004545 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 knows about pasting and will mostly do the right thing without 'paste'
4547 being set. The same is true for a terminal where Vim handles the
4548 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004549 This option is reset when starting the GUI. Thus if you set it in
4550 your .vimrc it will work in a terminal, but not in the GUI. Setting
4551 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4552 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 When the 'paste' option is switched on (also when it was already on):
4554 - mapping in Insert mode and Command-line mode is disabled
4555 - abbreviations are disabled
4556 - 'textwidth' is set to 0
4557 - 'wrapmargin' is set to 0
4558 - 'autoindent' is reset
4559 - 'smartindent' is reset
4560 - 'softtabstop' is set to 0
4561 - 'revins' is reset
4562 - 'ruler' is reset
4563 - 'showmatch' is reset
4564 - 'formatoptions' is used like it is empty
4565 These options keep their value, but their effect is disabled:
4566 - 'lisp'
4567 - 'indentexpr'
4568 - 'cindent'
4569 NOTE: When you start editing another file while the 'paste' option is
4570 on, settings from the modelines or autocommands may change the
4571 settings again, causing trouble when pasting text. You might want to
4572 set the 'paste' option again.
4573 When the 'paste' option is reset the mentioned options are restored to
4574 the value before the moment 'paste' was switched from off to on.
4575 Resetting 'paste' before ever setting it does not have any effect.
4576 Since mapping doesn't work while 'paste' is active, you need to use
4577 the 'pastetoggle' option to toggle the 'paste' option with some key.
4578
4579 *'pastetoggle'* *'pt'*
4580'pastetoggle' 'pt' string (default "")
4581 global
4582 {not in Vi}
4583 When non-empty, specifies the key sequence that toggles the 'paste'
4584 option. This is like specifying a mapping: >
4585 :map {keys} :set invpaste<CR>
4586< Where {keys} is the value of 'pastetoggle'.
4587 The difference is that it will work even when 'paste' is set.
4588 'pastetoggle' works in Insert mode and Normal mode, but not in
4589 Command-line mode.
4590 Mappings are checked first, thus overrule 'pastetoggle'. However,
4591 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4592 this: >
4593 :map <F10> :set paste<CR>
4594 :map <F11> :set nopaste<CR>
4595 :imap <F10> <C-O>:set paste<CR>
4596 :imap <F11> <nop>
4597 :set pastetoggle=<F11>
4598< This will make <F10> start paste mode and <F11> stop paste mode.
4599 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4600 mode everything is inserted literally, except the 'pastetoggle' key
4601 sequence.
4602
4603 *'pex'* *'patchexpr'*
4604'patchexpr' 'pex' string (default "")
4605 global
4606 {not in Vi}
4607 {not available when compiled without the |+diff|
4608 feature}
4609 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004610 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611
4612 *'patchmode'* *'pm'* *E206*
4613'patchmode' 'pm' string (default "")
4614 global
4615 {not in Vi}
4616 When non-empty the oldest version of a file is kept. This can be used
4617 to keep the original version of a file if you are changing files in a
4618 source distribution. Only the first time that a file is written a
4619 copy of the original file will be kept. The name of the copy is the
4620 name of the original file with the string in the 'patchmode' option
4621 appended. This option should start with a dot. Use a string like
4622 ".org". 'backupdir' must not be empty for this to work (Detail: The
4623 backup file is renamed to the patchmode file after the new file has
4624 been successfully written, that's why it must be possible to write a
4625 backup file). If there was no file to be backed up, an empty file is
4626 created.
4627 When the 'backupskip' pattern matches, a patchmode file is not made.
4628 Using 'patchmode' for compressed files appends the extension at the
4629 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4630 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004631 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632
4633 *'path'* *'pa'* *E343* *E345* *E347*
4634'path' 'pa' string (default on Unix: ".,/usr/include,,"
4635 on OS/2: ".,/emx/include,,"
4636 other systems: ".,,")
4637 global or local to buffer |global-local|
4638 {not in Vi}
4639 This is a list of directories which will be searched when using the
4640 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4641 being searched for has a relative path (not starting with '/'). The
4642 directories in the 'path' option may be relative or absolute.
4643 - Use commas to separate directory names: >
4644 :set path=.,/usr/local/include,/usr/include
4645< - Spaces can also be used to separate directory names (for backwards
4646 compatibility with version 3.0). To have a space in a directory
4647 name, precede it with an extra backslash, and escape the space: >
4648 :set path=.,/dir/with\\\ space
4649< - To include a comma in a directory name precede it with an extra
4650 backslash: >
4651 :set path=.,/dir/with\\,comma
4652< - To search relative to the directory of the current file, use: >
4653 :set path=.
4654< - To search in the current directory use an empty string between two
4655 commas: >
4656 :set path=,,
4657< - A directory name may end in a ':' or '/'.
4658 - Environment variables are expanded |:set_env|.
4659 - When using |netrw.vim| URLs can be used. For example, adding
4660 "http://www.vim.org" will make ":find index.html" work.
4661 - Search upwards and downwards in a directory tree:
4662 1) "*" matches a sequence of characters, e.g.: >
4663 :set path=/usr/include/*
4664< means all subdirectories in /usr/include (but not /usr/include
4665 itself). >
4666 :set path=/usr/*c
4667< matches /usr/doc and /usr/src.
4668 2) "**" matches a subtree, up to 100 directories deep. Example: >
4669 :set path=/home/user_x/src/**
4670< means search in the whole subtree under "/home/usr_x/src".
4671 3) If the path ends with a ';', this path is the startpoint
4672 for upward search.
4673 See |file-searching| for more info and exact syntax.
4674 {not available when compiled without the |+path_extra| feature}
4675 - Careful with '\' characters, type two to get one in the option: >
4676 :set path=.,c:\\include
4677< Or just use '/' instead: >
4678 :set path=.,c:/include
4679< Don't forget "." or files won't even be found in the same directory as
4680 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004681 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004682 it is something like 256 or 1024 characters.
4683 You can check if all the include files are found, using the value of
4684 'path', see |:checkpath|.
4685 The use of |:set+=| and |:set-=| is preferred when adding or removing
4686 directories from the list. This avoids problems when a future version
4687 uses another default. To remove the current directory use: >
4688 :set path-=
4689< To add the current directory use: >
4690 :set path+=
4691< To use an environment variable, you probably need to replace the
4692 separator. Here is an example to append $INCL, in which directory
4693 names are separated with a semi-colon: >
4694 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4695< Replace the ';' with a ':' or whatever separator is used. Note that
4696 this doesn't work when $INCL contains a comma or white space.
4697
4698 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4699'preserveindent' 'pi' boolean (default off)
4700 local to buffer
4701 {not in Vi}
4702 When changing the indent of the current line, preserve as much of the
4703 indent structure as possible. Normally the indent is replaced by a
4704 series of tabs followed by spaces as required (unless |'expandtab'| is
4705 enabled, in which case only spaces are used). Enabling this option
4706 means the indent will preserve as many existing characters as possible
4707 for indenting, and only add additional tabs or spaces as required.
4708 NOTE: When using ">>" multiple times the resulting indent is a mix of
4709 tabs and spaces. You might not like this.
4710 NOTE: 'preserveindent' is reset when 'compatible' is set.
4711 Also see 'copyindent'.
4712 Use |:retab| to clean up white space.
4713
4714 *'previewheight'* *'pvh'*
4715'previewheight' 'pvh' number (default 12)
4716 global
4717 {not in Vi}
4718 {not available when compiled without the |+windows| or
4719 |+quickfix| feature}
4720 Default height for a preview window. Used for |:ptag| and associated
4721 commands. Used for |CTRL-W_}| when no count is given.
4722
4723 *'previewwindow'* *'nopreviewwindow'*
4724 *'pvw'* *'nopvw'* *E590*
4725'previewwindow' 'pvw' boolean (default off)
4726 local to window
4727 {not in Vi}
4728 {not available when compiled without the |+windows| or
4729 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004730 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004731 set. It's normally not set directly, but by using one of the commands
4732 |:ptag|, |:pedit|, etc.
4733
4734 *'printdevice'* *'pdev'*
4735'printdevice' 'pdev' string (default empty)
4736 global
4737 {not in Vi}
4738 {only available when compiled with the |+printer|
4739 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004740 The name of the printer to be used for |:hardcopy|.
4741 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004742 This option cannot be set from a |modeline| or in the |sandbox|, for
4743 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
Bram Moolenaar8299df92004-07-10 09:47:34 +00004745 *'printencoding'* *'penc'*
4746'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004747 global
4748 {not in Vi}
4749 {only available when compiled with the |+printer|
4750 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004751 Sets the character encoding used when printing.
4752 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753
4754 *'printexpr'* *'pexpr'*
4755'printexpr' 'pexpr' String (default: see below)
4756 global
4757 {not in Vi}
4758 {only available when compiled with the |+printer|
4759 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004760 Expression used to print the PostScript produced with |:hardcopy|.
4761 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
Bram Moolenaar8299df92004-07-10 09:47:34 +00004763 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764'printfont' 'pfn' string (default "courier")
4765 global
4766 {not in Vi}
4767 {only available when compiled with the |+printer|
4768 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004769 The name of the font that will be used for |:hardcopy|.
4770 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771
4772 *'printheader'* *'pheader'*
4773'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4774 global
4775 {not in Vi}
4776 {only available when compiled with the |+printer|
4777 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004778 The format of the header produced in |:hardcopy| output.
4779 See |pheader-option|.
4780
4781 *'printmbcharset'* *'pmbcs'*
4782'printmbcharset' 'pmbcs' string (default "")
4783 global
4784 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004785 {only available when compiled with the |+printer|,
4786 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004787 The CJK character set to be used for CJK output from |:hardcopy|.
4788 See |pmbcs-option|.
4789
4790 *'printmbfont'* *'pmbfn'*
4791'printmbfont' 'pmbfn' string (default "")
4792 global
4793 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004794 {only available when compiled with the |+printer|,
4795 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004796 List of font names to be used for CJK output from |:hardcopy|.
4797 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798
4799 *'printoptions'* *'popt'*
4800'printoptions' 'popt' string (default "")
4801 global
4802 {not in Vi}
4803 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004804 List of items that control the format of the output of |:hardcopy|.
4805 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004807 *'prompt'* *'noprompt'*
4808'prompt' boolean (default on)
4809 global
4810 When on a ":" prompt is used in Ex mode.
4811
Bram Moolenaar677ee682005-01-27 14:41:15 +00004812 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004813'quoteescape' 'qe' string (default "\")
4814 local to buffer
4815 {not in Vi}
4816 The characters that are used to escape quotes in a string. Used for
4817 objects like a', a" and a` |a'|.
4818 When one of the characters in this option is found inside a string,
4819 the following character will be skipped. The default value makes the
4820 text "foo\"bar\\" considered to be one string.
4821
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4823'readonly' 'ro' boolean (default off)
4824 local to buffer
4825 If on, writes fail unless you use a '!'. Protects you from
4826 accidentally overwriting a file. Default on when Vim is started
4827 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004828 When using ":w!" the 'readonly' option is reset for the current
4829 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004831 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832
4833 *'remap'* *'noremap'*
4834'remap' boolean (default on)
4835 global
4836 Allows for mappings to work recursively. If you do not want this for
4837 a single entry, use the :noremap[!] command.
4838
4839 *'report'*
4840'report' number (default 2)
4841 global
4842 Threshold for reporting number of lines changed. When the number of
4843 changed lines is more than 'report' a message will be given for most
4844 ":" commands. If you want it always, set 'report' to 0.
4845 For the ":substitute" command the number of substitutions is used
4846 instead of the number of lines.
4847
4848 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4849'restorescreen' 'rs' boolean (default on)
4850 global
4851 {not in Vi} {only in Windows 95/NT console version}
4852 When set, the screen contents is restored when exiting Vim. This also
4853 happens when executing external commands.
4854
4855 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4856 options in your .vimrc. To disable restoring:
4857 set t_ti= t_te=
4858 To enable restoring (for an xterm):
4859 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4860 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4861
4862 *'revins'* *'ri'* *'norevins'* *'nori'*
4863'revins' 'ri' boolean (default off)
4864 global
4865 {not in Vi}
4866 {only available when compiled with the |+rightleft|
4867 feature}
4868 Inserting characters in Insert mode will work backwards. See "typing
4869 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4870 command in Insert mode, when 'allowrevins' is set.
4871 NOTE: This option is reset when 'compatible' or 'paste' is set.
4872
4873 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4874'rightleft' 'rl' boolean (default off)
4875 local to window
4876 {not in Vi}
4877 {only available when compiled with the |+rightleft|
4878 feature}
4879 When on, display orientation becomes right-to-left, i.e., characters
4880 that are stored in the file appear from the right to the left.
4881 Using this option, it is possible to edit files for languages that
4882 are written from the right to the left such as Hebrew and Arabic.
4883 This option is per window, so it is possible to edit mixed files
4884 simultaneously, or to view the same file in both ways (this is
4885 useful whenever you have a mixed text file with both right-to-left
4886 and left-to-right strings so that both sets are displayed properly
4887 in different windows). Also see |rileft.txt|.
4888
4889 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4890'rightleftcmd' 'rlc' string (default "search")
4891 local to window
4892 {not in Vi}
4893 {only available when compiled with the |+rightleft|
4894 feature}
4895 Each word in this option enables the command line editing to work in
4896 right-to-left mode for a group of commands:
4897
4898 search "/" and "?" commands
4899
4900 This is useful for languages such as Hebrew, Arabic and Farsi.
4901 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4902
4903 *'ruler'* *'ru'* *'noruler'* *'noru'*
4904'ruler' 'ru' boolean (default off)
4905 global
4906 {not in Vi}
4907 {not available when compiled without the
4908 |+cmdline_info| feature}
4909 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004910 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 text in the file is shown on the far right:
4912 Top first line is visible
4913 Bot last line is visible
4914 All first and last line are visible
4915 45% relative position in the file
4916 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004917 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00004919 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004920 this option takes precedence over 'ruler' and 'rulerformat'
4921 If the number of characters displayed is different from the number of
4922 bytes in the text (e.g., for a TAB or a multi-byte character), both
4923 the text column (byte number) and the screen column are shown,
4924 separated with a dash.
4925 For an empty line "0-1" is shown.
4926 For an empty buffer the line number will also be zero: "0,0-1".
4927 This option is reset when the 'paste' option is set.
4928 If you don't want to see the ruler all the time but want to know where
4929 you are, use "g CTRL-G" |g_CTRL-G|.
4930 NOTE: This option is reset when 'compatible' is set.
4931
4932 *'rulerformat'* *'ruf'*
4933'rulerformat' 'ruf' string (default empty)
4934 global
4935 {not in Vi}
4936 {not available when compiled without the |+statusline|
4937 feature}
4938 When this option is not empty, it determines the content of the ruler
4939 string, as displayed for the 'ruler' option.
4940 The format of this option, is like that of 'statusline'.
4941 The default ruler width is 17 characters. To make the ruler 15
4942 characters wide, put "%15(" at the start and "%)" at the end.
4943 Example: >
4944 :set rulerformat=%15(%c%V\ %p%%%)
4945<
4946 *'runtimepath'* *'rtp'* *vimfiles*
4947'runtimepath' 'rtp' string (default:
4948 Unix: "$HOME/.vim,
4949 $VIM/vimfiles,
4950 $VIMRUNTIME,
4951 $VIM/vimfiles/after,
4952 $HOME/.vim/after"
4953 Amiga: "home:vimfiles,
4954 $VIM/vimfiles,
4955 $VIMRUNTIME,
4956 $VIM/vimfiles/after,
4957 home:vimfiles/after"
4958 PC, OS/2: "$HOME/vimfiles,
4959 $VIM/vimfiles,
4960 $VIMRUNTIME,
4961 $VIM/vimfiles/after,
4962 $HOME/vimfiles/after"
4963 Macintosh: "$VIM:vimfiles,
4964 $VIMRUNTIME,
4965 $VIM:vimfiles:after"
4966 RISC-OS: "Choices:vimfiles,
4967 $VIMRUNTIME,
4968 Choices:vimfiles/after"
4969 VMS: "sys$login:vimfiles,
4970 $VIM/vimfiles,
4971 $VIMRUNTIME,
4972 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004973 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 global
4975 {not in Vi}
4976 This is a list of directories which will be searched for runtime
4977 files:
4978 filetype.vim filetypes by file name |new-filetype|
4979 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004980 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 colors/ color scheme files |:colorscheme|
4982 compiler/ compiler files |:compiler|
4983 doc/ documentation |write-local-help|
4984 ftplugin/ filetype plugins |write-filetype-plugin|
4985 indent/ indent scripts |indent-expression|
4986 keymap/ key mapping files |mbyte-keymap|
4987 lang/ menu translations |:menutrans|
4988 menu.vim GUI menus |menu.vim|
4989 plugin/ plugin scripts |write-plugin|
4990 print/ files for printing |postscript-print-encoding|
4991 syntax/ syntax files |mysyntaxfile|
4992 tutor/ files for vimtutor |tutor|
4993
4994 And any other file searched for with the |:runtime| command.
4995
4996 The defaults for most systems are setup to search five locations:
4997 1. In your home directory, for your personal preferences.
4998 2. In a system-wide Vim directory, for preferences from the system
4999 administrator.
5000 3. In $VIMRUNTIME, for files distributed with Vim.
5001 *after-directory*
5002 4. In the "after" directory in the system-wide Vim directory. This is
5003 for the system administrator to overrule or add to the distributed
5004 defaults (rarely needed)
5005 5. In the "after" directory in your home directory. This is for
5006 personal preferences to overrule or add to the distributed defaults
5007 or system-wide settings (rarely needed).
5008
5009 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5010 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005011 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 wildcards.
5013 See |:runtime|.
5014 Example: >
5015 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5016< This will use the directory "~/vimruntime" first (containing your
5017 personal Vim runtime files), then "/mygroup/vim" (shared between a
5018 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5019 files).
5020 You probably should always include $VIMRUNTIME somewhere, to use the
5021 distributed runtime files. You can put a directory before $VIMRUNTIME
5022 to find files which replace a distributed runtime files. You can put
5023 a directory after $VIMRUNTIME to find files which add to distributed
5024 runtime files.
5025 This option cannot be set from a |modeline| or in the |sandbox|, for
5026 security reasons.
5027
5028 *'scroll'* *'scr'*
5029'scroll' 'scr' number (default: half the window height)
5030 local to window
5031 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5032 set to half the number of lines in the window when the window size
5033 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005034 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5036 the number of screen lines instead of file lines, makes a difference
5037 when lines wrap}
5038
5039 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5040'scrollbind' 'scb' boolean (default off)
5041 local to window
5042 {not in Vi}
5043 {not available when compiled without the |+scrollbind|
5044 feature}
5045 See also |scroll-binding|. When this option is set, the current
5046 window scrolls as other scrollbind windows (windows that also have
5047 this option set) scroll. This option is useful for viewing the
5048 differences between two versions of a file, see 'diff'.
5049 See |'scrollopt'| for options that determine how this option should be
5050 interpreted.
5051 This option is mostly reset when splitting a window to edit another
5052 file. This means that ":split | edit file" results in two windows
5053 with scroll-binding, but ":split file" does not.
5054
5055 *'scrolljump'* *'sj'*
5056'scrolljump' 'sj' number (default 1)
5057 global
5058 {not in Vi}
5059 Minimal number of lines to scroll when the cursor gets off the
5060 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5061 CTRL-D). Useful if your terminal scrolls very slowly.
5062 NOTE: This option is set to 1 when 'compatible' is set.
5063
5064 *'scrolloff'* *'so'*
5065'scrolloff' 'so' number (default 0)
5066 global
5067 {not in Vi}
5068 Minimal number of screen lines to keep above and below the cursor.
5069 This will make some context visible around where you are working. If
5070 you set it to a very large value (999) the cursor line will always be
5071 in the middle of the window (except at the start or end of the file or
5072 when long lines wrap).
5073 For scrolling horizontally see 'sidescrolloff'.
5074 NOTE: This option is set to 0 when 'compatible' is set.
5075
5076 *'scrollopt'* *'sbo'*
5077'scrollopt' 'sbo' string (default "ver,jump")
5078 global
5079 {not available when compiled without the |+scrollbind|
5080 feature}
5081 {not in Vi}
5082 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005083 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5084 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005085 The following words are available:
5086 ver Bind vertical scrolling for 'scrollbind' windows
5087 hor Bind horizontal scrolling for 'scrollbind' windows
5088 jump Applies to the offset between two windows for vertical
5089 scrolling. This offset is the difference in the first
5090 displayed line of the bound windows. When moving
5091 around in a window, another 'scrollbind' window may
5092 reach a position before the start or after the end of
5093 the buffer. The offset is not changed though, when
5094 moving back the 'scrollbind' window will try to scroll
5095 to the desired position when possible.
5096 When now making that window the current one, two
5097 things can be done with the relative offset:
5098 1. When "jump" is not included, the relative offset is
5099 adjusted for the scroll position in the new current
5100 window. When going back to the other window, the
5101 the new relative offset will be used.
5102 2. When "jump" is included, the other windows are
5103 scrolled to keep the same relative offset. When
5104 going back to the other window, it still uses the
5105 same relative offset.
5106 Also see |scroll-binding|.
5107
5108 *'sections'* *'sect'*
5109'sections' 'sect' string (default "SHNHH HUnhsh")
5110 global
5111 Specifies the nroff macros that separate sections. These are pairs of
5112 two letters (See |object-motions|). The default makes a section start
5113 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5114
5115 *'secure'* *'nosecure'* *E523*
5116'secure' boolean (default off)
5117 global
5118 {not in Vi}
5119 When on, ":autocmd", shell and write commands are not allowed in
5120 ".vimrc" and ".exrc" in the current directory and map commands are
5121 displayed. Switch it off only if you know that you will not run into
5122 problems, or when the 'exrc' option is off. On Unix this option is
5123 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005124 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 'secure' at the end of your ~/.vimrc then.
5126 This option cannot be set from a |modeline| or in the |sandbox|, for
5127 security reasons.
5128
5129 *'selection'* *'sel'*
5130'selection' 'sel' string (default "inclusive")
5131 global
5132 {not in Vi}
5133 This option defines the behavior of the selection. It is only used
5134 in Visual and Select mode.
5135 Possible values:
5136 value past line inclusive ~
5137 old no yes
5138 inclusive yes yes
5139 exclusive yes no
5140 "past line" means that the cursor is allowed to be positioned one
5141 character past the line.
5142 "inclusive" means that the last character of the selection is included
5143 in an operation. For example, when "x" is used to delete the
5144 selection.
5145 Note that when "exclusive" is used and selecting from the end
5146 backwards, you cannot include the last character of a line, when
5147 starting in Normal mode and 'virtualedit' empty.
5148
5149 The 'selection' option is set by the |:behave| command.
5150
5151 *'selectmode'* *'slm'*
5152'selectmode' 'slm' string (default "")
5153 global
5154 {not in Vi}
5155 This is a comma separated list of words, which specifies when to start
5156 Select mode instead of Visual mode, when a selection is started.
5157 Possible values:
5158 mouse when using the mouse
5159 key when using shifted special keys
5160 cmd when using "v", "V" or CTRL-V
5161 See |Select-mode|.
5162 The 'selectmode' option is set by the |:behave| command.
5163
5164 *'sessionoptions'* *'ssop'*
5165'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5166 help,options,winsize")
5167 global
5168 {not in Vi}
5169 {not available when compiled without the +mksession
5170 feature}
5171 Changes the effect of the |:mksession| command. It is a comma
5172 separated list of words. Each word enables saving and restoring
5173 something:
5174 word save and restore ~
5175 blank empty windows
5176 buffers hidden and unloaded buffers, not just those in windows
5177 curdir the current directory
5178 folds manually created folds, opened/closed folds and local
5179 fold options
5180 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005181 and contain at least one lowercase letter. Only
5182 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 help the help window
5184 localoptions options and mappings local to a window or buffer (not
5185 global values for local options)
5186 options all options and mappings (also global values for local
5187 options)
5188 resize size of the Vim window: 'lines' and 'columns'
5189 sesdir the directory in which the session file is located
5190 will become the current directory (useful with
5191 projects accessed over a network from different
5192 systems)
5193 slash backslashes in file names replaced with forward
5194 slashes
5195 unix with Unix end-of-line format (single <NL>), even when
5196 on Windows or DOS
5197 winpos position of the whole Vim window
5198 winsize window sizes
5199
5200 Don't include both "curdir" and "sesdir".
5201 When "curdir" nor "sesdir" is included, file names are stored with
5202 absolute paths.
5203 "slash" and "unix" are useful on Windows when sharing session files
5204 with Unix. The Unix version of Vim cannot source dos format scripts,
5205 but the Windows version of Vim can source unix format scripts.
5206
5207 *'shell'* *'sh'* *E91*
5208'shell' 'sh' string (default $SHELL or "sh",
5209 MS-DOS and Win32: "command.com" or
5210 "cmd.exe", OS/2: "cmd")
5211 global
5212 Name of the shell to use for ! and :! commands. When changing the
5213 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5214 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005215 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 See |option-backslash| about including spaces and backslashes.
5217 Environment variables are expanded |:set_env|.
5218 If the name of the shell contains a space, you might need to enclose
5219 it in quotes. Example: >
5220 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5221< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005222 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 "-f" is not inside the quotes, because it is not part of the command
5224 name. And Vim automagically recognizes the backslashes that are path
5225 separators.
5226 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5227 variable to change the way external commands are executed. See the
5228 libc.inf file of DJGPP.
5229 Under MS-Windows, when the executable ends in ".com" it must be
5230 included. Thus setting the shell to "command.com" or "4dos.com"
5231 works, but "command" and "4dos" do not work for all commands (e.g.,
5232 filtering).
5233 For unknown reasons, when using "4dos.com" the current directory is
5234 changed to "C:\". To avoid this set 'shell' like this: >
5235 :set shell=command.com\ /c\ 4dos
5236< This option cannot be set from a |modeline| or in the |sandbox|, for
5237 security reasons.
5238
5239 *'shellcmdflag'* *'shcf'*
5240'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5241 does not contain "sh" somewhere: "/c")
5242 global
5243 {not in Vi}
5244 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5245 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5246 systems, the default is set according to the value of 'shell', to
5247 reduce the need to set this option by the user. It's not used for
5248 OS/2 (EMX figures this out itself). See |option-backslash| about
5249 including spaces and backslashes. See |dos-shell|.
5250 This option cannot be set from a |modeline| or in the |sandbox|, for
5251 security reasons.
5252
5253 *'shellpipe'* *'sp'*
5254'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5255 global
5256 {not in Vi}
5257 {not available when compiled without the |+quickfix|
5258 feature}
5259 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005260 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 including spaces and backslashes.
5262 The name of the temporary file can be represented by "%s" if necessary
5263 (the file name is appended automatically if no %s appears in the value
5264 of this option).
5265 For the Amiga and MS-DOS the default is ">". The output is directly
5266 saved in a file and not echoed to the screen.
5267 For Unix the default it "| tee". The stdout of the compiler is saved
5268 in a file and echoed to the screen. If the 'shell' option is "csh" or
5269 "tcsh" after initializations, the default becomes "|& tee". If the
5270 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5271 "2>&1| tee". This means that stderr is also included.
5272 The initialization of this option is done after reading the ".vimrc"
5273 and the other initializations, so that when the 'shell' option is set
5274 there, the 'shellpipe' option changes automatically, unless it was
5275 explicitly set before.
5276 When 'shellpipe' is set to an empty string, no redirection of the
5277 ":make" output will be done. This is useful if you use a 'makeprg'
5278 that writes to 'makeef' by itself. If you want no piping, but do
5279 want to include the 'makeef', set 'shellpipe' to a single space.
5280 Don't forget to precede the space with a backslash: ":set sp=\ ".
5281 In the future pipes may be used for filtering and this option will
5282 become obsolete (at least for Unix).
5283 This option cannot be set from a |modeline| or in the |sandbox|, for
5284 security reasons.
5285
5286 *'shellquote'* *'shq'*
5287'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5288 contains "sh" somewhere: "\"")
5289 global
5290 {not in Vi}
5291 Quoting character(s), put around the command passed to the shell, for
5292 the "!" and ":!" commands. The redirection is kept outside of the
5293 quoting. See 'shellxquote' to include the redirection. It's
5294 probably not useful to set both options.
5295 This is an empty string by default. Only known to be useful for
5296 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5297 or bash, where it should be "\"". The default is adjusted according
5298 the value of 'shell', to reduce the need to set this option by the
5299 user. See |dos-shell|.
5300 This option cannot be set from a |modeline| or in the |sandbox|, for
5301 security reasons.
5302
5303 *'shellredir'* *'srr'*
5304'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5305 global
5306 {not in Vi}
5307 String to be used to put the output of a filter command in a temporary
5308 file. See also |:!|. See |option-backslash| about including spaces
5309 and backslashes.
5310 The name of the temporary file can be represented by "%s" if necessary
5311 (the file name is appended automatically if no %s appears in the value
5312 of this option).
5313 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5314 or "zsh" during initializations, the default becomes ">&". If the
5315 'shell' option is "sh", "ksh" or "bash" the default becomes
5316 ">%s 2>&1". This means that stderr is also included.
5317 For Win32, the Unix checks are done and additionally "cmd" is checked
5318 for, which makes the default ">%s 2>&1". Also, the same names with
5319 ".exe" appended are checked for.
5320 The initialization of this option is done after reading the ".vimrc"
5321 and the other initializations, so that when the 'shell' option is set
5322 there, the 'shellredir' option changes automatically unless it was
5323 explicitly set before.
5324 In the future pipes may be used for filtering and this option will
5325 become obsolete (at least for Unix).
5326 This option cannot be set from a |modeline| or in the |sandbox|, for
5327 security reasons.
5328
5329 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5330'shellslash' 'ssl' boolean (default off)
5331 global
5332 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5333 When set, a forward slash is used when expanding file names. This is
5334 useful when a Unix-like shell is used instead of command.com or
5335 cmd.exe. Backward slashes can still be typed, but they are changed to
5336 forward slashes by Vim.
5337 Note that setting or resetting this option has no effect for some
5338 existing file names, thus this option needs to be set before opening
5339 any file for best results. This might change in the future.
5340 'shellslash' only works when a backslash can be used as a path
5341 separator. To test if this is so use: >
5342 if exists('+shellslash')
5343<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005344 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5345'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5346 global
5347 {not in Vi}
5348 When on, use temp files for shell commands. When off use a pipe.
5349 When using a pipe is not possible temp files are used anyway.
5350 Currently a pipe is only supported on Unix. You can check it with: >
5351 :if has("filterpipe")
5352< The advantage of using a pipe is that nobody can read the temp file
5353 and the 'shell' command does not need to support redirection.
5354 The advantage of using a temp file is that the file type and encoding
5355 can be detected.
5356 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5357 |FilterWritePost| autocommands event are not triggered when
5358 'shelltemp' is off.
5359
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 *'shelltype'* *'st'*
5361'shelltype' 'st' number (default 0)
5362 global
5363 {not in Vi} {only for the Amiga}
5364 On the Amiga this option influences the way how the commands work
5365 which use a shell.
5366 0 and 1: always use the shell
5367 2 and 3: use the shell only to filter lines
5368 4 and 5: use shell only for ':sh' command
5369 When not using the shell, the command is executed directly.
5370
5371 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5372 1 and 3: use "shell cmd" to start external commands
5373
5374 *'shellxquote'* *'sxq'*
5375'shellxquote' 'sxq' string (default: "";
5376 for Win32, when 'shell' contains "sh"
5377 somewhere: "\""
5378 for Unix, when using system(): "\"")
5379 global
5380 {not in Vi}
5381 Quoting character(s), put around the command passed to the shell, for
5382 the "!" and ":!" commands. Includes the redirection. See
5383 'shellquote' to exclude the redirection. It's probably not useful
5384 to set both options.
5385 This is an empty string by default. Known to be useful for
5386 third-party shells when using the Win32 version, such as the MKS Korn
5387 Shell or bash, where it should be "\"". The default is adjusted
5388 according the value of 'shell', to reduce the need to set this option
5389 by the user. See |dos-shell|.
5390 This option cannot be set from a |modeline| or in the |sandbox|, for
5391 security reasons.
5392
5393 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5394'shiftround' 'sr' boolean (default off)
5395 global
5396 {not in Vi}
5397 Round indent to multiple of 'shiftwidth'. Applies to > and <
5398 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5399 a multiple of 'shiftwidth' (this is Vi compatible).
5400 NOTE: This option is reset when 'compatible' is set.
5401
5402 *'shiftwidth'* *'sw'*
5403'shiftwidth' 'sw' number (default 8)
5404 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005405 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 |'cindent'|, |>>|, |<<|, etc.
5407
5408 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005409'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5410 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411 global
5412 {not in Vi}
5413 This option helps to avoid all the |hit-enter| prompts caused by file
5414 messages, for example with CTRL-G, and to avoid some other messages.
5415 It is a list of flags:
5416 flag meaning when present ~
5417 f use "(3 of 5)" instead of "(file 3 of 5)"
5418 i use "[noeol]" instead of "[Incomplete last line]"
5419 l use "999L, 888C" instead of "999 lines, 888 characters"
5420 m use "[+]" instead of "[Modified]"
5421 n use "[New]" instead of "[New File]"
5422 r use "[RO]" instead of "[readonly]"
5423 w use "[w]" instead of "written" for file write message
5424 and "[a]" instead of "appended" for ':w >> file' command
5425 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5426 "[unix format]" and "[mac]" instead of "[mac format]".
5427 a all of the above abbreviations
5428
5429 o overwrite message for writing a file with subsequent message
5430 for reading a file (useful for ":wn" or when 'autowrite' on)
5431 O message for reading a file overwrites any previous message.
5432 Also for quickfix message (e.g., ":cn").
5433 s don't give "search hit BOTTOM, continuing at TOP" or "search
5434 hit TOP, continuing at BOTTOM" messages
5435 t truncate file message at the start if it is too long to fit
5436 on the command-line, "<" will appear in the left most column.
5437 Ignored in Ex mode.
5438 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005439 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 Ignored in Ex mode.
5441 W don't give "written" or "[w]" when writing a file
5442 A don't give the "ATTENTION" message when an existing swap file
5443 is found.
5444 I don't give the intro message when starting Vim |:intro|.
5445
5446 This gives you the opportunity to avoid that a change between buffers
5447 requires you to hit <Enter>, but still gives as useful a message as
5448 possible for the space available. To get the whole message that you
5449 would have got with 'shm' empty, use ":file!"
5450 Useful values:
5451 shm= No abbreviation of message.
5452 shm=a Abbreviation, but no loss of information.
5453 shm=at Abbreviation, and truncate message when necessary.
5454
5455 NOTE: This option is set to the Vi default value when 'compatible' is
5456 set and to the Vim default value when 'compatible' is reset.
5457
5458 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5459'shortname' 'sn' boolean (default off)
5460 local to buffer
5461 {not in Vi, not in MS-DOS versions}
5462 Filenames are assumed to be 8 characters plus one extension of 3
5463 characters. Multiple dots in file names are not allowed. When this
5464 option is on, dots in file names are replaced with underscores when
5465 adding an extension (".~" or ".swp"). This option is not available
5466 for MS-DOS, because then it would always be on. This option is useful
5467 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5468 or crossdos. When running the Win32 GUI version under Win32s, this
5469 option is always on by default.
5470
5471 *'showbreak'* *'sbr'* *E595*
5472'showbreak' 'sbr' string (default "")
5473 global
5474 {not in Vi}
5475 {not available when compiled without the |+linebreak|
5476 feature}
5477 String to put at the start of lines that have been wrapped. Useful
5478 values are "> " or "+++ ".
5479 Only printable single-cell characters are allowed, excluding <Tab> and
5480 comma (in a future version the comma might be used to separate the
5481 part that is shown at the end and at the start of a line).
5482 The characters are highlighted according to the '@' flag in
5483 'highlight'.
5484 Note that tabs after the showbreak will be displayed differently.
5485 If you want the 'showbreak' to appear in between line numbers, add the
5486 "n" flag to 'cpoptions'.
5487
5488 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5489'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5490 off)
5491 global
5492 {not in Vi}
5493 {not available when compiled without the
5494 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005495 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 terminal is slow.
5497 In Visual mode the size of the selected area is shown:
5498 - When selecting characters within a line, the number of characters.
5499 - When selecting more than one line, the number of lines.
5500 - When selecting a block, the size in screen characters: linesxcolumns.
5501 NOTE: This option is set to the Vi default value when 'compatible' is
5502 set and to the Vim default value when 'compatible' is reset.
5503
5504 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5505'showfulltag' 'sft' boolean (default off)
5506 global
5507 {not in Vi}
5508 When completing a word in insert mode (see |ins-completion|) from the
5509 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005510 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 matched a C function, you can see a template for what arguments are
5512 required (coding style permitting).
5513
5514 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5515'showmatch' 'sm' boolean (default off)
5516 global
5517 When a bracket is inserted, briefly jump to the matching one. The
5518 jump is only done if the match can be seen on the screen. The time to
5519 show the match can be set with 'matchtime'.
5520 A Beep is given if there is no match (no matter if the match can be
5521 seen or not). This option is reset when the 'paste' option is set.
5522 When the 'm' flag is not included in 'cpoptions', typing a character
5523 will immediately move the cursor back to where it belongs.
5524 See the "sm" field in 'guicursor' for setting the cursor shape and
5525 blinking when showing the match.
5526 The 'matchpairs' option can be used to specify the characters to show
5527 matches for. 'rightleft' and 'revins' are used to look for opposite
5528 matches.
5529 Note: For the use of the short form parental guidance is advised.
5530
5531 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5532'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5533 global
5534 If in Insert, Replace or Visual mode put a message on the last line.
5535 Use the 'M' flag in 'highlight' to set the type of highlighting for
5536 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005537 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 doesn't mean XIM is really active, especially when 'imactivatekey' is
5539 not set.
5540 NOTE: This option is set to the Vi default value when 'compatible' is
5541 set and to the Vim default value when 'compatible' is reset.
5542
5543 *'sidescroll'* *'ss'*
5544'sidescroll' 'ss' number (default 0)
5545 global
5546 {not in Vi}
5547 The minimal number of columns to scroll horizontally. Used only when
5548 the 'wrap' option is off and the cursor is moved off of the screen.
5549 When it is zero the cursor will be put in the middle of the screen.
5550 When using a slow terminal set it to a large number or 0. When using
5551 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5552 commands.
5553
5554 *'sidescrolloff'* *'siso'*
5555'sidescrolloff' 'siso' number (default 0)
5556 global
5557 {not in Vi}
5558 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005559 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 greater than 0 while having |'sidescroll'| also at a non-zero value
5561 makes some context visible in the line you are scrolling in
5562 horizontally (except at the end and beginning of the line). Setting
5563 this option to a large value (like 999) has the effect of keeping the
5564 cursor horizontally centered in the window, as long as one does not
5565 come too close to the beginning or end of the line.
5566 NOTE: This option is set to 0 when 'compatible' is set.
5567
5568 Example: Try this together with 'sidescroll' and 'listchars' as
5569 in the following example to never allow the cursor to move
5570 onto the "extends" character:
5571
5572 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5573 :set sidescrolloff=1
5574
5575
5576 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5577'smartcase' 'scs' boolean (default off)
5578 global
5579 {not in Vi}
5580 Override the 'ignorecase' option if the search pattern contains upper
5581 case characters. Only used when the search pattern is typed and
5582 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005583 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005584 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5585 recalling the search pattern from history and hitting <Enter>.
5586 NOTE: This option is reset when 'compatible' is set.
5587
5588 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5589'smartindent' 'si' boolean (default off)
5590 local to buffer
5591 {not in Vi}
5592 {not available when compiled without the
5593 |+smartindent| feature}
5594 Do smart autoindenting when starting a new line. Works for C-like
5595 programs, but can also be used for other languages. 'cindent' does
5596 something like this, works better in most cases, but is more strict,
5597 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5598 'indentexpr' is a more advanced alternative.
5599 Normally 'autoindent' should also be on when using 'smartindent'.
5600 An indent is automatically inserted:
5601 - After a line ending in '{'.
5602 - After a line starting with a keyword from 'cinwords'.
5603 - Before a line starting with '}' (only with the "O" command).
5604 When typing '}' as the first character in a new line, that line is
5605 given the same indent as the matching '{'.
5606 When typing '#' as the first character in a new line, the indent for
5607 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005608 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005609 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5610 When using the ">>" command, lines starting with '#' are not shifted
5611 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 is set smart indenting is disabled.
5614
5615 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5616'smarttab' 'sta' boolean (default off)
5617 global
5618 {not in Vi}
5619 When on, a <Tab> in front of a line inserts blanks according to
5620 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5621 a 'shiftwidth' worth of space at the start of the line.
5622 When off a <Tab> always inserts blanks according to 'tabstop'.
5623 'shiftwidth' is only used for shifting text left or right
5624 |shift-left-right|.
5625 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5626 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005627 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 NOTE: This option is reset when 'compatible' is set.
5629
5630 *'softtabstop'* *'sts'*
5631'softtabstop' 'sts' number (default 0)
5632 local to buffer
5633 {not in Vi}
5634 Number of spaces that a <Tab> counts for while performing editing
5635 operations, like inserting a <Tab> or using <BS>. It "feels" like
5636 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5637 used. This is useful to keep the 'ts' setting at its standard value
5638 of 8, while being able to edit like it is set to 'sts'. However,
5639 commands like "x" still work on the actual characters.
5640 When 'sts' is zero, this feature is off.
5641 'softtabstop' is set to 0 when the 'paste' option is set.
5642 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5643 spaces is minimized by using <Tab>s.
5644 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5645 set.
5646 NOTE: This option is set to 0 when 'compatible' is set.
5647
Bram Moolenaar217ad922005-03-20 22:37:15 +00005648 *'spell'* *'nospell'*
5649'spell' boolean (default off)
5650 local to window
5651 {not in Vi}
5652 {not available when compiled without the |+syntax|
5653 feature}
5654 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005655 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005656
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005657 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005658'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005659 local to buffer
5660 {not in Vi}
5661 {not available when compiled without the |+syntax|
5662 feature}
5663 Pattern to locate the end of a sentence. The following word will be
5664 checked to start with a capital letter. If not then it is highlighted
5665 with SpellCap |hl-SpellCap|.
5666 When this check is not wanted make this option empty.
5667 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005668 Be careful with special characters, see |option-backslash| about
5669 including spaces and backslashes.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005670
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005671 *'spellfile'* *'spf'*
5672'spellfile' 'spf' string (default empty)
5673 local to buffer
5674 {not in Vi}
5675 {not available when compiled without the |+syntax|
5676 feature}
5677 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005678 commands. It must end in ".{encoding}.add". You need to include the
5679 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005680 *E765*
5681 It may also be a comma separated list of names. A count before the
5682 |zg| and |zw| commands can be used to access each. This allows using
5683 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005684 When a word is added while this option is empty Vim will set it for
5685 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005686 writable and the first language name that appears in 'spelllang',
5687 ignoring the region.
5688 The resulting ".spl" file will be used for spell checking, it does not
5689 have to appear in 'spelllang'.
5690 Normally one file is used for all regions, but you can add the region
5691 name if you want to. However, it will then only be used when
5692 'spellfile' is set to it, for entries in 'spelllang' only files
5693 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005694 This option cannot be set from a |modeline| or in the |sandbox|, for
5695 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005696
Bram Moolenaar217ad922005-03-20 22:37:15 +00005697 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005698'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005699 local to buffer
5700 {not in Vi}
5701 {not available when compiled without the |+syntax|
5702 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005703 A comma separated list of word list names. When the 'spell' option is
5704 on spellchecking will be done for these languages. Example: >
5705 set spelllang=en_us,nl,medical
5706< This means US English, Dutch and medical words are recognized. Words
5707 that are not recognized will be highlighted.
5708 The word list name must not include a comma or dot. Using a dash is
5709 recommended to separate the two letter language name from a
5710 specification. Thus "en-rare" is used for rare English words.
5711 A region name must come last and have the form "_xx", where "xx" is
5712 the two-letter, lower case region name. You can use more than one
5713 region by listing them: "en_us,en_ca" supports both US and Canadian
5714 English, but not words specific for Australia, New Zealand or Great
5715 Britain.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005716 As a special case the name of a .spl file can be given as-is. The
5717 first "_xx" in the name is removed and used as the region name
5718 (_xx is an underscore, two letters and followed by a non-letter).
5719 This is mainly for testing purposes. You must make sure the correct
5720 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005721 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005722 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5723 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005724 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005725
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005726 *'spellsuggest'* *'sps'*
5727'spellsuggest' 'sps' string (default "best")
5728 global
5729 {not in Vi}
5730 {not available when compiled without the |+syntax|
5731 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005732 Methods used for spelling suggestions. Both for the |z?| command and
5733 the |spellsuggest()| function. This is a comma-separated list of
5734 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005735
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005736 best Internal method that works best for English. Finds
5737 changes like "fast" and uses a bit of sound-a-like
5738 scoring to improve the ordering.
5739
5740 double Internal method that uses two methods and mixes the
5741 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005742 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005743 word. That only works when the language specifies
5744 sound folding. Can be slow and doesn't always give
5745 better results.
5746
5747 fast Internal method that only checks for simple changes:
5748 character inserts/deletes/swaps. Works well for
5749 simple typing mistakes.
5750
5751 file:{filename} Read file {filename}, which must have two columns,
5752 separated by a slash. The first column contains the
5753 bad word, the second column the suggested good word.
5754 Example:
5755 theribal/terrible ~
5756 Use this for common mistakes that do not appear at the
5757 top of the suggestion list with the internal methods.
5758 Lines without a slash are ignored, use this for
5759 comments.
5760 The file is used for all languages.
5761
5762 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5763 trouble with spaces. |v:val| holds the badly spelled
5764 word. The expression must evaluate to a List of
5765 Lists, each with a suggestion and a score.
5766 Example:
5767 [['the', 33], ['that', 44]]
5768 Set 'verbose' and use |z?| to see the scores that the
5769 internal methods use. A lower score is better.
5770 This may invoke |spellsuggest()| if you temporarily
5771 set 'spellsuggest' to exclude the "expr:" part.
5772 Errors are silently ignored, unless you set the
5773 'verbose' option to a non-zero value.
5774
5775 Only one of "best", "double" or "fast" may be used. The others may
5776 appear several times in any order. Example: >
5777 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5778<
5779 This option cannot be set from a |modeline| or in the |sandbox|, for
5780 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005781
5782
Bram Moolenaar071d4272004-06-13 20:20:40 +00005783 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5784'splitbelow' 'sb' boolean (default off)
5785 global
5786 {not in Vi}
5787 {not available when compiled without the +windows
5788 feature}
5789 When on, splitting a window will put the new window below the current
5790 one. |:split|
5791
5792 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5793'splitright' 'spr' boolean (default off)
5794 global
5795 {not in Vi}
5796 {not available when compiled without the +vertsplit
5797 feature}
5798 When on, splitting a window will put the new window right of the
5799 current one. |:vsplit|
5800
5801 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5802'startofline' 'sol' boolean (default on)
5803 global
5804 {not in Vi}
5805 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005806 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005807 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005808 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005809 with a linewise operator, with "%" with a count and to buffer changing
5810 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5811 only has a line number, e.g., ":25" or ":+".
5812 In case of buffer changing commands the cursor is placed at the column
5813 where it was the last time the buffer was edited.
5814 NOTE: This option is set when 'compatible' is set.
5815
5816 *'statusline'* *'stl'* *E540* *E541* *E542*
5817'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005818 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005819 {not in Vi}
5820 {not available when compiled without the |+statusline|
5821 feature}
5822 When nonempty, this option determines the content of the status line.
5823 Also see |status-line|.
5824
5825 The option consists of printf style '%' items interspersed with
5826 normal text. Each status line item is of the form:
5827 %-0{minwid}.{maxwid}{item}
5828 All fields except the {item} is optional. A single percent sign can
5829 be given as "%%". Up to 80 items can be specified.
5830
5831 Note that the only effect of 'ruler' when this option is set (and
5832 'laststatus' is 2) is controlling the output of |CTRL-G|.
5833
5834 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005835 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005836 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005837 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 minwid Minimum width of the item, padding as set by '-' & '0'.
5839 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005840 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005841 on the left for text items. Numeric items will be
5842 shifted down to maxwid-2 digits followed by '>'number
5843 where number is the amount of missing digits, much like
5844 an exponential notation.
5845 item A one letter code as described below.
5846
5847 Following is a description of the possible statusline items. The
5848 second character in "item" is the type:
5849 N for number
5850 S for string
5851 F for flags as described below
5852 - not applicable
5853
5854 item meaning ~
5855 f S Path to the file in the buffer, relative to current directory.
5856 F S Full path to the file in the buffer.
5857 t S File name (tail) of file in the buffer.
5858 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5859 M F Modified flag, text is ",+" or ",-".
5860 r F Readonly flag, text is " [RO]".
5861 R F Readonly flag, text is ",RO".
5862 h F Help buffer flag, text is " [help]".
5863 H F Help buffer flag, text is ",HLP".
5864 w F Preview window flag, text is " [Preview]".
5865 W F Preview window flag, text is ",PRV".
5866 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5867 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5868 {not available when compiled without |+autocmd| feature}
5869 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5870 being used: "<keymap>"
5871 n N Buffer number.
5872 b N Value of byte under cursor.
5873 B N As above, in hexadecimal.
5874 o N Byte number in file of byte under cursor, first byte is 1.
5875 Mnemonic: Offset from start of file (with one added)
5876 {not available when compiled without |+byte_offset| feature}
5877 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005878 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879 l N Line number.
5880 L N Number of lines in buffer.
5881 c N Column number.
5882 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005883 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 p N Percentage through file in lines as in |CTRL-G|.
5885 P S Percentage through file of displayed window. This is like the
5886 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005887 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00005888 Empty if the argument file count is zero or one.
5889 { NF Evaluate expression between '{' and '}' and substitute result.
5890 ( - Start of item group. Can be used for setting the width and
5891 alignment of a section. Must be followed by %) somewhere.
5892 ) - End of item group. No width fields allowed.
5893 < - Where to truncate line if too long. Default is at the start.
5894 No width fields allowed.
5895 = - Separation point between left and right aligned items.
5896 No width fields allowed.
5897 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005898 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 The difference between User{N} and StatusLine will be applied
5900 to StatusLineNC for the statusline of non-current windows.
5901 The number N must be between 1 and 9. See |hl-User1..9|
5902
5903 Display of flags are controlled by the following heuristic:
5904 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005905 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 with a space it is assumed that it wants to separate itself from
5907 anything but other flags. That is: A leading comma is removed if the
5908 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00005909 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00005910 make a nice display when flags are used like in the examples below.
5911
Bram Moolenaar582fd852005-03-28 20:58:01 +00005912 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 not set) and a minwid is not set for the group, the whole group will
5914 become empty. This will make a group like the following disappear
5915 completely from the statusline when none of the flags are set. >
5916 :set statusline=...%(\ [%M%R%H]%)...
5917<
5918 Beware that an expression is evaluated each and every time the status
5919 line is displayed. The current buffer and current window will be set
5920 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00005921 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5923 real current buffer. The expression is evaluated in the |sandbox|.
5924
5925 If the statusline is not updated when you want it (e.g., after setting
5926 a variable that's used in an expression), you can force an update by
5927 setting an option without changing its value. Example: >
5928 :let &ro = &ro
5929
5930< A result of all digits is regarded a number for display purposes.
5931 Otherwise the result is taken as flag text and applied to the rules
5932 described above.
5933
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00005934 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005935 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5936 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5937
5938 Examples:
5939 Emulate standard status line with 'ruler' set >
5940 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5941< Similar, but add ASCII value of char under the cursor (like "ga") >
5942 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5943< Display byte count and byte value, modified flag in red. >
5944 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5945 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5946< Display a ,GZ flag if a compressed file is loaded >
5947 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5948< In the |:autocmd|'s: >
5949 :let b:gzflag = 1
5950< And: >
5951 :unlet b:gzflag
5952< And define this function: >
5953 :function VarExists(var, val)
5954 : if exists(a:var) | return a:val | else | return '' | endif
5955 :endfunction
5956<
5957 *'suffixes'* *'su'*
5958'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5959 global
5960 {not in Vi}
5961 Files with these suffixes get a lower priority when multiple files
5962 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005963 suffixes. Spaces after the comma are ignored. A dot is also seen as
5964 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005965 separator, precede it with a backslash (see |option-backslash| about
5966 including spaces and backslashes).
5967 See 'wildignore' for completely ignoring files.
5968 The use of |:set+=| and |:set-=| is preferred when adding or removing
5969 suffixes from the list. This avoids problems when a future version
5970 uses another default.
5971
5972 *'suffixesadd'* *'sua'*
5973'suffixesadd' 'sua' string (default "")
5974 local to buffer
5975 {not in Vi}
5976 {not available when compiled without the
5977 |+file_in_path| feature}
5978 Comma separated list of suffixes, which are used when searching for a
5979 file for the "gf", "[I", etc. commands. Example: >
5980 :set suffixesadd=.java
5981<
5982 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
5983'swapfile' 'swf' boolean (default on)
5984 local to buffer
5985 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005986 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005987 swapfile is not wanted for a specific buffer. For example, with
5988 confidential information that even root must not be able to access.
5989 Careful: All text will be in memory:
5990 - Don't use this for big files.
5991 - Recovery will be impossible!
5992 A swapfile will only be present when |'updatecount'| is non-zero and
5993 'swapfile' is set.
5994 When 'swapfile' is reset, the swap file for the current buffer is
5995 immediately deleted. When 'swapfile' is set, and 'updatecount' is
5996 non-zero, a swap file is immediately created.
5997 Also see |swap-file| and |'swapsync'|.
5998
5999 This option is used together with 'bufhidden' and 'buftype' to
6000 specify special kinds of buffers. See |special-buffers|.
6001
6002 *'swapsync'* *'sws'*
6003'swapsync' 'sws' string (default "fsync")
6004 global
6005 {not in Vi}
6006 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006007 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006008 When this option is empty parts of the swap file may be in memory and
6009 not written to disk. When the system crashes you may lose more work.
6010 On Unix the system does a sync now and then without Vim asking for it,
6011 so the disadvantage of setting this option off is small. On some
6012 systems the swap file will not be written at all. For a unix system
6013 setting it to "sync" will use the sync() call instead of the default
6014 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006015 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006016
6017 *'switchbuf'* *'swb'*
6018'switchbuf' 'swb' string (default "")
6019 global
6020 {not in Vi}
6021 This option controls the behavior when switching between buffers.
6022 Possible values (comma separated list):
6023 useopen If included, jump to the first open window that
6024 contains the specified buffer (if there is one).
6025 Otherwise: Do not examine other windows.
6026 This setting is checked with |quickfix| commands, when
6027 jumping to errors (":cc", ":cn", "cp", etc.). It is
6028 also used in all buffer related split commands, for
6029 example ":sbuffer", ":sbnext", or ":sbrewind".
6030 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006031 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006032 Supported in |quickfix| commands that display errors.
6033
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006034 *'synmaxcol'* *'smc'*
6035'synmaxcol' 'smc' number (default 3000)
6036 local to buffer
6037 {not in Vi}
6038 {not available when compiled without the |+syntax|
6039 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006040 Maximum column in which to search for syntax items. In long lines the
6041 text after this column is not highlighted and following lines may not
6042 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006043 This helps to avoid very slow redrawing for an XML file that is one
6044 long line.
6045 Set to zero to remove the limit.
6046
Bram Moolenaar071d4272004-06-13 20:20:40 +00006047 *'syntax'* *'syn'*
6048'syntax' 'syn' string (default empty)
6049 local to buffer
6050 {not in Vi}
6051 {not available when compiled without the |+syntax|
6052 feature}
6053 When this option is set, the syntax with this name is loaded, unless
6054 syntax highlighting has been switched off with ":syntax off".
6055 Otherwise this option does not always reflect the current syntax (the
6056 b:current_syntax variable does).
6057 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006058 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006059 /* vim: set syntax=idl : */
6060< To switch off syntax highlighting for the current file, use: >
6061 :set syntax=OFF
6062< To switch syntax highlighting on according to the current value of the
6063 'filetype' option: >
6064 :set syntax=ON
6065< What actually happens when setting the 'syntax' option is that the
6066 Syntax autocommand event is triggered with the value as argument.
6067 This option is not copied to another buffer, independent of the 's' or
6068 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006069 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070
6071 *'tabstop'* *'ts'*
6072'tabstop' 'ts' number (default 8)
6073 local to buffer
6074 Number of spaces that a <Tab> in the file counts for. Also see
6075 |:retab| command, and 'softtabstop' option.
6076
6077 Note: Setting 'tabstop' to any other value than 8 can make your file
6078 appear wrong in many places (e.g., when printing it).
6079
6080 There are four main ways to use tabs in Vim:
6081 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6082 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6083 will use a mix of tabs and spaces, but typing Tab and BS will
6084 behave like a tab appears every 4 (or 3) characters.
6085 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6086 'expandtab'. This way you will always insert spaces. The
6087 formatting will never be messed up when 'tabstop' is changed.
6088 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006089 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006090 works when using Vim to edit the file.
6091 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6092 'noexpandtab'. This should then work (for initial indents only)
6093 for any tabstop setting that people use. It might be nice to have
6094 tabs after the first non-blank inserted as spaces if you do this
6095 though. Otherwise aligned comments will be wrong when 'tabstop' is
6096 changed.
6097
6098 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6099'tagbsearch' 'tbs' boolean (default on)
6100 global
6101 {not in Vi}
6102 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006103 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 searching makes searching for a tag a LOT faster, but a linear search
6105 will find more tags if the tags file wasn't properly sorted.
6106 Vim normally assumes that your tags files are sorted, or indicate that
6107 they are not sorted. Only when this is not the case does the
6108 'tagbsearch' option need to be switched off.
6109
6110 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006111 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 certain files, or retry all files with a linear search. When
6113 'tagbsearch' is off, only a linear search is done.
6114
6115 Linear searching is done anyway, for one file, when Vim finds a line
6116 at the start of the file indicating that it's not sorted: >
6117 !_TAG_FILE_SORTED 0 /some command/
6118< [The whitespace before and after the '0' must be a single <Tab>]
6119
6120 When a binary search was done and no match was found in any of the
6121 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6122 instead of a normal tag name, a retry is done with a linear search.
6123 Tags in unsorted tags files, and matches with different case will only
6124 be found in the retry.
6125
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006126 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 linear search can be avoided for the 'ignorecase' case. Use a value
6128 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6129 case-fold sorted with the -f switch to "sort" in most unices, as in
6130 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6131 5.3 or higher the -f or --fold-case-sort switch can be used for this
6132 as well. Note that case must be folded to uppercase for this to work.
6133
6134 When 'tagbsearch' is off, tags searching is slower when a full match
6135 exists, but faster when no full match exists. Tags in unsorted tags
6136 files may only be found with 'tagbsearch' off.
6137 When the tags file is not sorted, or sorted in a wrong way (not on
6138 ASCII byte value), 'tagbsearch' should be off, or the line given above
6139 must be included in the tags file.
6140 This option doesn't affect commands that find all matching tags (e.g.,
6141 command-line completion and ":help").
6142 {Vi: always uses binary search in some versions}
6143
6144 *'taglength'* *'tl'*
6145'taglength' 'tl' number (default 0)
6146 global
6147 If non-zero, tags are significant up to this number of characters.
6148
6149 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6150'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6151 global
6152 {not in Vi}
6153 If on and using a tag file in another directory, file names in that
6154 tag file are relative to the directory where the tag file is.
6155 NOTE: This option is set to the Vi default value when 'compatible' is
6156 set and to the Vim default value when 'compatible' is reset.
6157
6158 *'tags'* *'tag'* *E433*
6159'tags' 'tag' string (default "./tags,tags", when compiled with
6160 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6161 global or local to buffer |global-local|
6162 Filenames for the tag command, separated by spaces or commas. To
6163 include a space or comma in a file name, precede it with a backslash
6164 (see |option-backslash| about including spaces and backslashes).
6165 When a file name starts with "./", the '.' is replaced with the path
6166 of the current file. But only when the 'd' flag is not included in
6167 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6168 |tags-option|.
6169 "*", "**" and other wildcards can be used to search for tags files in
6170 a directory tree. See |file-searching|. {not available when compiled
6171 without the |+path_extra| feature}
6172 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6173 files are also supported. They are automatically recognized. The
6174 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6175 differences are ignored (MS-Windows). |emacs-tags|
6176 The use of |:set+=| and |:set-=| is preferred when adding or removing
6177 file names from the list. This avoids problems when a future version
6178 uses another default.
6179 {Vi: default is "tags /usr/lib/tags"}
6180
6181 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6182'tagstack' 'tgst' boolean (default on)
6183 global
6184 {not in all versions of Vi}
6185 When on, the |tagstack| is used normally. When off, a ":tag" or
6186 ":tselect" command with an argument will not push the tag onto the
6187 tagstack. A following ":tag" without an argument, a ":pop" command or
6188 any other command that uses the tagstack will use the unmodified
6189 tagstack, but does change the pointer to the active entry.
6190 Resetting this option is useful when using a ":tag" command in a
6191 mapping which should not change the tagstack.
6192
6193 *'term'* *E529* *E530* *E531*
6194'term' string (default is $TERM, if that fails:
6195 in the GUI: "builtin_gui"
6196 on Amiga: "amiga"
6197 on BeOS: "beos-ansi"
6198 on Mac: "mac-ansi"
6199 on MiNT: "vt52"
6200 on MS-DOS: "pcterm"
6201 on OS/2: "os2ansi"
6202 on Unix: "ansi"
6203 on VMS: "ansi"
6204 on Win 32: "win32")
6205 global
6206 Name of the terminal. Used for choosing the terminal control
6207 characters. Environment variables are expanded |:set_env|.
6208 For example: >
6209 :set term=$TERM
6210< See |termcap|.
6211
6212 *'termbidi'* *'tbidi'*
6213 *'notermbidi'* *'notbidi'*
6214'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6215 global
6216 {not in Vi}
6217 {only available when compiled with the |+arabic|
6218 feature}
6219 The terminal is in charge of Bi-directionality of text (as specified
6220 by Unicode). The terminal is also expected to do the required shaping
6221 that some languages (such as Arabic) require.
6222 Setting this option implies that 'rightleft' will not be set when
6223 'arabic' is set and the value of 'arabicshape' will be ignored.
6224 Note that setting 'termbidi' has the immediate effect that
6225 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6226 This option is reset when the GUI is started.
6227 For further details see |arabic.txt|.
6228
6229 *'termencoding'* *'tenc'*
6230'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6231 Macintosh GUI: "macroman")
6232 global
6233 {only available when compiled with the |+multi_byte|
6234 feature}
6235 {not in Vi}
6236 Encoding used for the terminal. This specifies what character
6237 encoding the keyboard produces and the display will understand. For
6238 the GUI it only applies to the keyboard ('encoding' is used for the
6239 display).
6240 In the Win32 console version the default value is the console codepage
6241 when it differs from the ANSI codepage.
6242 *E617*
6243 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6244 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6245 Any attempts to set a different value will be rejected, and an error
6246 message is shown.
6247 For the Win32 GUI 'termencoding' is not used for typed characters,
6248 because the Win32 system always passes Unicode characters.
6249 When empty, the same encoding is used as for the 'encoding' option.
6250 This is the normal value.
6251 Not all combinations for 'termencoding' and 'encoding' are valid. See
6252 |encoding-table|.
6253 The value for this option must be supported by internal conversions or
6254 iconv(). When this is not possible no conversion will be done and you
6255 will probably experience problems with non-ASCII characters.
6256 Example: You are working with the locale set to euc-jp (Japanese) and
6257 want to edit a UTF-8 file: >
6258 :let &termencoding = &encoding
6259 :set encoding=utf-8
6260< You need to do this when your system has no locale support for UTF-8.
6261
6262 *'terse'* *'noterse'*
6263'terse' boolean (default off)
6264 global
6265 When set: Add 's' flag to 'shortmess' option (this makes the message
6266 for a search that hits the start or end of the file not being
6267 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6268 shortens a lot of messages}
6269
6270 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6271'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6272 global
6273 {not in Vi}
6274 This option is obsolete. Use 'fileformats'.
6275 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6276 set to the default value for the current system. When 'textauto' is
6277 reset, 'fileformats' is made empty.
6278 NOTE: This option is set to the Vi default value when 'compatible' is
6279 set and to the Vim default value when 'compatible' is reset.
6280
6281 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6282'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6283 others: default off)
6284 local to buffer
6285 {not in Vi}
6286 This option is obsolete. Use 'fileformat'.
6287 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6288 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6289 "unix".
6290
6291 *'textwidth'* *'tw'*
6292'textwidth' 'tw' number (default 0)
6293 local to buffer
6294 {not in Vi}
6295 Maximum width of text that is being inserted. A longer line will be
6296 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006297 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6298 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006299 'formatoptions' and |ins-textwidth|.
6300 NOTE: This option is set to 0 when 'compatible' is set.
6301
6302 *'thesaurus'* *'tsr'*
6303'thesaurus' 'tsr' string (default "")
6304 global or local to buffer |global-local|
6305 {not in Vi}
6306 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006307 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006308 the file should contain words with similar meaning, separated by
6309 non-keyword characters (white space is preferred). Maximum line
6310 length is 510 bytes.
6311 To obtain a file to be used here, check out the wordlist FAQ at
6312 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006313 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 after a comma are ignored, otherwise spaces are included in the file
6315 name. See |option-backslash| about using backslashes.
6316 The use of |:set+=| and |:set-=| is preferred when adding or removing
6317 directories from the list. This avoids problems when a future version
6318 uses another default.
6319 Backticks cannot be used in this option for security reasons.
6320
6321 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6322'tildeop' 'top' boolean (default off)
6323 global
6324 {not in Vi}
6325 When on: The tilde command "~" behaves like an operator.
6326 NOTE: This option is reset when 'compatible' is set.
6327
6328 *'timeout'* *'to'* *'notimeout'* *'noto'*
6329'timeout' 'to' boolean (default on)
6330 global
6331 *'ttimeout'* *'nottimeout'*
6332'ttimeout' boolean (default off)
6333 global
6334 {not in Vi}
6335 These two options together determine the behavior when part of a
6336 mapped key sequence or keyboard code has been received:
6337
6338 'timeout' 'ttimeout' action ~
6339 off off do not time out
6340 on on or off time out on :mappings and key codes
6341 off on time out on key codes
6342
6343 If both options are off, Vim will wait until either the complete
6344 mapping or key sequence has been received, or it is clear that there
6345 is no mapping or key sequence for the received characters. For
6346 example: if you have mapped "vl" and Vim has received 'v', the next
6347 character is needed to see if the 'v' is followed by an 'l'.
6348 When one of the options is on, Vim will wait for about 1 second for
6349 the next character to arrive. After that the already received
6350 characters are interpreted as single characters. The waiting time can
6351 be changed with the 'timeoutlen' option.
6352 On slow terminals or very busy systems timing out may cause
6353 malfunctioning cursor keys. If both options are off, Vim waits
6354 forever after an entered <Esc> if there are key codes that start
6355 with <Esc>. You will have to type <Esc> twice. If you do not have
6356 problems with key codes, but would like to have :mapped key
6357 sequences not timing out in 1 second, set the 'ttimeout' option and
6358 reset the 'timeout' option.
6359
6360 NOTE: 'ttimeout' is reset when 'compatible' is set.
6361
6362 *'timeoutlen'* *'tm'*
6363'timeoutlen' 'tm' number (default 1000)
6364 global
6365 {not in all versions of Vi}
6366 *'ttimeoutlen'* *'ttm'*
6367'ttimeoutlen' 'ttm' number (default -1)
6368 global
6369 {not in Vi}
6370 The time in milliseconds that is waited for a key code or mapped key
6371 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6372 when part of a command has been typed.
6373 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6374 different timeout value for key codes is desired set 'ttimeoutlen' to
6375 a non-negative number.
6376
6377 ttimeoutlen mapping delay key code delay ~
6378 < 0 'timeoutlen' 'timeoutlen'
6379 >= 0 'timeoutlen' 'ttimeoutlen'
6380
6381 The timeout only happens when the 'timeout' and 'ttimeout' options
6382 tell so. A useful setting would be >
6383 :set timeout timeoutlen=3000 ttimeoutlen=100
6384< (time out on mapping after three seconds, time out on key codes after
6385 a tenth of a second).
6386
6387 *'title'* *'notitle'*
6388'title' boolean (default off, on when title can be restored)
6389 global
6390 {not in Vi}
6391 {not available when compiled without the |+title|
6392 feature}
6393 When on, the title of the window will be set to the value of
6394 'titlestring' (if it is not empty), or to:
6395 filename [+=-] (path) - VIM
6396 Where:
6397 filename the name of the file being edited
6398 - indicates the file cannot be modified, 'ma' off
6399 + indicates the file was modified
6400 = indicates the file is read-only
6401 =+ indicates the file is read-only and modified
6402 (path) is the path of the file being edited
6403 - VIM the server name |v:servername| or "VIM"
6404 Only works if the terminal supports setting window titles
6405 (currently Amiga console, Win32 console, all GUI versions and
6406 terminals with a non- empty 't_ts' option - these are Unix xterm and
6407 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6408 *X11*
6409 When Vim was compiled with HAVE_X11 defined, the original title will
6410 be restored if possible. The output of ":version" will include "+X11"
6411 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6412 works for the icon name |'icon'|.
6413 But: When Vim was started with the |-X| argument, restoring the title
6414 will not work (except in the GUI).
6415 If the title cannot be restored, it is set to the value of 'titleold'.
6416 You might want to restore the title outside of Vim then.
6417 When using an xterm from a remote machine you can use this command:
6418 rsh machine_name xterm -display $DISPLAY &
6419 then the WINDOWID environment variable should be inherited and the
6420 title of the window should change back to what it should be after
6421 exiting Vim.
6422
6423 *'titlelen'*
6424'titlelen' number (default 85)
6425 global
6426 {not in Vi}
6427 {not available when compiled without the |+title|
6428 feature}
6429 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006430 title. When the title is longer, only the end of the path name is
6431 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 Using a percentage makes this adapt to the width of the window. But
6433 it won't work perfectly, because the actual number of characters
6434 available also depends on the font used and other things in the title
6435 bar. When 'titlelen' is zero the full path is used. Otherwise,
6436 values from 1 to 30000 percent can be used.
6437 'titlelen' is also used for the 'titlestring' option.
6438
6439 *'titleold'*
6440'titleold' string (default "Thanks for flying Vim")
6441 global
6442 {not in Vi}
6443 {only available when compiled with the |+title|
6444 feature}
6445 This option will be used for the window title when exiting Vim if the
6446 original title cannot be restored. Only happens if 'title' is on or
6447 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006448 This option cannot be set from a |modeline| or in the |sandbox|, for
6449 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 *'titlestring'*
6451'titlestring' string (default "")
6452 global
6453 {not in Vi}
6454 {not available when compiled without the |+title|
6455 feature}
6456 When this option is not empty, it will be used for the title of the
6457 window. This happens only when the 'title' option is on.
6458 Only works if the terminal supports setting window titles (currently
6459 Amiga console, Win32 console, all GUI versions and terminals with a
6460 non-empty 't_ts' option).
6461 When Vim was compiled with HAVE_X11 defined, the original title will
6462 be restored if possible |X11|.
6463 When this option contains printf-style '%' items, they will be
6464 expanded according to the rules used for 'statusline'.
6465 Example: >
6466 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6467 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6468< The value of 'titlelen' is used to align items in the middle or right
6469 of the available space.
6470 Some people prefer to have the file name first: >
6471 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6472< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006473 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 separating space only when needed.
6475 NOTE: Use of special characters in 'titlestring' may cause the display
6476 to be garbled (e.g., when it contains a CR or NL character).
6477 {not available when compiled without the |+statusline| feature}
6478
6479 *'toolbar'* *'tb'*
6480'toolbar' 'tb' string (default "icons,tooltips")
6481 global
6482 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6483 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006484 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006485 possible values are:
6486 icons Toolbar buttons are shown with icons.
6487 text Toolbar buttons shown with text.
6488 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006489 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006490 tooltips Tooltips are active for toolbar buttons.
6491 Tooltips refer to the popup help text which appears after the mouse
6492 cursor is placed over a toolbar button for a brief moment.
6493
6494 If you want the toolbar to be shown with icons as well as text, do the
6495 following: >
6496 :set tb=icons,text
6497< Motif and Athena cannot display icons and text at the same time. They
6498 will show icons if both are requested.
6499
6500 If none of the strings specified in 'toolbar' are valid or if
6501 'toolbar' is empty, this option is ignored. If you want to disable
6502 the toolbar, you need to set the 'guioptions' option. For example: >
6503 :set guioptions-=T
6504< Also see |gui-toolbar|.
6505
6506 *'toolbariconsize'* *'tbis'*
6507'toolbariconsize' 'tbis' string (default "small")
6508 global
6509 {not in Vi}
6510 {only in the GTK+ 2 GUI}
6511 Controls the size of toolbar icons. The possible values are:
6512 tiny Use tiny toolbar icons.
6513 small Use small toolbar icons (default).
6514 medium Use medium-sized toolbar icons.
6515 large Use large toolbar icons.
6516 The exact dimensions in pixels of the various icon sizes depend on
6517 the current theme. Common dimensions are large=32x32, medium=24x24,
6518 small=20x20 and tiny=16x16.
6519
6520 If 'toolbariconsize' is empty, the global default size as determined
6521 by user preferences or the current theme is used.
6522
6523 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6524'ttybuiltin' 'tbi' boolean (default on)
6525 global
6526 {not in Vi}
6527 When on, the builtin termcaps are searched before the external ones.
6528 When off the builtin termcaps are searched after the external ones.
6529 When this option is changed, you should set the 'term' option next for
6530 the change to take effect, for example: >
6531 :set notbi term=$TERM
6532< See also |termcap|.
6533 Rationale: The default for this option is "on", because the builtin
6534 termcap entries are generally better (many systems contain faulty
6535 xterm entries...).
6536
6537 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6538'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6539 sun-cmd, screen, rxvt, dtterm or
6540 iris-ansi; also on when running Vim in
6541 a DOS console)
6542 global
6543 {not in Vi}
6544 Indicates a fast terminal connection. More characters will be sent to
6545 the screen for redrawing, instead of using insert/delete line
6546 commands. Improves smoothness of redrawing when there are multiple
6547 windows and the terminal does not support a scrolling region.
6548 Also enables the extra writing of characters at the end of each screen
6549 line for lines that wrap. This helps when using copy/paste with the
6550 mouse in an xterm and other terminals.
6551
6552 *'ttymouse'* *'ttym'*
6553'ttymouse' 'ttym' string (default depends on 'term')
6554 global
6555 {not in Vi}
6556 {only in Unix and VMS, doesn't work in the GUI; not
6557 available when compiled without |+mouse|}
6558 Name of the terminal type for which mouse codes are to be recognized.
6559 Currently these three strings are valid:
6560 *xterm-mouse*
6561 xterm xterm-like mouse handling. The mouse generates
6562 "<Esc>[Mscr", where "scr" is three bytes:
6563 "s" = button state
6564 "c" = column plus 33
6565 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006566 This only works up to 223 columns! See "dec" for a
6567 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 xterm2 Works like "xterm", but with the xterm reporting the
6569 mouse position while the mouse is dragged. This works
6570 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006571 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006572 work. See below for how Vim detects this
6573 automatically.
6574 *netterm-mouse*
6575 netterm NetTerm mouse handling. The mouse generates
6576 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6577 for the row and column.
6578 *dec-mouse*
6579 dec DEC terminal mouse handling. The mouse generates a
6580 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006581 This is also available for an Xterm, if it was
6582 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 *jsbterm-mouse*
6584 jsbterm JSB term mouse handling.
6585 *pterm-mouse*
6586 pterm QNX pterm mouse handling.
6587
6588 The mouse handling must be enabled at compile time |+mouse_xterm|
6589 |+mouse_dec| |+mouse_netterm|.
6590 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6591 recognized, if enabled at compile time. DEC terminal mouse codes
6592 are recognized if enabled at compile time, and 'ttymouse' is not
6593 "xterm" (because the xterm and dec mouse codes conflict).
6594 This option is automatically set to "xterm", when the 'term' option is
6595 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6596 or "xterm2" already. The main use of this option is to set it to
6597 "xterm", when the terminal name doesn't start with "xterm", but it can
6598 handle xterm mouse codes.
6599 The "xterm2" value will be set if the xterm version is reported to be
6600 95 of higher. This only works when compiled with the |+termresponse|
6601 feature and if |t_RV| is set to the escape sequence to request the
6602 xterm version number. Otherwise "xterm2" must be set explicitly.
6603 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6604 t_RV to an empty string: >
6605 :set t_RV=
6606<
6607 *'ttyscroll'* *'tsl'*
6608'ttyscroll' 'tsl' number (default 999)
6609 global
6610 Maximum number of lines to scroll the screen. If there are more lines
6611 to scroll the window is redrawn. For terminals where scrolling is
6612 very slow and redrawing is not slow this can be set to a small number,
6613 e.g., 3, to speed up displaying.
6614
6615 *'ttytype'* *'tty'*
6616'ttytype' 'tty' string (default from $TERM)
6617 global
6618 Alias for 'term', see above.
6619
6620 *'undolevels'* *'ul'*
6621'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6622 Win32 and OS/2)
6623 global
6624 {not in Vi}
6625 Maximum number of changes that can be undone. Since undo information
6626 is kept in memory, higher numbers will cause more memory to be used
6627 (nevertheless, a single change can use an unlimited amount of memory).
6628 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6629 itself: >
6630 set ul=0
6631< But you can also get Vi compatibility by including the 'u' flag in
6632 'cpoptions', and still be able to use CTRL-R to repeat undo.
6633 Set to a negative number for no undo at all: >
6634 set ul=-1
6635< This helps when you run out of memory for a single change.
6636 Also see |undo-two-ways|.
6637
6638 *'updatecount'* *'uc'*
6639'updatecount' 'uc' number (default: 200)
6640 global
6641 {not in Vi}
6642 After typing this many characters the swap file will be written to
6643 disk. When zero, no swap file will be created at all (see chapter on
6644 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6645 Vim with the "-n" option, see |startup|. When editing in readonly
6646 mode this option will be initialized to 10000.
6647 The swapfile can be disabled per buffer with |'swapfile'|.
6648 When 'updatecount' is set from zero to non-zero, swap files are
6649 created for all buffers that have 'swapfile' set. When 'updatecount'
6650 is set to zero, existing swap files are not deleted.
6651 Also see |'swapsync'|.
6652 This option has no meaning in buffers where |'buftype'| is "nofile"
6653 or "nowrite".
6654
6655 *'updatetime'* *'ut'*
6656'updatetime' 'ut' number (default 4000)
6657 global
6658 {not in Vi}
6659 If this many milliseconds nothing is typed the swap file will be
6660 written to disk (see |crash-recovery|). Also used for the
6661 |CursorHold| autocommand event.
6662
6663 *'verbose'* *'vbs'*
6664'verbose' 'vbs' number (default 0)
6665 global
6666 {not in Vi, although some versions have a boolean
6667 verbose option}
6668 When bigger than zero, Vim will give messages about what it is doing.
6669 Currently, these messages are given:
6670 >= 1 When the viminfo file is read or written.
6671 >= 2 When a file is ":source"'ed.
6672 >= 5 Every searched tags file.
6673 >= 8 Files for which a group of autocommands is executed.
6674 >= 9 Every executed autocommand.
6675 >= 12 Every executed function.
6676 >= 13 When an exception is thrown, caught, finished, or discarded.
6677 >= 14 Anything pending in a ":finally" clause.
6678 >= 15 Every executed Ex command (truncated at 200 characters).
6679
6680 This option can also be set with the "-V" argument. See |-V|.
6681 This option is also set by the |:verbose| command.
6682
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006683 When the 'verbosefile' option is set then the verbose messages are not
6684 displayed.
6685
6686 *'verbosefile'* *'vfile'*
6687'verbosefile' 'vfile' string (default empty)
6688 global
6689 {not in Vi}
6690 When not empty all messages are written in a file with this name.
6691 When the file exists messages are appended.
6692 Writing to the file ends when Vim exits or when 'verbosefile' is made
6693 empty.
6694 Setting 'verbosefile' to a new value is like making it empty first.
6695 The difference with |:redir| is that verbose messages are not
6696 displayed when 'verbosefile' is set.
6697
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 *'viewdir'* *'vdir'*
6699'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6700 "$VIM/vimfiles/view",
6701 for Unix: "~/.vim/view",
6702 for Macintosh: "$VIM:vimfiles:view"
6703 for VMS: "sys$login:vimfiles/view"
6704 for RiscOS: "Choices:vimfiles/view")
6705 global
6706 {not in Vi}
6707 {not available when compiled without the +mksession
6708 feature}
6709 Name of the directory where to store files for |:mkview|.
6710 This option cannot be set from a |modeline| or in the |sandbox|, for
6711 security reasons.
6712
6713 *'viewoptions'* *'vop'*
6714'viewoptions' 'vop' string (default: "folds,options,cursor")
6715 global
6716 {not in Vi}
6717 {not available when compiled without the +mksession
6718 feature}
6719 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006720 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 word save and restore ~
6722 cursor cursor position in file and in window
6723 folds manually created folds, opened/closed folds and local
6724 fold options
6725 options options and mappings local to a window or buffer (not
6726 global values for local options)
6727 slash backslashes in file names replaced with forward
6728 slashes
6729 unix with Unix end-of-line format (single <NL>), even when
6730 on Windows or DOS
6731
6732 "slash" and "unix" are useful on Windows when sharing view files
6733 with Unix. The Unix version of Vim cannot source dos format scripts,
6734 but the Windows version of Vim can source unix format scripts.
6735
6736 *'viminfo'* *'vi'* *E526* *E527* *E528*
6737'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6738 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6739 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6740 for others: '20,<50,s10,h)
6741 global
6742 {not in Vi}
6743 {not available when compiled without the |+viminfo|
6744 feature}
6745 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006746 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 separated list of parameters, each consisting of a single character
6748 identifying the particular parameter, followed by a number or string
6749 which specifies the value of that parameter. If a particular
6750 character is left out, then the default value is used for that
6751 parameter. The following is a list of the identifying characters and
6752 the effect of their value.
6753 CHAR VALUE ~
6754 ! When included, save and restore global variables that start
6755 with an uppercase letter, and don't contain a lowercase
6756 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006757 and "_K_L_M" are not. Only String and Number types are
6758 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 " Maximum number of lines saved for each register. Old name of
6760 the '<' item, with the disadvantage that you need to put a
6761 backslash before the ", otherwise it will be recognized as the
6762 start of a comment!
6763 % When included, save and restore the buffer list. If Vim is
6764 started with a file name argument, the buffer list is not
6765 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 without a file name and buffers for help files are not written
6768 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006769 When followed by a number, the number specifies the maximum
6770 number of buffers that are stored. Without a number all
6771 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 ' Maximum number of previously edited files for which the marks
6773 are remembered. This parameter must always be included when
6774 'viminfo' is non-empty.
6775 Including this item also means that the |jumplist| and the
6776 |changelist| are stored in the viminfo file.
6777 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006778 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006779 patterns are also saved. When not included, the value of
6780 'history' is used.
6781 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006782 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 < Maximum number of lines saved for each register. If zero then
6784 registers are not saved. When not included, all lines are
6785 saved. '"' is the old name for this item.
6786 Also see the 's' item below: limit specified in Kbyte.
6787 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 c When included, convert the text in the viminfo file from the
6790 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006791 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792 f Whether file marks need to be stored. If zero, file marks ('0
6793 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006794 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 cursor position (when exiting or when doing ":wviminfo").
6796 h Disable the effect of 'hlsearch' when loading the viminfo
6797 file. When not included, it depends on whether ":nohlsearch"
6798 has been used since the last search command.
6799 n Name of the viminfo file. The name must immediately follow
6800 the 'n'. Must be the last one! If the "-i" argument was
6801 given when starting Vim, that file name overrides the one
6802 given here with 'viminfo'. Environment variables are expanded
6803 when opening the file, not when setting the option.
6804 r Removable media. The argument is a string (up to the next
6805 ','). This parameter can be given several times. Each
6806 specifies the start of a path for which no marks will be
6807 stored. This is to avoid removable media. For MS-DOS you
6808 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6809 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6810 ignored. Maximum length of each 'r' argument is 50
6811 characters.
6812 s Maximum size of an item in Kbyte. If zero then registers are
6813 not saved. Currently only applies to registers. The default
6814 "s10" will exclude registers with more than 10 Kbyte of text.
6815 Also see the '<' item above: line count limit.
6816
6817 Example: >
6818 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6819<
6820 '50 Marks will be remembered for the last 50 files you
6821 edited.
6822 <1000 Contents of registers (up to 1000 lines each) will be
6823 remembered.
6824 s100 Registers with more than 100 Kbyte text are skipped.
6825 :0 Command-line history will not be saved.
6826 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6827 no / Since '/' is not specified, the default will be used,
6828 that is, save all of the search history, and also the
6829 previous search and substitute patterns.
6830 no % The buffer list will not be saved nor read back.
6831 no h 'hlsearch' highlighting will be restored.
6832
6833 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6834 load the contents of the file, this is not done automatically.
6835
6836 This option cannot be set from a |modeline| or in the |sandbox|, for
6837 security reasons.
6838
6839 *'virtualedit'* *'ve'*
6840'virtualedit' 've' string (default "")
6841 global
6842 {not in Vi}
6843 {not available when compiled without the
6844 |+virtualedit| feature}
6845 A comma separated list of these words:
6846 block Allow virtual editing in Visual block mode.
6847 insert Allow virtual editing in Insert mode.
6848 all Allow virtual editing in all modes.
6849 Virtual editing means that the cursor can be positioned where there is
6850 no actual character. This can be halfway into a Tab or beyond the end
6851 of the line. Useful for selecting a rectangle in Visual mode and
6852 editing a table.
6853
6854 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6855'visualbell' 'vb' boolean (default off)
6856 global
6857 {not in Vi}
6858 Use visual bell instead of beeping. The terminal code to display the
6859 visual bell is given with 't_vb'. When no beep or flash is wanted,
6860 use ":set vb t_vb=".
6861 Note: When the GUI starts, 't_vb' is reset to its default value. You
6862 might want to set it again in your |gvimrc|.
6863 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6864 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6865 where 40 is the time in msec.
6866 Does not work on the Amiga, you always get a screen flash.
6867 Also see 'errorbells'.
6868
6869 *'warn'* *'nowarn'*
6870'warn' boolean (default on)
6871 global
6872 Give a warning message when a shell command is used while the buffer
6873 has been changed.
6874
6875 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6876'weirdinvert' 'wiv' boolean (default off)
6877 global
6878 {not in Vi}
6879 This option has the same effect as the 't_xs' termcap option.
6880 It is provided for backwards compatibility with version 4.x.
6881 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6882 vice versa. Has no effect when the GUI is running.
6883
6884 *'whichwrap'* *'ww'*
6885'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6886 global
6887 {not in Vi}
6888 Allow specified keys that move the cursor left/right to move to the
6889 previous/next line when the cursor is on the first/last character in
6890 the line. Concatenate characters to allow this for these keys:
6891 char key mode ~
6892 b <BS> Normal and Visual
6893 s <Space> Normal and Visual
6894 h "h" Normal and Visual
6895 l "l" Normal and Visual
6896 < <Left> Normal and Visual
6897 > <Right> Normal and Visual
6898 ~ "~" Normal
6899 [ <Left> Insert and Replace
6900 ] <Right> Insert and Replace
6901 For example: >
6902 :set ww=<,>,[,]
6903< allows wrap only when cursor keys are used.
6904 When the movement keys are used in combination with a delete or change
6905 operator, the <EOL> also counts for a character. This makes "3h"
6906 different from "3dh" when the cursor crosses the end of a line. This
6907 is also true for "x" and "X", because they do the same as "dl" and
6908 "dh". If you use this, you may also want to use the mapping
6909 ":map <BS> X" to make backspace delete the character in front of the
6910 cursor.
6911 When 'l' is included, you get a side effect: "yl" on an empty line
6912 will include the <EOL>, so that "p" will insert a new line.
6913 NOTE: This option is set to the Vi default value when 'compatible' is
6914 set and to the Vim default value when 'compatible' is reset.
6915
6916 *'wildchar'* *'wc'*
6917'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6918 global
6919 {not in Vi}
6920 Character you have to type to start wildcard expansion in the
6921 command-line, as specified with 'wildmode'.
6922 The character is not recognized when used inside a macro. See
6923 'wildcharm' for that.
6924 Although 'wc' is a number option, you can set it to a special key: >
6925 :set wc=<Esc>
6926< NOTE: This option is set to the Vi default value when 'compatible' is
6927 set and to the Vim default value when 'compatible' is reset.
6928
6929 *'wildcharm'* *'wcm'*
6930'wildcharm' 'wcm' number (default: none (0))
6931 global
6932 {not in Vi}
6933 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006934 recognized when used inside a macro. You can find "spare" command-line
6935 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00006936 you'll never actually type 'wildcharm', just use it in mappings that
6937 automatically invoke completion mode, e.g.: >
6938 :set wcm=<C-Z>
6939 :cmap ss so $vim/sessions/*.vim<C-Z>
6940< Then after typing :ss you can use CTRL-P & CTRL-N.
6941
6942 *'wildignore'* *'wig'*
6943'wildignore' 'wig' string (default "")
6944 global
6945 {not in Vi}
6946 {not available when compiled without the |+wildignore|
6947 feature}
6948 A list of file patterns. A file that matches with one of these
6949 patterns is ignored when completing file or directory names.
6950 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6951 Also see 'suffixes'.
6952 Example: >
6953 :set wildignore=*.o,*.obj
6954< The use of |:set+=| and |:set-=| is preferred when adding or removing
6955 a pattern from the list. This avoids problems when a future version
6956 uses another default.
6957
6958 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6959'wildmenu' 'wmnu' boolean (default off)
6960 global
6961 {not in Vi}
6962 {not available if compiled without the |+wildmenu|
6963 feature}
6964 When 'wildmenu' is on, command-line completion operates in an enhanced
6965 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
6966 the possible matches are shown just above the command line, with the
6967 first match highlighted (overwriting the status line, if there is
6968 one). Keys that show the previous/next match, such as <Tab> or
6969 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
6970 When 'wildmode' is used, "wildmenu" mode is used where "full" is
6971 specified. "longest" and "list" do not start "wildmenu" mode.
6972 If there are more matches than can fit in the line, a ">" is shown on
6973 the right and/or a "<" is shown on the left. The status line scrolls
6974 as needed.
6975 The "wildmenu" mode is abandoned when a key is hit that is not used
6976 for selecting a completion.
6977 While the "wildmenu" is active the following keys have special
6978 meanings:
6979
6980 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
6981 <Down> - in filename/menu name completion: move into a
6982 subdirectory or submenu.
6983 <CR> - in menu completion, when the cursor is just after a
6984 dot: move into a submenu.
6985 <Up> - in filename/menu name completion: move up into
6986 parent directory or parent menu.
6987
6988 This makes the menus accessible from the console |console-menus|.
6989
6990 If you prefer the <Left> and <Right> keys to move the cursor instead
6991 of selecting a different match, use this: >
6992 :cnoremap <Left> <Space><BS><Left>
6993 :cnoremap <Right> <Space><BS><Right>
6994<
6995 The "WildMenu" highlighting is used for displaying the current match
6996 |hl-WildMenu|.
6997
6998 *'wildmode'* *'wim'*
6999'wildmode' 'wim' string (Vim default: "full")
7000 global
7001 {not in Vi}
7002 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007003 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007004 part specifies what to do for each consecutive use of 'wildchar. The
7005 first part specifies the behavior for the first use of 'wildchar',
7006 The second part for the second use, etc.
7007 These are the possible values for each part:
7008 "" Complete only the first match.
7009 "full" Complete the next full match. After the last match,
7010 the original string is used and then the first match
7011 again.
7012 "longest" Complete till longest common string. If this doesn't
7013 result in a longer string, use the next part.
7014 "longest:full" Like "longest", but also start 'wildmenu' if it is
7015 enabled.
7016 "list" When more than one match, list all matches.
7017 "list:full" When more than one match, list all matches and
7018 complete first match.
7019 "list:longest" When more than one match, list all matches and
7020 complete till longest common string.
7021 When there is only a single match, it is fully completed in all cases.
7022
7023 Examples: >
7024 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007025< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 :set wildmode=longest,full
7027< Complete longest common string, then each full match >
7028 :set wildmode=list:full
7029< List all matches and complete each full match >
7030 :set wildmode=list,full
7031< List all matches without completing, then each full match >
7032 :set wildmode=longest,list
7033< Complete longest common string, then list alternatives.
7034
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007035 *'wildoptions'* *'wop'*
7036'wildoptions' 'wop' string (default "")
7037 global
7038 {not in Vi}
7039 {not available when compiled without the |+wildignore|
7040 feature}
7041 A list of words that change how command line completion is done.
7042 Currently only one word is allowed:
7043 tagfile When using CTRL-D to list matching tags, the kind of
7044 tag and the file of the tag is listed. Only one match
7045 is displayed per line. Often used tag kinds are:
7046 d #define
7047 f function
7048 Also see |cmdline-completion|.
7049
Bram Moolenaar071d4272004-06-13 20:20:40 +00007050 *'winaltkeys'* *'wak'*
7051'winaltkeys' 'wak' string (default "menu")
7052 global
7053 {not in Vi}
7054 {only used in Win32, Motif, GTK and Photon GUI}
7055 Some GUI versions allow the access to menu entries by using the ALT
7056 key in combination with a character that appears underlined in the
7057 menu. This conflicts with the use of the ALT key for mappings and
7058 entering special characters. This option tells what to do:
7059 no Don't use ALT keys for menus. ALT key combinations can be
7060 mapped, but there is no automatic handling. This can then be
7061 done with the |:simalt| command.
7062 yes ALT key handling is done by the windowing system. ALT key
7063 combinations cannot be mapped.
7064 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007065 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007066 keys can be mapped.
7067 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7068 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007069 This option is not used for <F10>; on Win32 and with GTK <F10> will
7070 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007071
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007072 *'window'* *'wi'*
7073'window' 'wi' number (default screen height - 1)
7074 global
7075 Window height. Do not confuse this with the height of the Vim window,
7076 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007077 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7078 value is smaller than 'lines' minus one. The screen will scroll
7079 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007080 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7081 in a much smarter way, taking care of wrapping lines.
7082 When resizing the Vim window, the value is smaller than 1 or more than
7083 or equal to 'lines' it will be set to 'lines' minus 1.
7084 {Vi also uses the option to specify the number of displayed lines}
7085
Bram Moolenaar071d4272004-06-13 20:20:40 +00007086 *'winheight'* *'wh'* *E591*
7087'winheight' 'wh' number (default 1)
7088 global
7089 {not in Vi}
7090 {not available when compiled without the +windows
7091 feature}
7092 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007093 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007094 current window is smaller, its size is increased, at the cost of the
7095 height of other windows. Set it to 999 to make the current window
7096 always fill the screen (although this has the drawback that ":all"
7097 will create only two windows). Set it to a small number for normal
7098 editing.
7099 Minimum value is 1.
7100 The height is not adjusted after one of the commands to change the
7101 height of the current window.
7102 'winheight' applies to the current window. Use 'winminheight' to set
7103 the minimal height for other windows.
7104
7105 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7106'winfixheight' 'wfh' boolean (default off)
7107 local to window
7108 {not in Vi}
7109 {not available when compiled without the +windows
7110 feature}
7111 Keep the window height when windows are opened or closed and
7112 'equalalways' is set. Set by default for the |preview-window| and
7113 |quickfix-window|.
7114 The height may be changed anyway when running out of room.
7115
7116 *'winminheight'* *'wmh'*
7117'winminheight' 'wmh' number (default 1)
7118 global
7119 {not in Vi}
7120 {not available when compiled without the +windows
7121 feature}
7122 The minimal height of a window, when it's not the current window.
7123 This is a hard minimum, windows will never become smaller.
7124 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7125 status bar) if necessary. They will return to at least one line when
7126 they become active (since the cursor has to have somewhere to go.)
7127 Use 'winheight' to set the minimal height of the current window.
7128 This option is only checked when making a window smaller. Don't use a
7129 large number, it will cause errors when opening more than a few
7130 windows. A value of 0 to 3 is reasonable.
7131
7132 *'winminwidth'* *'wmw'*
7133'winminwidth' 'wmw' number (default 1)
7134 global
7135 {not in Vi}
7136 {not available when compiled without the +vertsplit
7137 feature}
7138 The minimal width of a window, when it's not the current window.
7139 This is a hard minimum, windows will never become smaller.
7140 When set to zero, windows may be "squashed" to zero columns (i.e. just
7141 a vertical separator) if necessary. They will return to at least one
7142 line when they become active (since the cursor has to have somewhere
7143 to go.)
7144 Use 'winwidth' to set the minimal width of the current window.
7145 This option is only checked when making a window smaller. Don't use a
7146 large number, it will cause errors when opening more than a few
7147 windows. A value of 0 to 12 is reasonable.
7148
7149 *'winwidth'* *'wiw'* *E592*
7150'winwidth' 'wiw' number (default 20)
7151 global
7152 {not in Vi}
7153 {not available when compiled without the +vertsplit
7154 feature}
7155 Minimal number of columns for the current window. This is not a hard
7156 minimum, Vim will use fewer columns if there is not enough room. If
7157 the current window is smaller, its size is increased, at the cost of
7158 the width of other windows. Set it to 999 to make the current window
7159 always fill the screen. Set it to a small number for normal editing.
7160 The width is not adjusted after one of the commands to change the
7161 width of the current window.
7162 'winwidth' applies to the current window. Use 'winminwidth' to set
7163 the minimal width for other windows.
7164
7165 *'wrap'* *'nowrap'*
7166'wrap' boolean (default on)
7167 local to window
7168 {not in Vi}
7169 This option changes how text is displayed. It doesn't change the text
7170 in the buffer, see 'textwidth' for that.
7171 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007172 displaying continues on the next line. When off lines will not wrap
7173 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 moved to a part that is not shown, the screen will scroll
7175 horizontally.
7176 The line will be broken in the middle of a word if necessary. See
7177 'linebreak' to get the break at a word boundary.
7178 To make scrolling horizontally a bit more useful, try this: >
7179 :set sidescroll=5
7180 :set listchars+=precedes:<,extends:>
7181< See 'sidescroll', 'listchars' and |wrap-off|.
7182
7183 *'wrapmargin'* *'wm'*
7184'wrapmargin' 'wm' number (default 0)
7185 local to buffer
7186 Number of characters from the right window border where wrapping
7187 starts. When typing text beyond this limit, an <EOL> will be inserted
7188 and inserting continues on the next line.
7189 Options that add a margin, such as 'number' and 'foldcolumn', cause
7190 the text width to be further reduced. This is Vi compatible.
7191 When 'textwidth' is non-zero, this option is not used.
7192 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7193 and less usefully}
7194
7195 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7196'wrapscan' 'ws' boolean (default on) *E384* *E385*
7197 global
7198 Searches wrap around the end of the file.
7199
7200 *'write'* *'nowrite'*
7201'write' boolean (default on)
7202 global
7203 {not in Vi}
7204 Allows writing files. When not set, writing a file is not allowed.
7205 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007206 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 argument. Filtering text is still possible, even though this requires
7208 writing a temporary file.
7209
7210 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7211'writeany' 'wa' boolean (default off)
7212 global
7213 Allows writing to any file with no need for "!" override.
7214
7215 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7216'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7217 otherwise)
7218 global
7219 {not in Vi}
7220 Make a backup before overwriting a file. The backup is removed after
7221 the file was successfully written, unless the 'backup' option is
7222 also on. Reset this option if your file system is almost full. See
7223 |backup-table| for another explanation.
7224 When the 'backupskip' pattern matches, a backup is not made anyway.
7225 NOTE: This option is set to the default value when 'compatible' is
7226 set.
7227
7228 *'writedelay'* *'wd'*
7229'writedelay' 'wd' number (default 0)
7230 global
7231 {not in Vi}
7232 The number of microseconds to wait for each character sent to the
7233 screen. When non-zero, characters are sent to the terminal one by
7234 one. For MS-DOS pcterm this does not work. For debugging purposes.
7235
7236 vim:tw=78:ts=8:ft=help:norl: