blob: f17cf6516d0f2e37ba4e939a94a49923367eff0c [file] [log] [blame]
Bram Moolenaar572cb562005-08-05 21:35:02 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Aug 05
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
Bram Moolenaar572cb562005-08-05 21:35:02 +00001610 When searching for matches takes some time call |complete_add()| to
1611 add each match to the total list. These matches should then not
1612 appear in the returned list! Call |complete_check()| now and then to
1613 allow the user to press a key while still searching for matches. Stop
1614 searching when it returns non-zero.
1615
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001616 The function must not move the cursor!
Bram Moolenaar572cb562005-08-05 21:35:02 +00001617 This option cannot be set from a |modeline| or in the |sandbox|, for
1618 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001619
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001620 An example that completes the names of the months: >
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001621 fun! CompleteMonths(findstart, col, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001622 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001623 " locate the start of the word
1624 let line = getline('.')
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001625 let start = a:col
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001626 while start > 0 && line[start - 1] =~ '\a'
1627 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001628 endwhile
1629 return start
1630 else
1631 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001632 let res = []
1633 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1634 if m =~ '^' . a:base
1635 call add(res, m)
1636 endif
1637 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001638 return res
1639 endif
1640 endfun
1641 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001642<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001643 The same, but now pretending searching for matches is slow: >
1644 fun! CompleteMonths(findstart, col, base)
1645 if a:findstart
1646 " locate the start of the word
1647 let line = getline('.')
1648 let start = a:col
1649 while start > 0 && line[start - 1] =~ '\a'
1650 let start -= 1
1651 endwhile
1652 return start
1653 else
1654 " find months matching with "a:base"
1655 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1656 if m =~ '^' . a:base
1657 call complete_add(m)
1658 endif
1659 sleep 300m " simulate searching for next match
1660 if complete_check()
1661 break
1662 endif
1663 endfor
1664 return []
1665 endif
1666 endfun
1667 set completefunc=CompleteMonths
1668<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001669
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1671'confirm' 'cf' boolean (default off)
1672 global
1673 {not in Vi}
1674 When 'confirm' is on, certain operations that would normally
1675 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1676 instead raise a |dialog| asking if you wish to save the current
1677 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1678 If 'confirm' is off you can still activate confirmation for one
1679 command only (this is most useful in mappings) with the |:confirm|
1680 command.
1681 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1682
1683 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1684'conskey' 'consk' boolean (default off)
1685 global
1686 {not in Vi} {only for MS-DOS}
1687 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001688 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 three methods of console input are available:
1690 'conskey' 'bioskey' action ~
1691 on on or off direct console input
1692 off on BIOS
1693 off off STDIN
1694
1695 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1696'copyindent' 'ci' boolean (default off)
1697 local to buffer
1698 {not in Vi}
1699 Copy the structure of the existing lines indent when autoindenting a
1700 new line. Normally the new indent is reconstructed by a series of
1701 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1702 in which case only spaces are used). Enabling this option makes the
1703 new line copy whatever characters were used for indenting on the
1704 existing line. If the new indent is greater than on the existing
1705 line, the remaining space is filled in the normal manner.
1706 NOTE: 'copyindent' is reset when 'compatible' is set.
1707 Also see 'preserveindent'.
1708
1709 *'cpoptions'* *'cpo'*
1710'cpoptions' 'cpo' string (Vim default: "aABceFs",
1711 Vi default: all flags)
1712 global
1713 {not in Vi}
1714 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001715 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 not being vi-compatible is mostly or sometimes preferred.
1717 'cpoptions' stands for "compatible-options".
1718 Commas can be added for readability.
1719 To avoid problems with flags that are added in the future, use the
1720 "+=" and "-=" feature of ":set" |add-option-flags|.
1721 NOTE: This option is set to the Vi default value when 'compatible' is
1722 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001723 NOTE: This option is set to the POSIX default value at startup when
1724 the Vi default value would be used and the $VIM_POSIX environment
1725 variable exists |posix|. This means tries to behave like the POSIX
1726 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727
1728 contains behavior ~
1729 *cpo-a*
1730 a When included, a ":read" command with a file name
1731 argument will set the alternate file name for the
1732 current window.
1733 *cpo-A*
1734 A When included, a ":write" command with a file name
1735 argument will set the alternate file name for the
1736 current window.
1737 *cpo-b*
1738 b "\|" in a ":map" command is recognized as the end of
1739 the map command. The '\' is included in the mapping,
1740 the text after the '|' is interpreted as the next
1741 command. Use a CTRL-V instead of a backslash to
1742 include the '|' in the mapping. Applies to all
1743 mapping, abbreviation, menu and autocmd commands.
1744 See also |map_bar|.
1745 *cpo-B*
1746 B A backslash has no special meaning in mappings,
1747 abbreviations and the "to" part of the menu commands.
1748 Remove this flag to be able to use a backslash like a
1749 CTRL-V. For example, the command ":map X \<Esc>"
1750 results in X being mapped to:
1751 'B' included: "\^[" (^[ is a real <Esc>)
1752 'B' excluded: "<Esc>" (5 characters)
1753 ('<' excluded in both cases)
1754 *cpo-c*
1755 c Searching continues at the end of any match at the
1756 cursor position, but not further than the start of the
1757 next line. When not present searching continues
1758 one character from the cursor position. With 'c'
1759 "abababababab" only gets three matches when repeating
1760 "/abab", without 'c' there are five matches.
1761 *cpo-C*
1762 C Do not concatenate sourced lines that start with a
1763 backslash. See |line-continuation|.
1764 *cpo-d*
1765 d Using "./" in the 'tags' option doesn't mean to use
1766 the tags file relative to the current file, but the
1767 tags file in the current directory.
1768 *cpo-D*
1769 D Can't use CTRL-K to enter a digraph after Normal mode
1770 commands with a character argument, like |r|, |f| and
1771 |t|.
1772 *cpo-e*
1773 e When executing a register with ":@r", always add a
1774 <CR> to the last line, also when the register is not
1775 linewise. If this flag is not present, the register
1776 is not linewise and the last line does not end in a
1777 <CR>, then the last line is put on the command-line
1778 and can be edited before hitting <CR>.
1779 *cpo-E*
1780 E It is an error when using "y", "d", "c", "g~", "gu" or
1781 "gU" on an Empty region. The operators only work when
1782 at least one character is to be operate on. Example:
1783 This makes "y0" fail in the first column.
1784 *cpo-f*
1785 f When included, a ":read" command with a file name
1786 argument will set the file name for the current buffer,
1787 if the current buffer doesn't have a file name yet.
1788 *cpo-F*
1789 F When included, a ":write" command with a file name
1790 argument will set the file name for the current
1791 buffer, if the current buffer doesn't have a file name
1792 yet.
1793 *cpo-g*
1794 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001795 *cpo-H*
1796 H When using "I" on a line with only blanks, insert
1797 before the last blank. Without this flag insert after
1798 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 *cpo-i*
1800 i When included, interrupting the reading of a file will
1801 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001802 *cpo-I*
1803 I When moving the cursor up or down just after inserting
1804 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001805 *cpo-j*
1806 j When joining lines, only add two spaces after a '.',
1807 not after '!' or '?'. Also see 'joinspaces'.
1808 *cpo-J*
1809 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001810 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001811 white space.
1812 *cpo-k*
1813 k Disable the recognition of raw key codes in
1814 mappings, abbreviations, and the "to" part of menu
1815 commands. For example, if <Key> sends ^[OA (where ^[
1816 is <Esc>), the command ":map X ^[OA" results in X
1817 being mapped to:
1818 'k' included: "^[OA" (3 characters)
1819 'k' excluded: "<Key>" (one key code)
1820 Also see the '<' flag below.
1821 *cpo-K*
1822 K Don't wait for a key code to complete when it is
1823 halfway a mapping. This breaks mapping <F1><F1> when
1824 only part of the second <F1> has been read. It
1825 enables cancelling the mapping by typing <F1><Esc>.
1826 *cpo-l*
1827 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001828 literally, only "\]", "\^", "\-" and "\\" are special.
1829 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1831 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001832 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 *cpo-L*
1834 L When the 'list' option is set, 'wrapmargin',
1835 'textwidth', 'softtabstop' and Virtual Replace mode
1836 (see |gR|) count a <Tab> as two characters, instead of
1837 the normal behavior of a <Tab>.
1838 *cpo-m*
1839 m When included, a showmatch will always wait half a
1840 second. When not included, a showmatch will wait half
1841 a second or until a character is typed. |'showmatch'|
1842 *cpo-M*
1843 M When excluded, "%" matching will take backslashes into
1844 account. Thus in "( \( )" and "\( ( \)" the outer
1845 parenthesis match. When included "%" ignores
1846 backslashes, which is Vi compatible.
1847 *cpo-n*
1848 n When included, the column used for 'number' will also
1849 be used for text of wrapped lines.
1850 *cpo-o*
1851 o Line offset to search command is not remembered for
1852 next search.
1853 *cpo-O*
1854 O Don't complain if a file is being overwritten, even
1855 when it didn't exist when editing it. This is a
1856 protection against a file unexpectedly created by
1857 someone else. Vi didn't complain about this.
1858 *cpo-p*
1859 p Vi compatible Lisp indenting. When not present, a
1860 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001861 *cpo-q*
1862 q When joining multiple lines leave the cursor at the
1863 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 *cpo-r*
1865 r Redo ("." command) uses "/" to repeat a search
1866 command, instead of the actually used search string.
1867 *cpo-R*
1868 R Remove marks from filtered lines. Without this flag
1869 marks are kept like |:keepmarks| was used.
1870 *cpo-s*
1871 s Set buffer options when entering the buffer for the
1872 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001873 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 set when the buffer is created.
1875 *cpo-S*
1876 S Set buffer options always when entering a buffer
1877 (except 'readonly', 'fileformat', 'filetype' and
1878 'syntax'). This is the (most) Vi compatible setting.
1879 The options are set to the values in the current
1880 buffer. When you change an option and go to another
1881 buffer, the value is copied. Effectively makes the
1882 buffer options global to all buffers.
1883
1884 's' 'S' copy buffer options
1885 no no when buffer created
1886 yes no when buffer first entered (default)
1887 X yes each time when buffer entered (vi comp.)
1888 *cpo-t*
1889 t Search pattern for the tag command is remembered for
1890 "n" command. Otherwise Vim only puts the pattern in
1891 the history for search pattern, but doesn't change the
1892 last used search pattern.
1893 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001894 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 *cpo-v*
1896 v Backspaced characters remain visible on the screen in
1897 Insert mode. Without this flag the characters are
1898 erased from the screen right away. With this flag the
1899 screen newly typed text overwrites backspaced
1900 characters.
1901 *cpo-w*
1902 w When using "cw" on a blank character, only change one
1903 character and not all blanks until the start of the
1904 next word.
1905 *cpo-W*
1906 W Don't overwrite a readonly file. When omitted, ":w!"
1907 overwrites a readonly file, if possible.
1908 *cpo-x*
1909 x <Esc> on the command-line executes the command-line.
1910 The default in Vim is to abandon the command-line,
1911 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001912 *cpo-X*
1913 X When using a count with "R" the replaced text is
1914 deleted only once. Also when repeating "R" with "."
1915 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 *cpo-y*
1917 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001918 *cpo-Z*
1919 Z When using "w!" while the 'readonly' option is set,
1920 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 *cpo-!*
1922 ! When redoing a filter command, use the last used
1923 external command, whatever it was. Otherwise the last
1924 used -filter- command is used.
1925 *cpo-$*
1926 $ When making a change to one line, don't redisplay the
1927 line, but put a '$' at the end of the changed text.
1928 The changed text will be overwritten when you type the
1929 new text. The line is redisplayed if you type any
1930 command that moves the cursor from the insertion
1931 point.
1932 *cpo-%*
1933 % Vi-compatible matching is done for the "%" command.
1934 Does not recognize "#if", "#endif", etc.
1935 Does not recognize "/*" and "*/".
1936 Parens inside single and double quotes are also
1937 counted, causing a string that contains a paren to
1938 disturb the matching. For example, in a line like
1939 "if (strcmp("foo(", s))" the first paren does not
1940 match the last one. When this flag is not included,
1941 parens inside single and double quotes are treated
1942 specially. When matching a paren outside of quotes,
1943 everything inside quotes is ignored. When matching a
1944 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001945 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001946 This flag is also used for other features, such as
1947 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001948 *cpo--*
1949 - When included, a vertical movement command fails when
1950 it would above the first line or below the last line.
1951 Without it the cursor moves to the first or last line,
1952 unless it already was in that line.
1953 Applies to the commands "-", "k", CTRL-P, "+", "j",
1954 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001955 *cpo-+*
1956 + When included, a ":write file" command will reset the
1957 'modified' flag of the buffer, even though the buffer
1958 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001959 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 * Use ":*" in the same way as ":@". When not included,
1961 ":*" is an alias for ":'<,'>", select the Visual area.
1962 *cpo-<*
1963 < Disable the recognition of special key codes in |<>|
1964 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001965 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 ":map X <Tab>" results in X being mapped to:
1967 '<' included: "<Tab>" (5 characters)
1968 '<' excluded: "^I" (^I is a real <Tab>)
1969 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001970 *cpo->*
1971 > When appending to a register, put a line break before
1972 the appended text.
1973
1974 POSIX flags. These are not included in the Vi default value, except
1975 when $VIM_POSIX was set on startup. |posix|
1976
1977 contains behavior ~
1978 *cpo-#*
1979 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001980 *cpo-&*
1981 & When ":preserve" was used keep the swap file when
1982 exiting normally while this buffer is still loaded.
1983 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001984 *cpo-\*
1985 \ Backslash in a [] range in a search pattern is taken
1986 literally, only "\]" is special See |/[]|
1987 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1988 'l' excluded: "/[ \t]" finds <Space> and <Tab>
1989 Also see |cpo-\|.
1990 *cpo-/*
1991 / When "%" is used as the replacement string in a |:s|
1992 command, use the previous replacement string. |:s%|
1993 *cpo-{*
1994 { The |{| and |}| commands also stop at a "{" character
1995 at the start of a line.
1996 *cpo-.*
1997 . The ":chdir" and ":cd" commands fail if the current
1998 buffer is modified, unless ! is used. Vim doesn't
1999 need this, since it remembers the full path of an
2000 opened file.
2001 *cpo-bar*
2002 | The value of the $LINES and $COLUMNS environment
2003 variables overrule the terminal size values obtained
2004 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002005
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006
2007 *'cscopepathcomp'* *'cspc'*
2008'cscopepathcomp' 'cspc' number (default 0)
2009 global
2010 {not available when compiled without the |+cscope|
2011 feature}
2012 {not in Vi}
2013 Determines how many components of the path to show in a list of tags.
2014 See |cscopepathcomp|.
2015
2016 *'cscopeprg'* *'csprg'*
2017'cscopeprg' 'csprg' string (default "cscope")
2018 global
2019 {not available when compiled without the |+cscope|
2020 feature}
2021 {not in Vi}
2022 Specifies the command to execute cscope. See |cscopeprg|.
2023 This option cannot be set from a |modeline| or in the |sandbox|, for
2024 security reasons.
2025
2026 *'cscopequickfix'* *'csqf'*
2027'cscopequickfix' 'csqf' string (default "")
2028 global
2029 {not available when compiled without the |+cscope|
2030 or |+quickfix| features}
2031 {not in Vi}
2032 Specifies whether to use quickfix window to show cscope results.
2033 See |cscopequickfix|.
2034
2035 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2036'cscopetag' 'cst' boolean (default off)
2037 global
2038 {not available when compiled without the |+cscope|
2039 feature}
2040 {not in Vi}
2041 Use cscope for tag commands. See |cscope-options|.
2042 NOTE: This option is reset when 'compatible' is set.
2043
2044 *'cscopetagorder'* *'csto'*
2045'cscopetagorder' 'csto' number (default 0)
2046 global
2047 {not available when compiled without the |+cscope|
2048 feature}
2049 {not in Vi}
2050 Determines the order in which ":cstag" performs a search. See
2051 |cscopetagorder|.
2052 NOTE: This option is set to 0 when 'compatible' is set.
2053
2054 *'cscopeverbose'* *'csverb'*
2055 *'nocscopeverbose'* *'nocsverb'*
2056'cscopeverbose' 'csverb' boolean (default off)
2057 global
2058 {not available when compiled without the |+cscope|
2059 feature}
2060 {not in Vi}
2061 Give messages when adding a cscope database. See |cscopeverbose|.
2062 NOTE: This option is reset when 'compatible' is set.
2063
2064 *'debug'*
2065'debug' string (default "")
2066 global
2067 {not in Vi}
2068 When set to "msg", error messages that would otherwise be omitted will
2069 be given anyway. This is useful when debugging 'foldexpr' or
2070 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002071 When set to "beep", a message will be given when otherwise only a beep
2072 would be produced.
2073 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074
2075 *'define'* *'def'*
2076'define' 'def' string (default "^\s*#\s*define")
2077 global or local to buffer |global-local|
2078 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002079 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 pattern, just like for the "/" command. This option is used for the
2081 commands like "[i" and "[d" |include-search|. The 'isident' option is
2082 used to recognize the defined name after the match:
2083 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2084 See |option-backslash| about inserting backslashes to include a space
2085 or backslash.
2086 The default value is for C programs. For C++ this value would be
2087 useful, to include const type declarations: >
2088 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2089< When using the ":set" command, you need to double the backslashes!
2090
2091 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2092'delcombine' 'deco' boolean (default off)
2093 global
2094 {not in Vi}
2095 {only available when compiled with the |+multi_byte|
2096 feature}
2097 If editing Unicode and this option is set, backspace and Normal mode
2098 "x" delete each combining character on its own. When it is off (the
2099 default) the character along with its combining characters are
2100 deleted.
2101 Note: When 'delcombine' is set "xx" may work different from "2x"!
2102
2103 This is useful for Arabic, Hebrew and many other languages where one
2104 may have combining characters overtop of base characters, and want
2105 to remove only the combining ones.
2106
2107 *'dictionary'* *'dict'*
2108'dictionary' 'dict' string (default "")
2109 global or local to buffer |global-local|
2110 {not in Vi}
2111 List of file names, separated by commas, that are used to lookup words
2112 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2113 contain a list of words. This can be one word per line, or several
2114 words per line, separated by non-keyword characters (white space is
2115 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002116 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 after a comma are ignored, otherwise spaces are included in the file
2118 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002119 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120 Where to find a list of words?
2121 - On FreeBSD, there is the file "/usr/share/dict/words".
2122 - In the Simtel archive, look in the "msdos/linguist" directory.
2123 - In "miscfiles" of the GNU collection.
2124 The use of |:set+=| and |:set-=| is preferred when adding or removing
2125 directories from the list. This avoids problems when a future version
2126 uses another default.
2127 Backticks cannot be used in this option for security reasons.
2128
2129 *'diff'* *'nodiff'*
2130'diff' boolean (default off)
2131 local to window
2132 {not in Vi}
2133 {not available when compiled without the |+diff|
2134 feature}
2135 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002136 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137
2138 *'dex'* *'diffexpr'*
2139'diffexpr' 'dex' string (default "")
2140 global
2141 {not in Vi}
2142 {not available when compiled without the |+diff|
2143 feature}
2144 Expression which is evaluated to obtain an ed-style diff file from two
2145 versions of a file. See |diff-diffexpr|.
2146 This option cannot be set from a |modeline| or in the |sandbox|, for
2147 security reasons.
2148
2149 *'dip'* *'diffopt'*
2150'diffopt' 'dip' string (default "filler")
2151 global
2152 {not in Vi}
2153 {not available when compiled without the |+diff|
2154 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002155 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 All are optional. Items must be separated by a comma.
2157
2158 filler Show filler lines, to keep the text
2159 synchronized with a window that has inserted
2160 lines at the same position. Mostly useful
2161 when windows are side-by-side and 'scrollbind'
2162 is set.
2163
2164 context:{n} Use a context of {n} lines between a change
2165 and a fold that contains unchanged lines.
2166 When omitted a context of six lines is used.
2167 See |fold-diff|.
2168
2169 icase Ignore changes in case of text. "a" and "A"
2170 are considered the same. Adds the "-i" flag
2171 to the "diff" command if 'diffexpr' is empty.
2172
2173 iwhite Ignore changes in amount of white space. Adds
2174 the "-b" flag to the "diff" command if
2175 'diffexpr' is empty. Check the documentation
2176 of the "diff" command for what this does
2177 exactly. It should ignore adding trailing
2178 white space, but not leading white space.
2179
2180 Examples: >
2181
2182 :set diffopt=filler,context:4
2183 :set diffopt=
2184 :set diffopt=filler
2185<
2186 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2187'digraph' 'dg' boolean (default off)
2188 global
2189 {not in Vi}
2190 {not available when compiled without the |+digraphs|
2191 feature}
2192 Enable the entering of digraphs in Insert mode with {char1} <BS>
2193 {char2}. See |digraphs|.
2194 NOTE: This option is reset when 'compatible' is set.
2195
2196 *'directory'* *'dir'*
2197'directory' 'dir' string (default for Amiga: ".,t:",
2198 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2199 for Unix: ".,~/tmp,/var/tmp,/tmp")
2200 global
2201 List of directory names for the swap file, separated with commas.
2202 - The swap file will be created in the first directory where this is
2203 possible.
2204 - Empty means that no swap file will be used (recovery is
2205 impossible!).
2206 - A directory "." means to put the swap file in the same directory as
2207 the edited file. On Unix, a dot is prepended to the file name, so
2208 it doesn't show in a directory listing. On MS-Windows the "hidden"
2209 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002210 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 put the swap file relative to where the edited file is. The leading
2212 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002213 - For Unix and Win32, if a directory ends in two path separators "//"
2214 or "\\", the swap file name will be built from the complete path to
2215 the file with all path separators substituted to percent '%' signs.
2216 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 - Spaces after the comma are ignored, other spaces are considered part
2218 of the directory name. To have a space at the start of a directory
2219 name, precede it with a backslash.
2220 - To include a comma in a directory name precede it with a backslash.
2221 - A directory name may end in an ':' or '/'.
2222 - Environment variables are expanded |:set_env|.
2223 - Careful with '\' characters, type one before a space, type two to
2224 get one in the option (see |option-backslash|), for example: >
2225 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2226< - For backwards compatibility with Vim version 3.0 a '>' at the start
2227 of the option is removed.
2228 Using "." first in the list is recommended. This means that editing
2229 the same file twice will result in a warning. Using "/tmp" on Unix is
2230 discouraged: When the system crashes you lose the swap file.
2231 "/var/tmp" is often not cleared when rebooting, thus is a better
2232 choice than "/tmp". But it can contain a lot of files, your swap
2233 files get lost in the crowd. That is why a "tmp" directory in your
2234 home directory is tried first.
2235 The use of |:set+=| and |:set-=| is preferred when adding or removing
2236 directories from the list. This avoids problems when a future version
2237 uses another default.
2238 This option cannot be set from a |modeline| or in the |sandbox|, for
2239 security reasons.
2240 {Vi: directory to put temp file in, defaults to "/tmp"}
2241
2242 *'display'* *'dy'*
2243'display' 'dy' string (default "")
2244 global
2245 {not in Vi}
2246 Change the way text is displayed. This is comma separated list of
2247 flags:
2248 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002249 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 last line that doesn't fit is replaced with "@" lines.
2251 uhex Show unprintable characters hexadecimal as <xx>
2252 instead of using ^C and ~C.
2253
2254 *'eadirection'* *'ead'*
2255'eadirection' 'ead' string (default "both")
2256 global
2257 {not in Vi}
2258 {not available when compiled without the +vertsplit
2259 feature}
2260 Tells when the 'equalalways' option applies:
2261 ver vertically, width of windows is not affected
2262 hor horizontally, height of windows is not affected
2263 both width and height of windows is affected
2264
2265 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2266'edcompatible' 'ed' boolean (default off)
2267 global
2268 Makes the 'g' and 'c' flags of the ":substitute" command to be
2269 toggled each time the flag is given. See |complex-change|. See
2270 also 'gdefault' option.
2271 Switching this option on is discouraged!
2272
2273 *'encoding'* *'enc'* *E543*
2274'encoding' 'enc' string (default: "latin1" or value from $LANG)
2275 global
2276 {only available when compiled with the |+multi_byte|
2277 feature}
2278 {not in Vi}
2279 Sets the character encoding used inside Vim. It applies to text in
2280 the buffers, registers, Strings in expressions, text stored in the
2281 viminfo file, etc. It sets the kind of characters which Vim can work
2282 with. See |encoding-names| for the possible values.
2283
2284 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002285 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 It should normally be kept at its default value, or set when Vim
2287 starts up. See |multibyte|.
2288
2289 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2290 "utf-8". Although care has been taken to allow different values of
2291 'encoding', "utf-8" is the natural choice for the environment and
2292 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002293 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 versions, and to avoid changing the encoding of newly created files
2295 without your knowledge (in case 'fileencodings' is empty).
2296
2297 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002298 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 iconv() or as specified with 'charconvert'.
2300
2301 Normally 'encoding' will be equal to your current locale. This will
2302 be the default if Vim recognizes your environment settings. If
2303 'encoding' is not set to the current locale, 'termencoding' must be
2304 set to convert typed and displayed text. See |encoding-table|.
2305
2306 When you set this option, it fires the |EncodingChanged| autocommand
2307 event so that you can set up fonts if necessary.
2308
2309 When the option is set, the value is converted to lowercase. Thus
2310 you can set it with uppercase values too. Underscores are translated
2311 to '-' signs.
2312 When the encoding is recognized, it is changed to the standard name.
2313 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2314 "iso-8859-2" and "utf8" becomes "utf-8".
2315
2316 Note: "latin1" is also used when the encoding could not be detected.
2317 This only works when editing files in the same encoding! When the
2318 actual character set is not latin1, make sure 'fileencoding' and
2319 'fileencodings' are empty. When conversion is needed, switch to using
2320 utf-8.
2321
2322 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2323 You don't notice this while editing, but it does matter for the
2324 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2325 setting 'encoding' to one of these values instead of utf-8 only has
2326 effect for encoding used for files when 'fileencoding' is empty.
2327
Bram Moolenaar661b1822005-07-28 22:36:45 +00002328 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2329 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330
2331 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2332'endofline' 'eol' boolean (default on)
2333 local to buffer
2334 {not in Vi}
2335 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 option is automatically set when starting to edit a new file, unless
2338 the file does not have an <EOL> for the last line in the file, in
2339 which case it is reset. Normally you don't have to set or reset this
2340 option. When 'binary' is off the value is not used when writing the
2341 file. When 'binary' is on it is used to remember the presence of a
2342 <EOL> for the last line in the file, so that when you write the file
2343 the situation from the original file can be kept. But you can change
2344 it if you want to.
2345
2346 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2347'equalalways' 'ea' boolean (default on)
2348 global
2349 {not in Vi}
2350 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002351 splitting or closing a window. This also happens the moment the
2352 option is switched on. When off, splitting a window will reduce the
2353 size of the current window and leave the other windows the same. When
2354 closing a window the extra lines are given to the window next to it
2355 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002356 When mixing vertically and horizontally split windows, a minimal size
2357 is computed and some windows may be larger if there is room. The
2358 'eadirection' option tells in which direction the size is affected.
2359 Changing the height of a window can be avoided by setting
2360 'winfixheight'.
2361
2362 *'equalprg'* *'ep'*
2363'equalprg' 'ep' string (default "")
2364 global or local to buffer |global-local|
2365 {not in Vi}
2366 External program to use for "=" command. When this option is empty
2367 the internal formatting functions are used ('lisp', 'cindent' or
2368 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002369 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 about including spaces and backslashes.
2371 This option cannot be set from a |modeline| or in the |sandbox|, for
2372 security reasons.
2373
2374 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2375'errorbells' 'eb' boolean (default off)
2376 global
2377 Ring the bell (beep or screen flash) for error messages. This only
2378 makes a difference for error messages, the bell will be used always
2379 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002380 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 screen flash or do nothing.
2382
2383 *'errorfile'* *'ef'*
2384'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2385 others: "errors.err")
2386 global
2387 {not in Vi}
2388 {not available when compiled without the |+quickfix|
2389 feature}
2390 Name of the errorfile for the QuickFix mode (see |:cf|).
2391 When the "-q" command-line argument is used, 'errorfile' is set to the
2392 following argument. See |-q|.
2393 NOT used for the ":make" command. See 'makeef' for that.
2394 Environment variables are expanded |:set_env|.
2395 See |option-backslash| about including spaces and backslashes.
2396 This option cannot be set from a |modeline| or in the |sandbox|, for
2397 security reasons.
2398
2399 *'errorformat'* *'efm'*
2400'errorformat' 'efm' string (default is very long)
2401 global or local to buffer |global-local|
2402 {not in Vi}
2403 {not available when compiled without the |+quickfix|
2404 feature}
2405 Scanf-like description of the format for the lines in the error file
2406 (see |errorformat|).
2407
2408 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2409'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2410 global
2411 {not in Vi}
2412 Function keys that start with an <Esc> are recognized in Insert
2413 mode. When this option is off, the cursor and function keys cannot be
2414 used in Insert mode if they start with an <Esc>. The advantage of
2415 this is that the single <Esc> is recognized immediately, instead of
2416 after one second. Instead of resetting this option, you might want to
2417 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2418 when 'esckeys' is off, you can still map anything, but the cursor keys
2419 won't work by default.
2420 NOTE: This option is set to the Vi default value when 'compatible' is
2421 set and to the Vim default value when 'compatible' is reset.
2422
2423 *'eventignore'* *'ei'*
2424'eventignore' 'ei' string (default "")
2425 global
2426 {not in Vi}
2427 {not available when compiled without the |+autocmd|
2428 feature}
2429 A list of autocommand event names, which are to be ignored.
2430 When set to "all", all autocommand events are ignored, autocommands
2431 will not be executed.
2432 Otherwise this is a comma separated list of event names. Example: >
2433 :set ei=WinEnter,WinLeave
2434<
2435 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2436'expandtab' 'et' boolean (default off)
2437 local to buffer
2438 {not in Vi}
2439 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002440 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2442 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2443 NOTE: This option is reset when 'compatible' is set.
2444
2445 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2446'exrc' 'ex' boolean (default off)
2447 global
2448 {not in Vi}
2449 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2450 directory. If you switch this option on you should also consider
2451 setting the 'secure' option (see |initialization|). Using a local
2452 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2453 also see |.vimrc| and |gui-init|.
2454 This option cannot be set from a |modeline| or in the |sandbox|, for
2455 security reasons.
2456
2457 *'fileencoding'* *'fenc'* *E213*
2458'fileencoding' 'fenc' string (default: "")
2459 local to buffer
2460 {only available when compiled with the |+multi_byte|
2461 feature}
2462 {not in Vi}
2463 Sets the character encoding for the file of this buffer.
2464 When 'fileencoding' is different from 'encoding', conversion will be
2465 done when reading and writing the file.
2466 When 'fileencoding' is empty, the same value as 'encoding' will be
2467 used (no conversion when reading or writing a file).
2468 WARNING: Conversion can cause loss of information! When
2469 'encoding' is "utf-8" conversion is most likely done in a way
2470 that the reverse conversion results in the same text. When
2471 'encoding' is not "utf-8" some characters may be lost!
2472 See 'encoding' for the possible values. Additionally, values may be
2473 specified that can be handled by the converter, see
2474 |mbyte-conversion|.
2475 When reading a file 'fileencoding' will be set from 'fileencodings'.
2476 To read a file in a certain encoding it won't work by setting
2477 'fileencoding', use the |++enc| argument.
2478 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2479 When the option is set, the value is converted to lowercase. Thus
2480 you can set it with uppercase values too. '_' characters are
2481 replaced with '-'. If a name is recognized from the list for
2482 'encoding', it is replaced by the standard name. For example
2483 "ISO8859-2" becomes "iso-8859-2".
2484 When this option is set, after starting to edit a file, the 'modified'
2485 option is set, because the file would be different when written.
2486 If you do this in a modeline, you might want to set 'nomodified' to
2487 avoid this.
2488 This option can not be changed when 'modifiable' is off.
2489
2490 *'fe'*
2491 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002492 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 old short name was 'fe', which is no longer used.
2494
2495 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002496'fileencodings' 'fencs' string (default: "ucs-bom",
2497 "ucs-bom,utf-8,default,latin1" when
2498 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 global
2500 {only available when compiled with the |+multi_byte|
2501 feature}
2502 {not in Vi}
2503 This is a list of character encodings considered when starting to edit
2504 an existing file. When a file is read, Vim tries to use the first
2505 mentioned character encoding. If an error is detected, the next one
2506 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002507 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508 an empty string, which means the value of 'encoding' is used.
2509 WARNING: Conversion can cause loss of information! When
2510 'encoding' is "utf-8" (or one of the other Unicode variants)
2511 conversion is most likely done in a way that the reverse
2512 conversion results in the same text. When 'encoding' is not
2513 "utf-8" special characters may be lost!
2514 For an empty file or a file with only ASCII characters most encodings
2515 will work and the first entry of 'fileencodings' will be used (except
2516 "ucs-bom", which requires the BOM to be present). If you prefer
2517 another encoding use an BufReadPost autocommand event to test if your
2518 preferred encoding is to be used. Example: >
2519 au BufReadPost * if search('\S', 'w') == 0 |
2520 \ set fenc=iso-2022-jp | endif
2521< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2522 non-blank characters.
2523 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2524 is always empty then. This means that a non-existing file may get a
2525 different encoding than an empty file.
2526 The special value "ucs-bom" can be used to check for a Unicode BOM
2527 (Byte Order Mark) at the start of the file. It must not be preceded
2528 by "utf-8" or another Unicode encoding for this to work properly.
2529 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2530 because Vim cannot detect an error, thus the encoding is always
2531 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002532 The special value "default" can be used for the encoding from the
2533 environment. This is the default value for 'encoding'. It is useful
2534 when 'encoding' is set to "utf-8" and your environment uses a
2535 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002536 WRONG VALUES: WHAT'S WRONG:
2537 latin1,utf-8 "latin1" will always be used
2538 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2539 file
2540 cp1250,latin1 "cp1250" will always be used
2541 If 'fileencodings' is empty, 'fileencoding' is not modified.
2542 See 'fileencoding' for the possible values.
2543 Setting this option does not have an effect until the next time a file
2544 is read.
2545
2546 *'fileformat'* *'ff'*
2547'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2548 Unix default: "unix",
2549 Macintosh default: "mac")
2550 local to buffer
2551 {not in Vi}
2552 This gives the <EOL> of the current buffer, which is used for
2553 reading/writing the buffer from/to a file:
2554 dos <CR> <NL>
2555 unix <NL>
2556 mac <CR>
2557 When "dos" is used, CTRL-Z at the end of a file is ignored.
2558 See |file-formats| and |file-read|.
2559 For the character encoding of the file see 'fileencoding'.
2560 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2561 works like it was set to "unix'.
2562 This option is set automatically when starting to edit a file and
2563 'fileformats' is not empty and 'binary' is off.
2564 When this option is set, after starting to edit a file, the 'modified'
2565 option is set, because the file would be different when written.
2566 This option can not be changed when 'modifiable' is off.
2567 For backwards compatibility: When this option is set to "dos",
2568 'textmode' is set, otherwise 'textmode' is reset.
2569
2570 *'fileformats'* *'ffs'*
2571'fileformats' 'ffs' string (default:
2572 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2573 Vim Unix: "unix,dos",
2574 Vim Mac: "mac,unix,dos",
2575 Vi Cygwin: "unix,dos",
2576 Vi others: "")
2577 global
2578 {not in Vi}
2579 This gives the end-of-line (<EOL>) formats that will be tried when
2580 starting to edit a new buffer and when reading a file into an existing
2581 buffer:
2582 - When empty, the format defined with 'fileformat' will be used
2583 always. It is not set automatically.
2584 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002585 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 'fileformats' name will be used when a file is read into an existing
2587 buffer, no matter what 'fileformat' for that buffer is set to.
2588 - When more than one name is present, separated by commas, automatic
2589 <EOL> detection will be done when reading a file. When starting to
2590 edit a file, a check is done for the <EOL>:
2591 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2592 'fileformat' is set to "dos".
2593 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002594 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 preceding <CR>, "unix" is preferred over "dos".
2596 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2597 This means that "mac" is only chosen when "unix" is not present,
2598 or when no <NL> is found in the file, and when "dos" is not
2599 present, or no <CR><NL> is present in the file.
2600 Also if "unix" was first chosen, but the first <CR> is before
2601 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2602 the file, then 'fileformat' is set to "mac".
2603 4. If 'fileformat' is still not set, the first name from
2604 'fileformats' is used.
2605 When reading a file into an existing buffer, the same is done, but
2606 this happens like 'fileformat' has been set appropriately for that
2607 file only, the option is not changed.
2608 When 'binary' is set, the value of 'fileformats' is not used.
2609
2610 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2611 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2612 done:
2613 - When 'fileformats' is empty, there is no automatic detection. Dos
2614 format will be used.
2615 - When 'fileformats' is set to one or more names, automatic detection
2616 is done. This is based on the first <NL> in the file: If there is a
2617 <CR> in front of it, Dos format is used, otherwise Unix format is
2618 used.
2619 Also see |file-formats|.
2620 For backwards compatibility: When this option is set to an empty
2621 string or one format (no comma is included), 'textauto' is reset,
2622 otherwise 'textauto' is set.
2623 NOTE: This option is set to the Vi default value when 'compatible' is
2624 set and to the Vim default value when 'compatible' is reset.
2625
2626 *'filetype'* *'ft'*
2627'filetype' 'ft' string (default: "")
2628 local to buffer
2629 {not in Vi}
2630 {not available when compiled without the |+autocmd|
2631 feature}
2632 When this option is set, the FileType autocommand event is triggered.
2633 All autocommands that match with the value of this option will be
2634 executed. Thus the value of 'filetype' is used in place of the file
2635 name.
2636 Otherwise this option does not always reflect the current file type.
2637 This option is normally set when the file type is detected. To enable
2638 this use the ":filetype on" command. |:filetype|
2639 Setting this option to a different value is most useful in a modeline,
2640 for a file for which the file type is not automatically recognized.
2641 Example, for in an IDL file: >
2642 /* vim: set filetype=idl : */
2643< |FileType| |filetypes|
2644 Do not confuse this option with 'osfiletype', which is for the file
2645 type that is actually stored with the file.
2646 This option is not copied to another buffer, independent of the 's' or
2647 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002648 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649
2650 *'fillchars'* *'fcs'*
2651'fillchars' 'fcs' string (default "vert:|,fold:-")
2652 global
2653 {not in Vi}
2654 {not available when compiled without the |+windows|
2655 and |+folding| features}
2656 Characters to fill the statuslines and vertical separators.
2657 It is a comma separated list of items:
2658
2659 item default Used for ~
2660 stl:c ' ' or '^' statusline of the current window
2661 stlnc:c ' ' or '-' statusline of the non-current windows
2662 vert:c '|' vertical separators |:vsplit|
2663 fold:c '-' filling 'foldtext'
2664 diff:c '-' deleted lines of the 'diff' option
2665
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002666 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 "stlnc" the space will be used when there is highlighting, '^' or '-'
2668 otherwise.
2669
2670 Example: >
2671 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2672< This is similar to the default, except that these characters will also
2673 be used when there is highlighting.
2674
2675 The highlighting used for these items:
2676 item highlight group ~
2677 stl:c StatusLine |hl-StatusLine|
2678 stlnc:c StatusLineNC |hl-StatusLineNC|
2679 vert:c VertSplit |hl-VertSplit|
2680 fold:c Folded |hl-Folded|
2681 diff:c DiffDelete |hl-DiffDelete|
2682
2683 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2684'fkmap' 'fk' boolean (default off) *E198*
2685 global
2686 {not in Vi}
2687 {only available when compiled with the |+rightleft|
2688 feature}
2689 When on, the keyboard is mapped for the Farsi character set.
2690 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002691 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692
2693 *'foldclose'* *'fcl'*
2694'foldclose' 'fcl' string (default "")
2695 global
2696 {not in Vi}
2697 {not available when compiled without the |+folding|
2698 feature}
2699 When set to "all", a fold is closed when the cursor isn't in it and
2700 its level is higher than 'foldlevel'. Useful if you want folds to
2701 automatically close when moving out of them.
2702
2703 *'foldcolumn'* *'fdc'*
2704'foldcolumn' 'fdc' number (default 0)
2705 local to window
2706 {not in Vi}
2707 {not available when compiled without the |+folding|
2708 feature}
2709 When non-zero, a column with the specified width is shown at the side
2710 of the window which indicates open and closed folds. The maximum
2711 value is 12.
2712 See |folding|.
2713
2714 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2715'foldenable' 'fen' boolean (default on)
2716 local to window
2717 {not in Vi}
2718 {not available when compiled without the |+folding|
2719 feature}
2720 When off, all folds are open. This option can be used to quickly
2721 switch between showing all text unfolded and viewing the text with
2722 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002723 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 'foldenable' is off.
2725 This option is set by commands that create a new fold or close a fold.
2726 See |folding|.
2727
2728 *'foldexpr'* *'fde'*
2729'foldexpr' 'fde' string (default: "0")
2730 local to window
2731 {not in Vi}
2732 {not available when compiled without the |+folding|
2733 or |+eval| feature}
2734 The expression used for when 'foldmethod' is "expr". It is evaluated
2735 for each line to obtain its fold level. See |fold-expr|. Also see
2736 |eval-sandbox|.
2737
2738 *'foldignore'* *'fdi'*
2739'foldignore' 'fdi' string (default: "#")
2740 local to window
2741 {not in Vi}
2742 {not available when compiled without the |+folding|
2743 feature}
2744 Used only when 'foldmethod' is "indent". Lines starting with
2745 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002746 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 The default "#" works well for C programs. See |fold-indent|.
2748
2749 *'foldlevel'* *'fdl'*
2750'foldlevel' 'fdl' number (default: 0)
2751 local to window
2752 {not in Vi}
2753 {not available when compiled without the |+folding|
2754 feature}
2755 Sets the fold level: Folds with a higher level will be closed.
2756 Setting this option to zero will close all folds. Higher numbers will
2757 close fewer folds.
2758 This option is set by commands like |zm|, |zM| and |zR|.
2759 See |fold-foldlevel|.
2760
2761 *'foldlevelstart'* *'fdls'*
2762'foldlevelstart' 'fdls' number (default: -1)
2763 global
2764 {not in Vi}
2765 {not available when compiled without the |+folding|
2766 feature}
2767 Sets 'foldlevel' when starting to edit another buffer in a window.
2768 Useful to always start editing with all folds closed (value zero),
2769 some folds closed (one) or no folds closed (99).
2770 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002771 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 ignores this option and closes all folds.
2773 It is also done before BufReadPre autocommands, to allow an autocmd to
2774 overrule the 'foldlevel' value for specific files.
2775 When the value is negative, it is not used.
2776
2777 *'foldmarker'* *'fmr'* *E536*
2778'foldmarker' 'fmr' string (default: "{{{,}}}")
2779 local to window
2780 {not in Vi}
2781 {not available when compiled without the |+folding|
2782 feature}
2783 The start and end marker used when 'foldmethod' is "marker". There
2784 must be one comma, which separates the start and end marker. The
2785 marker is a literal string (a regular expression would be too slow).
2786 See |fold-marker|.
2787
2788 *'foldmethod'* *'fdm'*
2789'foldmethod' 'fdm' string (default: "manual")
2790 local to window
2791 {not in Vi}
2792 {not available when compiled without the |+folding|
2793 feature}
2794 The kind of folding used for the current window. Possible values:
2795 |fold-manual| manual Folds are created manually.
2796 |fold-indent| indent Lines with equal indent form a fold.
2797 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2798 |fold-marker| marker Markers are used to specify folds.
2799 |fold-syntax| syntax Syntax highlighting items specify folds.
2800 |fold-diff| diff Fold text that is not changed.
2801
2802 *'foldminlines'* *'fml'*
2803'foldminlines' 'fml' number (default: 1)
2804 local to window
2805 {not in Vi}
2806 {not available when compiled without the |+folding|
2807 feature}
2808 Sets the minimum number of screen lines for a fold to be displayed
2809 closed. Also for manually closed folds.
2810 Note that this only has an effect of what is displayed. After using
2811 "zc" to close a fold, which is displayed open because it's smaller
2812 than 'foldminlines', a following "zc" may close a containing fold.
2813
2814 *'foldnestmax'* *'fdn'*
2815'foldnestmax' 'fdn' number (default: 20)
2816 local to window
2817 {not in Vi}
2818 {not available when compiled without the |+folding|
2819 feature}
2820 Sets the maximum nesting of folds for the "indent" and "syntax"
2821 methods. This avoids that too many folds will be created. Using more
2822 than 20 doesn't work, because the internal limit is 20.
2823
2824 *'foldopen'* *'fdo'*
2825'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2826 search,tag,undo")
2827 global
2828 {not in Vi}
2829 {not available when compiled without the |+folding|
2830 feature}
2831 Specifies for which type of commands folds will be opened, if the
2832 command moves the cursor into a closed fold. It is a comma separated
2833 list of items.
2834 item commands ~
2835 all any
2836 block "(", "{", "[[", "[{", etc.
2837 hor horizontal movements: "l", "w", "fx", etc.
2838 insert any command in Insert mode
2839 jump far jumps: "G", "gg", etc.
2840 mark jumping to a mark: "'m", CTRL-O, etc.
2841 percent "%"
2842 quickfix ":cn", ":crew", ":make", etc.
2843 search search for a pattern: "/", "n", "*", "gd", etc.
2844 (not for a search pattern in a ":" command)
2845 tag jumping to a tag: ":ta", CTRL-T, etc.
2846 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 the |zv| command to the mapping to get the same effect.
2849 When a movement command is used for an operator (e.g., "dl" or "y%")
2850 this option is not used. This means the operator will include the
2851 whole closed fold.
2852 Note that vertical movements are not here, because it would make it
2853 very difficult to move onto a closed fold.
2854 In insert mode the folds containing the cursor will always be open
2855 when text is inserted.
2856 To close folds you can re-apply 'foldlevel' with the |zx| command or
2857 set the 'foldclose' option to "all".
2858
2859 *'foldtext'* *'fdt'*
2860'foldtext' 'fdt' string (default: "foldtext()")
2861 local to window
2862 {not in Vi}
2863 {not available when compiled without the |+folding|
2864 feature}
2865 An expression which is used to specify the text displayed for a closed
2866 fold. See |fold-foldtext|.
2867
2868 *'formatoptions'* *'fo'*
2869'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2870 local to buffer
2871 {not in Vi}
2872 This is a sequence of letters which describes how automatic
2873 formatting is to be done. See |fo-table|. When the 'paste' option is
2874 on, no formatting is done (like 'formatoptions' is empty). Commas can
2875 be inserted for readability.
2876 To avoid problems with flags that are added in the future, use the
2877 "+=" and "-=" feature of ":set" |add-option-flags|.
2878 NOTE: This option is set to the Vi default value when 'compatible' is
2879 set and to the Vim default value when 'compatible' is reset.
2880
Bram Moolenaar86b68352004-12-27 21:59:20 +00002881 *'formatlistpat'* *'flp'*
2882'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2883 local to buffer
2884 {not in Vi}
2885 A pattern that is used to recognize a list header. This is used for
2886 the "n" flag in 'formatoptions'.
2887 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002888 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002889 while still checking more characters. There must be a character
2890 following the pattern, when it matches the whole line it is handled
2891 like there is no match.
2892 The default recognizes a number, followed by an optional punctuation
2893 character and white space.
2894
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 *'formatprg'* *'fp'*
2896'formatprg' 'fp' string (default "")
2897 global
2898 {not in Vi}
2899 The name of an external program that will be used to format the lines
2900 selected with the "gq" command. The program must take the input on
2901 stdin and produce the output on stdout. The Unix program "fmt" is
2902 such a program. If this option is an empty string, the internal
2903 format function will be used |C-indenting|. Environment variables are
2904 expanded |:set_env|. See |option-backslash| about including spaces
2905 and backslashes.
2906 This option cannot be set from a |modeline| or in the |sandbox|, for
2907 security reasons.
2908
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002909 *'fsync'* *'fs'*
2910'fsync' 'fs' boolean (default on)
2911 global
2912 {not in Vi}
2913 When on, the library function fsync() will be called after writing a
2914 file. This will flush a file to disk, ensuring that it is safely
2915 written even on filesystems which do metadata-only journaling. This
2916 will force the harddrive to spin up on Linux systems running in laptop
2917 mode, so it may be undesirable in some situations. Be warned that
2918 turning this off increases the chances of data loss after a crash. On
2919 systems without an fsync() implementation, this variable is always
2920 off.
2921 Also see 'swapsync' for controlling fsync() on swap files.
2922
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2924'gdefault' 'gd' boolean (default off)
2925 global
2926 {not in Vi}
2927 When on, the ":substitute" flag 'g' is default on. This means that
2928 all matches in a line are substituted instead of one. When a 'g' flag
2929 is given to a ":substitute" command, this will toggle the substitution
2930 of all or one match. See |complex-change|.
2931
2932 command 'gdefault' on 'gdefault' off ~
2933 :s/// subst. all subst. one
2934 :s///g subst. one subst. all
2935 :s///gg subst. all subst. one
2936
2937 NOTE: This option is reset when 'compatible' is set.
2938
2939 *'grepformat'* *'gfm'*
2940'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2941 global
2942 {not in Vi}
2943 Format to recognize for the ":grep" command output.
2944 This is a scanf-like string that uses the same format as the
2945 'errorformat' option: see |errorformat|.
2946
2947 *'grepprg'* *'gp'*
2948'grepprg' 'gp' string (default "grep -n ",
2949 Unix: "grep -n $* /dev/null",
2950 Win32: "findstr /n" or "grep -n",
2951 VMS: "SEARCH/NUMBERS ")
2952 global or local to buffer |global-local|
2953 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002954 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 and '#' characters, which are expanded like when used in a command-
2956 line. The placeholder "$*" is allowed to specify where the arguments
2957 will be included. Environment variables are expanded |:set_env|. See
2958 |option-backslash| about including spaces and backslashes.
2959 When your "grep" accepts the "-H" argument, use this to make ":grep"
2960 also work well with a single file: >
2961 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002962< Special value: When 'grepprg' is set to "internal" the |:grep| command
2963 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002964 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 apply equally to 'grepprg'.
2966 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2967 otherwise it's "grep -n".
2968 This option cannot be set from a |modeline| or in the |sandbox|, for
2969 security reasons.
2970
2971 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2972'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2973 ve:ver35-Cursor,
2974 o:hor50-Cursor,
2975 i-ci:ver25-Cursor/lCursor,
2976 r-cr:hor20-Cursor/lCursor,
2977 sm:block-Cursor
2978 -blinkwait175-blinkoff150-blinkon175",
2979 for MS-DOS and Win32 console:
2980 "n-v-c:block,o:hor50,i-ci:hor15,
2981 r-cr:hor30,sm:block")
2982 global
2983 {not in Vi}
2984 {only available when compiled with GUI enabled, and
2985 for MS-DOS and Win32 console}
2986 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002987 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 the height of the cursor can be changed. This can be done by
2989 specifying a block cursor, or a percentage for a vertical or
2990 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002991 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002993 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 mode-list and an argument-list:
2995 mode-list:argument-list,mode-list:argument-list,..
2996 The mode-list is a dash separated list of these modes:
2997 n Normal mode
2998 v Visual mode
2999 ve Visual mode with 'selection' "exclusive" (same as 'v',
3000 if not specified)
3001 o Operator-pending mode
3002 i Insert mode
3003 r Replace mode
3004 c Command-line Normal (append) mode
3005 ci Command-line Insert mode
3006 cr Command-line Replace mode
3007 sm showmatch in Insert mode
3008 a all modes
3009 The argument-list is a dash separated list of these arguments:
3010 hor{N} horizontal bar, {N} percent of the character height
3011 ver{N} vertical bar, {N} percent of the character width
3012 block block cursor, fills the whole character
3013 [only one of the above three should be present]
3014 blinkwait{N} *cursor-blinking*
3015 blinkon{N}
3016 blinkoff{N}
3017 blink times for cursor: blinkwait is the delay before
3018 the cursor starts blinking, blinkon is the time that
3019 the cursor is shown and blinkoff is the time that the
3020 cursor is not shown. The times are in msec. When one
3021 of the numbers is zero, there is no blinking. The
3022 default is: "blinkwait700-blinkon400-blinkoff250".
3023 These numbers are used for a missing entry. This
3024 means that blinking is enabled by default. To switch
3025 blinking off you can use "blinkon0". The cursor only
3026 blinks when Vim is waiting for input, not while
3027 executing a command.
3028 To make the cursor blink in an xterm, see
3029 |xterm-blink|.
3030 {group-name}
3031 a highlight group name, that sets the color and font
3032 for the cursor
3033 {group-name}/{group-name}
3034 Two highlight group names, the first is used when
3035 no language mappings are used, the other when they
3036 are. |language-mapping|
3037
3038 Examples of parts:
3039 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3040 block cursor with colors from the "nCursor"
3041 highlight group
3042 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3043 In Insert and Command-line Insert mode, use a
3044 30% vertical bar cursor with colors from the
3045 "iCursor" highlight group. Blink a bit
3046 faster.
3047
3048 The 'a' mode is different. It will set the given argument-list for
3049 all modes. It does not reset anything to defaults. This can be used
3050 to do a common setting for all modes. For example, to switch off
3051 blinking: "a:blinkon0"
3052
3053 Examples of cursor highlighting: >
3054 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3055 :highlight Cursor gui=NONE guifg=bg guibg=fg
3056<
3057 *'guifont'* *'gfn'*
3058 *E235* *E596* *E610* *E611*
3059'guifont' 'gfn' string (default "")
3060 global
3061 {not in Vi}
3062 {only available when compiled with GUI enabled}
3063 This is a list of fonts which will be used for the GUI version of Vim.
3064 In its simplest form the value is just one font name. When
3065 the font cannot be found you will get an error message. To try other
3066 font names a list can be specified, font names separated with commas.
3067 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003068
Bram Moolenaar05159a02005-02-26 23:04:13 +00003069 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3070 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003071
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 Spaces after a comma are ignored. To include a comma in a font name
3073 precede it with a backslash. Setting an option requires an extra
3074 backslash before a space and a backslash. See also
3075 |option-backslash|. For example: >
3076 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003077< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003079
3080 If none of the fonts can be loaded, Vim will keep the current setting.
3081 If an empty font list is given, Vim will try using other resource
3082 settings (for X, it will use the Vim.font resource), and finally it
3083 will try some builtin default which should always be there ("7x13" in
3084 the case of X). The font names given should be "normal" fonts. Vim
3085 will try to find the related bold and italic fonts.
3086
Bram Moolenaar05159a02005-02-26 23:04:13 +00003087 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003088 :set guifont=*
3089< will bring up a font requester, where you can pick the font you want.
3090
3091 The font name depends on the GUI used. See |setting-guifont| for a
3092 way to set 'guifont' for various systems.
3093
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 For the GTK+ 2 GUI the font name looks like this: >
3095 :set guifont=Andale\ Mono\ 11
3096< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003097
3098 For Mac OSX you can use something like this: >
3099 :set guifont=Monaco:h10
3100< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003102 width). An exception is GTK 2: all fonts are accepted, but
3103 mono-spaced fonts look best.
3104
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 To preview a font on X11, you might be able to use the "xfontsel"
3106 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003107
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 For the Win32 GUI *E244* *E245*
3109 - takes these options in the font name:
3110 hXX - height is XX (points, can be floating-point)
3111 wXX - width is XX (points, can be floating-point)
3112 b - bold
3113 i - italic
3114 u - underline
3115 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003116 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3118 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3119 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003120 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121
3122 Use a ':' to separate the options.
3123 - A '_' can be used in the place of a space, so you don't need to use
3124 backslashes to escape the spaces.
3125 - Examples: >
3126 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3127 :set guifont=Andale_Mono:h7.5:w4.5
3128< See also |font-sizes|.
3129
3130 *'guifontset'* *'gfs'*
3131 *E250* *E252* *E234* *E597* *E598*
3132'guifontset' 'gfs' string (default "")
3133 global
3134 {not in Vi}
3135 {only available when compiled with GUI enabled and
3136 with the |+xfontset| feature}
3137 {not available in the GTK+ 2 GUI}
3138 When not empty, specifies two (or more) fonts to be used. The first
3139 one for normal English, the second one for your special language. See
3140 |xfontset|.
3141 Setting this option also means that all font names will be handled as
3142 a fontset name. Also the ones used for the "font" argument of the
3143 |:highlight| command.
3144 The fonts must match with the current locale. If fonts for the
3145 character sets that the current locale uses are not included, setting
3146 'guifontset' will fail.
3147 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3148 the comma-separated names are alternative names, one of which will be
3149 used. In 'guifontset' the whole string is one fontset name,
3150 including the commas. It is not possible to specify alternative
3151 fontset names.
3152 This example works on many X11 systems: >
3153 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3154<
3155 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3156'guifontwide' 'gfw' string (default "")
3157 global
3158 {not in Vi}
3159 {only available when compiled with GUI enabled}
3160 When not empty, specifies a comma-separated list of fonts to be used
3161 for double-width characters. The first font that can be loaded is
3162 used.
3163 Note: The size of these fonts must be exactly twice as wide as the one
3164 specified with 'guifont' and the same height.
3165
3166 All GUI versions but GTK+ 2:
3167
3168 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3169 'guifontset' is empty or invalid.
3170 When 'guifont' is set and a valid font is found in it and
3171 'guifontwide' is empty Vim will attempt to find a matching
3172 double-width font and set 'guifontwide' to it.
3173
3174 GTK+ 2 GUI only: *guifontwide_gtk2*
3175
3176 If set and valid, 'guifontwide' is always used for double width
3177 characters, even if 'encoding' is not set to "utf-8".
3178 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003179 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 font for characters not available in 'guifont'. Thus you do not need
3181 to set 'guifontwide' at all unless you want to override the choice
3182 made by Pango/Xft.
3183
3184 *'guiheadroom'* *'ghr'*
3185'guiheadroom' 'ghr' number (default 50)
3186 global
3187 {not in Vi} {only for GTK and X11 GUI}
3188 The number of pixels subtracted from the screen height when fitting
3189 the GUI window on the screen. Set this before the GUI is started,
3190 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003191 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 lines will be left for window decorations and other items on the
3193 screen. Set it to a negative value to allow windows taller than the
3194 screen.
3195
3196 *'guioptions'* *'go'*
3197'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003198 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 global
3200 {not in Vi}
3201 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003202 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 sequence of letters which describes what components and options of the
3204 GUI should be used.
3205 To avoid problems with flags that are added in the future, use the
3206 "+=" and "-=" feature of ":set" |add-option-flags|.
3207
3208 Valid letters are as follows:
3209 *guioptions_a*
3210 'a' Autoselect: If present, then whenever VISUAL mode is started,
3211 or the Visual area extended, Vim tries to become the owner of
3212 the windowing system's global selection. This means that the
3213 Visually highlighted text is available for pasting into other
3214 applications as well as into Vim itself. When the Visual mode
3215 ends, possibly due to an operation on the text, or when an
3216 application wants to paste the selection, the highlighted text
3217 is automatically yanked into the "* selection register.
3218 Thus the selection is still available for pasting into other
3219 applications after the VISUAL mode has ended.
3220 If not present, then Vim won't become the owner of the
3221 windowing system's global selection unless explicitly told to
3222 by a yank or delete operation for the "* register.
3223 The same applies to the modeless selection.
3224
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003225 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 applies to the modeless selection.
3227
3228 'guioptions' autoselect Visual autoselect modeless ~
3229 "" - -
3230 "a" yes yes
3231 "A" - yes
3232 "aA" yes yes
3233
3234 'c' Use console dialogs instead of popup dialogs for simple
3235 choices.
3236
3237 'f' Foreground: Don't use fork() to detach the GUI from the shell
3238 where it was started. Use this for programs that wait for the
3239 editor to finish (e.g., an e-mail program). Alternatively you
3240 can use "gvim -f" or ":gui -f" to start the GUI in the
3241 foreground. |gui-fork|
3242 Note: Set this option in the vimrc file. The forking may have
3243 happened already when the gvimrc file is read.
3244
3245 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3246 corner of the window. It's black&white on non-GTK, because of
3247 limitations of X11. For a color icon, see |X11-icon|.
3248
3249 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003250 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 that this flag must be added in the .vimrc file, before
3252 switching on syntax or filetype recognition (when the .gvimrc
3253 file is sourced the system menu has already been loaded; the
3254 ":syntax on" and ":filetype on" commands load the menu too).
3255 'g' Grey menu items: Make menu items that are not active grey. If
3256 'g' is not included inactive menu items are not shown at all.
3257 Exception: Athena will always use grey menu items.
3258
3259 't' Include tearoff menu items. Currently only works for Win32,
3260 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003261 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3262 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263
3264 'r' Right-hand scrollbar is always present.
3265 'R' Right-hand scrollbar is present when there is a vertically
3266 split window.
3267 'l' Left-hand scrollbar is always present.
3268 'L' Left-hand scrollbar is present when there is a vertically
3269 split window.
3270 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3271 the longest visible line, or on the cursor line if the 'h'
3272 flag is included. |gui-horiz-scroll|
3273 'h' Limit horizontal scrollbar size to the length of the cursor
3274 line. Reduces computations. |gui-horiz-scroll|
3275
3276 And yes, you may even have scrollbars on the left AND the right if
3277 you really want to :-). See |gui-scrollbars| for more information.
3278
3279 'v' Use a vertical button layout for dialogs. When not included,
3280 a horizontal layout is preferred, but when it doesn't fit a
3281 vertical layout is used anyway.
3282 'p' Use Pointer callbacks for X11 GUI. This is required for some
3283 window managers. If the cursor is not blinking or hollow at
3284 the right moment, try adding this flag. This must be done
3285 before starting the GUI. Set it in your gvimrc. Adding or
3286 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003287 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289 *'guipty'* *'noguipty'*
3290'guipty' boolean (default on)
3291 global
3292 {not in Vi}
3293 {only available when compiled with GUI enabled}
3294 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3295 I/O to/from shell commands. See |gui-pty|.
3296
3297 *'helpfile'* *'hf'*
3298'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3299 (others) "$VIMRUNTIME/doc/help.txt")
3300 global
3301 {not in Vi}
3302 Name of the main help file. All distributed help files should be
3303 placed together in one directory. Additionally, all "doc" directories
3304 in 'runtimepath' will be used.
3305 Environment variables are expanded |:set_env|. For example:
3306 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003307 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 spaces and backslashes.
3309 This option cannot be set from a |modeline| or in the |sandbox|, for
3310 security reasons.
3311
3312 *'helpheight'* *'hh'*
3313'helpheight' 'hh' number (default 20)
3314 global
3315 {not in Vi}
3316 {not available when compiled without the +windows
3317 feature}
3318 Minimal initial height of the help window when it is opened with the
3319 ":help" command. The initial height of the help window is half of the
3320 current window, or (when the 'ea' option is on) the same as other
3321 windows. When the height is less than 'helpheight', the height is
3322 set to 'helpheight'. Set to zero to disable.
3323
3324 *'helplang'* *'hlg'*
3325'helplang' 'hlg' string (default: messages language or empty)
3326 global
3327 {only available when compiled with the |+multi_lang|
3328 feature}
3329 {not in Vi}
3330 Comma separated list of languages. Vim will use the first language
3331 for which the desired help can be found. The English help will always
3332 be used as a last resort. You can add "en" to prefer English over
3333 another language, but that will only find tags that exist in that
3334 language and not in the English help.
3335 Example: >
3336 :set helplang=de,it
3337< This will first search German, then Italian and finally English help
3338 files.
3339 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3340 try to find the tag in the current language before using this option.
3341 See |help-translated|.
3342
3343 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3344'hidden' 'hid' boolean (default off)
3345 global
3346 {not in Vi}
3347 When off a buffer is unloaded when it is |abandon|ed. When on a
3348 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3349 displayed in another window, it does not become hidden, of course.
3350 The commands that move through the buffer list sometimes make a buffer
3351 hidden although the 'hidden' option is off: When the buffer is
3352 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003353 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003354 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 This option is set for one command with ":hide {command}" |:hide|.
3356 WARNING: It's easy to forget that you have changes in hidden buffers.
3357 Think twice when using ":q!" or ":qa!".
3358
3359 *'highlight'* *'hl'*
3360'highlight' 'hl' string (default (as a single string):
3361 "8:SpecialKey,@:NonText,d:Directory,
3362 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3363 M:ModeMsg,n:LineNr,r:Question,
3364 s:StatusLine,S:StatusLineNC,c:VertSplit
3365 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3366 f:Folded,F:FoldColumn,A:DiffAdd,
3367 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003368 >:SignColumn,B:SpellBad,P:SpellCap,
3369 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 global
3371 {not in Vi}
3372 This option can be used to set highlighting mode for various
3373 occasions. It is a comma separated list of character pairs. The
3374 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003375 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3377 |hl-NonText| @ '~' and '@' at the end of the window and
3378 characters from 'showbreak'
3379 |hl-Directory| d directories in CTRL-D listing and other special
3380 things in listings
3381 |hl-ErrorMsg| e error messages
3382 h (obsolete, ignored)
3383 |hl-IncSearch| i 'incsearch' highlighting
3384 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3385 |hl-MoreMsg| m |more-prompt|
3386 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3387 |hl-LineNr| n line number for ":number" and ":#" commands
3388 |hl-Question| r |hit-enter| prompt and yes/no questions
3389 |hl-StatusLine| s status line of current window |status-line|
3390 |hl-StatusLineNC| S status lines of not-current windows
3391 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3392 |hl-VertSplit| c column used to separate vertically split windows
3393 |hl-Visual| v Visual mode
3394 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3395 Selection" Only X11 Gui's |gui-x11| and
3396 |xterm-clipboard|.
3397 |hl-WarningMsg| w warning messages
3398 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3399 |hl-Folded| f line used for closed folds
3400 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003401 |hl-DiffAdd| A added line in diff mode
3402 |hl-DiffChange| C changed line in diff mode
3403 |hl-DiffDelete| D deleted line in diff mode
3404 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003406 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003407 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003408 |hl-SpellRare| R rare word |spell|
3409 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410
3411 The display modes are:
3412 r reverse (termcap entry "mr" and "me")
3413 i italic (termcap entry "ZH" and "ZR")
3414 b bold (termcap entry "md" and "me")
3415 s standout (termcap entry "so" and "se")
3416 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003417 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 n no highlighting
3419 - no highlighting
3420 : use a highlight group
3421 The default is used for occasions that are not included.
3422 If you want to change what the display modes do, see |dos-colors|
3423 for an example.
3424 When using the ':' display mode, this must be followed by the name of
3425 a highlight group. A highlight group can be used to define any type
3426 of highlighting, including using color. See |:highlight| on how to
3427 define one. The default uses a different group for each occasion.
3428 See |highlight-default| for the default highlight groups.
3429
3430 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3431'hlsearch' 'hls' boolean (default off)
3432 global
3433 {not in Vi}
3434 {not available when compiled without the
3435 |+extra_search| feature}
3436 When there is a previous search pattern, highlight all its matches.
3437 The type of highlighting used can be set with the 'l' occasion in the
3438 'highlight' option. This uses the "Search" highlight group by
3439 default. Note that only the matching text is highlighted, any offsets
3440 are not applied.
3441 See also: 'incsearch' and |:match|.
3442 When you get bored looking at the highlighted matches, you can turn it
3443 off with |:nohlsearch|. As soon as you use a search command, the
3444 highlighting comes back.
3445 When the search pattern can match an end-of-line, Vim will try to
3446 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003447 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 line below a closed fold. A match in a previous line which is not
3449 drawn may not continue in an newly drawn line.
3450 NOTE: This option is reset when 'compatible' is set.
3451
3452 *'history'* *'hi'*
3453'history' 'hi' number (Vim default: 20, Vi default: 0)
3454 global
3455 {not in Vi}
3456 A history of ":" commands, and a history of previous search patterns
3457 are remembered. This option decides how many entries may be stored in
3458 each of these histories (see |cmdline-editing|).
3459 NOTE: This option is set to the Vi default value when 'compatible' is
3460 set and to the Vim default value when 'compatible' is reset.
3461
3462 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3463'hkmap' 'hk' boolean (default off)
3464 global
3465 {not in Vi}
3466 {only available when compiled with the |+rightleft|
3467 feature}
3468 When on, the keyboard is mapped for the Hebrew character set.
3469 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3470 toggle this option. See |rileft.txt|.
3471 NOTE: This option is reset when 'compatible' is set.
3472
3473 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3474'hkmapp' 'hkp' boolean (default off)
3475 global
3476 {not in Vi}
3477 {only available when compiled with the |+rightleft|
3478 feature}
3479 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3480 This is useful if you have a non-Hebrew keyboard.
3481 See |rileft.txt|.
3482 NOTE: This option is reset when 'compatible' is set.
3483
3484 *'icon'* *'noicon'*
3485'icon' boolean (default off, on when title can be restored)
3486 global
3487 {not in Vi}
3488 {not available when compiled without the |+title|
3489 feature}
3490 When on, the icon text of the window will be set to the value of
3491 'iconstring' (if it is not empty), or to the name of the file
3492 currently being edited. Only the last part of the name is used.
3493 Overridden by the 'iconstring' option.
3494 Only works if the terminal supports setting window icons (currently
3495 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3496 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3497 builtin termcap).
3498 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003499 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 X11.
3501
3502 *'iconstring'*
3503'iconstring' string (default "")
3504 global
3505 {not in Vi}
3506 {not available when compiled without the |+title|
3507 feature}
3508 When this option is not empty, it will be used for the icon text of
3509 the window. This happens only when the 'icon' option is on.
3510 Only works if the terminal supports setting window icon text
3511 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3512 Does not work for MS Windows.
3513 When Vim was compiled with HAVE_X11 defined, the original icon will be
3514 restored if possible |X11|.
3515 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003516 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 'titlestring' for example settings.
3518 {not available when compiled without the |+statusline| feature}
3519
3520 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3521'ignorecase' 'ic' boolean (default off)
3522 global
3523 Ignore case in search patterns. Also used when searching in the tags
3524 file.
3525 Also see 'smartcase'.
3526 Can be overruled by using "\c" or "\C" in the pattern, see
3527 |/ignorecase|.
3528
3529 *'imactivatekey'* *'imak'*
3530'imactivatekey' 'imak' string (default "")
3531 global
3532 {not in Vi}
3533 {only available when compiled with |+xim| and
3534 |+GUI_GTK|}
3535 Specifies the key that your Input Method in X-Windows uses for
3536 activation. When this is specified correctly, vim can fully control
3537 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3538 You can't use this option to change the activation key, the option
3539 tells Vim what the key is.
3540 Format:
3541 [MODIFIER_FLAG-]KEY_STRING
3542
3543 These characters can be used for MODIFIER_FLAG (case is ignored):
3544 S Shift key
3545 L Lock key
3546 C Control key
3547 1 Mod1 key
3548 2 Mod2 key
3549 3 Mod3 key
3550 4 Mod4 key
3551 5 Mod5 key
3552 Combinations are allowed, for example "S-C-space" or "SC-space" are
3553 both shift+ctrl+space.
3554 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3555
3556 Example: >
3557 :set imactivatekey=S-space
3558< "S-space" means shift+space. This is the activation key for kinput2 +
3559 canna (Japanese), and ami (Korean).
3560
3561 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3562'imcmdline' 'imc' boolean (default off)
3563 global
3564 {not in Vi}
3565 {only available when compiled with the |+xim|
3566 |+multi_byte_ime| or |global-ime| feature}
3567 When set the Input Method is always on when starting to edit a command
3568 line, unless entering a search pattern (see 'imsearch' for that).
3569 Setting this option is useful when your input method allows entering
3570 English characters directly, e.g., when it's used to type accented
3571 characters with dead keys.
3572
3573 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3574'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3575 global
3576 {not in Vi}
3577 {only available when compiled with the |+xim|
3578 |+multi_byte_ime| or |global-ime| feature}
3579 When set the Input Method is never used. This is useful to disable
3580 the IM when it doesn't work properly.
3581 Currently this option is on by default for SGI/IRIX machines. This
3582 may change in later releases.
3583
3584 *'iminsert'* *'imi'*
3585'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3586 local to buffer
3587 {not in Vi}
3588 Specifies whether :lmap or an Input Method (IM) is to be used in
3589 Insert mode. Valid values:
3590 0 :lmap is off and IM is off
3591 1 :lmap is ON and IM is off
3592 2 :lmap is off and IM is ON
3593 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3594 or |global-ime|.
3595 To always reset the option to zero when leaving Insert mode with <Esc>
3596 this can be used: >
3597 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3598< This makes :lmap and IM turn off automatically when leaving Insert
3599 mode.
3600 Note that this option changes when using CTRL-^ in Insert mode
3601 |i_CTRL-^|.
3602 The value is set to 1 when setting 'keymap' to a valid keymap name.
3603 It is also used for the argument of commands like "r" and "f".
3604 The value 0 may not work correctly with Athena and Motif with some XIM
3605 methods. Use 'imdisable' to disable XIM then.
3606
3607 *'imsearch'* *'ims'*
3608'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3609 local to buffer
3610 {not in Vi}
3611 Specifies whether :lmap or an Input Method (IM) is to be used when
3612 entering a search pattern. Valid values:
3613 -1 the value of 'iminsert' is used, makes it look like
3614 'iminsert' is also used when typing a search pattern
3615 0 :lmap is off and IM is off
3616 1 :lmap is ON and IM is off
3617 2 :lmap is off and IM is ON
3618 Note that this option changes when using CTRL-^ in Command-line mode
3619 |c_CTRL-^|.
3620 The value is set to 1 when it is not -1 and setting the 'keymap'
3621 option to a valid keymap name.
3622 The value 0 may not work correctly with Athena and Motif with some XIM
3623 methods. Use 'imdisable' to disable XIM then.
3624
3625 *'include'* *'inc'*
3626'include' 'inc' string (default "^\s*#\s*include")
3627 global or local to buffer |global-local|
3628 {not in Vi}
3629 {not available when compiled without the
3630 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003631 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 pattern, just like for the "/" command (See |pattern|). The default
3633 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003634 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 name that comes after the matched pattern. See |option-backslash|
3636 about including spaces and backslashes.
3637
3638 *'includeexpr'* *'inex'*
3639'includeexpr' 'inex' string (default "")
3640 local to buffer
3641 {not in Vi}
3642 {not available when compiled without the
3643 |+find_in_path| or |+eval| feature}
3644 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003645 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 :set includeexpr=substitute(v:fname,'\\.','/','g')
3647< The "v:fname" variable will be set to the file name that was detected.
3648 Evaluated in the |sandbox|.
3649 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003650 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 Also used for |<cfile>|.
3652
3653 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3654'incsearch' 'is' boolean (default off)
3655 global
3656 {not in Vi}
3657 {not available when compiled without the
3658 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003659 While typing a search command, show where the pattern, as it was typed
3660 so far, matches. The matched string is highlighted. If the pattern
3661 is invalid or not found, nothing is shown. The screen will be updated
3662 often, this is only useful on fast terminals.
3663 Note that the match will be shown, but the cursor will return to its
3664 original position when no match is found and when pressing <Esc>. You
3665 still need to finish the search command with <Enter> to move the
3666 cursor to the match.
3667 The highlighting can be set with the 'i' flag in 'highlight'.
3668 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 NOTE: This option is reset when 'compatible' is set.
3670
3671 *'indentexpr'* *'inde'*
3672'indentexpr' 'inde' string (default "")
3673 local to buffer
3674 {not in Vi}
3675 {not available when compiled without the |+cindent|
3676 or |+eval| features}
3677 Expression which is evaluated to obtain the proper indent for a line.
3678 It is used when a new line is created, for the |=| operator and
3679 in Insert mode as specified with the 'indentkeys' option.
3680 When this option is not empty, it overrules the 'cindent' and
3681 'smartindent' indenting.
3682 When 'paste' is set this option is not used for indenting.
3683 The expression is evaluated with |v:lnum| set to the line number for
3684 which the indent is to be computed. The cursor is also as this line
3685 when the expression is evaluated (but it may be moved around).
3686 The expression must return the number of spaces worth of indent. It
3687 can return "-1" to keep the current indent (this means 'autoindent' is
3688 used for the indent).
3689 Functions useful for computing the indent are |indent()|, |cindent()|
3690 and |lispindent()|.
3691 The evaluation of the expression must not have side effects! It must
3692 not change the text, jump to another window, etc. Afterwards the
3693 cursor position is always restored, thus the cursor may be moved.
3694 Normally this option would be set to call a function: >
3695 :set indentexpr=GetMyIndent()
3696< Error messages will be suppressed, unless the 'debug' option contains
3697 "msg".
3698 See |indent-expression|. Also see |eval-sandbox|.
3699 NOTE: This option is made empty when 'compatible' is set.
3700
3701 *'indentkeys'* *'indk'*
3702'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3703 local to buffer
3704 {not in Vi}
3705 {not available when compiled without the |+cindent|
3706 feature}
3707 A list of keys that, when typed in Insert mode, cause reindenting of
3708 the current line. Only happens if 'indentexpr' isn't empty.
3709 The format is identical to 'cinkeys', see |indentkeys-format|.
3710 See |C-indenting| and |indent-expression|.
3711
3712 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3713'infercase' 'inf' boolean (default off)
3714 local to buffer
3715 {not in Vi}
3716 When doing keyword completion in insert mode |ins-completion|, and
3717 'ignorecase' is also on, the case of the match is adjusted. If the
3718 typed text contains a lowercase letter where the match has an upper
3719 case letter, the completed part is made lowercase. If the typed text
3720 has no lowercase letters and the match has a lowercase letter where
3721 the typed text has an uppercase letter, and there is a letter before
3722 it, the completed part is made uppercase.
3723
3724 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3725'insertmode' 'im' boolean (default off)
3726 global
3727 {not in Vi}
3728 Makes Vim work in a way that Insert mode is the default mode. Useful
3729 if you want to use Vim as a modeless editor. Used for |evim|.
3730 These Insert mode commands will be useful:
3731 - Use the cursor keys to move around.
3732 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3733 this is a mapping, it is executed as if 'insertmode' was off.
3734 Normal mode remains active until the mapping is finished.
3735 *i_CTRL-L*
3736 - Use CTRL-L to execute a number of Normal mode commands, then use
3737 <Esc> to get back to Insert mode.
3738
3739 These items change when 'insertmode' is set:
3740 - when starting to edit of a file, Vim goes to Insert mode.
3741 - <Esc> in Insert mode is a no-op and beeps.
3742 - <Esc> in Normal mode makes Vim go to Insert mode.
3743 - CTRL-L in Insert mode is a command, it is not inserted.
3744 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3745 However, when <Esc> is used inside a mapping, it behaves like
3746 'insertmode' was not set. This was done to be able to use the same
3747 mappings with 'insertmode' set or not set.
3748 When executing commands with |:normal| 'insertmode' is not used.
3749
3750 NOTE: This option is reset when 'compatible' is set.
3751
3752 *'isfname'* *'isf'*
3753'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3754 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3755 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3756 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3757 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3758 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3759 global
3760 {not in Vi}
3761 The characters specified by this option are included in file names and
3762 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003763 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 Multi-byte characters 256 and above are always included, only the
3765 characters up to 255 are specified with this option.
3766 For UTF-8 the characters 0xa0 to 0xff are included as well.
3767
3768 Note that on systems using a backslash as path separator, Vim tries to
3769 do its best to make it work as you would expect. That is a bit
3770 tricky, since Vi originally used the backslash to escape special
3771 characters. Vim will not remove a backslash in front of a normal file
3772 name character on these systems, but it will on Unix and alikes. The
3773 '&' and '^' are not included by default, because these are special for
3774 cmd.exe.
3775
3776 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003777 Each part can be a single character number or a range. A range is two
3778 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 decimal number between 0 and 255 or the ASCII character itself (does
3780 not work for digits). Example:
3781 "_,-,128-140,#-43" (include '_' and '-' and the range
3782 128 to 140 and '#' to 43)
3783 If a part starts with '^', the following character number or range
3784 will be excluded from the option. The option is interpreted from left
3785 to right. Put the excluded character after the range where it is
3786 included. To include '^' itself use it as the last character of the
3787 option or the end of a range. Example:
3788 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3789 If the character is '@', all characters where isalpha() returns TRUE
3790 are included. Normally these are the characters a to z and A to Z,
3791 plus accented characters. To include '@' itself use "@-@". Examples:
3792 "@,^a-z" All alphabetic characters, excluding lower
3793 case letters.
3794 "a-z,A-Z,@-@" All letters plus the '@' character.
3795 A comma can be included by using it where a character number is
3796 expected. Example:
3797 "48-57,,,_" Digits, comma and underscore.
3798 A comma can be excluded by prepending a '^'. Example:
3799 " -~,^,,9" All characters from space to '~', excluding
3800 comma, plus <Tab>.
3801 See |option-backslash| about including spaces and backslashes.
3802
3803 *'isident'* *'isi'*
3804'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3805 "@,48-57,_,128-167,224-235"
3806 otherwise: "@,48-57,_,192-255")
3807 global
3808 {not in Vi}
3809 The characters given by this option are included in identifiers.
3810 Identifiers are used in recognizing environment variables and after a
3811 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003812 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 option.
3814 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003815 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3817
3818 *'iskeyword'* *'isk'*
3819'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3820 "@,48-57,_,128-167,224-235"
3821 otherwise: "@,48-57,_,192-255"
3822 Vi default: "@,48-57,_")
3823 local to buffer
3824 {not in Vi}
3825 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003826 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 'isfname' for a description of the format of this option. For C
3828 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3829 For a help file it is set to all non-blank printable characters except
3830 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3831 command).
3832 When the 'lisp' option is on the '-' character is always included.
3833 NOTE: This option is set to the Vi default value when 'compatible' is
3834 set and to the Vim default value when 'compatible' is reset.
3835
3836 *'isprint'* *'isp'*
3837'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3838 "@,~-255"; otherwise: "@,161-255")
3839 global
3840 {not in Vi}
3841 The characters given by this option are displayed directly on the
3842 screen. It is also used for "\p" in a |pattern|. The characters from
3843 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3844 even when they are not included in 'isprint' or excluded. See
3845 'isfname' for a description of the format of this option.
3846
3847 Non-printable characters are displayed with two characters:
3848 0 - 31 "^@" - "^_"
3849 32 - 126 always single characters
3850 127 "^?"
3851 128 - 159 "~@" - "~_"
3852 160 - 254 "| " - "|~"
3853 255 "~?"
3854 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3855 displayed as <xx>, with the hexadecimal value of the byte.
3856 When 'display' contains "uhex" all unprintable characters are
3857 displayed as <xx>.
3858 The NonText highlighting will be used for unprintable characters.
3859 |hl-NonText|
3860
3861 Multi-byte characters 256 and above are always included, only the
3862 characters up to 255 are specified with this option. When a character
3863 is printable but it is not available in the current font, a
3864 replacement character will be shown.
3865 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3866 There is no option to specify these characters.
3867
3868 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3869'joinspaces' 'js' boolean (default on)
3870 global
3871 {not in Vi}
3872 Insert two spaces after a '.', '?' and '!' with a join command.
3873 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3874 Otherwise only one space is inserted.
3875 NOTE: This option is set when 'compatible' is set.
3876
3877 *'key'*
3878'key' string (default "")
3879 local to buffer
3880 {not in Vi}
3881 The key that is used for encrypting and decrypting the current buffer.
3882 See |encryption|.
3883 Careful: Do not set the key value by hand, someone might see the typed
3884 key. Use the |:X| command. But you can make 'key' empty: >
3885 :set key=
3886< It is not possible to get the value of this option with ":set key" or
3887 "echo &key". This is to avoid showing it to someone who shouldn't
3888 know. It also means you cannot see it yourself once you have set it,
3889 be careful not to make a typing error!
3890
3891 *'keymap'* *'kmp'* *E544*
3892'keymap' 'kmp' string (default "")
3893 local to buffer
3894 {not in Vi}
3895 {only available when compiled with the |+keymap|
3896 feature}
3897 Name of a keyboard mapping. See |mbyte-keymap|.
3898 Setting this option to a valid keymap name has the side effect of
3899 setting 'iminsert' to one, so that the keymap becomes effective.
3900 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003901 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902
3903 *'keymodel'* *'km'*
3904'keymodel' 'km' string (default "")
3905 global
3906 {not in Vi}
3907 List of comma separated words, which enable special things that keys
3908 can do. These values can be used:
3909 startsel Using a shifted special key starts selection (either
3910 Select mode or Visual mode, depending on "key" being
3911 present in 'selectmode').
3912 stopsel Using a not-shifted special key stops selection.
3913 Special keys in this context are the cursor keys, <End>, <Home>,
3914 <PageUp> and <PageDown>.
3915 The 'keymodel' option is set by the |:behave| command.
3916
3917 *'keywordprg'* *'kp'*
3918'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3919 OS/2: "view /", VMS: "help")
3920 global or local to buffer |global-local|
3921 {not in Vi}
3922 Program to use for the |K| command. Environment variables are
3923 expanded |:set_env|. ":help" may be used to access the Vim internal
3924 help. (Note that previously setting the global option to the empty
3925 value did this, which is now deprecated.)
3926 When "man" is used, Vim will automatically translate a count for the
3927 "K" command to a section number. Also for "man -s", in which case the
3928 "-s" is removed when there is no count.
3929 See |option-backslash| about including spaces and backslashes.
3930 Example: >
3931 :set keywordprg=man\ -s
3932< This option cannot be set from a |modeline| or in the |sandbox|, for
3933 security reasons.
3934
3935 *'langmap'* *'lmap'* *E357* *E358*
3936'langmap' 'lmap' string (default "")
3937 global
3938 {not in Vi}
3939 {only available when compiled with the |+langmap|
3940 feature}
3941 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003942 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 inserted directly. When in command mode the 'langmap' option takes
3944 care of translating these special characters to the original meaning
3945 of the key. This means you don't have to change the keyboard mode to
3946 be able to execute Normal mode commands.
3947 This is the opposite of the 'keymap' option, where characters are
3948 mapped in Insert mode.
3949 This only works for 8-bit characters. The value of 'langmap' may be
3950 specified with multi-byte characters (e.g., UTF-8), but only the lower
3951 8 bits of each character will be used.
3952
3953 Example (for Greek): *greek* >
3954 :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
3955< Example (exchanges meaning of z and y for commands): >
3956 :set langmap=zy,yz,ZY,YZ
3957<
3958 The 'langmap' option is a list of parts, separated with commas. Each
3959 part can be in one of two forms:
3960 1. A list of pairs. Each pair is a "from" character immediately
3961 followed by the "to" character. Examples: "aA", "aAbBcC".
3962 2. A list of "from" characters, a semi-colon and a list of "to"
3963 characters. Example: "abc;ABC"
3964 Example: "aA,fgh;FGH,cCdDeE"
3965 Special characters need to be preceded with a backslash. These are
3966 ";", ',' and backslash itself.
3967
3968 This will allow you to activate vim actions without having to switch
3969 back and forth between the languages. Your language characters will
3970 be understood as normal vim English characters (according to the
3971 langmap mappings) in the following cases:
3972 o Normal/Visual mode (commands, buffer/register names, user mappings)
3973 o Insert/Replace Mode: Register names after CTRL-R
3974 o Insert/Replace Mode: Mappings
3975 Characters entered in Command-line mode will NOT be affected by
3976 this option. Note that this option can be changed at any time
3977 allowing to switch between mappings for different languages/encodings.
3978 Use a mapping to avoid having to type it each time!
3979
3980 *'langmenu'* *'lm'*
3981'langmenu' 'lm' string (default "")
3982 global
3983 {not in Vi}
3984 {only available when compiled with the |+menu| and
3985 |+multi_lang| features}
3986 Language to use for menu translation. Tells which file is loaded
3987 from the "lang" directory in 'runtimepath': >
3988 "lang/menu_" . &langmenu . ".vim"
3989< (without the spaces). For example, to always use the Dutch menus, no
3990 matter what $LANG is set to: >
3991 :set langmenu=nl_NL.ISO_8859-1
3992< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003993 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003994 If your $LANG is set to a non-English language but you do want to use
3995 the English menus: >
3996 :set langmenu=none
3997< This option must be set before loading menus, switching on filetype
3998 detection or syntax highlighting. Once the menus are defined setting
3999 this option has no effect. But you could do this: >
4000 :source $VIMRUNTIME/delmenu.vim
4001 :set langmenu=de_DE.ISO_8859-1
4002 :source $VIMRUNTIME/menu.vim
4003< Warning: This deletes all menus that you defined yourself!
4004
4005 *'laststatus'* *'ls'*
4006'laststatus' 'ls' number (default 1)
4007 global
4008 {not in Vi}
4009 The value of this option influences when the last window will have a
4010 status line:
4011 0: never
4012 1: only if there are at least two windows
4013 2: always
4014 The screen looks nicer with a status line if you have several
4015 windows, but it takes another screen line. |status-line|
4016
4017 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4018'lazyredraw' 'lz' boolean (default off)
4019 global
4020 {not in Vi}
4021 When this option is set, the screen will not be redrawn while
4022 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004023 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024 update use |:redraw|.
4025
4026 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4027'linebreak' 'lbr' boolean (default off)
4028 local to window
4029 {not in Vi}
4030 {not available when compiled without the |+linebreak|
4031 feature}
4032 If on Vim will wrap long lines at a character in 'breakat' rather
4033 than at the last character that fits on the screen. Unlike
4034 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4035 it only affects the way the file is displayed, not its contents. The
4036 value of 'showbreak' is used to put in front of wrapped lines.
4037 This option is not used when the 'wrap' option is off or 'list' is on.
4038 Note that <Tab> characters after an <EOL> are mostly not displayed
4039 with the right amount of white space.
4040
4041 *'lines'* *E593*
4042'lines' number (default 24 or terminal height)
4043 global
4044 Number of lines of the Vim window.
4045 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004046 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 When Vim is running in the GUI or in a resizable window, setting this
4048 option will cause the window size to be changed. When you only want
4049 to use the size for the GUI, put the command in your |gvimrc| file.
4050 Vim limits the number of lines to what fits on the screen. You can
4051 use this command to get the tallest window possible: >
4052 :set lines=999
4053< If you get less lines than expected, check the 'guiheadroom' option.
4054 When you set this option and Vim is unable to change the physical
4055 number of lines of the display, the display may be messed up.
4056
4057 *'linespace'* *'lsp'*
4058'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4059 global
4060 {not in Vi}
4061 {only in the GUI}
4062 Number of pixel lines inserted between characters. Useful if the font
4063 uses the full character cell height, making lines touch each other.
4064 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004065 With some fonts there can be too much room between lines (to have
4066 space for ascents and descents). Then it makes sense to set
4067 'linespace' to a negative value. This may cause display problems
4068 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004069
4070 *'lisp'* *'nolisp'*
4071'lisp' boolean (default off)
4072 local to buffer
4073 {not available when compiled without the |+lispindent|
4074 feature}
4075 Lisp mode: When <Enter> is typed in insert mode set the indent for
4076 the next line to Lisp standards (well, sort of). Also happens with
4077 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4078 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4079 better. Also see 'lispwords'.
4080 The '-' character is included in keyword characters. Redefines the
4081 "=" operator to use this same indentation algorithm rather than
4082 calling an external program if 'equalprg' is empty.
4083 This option is not used when 'paste' is set.
4084 {Vi: Does it a little bit differently}
4085
4086 *'lispwords'* *'lw'*
4087'lispwords' 'lw' string (default is very long)
4088 global
4089 {not in Vi}
4090 {not available when compiled without the |+lispindent|
4091 feature}
4092 Comma separated list of words that influence the Lisp indenting.
4093 |'lisp'|
4094
4095 *'list'* *'nolist'*
4096'list' boolean (default off)
4097 local to window
4098 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4099 see the difference between tabs and spaces and for trailing blanks.
4100 Note that this will also affect formatting (set with 'textwidth' or
4101 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4102 changing the way tabs are displayed.
4103
4104 *'listchars'* *'lcs'*
4105'listchars' 'lcs' string (default "eol:$")
4106 global
4107 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004108 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 settings.
4110 eol:c Character to show at the end of each line. When
4111 omitted, there is no extra character at the end of the
4112 line.
4113 tab:xy Two characters to be used to show a Tab. The first
4114 char is used once. The second char is repeated to
4115 fill the space that the Tab normally occupies.
4116 "tab:>-" will show a Tab that takes four spaces as
4117 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004118 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 trailing spaces are blank.
4120 extends:c Character to show in the last column, when 'wrap' is
4121 off and the line continues beyond the right of the
4122 screen.
4123 precedes:c Character to show in the first column, when 'wrap'
4124 is off and there is text preceding the character
4125 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004126 nbsp:c Character to show for a non-breakable space (character
4127 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004129 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 be used when 'encoding' is "utf-8", otherwise only printable
4131 characters are allowed.
4132
4133 Examples: >
4134 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004135 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136 :set lcs=extends:>,precedes:<
4137< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004138 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139
4140 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4141'loadplugins' 'lpl' boolean (default on)
4142 global
4143 {not in Vi}
4144 When on the plugin scripts are loaded when starting up |load-plugins|.
4145 This option can be reset in your |vimrc| file to disable the loading
4146 of plugins.
4147 Note that using the "-u NONE" and "--noplugin" command line arguments
4148 reset this option. |-u| |--noplugin|
4149
4150 *'magic'* *'nomagic'*
4151'magic' boolean (default on)
4152 global
4153 Changes the special characters that can be used in search patterns.
4154 See |pattern|.
4155 NOTE: To avoid portability problems with using patterns, always keep
4156 this option at the default "on". Only switch it off when working with
4157 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004158 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159
4160 *'makeef'* *'mef'*
4161'makeef' 'mef' string (default: "")
4162 global
4163 {not in Vi}
4164 {not available when compiled without the |+quickfix|
4165 feature}
4166 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4167 and the |:grep| command.
4168 When it is empty, an internally generated temp file will be used.
4169 When "##" is included, it is replaced by a number to make the name
4170 unique. This makes sure that the ":make" command doesn't overwrite an
4171 existing file.
4172 NOT used for the ":cf" command. See 'errorfile' for that.
4173 Environment variables are expanded |:set_env|.
4174 See |option-backslash| about including spaces and backslashes.
4175 This option cannot be set from a |modeline| or in the |sandbox|, for
4176 security reasons.
4177
4178 *'makeprg'* *'mp'*
4179'makeprg' 'mp' string (default "make", VMS: "MMS")
4180 global or local to buffer |global-local|
4181 {not in Vi}
4182 Program to use for the ":make" command. See |:make_makeprg|. This
4183 option may contain '%' and '#' characters, which are expanded like
4184 when used in a command-line. Environment variables are expanded
4185 |:set_env|. See |option-backslash| about including spaces and
4186 backslashes. Note that a '|' must be escaped twice: once for ":set"
4187 and once for the interpretation of a command. When you use a filter
4188 called "myfilter" do it like this: >
4189 :set makeprg=gmake\ \\\|\ myfilter
4190< The placeholder "$*" can be given (even multiple times) to specify
4191 where the arguments will be included, for example: >
4192 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4193< This option cannot be set from a |modeline| or in the |sandbox|, for
4194 security reasons.
4195
4196 *'matchpairs'* *'mps'*
4197'matchpairs' 'mps' string (default "(:),{:},[:]")
4198 local to buffer
4199 {not in Vi}
4200 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004201 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 must be different. The characters must be separated by a colon. The
4203 pairs must be separated by a comma. Example for including '<' and '>'
4204 (HTML): >
4205 :set mps+=<:>
4206
4207< A more exotic example, to jump between the '=' and ';' in an
4208 assignment, useful for languages like C and Java: >
4209 :au FileType c,cpp,java set mps+==:;
4210
4211< For a more advanced way of using "%", see the matchit.vim plugin in
4212 the $VIMRUNTIME/macros directory. |add-local-help|
4213
4214 *'matchtime'* *'mat'*
4215'matchtime' 'mat' number (default 5)
4216 global
4217 {not in Vi}{in Nvi}
4218 Tenths of a second to show the matching paren, when 'showmatch' is
4219 set. Note that this is not in milliseconds, like other options that
4220 set a time. This is to be compatible with Nvi.
4221
4222 *'maxfuncdepth'* *'mfd'*
4223'maxfuncdepth' 'mfd' number (default 100)
4224 global
4225 {not in Vi}
4226 Maximum depth of function calls for user functions. This normally
4227 catches endless recursion. When using a recursive function with
4228 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4229 more memory, there is the danger of failing when memory is exhausted.
4230 See also |:function|.
4231
4232 *'maxmapdepth'* *'mmd'* *E223*
4233'maxmapdepth' 'mmd' number (default 1000)
4234 global
4235 {not in Vi}
4236 Maximum number of times a mapping is done without resulting in a
4237 character to be used. This normally catches endless mappings, like
4238 ":map x y" with ":map y x". It still does not catch ":map g wg",
4239 because the 'w' is used before the next mapping is done. See also
4240 |key-mapping|.
4241
4242 *'maxmem'* *'mm'*
4243'maxmem' 'mm' number (default between 256 to 5120 (system
4244 dependent) or half the amount of memory
4245 available)
4246 global
4247 {not in Vi}
4248 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4249 limit is reached allocating extra memory for a buffer will cause
4250 other memory to be freed. Maximum value 2000000. Use this to work
4251 without a limit. Also see 'maxmemtot'.
4252
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004253 *'maxmempattern'* *'mmp'*
4254'maxmempattern' 'mmp' number (default 1000)
4255 global
4256 {not in Vi}
4257 Maximum amount of memory (in Kbyte) to use for pattern matching.
4258 Maximum value 2000000. Use this to work without a limit.
4259 *E363*
4260 When Vim runs into the limit it gives an error message mostly behaves
4261 like CTRL-C was typed.
4262 Running into the limit often means that the pattern is very
4263 inefficient or too complex. This may already happen with the pattern
4264 "\(.\)*" on a very long line. ".*" works much better.
4265 Vim may run out of memory before hitting the 'maxmempattern' limit.
4266
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 *'maxmemtot'* *'mmt'*
4268'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4269 dependent) or half the amount of memory
4270 available)
4271 global
4272 {not in Vi}
4273 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004274 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 'maxmem'.
4276
4277 *'menuitems'* *'mis'*
4278'menuitems' 'mis' number (default 25)
4279 global
4280 {not in Vi}
4281 {not available when compiled without the |+menu|
4282 feature}
4283 Maximum number of items to use in a menu. Used for menus that are
4284 generated from a list of items, e.g., the Buffers menu. Changing this
4285 option has no direct effect, the menu must be refreshed first.
4286
4287 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4288'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4289 local to buffer
4290 *'modelines'* *'mls'*
4291'modelines' 'mls' number (default 5)
4292 global
4293 {not in Vi}
4294 If 'modeline' is on 'modelines' gives the number of lines that is
4295 checked for set commands. If 'modeline' is off or 'modelines' is zero
4296 no lines are checked. See |modeline|.
4297 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4298 set and to the Vim default value when 'compatible' is reset.
4299
4300 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4301'modifiable' 'ma' boolean (default on)
4302 local to buffer
4303 {not in Vi} *E21*
4304 When off the buffer contents cannot be changed. The 'fileformat' and
4305 'fileencoding' options also can't be changed.
4306 Can be reset with the |-M| command line argument.
4307
4308 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4309'modified' 'mod' boolean (default off)
4310 local to buffer
4311 {not in Vi}
4312 When on, the buffer is considered to be modified. This option is set
4313 when:
4314 1. A change was made to the text since it was last written. Using the
4315 |undo| command to go back to the original text will reset the
4316 option. But undoing changes that were made before writing the
4317 buffer will set the option again, since the text is different from
4318 when it was written.
4319 2. 'fileformat' or 'fileencoding' is different from its original
4320 value. The original value is set when the buffer is read or
4321 written. A ":set nomodified" command also resets the original
4322 values to the current values and the 'modified' option will be
4323 reset.
4324 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4325 will be ignored.
4326
4327 *'more'* *'nomore'*
4328'more' boolean (Vim default: on, Vi default: off)
4329 global
4330 {not in Vi}
4331 When on, listings pause when the whole screen is filled. You will get
4332 the |more-prompt|. When this option is off there are no pauses, the
4333 listing continues until finished.
4334 NOTE: This option is set to the Vi default value when 'compatible' is
4335 set and to the Vim default value when 'compatible' is reset.
4336
4337 *'mouse'* *E538*
4338'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4339 global
4340 {not in Vi}
4341 Enable the use of the mouse. Only works for certain terminals
4342 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4343 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4344 The mouse can be enabled for different modes:
4345 n Normal mode
4346 v Visual mode
4347 i Insert mode
4348 c Command-line mode
4349 h all previous modes when editing a help file
4350 a all previous modes
4351 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 Normally you would enable the mouse in all four modes with: >
4353 :set mouse=a
4354< When the mouse is not enabled, the GUI will still use the mouse for
4355 modeless selection. This doesn't move the text cursor.
4356
4357 See |mouse-using|. Also see |'clipboard'|.
4358
4359 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004360 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004361 the mouse buttons can still be used by keeping the shift key pressed.
4362 Also see the 'clipboard' option.
4363
4364 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4365'mousefocus' 'mousef' boolean (default off)
4366 global
4367 {not in Vi}
4368 {only works in the GUI}
4369 The window that the mouse pointer is on is automatically activated.
4370 When changing the window layout or window focus in another way, the
4371 mouse pointer is moved to the window with keyboard focus. Off is the
4372 default because it makes using the pull down menus a little goofy, as
4373 a pointer transit may activate a window unintentionally.
4374
4375 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4376'mousehide' 'mh' boolean (default on)
4377 global
4378 {not in Vi}
4379 {only works in the GUI}
4380 When on, the mouse pointer is hidden when characters are typed.
4381 The mouse pointer is restored when the mouse is moved.
4382
4383 *'mousemodel'* *'mousem'*
4384'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4385 global
4386 {not in Vi}
4387 Sets the model to use for the mouse. The name mostly specifies what
4388 the right mouse button is used for:
4389 extend Right mouse button extends a selection. This works
4390 like in an xterm.
4391 popup Right mouse button pops up a menu. The shifted left
4392 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004393 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 popup_setpos Like "popup", but the cursor will be moved to the
4395 position where the mouse was clicked, and thus the
4396 selected operation will act upon the clicked object.
4397 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004398 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399 course, that right clicking outside a selection will
4400 end Visual mode.
4401 Overview of what button does what for each model:
4402 mouse extend popup(_setpos) ~
4403 left click place cursor place cursor
4404 left drag start selection start selection
4405 shift-left search word extend selection
4406 right click extend selection popup menu (place cursor)
4407 right drag extend selection -
4408 middle click paste paste
4409
4410 In the "popup" model the right mouse button produces a pop-up menu.
4411 You need to define this first, see |popup-menu|.
4412
4413 Note that you can further refine the meaning of buttons with mappings.
4414 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4415 selection (because that's handled in the GUI code directly).
4416
4417 The 'mousemodel' option is set by the |:behave| command.
4418
4419 *'mouseshape'* *'mouses'* *E547*
4420'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004421 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 global
4423 {not in Vi}
4424 {only available when compiled with the |+mouseshape|
4425 feature}
4426 This option tells Vim what the mouse pointer should look like in
4427 different modes. The option is a comma separated list of parts, much
4428 like used for 'guicursor'. Each part consist of a mode/location-list
4429 and an argument-list:
4430 mode-list:shape,mode-list:shape,..
4431 The mode-list is a dash separated list of these modes/locations:
4432 In a normal window: ~
4433 n Normal mode
4434 v Visual mode
4435 ve Visual mode with 'selection' "exclusive" (same as 'v',
4436 if not specified)
4437 o Operator-pending mode
4438 i Insert mode
4439 r Replace mode
4440
4441 Others: ~
4442 c appending to the command-line
4443 ci inserting in the command-line
4444 cr replacing in the command-line
4445 m at the 'Hit ENTER' or 'More' prompts
4446 ml idem, but cursor in the last line
4447 e any mode, pointer below last window
4448 s any mode, pointer on a status line
4449 sd any mode, while dragging a status line
4450 vs any mode, pointer on a vertical separator line
4451 vd any mode, while dragging a vertical separator line
4452 a everywhere
4453
4454 The shape is one of the following:
4455 avail name looks like ~
4456 w x arrow Normal mouse pointer
4457 w x blank no pointer at all (use with care!)
4458 w x beam I-beam
4459 w x updown up-down sizing arrows
4460 w x leftright left-right sizing arrows
4461 w x busy The system's usual busy pointer
4462 w x no The system's usual 'no input' pointer
4463 x udsizing indicates up-down resizing
4464 x lrsizing indicates left-right resizing
4465 x crosshair like a big thin +
4466 x hand1 black hand
4467 x hand2 white hand
4468 x pencil what you write with
4469 x question big ?
4470 x rightup-arrow arrow pointing right-up
4471 w x up-arrow arrow pointing up
4472 x <number> any X11 pointer number (see X11/cursorfont.h)
4473
4474 The "avail" column contains a 'w' if the shape is available for Win32,
4475 x for X11.
4476 Any modes not specified or shapes not available use the normal mouse
4477 pointer.
4478
4479 Example: >
4480 :set mouseshape=s:udsizing,m:no
4481< will make the mouse turn to a sizing arrow over the status lines and
4482 indicate no input when the hit-enter prompt is displayed (since
4483 clicking the mouse has no effect in this state.)
4484
4485 *'mousetime'* *'mouset'*
4486'mousetime' 'mouset' number (default 500)
4487 global
4488 {not in Vi}
4489 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4490 time in msec between two mouse clicks for the second click to be
4491 recognized as a multi click.
4492
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004493 *'mzquantum'* *'mzq'*
4494'mzquantum' 'mzq' number (default 100)
4495 global
4496 {not in Vi}
4497 {not available when compiled without the |+mzscheme|
4498 feature}
4499 The number of milliseconds between polls for MzScheme threads.
4500 Negative or zero value means no thread scheduling.
4501
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 *'nrformats'* *'nf'*
4503'nrformats' 'nf' string (default "octal,hex")
4504 local to buffer
4505 {not in Vi}
4506 This defines what bases Vim will consider for numbers when using the
4507 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4508 respectively; see |CTRL-A| for more info on these commands.
4509 alpha if included, single alphabetical characters will be
4510 incremented or decremented. This is useful for a list with a
4511 letter index a), b), etc.
4512 octal if included, numbers that start with a zero will be considered
4513 to be octal. Example: Using CTRL-A on "007" results in "010".
4514 hex if included, numbers starting with "0x" or "0X" will be
4515 considered to be hexadecimal. Example: Using CTRL-X on
4516 "0x100" results in "0x0ff".
4517 Numbers which simply begin with a digit in the range 1-9 are always
4518 considered decimal. This also happens for numbers that are not
4519 recognized as octal or hex.
4520
4521 *'number'* *'nu'* *'nonumber'* *'nonu'*
4522'number' 'nu' boolean (default off)
4523 local to window
4524 Print the line number in front of each line. When the 'n' option is
4525 excluded from 'cpoptions' a wrapped line will not use the column of
4526 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004527 The 'numberwidth' option can be used to set the room used for the line
4528 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 When a long, wrapped line doesn't start with the first character, '-'
4530 characters are put before the number.
4531 See |hl-LineNr| for the highlighting used for the number.
4532
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004533 *'numberwidth'* *'nuw'*
4534'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4535 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004536 {not in Vi}
4537 {only available when compiled with the |+linebreak|
4538 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004539 Minimal number of columns to use for the line number. Only relevant
4540 when the 'number' option is set.
4541 Since one space is always between the number and the text, there is
4542 one less character for the number itself.
4543 The value is the minimum width. A bigger width is used when needed to
4544 fit the highest line number in the buffer. Thus with the Vim default
4545 of 4 there is room for a line number up to 999. When the buffer has
4546 1000 lines five columns will be used.
4547 The minimum value is 1, the maximum value is 10.
4548 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4549
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 *'osfiletype'* *'oft'* *E366*
4551'osfiletype' 'oft' string (RISC-OS default: "Text",
4552 others default: "")
4553 local to buffer
4554 {not in Vi}
4555 {only available when compiled with the |+osfiletype|
4556 feature}
4557 Some operating systems store extra information about files besides
4558 name, datestamp and permissions. This option contains the extra
4559 information, the nature of which will vary between systems.
4560 The value of this option is usually set when the file is loaded, and
4561 use to set the file type when file is written.
4562 It can affect the pattern matching of the automatic commands.
4563 |autocmd-osfiletypes|
4564
4565 *'paragraphs'* *'para'*
4566'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4567 global
4568 Specifies the nroff macros that separate paragraphs. These are pairs
4569 of two letters (see |object-motions|).
4570
4571 *'paste'* *'nopaste'*
4572'paste' boolean (default off)
4573 global
4574 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004575 Put Vim in Paste mode. This is useful if you want to cut or copy
4576 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 unexpected effects.
4578 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004579 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 knows about pasting and will mostly do the right thing without 'paste'
4581 being set. The same is true for a terminal where Vim handles the
4582 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004583 This option is reset when starting the GUI. Thus if you set it in
4584 your .vimrc it will work in a terminal, but not in the GUI. Setting
4585 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4586 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 When the 'paste' option is switched on (also when it was already on):
4588 - mapping in Insert mode and Command-line mode is disabled
4589 - abbreviations are disabled
4590 - 'textwidth' is set to 0
4591 - 'wrapmargin' is set to 0
4592 - 'autoindent' is reset
4593 - 'smartindent' is reset
4594 - 'softtabstop' is set to 0
4595 - 'revins' is reset
4596 - 'ruler' is reset
4597 - 'showmatch' is reset
4598 - 'formatoptions' is used like it is empty
4599 These options keep their value, but their effect is disabled:
4600 - 'lisp'
4601 - 'indentexpr'
4602 - 'cindent'
4603 NOTE: When you start editing another file while the 'paste' option is
4604 on, settings from the modelines or autocommands may change the
4605 settings again, causing trouble when pasting text. You might want to
4606 set the 'paste' option again.
4607 When the 'paste' option is reset the mentioned options are restored to
4608 the value before the moment 'paste' was switched from off to on.
4609 Resetting 'paste' before ever setting it does not have any effect.
4610 Since mapping doesn't work while 'paste' is active, you need to use
4611 the 'pastetoggle' option to toggle the 'paste' option with some key.
4612
4613 *'pastetoggle'* *'pt'*
4614'pastetoggle' 'pt' string (default "")
4615 global
4616 {not in Vi}
4617 When non-empty, specifies the key sequence that toggles the 'paste'
4618 option. This is like specifying a mapping: >
4619 :map {keys} :set invpaste<CR>
4620< Where {keys} is the value of 'pastetoggle'.
4621 The difference is that it will work even when 'paste' is set.
4622 'pastetoggle' works in Insert mode and Normal mode, but not in
4623 Command-line mode.
4624 Mappings are checked first, thus overrule 'pastetoggle'. However,
4625 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4626 this: >
4627 :map <F10> :set paste<CR>
4628 :map <F11> :set nopaste<CR>
4629 :imap <F10> <C-O>:set paste<CR>
4630 :imap <F11> <nop>
4631 :set pastetoggle=<F11>
4632< This will make <F10> start paste mode and <F11> stop paste mode.
4633 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4634 mode everything is inserted literally, except the 'pastetoggle' key
4635 sequence.
4636
4637 *'pex'* *'patchexpr'*
4638'patchexpr' 'pex' string (default "")
4639 global
4640 {not in Vi}
4641 {not available when compiled without the |+diff|
4642 feature}
4643 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004644 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
4646 *'patchmode'* *'pm'* *E206*
4647'patchmode' 'pm' string (default "")
4648 global
4649 {not in Vi}
4650 When non-empty the oldest version of a file is kept. This can be used
4651 to keep the original version of a file if you are changing files in a
4652 source distribution. Only the first time that a file is written a
4653 copy of the original file will be kept. The name of the copy is the
4654 name of the original file with the string in the 'patchmode' option
4655 appended. This option should start with a dot. Use a string like
4656 ".org". 'backupdir' must not be empty for this to work (Detail: The
4657 backup file is renamed to the patchmode file after the new file has
4658 been successfully written, that's why it must be possible to write a
4659 backup file). If there was no file to be backed up, an empty file is
4660 created.
4661 When the 'backupskip' pattern matches, a patchmode file is not made.
4662 Using 'patchmode' for compressed files appends the extension at the
4663 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4664 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004665 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666
4667 *'path'* *'pa'* *E343* *E345* *E347*
4668'path' 'pa' string (default on Unix: ".,/usr/include,,"
4669 on OS/2: ".,/emx/include,,"
4670 other systems: ".,,")
4671 global or local to buffer |global-local|
4672 {not in Vi}
4673 This is a list of directories which will be searched when using the
4674 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4675 being searched for has a relative path (not starting with '/'). The
4676 directories in the 'path' option may be relative or absolute.
4677 - Use commas to separate directory names: >
4678 :set path=.,/usr/local/include,/usr/include
4679< - Spaces can also be used to separate directory names (for backwards
4680 compatibility with version 3.0). To have a space in a directory
4681 name, precede it with an extra backslash, and escape the space: >
4682 :set path=.,/dir/with\\\ space
4683< - To include a comma in a directory name precede it with an extra
4684 backslash: >
4685 :set path=.,/dir/with\\,comma
4686< - To search relative to the directory of the current file, use: >
4687 :set path=.
4688< - To search in the current directory use an empty string between two
4689 commas: >
4690 :set path=,,
4691< - A directory name may end in a ':' or '/'.
4692 - Environment variables are expanded |:set_env|.
4693 - When using |netrw.vim| URLs can be used. For example, adding
4694 "http://www.vim.org" will make ":find index.html" work.
4695 - Search upwards and downwards in a directory tree:
4696 1) "*" matches a sequence of characters, e.g.: >
4697 :set path=/usr/include/*
4698< means all subdirectories in /usr/include (but not /usr/include
4699 itself). >
4700 :set path=/usr/*c
4701< matches /usr/doc and /usr/src.
4702 2) "**" matches a subtree, up to 100 directories deep. Example: >
4703 :set path=/home/user_x/src/**
4704< means search in the whole subtree under "/home/usr_x/src".
4705 3) If the path ends with a ';', this path is the startpoint
4706 for upward search.
4707 See |file-searching| for more info and exact syntax.
4708 {not available when compiled without the |+path_extra| feature}
4709 - Careful with '\' characters, type two to get one in the option: >
4710 :set path=.,c:\\include
4711< Or just use '/' instead: >
4712 :set path=.,c:/include
4713< Don't forget "." or files won't even be found in the same directory as
4714 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004715 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716 it is something like 256 or 1024 characters.
4717 You can check if all the include files are found, using the value of
4718 'path', see |:checkpath|.
4719 The use of |:set+=| and |:set-=| is preferred when adding or removing
4720 directories from the list. This avoids problems when a future version
4721 uses another default. To remove the current directory use: >
4722 :set path-=
4723< To add the current directory use: >
4724 :set path+=
4725< To use an environment variable, you probably need to replace the
4726 separator. Here is an example to append $INCL, in which directory
4727 names are separated with a semi-colon: >
4728 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4729< Replace the ';' with a ':' or whatever separator is used. Note that
4730 this doesn't work when $INCL contains a comma or white space.
4731
4732 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4733'preserveindent' 'pi' boolean (default off)
4734 local to buffer
4735 {not in Vi}
4736 When changing the indent of the current line, preserve as much of the
4737 indent structure as possible. Normally the indent is replaced by a
4738 series of tabs followed by spaces as required (unless |'expandtab'| is
4739 enabled, in which case only spaces are used). Enabling this option
4740 means the indent will preserve as many existing characters as possible
4741 for indenting, and only add additional tabs or spaces as required.
4742 NOTE: When using ">>" multiple times the resulting indent is a mix of
4743 tabs and spaces. You might not like this.
4744 NOTE: 'preserveindent' is reset when 'compatible' is set.
4745 Also see 'copyindent'.
4746 Use |:retab| to clean up white space.
4747
4748 *'previewheight'* *'pvh'*
4749'previewheight' 'pvh' number (default 12)
4750 global
4751 {not in Vi}
4752 {not available when compiled without the |+windows| or
4753 |+quickfix| feature}
4754 Default height for a preview window. Used for |:ptag| and associated
4755 commands. Used for |CTRL-W_}| when no count is given.
4756
4757 *'previewwindow'* *'nopreviewwindow'*
4758 *'pvw'* *'nopvw'* *E590*
4759'previewwindow' 'pvw' boolean (default off)
4760 local to window
4761 {not in Vi}
4762 {not available when compiled without the |+windows| or
4763 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004764 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004765 set. It's normally not set directly, but by using one of the commands
4766 |:ptag|, |:pedit|, etc.
4767
4768 *'printdevice'* *'pdev'*
4769'printdevice' 'pdev' string (default empty)
4770 global
4771 {not in Vi}
4772 {only available when compiled with the |+printer|
4773 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004774 The name of the printer to be used for |:hardcopy|.
4775 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004776 This option cannot be set from a |modeline| or in the |sandbox|, for
4777 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778
Bram Moolenaar8299df92004-07-10 09:47:34 +00004779 *'printencoding'* *'penc'*
4780'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781 global
4782 {not in Vi}
4783 {only available when compiled with the |+printer|
4784 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004785 Sets the character encoding used when printing.
4786 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787
4788 *'printexpr'* *'pexpr'*
4789'printexpr' 'pexpr' String (default: see below)
4790 global
4791 {not in Vi}
4792 {only available when compiled with the |+printer|
4793 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004794 Expression used to print the PostScript produced with |:hardcopy|.
4795 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
Bram Moolenaar8299df92004-07-10 09:47:34 +00004797 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798'printfont' 'pfn' string (default "courier")
4799 global
4800 {not in Vi}
4801 {only available when compiled with the |+printer|
4802 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004803 The name of the font that will be used for |:hardcopy|.
4804 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
4806 *'printheader'* *'pheader'*
4807'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4808 global
4809 {not in Vi}
4810 {only available when compiled with the |+printer|
4811 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004812 The format of the header produced in |:hardcopy| output.
4813 See |pheader-option|.
4814
4815 *'printmbcharset'* *'pmbcs'*
4816'printmbcharset' 'pmbcs' string (default "")
4817 global
4818 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004819 {only available when compiled with the |+printer|,
4820 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004821 The CJK character set to be used for CJK output from |:hardcopy|.
4822 See |pmbcs-option|.
4823
4824 *'printmbfont'* *'pmbfn'*
4825'printmbfont' 'pmbfn' string (default "")
4826 global
4827 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004828 {only available when compiled with the |+printer|,
4829 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004830 List of font names to be used for CJK output from |:hardcopy|.
4831 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832
4833 *'printoptions'* *'popt'*
4834'printoptions' 'popt' string (default "")
4835 global
4836 {not in Vi}
4837 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004838 List of items that control the format of the output of |:hardcopy|.
4839 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004841 *'prompt'* *'noprompt'*
4842'prompt' boolean (default on)
4843 global
4844 When on a ":" prompt is used in Ex mode.
4845
Bram Moolenaar677ee682005-01-27 14:41:15 +00004846 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004847'quoteescape' 'qe' string (default "\")
4848 local to buffer
4849 {not in Vi}
4850 The characters that are used to escape quotes in a string. Used for
4851 objects like a', a" and a` |a'|.
4852 When one of the characters in this option is found inside a string,
4853 the following character will be skipped. The default value makes the
4854 text "foo\"bar\\" considered to be one string.
4855
Bram Moolenaar071d4272004-06-13 20:20:40 +00004856 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4857'readonly' 'ro' boolean (default off)
4858 local to buffer
4859 If on, writes fail unless you use a '!'. Protects you from
4860 accidentally overwriting a file. Default on when Vim is started
4861 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004862 When using ":w!" the 'readonly' option is reset for the current
4863 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004865 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866
4867 *'remap'* *'noremap'*
4868'remap' boolean (default on)
4869 global
4870 Allows for mappings to work recursively. If you do not want this for
4871 a single entry, use the :noremap[!] command.
4872
4873 *'report'*
4874'report' number (default 2)
4875 global
4876 Threshold for reporting number of lines changed. When the number of
4877 changed lines is more than 'report' a message will be given for most
4878 ":" commands. If you want it always, set 'report' to 0.
4879 For the ":substitute" command the number of substitutions is used
4880 instead of the number of lines.
4881
4882 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4883'restorescreen' 'rs' boolean (default on)
4884 global
4885 {not in Vi} {only in Windows 95/NT console version}
4886 When set, the screen contents is restored when exiting Vim. This also
4887 happens when executing external commands.
4888
4889 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4890 options in your .vimrc. To disable restoring:
4891 set t_ti= t_te=
4892 To enable restoring (for an xterm):
4893 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4894 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4895
4896 *'revins'* *'ri'* *'norevins'* *'nori'*
4897'revins' 'ri' boolean (default off)
4898 global
4899 {not in Vi}
4900 {only available when compiled with the |+rightleft|
4901 feature}
4902 Inserting characters in Insert mode will work backwards. See "typing
4903 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4904 command in Insert mode, when 'allowrevins' is set.
4905 NOTE: This option is reset when 'compatible' or 'paste' is set.
4906
4907 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4908'rightleft' 'rl' boolean (default off)
4909 local to window
4910 {not in Vi}
4911 {only available when compiled with the |+rightleft|
4912 feature}
4913 When on, display orientation becomes right-to-left, i.e., characters
4914 that are stored in the file appear from the right to the left.
4915 Using this option, it is possible to edit files for languages that
4916 are written from the right to the left such as Hebrew and Arabic.
4917 This option is per window, so it is possible to edit mixed files
4918 simultaneously, or to view the same file in both ways (this is
4919 useful whenever you have a mixed text file with both right-to-left
4920 and left-to-right strings so that both sets are displayed properly
4921 in different windows). Also see |rileft.txt|.
4922
4923 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4924'rightleftcmd' 'rlc' string (default "search")
4925 local to window
4926 {not in Vi}
4927 {only available when compiled with the |+rightleft|
4928 feature}
4929 Each word in this option enables the command line editing to work in
4930 right-to-left mode for a group of commands:
4931
4932 search "/" and "?" commands
4933
4934 This is useful for languages such as Hebrew, Arabic and Farsi.
4935 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
4936
4937 *'ruler'* *'ru'* *'noruler'* *'noru'*
4938'ruler' 'ru' boolean (default off)
4939 global
4940 {not in Vi}
4941 {not available when compiled without the
4942 |+cmdline_info| feature}
4943 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004944 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 text in the file is shown on the far right:
4946 Top first line is visible
4947 Bot last line is visible
4948 All first and last line are visible
4949 45% relative position in the file
4950 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004951 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00004953 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 this option takes precedence over 'ruler' and 'rulerformat'
4955 If the number of characters displayed is different from the number of
4956 bytes in the text (e.g., for a TAB or a multi-byte character), both
4957 the text column (byte number) and the screen column are shown,
4958 separated with a dash.
4959 For an empty line "0-1" is shown.
4960 For an empty buffer the line number will also be zero: "0,0-1".
4961 This option is reset when the 'paste' option is set.
4962 If you don't want to see the ruler all the time but want to know where
4963 you are, use "g CTRL-G" |g_CTRL-G|.
4964 NOTE: This option is reset when 'compatible' is set.
4965
4966 *'rulerformat'* *'ruf'*
4967'rulerformat' 'ruf' string (default empty)
4968 global
4969 {not in Vi}
4970 {not available when compiled without the |+statusline|
4971 feature}
4972 When this option is not empty, it determines the content of the ruler
4973 string, as displayed for the 'ruler' option.
4974 The format of this option, is like that of 'statusline'.
4975 The default ruler width is 17 characters. To make the ruler 15
4976 characters wide, put "%15(" at the start and "%)" at the end.
4977 Example: >
4978 :set rulerformat=%15(%c%V\ %p%%%)
4979<
4980 *'runtimepath'* *'rtp'* *vimfiles*
4981'runtimepath' 'rtp' string (default:
4982 Unix: "$HOME/.vim,
4983 $VIM/vimfiles,
4984 $VIMRUNTIME,
4985 $VIM/vimfiles/after,
4986 $HOME/.vim/after"
4987 Amiga: "home:vimfiles,
4988 $VIM/vimfiles,
4989 $VIMRUNTIME,
4990 $VIM/vimfiles/after,
4991 home:vimfiles/after"
4992 PC, OS/2: "$HOME/vimfiles,
4993 $VIM/vimfiles,
4994 $VIMRUNTIME,
4995 $VIM/vimfiles/after,
4996 $HOME/vimfiles/after"
4997 Macintosh: "$VIM:vimfiles,
4998 $VIMRUNTIME,
4999 $VIM:vimfiles:after"
5000 RISC-OS: "Choices:vimfiles,
5001 $VIMRUNTIME,
5002 Choices:vimfiles/after"
5003 VMS: "sys$login:vimfiles,
5004 $VIM/vimfiles,
5005 $VIMRUNTIME,
5006 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005007 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 global
5009 {not in Vi}
5010 This is a list of directories which will be searched for runtime
5011 files:
5012 filetype.vim filetypes by file name |new-filetype|
5013 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005014 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 colors/ color scheme files |:colorscheme|
5016 compiler/ compiler files |:compiler|
5017 doc/ documentation |write-local-help|
5018 ftplugin/ filetype plugins |write-filetype-plugin|
5019 indent/ indent scripts |indent-expression|
5020 keymap/ key mapping files |mbyte-keymap|
5021 lang/ menu translations |:menutrans|
5022 menu.vim GUI menus |menu.vim|
5023 plugin/ plugin scripts |write-plugin|
5024 print/ files for printing |postscript-print-encoding|
5025 syntax/ syntax files |mysyntaxfile|
5026 tutor/ files for vimtutor |tutor|
5027
5028 And any other file searched for with the |:runtime| command.
5029
5030 The defaults for most systems are setup to search five locations:
5031 1. In your home directory, for your personal preferences.
5032 2. In a system-wide Vim directory, for preferences from the system
5033 administrator.
5034 3. In $VIMRUNTIME, for files distributed with Vim.
5035 *after-directory*
5036 4. In the "after" directory in the system-wide Vim directory. This is
5037 for the system administrator to overrule or add to the distributed
5038 defaults (rarely needed)
5039 5. In the "after" directory in your home directory. This is for
5040 personal preferences to overrule or add to the distributed defaults
5041 or system-wide settings (rarely needed).
5042
5043 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5044 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005045 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046 wildcards.
5047 See |:runtime|.
5048 Example: >
5049 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5050< This will use the directory "~/vimruntime" first (containing your
5051 personal Vim runtime files), then "/mygroup/vim" (shared between a
5052 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5053 files).
5054 You probably should always include $VIMRUNTIME somewhere, to use the
5055 distributed runtime files. You can put a directory before $VIMRUNTIME
5056 to find files which replace a distributed runtime files. You can put
5057 a directory after $VIMRUNTIME to find files which add to distributed
5058 runtime files.
5059 This option cannot be set from a |modeline| or in the |sandbox|, for
5060 security reasons.
5061
5062 *'scroll'* *'scr'*
5063'scroll' 'scr' number (default: half the window height)
5064 local to window
5065 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5066 set to half the number of lines in the window when the window size
5067 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005068 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005069 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5070 the number of screen lines instead of file lines, makes a difference
5071 when lines wrap}
5072
5073 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5074'scrollbind' 'scb' boolean (default off)
5075 local to window
5076 {not in Vi}
5077 {not available when compiled without the |+scrollbind|
5078 feature}
5079 See also |scroll-binding|. When this option is set, the current
5080 window scrolls as other scrollbind windows (windows that also have
5081 this option set) scroll. This option is useful for viewing the
5082 differences between two versions of a file, see 'diff'.
5083 See |'scrollopt'| for options that determine how this option should be
5084 interpreted.
5085 This option is mostly reset when splitting a window to edit another
5086 file. This means that ":split | edit file" results in two windows
5087 with scroll-binding, but ":split file" does not.
5088
5089 *'scrolljump'* *'sj'*
5090'scrolljump' 'sj' number (default 1)
5091 global
5092 {not in Vi}
5093 Minimal number of lines to scroll when the cursor gets off the
5094 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5095 CTRL-D). Useful if your terminal scrolls very slowly.
5096 NOTE: This option is set to 1 when 'compatible' is set.
5097
5098 *'scrolloff'* *'so'*
5099'scrolloff' 'so' number (default 0)
5100 global
5101 {not in Vi}
5102 Minimal number of screen lines to keep above and below the cursor.
5103 This will make some context visible around where you are working. If
5104 you set it to a very large value (999) the cursor line will always be
5105 in the middle of the window (except at the start or end of the file or
5106 when long lines wrap).
5107 For scrolling horizontally see 'sidescrolloff'.
5108 NOTE: This option is set to 0 when 'compatible' is set.
5109
5110 *'scrollopt'* *'sbo'*
5111'scrollopt' 'sbo' string (default "ver,jump")
5112 global
5113 {not available when compiled without the |+scrollbind|
5114 feature}
5115 {not in Vi}
5116 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005117 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5118 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 The following words are available:
5120 ver Bind vertical scrolling for 'scrollbind' windows
5121 hor Bind horizontal scrolling for 'scrollbind' windows
5122 jump Applies to the offset between two windows for vertical
5123 scrolling. This offset is the difference in the first
5124 displayed line of the bound windows. When moving
5125 around in a window, another 'scrollbind' window may
5126 reach a position before the start or after the end of
5127 the buffer. The offset is not changed though, when
5128 moving back the 'scrollbind' window will try to scroll
5129 to the desired position when possible.
5130 When now making that window the current one, two
5131 things can be done with the relative offset:
5132 1. When "jump" is not included, the relative offset is
5133 adjusted for the scroll position in the new current
5134 window. When going back to the other window, the
5135 the new relative offset will be used.
5136 2. When "jump" is included, the other windows are
5137 scrolled to keep the same relative offset. When
5138 going back to the other window, it still uses the
5139 same relative offset.
5140 Also see |scroll-binding|.
5141
5142 *'sections'* *'sect'*
5143'sections' 'sect' string (default "SHNHH HUnhsh")
5144 global
5145 Specifies the nroff macros that separate sections. These are pairs of
5146 two letters (See |object-motions|). The default makes a section start
5147 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5148
5149 *'secure'* *'nosecure'* *E523*
5150'secure' boolean (default off)
5151 global
5152 {not in Vi}
5153 When on, ":autocmd", shell and write commands are not allowed in
5154 ".vimrc" and ".exrc" in the current directory and map commands are
5155 displayed. Switch it off only if you know that you will not run into
5156 problems, or when the 'exrc' option is off. On Unix this option is
5157 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005158 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 'secure' at the end of your ~/.vimrc then.
5160 This option cannot be set from a |modeline| or in the |sandbox|, for
5161 security reasons.
5162
5163 *'selection'* *'sel'*
5164'selection' 'sel' string (default "inclusive")
5165 global
5166 {not in Vi}
5167 This option defines the behavior of the selection. It is only used
5168 in Visual and Select mode.
5169 Possible values:
5170 value past line inclusive ~
5171 old no yes
5172 inclusive yes yes
5173 exclusive yes no
5174 "past line" means that the cursor is allowed to be positioned one
5175 character past the line.
5176 "inclusive" means that the last character of the selection is included
5177 in an operation. For example, when "x" is used to delete the
5178 selection.
5179 Note that when "exclusive" is used and selecting from the end
5180 backwards, you cannot include the last character of a line, when
5181 starting in Normal mode and 'virtualedit' empty.
5182
5183 The 'selection' option is set by the |:behave| command.
5184
5185 *'selectmode'* *'slm'*
5186'selectmode' 'slm' string (default "")
5187 global
5188 {not in Vi}
5189 This is a comma separated list of words, which specifies when to start
5190 Select mode instead of Visual mode, when a selection is started.
5191 Possible values:
5192 mouse when using the mouse
5193 key when using shifted special keys
5194 cmd when using "v", "V" or CTRL-V
5195 See |Select-mode|.
5196 The 'selectmode' option is set by the |:behave| command.
5197
5198 *'sessionoptions'* *'ssop'*
5199'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5200 help,options,winsize")
5201 global
5202 {not in Vi}
5203 {not available when compiled without the +mksession
5204 feature}
5205 Changes the effect of the |:mksession| command. It is a comma
5206 separated list of words. Each word enables saving and restoring
5207 something:
5208 word save and restore ~
5209 blank empty windows
5210 buffers hidden and unloaded buffers, not just those in windows
5211 curdir the current directory
5212 folds manually created folds, opened/closed folds and local
5213 fold options
5214 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005215 and contain at least one lowercase letter. Only
5216 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 help the help window
5218 localoptions options and mappings local to a window or buffer (not
5219 global values for local options)
5220 options all options and mappings (also global values for local
5221 options)
5222 resize size of the Vim window: 'lines' and 'columns'
5223 sesdir the directory in which the session file is located
5224 will become the current directory (useful with
5225 projects accessed over a network from different
5226 systems)
5227 slash backslashes in file names replaced with forward
5228 slashes
5229 unix with Unix end-of-line format (single <NL>), even when
5230 on Windows or DOS
5231 winpos position of the whole Vim window
5232 winsize window sizes
5233
5234 Don't include both "curdir" and "sesdir".
5235 When "curdir" nor "sesdir" is included, file names are stored with
5236 absolute paths.
5237 "slash" and "unix" are useful on Windows when sharing session files
5238 with Unix. The Unix version of Vim cannot source dos format scripts,
5239 but the Windows version of Vim can source unix format scripts.
5240
5241 *'shell'* *'sh'* *E91*
5242'shell' 'sh' string (default $SHELL or "sh",
5243 MS-DOS and Win32: "command.com" or
5244 "cmd.exe", OS/2: "cmd")
5245 global
5246 Name of the shell to use for ! and :! commands. When changing the
5247 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5248 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005249 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005250 See |option-backslash| about including spaces and backslashes.
5251 Environment variables are expanded |:set_env|.
5252 If the name of the shell contains a space, you might need to enclose
5253 it in quotes. Example: >
5254 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5255< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005256 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 "-f" is not inside the quotes, because it is not part of the command
5258 name. And Vim automagically recognizes the backslashes that are path
5259 separators.
5260 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5261 variable to change the way external commands are executed. See the
5262 libc.inf file of DJGPP.
5263 Under MS-Windows, when the executable ends in ".com" it must be
5264 included. Thus setting the shell to "command.com" or "4dos.com"
5265 works, but "command" and "4dos" do not work for all commands (e.g.,
5266 filtering).
5267 For unknown reasons, when using "4dos.com" the current directory is
5268 changed to "C:\". To avoid this set 'shell' like this: >
5269 :set shell=command.com\ /c\ 4dos
5270< This option cannot be set from a |modeline| or in the |sandbox|, for
5271 security reasons.
5272
5273 *'shellcmdflag'* *'shcf'*
5274'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5275 does not contain "sh" somewhere: "/c")
5276 global
5277 {not in Vi}
5278 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5279 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5280 systems, the default is set according to the value of 'shell', to
5281 reduce the need to set this option by the user. It's not used for
5282 OS/2 (EMX figures this out itself). See |option-backslash| about
5283 including spaces and backslashes. See |dos-shell|.
5284 This option cannot be set from a |modeline| or in the |sandbox|, for
5285 security reasons.
5286
5287 *'shellpipe'* *'sp'*
5288'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5289 global
5290 {not in Vi}
5291 {not available when compiled without the |+quickfix|
5292 feature}
5293 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005294 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 including spaces and backslashes.
5296 The name of the temporary file can be represented by "%s" if necessary
5297 (the file name is appended automatically if no %s appears in the value
5298 of this option).
5299 For the Amiga and MS-DOS the default is ">". The output is directly
5300 saved in a file and not echoed to the screen.
5301 For Unix the default it "| tee". The stdout of the compiler is saved
5302 in a file and echoed to the screen. If the 'shell' option is "csh" or
5303 "tcsh" after initializations, the default becomes "|& tee". If the
5304 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5305 "2>&1| tee". This means that stderr is also included.
5306 The initialization of this option is done after reading the ".vimrc"
5307 and the other initializations, so that when the 'shell' option is set
5308 there, the 'shellpipe' option changes automatically, unless it was
5309 explicitly set before.
5310 When 'shellpipe' is set to an empty string, no redirection of the
5311 ":make" output will be done. This is useful if you use a 'makeprg'
5312 that writes to 'makeef' by itself. If you want no piping, but do
5313 want to include the 'makeef', set 'shellpipe' to a single space.
5314 Don't forget to precede the space with a backslash: ":set sp=\ ".
5315 In the future pipes may be used for filtering and this option will
5316 become obsolete (at least for Unix).
5317 This option cannot be set from a |modeline| or in the |sandbox|, for
5318 security reasons.
5319
5320 *'shellquote'* *'shq'*
5321'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5322 contains "sh" somewhere: "\"")
5323 global
5324 {not in Vi}
5325 Quoting character(s), put around the command passed to the shell, for
5326 the "!" and ":!" commands. The redirection is kept outside of the
5327 quoting. See 'shellxquote' to include the redirection. It's
5328 probably not useful to set both options.
5329 This is an empty string by default. Only known to be useful for
5330 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5331 or bash, where it should be "\"". The default is adjusted according
5332 the value of 'shell', to reduce the need to set this option by the
5333 user. See |dos-shell|.
5334 This option cannot be set from a |modeline| or in the |sandbox|, for
5335 security reasons.
5336
5337 *'shellredir'* *'srr'*
5338'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5339 global
5340 {not in Vi}
5341 String to be used to put the output of a filter command in a temporary
5342 file. See also |:!|. See |option-backslash| about including spaces
5343 and backslashes.
5344 The name of the temporary file can be represented by "%s" if necessary
5345 (the file name is appended automatically if no %s appears in the value
5346 of this option).
5347 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5348 or "zsh" during initializations, the default becomes ">&". If the
5349 'shell' option is "sh", "ksh" or "bash" the default becomes
5350 ">%s 2>&1". This means that stderr is also included.
5351 For Win32, the Unix checks are done and additionally "cmd" is checked
5352 for, which makes the default ">%s 2>&1". Also, the same names with
5353 ".exe" appended are checked for.
5354 The initialization of this option is done after reading the ".vimrc"
5355 and the other initializations, so that when the 'shell' option is set
5356 there, the 'shellredir' option changes automatically unless it was
5357 explicitly set before.
5358 In the future pipes may be used for filtering and this option will
5359 become obsolete (at least for Unix).
5360 This option cannot be set from a |modeline| or in the |sandbox|, for
5361 security reasons.
5362
5363 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5364'shellslash' 'ssl' boolean (default off)
5365 global
5366 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5367 When set, a forward slash is used when expanding file names. This is
5368 useful when a Unix-like shell is used instead of command.com or
5369 cmd.exe. Backward slashes can still be typed, but they are changed to
5370 forward slashes by Vim.
5371 Note that setting or resetting this option has no effect for some
5372 existing file names, thus this option needs to be set before opening
5373 any file for best results. This might change in the future.
5374 'shellslash' only works when a backslash can be used as a path
5375 separator. To test if this is so use: >
5376 if exists('+shellslash')
5377<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005378 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5379'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5380 global
5381 {not in Vi}
5382 When on, use temp files for shell commands. When off use a pipe.
5383 When using a pipe is not possible temp files are used anyway.
5384 Currently a pipe is only supported on Unix. You can check it with: >
5385 :if has("filterpipe")
5386< The advantage of using a pipe is that nobody can read the temp file
5387 and the 'shell' command does not need to support redirection.
5388 The advantage of using a temp file is that the file type and encoding
5389 can be detected.
5390 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5391 |FilterWritePost| autocommands event are not triggered when
5392 'shelltemp' is off.
5393
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 *'shelltype'* *'st'*
5395'shelltype' 'st' number (default 0)
5396 global
5397 {not in Vi} {only for the Amiga}
5398 On the Amiga this option influences the way how the commands work
5399 which use a shell.
5400 0 and 1: always use the shell
5401 2 and 3: use the shell only to filter lines
5402 4 and 5: use shell only for ':sh' command
5403 When not using the shell, the command is executed directly.
5404
5405 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5406 1 and 3: use "shell cmd" to start external commands
5407
5408 *'shellxquote'* *'sxq'*
5409'shellxquote' 'sxq' string (default: "";
5410 for Win32, when 'shell' contains "sh"
5411 somewhere: "\""
5412 for Unix, when using system(): "\"")
5413 global
5414 {not in Vi}
5415 Quoting character(s), put around the command passed to the shell, for
5416 the "!" and ":!" commands. Includes the redirection. See
5417 'shellquote' to exclude the redirection. It's probably not useful
5418 to set both options.
5419 This is an empty string by default. Known to be useful for
5420 third-party shells when using the Win32 version, such as the MKS Korn
5421 Shell or bash, where it should be "\"". The default is adjusted
5422 according the value of 'shell', to reduce the need to set this option
5423 by the user. See |dos-shell|.
5424 This option cannot be set from a |modeline| or in the |sandbox|, for
5425 security reasons.
5426
5427 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5428'shiftround' 'sr' boolean (default off)
5429 global
5430 {not in Vi}
5431 Round indent to multiple of 'shiftwidth'. Applies to > and <
5432 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5433 a multiple of 'shiftwidth' (this is Vi compatible).
5434 NOTE: This option is reset when 'compatible' is set.
5435
5436 *'shiftwidth'* *'sw'*
5437'shiftwidth' 'sw' number (default 8)
5438 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005439 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005440 |'cindent'|, |>>|, |<<|, etc.
5441
5442 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005443'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5444 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 global
5446 {not in Vi}
5447 This option helps to avoid all the |hit-enter| prompts caused by file
5448 messages, for example with CTRL-G, and to avoid some other messages.
5449 It is a list of flags:
5450 flag meaning when present ~
5451 f use "(3 of 5)" instead of "(file 3 of 5)"
5452 i use "[noeol]" instead of "[Incomplete last line]"
5453 l use "999L, 888C" instead of "999 lines, 888 characters"
5454 m use "[+]" instead of "[Modified]"
5455 n use "[New]" instead of "[New File]"
5456 r use "[RO]" instead of "[readonly]"
5457 w use "[w]" instead of "written" for file write message
5458 and "[a]" instead of "appended" for ':w >> file' command
5459 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5460 "[unix format]" and "[mac]" instead of "[mac format]".
5461 a all of the above abbreviations
5462
5463 o overwrite message for writing a file with subsequent message
5464 for reading a file (useful for ":wn" or when 'autowrite' on)
5465 O message for reading a file overwrites any previous message.
5466 Also for quickfix message (e.g., ":cn").
5467 s don't give "search hit BOTTOM, continuing at TOP" or "search
5468 hit TOP, continuing at BOTTOM" messages
5469 t truncate file message at the start if it is too long to fit
5470 on the command-line, "<" will appear in the left most column.
5471 Ignored in Ex mode.
5472 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005473 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 Ignored in Ex mode.
5475 W don't give "written" or "[w]" when writing a file
5476 A don't give the "ATTENTION" message when an existing swap file
5477 is found.
5478 I don't give the intro message when starting Vim |:intro|.
5479
5480 This gives you the opportunity to avoid that a change between buffers
5481 requires you to hit <Enter>, but still gives as useful a message as
5482 possible for the space available. To get the whole message that you
5483 would have got with 'shm' empty, use ":file!"
5484 Useful values:
5485 shm= No abbreviation of message.
5486 shm=a Abbreviation, but no loss of information.
5487 shm=at Abbreviation, and truncate message when necessary.
5488
5489 NOTE: This option is set to the Vi default value when 'compatible' is
5490 set and to the Vim default value when 'compatible' is reset.
5491
5492 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5493'shortname' 'sn' boolean (default off)
5494 local to buffer
5495 {not in Vi, not in MS-DOS versions}
5496 Filenames are assumed to be 8 characters plus one extension of 3
5497 characters. Multiple dots in file names are not allowed. When this
5498 option is on, dots in file names are replaced with underscores when
5499 adding an extension (".~" or ".swp"). This option is not available
5500 for MS-DOS, because then it would always be on. This option is useful
5501 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5502 or crossdos. When running the Win32 GUI version under Win32s, this
5503 option is always on by default.
5504
5505 *'showbreak'* *'sbr'* *E595*
5506'showbreak' 'sbr' string (default "")
5507 global
5508 {not in Vi}
5509 {not available when compiled without the |+linebreak|
5510 feature}
5511 String to put at the start of lines that have been wrapped. Useful
5512 values are "> " or "+++ ".
5513 Only printable single-cell characters are allowed, excluding <Tab> and
5514 comma (in a future version the comma might be used to separate the
5515 part that is shown at the end and at the start of a line).
5516 The characters are highlighted according to the '@' flag in
5517 'highlight'.
5518 Note that tabs after the showbreak will be displayed differently.
5519 If you want the 'showbreak' to appear in between line numbers, add the
5520 "n" flag to 'cpoptions'.
5521
5522 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5523'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5524 off)
5525 global
5526 {not in Vi}
5527 {not available when compiled without the
5528 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005529 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 terminal is slow.
5531 In Visual mode the size of the selected area is shown:
5532 - When selecting characters within a line, the number of characters.
5533 - When selecting more than one line, the number of lines.
5534 - When selecting a block, the size in screen characters: linesxcolumns.
5535 NOTE: This option is set to the Vi default value when 'compatible' is
5536 set and to the Vim default value when 'compatible' is reset.
5537
5538 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5539'showfulltag' 'sft' boolean (default off)
5540 global
5541 {not in Vi}
5542 When completing a word in insert mode (see |ins-completion|) from the
5543 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005544 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545 matched a C function, you can see a template for what arguments are
5546 required (coding style permitting).
5547
5548 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5549'showmatch' 'sm' boolean (default off)
5550 global
5551 When a bracket is inserted, briefly jump to the matching one. The
5552 jump is only done if the match can be seen on the screen. The time to
5553 show the match can be set with 'matchtime'.
5554 A Beep is given if there is no match (no matter if the match can be
5555 seen or not). This option is reset when the 'paste' option is set.
5556 When the 'm' flag is not included in 'cpoptions', typing a character
5557 will immediately move the cursor back to where it belongs.
5558 See the "sm" field in 'guicursor' for setting the cursor shape and
5559 blinking when showing the match.
5560 The 'matchpairs' option can be used to specify the characters to show
5561 matches for. 'rightleft' and 'revins' are used to look for opposite
5562 matches.
5563 Note: For the use of the short form parental guidance is advised.
5564
5565 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5566'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5567 global
5568 If in Insert, Replace or Visual mode put a message on the last line.
5569 Use the 'M' flag in 'highlight' to set the type of highlighting for
5570 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005571 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 doesn't mean XIM is really active, especially when 'imactivatekey' is
5573 not set.
5574 NOTE: This option is set to the Vi default value when 'compatible' is
5575 set and to the Vim default value when 'compatible' is reset.
5576
5577 *'sidescroll'* *'ss'*
5578'sidescroll' 'ss' number (default 0)
5579 global
5580 {not in Vi}
5581 The minimal number of columns to scroll horizontally. Used only when
5582 the 'wrap' option is off and the cursor is moved off of the screen.
5583 When it is zero the cursor will be put in the middle of the screen.
5584 When using a slow terminal set it to a large number or 0. When using
5585 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5586 commands.
5587
5588 *'sidescrolloff'* *'siso'*
5589'sidescrolloff' 'siso' number (default 0)
5590 global
5591 {not in Vi}
5592 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005593 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 greater than 0 while having |'sidescroll'| also at a non-zero value
5595 makes some context visible in the line you are scrolling in
5596 horizontally (except at the end and beginning of the line). Setting
5597 this option to a large value (like 999) has the effect of keeping the
5598 cursor horizontally centered in the window, as long as one does not
5599 come too close to the beginning or end of the line.
5600 NOTE: This option is set to 0 when 'compatible' is set.
5601
5602 Example: Try this together with 'sidescroll' and 'listchars' as
5603 in the following example to never allow the cursor to move
5604 onto the "extends" character:
5605
5606 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5607 :set sidescrolloff=1
5608
5609
5610 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5611'smartcase' 'scs' boolean (default off)
5612 global
5613 {not in Vi}
5614 Override the 'ignorecase' option if the search pattern contains upper
5615 case characters. Only used when the search pattern is typed and
5616 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005617 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5619 recalling the search pattern from history and hitting <Enter>.
5620 NOTE: This option is reset when 'compatible' is set.
5621
5622 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5623'smartindent' 'si' boolean (default off)
5624 local to buffer
5625 {not in Vi}
5626 {not available when compiled without the
5627 |+smartindent| feature}
5628 Do smart autoindenting when starting a new line. Works for C-like
5629 programs, but can also be used for other languages. 'cindent' does
5630 something like this, works better in most cases, but is more strict,
5631 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5632 'indentexpr' is a more advanced alternative.
5633 Normally 'autoindent' should also be on when using 'smartindent'.
5634 An indent is automatically inserted:
5635 - After a line ending in '{'.
5636 - After a line starting with a keyword from 'cinwords'.
5637 - Before a line starting with '}' (only with the "O" command).
5638 When typing '}' as the first character in a new line, that line is
5639 given the same indent as the matching '{'.
5640 When typing '#' as the first character in a new line, the indent for
5641 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005642 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5644 When using the ">>" command, lines starting with '#' are not shifted
5645 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005646 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 is set smart indenting is disabled.
5648
5649 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5650'smarttab' 'sta' boolean (default off)
5651 global
5652 {not in Vi}
5653 When on, a <Tab> in front of a line inserts blanks according to
5654 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5655 a 'shiftwidth' worth of space at the start of the line.
5656 When off a <Tab> always inserts blanks according to 'tabstop'.
5657 'shiftwidth' is only used for shifting text left or right
5658 |shift-left-right|.
5659 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5660 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005661 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005662 NOTE: This option is reset when 'compatible' is set.
5663
5664 *'softtabstop'* *'sts'*
5665'softtabstop' 'sts' number (default 0)
5666 local to buffer
5667 {not in Vi}
5668 Number of spaces that a <Tab> counts for while performing editing
5669 operations, like inserting a <Tab> or using <BS>. It "feels" like
5670 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5671 used. This is useful to keep the 'ts' setting at its standard value
5672 of 8, while being able to edit like it is set to 'sts'. However,
5673 commands like "x" still work on the actual characters.
5674 When 'sts' is zero, this feature is off.
5675 'softtabstop' is set to 0 when the 'paste' option is set.
5676 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5677 spaces is minimized by using <Tab>s.
5678 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5679 set.
5680 NOTE: This option is set to 0 when 'compatible' is set.
5681
Bram Moolenaar217ad922005-03-20 22:37:15 +00005682 *'spell'* *'nospell'*
5683'spell' boolean (default off)
5684 local to window
5685 {not in Vi}
5686 {not available when compiled without the |+syntax|
5687 feature}
5688 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005689 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005690
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005691 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005692'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005693 local to buffer
5694 {not in Vi}
5695 {not available when compiled without the |+syntax|
5696 feature}
5697 Pattern to locate the end of a sentence. The following word will be
5698 checked to start with a capital letter. If not then it is highlighted
5699 with SpellCap |hl-SpellCap|.
5700 When this check is not wanted make this option empty.
5701 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005702 Be careful with special characters, see |option-backslash| about
5703 including spaces and backslashes.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005704
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005705 *'spellfile'* *'spf'*
5706'spellfile' 'spf' string (default empty)
5707 local to buffer
5708 {not in Vi}
5709 {not available when compiled without the |+syntax|
5710 feature}
5711 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005712 commands. It must end in ".{encoding}.add". You need to include the
5713 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005714 *E765*
5715 It may also be a comma separated list of names. A count before the
5716 |zg| and |zw| commands can be used to access each. This allows using
5717 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005718 When a word is added while this option is empty Vim will set it for
5719 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005720 writable and the first language name that appears in 'spelllang',
5721 ignoring the region.
5722 The resulting ".spl" file will be used for spell checking, it does not
5723 have to appear in 'spelllang'.
5724 Normally one file is used for all regions, but you can add the region
5725 name if you want to. However, it will then only be used when
5726 'spellfile' is set to it, for entries in 'spelllang' only files
5727 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005728 This option cannot be set from a |modeline| or in the |sandbox|, for
5729 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005730
Bram Moolenaar217ad922005-03-20 22:37:15 +00005731 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005732'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005733 local to buffer
5734 {not in Vi}
5735 {not available when compiled without the |+syntax|
5736 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005737 A comma separated list of word list names. When the 'spell' option is
5738 on spellchecking will be done for these languages. Example: >
5739 set spelllang=en_us,nl,medical
5740< This means US English, Dutch and medical words are recognized. Words
5741 that are not recognized will be highlighted.
5742 The word list name must not include a comma or dot. Using a dash is
5743 recommended to separate the two letter language name from a
5744 specification. Thus "en-rare" is used for rare English words.
5745 A region name must come last and have the form "_xx", where "xx" is
5746 the two-letter, lower case region name. You can use more than one
5747 region by listing them: "en_us,en_ca" supports both US and Canadian
5748 English, but not words specific for Australia, New Zealand or Great
5749 Britain.
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005750 As a special case the name of a .spl file can be given as-is. The
5751 first "_xx" in the name is removed and used as the region name
5752 (_xx is an underscore, two letters and followed by a non-letter).
5753 This is mainly for testing purposes. You must make sure the correct
5754 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005755 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005756 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5757 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005758 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005759
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005760 *'spellsuggest'* *'sps'*
5761'spellsuggest' 'sps' string (default "best")
5762 global
5763 {not in Vi}
5764 {not available when compiled without the |+syntax|
5765 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005766 Methods used for spelling suggestions. Both for the |z?| command and
5767 the |spellsuggest()| function. This is a comma-separated list of
5768 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005769
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005770 best Internal method that works best for English. Finds
5771 changes like "fast" and uses a bit of sound-a-like
5772 scoring to improve the ordering.
5773
5774 double Internal method that uses two methods and mixes the
5775 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005776 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005777 word. That only works when the language specifies
5778 sound folding. Can be slow and doesn't always give
5779 better results.
5780
5781 fast Internal method that only checks for simple changes:
5782 character inserts/deletes/swaps. Works well for
5783 simple typing mistakes.
5784
5785 file:{filename} Read file {filename}, which must have two columns,
5786 separated by a slash. The first column contains the
5787 bad word, the second column the suggested good word.
5788 Example:
5789 theribal/terrible ~
5790 Use this for common mistakes that do not appear at the
5791 top of the suggestion list with the internal methods.
5792 Lines without a slash are ignored, use this for
5793 comments.
5794 The file is used for all languages.
5795
5796 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5797 trouble with spaces. |v:val| holds the badly spelled
5798 word. The expression must evaluate to a List of
5799 Lists, each with a suggestion and a score.
5800 Example:
5801 [['the', 33], ['that', 44]]
5802 Set 'verbose' and use |z?| to see the scores that the
5803 internal methods use. A lower score is better.
5804 This may invoke |spellsuggest()| if you temporarily
5805 set 'spellsuggest' to exclude the "expr:" part.
5806 Errors are silently ignored, unless you set the
5807 'verbose' option to a non-zero value.
5808
5809 Only one of "best", "double" or "fast" may be used. The others may
5810 appear several times in any order. Example: >
5811 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5812<
5813 This option cannot be set from a |modeline| or in the |sandbox|, for
5814 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005815
5816
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5818'splitbelow' 'sb' boolean (default off)
5819 global
5820 {not in Vi}
5821 {not available when compiled without the +windows
5822 feature}
5823 When on, splitting a window will put the new window below the current
5824 one. |:split|
5825
5826 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5827'splitright' 'spr' boolean (default off)
5828 global
5829 {not in Vi}
5830 {not available when compiled without the +vertsplit
5831 feature}
5832 When on, splitting a window will put the new window right of the
5833 current one. |:vsplit|
5834
5835 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5836'startofline' 'sol' boolean (default on)
5837 global
5838 {not in Vi}
5839 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005840 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005841 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005842 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005843 with a linewise operator, with "%" with a count and to buffer changing
5844 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5845 only has a line number, e.g., ":25" or ":+".
5846 In case of buffer changing commands the cursor is placed at the column
5847 where it was the last time the buffer was edited.
5848 NOTE: This option is set when 'compatible' is set.
5849
5850 *'statusline'* *'stl'* *E540* *E541* *E542*
5851'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005852 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005853 {not in Vi}
5854 {not available when compiled without the |+statusline|
5855 feature}
5856 When nonempty, this option determines the content of the status line.
5857 Also see |status-line|.
5858
5859 The option consists of printf style '%' items interspersed with
5860 normal text. Each status line item is of the form:
5861 %-0{minwid}.{maxwid}{item}
5862 All fields except the {item} is optional. A single percent sign can
5863 be given as "%%". Up to 80 items can be specified.
5864
5865 Note that the only effect of 'ruler' when this option is set (and
5866 'laststatus' is 2) is controlling the output of |CTRL-G|.
5867
5868 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005869 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005870 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005871 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005872 minwid Minimum width of the item, padding as set by '-' & '0'.
5873 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005874 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005875 on the left for text items. Numeric items will be
5876 shifted down to maxwid-2 digits followed by '>'number
5877 where number is the amount of missing digits, much like
5878 an exponential notation.
5879 item A one letter code as described below.
5880
5881 Following is a description of the possible statusline items. The
5882 second character in "item" is the type:
5883 N for number
5884 S for string
5885 F for flags as described below
5886 - not applicable
5887
5888 item meaning ~
5889 f S Path to the file in the buffer, relative to current directory.
5890 F S Full path to the file in the buffer.
5891 t S File name (tail) of file in the buffer.
5892 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5893 M F Modified flag, text is ",+" or ",-".
5894 r F Readonly flag, text is " [RO]".
5895 R F Readonly flag, text is ",RO".
5896 h F Help buffer flag, text is " [help]".
5897 H F Help buffer flag, text is ",HLP".
5898 w F Preview window flag, text is " [Preview]".
5899 W F Preview window flag, text is ",PRV".
5900 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5901 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5902 {not available when compiled without |+autocmd| feature}
5903 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5904 being used: "<keymap>"
5905 n N Buffer number.
5906 b N Value of byte under cursor.
5907 B N As above, in hexadecimal.
5908 o N Byte number in file of byte under cursor, first byte is 1.
5909 Mnemonic: Offset from start of file (with one added)
5910 {not available when compiled without |+byte_offset| feature}
5911 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005912 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005913 l N Line number.
5914 L N Number of lines in buffer.
5915 c N Column number.
5916 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005917 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005918 p N Percentage through file in lines as in |CTRL-G|.
5919 P S Percentage through file of displayed window. This is like the
5920 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005921 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 Empty if the argument file count is zero or one.
5923 { NF Evaluate expression between '{' and '}' and substitute result.
5924 ( - Start of item group. Can be used for setting the width and
5925 alignment of a section. Must be followed by %) somewhere.
5926 ) - End of item group. No width fields allowed.
5927 < - Where to truncate line if too long. Default is at the start.
5928 No width fields allowed.
5929 = - Separation point between left and right aligned items.
5930 No width fields allowed.
5931 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005932 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 The difference between User{N} and StatusLine will be applied
5934 to StatusLineNC for the statusline of non-current windows.
5935 The number N must be between 1 and 9. See |hl-User1..9|
5936
5937 Display of flags are controlled by the following heuristic:
5938 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005939 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00005940 with a space it is assumed that it wants to separate itself from
5941 anything but other flags. That is: A leading comma is removed if the
5942 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00005943 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 make a nice display when flags are used like in the examples below.
5945
Bram Moolenaar582fd852005-03-28 20:58:01 +00005946 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 not set) and a minwid is not set for the group, the whole group will
5948 become empty. This will make a group like the following disappear
5949 completely from the statusline when none of the flags are set. >
5950 :set statusline=...%(\ [%M%R%H]%)...
5951<
5952 Beware that an expression is evaluated each and every time the status
5953 line is displayed. The current buffer and current window will be set
5954 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00005955 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005956 The variable "actual_curbuf" is set to the 'bufnr()' number of the
5957 real current buffer. The expression is evaluated in the |sandbox|.
5958
5959 If the statusline is not updated when you want it (e.g., after setting
5960 a variable that's used in an expression), you can force an update by
5961 setting an option without changing its value. Example: >
5962 :let &ro = &ro
5963
5964< A result of all digits is regarded a number for display purposes.
5965 Otherwise the result is taken as flag text and applied to the rules
5966 described above.
5967
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00005968 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
5970 edit your .vimrc or whatever with "vim -u NONE" to get it right.
5971
5972 Examples:
5973 Emulate standard status line with 'ruler' set >
5974 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
5975< Similar, but add ASCII value of char under the cursor (like "ga") >
5976 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
5977< Display byte count and byte value, modified flag in red. >
5978 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
5979 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
5980< Display a ,GZ flag if a compressed file is loaded >
5981 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
5982< In the |:autocmd|'s: >
5983 :let b:gzflag = 1
5984< And: >
5985 :unlet b:gzflag
5986< And define this function: >
5987 :function VarExists(var, val)
5988 : if exists(a:var) | return a:val | else | return '' | endif
5989 :endfunction
5990<
5991 *'suffixes'* *'su'*
5992'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
5993 global
5994 {not in Vi}
5995 Files with these suffixes get a lower priority when multiple files
5996 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005997 suffixes. Spaces after the comma are ignored. A dot is also seen as
5998 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00005999 separator, precede it with a backslash (see |option-backslash| about
6000 including spaces and backslashes).
6001 See 'wildignore' for completely ignoring files.
6002 The use of |:set+=| and |:set-=| is preferred when adding or removing
6003 suffixes from the list. This avoids problems when a future version
6004 uses another default.
6005
6006 *'suffixesadd'* *'sua'*
6007'suffixesadd' 'sua' string (default "")
6008 local to buffer
6009 {not in Vi}
6010 {not available when compiled without the
6011 |+file_in_path| feature}
6012 Comma separated list of suffixes, which are used when searching for a
6013 file for the "gf", "[I", etc. commands. Example: >
6014 :set suffixesadd=.java
6015<
6016 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6017'swapfile' 'swf' boolean (default on)
6018 local to buffer
6019 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006020 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006021 swapfile is not wanted for a specific buffer. For example, with
6022 confidential information that even root must not be able to access.
6023 Careful: All text will be in memory:
6024 - Don't use this for big files.
6025 - Recovery will be impossible!
6026 A swapfile will only be present when |'updatecount'| is non-zero and
6027 'swapfile' is set.
6028 When 'swapfile' is reset, the swap file for the current buffer is
6029 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6030 non-zero, a swap file is immediately created.
6031 Also see |swap-file| and |'swapsync'|.
6032
6033 This option is used together with 'bufhidden' and 'buftype' to
6034 specify special kinds of buffers. See |special-buffers|.
6035
6036 *'swapsync'* *'sws'*
6037'swapsync' 'sws' string (default "fsync")
6038 global
6039 {not in Vi}
6040 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006041 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006042 When this option is empty parts of the swap file may be in memory and
6043 not written to disk. When the system crashes you may lose more work.
6044 On Unix the system does a sync now and then without Vim asking for it,
6045 so the disadvantage of setting this option off is small. On some
6046 systems the swap file will not be written at all. For a unix system
6047 setting it to "sync" will use the sync() call instead of the default
6048 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006049 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050
6051 *'switchbuf'* *'swb'*
6052'switchbuf' 'swb' string (default "")
6053 global
6054 {not in Vi}
6055 This option controls the behavior when switching between buffers.
6056 Possible values (comma separated list):
6057 useopen If included, jump to the first open window that
6058 contains the specified buffer (if there is one).
6059 Otherwise: Do not examine other windows.
6060 This setting is checked with |quickfix| commands, when
6061 jumping to errors (":cc", ":cn", "cp", etc.). It is
6062 also used in all buffer related split commands, for
6063 example ":sbuffer", ":sbnext", or ":sbrewind".
6064 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006065 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 Supported in |quickfix| commands that display errors.
6067
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006068 *'synmaxcol'* *'smc'*
6069'synmaxcol' 'smc' number (default 3000)
6070 local to buffer
6071 {not in Vi}
6072 {not available when compiled without the |+syntax|
6073 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006074 Maximum column in which to search for syntax items. In long lines the
6075 text after this column is not highlighted and following lines may not
6076 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006077 This helps to avoid very slow redrawing for an XML file that is one
6078 long line.
6079 Set to zero to remove the limit.
6080
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 *'syntax'* *'syn'*
6082'syntax' 'syn' string (default empty)
6083 local to buffer
6084 {not in Vi}
6085 {not available when compiled without the |+syntax|
6086 feature}
6087 When this option is set, the syntax with this name is loaded, unless
6088 syntax highlighting has been switched off with ":syntax off".
6089 Otherwise this option does not always reflect the current syntax (the
6090 b:current_syntax variable does).
6091 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006092 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 /* vim: set syntax=idl : */
6094< To switch off syntax highlighting for the current file, use: >
6095 :set syntax=OFF
6096< To switch syntax highlighting on according to the current value of the
6097 'filetype' option: >
6098 :set syntax=ON
6099< What actually happens when setting the 'syntax' option is that the
6100 Syntax autocommand event is triggered with the value as argument.
6101 This option is not copied to another buffer, independent of the 's' or
6102 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006103 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104
6105 *'tabstop'* *'ts'*
6106'tabstop' 'ts' number (default 8)
6107 local to buffer
6108 Number of spaces that a <Tab> in the file counts for. Also see
6109 |:retab| command, and 'softtabstop' option.
6110
6111 Note: Setting 'tabstop' to any other value than 8 can make your file
6112 appear wrong in many places (e.g., when printing it).
6113
6114 There are four main ways to use tabs in Vim:
6115 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6116 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6117 will use a mix of tabs and spaces, but typing Tab and BS will
6118 behave like a tab appears every 4 (or 3) characters.
6119 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6120 'expandtab'. This way you will always insert spaces. The
6121 formatting will never be messed up when 'tabstop' is changed.
6122 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006123 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006124 works when using Vim to edit the file.
6125 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6126 'noexpandtab'. This should then work (for initial indents only)
6127 for any tabstop setting that people use. It might be nice to have
6128 tabs after the first non-blank inserted as spaces if you do this
6129 though. Otherwise aligned comments will be wrong when 'tabstop' is
6130 changed.
6131
6132 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6133'tagbsearch' 'tbs' boolean (default on)
6134 global
6135 {not in Vi}
6136 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006137 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 searching makes searching for a tag a LOT faster, but a linear search
6139 will find more tags if the tags file wasn't properly sorted.
6140 Vim normally assumes that your tags files are sorted, or indicate that
6141 they are not sorted. Only when this is not the case does the
6142 'tagbsearch' option need to be switched off.
6143
6144 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006145 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 certain files, or retry all files with a linear search. When
6147 'tagbsearch' is off, only a linear search is done.
6148
6149 Linear searching is done anyway, for one file, when Vim finds a line
6150 at the start of the file indicating that it's not sorted: >
6151 !_TAG_FILE_SORTED 0 /some command/
6152< [The whitespace before and after the '0' must be a single <Tab>]
6153
6154 When a binary search was done and no match was found in any of the
6155 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6156 instead of a normal tag name, a retry is done with a linear search.
6157 Tags in unsorted tags files, and matches with different case will only
6158 be found in the retry.
6159
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006160 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 linear search can be avoided for the 'ignorecase' case. Use a value
6162 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6163 case-fold sorted with the -f switch to "sort" in most unices, as in
6164 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6165 5.3 or higher the -f or --fold-case-sort switch can be used for this
6166 as well. Note that case must be folded to uppercase for this to work.
6167
6168 When 'tagbsearch' is off, tags searching is slower when a full match
6169 exists, but faster when no full match exists. Tags in unsorted tags
6170 files may only be found with 'tagbsearch' off.
6171 When the tags file is not sorted, or sorted in a wrong way (not on
6172 ASCII byte value), 'tagbsearch' should be off, or the line given above
6173 must be included in the tags file.
6174 This option doesn't affect commands that find all matching tags (e.g.,
6175 command-line completion and ":help").
6176 {Vi: always uses binary search in some versions}
6177
6178 *'taglength'* *'tl'*
6179'taglength' 'tl' number (default 0)
6180 global
6181 If non-zero, tags are significant up to this number of characters.
6182
6183 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6184'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6185 global
6186 {not in Vi}
6187 If on and using a tag file in another directory, file names in that
6188 tag file are relative to the directory where the tag file is.
6189 NOTE: This option is set to the Vi default value when 'compatible' is
6190 set and to the Vim default value when 'compatible' is reset.
6191
6192 *'tags'* *'tag'* *E433*
6193'tags' 'tag' string (default "./tags,tags", when compiled with
6194 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6195 global or local to buffer |global-local|
6196 Filenames for the tag command, separated by spaces or commas. To
6197 include a space or comma in a file name, precede it with a backslash
6198 (see |option-backslash| about including spaces and backslashes).
6199 When a file name starts with "./", the '.' is replaced with the path
6200 of the current file. But only when the 'd' flag is not included in
6201 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6202 |tags-option|.
6203 "*", "**" and other wildcards can be used to search for tags files in
6204 a directory tree. See |file-searching|. {not available when compiled
6205 without the |+path_extra| feature}
6206 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6207 files are also supported. They are automatically recognized. The
6208 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6209 differences are ignored (MS-Windows). |emacs-tags|
6210 The use of |:set+=| and |:set-=| is preferred when adding or removing
6211 file names from the list. This avoids problems when a future version
6212 uses another default.
6213 {Vi: default is "tags /usr/lib/tags"}
6214
6215 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6216'tagstack' 'tgst' boolean (default on)
6217 global
6218 {not in all versions of Vi}
6219 When on, the |tagstack| is used normally. When off, a ":tag" or
6220 ":tselect" command with an argument will not push the tag onto the
6221 tagstack. A following ":tag" without an argument, a ":pop" command or
6222 any other command that uses the tagstack will use the unmodified
6223 tagstack, but does change the pointer to the active entry.
6224 Resetting this option is useful when using a ":tag" command in a
6225 mapping which should not change the tagstack.
6226
6227 *'term'* *E529* *E530* *E531*
6228'term' string (default is $TERM, if that fails:
6229 in the GUI: "builtin_gui"
6230 on Amiga: "amiga"
6231 on BeOS: "beos-ansi"
6232 on Mac: "mac-ansi"
6233 on MiNT: "vt52"
6234 on MS-DOS: "pcterm"
6235 on OS/2: "os2ansi"
6236 on Unix: "ansi"
6237 on VMS: "ansi"
6238 on Win 32: "win32")
6239 global
6240 Name of the terminal. Used for choosing the terminal control
6241 characters. Environment variables are expanded |:set_env|.
6242 For example: >
6243 :set term=$TERM
6244< See |termcap|.
6245
6246 *'termbidi'* *'tbidi'*
6247 *'notermbidi'* *'notbidi'*
6248'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6249 global
6250 {not in Vi}
6251 {only available when compiled with the |+arabic|
6252 feature}
6253 The terminal is in charge of Bi-directionality of text (as specified
6254 by Unicode). The terminal is also expected to do the required shaping
6255 that some languages (such as Arabic) require.
6256 Setting this option implies that 'rightleft' will not be set when
6257 'arabic' is set and the value of 'arabicshape' will be ignored.
6258 Note that setting 'termbidi' has the immediate effect that
6259 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6260 This option is reset when the GUI is started.
6261 For further details see |arabic.txt|.
6262
6263 *'termencoding'* *'tenc'*
6264'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6265 Macintosh GUI: "macroman")
6266 global
6267 {only available when compiled with the |+multi_byte|
6268 feature}
6269 {not in Vi}
6270 Encoding used for the terminal. This specifies what character
6271 encoding the keyboard produces and the display will understand. For
6272 the GUI it only applies to the keyboard ('encoding' is used for the
6273 display).
6274 In the Win32 console version the default value is the console codepage
6275 when it differs from the ANSI codepage.
6276 *E617*
6277 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6278 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6279 Any attempts to set a different value will be rejected, and an error
6280 message is shown.
6281 For the Win32 GUI 'termencoding' is not used for typed characters,
6282 because the Win32 system always passes Unicode characters.
6283 When empty, the same encoding is used as for the 'encoding' option.
6284 This is the normal value.
6285 Not all combinations for 'termencoding' and 'encoding' are valid. See
6286 |encoding-table|.
6287 The value for this option must be supported by internal conversions or
6288 iconv(). When this is not possible no conversion will be done and you
6289 will probably experience problems with non-ASCII characters.
6290 Example: You are working with the locale set to euc-jp (Japanese) and
6291 want to edit a UTF-8 file: >
6292 :let &termencoding = &encoding
6293 :set encoding=utf-8
6294< You need to do this when your system has no locale support for UTF-8.
6295
6296 *'terse'* *'noterse'*
6297'terse' boolean (default off)
6298 global
6299 When set: Add 's' flag to 'shortmess' option (this makes the message
6300 for a search that hits the start or end of the file not being
6301 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6302 shortens a lot of messages}
6303
6304 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6305'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6306 global
6307 {not in Vi}
6308 This option is obsolete. Use 'fileformats'.
6309 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6310 set to the default value for the current system. When 'textauto' is
6311 reset, 'fileformats' is made empty.
6312 NOTE: This option is set to the Vi default value when 'compatible' is
6313 set and to the Vim default value when 'compatible' is reset.
6314
6315 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6316'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6317 others: default off)
6318 local to buffer
6319 {not in Vi}
6320 This option is obsolete. Use 'fileformat'.
6321 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6322 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6323 "unix".
6324
6325 *'textwidth'* *'tw'*
6326'textwidth' 'tw' number (default 0)
6327 local to buffer
6328 {not in Vi}
6329 Maximum width of text that is being inserted. A longer line will be
6330 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006331 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6332 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 'formatoptions' and |ins-textwidth|.
6334 NOTE: This option is set to 0 when 'compatible' is set.
6335
6336 *'thesaurus'* *'tsr'*
6337'thesaurus' 'tsr' string (default "")
6338 global or local to buffer |global-local|
6339 {not in Vi}
6340 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006341 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 the file should contain words with similar meaning, separated by
6343 non-keyword characters (white space is preferred). Maximum line
6344 length is 510 bytes.
6345 To obtain a file to be used here, check out the wordlist FAQ at
6346 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006347 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 after a comma are ignored, otherwise spaces are included in the file
6349 name. See |option-backslash| about using backslashes.
6350 The use of |:set+=| and |:set-=| is preferred when adding or removing
6351 directories from the list. This avoids problems when a future version
6352 uses another default.
6353 Backticks cannot be used in this option for security reasons.
6354
6355 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6356'tildeop' 'top' boolean (default off)
6357 global
6358 {not in Vi}
6359 When on: The tilde command "~" behaves like an operator.
6360 NOTE: This option is reset when 'compatible' is set.
6361
6362 *'timeout'* *'to'* *'notimeout'* *'noto'*
6363'timeout' 'to' boolean (default on)
6364 global
6365 *'ttimeout'* *'nottimeout'*
6366'ttimeout' boolean (default off)
6367 global
6368 {not in Vi}
6369 These two options together determine the behavior when part of a
6370 mapped key sequence or keyboard code has been received:
6371
6372 'timeout' 'ttimeout' action ~
6373 off off do not time out
6374 on on or off time out on :mappings and key codes
6375 off on time out on key codes
6376
6377 If both options are off, Vim will wait until either the complete
6378 mapping or key sequence has been received, or it is clear that there
6379 is no mapping or key sequence for the received characters. For
6380 example: if you have mapped "vl" and Vim has received 'v', the next
6381 character is needed to see if the 'v' is followed by an 'l'.
6382 When one of the options is on, Vim will wait for about 1 second for
6383 the next character to arrive. After that the already received
6384 characters are interpreted as single characters. The waiting time can
6385 be changed with the 'timeoutlen' option.
6386 On slow terminals or very busy systems timing out may cause
6387 malfunctioning cursor keys. If both options are off, Vim waits
6388 forever after an entered <Esc> if there are key codes that start
6389 with <Esc>. You will have to type <Esc> twice. If you do not have
6390 problems with key codes, but would like to have :mapped key
6391 sequences not timing out in 1 second, set the 'ttimeout' option and
6392 reset the 'timeout' option.
6393
6394 NOTE: 'ttimeout' is reset when 'compatible' is set.
6395
6396 *'timeoutlen'* *'tm'*
6397'timeoutlen' 'tm' number (default 1000)
6398 global
6399 {not in all versions of Vi}
6400 *'ttimeoutlen'* *'ttm'*
6401'ttimeoutlen' 'ttm' number (default -1)
6402 global
6403 {not in Vi}
6404 The time in milliseconds that is waited for a key code or mapped key
6405 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6406 when part of a command has been typed.
6407 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6408 different timeout value for key codes is desired set 'ttimeoutlen' to
6409 a non-negative number.
6410
6411 ttimeoutlen mapping delay key code delay ~
6412 < 0 'timeoutlen' 'timeoutlen'
6413 >= 0 'timeoutlen' 'ttimeoutlen'
6414
6415 The timeout only happens when the 'timeout' and 'ttimeout' options
6416 tell so. A useful setting would be >
6417 :set timeout timeoutlen=3000 ttimeoutlen=100
6418< (time out on mapping after three seconds, time out on key codes after
6419 a tenth of a second).
6420
6421 *'title'* *'notitle'*
6422'title' boolean (default off, on when title can be restored)
6423 global
6424 {not in Vi}
6425 {not available when compiled without the |+title|
6426 feature}
6427 When on, the title of the window will be set to the value of
6428 'titlestring' (if it is not empty), or to:
6429 filename [+=-] (path) - VIM
6430 Where:
6431 filename the name of the file being edited
6432 - indicates the file cannot be modified, 'ma' off
6433 + indicates the file was modified
6434 = indicates the file is read-only
6435 =+ indicates the file is read-only and modified
6436 (path) is the path of the file being edited
6437 - VIM the server name |v:servername| or "VIM"
6438 Only works if the terminal supports setting window titles
6439 (currently Amiga console, Win32 console, all GUI versions and
6440 terminals with a non- empty 't_ts' option - these are Unix xterm and
6441 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6442 *X11*
6443 When Vim was compiled with HAVE_X11 defined, the original title will
6444 be restored if possible. The output of ":version" will include "+X11"
6445 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6446 works for the icon name |'icon'|.
6447 But: When Vim was started with the |-X| argument, restoring the title
6448 will not work (except in the GUI).
6449 If the title cannot be restored, it is set to the value of 'titleold'.
6450 You might want to restore the title outside of Vim then.
6451 When using an xterm from a remote machine you can use this command:
6452 rsh machine_name xterm -display $DISPLAY &
6453 then the WINDOWID environment variable should be inherited and the
6454 title of the window should change back to what it should be after
6455 exiting Vim.
6456
6457 *'titlelen'*
6458'titlelen' number (default 85)
6459 global
6460 {not in Vi}
6461 {not available when compiled without the |+title|
6462 feature}
6463 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006464 title. When the title is longer, only the end of the path name is
6465 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006466 Using a percentage makes this adapt to the width of the window. But
6467 it won't work perfectly, because the actual number of characters
6468 available also depends on the font used and other things in the title
6469 bar. When 'titlelen' is zero the full path is used. Otherwise,
6470 values from 1 to 30000 percent can be used.
6471 'titlelen' is also used for the 'titlestring' option.
6472
6473 *'titleold'*
6474'titleold' string (default "Thanks for flying Vim")
6475 global
6476 {not in Vi}
6477 {only available when compiled with the |+title|
6478 feature}
6479 This option will be used for the window title when exiting Vim if the
6480 original title cannot be restored. Only happens if 'title' is on or
6481 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006482 This option cannot be set from a |modeline| or in the |sandbox|, for
6483 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 *'titlestring'*
6485'titlestring' string (default "")
6486 global
6487 {not in Vi}
6488 {not available when compiled without the |+title|
6489 feature}
6490 When this option is not empty, it will be used for the title of the
6491 window. This happens only when the 'title' option is on.
6492 Only works if the terminal supports setting window titles (currently
6493 Amiga console, Win32 console, all GUI versions and terminals with a
6494 non-empty 't_ts' option).
6495 When Vim was compiled with HAVE_X11 defined, the original title will
6496 be restored if possible |X11|.
6497 When this option contains printf-style '%' items, they will be
6498 expanded according to the rules used for 'statusline'.
6499 Example: >
6500 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6501 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6502< The value of 'titlelen' is used to align items in the middle or right
6503 of the available space.
6504 Some people prefer to have the file name first: >
6505 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6506< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006507 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 separating space only when needed.
6509 NOTE: Use of special characters in 'titlestring' may cause the display
6510 to be garbled (e.g., when it contains a CR or NL character).
6511 {not available when compiled without the |+statusline| feature}
6512
6513 *'toolbar'* *'tb'*
6514'toolbar' 'tb' string (default "icons,tooltips")
6515 global
6516 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6517 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006518 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006519 possible values are:
6520 icons Toolbar buttons are shown with icons.
6521 text Toolbar buttons shown with text.
6522 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 tooltips Tooltips are active for toolbar buttons.
6525 Tooltips refer to the popup help text which appears after the mouse
6526 cursor is placed over a toolbar button for a brief moment.
6527
6528 If you want the toolbar to be shown with icons as well as text, do the
6529 following: >
6530 :set tb=icons,text
6531< Motif and Athena cannot display icons and text at the same time. They
6532 will show icons if both are requested.
6533
6534 If none of the strings specified in 'toolbar' are valid or if
6535 'toolbar' is empty, this option is ignored. If you want to disable
6536 the toolbar, you need to set the 'guioptions' option. For example: >
6537 :set guioptions-=T
6538< Also see |gui-toolbar|.
6539
6540 *'toolbariconsize'* *'tbis'*
6541'toolbariconsize' 'tbis' string (default "small")
6542 global
6543 {not in Vi}
6544 {only in the GTK+ 2 GUI}
6545 Controls the size of toolbar icons. The possible values are:
6546 tiny Use tiny toolbar icons.
6547 small Use small toolbar icons (default).
6548 medium Use medium-sized toolbar icons.
6549 large Use large toolbar icons.
6550 The exact dimensions in pixels of the various icon sizes depend on
6551 the current theme. Common dimensions are large=32x32, medium=24x24,
6552 small=20x20 and tiny=16x16.
6553
6554 If 'toolbariconsize' is empty, the global default size as determined
6555 by user preferences or the current theme is used.
6556
6557 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6558'ttybuiltin' 'tbi' boolean (default on)
6559 global
6560 {not in Vi}
6561 When on, the builtin termcaps are searched before the external ones.
6562 When off the builtin termcaps are searched after the external ones.
6563 When this option is changed, you should set the 'term' option next for
6564 the change to take effect, for example: >
6565 :set notbi term=$TERM
6566< See also |termcap|.
6567 Rationale: The default for this option is "on", because the builtin
6568 termcap entries are generally better (many systems contain faulty
6569 xterm entries...).
6570
6571 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6572'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6573 sun-cmd, screen, rxvt, dtterm or
6574 iris-ansi; also on when running Vim in
6575 a DOS console)
6576 global
6577 {not in Vi}
6578 Indicates a fast terminal connection. More characters will be sent to
6579 the screen for redrawing, instead of using insert/delete line
6580 commands. Improves smoothness of redrawing when there are multiple
6581 windows and the terminal does not support a scrolling region.
6582 Also enables the extra writing of characters at the end of each screen
6583 line for lines that wrap. This helps when using copy/paste with the
6584 mouse in an xterm and other terminals.
6585
6586 *'ttymouse'* *'ttym'*
6587'ttymouse' 'ttym' string (default depends on 'term')
6588 global
6589 {not in Vi}
6590 {only in Unix and VMS, doesn't work in the GUI; not
6591 available when compiled without |+mouse|}
6592 Name of the terminal type for which mouse codes are to be recognized.
6593 Currently these three strings are valid:
6594 *xterm-mouse*
6595 xterm xterm-like mouse handling. The mouse generates
6596 "<Esc>[Mscr", where "scr" is three bytes:
6597 "s" = button state
6598 "c" = column plus 33
6599 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006600 This only works up to 223 columns! See "dec" for a
6601 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006602 xterm2 Works like "xterm", but with the xterm reporting the
6603 mouse position while the mouse is dragged. This works
6604 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006605 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 work. See below for how Vim detects this
6607 automatically.
6608 *netterm-mouse*
6609 netterm NetTerm mouse handling. The mouse generates
6610 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6611 for the row and column.
6612 *dec-mouse*
6613 dec DEC terminal mouse handling. The mouse generates a
6614 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006615 This is also available for an Xterm, if it was
6616 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 *jsbterm-mouse*
6618 jsbterm JSB term mouse handling.
6619 *pterm-mouse*
6620 pterm QNX pterm mouse handling.
6621
6622 The mouse handling must be enabled at compile time |+mouse_xterm|
6623 |+mouse_dec| |+mouse_netterm|.
6624 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6625 recognized, if enabled at compile time. DEC terminal mouse codes
6626 are recognized if enabled at compile time, and 'ttymouse' is not
6627 "xterm" (because the xterm and dec mouse codes conflict).
6628 This option is automatically set to "xterm", when the 'term' option is
6629 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6630 or "xterm2" already. The main use of this option is to set it to
6631 "xterm", when the terminal name doesn't start with "xterm", but it can
6632 handle xterm mouse codes.
6633 The "xterm2" value will be set if the xterm version is reported to be
6634 95 of higher. This only works when compiled with the |+termresponse|
6635 feature and if |t_RV| is set to the escape sequence to request the
6636 xterm version number. Otherwise "xterm2" must be set explicitly.
6637 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6638 t_RV to an empty string: >
6639 :set t_RV=
6640<
6641 *'ttyscroll'* *'tsl'*
6642'ttyscroll' 'tsl' number (default 999)
6643 global
6644 Maximum number of lines to scroll the screen. If there are more lines
6645 to scroll the window is redrawn. For terminals where scrolling is
6646 very slow and redrawing is not slow this can be set to a small number,
6647 e.g., 3, to speed up displaying.
6648
6649 *'ttytype'* *'tty'*
6650'ttytype' 'tty' string (default from $TERM)
6651 global
6652 Alias for 'term', see above.
6653
6654 *'undolevels'* *'ul'*
6655'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6656 Win32 and OS/2)
6657 global
6658 {not in Vi}
6659 Maximum number of changes that can be undone. Since undo information
6660 is kept in memory, higher numbers will cause more memory to be used
6661 (nevertheless, a single change can use an unlimited amount of memory).
6662 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6663 itself: >
6664 set ul=0
6665< But you can also get Vi compatibility by including the 'u' flag in
6666 'cpoptions', and still be able to use CTRL-R to repeat undo.
6667 Set to a negative number for no undo at all: >
6668 set ul=-1
6669< This helps when you run out of memory for a single change.
6670 Also see |undo-two-ways|.
6671
6672 *'updatecount'* *'uc'*
6673'updatecount' 'uc' number (default: 200)
6674 global
6675 {not in Vi}
6676 After typing this many characters the swap file will be written to
6677 disk. When zero, no swap file will be created at all (see chapter on
6678 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6679 Vim with the "-n" option, see |startup|. When editing in readonly
6680 mode this option will be initialized to 10000.
6681 The swapfile can be disabled per buffer with |'swapfile'|.
6682 When 'updatecount' is set from zero to non-zero, swap files are
6683 created for all buffers that have 'swapfile' set. When 'updatecount'
6684 is set to zero, existing swap files are not deleted.
6685 Also see |'swapsync'|.
6686 This option has no meaning in buffers where |'buftype'| is "nofile"
6687 or "nowrite".
6688
6689 *'updatetime'* *'ut'*
6690'updatetime' 'ut' number (default 4000)
6691 global
6692 {not in Vi}
6693 If this many milliseconds nothing is typed the swap file will be
6694 written to disk (see |crash-recovery|). Also used for the
6695 |CursorHold| autocommand event.
6696
6697 *'verbose'* *'vbs'*
6698'verbose' 'vbs' number (default 0)
6699 global
6700 {not in Vi, although some versions have a boolean
6701 verbose option}
6702 When bigger than zero, Vim will give messages about what it is doing.
6703 Currently, these messages are given:
6704 >= 1 When the viminfo file is read or written.
6705 >= 2 When a file is ":source"'ed.
6706 >= 5 Every searched tags file.
6707 >= 8 Files for which a group of autocommands is executed.
6708 >= 9 Every executed autocommand.
6709 >= 12 Every executed function.
6710 >= 13 When an exception is thrown, caught, finished, or discarded.
6711 >= 14 Anything pending in a ":finally" clause.
6712 >= 15 Every executed Ex command (truncated at 200 characters).
6713
6714 This option can also be set with the "-V" argument. See |-V|.
6715 This option is also set by the |:verbose| command.
6716
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006717 When the 'verbosefile' option is set then the verbose messages are not
6718 displayed.
6719
6720 *'verbosefile'* *'vfile'*
6721'verbosefile' 'vfile' string (default empty)
6722 global
6723 {not in Vi}
6724 When not empty all messages are written in a file with this name.
6725 When the file exists messages are appended.
6726 Writing to the file ends when Vim exits or when 'verbosefile' is made
6727 empty.
6728 Setting 'verbosefile' to a new value is like making it empty first.
6729 The difference with |:redir| is that verbose messages are not
6730 displayed when 'verbosefile' is set.
6731
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 *'viewdir'* *'vdir'*
6733'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6734 "$VIM/vimfiles/view",
6735 for Unix: "~/.vim/view",
6736 for Macintosh: "$VIM:vimfiles:view"
6737 for VMS: "sys$login:vimfiles/view"
6738 for RiscOS: "Choices:vimfiles/view")
6739 global
6740 {not in Vi}
6741 {not available when compiled without the +mksession
6742 feature}
6743 Name of the directory where to store files for |:mkview|.
6744 This option cannot be set from a |modeline| or in the |sandbox|, for
6745 security reasons.
6746
6747 *'viewoptions'* *'vop'*
6748'viewoptions' 'vop' string (default: "folds,options,cursor")
6749 global
6750 {not in Vi}
6751 {not available when compiled without the +mksession
6752 feature}
6753 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006754 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 word save and restore ~
6756 cursor cursor position in file and in window
6757 folds manually created folds, opened/closed folds and local
6758 fold options
6759 options options and mappings local to a window or buffer (not
6760 global values for local options)
6761 slash backslashes in file names replaced with forward
6762 slashes
6763 unix with Unix end-of-line format (single <NL>), even when
6764 on Windows or DOS
6765
6766 "slash" and "unix" are useful on Windows when sharing view files
6767 with Unix. The Unix version of Vim cannot source dos format scripts,
6768 but the Windows version of Vim can source unix format scripts.
6769
6770 *'viminfo'* *'vi'* *E526* *E527* *E528*
6771'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6772 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6773 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6774 for others: '20,<50,s10,h)
6775 global
6776 {not in Vi}
6777 {not available when compiled without the |+viminfo|
6778 feature}
6779 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006780 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 separated list of parameters, each consisting of a single character
6782 identifying the particular parameter, followed by a number or string
6783 which specifies the value of that parameter. If a particular
6784 character is left out, then the default value is used for that
6785 parameter. The following is a list of the identifying characters and
6786 the effect of their value.
6787 CHAR VALUE ~
6788 ! When included, save and restore global variables that start
6789 with an uppercase letter, and don't contain a lowercase
6790 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006791 and "_K_L_M" are not. Only String and Number types are
6792 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 " Maximum number of lines saved for each register. Old name of
6794 the '<' item, with the disadvantage that you need to put a
6795 backslash before the ", otherwise it will be recognized as the
6796 start of a comment!
6797 % When included, save and restore the buffer list. If Vim is
6798 started with a file name argument, the buffer list is not
6799 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006800 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 without a file name and buffers for help files are not written
6802 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006803 When followed by a number, the number specifies the maximum
6804 number of buffers that are stored. Without a number all
6805 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 ' Maximum number of previously edited files for which the marks
6807 are remembered. This parameter must always be included when
6808 'viminfo' is non-empty.
6809 Including this item also means that the |jumplist| and the
6810 |changelist| are stored in the viminfo file.
6811 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006812 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813 patterns are also saved. When not included, the value of
6814 'history' is used.
6815 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006816 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006817 < Maximum number of lines saved for each register. If zero then
6818 registers are not saved. When not included, all lines are
6819 saved. '"' is the old name for this item.
6820 Also see the 's' item below: limit specified in Kbyte.
6821 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006822 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 c When included, convert the text in the viminfo file from the
6824 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006825 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006826 f Whether file marks need to be stored. If zero, file marks ('0
6827 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006828 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 cursor position (when exiting or when doing ":wviminfo").
6830 h Disable the effect of 'hlsearch' when loading the viminfo
6831 file. When not included, it depends on whether ":nohlsearch"
6832 has been used since the last search command.
6833 n Name of the viminfo file. The name must immediately follow
6834 the 'n'. Must be the last one! If the "-i" argument was
6835 given when starting Vim, that file name overrides the one
6836 given here with 'viminfo'. Environment variables are expanded
6837 when opening the file, not when setting the option.
6838 r Removable media. The argument is a string (up to the next
6839 ','). This parameter can be given several times. Each
6840 specifies the start of a path for which no marks will be
6841 stored. This is to avoid removable media. For MS-DOS you
6842 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6843 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6844 ignored. Maximum length of each 'r' argument is 50
6845 characters.
6846 s Maximum size of an item in Kbyte. If zero then registers are
6847 not saved. Currently only applies to registers. The default
6848 "s10" will exclude registers with more than 10 Kbyte of text.
6849 Also see the '<' item above: line count limit.
6850
6851 Example: >
6852 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6853<
6854 '50 Marks will be remembered for the last 50 files you
6855 edited.
6856 <1000 Contents of registers (up to 1000 lines each) will be
6857 remembered.
6858 s100 Registers with more than 100 Kbyte text are skipped.
6859 :0 Command-line history will not be saved.
6860 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6861 no / Since '/' is not specified, the default will be used,
6862 that is, save all of the search history, and also the
6863 previous search and substitute patterns.
6864 no % The buffer list will not be saved nor read back.
6865 no h 'hlsearch' highlighting will be restored.
6866
6867 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6868 load the contents of the file, this is not done automatically.
6869
6870 This option cannot be set from a |modeline| or in the |sandbox|, for
6871 security reasons.
6872
6873 *'virtualedit'* *'ve'*
6874'virtualedit' 've' string (default "")
6875 global
6876 {not in Vi}
6877 {not available when compiled without the
6878 |+virtualedit| feature}
6879 A comma separated list of these words:
6880 block Allow virtual editing in Visual block mode.
6881 insert Allow virtual editing in Insert mode.
6882 all Allow virtual editing in all modes.
6883 Virtual editing means that the cursor can be positioned where there is
6884 no actual character. This can be halfway into a Tab or beyond the end
6885 of the line. Useful for selecting a rectangle in Visual mode and
6886 editing a table.
6887
6888 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6889'visualbell' 'vb' boolean (default off)
6890 global
6891 {not in Vi}
6892 Use visual bell instead of beeping. The terminal code to display the
6893 visual bell is given with 't_vb'. When no beep or flash is wanted,
6894 use ":set vb t_vb=".
6895 Note: When the GUI starts, 't_vb' is reset to its default value. You
6896 might want to set it again in your |gvimrc|.
6897 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6898 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6899 where 40 is the time in msec.
6900 Does not work on the Amiga, you always get a screen flash.
6901 Also see 'errorbells'.
6902
6903 *'warn'* *'nowarn'*
6904'warn' boolean (default on)
6905 global
6906 Give a warning message when a shell command is used while the buffer
6907 has been changed.
6908
6909 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6910'weirdinvert' 'wiv' boolean (default off)
6911 global
6912 {not in Vi}
6913 This option has the same effect as the 't_xs' termcap option.
6914 It is provided for backwards compatibility with version 4.x.
6915 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6916 vice versa. Has no effect when the GUI is running.
6917
6918 *'whichwrap'* *'ww'*
6919'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
6920 global
6921 {not in Vi}
6922 Allow specified keys that move the cursor left/right to move to the
6923 previous/next line when the cursor is on the first/last character in
6924 the line. Concatenate characters to allow this for these keys:
6925 char key mode ~
6926 b <BS> Normal and Visual
6927 s <Space> Normal and Visual
6928 h "h" Normal and Visual
6929 l "l" Normal and Visual
6930 < <Left> Normal and Visual
6931 > <Right> Normal and Visual
6932 ~ "~" Normal
6933 [ <Left> Insert and Replace
6934 ] <Right> Insert and Replace
6935 For example: >
6936 :set ww=<,>,[,]
6937< allows wrap only when cursor keys are used.
6938 When the movement keys are used in combination with a delete or change
6939 operator, the <EOL> also counts for a character. This makes "3h"
6940 different from "3dh" when the cursor crosses the end of a line. This
6941 is also true for "x" and "X", because they do the same as "dl" and
6942 "dh". If you use this, you may also want to use the mapping
6943 ":map <BS> X" to make backspace delete the character in front of the
6944 cursor.
6945 When 'l' is included, you get a side effect: "yl" on an empty line
6946 will include the <EOL>, so that "p" will insert a new line.
6947 NOTE: This option is set to the Vi default value when 'compatible' is
6948 set and to the Vim default value when 'compatible' is reset.
6949
6950 *'wildchar'* *'wc'*
6951'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
6952 global
6953 {not in Vi}
6954 Character you have to type to start wildcard expansion in the
6955 command-line, as specified with 'wildmode'.
6956 The character is not recognized when used inside a macro. See
6957 'wildcharm' for that.
6958 Although 'wc' is a number option, you can set it to a special key: >
6959 :set wc=<Esc>
6960< NOTE: This option is set to the Vi default value when 'compatible' is
6961 set and to the Vim default value when 'compatible' is reset.
6962
6963 *'wildcharm'* *'wcm'*
6964'wildcharm' 'wcm' number (default: none (0))
6965 global
6966 {not in Vi}
6967 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006968 recognized when used inside a macro. You can find "spare" command-line
6969 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00006970 you'll never actually type 'wildcharm', just use it in mappings that
6971 automatically invoke completion mode, e.g.: >
6972 :set wcm=<C-Z>
6973 :cmap ss so $vim/sessions/*.vim<C-Z>
6974< Then after typing :ss you can use CTRL-P & CTRL-N.
6975
6976 *'wildignore'* *'wig'*
6977'wildignore' 'wig' string (default "")
6978 global
6979 {not in Vi}
6980 {not available when compiled without the |+wildignore|
6981 feature}
6982 A list of file patterns. A file that matches with one of these
6983 patterns is ignored when completing file or directory names.
6984 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
6985 Also see 'suffixes'.
6986 Example: >
6987 :set wildignore=*.o,*.obj
6988< The use of |:set+=| and |:set-=| is preferred when adding or removing
6989 a pattern from the list. This avoids problems when a future version
6990 uses another default.
6991
6992 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
6993'wildmenu' 'wmnu' boolean (default off)
6994 global
6995 {not in Vi}
6996 {not available if compiled without the |+wildmenu|
6997 feature}
6998 When 'wildmenu' is on, command-line completion operates in an enhanced
6999 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7000 the possible matches are shown just above the command line, with the
7001 first match highlighted (overwriting the status line, if there is
7002 one). Keys that show the previous/next match, such as <Tab> or
7003 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7004 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7005 specified. "longest" and "list" do not start "wildmenu" mode.
7006 If there are more matches than can fit in the line, a ">" is shown on
7007 the right and/or a "<" is shown on the left. The status line scrolls
7008 as needed.
7009 The "wildmenu" mode is abandoned when a key is hit that is not used
7010 for selecting a completion.
7011 While the "wildmenu" is active the following keys have special
7012 meanings:
7013
7014 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7015 <Down> - in filename/menu name completion: move into a
7016 subdirectory or submenu.
7017 <CR> - in menu completion, when the cursor is just after a
7018 dot: move into a submenu.
7019 <Up> - in filename/menu name completion: move up into
7020 parent directory or parent menu.
7021
7022 This makes the menus accessible from the console |console-menus|.
7023
7024 If you prefer the <Left> and <Right> keys to move the cursor instead
7025 of selecting a different match, use this: >
7026 :cnoremap <Left> <Space><BS><Left>
7027 :cnoremap <Right> <Space><BS><Right>
7028<
7029 The "WildMenu" highlighting is used for displaying the current match
7030 |hl-WildMenu|.
7031
7032 *'wildmode'* *'wim'*
7033'wildmode' 'wim' string (Vim default: "full")
7034 global
7035 {not in Vi}
7036 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007037 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007038 part specifies what to do for each consecutive use of 'wildchar. The
7039 first part specifies the behavior for the first use of 'wildchar',
7040 The second part for the second use, etc.
7041 These are the possible values for each part:
7042 "" Complete only the first match.
7043 "full" Complete the next full match. After the last match,
7044 the original string is used and then the first match
7045 again.
7046 "longest" Complete till longest common string. If this doesn't
7047 result in a longer string, use the next part.
7048 "longest:full" Like "longest", but also start 'wildmenu' if it is
7049 enabled.
7050 "list" When more than one match, list all matches.
7051 "list:full" When more than one match, list all matches and
7052 complete first match.
7053 "list:longest" When more than one match, list all matches and
7054 complete till longest common string.
7055 When there is only a single match, it is fully completed in all cases.
7056
7057 Examples: >
7058 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007059< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007060 :set wildmode=longest,full
7061< Complete longest common string, then each full match >
7062 :set wildmode=list:full
7063< List all matches and complete each full match >
7064 :set wildmode=list,full
7065< List all matches without completing, then each full match >
7066 :set wildmode=longest,list
7067< Complete longest common string, then list alternatives.
7068
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007069 *'wildoptions'* *'wop'*
7070'wildoptions' 'wop' string (default "")
7071 global
7072 {not in Vi}
7073 {not available when compiled without the |+wildignore|
7074 feature}
7075 A list of words that change how command line completion is done.
7076 Currently only one word is allowed:
7077 tagfile When using CTRL-D to list matching tags, the kind of
7078 tag and the file of the tag is listed. Only one match
7079 is displayed per line. Often used tag kinds are:
7080 d #define
7081 f function
7082 Also see |cmdline-completion|.
7083
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 *'winaltkeys'* *'wak'*
7085'winaltkeys' 'wak' string (default "menu")
7086 global
7087 {not in Vi}
7088 {only used in Win32, Motif, GTK and Photon GUI}
7089 Some GUI versions allow the access to menu entries by using the ALT
7090 key in combination with a character that appears underlined in the
7091 menu. This conflicts with the use of the ALT key for mappings and
7092 entering special characters. This option tells what to do:
7093 no Don't use ALT keys for menus. ALT key combinations can be
7094 mapped, but there is no automatic handling. This can then be
7095 done with the |:simalt| command.
7096 yes ALT key handling is done by the windowing system. ALT key
7097 combinations cannot be mapped.
7098 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007099 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007100 keys can be mapped.
7101 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7102 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007103 This option is not used for <F10>; on Win32 and with GTK <F10> will
7104 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007106 *'window'* *'wi'*
7107'window' 'wi' number (default screen height - 1)
7108 global
7109 Window height. Do not confuse this with the height of the Vim window,
7110 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007111 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7112 value is smaller than 'lines' minus one. The screen will scroll
7113 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007114 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7115 in a much smarter way, taking care of wrapping lines.
7116 When resizing the Vim window, the value is smaller than 1 or more than
7117 or equal to 'lines' it will be set to 'lines' minus 1.
7118 {Vi also uses the option to specify the number of displayed lines}
7119
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 *'winheight'* *'wh'* *E591*
7121'winheight' 'wh' number (default 1)
7122 global
7123 {not in Vi}
7124 {not available when compiled without the +windows
7125 feature}
7126 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007127 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 current window is smaller, its size is increased, at the cost of the
7129 height of other windows. Set it to 999 to make the current window
7130 always fill the screen (although this has the drawback that ":all"
7131 will create only two windows). Set it to a small number for normal
7132 editing.
7133 Minimum value is 1.
7134 The height is not adjusted after one of the commands to change the
7135 height of the current window.
7136 'winheight' applies to the current window. Use 'winminheight' to set
7137 the minimal height for other windows.
7138
7139 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7140'winfixheight' 'wfh' boolean (default off)
7141 local to window
7142 {not in Vi}
7143 {not available when compiled without the +windows
7144 feature}
7145 Keep the window height when windows are opened or closed and
7146 'equalalways' is set. Set by default for the |preview-window| and
7147 |quickfix-window|.
7148 The height may be changed anyway when running out of room.
7149
7150 *'winminheight'* *'wmh'*
7151'winminheight' 'wmh' number (default 1)
7152 global
7153 {not in Vi}
7154 {not available when compiled without the +windows
7155 feature}
7156 The minimal height of a window, when it's not the current window.
7157 This is a hard minimum, windows will never become smaller.
7158 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7159 status bar) if necessary. They will return to at least one line when
7160 they become active (since the cursor has to have somewhere to go.)
7161 Use 'winheight' to set the minimal height of the current window.
7162 This option is only checked when making a window smaller. Don't use a
7163 large number, it will cause errors when opening more than a few
7164 windows. A value of 0 to 3 is reasonable.
7165
7166 *'winminwidth'* *'wmw'*
7167'winminwidth' 'wmw' number (default 1)
7168 global
7169 {not in Vi}
7170 {not available when compiled without the +vertsplit
7171 feature}
7172 The minimal width of a window, when it's not the current window.
7173 This is a hard minimum, windows will never become smaller.
7174 When set to zero, windows may be "squashed" to zero columns (i.e. just
7175 a vertical separator) if necessary. They will return to at least one
7176 line when they become active (since the cursor has to have somewhere
7177 to go.)
7178 Use 'winwidth' to set the minimal width of the current window.
7179 This option is only checked when making a window smaller. Don't use a
7180 large number, it will cause errors when opening more than a few
7181 windows. A value of 0 to 12 is reasonable.
7182
7183 *'winwidth'* *'wiw'* *E592*
7184'winwidth' 'wiw' number (default 20)
7185 global
7186 {not in Vi}
7187 {not available when compiled without the +vertsplit
7188 feature}
7189 Minimal number of columns for the current window. This is not a hard
7190 minimum, Vim will use fewer columns if there is not enough room. If
7191 the current window is smaller, its size is increased, at the cost of
7192 the width of other windows. Set it to 999 to make the current window
7193 always fill the screen. Set it to a small number for normal editing.
7194 The width is not adjusted after one of the commands to change the
7195 width of the current window.
7196 'winwidth' applies to the current window. Use 'winminwidth' to set
7197 the minimal width for other windows.
7198
7199 *'wrap'* *'nowrap'*
7200'wrap' boolean (default on)
7201 local to window
7202 {not in Vi}
7203 This option changes how text is displayed. It doesn't change the text
7204 in the buffer, see 'textwidth' for that.
7205 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007206 displaying continues on the next line. When off lines will not wrap
7207 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 moved to a part that is not shown, the screen will scroll
7209 horizontally.
7210 The line will be broken in the middle of a word if necessary. See
7211 'linebreak' to get the break at a word boundary.
7212 To make scrolling horizontally a bit more useful, try this: >
7213 :set sidescroll=5
7214 :set listchars+=precedes:<,extends:>
7215< See 'sidescroll', 'listchars' and |wrap-off|.
7216
7217 *'wrapmargin'* *'wm'*
7218'wrapmargin' 'wm' number (default 0)
7219 local to buffer
7220 Number of characters from the right window border where wrapping
7221 starts. When typing text beyond this limit, an <EOL> will be inserted
7222 and inserting continues on the next line.
7223 Options that add a margin, such as 'number' and 'foldcolumn', cause
7224 the text width to be further reduced. This is Vi compatible.
7225 When 'textwidth' is non-zero, this option is not used.
7226 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7227 and less usefully}
7228
7229 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7230'wrapscan' 'ws' boolean (default on) *E384* *E385*
7231 global
7232 Searches wrap around the end of the file.
7233
7234 *'write'* *'nowrite'*
7235'write' boolean (default on)
7236 global
7237 {not in Vi}
7238 Allows writing files. When not set, writing a file is not allowed.
7239 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007240 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 argument. Filtering text is still possible, even though this requires
7242 writing a temporary file.
7243
7244 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7245'writeany' 'wa' boolean (default off)
7246 global
7247 Allows writing to any file with no need for "!" override.
7248
7249 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7250'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7251 otherwise)
7252 global
7253 {not in Vi}
7254 Make a backup before overwriting a file. The backup is removed after
7255 the file was successfully written, unless the 'backup' option is
7256 also on. Reset this option if your file system is almost full. See
7257 |backup-table| for another explanation.
7258 When the 'backupskip' pattern matches, a backup is not made anyway.
7259 NOTE: This option is set to the default value when 'compatible' is
7260 set.
7261
7262 *'writedelay'* *'wd'*
7263'writedelay' 'wd' number (default 0)
7264 global
7265 {not in Vi}
7266 The number of microseconds to wait for each character sent to the
7267 screen. When non-zero, characters are sent to the terminal one by
7268 one. For MS-DOS pcterm this does not work. For debugging purposes.
7269
7270 vim:tw=78:ts=8:ft=help:norl: