blob: 91076157f52293f8bfac15e8cbc67fb99e7d93ac [file] [log] [blame]
Bram Moolenaar578b49e2005-09-10 19:22:57 +00001*options.txt* For Vim version 7.0aa. Last change: 2005 Sep 10
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 Moolenaar578b49e2005-09-10 19:22:57 +0000563Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000565Not all options are supported in all versions. This depends on the supported
566features and sometimes on the system. A remark about this is in curly braces
567below. When an option is not supported it may still be set without getting an
568error, this is called a hidden option. You can't get the value of a hidden
569option though, it is not stored.
570
571To test if option "foo" can be used with ":set" use something like this: >
572 if exists('&foo')
573This also returns true for a hidden option. To test if option "foo" is really
574supported use something like this: >
575 if exists('+foo')
576<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000577 *E355*
578A jump table for the options with a short description can be found at |Q_op|.
579
580 *'aleph'* *'al'* *aleph* *Aleph*
581'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
582 global
583 {not in Vi}
584 {only available when compiled with the |+rightleft|
585 feature}
586 The ASCII code for the first letter of the Hebrew alphabet. The
587 routine that maps the keyboard in Hebrew mode, both in Insert mode
588 (when hkmap is set) and on the command-line (when hitting CTRL-_)
589 outputs the Hebrew characters in the range [aleph..aleph+26].
590 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
591 See |rileft.txt|.
592
593 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
594'allowrevins' 'ari' boolean (default off)
595 global
596 {not in Vi}
597 {only available when compiled with the |+rightleft|
598 feature}
599 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
600 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
601 into reverse Insert mode, and don't know how to get out. See
602 'revins'.
603 NOTE: This option is reset when 'compatible' is set.
604
605 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
606'altkeymap' 'akm' boolean (default off)
607 global
608 {not in Vi}
609 {only available when compiled with the |+farsi|
610 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000611 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 the keyboard map between Farsi and English, when 'allowrevins' set.
613
Bram Moolenaar582fd852005-03-28 20:58:01 +0000614 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 is useful to start the Vim in native mode i.e. English (left-to-right
616 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000617 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000618
619 *'ambiwidth'* *'ambw'*
620'ambiwidth' 'ambw' string (default: "single")
621 global
622 {not in Vi}
623 {only available when compiled with the |+multi_byte|
624 feature}
625 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
626 Tells Vim what to do with characters with East Asian Width Class
627 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
628 letters, Cyrillic letters).
629
630 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000631 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 expected by most users.
633 "double": Use twice the width of ASCII characters.
634
635 There are a number of CJK fonts for which the width of glyphs for
636 those characters are solely based on how many octets they take in
637 legacy/traditional CJK encodings. In those encodings, Euro,
638 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000639 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000640 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000641 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 Vim is running inside a terminal (emulators) that uses a CJK font
643 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
644 this option should be set to "double" to match the width perceived
645 by Vim with the width of glyphs in the font. Perhaps it also has
646 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
647 when the system locale is set to one of CJK locales. See Unicode
648 Standard Annex #11 (http://www.unicode.org/reports/tr11).
649
650 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
651'antialias' 'anti' boolean (default: off)
652 global
653 {not in Vi}
654 {only available when compiled with GUI enabled
655 on Mac OS X}
656 This option only has an effect in the GUI version of Vim on Mac OS X
657 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
658 which can be easier to read at certain sizes on certain displays.
659 Setting this option can sometimes cause problems if 'guifont' is set
660 to its default (empty string).
661
662 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
663'autochdir' 'acd' boolean (default off)
664 global
665 {not in Vi}
666 {only available when compiled with the
667 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000668 When on, Vim will change the current working directory whenever you
669 open a file, switch buffers, delete a buffer or open/close a window.
670 It will change to the directory containing the file which was opened
671 or selected.
672 This option is provided for backward compatibility with the Vim
673 released with Sun ONE Studio 4 Enterprise Edition.
674 Note: When this option is on some plugins may not work. The directory
675 browser sets if off.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676
677 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
678'arabic' 'arab' boolean (default off)
679 local to window
680 {not in Vi}
681 {only available when compiled with the |+arabic|
682 feature}
683 This option can be set to start editing Arabic text.
684 Setting this option will:
685 - Set the 'rightleft' option, unless 'termbidi' is set.
686 - Set the 'arabicshape' option, unless 'termbidi' is set.
687 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
688 between typing English and Arabic key mapping.
689 - Set the 'delcombine' option
690 Note that 'encoding' must be "utf-8" for working with Arabic text.
691
692 Resetting this option will:
693 - Reset the 'rightleft' option.
694 - Disable the use of 'keymap' (without changing its value).
695 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
696 option.
697 Also see |arabic.txt|.
698
699 *'arabicshape'* *'arshape'*
700 *'noarabicshape'* *'noarshape'*
701'arabicshape' 'arshape' boolean (default on)
702 global
703 {not in Vi}
704 {only available when compiled with the |+arabic|
705 feature}
706 When on and 'termbidi' is off, the required visual character
707 corrections that need to take place for displaying the Arabic language
708 take affect. Shaping, in essence, gets enabled; the term is a broad
709 one which encompasses:
710 a) the changing/morphing of characters based on their location
711 within a word (initial, medial, final and stand-alone).
712 b) the enabling of the ability to compose characters
713 c) the enabling of the required combining of some characters
714 When disabled the character display reverts back to each character's
715 true stand-alone form.
716 Arabic is a complex language which requires other settings, for
717 further details see |arabic.txt|.
718
719 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
720'autoindent' 'ai' boolean (default off)
721 local to buffer
722 Copy indent from current line when starting a new line (typing <CR>
723 in Insert mode or when using the "o" or "O" command). If you do not
724 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000725 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
726 another line has the same effect, unless the 'I' flag is included in
727 'cpoptions'.
728 When autoindent is on, formatting (with the "gq" command or when you
729 reach 'textwidth' in Insert mode) uses the indentation of the first
730 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731 When 'smartindent' or 'cindent' is on the indent is changed in
732 a different way.
733 The 'autoindent' option is reset when the 'paste' option is set.
734 {small difference from Vi: After the indent is deleted when typing
735 <Esc> or <CR>, the cursor position when moving up or down is after the
736 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
737
738 *'autoread'* *'ar'* *'noautoread'* *'noar'*
739'autoread' 'ar' boolean (default off)
740 global or local to buffer |global-local|
741 {not in Vi}
742 When a file has been detected to have been changed outside of Vim and
743 it has not been changed inside of Vim, automatically read it again.
744 When the file has been deleted this is not done. |timestamp|
745 If this option has a local value, use this command to switch back to
746 using the global value: >
747 :set autoread<
748<
749 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
750'autowrite' 'aw' boolean (default off)
751 global
752 Write the contents of the file, if it has been modified, on each
753 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
754 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I,
755 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
756 Note that for some commands the 'autowrite' option is not used, see
757 'autowriteall' for that.
758
759 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
760'autowriteall' 'awa' boolean (default off)
761 global
762 {not in Vi}
763 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
764 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
765 Setting this option also implies that Vim behaves like 'autowrite' has
766 been set.
767
768 *'background'* *'bg'*
769'background' 'bg' string (default "dark" or "light")
770 global
771 {not in Vi}
772 When set to "dark", Vim will try to use colors that look good on a
773 dark background. When set to "light", Vim will try to use colors that
774 look good on a light background. Any other value is illegal.
775 Vim tries to set the default value according to the terminal used.
776 This will not always be correct.
777 Setting this option does not change the background color, it tells Vim
778 what the background color looks like. For changing the background
779 color, see |:hi-normal|.
780
781 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000782 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 change.
784 When a color scheme is loaded (the "colors_name" variable is set)
785 setting 'background' will cause the color scheme to be reloaded. If
786 the color scheme adjusts to the value of 'background' this will work.
787 However, if the color scheme sets 'background' itself the effect may
788 be undone. First delete the "colors_name" variable when needed.
789
790 When setting 'background' to the default value with: >
791 :set background&
792< Vim will guess the value. In the GUI this should work correctly,
793 in other cases Vim might not be able to guess the right value.
794
795 When starting the GUI, the default value for 'background' will be
796 "light". When the value is not set in the .gvimrc, and Vim detects
797 that the background is actually quite dark, 'background' is set to
798 "dark". But this happens only AFTER the .gvimrc file has been read
799 (because the window needs to be opened to find the actual background
800 color). To get around this, force the GUI window to be opened by
801 putting a ":gui" command in the .gvimrc file, before where the value
802 of 'background' is used (e.g., before ":syntax on").
803 Normally this option would be set in the .vimrc file. Possibly
804 depending on the terminal name. Example: >
805 :if &term == "pcterm"
806 : set background=dark
807 :endif
808< When this option is set, the default settings for the highlight groups
809 will change. To use other settings, place ":highlight" commands AFTER
810 the setting of the 'background' option.
811 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
812 to select the colors for syntax highlighting. After changing this
813 option, you must load syntax.vim again to see the result. This can be
814 done with ":syntax on".
815
816 *'backspace'* *'bs'*
817'backspace' 'bs' string (default "")
818 global
819 {not in Vi}
820 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
821 mode. This is a list of items, separated by commas. Each item allows
822 a way to backspace over something:
823 value effect ~
824 indent allow backspacing over autoindent
825 eol allow backspacing over line breaks (join lines)
826 start allow backspacing over the start of insert; CTRL-W and CTRL-U
827 stop once at the start of insert.
828
829 When the value is empty, Vi compatible backspacing is used.
830
831 For backwards compatibility with version 5.4 and earlier:
832 value effect ~
833 0 same as ":set backspace=" (Vi compatible)
834 1 same as ":set backspace=indent,eol"
835 2 same as ":set backspace=indent,eol,start"
836
837 See |:fixdel| if your <BS> or <Del> key does not do what you want.
838 NOTE: This option is set to "" when 'compatible' is set.
839
840 *'backup'* *'bk'* *'nobackup'* *'nobk'*
841'backup' 'bk' boolean (default off)
842 global
843 {not in Vi}
844 Make a backup before overwriting a file. Leave it around after the
845 file has been successfully written. If you do not want to keep the
846 backup file, but you do want a backup while the file is being
847 written, reset this option and set the 'writebackup' option (this is
848 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000849 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 |backup-table| for more explanations.
851 When the 'backupskip' pattern matches, a backup is not made anyway.
852 When 'patchmode' is set, the backup may be renamed to become the
853 oldest version of a file.
854 NOTE: This option is reset when 'compatible' is set.
855
856 *'backupcopy'* *'bkc'*
857'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
858 global
859 {not in Vi}
860 When writing a file and a backup is made, this option tells how it's
861 done. This is a comma separated list of words.
862
863 The main values are:
864 "yes" make a copy of the file and overwrite the original one
865 "no" rename the file and write a new one
866 "auto" one of the previous, what works best
867
868 Extra values that can be combined with the ones above are:
869 "breaksymlink" always break symlinks when writing
870 "breakhardlink" always break hardlinks when writing
871
872 Making a copy and overwriting the original file:
873 - Takes extra time to copy the file.
874 + When the file has special attributes, is a (hard/symbolic) link or
875 has a resource fork, all this is preserved.
876 - When the file is a link the backup will have the name of the link,
877 not of the real file.
878
879 Renaming the file and writing a new one:
880 + It's fast.
881 - Sometimes not all attributes of the file can be copied to the new
882 file.
883 - When the file is a link the new file will not be a link.
884
885 The "auto" value is the middle way: When Vim sees that renaming file
886 is possible without side effects (the attributes can be passed on and
887 and the file is not a link) that is used. When problems are expected,
888 a copy will be made.
889
890 The "breaksymlink" and "breakhardlink" values can be used in
891 combination with any of "yes", "no" and "auto". When included, they
892 force Vim to always break either symbolic or hard links by doing
893 exactly what the "no" option does, renaming the original file to
894 become the backup and writing a new file in its place. This can be
895 useful for example in source trees where all the files are symbolic or
896 hard links and any changes should stay in the local source tree, not
897 be propagated back to the original source.
898 *crontab*
899 One situation where "no" and "auto" will cause problems: A program
900 that opens a file, invokes Vim to edit that file, and then tests if
901 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000902 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 example.
904
905 When a copy is made, the original file is truncated and then filled
906 with the new text. This means that protection bits, owner and
907 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000908 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 group of the backup is set to the group of the original file. If this
910 fails, the protection bits for the group are made the same as for
911 others.
912
913 When the file is renamed this is the other way around: The backup has
914 the same attributes of the original file, and the newly written file
915 is owned by the current user. When the file was a (hard/symbolic)
916 link, the new file will not! That's why the "auto" value doesn't
917 rename when the file is a link. The owner and group of the newly
918 written file will be set to the same ones as the original file, but
919 the system may refuse to do this. In that case the "auto" value will
920 again not rename the file.
921
922 *'backupdir'* *'bdir'*
923'backupdir' 'bdir' string (default for Amiga: ".,t:",
924 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
925 for Unix: ".,~/tmp,~/")
926 global
927 {not in Vi}
928 List of directories for the backup file, separated with commas.
929 - The backup file will be created in the first directory in the list
930 where this is possible.
931 - Empty means that no backup file will be created ('patchmode' is
932 impossible!). Writing may fail because of this.
933 - A directory "." means to put the backup file in the same directory
934 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000935 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 put the backup file relative to where the edited file is. The
937 leading "." is replaced with the path name of the edited file.
938 ("." inside a directory name has no special meaning).
939 - Spaces after the comma are ignored, other spaces are considered part
940 of the directory name. To have a space at the start of a directory
941 name, precede it with a backslash.
942 - To include a comma in a directory name precede it with a backslash.
943 - A directory name may end in an '/'.
944 - Environment variables are expanded |:set_env|.
945 - Careful with '\' characters, type one before a space, type two to
946 get one in the option (see |option-backslash|), for example: >
947 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
948< - For backwards compatibility with Vim version 3.0 a '>' at the start
949 of the option is removed.
950 See also 'backup' and 'writebackup' options.
951 If you want to hide your backup files on Unix, consider this value: >
952 :set backupdir=./.backup,~/.backup,.,/tmp
953< You must create a ".backup" directory in each directory and in your
954 home directory for this to work properly.
955 The use of |:set+=| and |:set-=| is preferred when adding or removing
956 directories from the list. This avoids problems when a future version
957 uses another default.
958 This option cannot be set from a |modeline| or in the |sandbox|, for
959 security reasons.
960
961 *'backupext'* *'bex'* *E589*
962'backupext' 'bex' string (default "~", for VMS: "_")
963 global
964 {not in Vi}
965 String which is appended to a file name to make the name of the
966 backup file. The default is quite unusual, because this avoids
967 accidentally overwriting existing files with a backup file. You might
968 prefer using ".bak", but make sure that you don't have files with
969 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000970 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000972 If you like to keep a lot of backups, you could use a BufWritePre
973 autocommand to change 'backupext' just before writing the file to
974 include a timestamp. >
975 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
976< Use 'backupdir' to put the backup in a different directory.
977
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 *'backupskip'* *'bsk'*
979'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
980 global
981 {not in Vi}
982 {not available when compiled without the |+wildignore|
983 feature}
984 A list of file patterns. When one of the patterns matches with the
985 name of the file which is written, no backup file is created. Both
986 the specified file name and the full path name of the file are used.
987 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
988 Watch out for special characters, see |option-backslash|.
989 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +0000990 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991
992 *'balloondelay'* *'bdlay'*
993'balloondelay' 'bdlay' number (default: 600)
994 global
995 {not in Vi}
996 {only available when compiled with the |+balloon_eval|
997 feature}
998 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
999
1000 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1001'ballooneval' 'beval' boolean (default off)
1002 global
1003 {not in Vi}
1004 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001005 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001006 Switch on the |balloon-eval| functionality.
1007
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001008 *'balloonexpr'* *'bexpr'*
1009'balloonexpr' 'bexpr' string (default "")
1010 global
1011 {not in Vi}
1012 {only available when compiled with the |+balloon_eval|
1013 feature}
1014 Expression to show in evaluation balloon. It is only used when
1015 'ballooneval' is on. These variables can be used:
1016
1017 v:beval_bufnr number of the buffer in which balloon is going to show
1018 v:beval_winnr number of the window
1019 v:beval_lnum line number
1020 v:beval_col column number (byte index)
1021 v:beval_text word under or after the mouse pointer
1022
1023 The evaluation of the expression must not have side effects!
1024 Example: >
1025 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001026 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001027 \', column ' . v:beval_col .
1028 \ ' of file ' . bufname(v:beval_bufnr) .
1029 \ ' on word "' . v:beval_text . '"'
1030 endfunction
1031 set bexpr=MyBalloonExpr()
1032 set ballooneval
1033<
1034 NOTE: The balloon is displayed only if the cursor is on a text
1035 character. If the result of evaluating 'balloonexpr' is not empty,
1036 Vim does not try to send a message to an external debugger (Netbeans
1037 or Sun Workshop).
1038
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001039 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001040 if has("balloon_multiline")
1041<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1043'binary' 'bin' boolean (default off)
1044 local to buffer
1045 {not in Vi}
1046 This option should be set before editing a binary file. You can also
1047 use the |-b| Vim argument. When this option is switched on a few
1048 options will be changed (also when it already was on):
1049 'textwidth' will be set to 0
1050 'wrapmargin' will be set to 0
1051 'modeline' will be off
1052 'expandtab' will be off
1053 Also, 'fileformat' and 'fileformats' options will not be used, the
1054 file is read and written like 'fileformat' was "unix" (a single <NL>
1055 separates lines).
1056 The 'fileencoding' and 'fileencodings' options will not be used, the
1057 file is read without conversion.
1058 NOTE: When you start editing a(nother) file while the 'bin' option is
1059 on, settings from autocommands may change the settings again (e.g.,
1060 'textwidth'), causing trouble when editing. You might want to set
1061 'bin' again when the file has been loaded.
1062 The previous values of these options are remembered and restored when
1063 'bin' is switched from on to off. Each buffer has its own set of
1064 saved option values.
1065 To edit a file with 'binary' set you can use the |++bin| argument.
1066 This avoids you have to do ":set bin", which would have effect for all
1067 files you edit.
1068 When writing a file the <EOL> for the last line is only written if
1069 there was one in the original file (normally Vim appends an <EOL> to
1070 the last line if there is none; this would make the file longer). See
1071 the 'endofline' option.
1072
1073 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1074'bioskey' 'biosk' boolean (default on)
1075 global
1076 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001077 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 better to detect CTRL-C, but only works for the console. When using a
1079 terminal over a serial port reset this option.
1080 Also see |'conskey'|.
1081
1082 *'bomb'* *'nobomb'*
1083'bomb' boolean (default off)
1084 local to buffer
1085 {not in Vi}
1086 {only available when compiled with the |+multi_byte|
1087 feature}
1088 When writing a file and the following conditions are met, a BOM (Byte
1089 Order Mark) is prepended to the file:
1090 - this option is on
1091 - the 'binary' option is off
1092 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1093 endian variants.
1094 Some applications use the BOM to recognize the encoding of the file.
1095 Often used for UCS-2 files on MS-Windows. For other applications it
1096 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1097 appear halfway the resulting file.
1098 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1099 check for the presence of the BOM is done and 'bomb' set accordingly.
1100 Unless 'binary' is set, it is removed from the first line, so that you
1101 don't see it when editing. When you don't change the options, the BOM
1102 will be restored when writing the file.
1103
1104 *'breakat'* *'brk'*
1105'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1106 global
1107 {not in Vi}
1108 {not available when compiled without the |+linebreak|
1109 feature}
1110 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001111 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1112 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113
1114 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001115'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 global
1117 {not in Vi} {only for Motif and Win32 GUI}
1118 Which directory to use for the file browser:
1119 last Use same directory as with last file browser.
1120 buffer Use the directory of the related buffer.
1121 current Use the current directory.
1122 {path} Use the specified directory
1123
1124 *'bufhidden'* *'bh'*
1125'bufhidden' 'bh' string (default: "")
1126 local to buffer
1127 {not in Vi}
1128 {not available when compiled without the |+quickfix|
1129 feature}
1130 This option specifies what happens when a buffer is no longer
1131 displayed in a window:
1132 <empty> follow the global 'hidden' option
1133 hide hide the buffer (don't unload it), also when 'hidden'
1134 is not set
1135 unload unload the buffer, also when 'hidden' is set or using
1136 |:hide|
1137 delete delete the buffer from the buffer list, also when
1138 'hidden' is set or using |:hide|, like using
1139 |:bdelete|
1140 wipe wipe out the buffer from the buffer list, also when
1141 'hidden' is set or using |:hide|, like using
1142 |:bwipeout|
1143
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001144 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1145 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 This option is used together with 'buftype' and 'swapfile' to specify
1147 special kinds of buffers. See |special-buffers|.
1148
1149 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1150'buflisted' 'bl' boolean (default: on)
1151 local to buffer
1152 {not in Vi}
1153 When this option is set, the buffer shows up in the buffer list. If
1154 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1155 This option is reset by Vim for buffers that are only used to remember
1156 a file name or marks. Vim sets it when starting to edit a buffer.
1157 But not when moving to a buffer with ":buffer".
1158
1159 *'buftype'* *'bt'* *E382*
1160'buftype' 'bt' string (default: "")
1161 local to buffer
1162 {not in Vi}
1163 {not available when compiled without the |+quickfix|
1164 feature}
1165 The value of this option specifies the type of a buffer:
1166 <empty> normal buffer
1167 nofile buffer which is not related to a file and will not be
1168 written
1169 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001170 acwrite buffer which will always be written with BufWriteCmd
1171 autocommands. {not available when compiled without the
1172 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 quickfix quickfix buffer, contains list of errors |:cwindow|
1174 help help buffer (you are not supposed to set this
1175 manually)
1176
1177 This option is used together with 'bufhidden' and 'swapfile' to
1178 specify special kinds of buffers. See |special-buffers|.
1179
1180 Be careful with changing this option, it can have many side effects!
1181
1182 A "quickfix" buffer is only used for the error list. This value is
1183 set by the |:cwindow| command and you are not supposed to change it.
1184
1185 "nofile" and "nowrite" buffers are similar:
1186 both: The buffer is not to be written to disk, ":w" doesn't
1187 work (":w filename" does work though).
1188 both: The buffer is never considered to be |'modified'|.
1189 There is no warning when the changes will be lost, for
1190 example when you quit Vim.
1191 both: A swap file is only created when using too much memory
1192 (when 'swapfile' has been reset there is never a swap
1193 file).
1194 nofile only: The buffer name is fixed, it is not handled like a
1195 file name. It is not modified in response to a |:cd|
1196 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001197 *E676*
1198 "acwrite" implies that the buffer name is not related to a file, like
1199 "nofile", but it will be written. Thus, in contrast to "nofile" and
1200 "nowrite", ":w" does work and a modified buffer can't be abandoned
1201 without saving. For writing there must be matching |BufWriteCmd|,
1202 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203
1204 *'casemap'* *'cmp'*
1205'casemap' 'cmp' string (default: "internal,keepascii")
1206 global
1207 {not in Vi}
1208 Specifies details about changing the case of letters. It may contain
1209 these words, separated by a comma:
1210 internal Use internal case mapping functions, the current
1211 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001212 matters when 'encoding' is a Unicode encoding,
1213 "latin1" or "iso-8859-15". When "internal" is
1214 omitted, the towupper() and towlower() system library
1215 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1217 case mapping, the current locale is not effective.
1218 This probably only matters for Turkish.
1219
1220 *'cdpath'* *'cd'* *E344* *E346*
1221'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1222 global
1223 {not in Vi}
1224 {not available when compiled without the
1225 |+file_in_path| feature}
1226 This is a list of directories which will be searched when using the
1227 |:cd| and |:lcd| commands, provided that the directory being searched
1228 for has a relative path (not starting with "/", "./" or "../").
1229 The 'cdpath' option's value has the same form and semantics as
1230 |'path'|. Also see |file-searching|.
1231 The default value is taken from $CDPATH, with a "," prepended to look
1232 in the current directory first.
1233 If the default value taken from $CDPATH is not what you want, include
1234 a modified version of the following command in your vimrc file to
1235 override it: >
1236 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1237< This option cannot be set from a |modeline| or in the |sandbox|, for
1238 security reasons.
1239 (parts of 'cdpath' can be passed to the shell to expand file names).
1240
1241 *'cedit'*
1242'cedit' string (Vi default: "", Vim default: CTRL-F)
1243 global
1244 {not in Vi}
1245 {not available when compiled without the |+vertsplit|
1246 feature}
1247 The key used in Command-line Mode to open the command-line window.
1248 The default is CTRL-F when 'compatible' is off.
1249 Only non-printable keys are allowed.
1250 The key can be specified as a single character, but it is difficult to
1251 type. The preferred way is to use the <> notation. Examples: >
1252 :set cedit=<C-Y>
1253 :set cedit=<Esc>
1254< |Nvi| also has this option, but it only uses the first character.
1255 See |cmdwin|.
1256
1257 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1258'charconvert' 'ccv' string (default "")
1259 global
1260 {only available when compiled with the |+multi_byte|
1261 feature and the |+eval| feature}
1262 {not in Vi}
1263 An expression that is used for character encoding conversion. It is
1264 evaluated when a file that is to be read or has been written has a
1265 different encoding from what is desired.
1266 'charconvert' is not used when the internal iconv() function is
1267 supported and is able to do the conversion. Using iconv() is
1268 preferred, because it is much faster.
1269 'charconvert' is not used when reading stdin |--|, because there is no
1270 file to convert from. You will have to save the text in a file first.
1271 The expression must return zero or an empty string for success,
1272 non-zero for failure.
1273 The possible encoding names encountered are in 'encoding'.
1274 Additionally, names given in 'fileencodings' and 'fileencoding' are
1275 used.
1276 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1277 is done internally by Vim, 'charconvert' is not used for this.
1278 'charconvert' is also used to convert the viminfo file, if the 'c'
1279 flag is present in 'viminfo'. Also used for Unicode conversion.
1280 Example: >
1281 set charconvert=CharConvert()
1282 fun CharConvert()
1283 system("recode "
1284 \ . v:charconvert_from . ".." . v:charconvert_to
1285 \ . " <" . v:fname_in . " >" v:fname_out)
1286 return v:shell_error
1287 endfun
1288< The related Vim variables are:
1289 v:charconvert_from name of the current encoding
1290 v:charconvert_to name of the desired encoding
1291 v:fname_in name of the input file
1292 v:fname_out name of the output file
1293 Note that v:fname_in and v:fname_out will never be the same.
1294 Note that v:charconvert_from and v:charconvert_to may be different
1295 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1296 Encryption is not done by Vim when using 'charconvert'. If you want
1297 to encrypt the file after conversion, 'charconvert' should take care
1298 of this.
1299 This option cannot be set from a |modeline| or in the |sandbox|, for
1300 security reasons.
1301
1302 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1303'cindent' 'cin' boolean (default off)
1304 local to buffer
1305 {not in Vi}
1306 {not available when compiled without the |+cindent|
1307 feature}
1308 Enables automatic C program indenting See 'cinkeys' to set the keys
1309 that trigger reindenting in insert mode and 'cinoptions' to set your
1310 preferred indent style.
1311 If 'indentexpr' is not empty, it overrules 'cindent'.
1312 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1313 the "=" operator indents using this algorithm rather than calling an
1314 external program.
1315 See |C-indenting|.
1316 When you don't like the way 'cindent' works, try the 'smartindent'
1317 option or 'indentexpr'.
1318 This option is not used when 'paste' is set.
1319 NOTE: This option is reset when 'compatible' is set.
1320
1321 *'cinkeys'* *'cink'*
1322'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1323 local to buffer
1324 {not in Vi}
1325 {not available when compiled without the |+cindent|
1326 feature}
1327 A list of keys that, when typed in Insert mode, cause reindenting of
1328 the current line. Only used if 'cindent' is on and 'indentexpr' is
1329 empty.
1330 For the format of this option see |cinkeys-format|.
1331 See |C-indenting|.
1332
1333 *'cinoptions'* *'cino'*
1334'cinoptions' 'cino' string (default "")
1335 local to buffer
1336 {not in Vi}
1337 {not available when compiled without the |+cindent|
1338 feature}
1339 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1340 program. See |cinoptions-values| for the values of this option, and
1341 |C-indenting| for info on C indenting in general.
1342
1343
1344 *'cinwords'* *'cinw'*
1345'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1346 local to buffer
1347 {not in Vi}
1348 {not available when compiled without both the
1349 |+cindent| and the |+smartindent| features}
1350 These keywords start an extra indent in the next line when
1351 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1352 an appropriate place (inside {}).
1353 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1354 matter, include the keyword both the uppercase and lowercase:
1355 "if,If,IF".
1356
1357 *'clipboard'* *'cb'*
1358'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1359 for X-windows, "" otherwise)
1360 global
1361 {not in Vi}
1362 {only in GUI versions or when the |+xterm_clipboard|
1363 feature is included}
1364 This option is a list of comma separated names.
1365 These names are recognized:
1366
1367 unnamed When included, Vim will use the clipboard register '*'
1368 for all yank, delete, change and put operations which
1369 would normally go to the unnamed register. When a
1370 register is explicitly specified, it will always be
1371 used regardless of whether "unnamed" is in 'clipboard'
1372 or not. The clipboard register can always be
1373 explicitly accessed using the "* notation. Also see
1374 |gui-clipboard|.
1375
1376 autoselect Works like the 'a' flag in 'guioptions': If present,
1377 then whenever Visual mode is started, or the Visual
1378 area extended, Vim tries to become the owner of the
1379 windowing system's global selection or put the
1380 selected text on the clipboard used by the selection
1381 register "*. See |guioptions_a| and |quotestar| for
1382 details. When the GUI is active, the 'a' flag in
1383 'guioptions' is used, when the GUI is not active, this
1384 "autoselect" flag is used.
1385 Also applies to the modeless selection.
1386
1387 autoselectml Like "autoselect", but for the modeless selection
1388 only. Compare to the 'A' flag in 'guioptions'.
1389
1390 exclude:{pattern}
1391 Defines a pattern that is matched against the name of
1392 the terminal 'term'. If there is a match, no
1393 connection will be made to the X server. This is
1394 useful in this situation:
1395 - Running Vim in a console.
1396 - $DISPLAY is set to start applications on another
1397 display.
1398 - You do not want to connect to the X server in the
1399 console, but do want this in a terminal emulator.
1400 To never connect to the X server use: >
1401 exclude:.*
1402< This has the same effect as using the |-X| argument.
1403 Note that when there is no connection to the X server
1404 the window title won't be restored and the clipboard
1405 cannot be accessed.
1406 The value of 'magic' is ignored, {pattern} is
1407 interpreted as if 'magic' was on.
1408 The rest of the option value will be used for
1409 {pattern}, this must be the last entry.
1410
1411 *'cmdheight'* *'ch'*
1412'cmdheight' 'ch' number (default 1)
1413 global
1414 {not in Vi}
1415 Number of screen lines to use for the command-line. Helps avoiding
1416 |hit-enter| prompts.
1417
1418 *'cmdwinheight'* *'cwh'*
1419'cmdwinheight' 'cwh' number (default 7)
1420 global
1421 {not in Vi}
1422 {not available when compiled without the |+vertsplit|
1423 feature}
1424 Number of screen lines to use for the command-line window. |cmdwin|
1425
1426 *'columns'* *'co'* *E594*
1427'columns' 'co' number (default 80 or terminal width)
1428 global
1429 {not in Vi}
1430 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001431 initialization and does not have to be set by hand. Also see
1432 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001433 When Vim is running in the GUI or in a resizable window, setting this
1434 option will cause the window size to be changed. When you only want
1435 to use the size for the GUI, put the command in your |gvimrc| file.
1436 When you set this option and Vim is unable to change the physical
1437 number of columns of the display, the display may be messed up.
1438
1439 *'comments'* *'com'* *E524* *E525*
1440'comments' 'com' string (default
1441 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1442 local to buffer
1443 {not in Vi}
1444 {not available when compiled without the |+comments|
1445 feature}
1446 A comma separated list of strings that can start a comment line. See
1447 |format-comments|. See |option-backslash| about using backslashes to
1448 insert a space.
1449
1450 *'commentstring'* *'cms'* *E537*
1451'commentstring' 'cms' string (default "/*%s*/")
1452 local to buffer
1453 {not in Vi}
1454 {not available when compiled without the |+folding|
1455 feature}
1456 A template for a comment. The "%s" in the value is replaced with the
1457 comment text. Currently only used to add markers for folding, see
1458 |fold-marker|.
1459
1460 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaard042c562005-06-30 22:04:15 +00001461'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file
1462 is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 global
1464 {not in Vi}
1465 This option has the effect of making Vim either more Vi-compatible, or
1466 make Vim behave in a more useful way.
1467 This is a special kind of option, because when it's set or reset,
1468 other options are also changed as a side effect. CAREFUL: Setting or
1469 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001470 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 set this option in your vimrc file, you should probably put it at the
1472 very start.
1473 By default this option is on and the Vi defaults are used for the
1474 options. This default was chosen for those people who want to use Vim
1475 just like Vi, and don't even (want to) know about the 'compatible'
1476 option.
Bram Moolenaard042c562005-06-30 22:04:15 +00001477 When a ".vimrc" or ".gvimrc" file is found while Vim is starting up,
1478 this option is switched off, and all options that have not been
1479 modified will be set to the Vim defaults. Effectively, this means
1480 that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim
1481 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1482 happen for the system-wide vimrc or gvimrc file). Also see
1483 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001484 You can also set this option with the "-C" argument, and reset it with
1485 "-N". See |-C| and |-N|.
1486 Switching this option off makes the Vim defaults be used for options
1487 that have a different Vi and Vim default value. See the options
1488 marked with a '+' below. Other options are not modified.
1489 At the moment this option is set, several other options will be set
1490 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001491 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 editing.
1493 See also 'cpoptions'.
1494
1495 option + set value effect ~
1496
1497 'allowrevins' off no CTRL-_ command
1498 'backupcopy' Unix: "yes" backup file is a copy
1499 others: "auto" copy or rename backup file
1500 'backspace' "" normal backspace
1501 'backup' off no backup file
1502 'cindent' off no C code indentation
1503 'cedit' + "" no key to open the |cmdwin|
1504 'cpoptions' + (all flags) Vi-compatible flags
1505 'cscopetag' off don't use cscope for ":tag"
1506 'cscopetagorder' 0 see |cscopetagorder|
1507 'cscopeverbose' off see |cscopeverbose|
1508 'digraph' off no digraphs
1509 'esckeys' + off no <Esc>-keys in Insert mode
1510 'expandtab' off tabs not expanded to spaces
1511 'fileformats' + "" no automatic file format detection,
1512 "dos,unix" except for DOS, Windows and OS/2
1513 'formatoptions' + "vt" Vi compatible formatting
1514 'gdefault' off no default 'g' flag for ":s"
1515 'history' + 0 no commandline history
1516 'hkmap' off no Hebrew keyboard mapping
1517 'hkmapp' off no phonetic Hebrew keyboard mapping
1518 'hlsearch' off no highlighting of search matches
1519 'incsearch' off no incremental searching
1520 'indentexpr' "" no indenting by expression
1521 'insertmode' off do not start in Insert mode
1522 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1523 characters and '_'
1524 'joinspaces' on insert 2 spaces after period
1525 'modeline' + off no modelines
1526 'more' + off no pauses in listings
1527 'revins' off no reverse insert
1528 'ruler' off no ruler
1529 'scrolljump' 1 no jump scroll
1530 'scrolloff' 0 no scroll offset
1531 'shiftround' off indent not rounded to shiftwidth
1532 'shortmess' + "" no shortening of messages
1533 'showcmd' + off command characters not shown
1534 'showmode' + off current mode not shown
1535 'smartcase' off no automatic ignore case switch
1536 'smartindent' off no smart indentation
1537 'smarttab' off no smart tab size
1538 'softtabstop' 0 tabs are always 'tabstop' positions
1539 'startofline' on goto startofline with some commands
1540 'tagrelative' + off tag file names are not relative
1541 'textauto' + off no automatic textmode detection
1542 'textwidth' 0 no automatic line wrap
1543 'tildeop' off tilde is not an operator
1544 'ttimeout' off no terminal timeout
1545 'whichwrap' + "" left-right movements don't wrap
1546 'wildchar' + CTRL-E only when the current value is <Tab>
1547 use CTRL-E for cmdline completion
1548 'writebackup' on or off depends on +writebackup feature
1549
1550 *'complete'* *'cpt'* *E535*
1551'complete' 'cpt' string (default: ".,w,b,u,t,i")
1552 local to buffer
1553 {not in Vi}
1554 This option specifies how keyword completion |ins-completion| works
1555 when CTRL-P or CTRL-N are used. It is also used for whole-line
1556 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1557 and the places to scan. It is a comma separated list of flags:
1558 . scan the current buffer ('wrapscan' is ignored)
1559 w scan buffers from other windows
1560 b scan other loaded buffers that are in the buffer list
1561 u scan the unloaded buffers that are in the buffer list
1562 U scan the buffers that are not in the buffer list
1563 k scan the files given with the 'dictionary' option
1564 k{dict} scan the file {dict}. Several "k" flags can be given,
1565 patterns are valid too. For example: >
1566 :set cpt=k/usr/dict/*,k~/spanish
1567< s scan the files given with the 'thesaurus' option
1568 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1569 are valid too.
1570 i scan current and included files
1571 d scan current and included files for defined name or macro
1572 |i_CTRL-X_CTRL-D|
1573 ] tag completion
1574 t same as "]"
1575
1576 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1577 not executed, this may lead to unexpected completions from some files
1578 (gzipped files for example). Unloaded buffers are not scanned for
1579 whole-line completion.
1580
1581 The default is ".,w,b,u,t,i", which means to scan:
1582 1. the current buffer
1583 2. buffers in other windows
1584 3. other loaded buffers
1585 4. unloaded buffers
1586 5. tags
1587 6. included files
1588
1589 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001590 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1591 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001593 *'completefunc'* *'cfu'*
1594'completefunc' 'cfu' string (default: empty)
1595 local to buffer
1596 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001597 {not available when compiled without the +eval
1598 or +insert_expand feature}
1599 This option specifies a function to be used for CTRL-X CTRL-U
1600 completion. |i_CTRL-X_CTRL-U|
1601
Bram Moolenaare344bea2005-09-01 20:46:49 +00001602 The function will be invoked with two arguments. First the function
1603 is called to find the start of the text to be completed. Secondly the
1604 function is called to actually find the matches.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001605
Bram Moolenaare344bea2005-09-01 20:46:49 +00001606 On the first invocation the arguments are:
1607 a:findstart 1
1608 a:base empty
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001609
Bram Moolenaare344bea2005-09-01 20:46:49 +00001610 The function must return the column of where the completion starts.
1611 It must be a number between zero and the cursor column "col('.')".
1612 This involves looking at the characters just before the cursor and
1613 including those characters that could be part of the completed item.
1614 The text between this column and the cursor column will be replaced
1615 with the matches. Return -1 if no completion can be done.
1616
1617 On the second invocation the arguments are:
1618 a:findstart 0
1619 a:base the text with which matches should match, what was
1620 located in the first call
1621
1622 The function must return a List with the matching words. These
1623 matches usually include the "a:base" text. When there are no matches
1624 return an empty List.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001625
Bram Moolenaar572cb562005-08-05 21:35:02 +00001626 When searching for matches takes some time call |complete_add()| to
1627 add each match to the total list. These matches should then not
1628 appear in the returned list! Call |complete_check()| now and then to
1629 allow the user to press a key while still searching for matches. Stop
1630 searching when it returns non-zero.
1631
Bram Moolenaare344bea2005-09-01 20:46:49 +00001632 The function may move the cursor, it is restored afterwards.
Bram Moolenaar572cb562005-08-05 21:35:02 +00001633 This option cannot be set from a |modeline| or in the |sandbox|, for
1634 security reasons.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001635
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001636 An example that completes the names of the months: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001637 fun! CompleteMonths(findstart, base)
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001638 if a:findstart
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001639 " locate the start of the word
1640 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001641 let start = col('.') - 1
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001642 while start > 0 && line[start - 1] =~ '\a'
1643 let start -= 1
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001644 endwhile
1645 return start
1646 else
1647 " find months matching with "a:base"
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001648 let res = []
1649 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1650 if m =~ '^' . a:base
1651 call add(res, m)
1652 endif
1653 endfor
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001654 return res
1655 endif
1656 endfun
1657 set completefunc=CompleteMonths
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001658<
Bram Moolenaar572cb562005-08-05 21:35:02 +00001659 The same, but now pretending searching for matches is slow: >
Bram Moolenaare344bea2005-09-01 20:46:49 +00001660 fun! CompleteMonths(findstart, base)
Bram Moolenaar572cb562005-08-05 21:35:02 +00001661 if a:findstart
1662 " locate the start of the word
1663 let line = getline('.')
Bram Moolenaare344bea2005-09-01 20:46:49 +00001664 let start = col('.') - 1
Bram Moolenaar572cb562005-08-05 21:35:02 +00001665 while start > 0 && line[start - 1] =~ '\a'
1666 let start -= 1
1667 endwhile
1668 return start
1669 else
1670 " find months matching with "a:base"
1671 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec")
1672 if m =~ '^' . a:base
1673 call complete_add(m)
1674 endif
1675 sleep 300m " simulate searching for next match
1676 if complete_check()
1677 break
1678 endif
1679 endfor
1680 return []
1681 endif
1682 endfun
1683 set completefunc=CompleteMonths
1684<
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001685
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1687'confirm' 'cf' boolean (default off)
1688 global
1689 {not in Vi}
1690 When 'confirm' is on, certain operations that would normally
1691 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1692 instead raise a |dialog| asking if you wish to save the current
1693 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1694 If 'confirm' is off you can still activate confirmation for one
1695 command only (this is most useful in mappings) with the |:confirm|
1696 command.
1697 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1698
1699 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1700'conskey' 'consk' boolean (default off)
1701 global
1702 {not in Vi} {only for MS-DOS}
1703 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001704 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 three methods of console input are available:
1706 'conskey' 'bioskey' action ~
1707 on on or off direct console input
1708 off on BIOS
1709 off off STDIN
1710
1711 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1712'copyindent' 'ci' boolean (default off)
1713 local to buffer
1714 {not in Vi}
1715 Copy the structure of the existing lines indent when autoindenting a
1716 new line. Normally the new indent is reconstructed by a series of
1717 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1718 in which case only spaces are used). Enabling this option makes the
1719 new line copy whatever characters were used for indenting on the
1720 existing line. If the new indent is greater than on the existing
1721 line, the remaining space is filled in the normal manner.
1722 NOTE: 'copyindent' is reset when 'compatible' is set.
1723 Also see 'preserveindent'.
1724
1725 *'cpoptions'* *'cpo'*
1726'cpoptions' 'cpo' string (Vim default: "aABceFs",
1727 Vi default: all flags)
1728 global
1729 {not in Vi}
1730 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001731 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 not being vi-compatible is mostly or sometimes preferred.
1733 'cpoptions' stands for "compatible-options".
1734 Commas can be added for readability.
1735 To avoid problems with flags that are added in the future, use the
1736 "+=" and "-=" feature of ":set" |add-option-flags|.
1737 NOTE: This option is set to the Vi default value when 'compatible' is
1738 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001739 NOTE: This option is set to the POSIX default value at startup when
1740 the Vi default value would be used and the $VIM_POSIX environment
1741 variable exists |posix|. This means tries to behave like the POSIX
1742 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001743
1744 contains behavior ~
1745 *cpo-a*
1746 a When included, a ":read" command with a file name
1747 argument will set the alternate file name for the
1748 current window.
1749 *cpo-A*
1750 A When included, a ":write" command with a file name
1751 argument will set the alternate file name for the
1752 current window.
1753 *cpo-b*
1754 b "\|" in a ":map" command is recognized as the end of
1755 the map command. The '\' is included in the mapping,
1756 the text after the '|' is interpreted as the next
1757 command. Use a CTRL-V instead of a backslash to
1758 include the '|' in the mapping. Applies to all
1759 mapping, abbreviation, menu and autocmd commands.
1760 See also |map_bar|.
1761 *cpo-B*
1762 B A backslash has no special meaning in mappings,
1763 abbreviations and the "to" part of the menu commands.
1764 Remove this flag to be able to use a backslash like a
1765 CTRL-V. For example, the command ":map X \<Esc>"
1766 results in X being mapped to:
1767 'B' included: "\^[" (^[ is a real <Esc>)
1768 'B' excluded: "<Esc>" (5 characters)
1769 ('<' excluded in both cases)
1770 *cpo-c*
1771 c Searching continues at the end of any match at the
1772 cursor position, but not further than the start of the
1773 next line. When not present searching continues
1774 one character from the cursor position. With 'c'
1775 "abababababab" only gets three matches when repeating
1776 "/abab", without 'c' there are five matches.
1777 *cpo-C*
1778 C Do not concatenate sourced lines that start with a
1779 backslash. See |line-continuation|.
1780 *cpo-d*
1781 d Using "./" in the 'tags' option doesn't mean to use
1782 the tags file relative to the current file, but the
1783 tags file in the current directory.
1784 *cpo-D*
1785 D Can't use CTRL-K to enter a digraph after Normal mode
1786 commands with a character argument, like |r|, |f| and
1787 |t|.
1788 *cpo-e*
1789 e When executing a register with ":@r", always add a
1790 <CR> to the last line, also when the register is not
1791 linewise. If this flag is not present, the register
1792 is not linewise and the last line does not end in a
1793 <CR>, then the last line is put on the command-line
1794 and can be edited before hitting <CR>.
1795 *cpo-E*
1796 E It is an error when using "y", "d", "c", "g~", "gu" or
1797 "gU" on an Empty region. The operators only work when
1798 at least one character is to be operate on. Example:
1799 This makes "y0" fail in the first column.
1800 *cpo-f*
1801 f When included, a ":read" command with a file name
1802 argument will set the file name for the current buffer,
1803 if the current buffer doesn't have a file name yet.
1804 *cpo-F*
1805 F When included, a ":write" command with a file name
1806 argument will set the file name for the current
1807 buffer, if the current buffer doesn't have a file name
1808 yet.
1809 *cpo-g*
1810 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001811 *cpo-H*
1812 H When using "I" on a line with only blanks, insert
1813 before the last blank. Without this flag insert after
1814 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 *cpo-i*
1816 i When included, interrupting the reading of a file will
1817 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001818 *cpo-I*
1819 I When moving the cursor up or down just after inserting
1820 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 *cpo-j*
1822 j When joining lines, only add two spaces after a '.',
1823 not after '!' or '?'. Also see 'joinspaces'.
1824 *cpo-J*
1825 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001826 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 white space.
1828 *cpo-k*
1829 k Disable the recognition of raw key codes in
1830 mappings, abbreviations, and the "to" part of menu
1831 commands. For example, if <Key> sends ^[OA (where ^[
1832 is <Esc>), the command ":map X ^[OA" results in X
1833 being mapped to:
1834 'k' included: "^[OA" (3 characters)
1835 'k' excluded: "<Key>" (one key code)
1836 Also see the '<' flag below.
1837 *cpo-K*
1838 K Don't wait for a key code to complete when it is
1839 halfway a mapping. This breaks mapping <F1><F1> when
1840 only part of the second <F1> has been read. It
1841 enables cancelling the mapping by typing <F1><Esc>.
1842 *cpo-l*
1843 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001844 literally, only "\]", "\^", "\-" and "\\" are special.
1845 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1847 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001848 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 *cpo-L*
1850 L When the 'list' option is set, 'wrapmargin',
1851 'textwidth', 'softtabstop' and Virtual Replace mode
1852 (see |gR|) count a <Tab> as two characters, instead of
1853 the normal behavior of a <Tab>.
1854 *cpo-m*
1855 m When included, a showmatch will always wait half a
1856 second. When not included, a showmatch will wait half
1857 a second or until a character is typed. |'showmatch'|
1858 *cpo-M*
1859 M When excluded, "%" matching will take backslashes into
1860 account. Thus in "( \( )" and "\( ( \)" the outer
1861 parenthesis match. When included "%" ignores
1862 backslashes, which is Vi compatible.
1863 *cpo-n*
1864 n When included, the column used for 'number' will also
1865 be used for text of wrapped lines.
1866 *cpo-o*
1867 o Line offset to search command is not remembered for
1868 next search.
1869 *cpo-O*
1870 O Don't complain if a file is being overwritten, even
1871 when it didn't exist when editing it. This is a
1872 protection against a file unexpectedly created by
1873 someone else. Vi didn't complain about this.
1874 *cpo-p*
1875 p Vi compatible Lisp indenting. When not present, a
1876 slightly better algorithm is used.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001877 *cpo-q*
1878 q When joining multiple lines leave the cursor at the
1879 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 *cpo-r*
1881 r Redo ("." command) uses "/" to repeat a search
1882 command, instead of the actually used search string.
1883 *cpo-R*
1884 R Remove marks from filtered lines. Without this flag
1885 marks are kept like |:keepmarks| was used.
1886 *cpo-s*
1887 s Set buffer options when entering the buffer for the
1888 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001889 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 set when the buffer is created.
1891 *cpo-S*
1892 S Set buffer options always when entering a buffer
1893 (except 'readonly', 'fileformat', 'filetype' and
1894 'syntax'). This is the (most) Vi compatible setting.
1895 The options are set to the values in the current
1896 buffer. When you change an option and go to another
1897 buffer, the value is copied. Effectively makes the
1898 buffer options global to all buffers.
1899
1900 's' 'S' copy buffer options
1901 no no when buffer created
1902 yes no when buffer first entered (default)
1903 X yes each time when buffer entered (vi comp.)
1904 *cpo-t*
1905 t Search pattern for the tag command is remembered for
1906 "n" command. Otherwise Vim only puts the pattern in
1907 the history for search pattern, but doesn't change the
1908 last used search pattern.
1909 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001910 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 *cpo-v*
1912 v Backspaced characters remain visible on the screen in
1913 Insert mode. Without this flag the characters are
1914 erased from the screen right away. With this flag the
1915 screen newly typed text overwrites backspaced
1916 characters.
1917 *cpo-w*
1918 w When using "cw" on a blank character, only change one
1919 character and not all blanks until the start of the
1920 next word.
1921 *cpo-W*
1922 W Don't overwrite a readonly file. When omitted, ":w!"
1923 overwrites a readonly file, if possible.
1924 *cpo-x*
1925 x <Esc> on the command-line executes the command-line.
1926 The default in Vim is to abandon the command-line,
1927 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001928 *cpo-X*
1929 X When using a count with "R" the replaced text is
1930 deleted only once. Also when repeating "R" with "."
1931 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 *cpo-y*
1933 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001934 *cpo-Z*
1935 Z When using "w!" while the 'readonly' option is set,
1936 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001937 *cpo-!*
1938 ! When redoing a filter command, use the last used
1939 external command, whatever it was. Otherwise the last
1940 used -filter- command is used.
1941 *cpo-$*
1942 $ When making a change to one line, don't redisplay the
1943 line, but put a '$' at the end of the changed text.
1944 The changed text will be overwritten when you type the
1945 new text. The line is redisplayed if you type any
1946 command that moves the cursor from the insertion
1947 point.
1948 *cpo-%*
1949 % Vi-compatible matching is done for the "%" command.
1950 Does not recognize "#if", "#endif", etc.
1951 Does not recognize "/*" and "*/".
1952 Parens inside single and double quotes are also
1953 counted, causing a string that contains a paren to
1954 disturb the matching. For example, in a line like
1955 "if (strcmp("foo(", s))" the first paren does not
1956 match the last one. When this flag is not included,
1957 parens inside single and double quotes are treated
1958 specially. When matching a paren outside of quotes,
1959 everything inside quotes is ignored. When matching a
1960 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001961 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001962 This flag is also used for other features, such as
1963 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001964 *cpo--*
1965 - When included, a vertical movement command fails when
1966 it would above the first line or below the last line.
1967 Without it the cursor moves to the first or last line,
1968 unless it already was in that line.
1969 Applies to the commands "-", "k", CTRL-P, "+", "j",
1970 CTRL-N and CTRL-J.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001971 *cpo-+*
1972 + When included, a ":write file" command will reset the
1973 'modified' flag of the buffer, even though the buffer
1974 itself may still be different from its file.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001975 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001976 * Use ":*" in the same way as ":@". When not included,
1977 ":*" is an alias for ":'<,'>", select the Visual area.
1978 *cpo-<*
1979 < Disable the recognition of special key codes in |<>|
1980 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001981 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 ":map X <Tab>" results in X being mapped to:
1983 '<' included: "<Tab>" (5 characters)
1984 '<' excluded: "^I" (^I is a real <Tab>)
1985 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001986 *cpo->*
1987 > When appending to a register, put a line break before
1988 the appended text.
1989
1990 POSIX flags. These are not included in the Vi default value, except
1991 when $VIM_POSIX was set on startup. |posix|
1992
1993 contains behavior ~
1994 *cpo-#*
1995 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001996 *cpo-&*
1997 & When ":preserve" was used keep the swap file when
1998 exiting normally while this buffer is still loaded.
1999 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002000 *cpo-\*
2001 \ Backslash in a [] range in a search pattern is taken
2002 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002003 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2004 '\' excluded: "/[ \-]" finds <Space> and '-'
2005 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002006 *cpo-/*
2007 / When "%" is used as the replacement string in a |:s|
2008 command, use the previous replacement string. |:s%|
2009 *cpo-{*
2010 { The |{| and |}| commands also stop at a "{" character
2011 at the start of a line.
2012 *cpo-.*
2013 . The ":chdir" and ":cd" commands fail if the current
2014 buffer is modified, unless ! is used. Vim doesn't
2015 need this, since it remembers the full path of an
2016 opened file.
2017 *cpo-bar*
2018 | The value of the $LINES and $COLUMNS environment
2019 variables overrule the terminal size values obtained
2020 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002021
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022
2023 *'cscopepathcomp'* *'cspc'*
2024'cscopepathcomp' 'cspc' number (default 0)
2025 global
2026 {not available when compiled without the |+cscope|
2027 feature}
2028 {not in Vi}
2029 Determines how many components of the path to show in a list of tags.
2030 See |cscopepathcomp|.
2031
2032 *'cscopeprg'* *'csprg'*
2033'cscopeprg' 'csprg' string (default "cscope")
2034 global
2035 {not available when compiled without the |+cscope|
2036 feature}
2037 {not in Vi}
2038 Specifies the command to execute cscope. See |cscopeprg|.
2039 This option cannot be set from a |modeline| or in the |sandbox|, for
2040 security reasons.
2041
2042 *'cscopequickfix'* *'csqf'*
2043'cscopequickfix' 'csqf' string (default "")
2044 global
2045 {not available when compiled without the |+cscope|
2046 or |+quickfix| features}
2047 {not in Vi}
2048 Specifies whether to use quickfix window to show cscope results.
2049 See |cscopequickfix|.
2050
2051 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2052'cscopetag' 'cst' boolean (default off)
2053 global
2054 {not available when compiled without the |+cscope|
2055 feature}
2056 {not in Vi}
2057 Use cscope for tag commands. See |cscope-options|.
2058 NOTE: This option is reset when 'compatible' is set.
2059
2060 *'cscopetagorder'* *'csto'*
2061'cscopetagorder' 'csto' number (default 0)
2062 global
2063 {not available when compiled without the |+cscope|
2064 feature}
2065 {not in Vi}
2066 Determines the order in which ":cstag" performs a search. See
2067 |cscopetagorder|.
2068 NOTE: This option is set to 0 when 'compatible' is set.
2069
2070 *'cscopeverbose'* *'csverb'*
2071 *'nocscopeverbose'* *'nocsverb'*
2072'cscopeverbose' 'csverb' boolean (default off)
2073 global
2074 {not available when compiled without the |+cscope|
2075 feature}
2076 {not in Vi}
2077 Give messages when adding a cscope database. See |cscopeverbose|.
2078 NOTE: This option is reset when 'compatible' is set.
2079
2080 *'debug'*
2081'debug' string (default "")
2082 global
2083 {not in Vi}
2084 When set to "msg", error messages that would otherwise be omitted will
2085 be given anyway. This is useful when debugging 'foldexpr' or
2086 'indentexpr'.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002087 When set to "beep", a message will be given when otherwise only a beep
2088 would be produced.
2089 The values can be combined, separated by a comma.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090
2091 *'define'* *'def'*
2092'define' 'def' string (default "^\s*#\s*define")
2093 global or local to buffer |global-local|
2094 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002095 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 pattern, just like for the "/" command. This option is used for the
2097 commands like "[i" and "[d" |include-search|. The 'isident' option is
2098 used to recognize the defined name after the match:
2099 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2100 See |option-backslash| about inserting backslashes to include a space
2101 or backslash.
2102 The default value is for C programs. For C++ this value would be
2103 useful, to include const type declarations: >
2104 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2105< When using the ":set" command, you need to double the backslashes!
2106
2107 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2108'delcombine' 'deco' boolean (default off)
2109 global
2110 {not in Vi}
2111 {only available when compiled with the |+multi_byte|
2112 feature}
2113 If editing Unicode and this option is set, backspace and Normal mode
2114 "x" delete each combining character on its own. When it is off (the
2115 default) the character along with its combining characters are
2116 deleted.
2117 Note: When 'delcombine' is set "xx" may work different from "2x"!
2118
2119 This is useful for Arabic, Hebrew and many other languages where one
2120 may have combining characters overtop of base characters, and want
2121 to remove only the combining ones.
2122
2123 *'dictionary'* *'dict'*
2124'dictionary' 'dict' string (default "")
2125 global or local to buffer |global-local|
2126 {not in Vi}
2127 List of file names, separated by commas, that are used to lookup words
2128 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2129 contain a list of words. This can be one word per line, or several
2130 words per line, separated by non-keyword characters (white space is
2131 preferred). Maximum line length is 510 bytes.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002132 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 after a comma are ignored, otherwise spaces are included in the file
2134 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002135 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 Where to find a list of words?
2137 - On FreeBSD, there is the file "/usr/share/dict/words".
2138 - In the Simtel archive, look in the "msdos/linguist" directory.
2139 - In "miscfiles" of the GNU collection.
2140 The use of |:set+=| and |:set-=| is preferred when adding or removing
2141 directories from the list. This avoids problems when a future version
2142 uses another default.
2143 Backticks cannot be used in this option for security reasons.
2144
2145 *'diff'* *'nodiff'*
2146'diff' boolean (default off)
2147 local to window
2148 {not in Vi}
2149 {not available when compiled without the |+diff|
2150 feature}
2151 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002152 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153
2154 *'dex'* *'diffexpr'*
2155'diffexpr' 'dex' string (default "")
2156 global
2157 {not in Vi}
2158 {not available when compiled without the |+diff|
2159 feature}
2160 Expression which is evaluated to obtain an ed-style diff file from two
2161 versions of a file. See |diff-diffexpr|.
2162 This option cannot be set from a |modeline| or in the |sandbox|, for
2163 security reasons.
2164
2165 *'dip'* *'diffopt'*
2166'diffopt' 'dip' string (default "filler")
2167 global
2168 {not in Vi}
2169 {not available when compiled without the |+diff|
2170 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002171 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 All are optional. Items must be separated by a comma.
2173
2174 filler Show filler lines, to keep the text
2175 synchronized with a window that has inserted
2176 lines at the same position. Mostly useful
2177 when windows are side-by-side and 'scrollbind'
2178 is set.
2179
2180 context:{n} Use a context of {n} lines between a change
2181 and a fold that contains unchanged lines.
2182 When omitted a context of six lines is used.
2183 See |fold-diff|.
2184
2185 icase Ignore changes in case of text. "a" and "A"
2186 are considered the same. Adds the "-i" flag
2187 to the "diff" command if 'diffexpr' is empty.
2188
2189 iwhite Ignore changes in amount of white space. Adds
2190 the "-b" flag to the "diff" command if
2191 'diffexpr' is empty. Check the documentation
2192 of the "diff" command for what this does
2193 exactly. It should ignore adding trailing
2194 white space, but not leading white space.
2195
2196 Examples: >
2197
2198 :set diffopt=filler,context:4
2199 :set diffopt=
2200 :set diffopt=filler
2201<
2202 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2203'digraph' 'dg' boolean (default off)
2204 global
2205 {not in Vi}
2206 {not available when compiled without the |+digraphs|
2207 feature}
2208 Enable the entering of digraphs in Insert mode with {char1} <BS>
2209 {char2}. See |digraphs|.
2210 NOTE: This option is reset when 'compatible' is set.
2211
2212 *'directory'* *'dir'*
2213'directory' 'dir' string (default for Amiga: ".,t:",
2214 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2215 for Unix: ".,~/tmp,/var/tmp,/tmp")
2216 global
2217 List of directory names for the swap file, separated with commas.
2218 - The swap file will be created in the first directory where this is
2219 possible.
2220 - Empty means that no swap file will be used (recovery is
2221 impossible!).
2222 - A directory "." means to put the swap file in the same directory as
2223 the edited file. On Unix, a dot is prepended to the file name, so
2224 it doesn't show in a directory listing. On MS-Windows the "hidden"
2225 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002226 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 put the swap file relative to where the edited file is. The leading
2228 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002229 - For Unix and Win32, if a directory ends in two path separators "//"
2230 or "\\", the swap file name will be built from the complete path to
2231 the file with all path separators substituted to percent '%' signs.
2232 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233 - Spaces after the comma are ignored, other spaces are considered part
2234 of the directory name. To have a space at the start of a directory
2235 name, precede it with a backslash.
2236 - To include a comma in a directory name precede it with a backslash.
2237 - A directory name may end in an ':' or '/'.
2238 - Environment variables are expanded |:set_env|.
2239 - Careful with '\' characters, type one before a space, type two to
2240 get one in the option (see |option-backslash|), for example: >
2241 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2242< - For backwards compatibility with Vim version 3.0 a '>' at the start
2243 of the option is removed.
2244 Using "." first in the list is recommended. This means that editing
2245 the same file twice will result in a warning. Using "/tmp" on Unix is
2246 discouraged: When the system crashes you lose the swap file.
2247 "/var/tmp" is often not cleared when rebooting, thus is a better
2248 choice than "/tmp". But it can contain a lot of files, your swap
2249 files get lost in the crowd. That is why a "tmp" directory in your
2250 home directory is tried first.
2251 The use of |:set+=| and |:set-=| is preferred when adding or removing
2252 directories from the list. This avoids problems when a future version
2253 uses another default.
2254 This option cannot be set from a |modeline| or in the |sandbox|, for
2255 security reasons.
2256 {Vi: directory to put temp file in, defaults to "/tmp"}
2257
2258 *'display'* *'dy'*
2259'display' 'dy' string (default "")
2260 global
2261 {not in Vi}
2262 Change the way text is displayed. This is comma separated list of
2263 flags:
2264 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002265 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 last line that doesn't fit is replaced with "@" lines.
2267 uhex Show unprintable characters hexadecimal as <xx>
2268 instead of using ^C and ~C.
2269
2270 *'eadirection'* *'ead'*
2271'eadirection' 'ead' string (default "both")
2272 global
2273 {not in Vi}
2274 {not available when compiled without the +vertsplit
2275 feature}
2276 Tells when the 'equalalways' option applies:
2277 ver vertically, width of windows is not affected
2278 hor horizontally, height of windows is not affected
2279 both width and height of windows is affected
2280
2281 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2282'edcompatible' 'ed' boolean (default off)
2283 global
2284 Makes the 'g' and 'c' flags of the ":substitute" command to be
2285 toggled each time the flag is given. See |complex-change|. See
2286 also 'gdefault' option.
2287 Switching this option on is discouraged!
2288
2289 *'encoding'* *'enc'* *E543*
2290'encoding' 'enc' string (default: "latin1" or value from $LANG)
2291 global
2292 {only available when compiled with the |+multi_byte|
2293 feature}
2294 {not in Vi}
2295 Sets the character encoding used inside Vim. It applies to text in
2296 the buffers, registers, Strings in expressions, text stored in the
2297 viminfo file, etc. It sets the kind of characters which Vim can work
2298 with. See |encoding-names| for the possible values.
2299
2300 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002301 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 It should normally be kept at its default value, or set when Vim
2303 starts up. See |multibyte|.
2304
2305 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2306 "utf-8". Although care has been taken to allow different values of
2307 'encoding', "utf-8" is the natural choice for the environment and
2308 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002309 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002310 versions, and to avoid changing the encoding of newly created files
2311 without your knowledge (in case 'fileencodings' is empty).
2312
2313 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002314 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 iconv() or as specified with 'charconvert'.
2316
2317 Normally 'encoding' will be equal to your current locale. This will
2318 be the default if Vim recognizes your environment settings. If
2319 'encoding' is not set to the current locale, 'termencoding' must be
2320 set to convert typed and displayed text. See |encoding-table|.
2321
2322 When you set this option, it fires the |EncodingChanged| autocommand
2323 event so that you can set up fonts if necessary.
2324
2325 When the option is set, the value is converted to lowercase. Thus
2326 you can set it with uppercase values too. Underscores are translated
2327 to '-' signs.
2328 When the encoding is recognized, it is changed to the standard name.
2329 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2330 "iso-8859-2" and "utf8" becomes "utf-8".
2331
2332 Note: "latin1" is also used when the encoding could not be detected.
2333 This only works when editing files in the same encoding! When the
2334 actual character set is not latin1, make sure 'fileencoding' and
2335 'fileencodings' are empty. When conversion is needed, switch to using
2336 utf-8.
2337
2338 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2339 You don't notice this while editing, but it does matter for the
2340 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2341 setting 'encoding' to one of these values instead of utf-8 only has
2342 effect for encoding used for files when 'fileencoding' is empty.
2343
Bram Moolenaar661b1822005-07-28 22:36:45 +00002344 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2345 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346
2347 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2348'endofline' 'eol' boolean (default on)
2349 local to buffer
2350 {not in Vi}
2351 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 option is automatically set when starting to edit a new file, unless
2354 the file does not have an <EOL> for the last line in the file, in
2355 which case it is reset. Normally you don't have to set or reset this
2356 option. When 'binary' is off the value is not used when writing the
2357 file. When 'binary' is on it is used to remember the presence of a
2358 <EOL> for the last line in the file, so that when you write the file
2359 the situation from the original file can be kept. But you can change
2360 it if you want to.
2361
2362 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2363'equalalways' 'ea' boolean (default on)
2364 global
2365 {not in Vi}
2366 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002367 splitting or closing a window. This also happens the moment the
2368 option is switched on. When off, splitting a window will reduce the
2369 size of the current window and leave the other windows the same. When
2370 closing a window the extra lines are given to the window next to it
2371 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 When mixing vertically and horizontally split windows, a minimal size
2373 is computed and some windows may be larger if there is room. The
2374 'eadirection' option tells in which direction the size is affected.
2375 Changing the height of a window can be avoided by setting
2376 'winfixheight'.
2377
2378 *'equalprg'* *'ep'*
2379'equalprg' 'ep' string (default "")
2380 global or local to buffer |global-local|
2381 {not in Vi}
2382 External program to use for "=" command. When this option is empty
2383 the internal formatting functions are used ('lisp', 'cindent' or
2384 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002385 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 about including spaces and backslashes.
2387 This option cannot be set from a |modeline| or in the |sandbox|, for
2388 security reasons.
2389
2390 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2391'errorbells' 'eb' boolean (default off)
2392 global
2393 Ring the bell (beep or screen flash) for error messages. This only
2394 makes a difference for error messages, the bell will be used always
2395 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002396 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 screen flash or do nothing.
2398
2399 *'errorfile'* *'ef'*
2400'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2401 others: "errors.err")
2402 global
2403 {not in Vi}
2404 {not available when compiled without the |+quickfix|
2405 feature}
2406 Name of the errorfile for the QuickFix mode (see |:cf|).
2407 When the "-q" command-line argument is used, 'errorfile' is set to the
2408 following argument. See |-q|.
2409 NOT used for the ":make" command. See 'makeef' for that.
2410 Environment variables are expanded |:set_env|.
2411 See |option-backslash| about including spaces and backslashes.
2412 This option cannot be set from a |modeline| or in the |sandbox|, for
2413 security reasons.
2414
2415 *'errorformat'* *'efm'*
2416'errorformat' 'efm' string (default is very long)
2417 global or local to buffer |global-local|
2418 {not in Vi}
2419 {not available when compiled without the |+quickfix|
2420 feature}
2421 Scanf-like description of the format for the lines in the error file
2422 (see |errorformat|).
2423
2424 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2425'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2426 global
2427 {not in Vi}
2428 Function keys that start with an <Esc> are recognized in Insert
2429 mode. When this option is off, the cursor and function keys cannot be
2430 used in Insert mode if they start with an <Esc>. The advantage of
2431 this is that the single <Esc> is recognized immediately, instead of
2432 after one second. Instead of resetting this option, you might want to
2433 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2434 when 'esckeys' is off, you can still map anything, but the cursor keys
2435 won't work by default.
2436 NOTE: This option is set to the Vi default value when 'compatible' is
2437 set and to the Vim default value when 'compatible' is reset.
2438
2439 *'eventignore'* *'ei'*
2440'eventignore' 'ei' string (default "")
2441 global
2442 {not in Vi}
2443 {not available when compiled without the |+autocmd|
2444 feature}
2445 A list of autocommand event names, which are to be ignored.
2446 When set to "all", all autocommand events are ignored, autocommands
2447 will not be executed.
2448 Otherwise this is a comma separated list of event names. Example: >
2449 :set ei=WinEnter,WinLeave
2450<
2451 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2452'expandtab' 'et' boolean (default off)
2453 local to buffer
2454 {not in Vi}
2455 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002456 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2458 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2459 NOTE: This option is reset when 'compatible' is set.
2460
2461 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2462'exrc' 'ex' boolean (default off)
2463 global
2464 {not in Vi}
2465 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2466 directory. If you switch this option on you should also consider
2467 setting the 'secure' option (see |initialization|). Using a local
2468 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2469 also see |.vimrc| and |gui-init|.
2470 This option cannot be set from a |modeline| or in the |sandbox|, for
2471 security reasons.
2472
2473 *'fileencoding'* *'fenc'* *E213*
2474'fileencoding' 'fenc' string (default: "")
2475 local to buffer
2476 {only available when compiled with the |+multi_byte|
2477 feature}
2478 {not in Vi}
2479 Sets the character encoding for the file of this buffer.
2480 When 'fileencoding' is different from 'encoding', conversion will be
2481 done when reading and writing the file.
2482 When 'fileencoding' is empty, the same value as 'encoding' will be
2483 used (no conversion when reading or writing a file).
2484 WARNING: Conversion can cause loss of information! When
2485 'encoding' is "utf-8" conversion is most likely done in a way
2486 that the reverse conversion results in the same text. When
2487 'encoding' is not "utf-8" some characters may be lost!
2488 See 'encoding' for the possible values. Additionally, values may be
2489 specified that can be handled by the converter, see
2490 |mbyte-conversion|.
2491 When reading a file 'fileencoding' will be set from 'fileencodings'.
2492 To read a file in a certain encoding it won't work by setting
2493 'fileencoding', use the |++enc| argument.
2494 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2495 When the option is set, the value is converted to lowercase. Thus
2496 you can set it with uppercase values too. '_' characters are
2497 replaced with '-'. If a name is recognized from the list for
2498 'encoding', it is replaced by the standard name. For example
2499 "ISO8859-2" becomes "iso-8859-2".
2500 When this option is set, after starting to edit a file, the 'modified'
2501 option is set, because the file would be different when written.
2502 If you do this in a modeline, you might want to set 'nomodified' to
2503 avoid this.
2504 This option can not be changed when 'modifiable' is off.
2505
2506 *'fe'*
2507 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002508 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 old short name was 'fe', which is no longer used.
2510
2511 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002512'fileencodings' 'fencs' string (default: "ucs-bom",
2513 "ucs-bom,utf-8,default,latin1" when
2514 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 global
2516 {only available when compiled with the |+multi_byte|
2517 feature}
2518 {not in Vi}
2519 This is a list of character encodings considered when starting to edit
2520 an existing file. When a file is read, Vim tries to use the first
2521 mentioned character encoding. If an error is detected, the next one
2522 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002523 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524 an empty string, which means the value of 'encoding' is used.
2525 WARNING: Conversion can cause loss of information! When
2526 'encoding' is "utf-8" (or one of the other Unicode variants)
2527 conversion is most likely done in a way that the reverse
2528 conversion results in the same text. When 'encoding' is not
2529 "utf-8" special characters may be lost!
2530 For an empty file or a file with only ASCII characters most encodings
2531 will work and the first entry of 'fileencodings' will be used (except
2532 "ucs-bom", which requires the BOM to be present). If you prefer
2533 another encoding use an BufReadPost autocommand event to test if your
2534 preferred encoding is to be used. Example: >
2535 au BufReadPost * if search('\S', 'w') == 0 |
2536 \ set fenc=iso-2022-jp | endif
2537< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2538 non-blank characters.
2539 Note that 'fileencodings' is not used for an new file, 'fileencoding'
2540 is always empty then. This means that a non-existing file may get a
2541 different encoding than an empty file.
2542 The special value "ucs-bom" can be used to check for a Unicode BOM
2543 (Byte Order Mark) at the start of the file. It must not be preceded
2544 by "utf-8" or another Unicode encoding for this to work properly.
2545 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2546 because Vim cannot detect an error, thus the encoding is always
2547 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002548 The special value "default" can be used for the encoding from the
2549 environment. This is the default value for 'encoding'. It is useful
2550 when 'encoding' is set to "utf-8" and your environment uses a
2551 non-latin1 encoding, such as Russian.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 WRONG VALUES: WHAT'S WRONG:
2553 latin1,utf-8 "latin1" will always be used
2554 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2555 file
2556 cp1250,latin1 "cp1250" will always be used
2557 If 'fileencodings' is empty, 'fileencoding' is not modified.
2558 See 'fileencoding' for the possible values.
2559 Setting this option does not have an effect until the next time a file
2560 is read.
2561
2562 *'fileformat'* *'ff'*
2563'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2564 Unix default: "unix",
2565 Macintosh default: "mac")
2566 local to buffer
2567 {not in Vi}
2568 This gives the <EOL> of the current buffer, which is used for
2569 reading/writing the buffer from/to a file:
2570 dos <CR> <NL>
2571 unix <NL>
2572 mac <CR>
2573 When "dos" is used, CTRL-Z at the end of a file is ignored.
2574 See |file-formats| and |file-read|.
2575 For the character encoding of the file see 'fileencoding'.
2576 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2577 works like it was set to "unix'.
2578 This option is set automatically when starting to edit a file and
2579 'fileformats' is not empty and 'binary' is off.
2580 When this option is set, after starting to edit a file, the 'modified'
2581 option is set, because the file would be different when written.
2582 This option can not be changed when 'modifiable' is off.
2583 For backwards compatibility: When this option is set to "dos",
2584 'textmode' is set, otherwise 'textmode' is reset.
2585
2586 *'fileformats'* *'ffs'*
2587'fileformats' 'ffs' string (default:
2588 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2589 Vim Unix: "unix,dos",
2590 Vim Mac: "mac,unix,dos",
2591 Vi Cygwin: "unix,dos",
2592 Vi others: "")
2593 global
2594 {not in Vi}
2595 This gives the end-of-line (<EOL>) formats that will be tried when
2596 starting to edit a new buffer and when reading a file into an existing
2597 buffer:
2598 - When empty, the format defined with 'fileformat' will be used
2599 always. It is not set automatically.
2600 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002601 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 'fileformats' name will be used when a file is read into an existing
2603 buffer, no matter what 'fileformat' for that buffer is set to.
2604 - When more than one name is present, separated by commas, automatic
2605 <EOL> detection will be done when reading a file. When starting to
2606 edit a file, a check is done for the <EOL>:
2607 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2608 'fileformat' is set to "dos".
2609 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002610 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 preceding <CR>, "unix" is preferred over "dos".
2612 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2613 This means that "mac" is only chosen when "unix" is not present,
2614 or when no <NL> is found in the file, and when "dos" is not
2615 present, or no <CR><NL> is present in the file.
2616 Also if "unix" was first chosen, but the first <CR> is before
2617 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2618 the file, then 'fileformat' is set to "mac".
2619 4. If 'fileformat' is still not set, the first name from
2620 'fileformats' is used.
2621 When reading a file into an existing buffer, the same is done, but
2622 this happens like 'fileformat' has been set appropriately for that
2623 file only, the option is not changed.
2624 When 'binary' is set, the value of 'fileformats' is not used.
2625
2626 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2627 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2628 done:
2629 - When 'fileformats' is empty, there is no automatic detection. Dos
2630 format will be used.
2631 - When 'fileformats' is set to one or more names, automatic detection
2632 is done. This is based on the first <NL> in the file: If there is a
2633 <CR> in front of it, Dos format is used, otherwise Unix format is
2634 used.
2635 Also see |file-formats|.
2636 For backwards compatibility: When this option is set to an empty
2637 string or one format (no comma is included), 'textauto' is reset,
2638 otherwise 'textauto' is set.
2639 NOTE: This option is set to the Vi default value when 'compatible' is
2640 set and to the Vim default value when 'compatible' is reset.
2641
2642 *'filetype'* *'ft'*
2643'filetype' 'ft' string (default: "")
2644 local to buffer
2645 {not in Vi}
2646 {not available when compiled without the |+autocmd|
2647 feature}
2648 When this option is set, the FileType autocommand event is triggered.
2649 All autocommands that match with the value of this option will be
2650 executed. Thus the value of 'filetype' is used in place of the file
2651 name.
2652 Otherwise this option does not always reflect the current file type.
2653 This option is normally set when the file type is detected. To enable
2654 this use the ":filetype on" command. |:filetype|
2655 Setting this option to a different value is most useful in a modeline,
2656 for a file for which the file type is not automatically recognized.
2657 Example, for in an IDL file: >
2658 /* vim: set filetype=idl : */
2659< |FileType| |filetypes|
2660 Do not confuse this option with 'osfiletype', which is for the file
2661 type that is actually stored with the file.
2662 This option is not copied to another buffer, independent of the 's' or
2663 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002664 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665
2666 *'fillchars'* *'fcs'*
2667'fillchars' 'fcs' string (default "vert:|,fold:-")
2668 global
2669 {not in Vi}
2670 {not available when compiled without the |+windows|
2671 and |+folding| features}
2672 Characters to fill the statuslines and vertical separators.
2673 It is a comma separated list of items:
2674
2675 item default Used for ~
2676 stl:c ' ' or '^' statusline of the current window
2677 stlnc:c ' ' or '-' statusline of the non-current windows
2678 vert:c '|' vertical separators |:vsplit|
2679 fold:c '-' filling 'foldtext'
2680 diff:c '-' deleted lines of the 'diff' option
2681
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002682 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 "stlnc" the space will be used when there is highlighting, '^' or '-'
2684 otherwise.
2685
2686 Example: >
2687 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2688< This is similar to the default, except that these characters will also
2689 be used when there is highlighting.
2690
2691 The highlighting used for these items:
2692 item highlight group ~
2693 stl:c StatusLine |hl-StatusLine|
2694 stlnc:c StatusLineNC |hl-StatusLineNC|
2695 vert:c VertSplit |hl-VertSplit|
2696 fold:c Folded |hl-Folded|
2697 diff:c DiffDelete |hl-DiffDelete|
2698
2699 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2700'fkmap' 'fk' boolean (default off) *E198*
2701 global
2702 {not in Vi}
2703 {only available when compiled with the |+rightleft|
2704 feature}
2705 When on, the keyboard is mapped for the Farsi character set.
2706 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002707 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708
2709 *'foldclose'* *'fcl'*
2710'foldclose' 'fcl' string (default "")
2711 global
2712 {not in Vi}
2713 {not available when compiled without the |+folding|
2714 feature}
2715 When set to "all", a fold is closed when the cursor isn't in it and
2716 its level is higher than 'foldlevel'. Useful if you want folds to
2717 automatically close when moving out of them.
2718
2719 *'foldcolumn'* *'fdc'*
2720'foldcolumn' 'fdc' number (default 0)
2721 local to window
2722 {not in Vi}
2723 {not available when compiled without the |+folding|
2724 feature}
2725 When non-zero, a column with the specified width is shown at the side
2726 of the window which indicates open and closed folds. The maximum
2727 value is 12.
2728 See |folding|.
2729
2730 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2731'foldenable' 'fen' boolean (default on)
2732 local to window
2733 {not in Vi}
2734 {not available when compiled without the |+folding|
2735 feature}
2736 When off, all folds are open. This option can be used to quickly
2737 switch between showing all text unfolded and viewing the text with
2738 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002739 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 'foldenable' is off.
2741 This option is set by commands that create a new fold or close a fold.
2742 See |folding|.
2743
2744 *'foldexpr'* *'fde'*
2745'foldexpr' 'fde' string (default: "0")
2746 local to window
2747 {not in Vi}
2748 {not available when compiled without the |+folding|
2749 or |+eval| feature}
2750 The expression used for when 'foldmethod' is "expr". It is evaluated
2751 for each line to obtain its fold level. See |fold-expr|. Also see
2752 |eval-sandbox|.
2753
2754 *'foldignore'* *'fdi'*
2755'foldignore' 'fdi' string (default: "#")
2756 local to window
2757 {not in Vi}
2758 {not available when compiled without the |+folding|
2759 feature}
2760 Used only when 'foldmethod' is "indent". Lines starting with
2761 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002762 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 The default "#" works well for C programs. See |fold-indent|.
2764
2765 *'foldlevel'* *'fdl'*
2766'foldlevel' 'fdl' number (default: 0)
2767 local to window
2768 {not in Vi}
2769 {not available when compiled without the |+folding|
2770 feature}
2771 Sets the fold level: Folds with a higher level will be closed.
2772 Setting this option to zero will close all folds. Higher numbers will
2773 close fewer folds.
2774 This option is set by commands like |zm|, |zM| and |zR|.
2775 See |fold-foldlevel|.
2776
2777 *'foldlevelstart'* *'fdls'*
2778'foldlevelstart' 'fdls' number (default: -1)
2779 global
2780 {not in Vi}
2781 {not available when compiled without the |+folding|
2782 feature}
2783 Sets 'foldlevel' when starting to edit another buffer in a window.
2784 Useful to always start editing with all folds closed (value zero),
2785 some folds closed (one) or no folds closed (99).
2786 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002787 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 ignores this option and closes all folds.
2789 It is also done before BufReadPre autocommands, to allow an autocmd to
2790 overrule the 'foldlevel' value for specific files.
2791 When the value is negative, it is not used.
2792
2793 *'foldmarker'* *'fmr'* *E536*
2794'foldmarker' 'fmr' string (default: "{{{,}}}")
2795 local to window
2796 {not in Vi}
2797 {not available when compiled without the |+folding|
2798 feature}
2799 The start and end marker used when 'foldmethod' is "marker". There
2800 must be one comma, which separates the start and end marker. The
2801 marker is a literal string (a regular expression would be too slow).
2802 See |fold-marker|.
2803
2804 *'foldmethod'* *'fdm'*
2805'foldmethod' 'fdm' string (default: "manual")
2806 local to window
2807 {not in Vi}
2808 {not available when compiled without the |+folding|
2809 feature}
2810 The kind of folding used for the current window. Possible values:
2811 |fold-manual| manual Folds are created manually.
2812 |fold-indent| indent Lines with equal indent form a fold.
2813 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2814 |fold-marker| marker Markers are used to specify folds.
2815 |fold-syntax| syntax Syntax highlighting items specify folds.
2816 |fold-diff| diff Fold text that is not changed.
2817
2818 *'foldminlines'* *'fml'*
2819'foldminlines' 'fml' number (default: 1)
2820 local to window
2821 {not in Vi}
2822 {not available when compiled without the |+folding|
2823 feature}
2824 Sets the minimum number of screen lines for a fold to be displayed
2825 closed. Also for manually closed folds.
2826 Note that this only has an effect of what is displayed. After using
2827 "zc" to close a fold, which is displayed open because it's smaller
2828 than 'foldminlines', a following "zc" may close a containing fold.
2829
2830 *'foldnestmax'* *'fdn'*
2831'foldnestmax' 'fdn' number (default: 20)
2832 local to window
2833 {not in Vi}
2834 {not available when compiled without the |+folding|
2835 feature}
2836 Sets the maximum nesting of folds for the "indent" and "syntax"
2837 methods. This avoids that too many folds will be created. Using more
2838 than 20 doesn't work, because the internal limit is 20.
2839
2840 *'foldopen'* *'fdo'*
2841'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2842 search,tag,undo")
2843 global
2844 {not in Vi}
2845 {not available when compiled without the |+folding|
2846 feature}
2847 Specifies for which type of commands folds will be opened, if the
2848 command moves the cursor into a closed fold. It is a comma separated
2849 list of items.
2850 item commands ~
2851 all any
2852 block "(", "{", "[[", "[{", etc.
2853 hor horizontal movements: "l", "w", "fx", etc.
2854 insert any command in Insert mode
2855 jump far jumps: "G", "gg", etc.
2856 mark jumping to a mark: "'m", CTRL-O, etc.
2857 percent "%"
2858 quickfix ":cn", ":crew", ":make", etc.
2859 search search for a pattern: "/", "n", "*", "gd", etc.
2860 (not for a search pattern in a ":" command)
2861 tag jumping to a tag: ":ta", CTRL-T, etc.
2862 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002863 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 the |zv| command to the mapping to get the same effect.
2865 When a movement command is used for an operator (e.g., "dl" or "y%")
2866 this option is not used. This means the operator will include the
2867 whole closed fold.
2868 Note that vertical movements are not here, because it would make it
2869 very difficult to move onto a closed fold.
2870 In insert mode the folds containing the cursor will always be open
2871 when text is inserted.
2872 To close folds you can re-apply 'foldlevel' with the |zx| command or
2873 set the 'foldclose' option to "all".
2874
2875 *'foldtext'* *'fdt'*
2876'foldtext' 'fdt' string (default: "foldtext()")
2877 local to window
2878 {not in Vi}
2879 {not available when compiled without the |+folding|
2880 feature}
2881 An expression which is used to specify the text displayed for a closed
2882 fold. See |fold-foldtext|.
2883
2884 *'formatoptions'* *'fo'*
2885'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2886 local to buffer
2887 {not in Vi}
2888 This is a sequence of letters which describes how automatic
2889 formatting is to be done. See |fo-table|. When the 'paste' option is
2890 on, no formatting is done (like 'formatoptions' is empty). Commas can
2891 be inserted for readability.
2892 To avoid problems with flags that are added in the future, use the
2893 "+=" and "-=" feature of ":set" |add-option-flags|.
2894 NOTE: This option is set to the Vi default value when 'compatible' is
2895 set and to the Vim default value when 'compatible' is reset.
2896
Bram Moolenaar86b68352004-12-27 21:59:20 +00002897 *'formatlistpat'* *'flp'*
2898'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2899 local to buffer
2900 {not in Vi}
2901 A pattern that is used to recognize a list header. This is used for
2902 the "n" flag in 'formatoptions'.
2903 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002904 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002905 while still checking more characters. There must be a character
2906 following the pattern, when it matches the whole line it is handled
2907 like there is no match.
2908 The default recognizes a number, followed by an optional punctuation
2909 character and white space.
2910
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 *'formatprg'* *'fp'*
2912'formatprg' 'fp' string (default "")
2913 global
2914 {not in Vi}
2915 The name of an external program that will be used to format the lines
2916 selected with the "gq" command. The program must take the input on
2917 stdin and produce the output on stdout. The Unix program "fmt" is
2918 such a program. If this option is an empty string, the internal
2919 format function will be used |C-indenting|. Environment variables are
2920 expanded |:set_env|. See |option-backslash| about including spaces
2921 and backslashes.
2922 This option cannot be set from a |modeline| or in the |sandbox|, for
2923 security reasons.
2924
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002925 *'fsync'* *'fs'*
2926'fsync' 'fs' boolean (default on)
2927 global
2928 {not in Vi}
2929 When on, the library function fsync() will be called after writing a
2930 file. This will flush a file to disk, ensuring that it is safely
2931 written even on filesystems which do metadata-only journaling. This
2932 will force the harddrive to spin up on Linux systems running in laptop
2933 mode, so it may be undesirable in some situations. Be warned that
2934 turning this off increases the chances of data loss after a crash. On
2935 systems without an fsync() implementation, this variable is always
2936 off.
2937 Also see 'swapsync' for controlling fsync() on swap files.
2938
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
2940'gdefault' 'gd' boolean (default off)
2941 global
2942 {not in Vi}
2943 When on, the ":substitute" flag 'g' is default on. This means that
2944 all matches in a line are substituted instead of one. When a 'g' flag
2945 is given to a ":substitute" command, this will toggle the substitution
2946 of all or one match. See |complex-change|.
2947
2948 command 'gdefault' on 'gdefault' off ~
2949 :s/// subst. all subst. one
2950 :s///g subst. one subst. all
2951 :s///gg subst. all subst. one
2952
2953 NOTE: This option is reset when 'compatible' is set.
2954
2955 *'grepformat'* *'gfm'*
2956'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
2957 global
2958 {not in Vi}
2959 Format to recognize for the ":grep" command output.
2960 This is a scanf-like string that uses the same format as the
2961 'errorformat' option: see |errorformat|.
2962
2963 *'grepprg'* *'gp'*
2964'grepprg' 'gp' string (default "grep -n ",
2965 Unix: "grep -n $* /dev/null",
2966 Win32: "findstr /n" or "grep -n",
2967 VMS: "SEARCH/NUMBERS ")
2968 global or local to buffer |global-local|
2969 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00002970 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 and '#' characters, which are expanded like when used in a command-
2972 line. The placeholder "$*" is allowed to specify where the arguments
2973 will be included. Environment variables are expanded |:set_env|. See
2974 |option-backslash| about including spaces and backslashes.
2975 When your "grep" accepts the "-H" argument, use this to make ":grep"
2976 also work well with a single file: >
2977 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00002978< Special value: When 'grepprg' is set to "internal" the |:grep| command
2979 works like |:vimgrep| and |:grepadd| like |:vimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00002980 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 apply equally to 'grepprg'.
2982 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
2983 otherwise it's "grep -n".
2984 This option cannot be set from a |modeline| or in the |sandbox|, for
2985 security reasons.
2986
2987 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
2988'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
2989 ve:ver35-Cursor,
2990 o:hor50-Cursor,
2991 i-ci:ver25-Cursor/lCursor,
2992 r-cr:hor20-Cursor/lCursor,
2993 sm:block-Cursor
2994 -blinkwait175-blinkoff150-blinkon175",
2995 for MS-DOS and Win32 console:
2996 "n-v-c:block,o:hor50,i-ci:hor15,
2997 r-cr:hor30,sm:block")
2998 global
2999 {not in Vi}
3000 {only available when compiled with GUI enabled, and
3001 for MS-DOS and Win32 console}
3002 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003003 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 the height of the cursor can be changed. This can be done by
3005 specifying a block cursor, or a percentage for a vertical or
3006 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003007 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003009 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 mode-list and an argument-list:
3011 mode-list:argument-list,mode-list:argument-list,..
3012 The mode-list is a dash separated list of these modes:
3013 n Normal mode
3014 v Visual mode
3015 ve Visual mode with 'selection' "exclusive" (same as 'v',
3016 if not specified)
3017 o Operator-pending mode
3018 i Insert mode
3019 r Replace mode
3020 c Command-line Normal (append) mode
3021 ci Command-line Insert mode
3022 cr Command-line Replace mode
3023 sm showmatch in Insert mode
3024 a all modes
3025 The argument-list is a dash separated list of these arguments:
3026 hor{N} horizontal bar, {N} percent of the character height
3027 ver{N} vertical bar, {N} percent of the character width
3028 block block cursor, fills the whole character
3029 [only one of the above three should be present]
3030 blinkwait{N} *cursor-blinking*
3031 blinkon{N}
3032 blinkoff{N}
3033 blink times for cursor: blinkwait is the delay before
3034 the cursor starts blinking, blinkon is the time that
3035 the cursor is shown and blinkoff is the time that the
3036 cursor is not shown. The times are in msec. When one
3037 of the numbers is zero, there is no blinking. The
3038 default is: "blinkwait700-blinkon400-blinkoff250".
3039 These numbers are used for a missing entry. This
3040 means that blinking is enabled by default. To switch
3041 blinking off you can use "blinkon0". The cursor only
3042 blinks when Vim is waiting for input, not while
3043 executing a command.
3044 To make the cursor blink in an xterm, see
3045 |xterm-blink|.
3046 {group-name}
3047 a highlight group name, that sets the color and font
3048 for the cursor
3049 {group-name}/{group-name}
3050 Two highlight group names, the first is used when
3051 no language mappings are used, the other when they
3052 are. |language-mapping|
3053
3054 Examples of parts:
3055 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3056 block cursor with colors from the "nCursor"
3057 highlight group
3058 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3059 In Insert and Command-line Insert mode, use a
3060 30% vertical bar cursor with colors from the
3061 "iCursor" highlight group. Blink a bit
3062 faster.
3063
3064 The 'a' mode is different. It will set the given argument-list for
3065 all modes. It does not reset anything to defaults. This can be used
3066 to do a common setting for all modes. For example, to switch off
3067 blinking: "a:blinkon0"
3068
3069 Examples of cursor highlighting: >
3070 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3071 :highlight Cursor gui=NONE guifg=bg guibg=fg
3072<
3073 *'guifont'* *'gfn'*
3074 *E235* *E596* *E610* *E611*
3075'guifont' 'gfn' string (default "")
3076 global
3077 {not in Vi}
3078 {only available when compiled with GUI enabled}
3079 This is a list of fonts which will be used for the GUI version of Vim.
3080 In its simplest form the value is just one font name. When
3081 the font cannot be found you will get an error message. To try other
3082 font names a list can be specified, font names separated with commas.
3083 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003084
Bram Moolenaar05159a02005-02-26 23:04:13 +00003085 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3086 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003087
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 Spaces after a comma are ignored. To include a comma in a font name
3089 precede it with a backslash. Setting an option requires an extra
3090 backslash before a space and a backslash. See also
3091 |option-backslash|. For example: >
3092 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003093< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003095
3096 If none of the fonts can be loaded, Vim will keep the current setting.
3097 If an empty font list is given, Vim will try using other resource
3098 settings (for X, it will use the Vim.font resource), and finally it
3099 will try some builtin default which should always be there ("7x13" in
3100 the case of X). The font names given should be "normal" fonts. Vim
3101 will try to find the related bold and italic fonts.
3102
Bram Moolenaar05159a02005-02-26 23:04:13 +00003103 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003104 :set guifont=*
3105< will bring up a font requester, where you can pick the font you want.
3106
3107 The font name depends on the GUI used. See |setting-guifont| for a
3108 way to set 'guifont' for various systems.
3109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 For the GTK+ 2 GUI the font name looks like this: >
3111 :set guifont=Andale\ Mono\ 11
3112< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003113
3114 For Mac OSX you can use something like this: >
3115 :set guifont=Monaco:h10
3116< *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003118 width). An exception is GTK 2: all fonts are accepted, but
3119 mono-spaced fonts look best.
3120
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121 To preview a font on X11, you might be able to use the "xfontsel"
3122 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003123
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 For the Win32 GUI *E244* *E245*
3125 - takes these options in the font name:
3126 hXX - height is XX (points, can be floating-point)
3127 wXX - width is XX (points, can be floating-point)
3128 b - bold
3129 i - italic
3130 u - underline
3131 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003132 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3134 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3135 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003136 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137
3138 Use a ':' to separate the options.
3139 - A '_' can be used in the place of a space, so you don't need to use
3140 backslashes to escape the spaces.
3141 - Examples: >
3142 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3143 :set guifont=Andale_Mono:h7.5:w4.5
3144< See also |font-sizes|.
3145
3146 *'guifontset'* *'gfs'*
3147 *E250* *E252* *E234* *E597* *E598*
3148'guifontset' 'gfs' string (default "")
3149 global
3150 {not in Vi}
3151 {only available when compiled with GUI enabled and
3152 with the |+xfontset| feature}
3153 {not available in the GTK+ 2 GUI}
3154 When not empty, specifies two (or more) fonts to be used. The first
3155 one for normal English, the second one for your special language. See
3156 |xfontset|.
3157 Setting this option also means that all font names will be handled as
3158 a fontset name. Also the ones used for the "font" argument of the
3159 |:highlight| command.
3160 The fonts must match with the current locale. If fonts for the
3161 character sets that the current locale uses are not included, setting
3162 'guifontset' will fail.
3163 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3164 the comma-separated names are alternative names, one of which will be
3165 used. In 'guifontset' the whole string is one fontset name,
3166 including the commas. It is not possible to specify alternative
3167 fontset names.
3168 This example works on many X11 systems: >
3169 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3170<
3171 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3172'guifontwide' 'gfw' string (default "")
3173 global
3174 {not in Vi}
3175 {only available when compiled with GUI enabled}
3176 When not empty, specifies a comma-separated list of fonts to be used
3177 for double-width characters. The first font that can be loaded is
3178 used.
3179 Note: The size of these fonts must be exactly twice as wide as the one
3180 specified with 'guifont' and the same height.
3181
3182 All GUI versions but GTK+ 2:
3183
3184 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3185 'guifontset' is empty or invalid.
3186 When 'guifont' is set and a valid font is found in it and
3187 'guifontwide' is empty Vim will attempt to find a matching
3188 double-width font and set 'guifontwide' to it.
3189
3190 GTK+ 2 GUI only: *guifontwide_gtk2*
3191
3192 If set and valid, 'guifontwide' is always used for double width
3193 characters, even if 'encoding' is not set to "utf-8".
3194 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003195 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003196 font for characters not available in 'guifont'. Thus you do not need
3197 to set 'guifontwide' at all unless you want to override the choice
3198 made by Pango/Xft.
3199
3200 *'guiheadroom'* *'ghr'*
3201'guiheadroom' 'ghr' number (default 50)
3202 global
3203 {not in Vi} {only for GTK and X11 GUI}
3204 The number of pixels subtracted from the screen height when fitting
3205 the GUI window on the screen. Set this before the GUI is started,
3206 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 lines will be left for window decorations and other items on the
3209 screen. Set it to a negative value to allow windows taller than the
3210 screen.
3211
3212 *'guioptions'* *'go'*
3213'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003214 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 global
3216 {not in Vi}
3217 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003218 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 sequence of letters which describes what components and options of the
3220 GUI should be used.
3221 To avoid problems with flags that are added in the future, use the
3222 "+=" and "-=" feature of ":set" |add-option-flags|.
3223
3224 Valid letters are as follows:
3225 *guioptions_a*
3226 'a' Autoselect: If present, then whenever VISUAL mode is started,
3227 or the Visual area extended, Vim tries to become the owner of
3228 the windowing system's global selection. This means that the
3229 Visually highlighted text is available for pasting into other
3230 applications as well as into Vim itself. When the Visual mode
3231 ends, possibly due to an operation on the text, or when an
3232 application wants to paste the selection, the highlighted text
3233 is automatically yanked into the "* selection register.
3234 Thus the selection is still available for pasting into other
3235 applications after the VISUAL mode has ended.
3236 If not present, then Vim won't become the owner of the
3237 windowing system's global selection unless explicitly told to
3238 by a yank or delete operation for the "* register.
3239 The same applies to the modeless selection.
3240
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003241 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 applies to the modeless selection.
3243
3244 'guioptions' autoselect Visual autoselect modeless ~
3245 "" - -
3246 "a" yes yes
3247 "A" - yes
3248 "aA" yes yes
3249
3250 'c' Use console dialogs instead of popup dialogs for simple
3251 choices.
3252
3253 'f' Foreground: Don't use fork() to detach the GUI from the shell
3254 where it was started. Use this for programs that wait for the
3255 editor to finish (e.g., an e-mail program). Alternatively you
3256 can use "gvim -f" or ":gui -f" to start the GUI in the
3257 foreground. |gui-fork|
3258 Note: Set this option in the vimrc file. The forking may have
3259 happened already when the gvimrc file is read.
3260
3261 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3262 corner of the window. It's black&white on non-GTK, because of
3263 limitations of X11. For a color icon, see |X11-icon|.
3264
3265 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003266 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 that this flag must be added in the .vimrc file, before
3268 switching on syntax or filetype recognition (when the .gvimrc
3269 file is sourced the system menu has already been loaded; the
3270 ":syntax on" and ":filetype on" commands load the menu too).
3271 'g' Grey menu items: Make menu items that are not active grey. If
3272 'g' is not included inactive menu items are not shown at all.
3273 Exception: Athena will always use grey menu items.
3274
3275 't' Include tearoff menu items. Currently only works for Win32,
3276 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003277 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
3278 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279
3280 'r' Right-hand scrollbar is always present.
3281 'R' Right-hand scrollbar is present when there is a vertically
3282 split window.
3283 'l' Left-hand scrollbar is always present.
3284 'L' Left-hand scrollbar is present when there is a vertically
3285 split window.
3286 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3287 the longest visible line, or on the cursor line if the 'h'
3288 flag is included. |gui-horiz-scroll|
3289 'h' Limit horizontal scrollbar size to the length of the cursor
3290 line. Reduces computations. |gui-horiz-scroll|
3291
3292 And yes, you may even have scrollbars on the left AND the right if
3293 you really want to :-). See |gui-scrollbars| for more information.
3294
3295 'v' Use a vertical button layout for dialogs. When not included,
3296 a horizontal layout is preferred, but when it doesn't fit a
3297 vertical layout is used anyway.
3298 'p' Use Pointer callbacks for X11 GUI. This is required for some
3299 window managers. If the cursor is not blinking or hollow at
3300 the right moment, try adding this flag. This must be done
3301 before starting the GUI. Set it in your gvimrc. Adding or
3302 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003303 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304
3305 *'guipty'* *'noguipty'*
3306'guipty' boolean (default on)
3307 global
3308 {not in Vi}
3309 {only available when compiled with GUI enabled}
3310 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3311 I/O to/from shell commands. See |gui-pty|.
3312
3313 *'helpfile'* *'hf'*
3314'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3315 (others) "$VIMRUNTIME/doc/help.txt")
3316 global
3317 {not in Vi}
3318 Name of the main help file. All distributed help files should be
3319 placed together in one directory. Additionally, all "doc" directories
3320 in 'runtimepath' will be used.
3321 Environment variables are expanded |:set_env|. For example:
3322 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003323 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324 spaces and backslashes.
3325 This option cannot be set from a |modeline| or in the |sandbox|, for
3326 security reasons.
3327
3328 *'helpheight'* *'hh'*
3329'helpheight' 'hh' number (default 20)
3330 global
3331 {not in Vi}
3332 {not available when compiled without the +windows
3333 feature}
3334 Minimal initial height of the help window when it is opened with the
3335 ":help" command. The initial height of the help window is half of the
3336 current window, or (when the 'ea' option is on) the same as other
3337 windows. When the height is less than 'helpheight', the height is
3338 set to 'helpheight'. Set to zero to disable.
3339
3340 *'helplang'* *'hlg'*
3341'helplang' 'hlg' string (default: messages language or empty)
3342 global
3343 {only available when compiled with the |+multi_lang|
3344 feature}
3345 {not in Vi}
3346 Comma separated list of languages. Vim will use the first language
3347 for which the desired help can be found. The English help will always
3348 be used as a last resort. You can add "en" to prefer English over
3349 another language, but that will only find tags that exist in that
3350 language and not in the English help.
3351 Example: >
3352 :set helplang=de,it
3353< This will first search German, then Italian and finally English help
3354 files.
3355 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3356 try to find the tag in the current language before using this option.
3357 See |help-translated|.
3358
3359 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3360'hidden' 'hid' boolean (default off)
3361 global
3362 {not in Vi}
3363 When off a buffer is unloaded when it is |abandon|ed. When on a
3364 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3365 displayed in another window, it does not become hidden, of course.
3366 The commands that move through the buffer list sometimes make a buffer
3367 hidden although the 'hidden' option is off: When the buffer is
3368 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003369 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003370 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 This option is set for one command with ":hide {command}" |:hide|.
3372 WARNING: It's easy to forget that you have changes in hidden buffers.
3373 Think twice when using ":q!" or ":qa!".
3374
3375 *'highlight'* *'hl'*
3376'highlight' 'hl' string (default (as a single string):
3377 "8:SpecialKey,@:NonText,d:Directory,
3378 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3379 M:ModeMsg,n:LineNr,r:Question,
3380 s:StatusLine,S:StatusLineNC,c:VertSplit
3381 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3382 f:Folded,F:FoldColumn,A:DiffAdd,
3383 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003384 >:SignColumn,B:SpellBad,P:SpellCap,
3385 R:SpellRare,L:SpellLocal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 global
3387 {not in Vi}
3388 This option can be used to set highlighting mode for various
3389 occasions. It is a comma separated list of character pairs. The
3390 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003391 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003392 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3393 |hl-NonText| @ '~' and '@' at the end of the window and
3394 characters from 'showbreak'
3395 |hl-Directory| d directories in CTRL-D listing and other special
3396 things in listings
3397 |hl-ErrorMsg| e error messages
3398 h (obsolete, ignored)
3399 |hl-IncSearch| i 'incsearch' highlighting
3400 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3401 |hl-MoreMsg| m |more-prompt|
3402 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3403 |hl-LineNr| n line number for ":number" and ":#" commands
3404 |hl-Question| r |hit-enter| prompt and yes/no questions
3405 |hl-StatusLine| s status line of current window |status-line|
3406 |hl-StatusLineNC| S status lines of not-current windows
3407 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3408 |hl-VertSplit| c column used to separate vertically split windows
3409 |hl-Visual| v Visual mode
3410 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3411 Selection" Only X11 Gui's |gui-x11| and
3412 |xterm-clipboard|.
3413 |hl-WarningMsg| w warning messages
3414 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3415 |hl-Folded| f line used for closed folds
3416 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003417 |hl-DiffAdd| A added line in diff mode
3418 |hl-DiffChange| C changed line in diff mode
3419 |hl-DiffDelete| D deleted line in diff mode
3420 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003422 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003423 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003424 |hl-SpellRare| R rare word |spell|
3425 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426
3427 The display modes are:
3428 r reverse (termcap entry "mr" and "me")
3429 i italic (termcap entry "ZH" and "ZR")
3430 b bold (termcap entry "md" and "me")
3431 s standout (termcap entry "so" and "se")
3432 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003433 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 n no highlighting
3435 - no highlighting
3436 : use a highlight group
3437 The default is used for occasions that are not included.
3438 If you want to change what the display modes do, see |dos-colors|
3439 for an example.
3440 When using the ':' display mode, this must be followed by the name of
3441 a highlight group. A highlight group can be used to define any type
3442 of highlighting, including using color. See |:highlight| on how to
3443 define one. The default uses a different group for each occasion.
3444 See |highlight-default| for the default highlight groups.
3445
3446 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3447'hlsearch' 'hls' boolean (default off)
3448 global
3449 {not in Vi}
3450 {not available when compiled without the
3451 |+extra_search| feature}
3452 When there is a previous search pattern, highlight all its matches.
3453 The type of highlighting used can be set with the 'l' occasion in the
3454 'highlight' option. This uses the "Search" highlight group by
3455 default. Note that only the matching text is highlighted, any offsets
3456 are not applied.
3457 See also: 'incsearch' and |:match|.
3458 When you get bored looking at the highlighted matches, you can turn it
3459 off with |:nohlsearch|. As soon as you use a search command, the
3460 highlighting comes back.
3461 When the search pattern can match an end-of-line, Vim will try to
3462 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003463 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003464 line below a closed fold. A match in a previous line which is not
3465 drawn may not continue in an newly drawn line.
3466 NOTE: This option is reset when 'compatible' is set.
3467
3468 *'history'* *'hi'*
3469'history' 'hi' number (Vim default: 20, Vi default: 0)
3470 global
3471 {not in Vi}
3472 A history of ":" commands, and a history of previous search patterns
3473 are remembered. This option decides how many entries may be stored in
3474 each of these histories (see |cmdline-editing|).
3475 NOTE: This option is set to the Vi default value when 'compatible' is
3476 set and to the Vim default value when 'compatible' is reset.
3477
3478 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3479'hkmap' 'hk' boolean (default off)
3480 global
3481 {not in Vi}
3482 {only available when compiled with the |+rightleft|
3483 feature}
3484 When on, the keyboard is mapped for the Hebrew character set.
3485 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3486 toggle this option. See |rileft.txt|.
3487 NOTE: This option is reset when 'compatible' is set.
3488
3489 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3490'hkmapp' 'hkp' boolean (default off)
3491 global
3492 {not in Vi}
3493 {only available when compiled with the |+rightleft|
3494 feature}
3495 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3496 This is useful if you have a non-Hebrew keyboard.
3497 See |rileft.txt|.
3498 NOTE: This option is reset when 'compatible' is set.
3499
3500 *'icon'* *'noicon'*
3501'icon' boolean (default off, on when title can be restored)
3502 global
3503 {not in Vi}
3504 {not available when compiled without the |+title|
3505 feature}
3506 When on, the icon text of the window will be set to the value of
3507 'iconstring' (if it is not empty), or to the name of the file
3508 currently being edited. Only the last part of the name is used.
3509 Overridden by the 'iconstring' option.
3510 Only works if the terminal supports setting window icons (currently
3511 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3512 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3513 builtin termcap).
3514 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003515 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 X11.
3517
3518 *'iconstring'*
3519'iconstring' string (default "")
3520 global
3521 {not in Vi}
3522 {not available when compiled without the |+title|
3523 feature}
3524 When this option is not empty, it will be used for the icon text of
3525 the window. This happens only when the 'icon' option is on.
3526 Only works if the terminal supports setting window icon text
3527 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3528 Does not work for MS Windows.
3529 When Vim was compiled with HAVE_X11 defined, the original icon will be
3530 restored if possible |X11|.
3531 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003532 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533 'titlestring' for example settings.
3534 {not available when compiled without the |+statusline| feature}
3535
3536 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3537'ignorecase' 'ic' boolean (default off)
3538 global
3539 Ignore case in search patterns. Also used when searching in the tags
3540 file.
3541 Also see 'smartcase'.
3542 Can be overruled by using "\c" or "\C" in the pattern, see
3543 |/ignorecase|.
3544
3545 *'imactivatekey'* *'imak'*
3546'imactivatekey' 'imak' string (default "")
3547 global
3548 {not in Vi}
3549 {only available when compiled with |+xim| and
3550 |+GUI_GTK|}
3551 Specifies the key that your Input Method in X-Windows uses for
3552 activation. When this is specified correctly, vim can fully control
3553 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3554 You can't use this option to change the activation key, the option
3555 tells Vim what the key is.
3556 Format:
3557 [MODIFIER_FLAG-]KEY_STRING
3558
3559 These characters can be used for MODIFIER_FLAG (case is ignored):
3560 S Shift key
3561 L Lock key
3562 C Control key
3563 1 Mod1 key
3564 2 Mod2 key
3565 3 Mod3 key
3566 4 Mod4 key
3567 5 Mod5 key
3568 Combinations are allowed, for example "S-C-space" or "SC-space" are
3569 both shift+ctrl+space.
3570 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3571
3572 Example: >
3573 :set imactivatekey=S-space
3574< "S-space" means shift+space. This is the activation key for kinput2 +
3575 canna (Japanese), and ami (Korean).
3576
3577 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3578'imcmdline' 'imc' boolean (default off)
3579 global
3580 {not in Vi}
3581 {only available when compiled with the |+xim|
3582 |+multi_byte_ime| or |global-ime| feature}
3583 When set the Input Method is always on when starting to edit a command
3584 line, unless entering a search pattern (see 'imsearch' for that).
3585 Setting this option is useful when your input method allows entering
3586 English characters directly, e.g., when it's used to type accented
3587 characters with dead keys.
3588
3589 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3590'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3591 global
3592 {not in Vi}
3593 {only available when compiled with the |+xim|
3594 |+multi_byte_ime| or |global-ime| feature}
3595 When set the Input Method is never used. This is useful to disable
3596 the IM when it doesn't work properly.
3597 Currently this option is on by default for SGI/IRIX machines. This
3598 may change in later releases.
3599
3600 *'iminsert'* *'imi'*
3601'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3602 local to buffer
3603 {not in Vi}
3604 Specifies whether :lmap or an Input Method (IM) is to be used in
3605 Insert mode. Valid values:
3606 0 :lmap is off and IM is off
3607 1 :lmap is ON and IM is off
3608 2 :lmap is off and IM is ON
3609 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3610 or |global-ime|.
3611 To always reset the option to zero when leaving Insert mode with <Esc>
3612 this can be used: >
3613 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3614< This makes :lmap and IM turn off automatically when leaving Insert
3615 mode.
3616 Note that this option changes when using CTRL-^ in Insert mode
3617 |i_CTRL-^|.
3618 The value is set to 1 when setting 'keymap' to a valid keymap name.
3619 It is also used for the argument of commands like "r" and "f".
3620 The value 0 may not work correctly with Athena and Motif with some XIM
3621 methods. Use 'imdisable' to disable XIM then.
3622
3623 *'imsearch'* *'ims'*
3624'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3625 local to buffer
3626 {not in Vi}
3627 Specifies whether :lmap or an Input Method (IM) is to be used when
3628 entering a search pattern. Valid values:
3629 -1 the value of 'iminsert' is used, makes it look like
3630 'iminsert' is also used when typing a search pattern
3631 0 :lmap is off and IM is off
3632 1 :lmap is ON and IM is off
3633 2 :lmap is off and IM is ON
3634 Note that this option changes when using CTRL-^ in Command-line mode
3635 |c_CTRL-^|.
3636 The value is set to 1 when it is not -1 and setting the 'keymap'
3637 option to a valid keymap name.
3638 The value 0 may not work correctly with Athena and Motif with some XIM
3639 methods. Use 'imdisable' to disable XIM then.
3640
3641 *'include'* *'inc'*
3642'include' 'inc' string (default "^\s*#\s*include")
3643 global or local to buffer |global-local|
3644 {not in Vi}
3645 {not available when compiled without the
3646 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003647 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 pattern, just like for the "/" command (See |pattern|). The default
3649 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar582fd852005-03-28 20:58:01 +00003650 "]I", "[d", etc. The 'isfname' option is used to recognize the file
Bram Moolenaar071d4272004-06-13 20:20:40 +00003651 name that comes after the matched pattern. See |option-backslash|
3652 about including spaces and backslashes.
3653
3654 *'includeexpr'* *'inex'*
3655'includeexpr' 'inex' string (default "")
3656 local to buffer
3657 {not in Vi}
3658 {not available when compiled without the
3659 |+find_in_path| or |+eval| feature}
3660 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003661 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 :set includeexpr=substitute(v:fname,'\\.','/','g')
3663< The "v:fname" variable will be set to the file name that was detected.
3664 Evaluated in the |sandbox|.
3665 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003666 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 Also used for |<cfile>|.
3668
3669 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3670'incsearch' 'is' boolean (default off)
3671 global
3672 {not in Vi}
3673 {not available when compiled without the
3674 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003675 While typing a search command, show where the pattern, as it was typed
3676 so far, matches. The matched string is highlighted. If the pattern
3677 is invalid or not found, nothing is shown. The screen will be updated
3678 often, this is only useful on fast terminals.
3679 Note that the match will be shown, but the cursor will return to its
3680 original position when no match is found and when pressing <Esc>. You
3681 still need to finish the search command with <Enter> to move the
3682 cursor to the match.
3683 The highlighting can be set with the 'i' flag in 'highlight'.
3684 See also: 'hlsearch'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 NOTE: This option is reset when 'compatible' is set.
3686
3687 *'indentexpr'* *'inde'*
3688'indentexpr' 'inde' string (default "")
3689 local to buffer
3690 {not in Vi}
3691 {not available when compiled without the |+cindent|
3692 or |+eval| features}
3693 Expression which is evaluated to obtain the proper indent for a line.
3694 It is used when a new line is created, for the |=| operator and
3695 in Insert mode as specified with the 'indentkeys' option.
3696 When this option is not empty, it overrules the 'cindent' and
3697 'smartindent' indenting.
3698 When 'paste' is set this option is not used for indenting.
3699 The expression is evaluated with |v:lnum| set to the line number for
3700 which the indent is to be computed. The cursor is also as this line
3701 when the expression is evaluated (but it may be moved around).
3702 The expression must return the number of spaces worth of indent. It
3703 can return "-1" to keep the current indent (this means 'autoindent' is
3704 used for the indent).
3705 Functions useful for computing the indent are |indent()|, |cindent()|
3706 and |lispindent()|.
3707 The evaluation of the expression must not have side effects! It must
3708 not change the text, jump to another window, etc. Afterwards the
3709 cursor position is always restored, thus the cursor may be moved.
3710 Normally this option would be set to call a function: >
3711 :set indentexpr=GetMyIndent()
3712< Error messages will be suppressed, unless the 'debug' option contains
3713 "msg".
3714 See |indent-expression|. Also see |eval-sandbox|.
3715 NOTE: This option is made empty when 'compatible' is set.
3716
3717 *'indentkeys'* *'indk'*
3718'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3719 local to buffer
3720 {not in Vi}
3721 {not available when compiled without the |+cindent|
3722 feature}
3723 A list of keys that, when typed in Insert mode, cause reindenting of
3724 the current line. Only happens if 'indentexpr' isn't empty.
3725 The format is identical to 'cinkeys', see |indentkeys-format|.
3726 See |C-indenting| and |indent-expression|.
3727
3728 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3729'infercase' 'inf' boolean (default off)
3730 local to buffer
3731 {not in Vi}
3732 When doing keyword completion in insert mode |ins-completion|, and
3733 'ignorecase' is also on, the case of the match is adjusted. If the
3734 typed text contains a lowercase letter where the match has an upper
3735 case letter, the completed part is made lowercase. If the typed text
3736 has no lowercase letters and the match has a lowercase letter where
3737 the typed text has an uppercase letter, and there is a letter before
3738 it, the completed part is made uppercase.
3739
3740 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3741'insertmode' 'im' boolean (default off)
3742 global
3743 {not in Vi}
3744 Makes Vim work in a way that Insert mode is the default mode. Useful
3745 if you want to use Vim as a modeless editor. Used for |evim|.
3746 These Insert mode commands will be useful:
3747 - Use the cursor keys to move around.
3748 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3749 this is a mapping, it is executed as if 'insertmode' was off.
3750 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003752 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3753 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003754
3755 These items change when 'insertmode' is set:
3756 - when starting to edit of a file, Vim goes to Insert mode.
3757 - <Esc> in Insert mode is a no-op and beeps.
3758 - <Esc> in Normal mode makes Vim go to Insert mode.
3759 - CTRL-L in Insert mode is a command, it is not inserted.
3760 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3761 However, when <Esc> is used inside a mapping, it behaves like
3762 'insertmode' was not set. This was done to be able to use the same
3763 mappings with 'insertmode' set or not set.
3764 When executing commands with |:normal| 'insertmode' is not used.
3765
3766 NOTE: This option is reset when 'compatible' is set.
3767
3768 *'isfname'* *'isf'*
3769'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3770 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3771 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3772 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3773 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3774 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3775 global
3776 {not in Vi}
3777 The characters specified by this option are included in file names and
3778 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003779 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 Multi-byte characters 256 and above are always included, only the
3781 characters up to 255 are specified with this option.
3782 For UTF-8 the characters 0xa0 to 0xff are included as well.
3783
3784 Note that on systems using a backslash as path separator, Vim tries to
3785 do its best to make it work as you would expect. That is a bit
3786 tricky, since Vi originally used the backslash to escape special
3787 characters. Vim will not remove a backslash in front of a normal file
3788 name character on these systems, but it will on Unix and alikes. The
3789 '&' and '^' are not included by default, because these are special for
3790 cmd.exe.
3791
3792 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003793 Each part can be a single character number or a range. A range is two
3794 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 decimal number between 0 and 255 or the ASCII character itself (does
3796 not work for digits). Example:
3797 "_,-,128-140,#-43" (include '_' and '-' and the range
3798 128 to 140 and '#' to 43)
3799 If a part starts with '^', the following character number or range
3800 will be excluded from the option. The option is interpreted from left
3801 to right. Put the excluded character after the range where it is
3802 included. To include '^' itself use it as the last character of the
3803 option or the end of a range. Example:
3804 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3805 If the character is '@', all characters where isalpha() returns TRUE
3806 are included. Normally these are the characters a to z and A to Z,
3807 plus accented characters. To include '@' itself use "@-@". Examples:
3808 "@,^a-z" All alphabetic characters, excluding lower
3809 case letters.
3810 "a-z,A-Z,@-@" All letters plus the '@' character.
3811 A comma can be included by using it where a character number is
3812 expected. Example:
3813 "48-57,,,_" Digits, comma and underscore.
3814 A comma can be excluded by prepending a '^'. Example:
3815 " -~,^,,9" All characters from space to '~', excluding
3816 comma, plus <Tab>.
3817 See |option-backslash| about including spaces and backslashes.
3818
3819 *'isident'* *'isi'*
3820'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3821 "@,48-57,_,128-167,224-235"
3822 otherwise: "@,48-57,_,192-255")
3823 global
3824 {not in Vi}
3825 The characters given by this option are included in identifiers.
3826 Identifiers are used in recognizing environment variables and after a
3827 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003828 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 option.
3830 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003831 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3833
3834 *'iskeyword'* *'isk'*
3835'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3836 "@,48-57,_,128-167,224-235"
3837 otherwise: "@,48-57,_,192-255"
3838 Vi default: "@,48-57,_")
3839 local to buffer
3840 {not in Vi}
3841 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003842 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003843 'isfname' for a description of the format of this option. For C
3844 programs you could use "a-z,A-Z,48-57,_,.,-,>".
3845 For a help file it is set to all non-blank printable characters except
3846 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
3847 command).
3848 When the 'lisp' option is on the '-' character is always included.
3849 NOTE: This option is set to the Vi default value when 'compatible' is
3850 set and to the Vim default value when 'compatible' is reset.
3851
3852 *'isprint'* *'isp'*
3853'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
3854 "@,~-255"; otherwise: "@,161-255")
3855 global
3856 {not in Vi}
3857 The characters given by this option are displayed directly on the
3858 screen. It is also used for "\p" in a |pattern|. The characters from
3859 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
3860 even when they are not included in 'isprint' or excluded. See
3861 'isfname' for a description of the format of this option.
3862
3863 Non-printable characters are displayed with two characters:
3864 0 - 31 "^@" - "^_"
3865 32 - 126 always single characters
3866 127 "^?"
3867 128 - 159 "~@" - "~_"
3868 160 - 254 "| " - "|~"
3869 255 "~?"
3870 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
3871 displayed as <xx>, with the hexadecimal value of the byte.
3872 When 'display' contains "uhex" all unprintable characters are
3873 displayed as <xx>.
3874 The NonText highlighting will be used for unprintable characters.
3875 |hl-NonText|
3876
3877 Multi-byte characters 256 and above are always included, only the
3878 characters up to 255 are specified with this option. When a character
3879 is printable but it is not available in the current font, a
3880 replacement character will be shown.
3881 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
3882 There is no option to specify these characters.
3883
3884 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
3885'joinspaces' 'js' boolean (default on)
3886 global
3887 {not in Vi}
3888 Insert two spaces after a '.', '?' and '!' with a join command.
3889 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
3890 Otherwise only one space is inserted.
3891 NOTE: This option is set when 'compatible' is set.
3892
3893 *'key'*
3894'key' string (default "")
3895 local to buffer
3896 {not in Vi}
3897 The key that is used for encrypting and decrypting the current buffer.
3898 See |encryption|.
3899 Careful: Do not set the key value by hand, someone might see the typed
3900 key. Use the |:X| command. But you can make 'key' empty: >
3901 :set key=
3902< It is not possible to get the value of this option with ":set key" or
3903 "echo &key". This is to avoid showing it to someone who shouldn't
3904 know. It also means you cannot see it yourself once you have set it,
3905 be careful not to make a typing error!
3906
3907 *'keymap'* *'kmp'* *E544*
3908'keymap' 'kmp' string (default "")
3909 local to buffer
3910 {not in Vi}
3911 {only available when compiled with the |+keymap|
3912 feature}
3913 Name of a keyboard mapping. See |mbyte-keymap|.
3914 Setting this option to a valid keymap name has the side effect of
3915 setting 'iminsert' to one, so that the keymap becomes effective.
3916 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003917 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918
3919 *'keymodel'* *'km'*
3920'keymodel' 'km' string (default "")
3921 global
3922 {not in Vi}
3923 List of comma separated words, which enable special things that keys
3924 can do. These values can be used:
3925 startsel Using a shifted special key starts selection (either
3926 Select mode or Visual mode, depending on "key" being
3927 present in 'selectmode').
3928 stopsel Using a not-shifted special key stops selection.
3929 Special keys in this context are the cursor keys, <End>, <Home>,
3930 <PageUp> and <PageDown>.
3931 The 'keymodel' option is set by the |:behave| command.
3932
3933 *'keywordprg'* *'kp'*
3934'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
3935 OS/2: "view /", VMS: "help")
3936 global or local to buffer |global-local|
3937 {not in Vi}
3938 Program to use for the |K| command. Environment variables are
3939 expanded |:set_env|. ":help" may be used to access the Vim internal
3940 help. (Note that previously setting the global option to the empty
3941 value did this, which is now deprecated.)
3942 When "man" is used, Vim will automatically translate a count for the
3943 "K" command to a section number. Also for "man -s", in which case the
3944 "-s" is removed when there is no count.
3945 See |option-backslash| about including spaces and backslashes.
3946 Example: >
3947 :set keywordprg=man\ -s
3948< This option cannot be set from a |modeline| or in the |sandbox|, for
3949 security reasons.
3950
3951 *'langmap'* *'lmap'* *E357* *E358*
3952'langmap' 'lmap' string (default "")
3953 global
3954 {not in Vi}
3955 {only available when compiled with the |+langmap|
3956 feature}
3957 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003958 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 inserted directly. When in command mode the 'langmap' option takes
3960 care of translating these special characters to the original meaning
3961 of the key. This means you don't have to change the keyboard mode to
3962 be able to execute Normal mode commands.
3963 This is the opposite of the 'keymap' option, where characters are
3964 mapped in Insert mode.
3965 This only works for 8-bit characters. The value of 'langmap' may be
3966 specified with multi-byte characters (e.g., UTF-8), but only the lower
3967 8 bits of each character will be used.
3968
3969 Example (for Greek): *greek* >
3970 :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
3971< Example (exchanges meaning of z and y for commands): >
3972 :set langmap=zy,yz,ZY,YZ
3973<
3974 The 'langmap' option is a list of parts, separated with commas. Each
3975 part can be in one of two forms:
3976 1. A list of pairs. Each pair is a "from" character immediately
3977 followed by the "to" character. Examples: "aA", "aAbBcC".
3978 2. A list of "from" characters, a semi-colon and a list of "to"
3979 characters. Example: "abc;ABC"
3980 Example: "aA,fgh;FGH,cCdDeE"
3981 Special characters need to be preceded with a backslash. These are
3982 ";", ',' and backslash itself.
3983
3984 This will allow you to activate vim actions without having to switch
3985 back and forth between the languages. Your language characters will
3986 be understood as normal vim English characters (according to the
3987 langmap mappings) in the following cases:
3988 o Normal/Visual mode (commands, buffer/register names, user mappings)
3989 o Insert/Replace Mode: Register names after CTRL-R
3990 o Insert/Replace Mode: Mappings
3991 Characters entered in Command-line mode will NOT be affected by
3992 this option. Note that this option can be changed at any time
3993 allowing to switch between mappings for different languages/encodings.
3994 Use a mapping to avoid having to type it each time!
3995
3996 *'langmenu'* *'lm'*
3997'langmenu' 'lm' string (default "")
3998 global
3999 {not in Vi}
4000 {only available when compiled with the |+menu| and
4001 |+multi_lang| features}
4002 Language to use for menu translation. Tells which file is loaded
4003 from the "lang" directory in 'runtimepath': >
4004 "lang/menu_" . &langmenu . ".vim"
4005< (without the spaces). For example, to always use the Dutch menus, no
4006 matter what $LANG is set to: >
4007 :set langmenu=nl_NL.ISO_8859-1
4008< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004009 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 If your $LANG is set to a non-English language but you do want to use
4011 the English menus: >
4012 :set langmenu=none
4013< This option must be set before loading menus, switching on filetype
4014 detection or syntax highlighting. Once the menus are defined setting
4015 this option has no effect. But you could do this: >
4016 :source $VIMRUNTIME/delmenu.vim
4017 :set langmenu=de_DE.ISO_8859-1
4018 :source $VIMRUNTIME/menu.vim
4019< Warning: This deletes all menus that you defined yourself!
4020
4021 *'laststatus'* *'ls'*
4022'laststatus' 'ls' number (default 1)
4023 global
4024 {not in Vi}
4025 The value of this option influences when the last window will have a
4026 status line:
4027 0: never
4028 1: only if there are at least two windows
4029 2: always
4030 The screen looks nicer with a status line if you have several
4031 windows, but it takes another screen line. |status-line|
4032
4033 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4034'lazyredraw' 'lz' boolean (default off)
4035 global
4036 {not in Vi}
4037 When this option is set, the screen will not be redrawn while
4038 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004039 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 update use |:redraw|.
4041
4042 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4043'linebreak' 'lbr' boolean (default off)
4044 local to window
4045 {not in Vi}
4046 {not available when compiled without the |+linebreak|
4047 feature}
4048 If on Vim will wrap long lines at a character in 'breakat' rather
4049 than at the last character that fits on the screen. Unlike
4050 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4051 it only affects the way the file is displayed, not its contents. The
4052 value of 'showbreak' is used to put in front of wrapped lines.
4053 This option is not used when the 'wrap' option is off or 'list' is on.
4054 Note that <Tab> characters after an <EOL> are mostly not displayed
4055 with the right amount of white space.
4056
4057 *'lines'* *E593*
4058'lines' number (default 24 or terminal height)
4059 global
4060 Number of lines of the Vim window.
4061 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004062 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 When Vim is running in the GUI or in a resizable window, setting this
4064 option will cause the window size to be changed. When you only want
4065 to use the size for the GUI, put the command in your |gvimrc| file.
4066 Vim limits the number of lines to what fits on the screen. You can
4067 use this command to get the tallest window possible: >
4068 :set lines=999
4069< If you get less lines than expected, check the 'guiheadroom' option.
4070 When you set this option and Vim is unable to change the physical
4071 number of lines of the display, the display may be messed up.
4072
4073 *'linespace'* *'lsp'*
4074'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4075 global
4076 {not in Vi}
4077 {only in the GUI}
4078 Number of pixel lines inserted between characters. Useful if the font
4079 uses the full character cell height, making lines touch each other.
4080 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004081 With some fonts there can be too much room between lines (to have
4082 space for ascents and descents). Then it makes sense to set
4083 'linespace' to a negative value. This may cause display problems
4084 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 *'lisp'* *'nolisp'*
4087'lisp' boolean (default off)
4088 local to buffer
4089 {not available when compiled without the |+lispindent|
4090 feature}
4091 Lisp mode: When <Enter> is typed in insert mode set the indent for
4092 the next line to Lisp standards (well, sort of). Also happens with
4093 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4094 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4095 better. Also see 'lispwords'.
4096 The '-' character is included in keyword characters. Redefines the
4097 "=" operator to use this same indentation algorithm rather than
4098 calling an external program if 'equalprg' is empty.
4099 This option is not used when 'paste' is set.
4100 {Vi: Does it a little bit differently}
4101
4102 *'lispwords'* *'lw'*
4103'lispwords' 'lw' string (default is very long)
4104 global
4105 {not in Vi}
4106 {not available when compiled without the |+lispindent|
4107 feature}
4108 Comma separated list of words that influence the Lisp indenting.
4109 |'lisp'|
4110
4111 *'list'* *'nolist'*
4112'list' boolean (default off)
4113 local to window
4114 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4115 see the difference between tabs and spaces and for trailing blanks.
4116 Note that this will also affect formatting (set with 'textwidth' or
4117 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4118 changing the way tabs are displayed.
4119
4120 *'listchars'* *'lcs'*
4121'listchars' 'lcs' string (default "eol:$")
4122 global
4123 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004124 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125 settings.
4126 eol:c Character to show at the end of each line. When
4127 omitted, there is no extra character at the end of the
4128 line.
4129 tab:xy Two characters to be used to show a Tab. The first
4130 char is used once. The second char is repeated to
4131 fill the space that the Tab normally occupies.
4132 "tab:>-" will show a Tab that takes four spaces as
4133 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004134 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 trailing spaces are blank.
4136 extends:c Character to show in the last column, when 'wrap' is
4137 off and the line continues beyond the right of the
4138 screen.
4139 precedes:c Character to show in the first column, when 'wrap'
4140 is off and there is text preceding the character
4141 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004142 nbsp:c Character to show for a non-breakable space (character
4143 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004144
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004145 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 be used when 'encoding' is "utf-8", otherwise only printable
4147 characters are allowed.
4148
4149 Examples: >
4150 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004151 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 :set lcs=extends:>,precedes:<
4153< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004154 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155
4156 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4157'loadplugins' 'lpl' boolean (default on)
4158 global
4159 {not in Vi}
4160 When on the plugin scripts are loaded when starting up |load-plugins|.
4161 This option can be reset in your |vimrc| file to disable the loading
4162 of plugins.
4163 Note that using the "-u NONE" and "--noplugin" command line arguments
4164 reset this option. |-u| |--noplugin|
4165
4166 *'magic'* *'nomagic'*
4167'magic' boolean (default on)
4168 global
4169 Changes the special characters that can be used in search patterns.
4170 See |pattern|.
4171 NOTE: To avoid portability problems with using patterns, always keep
4172 this option at the default "on". Only switch it off when working with
4173 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004174 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175
4176 *'makeef'* *'mef'*
4177'makeef' 'mef' string (default: "")
4178 global
4179 {not in Vi}
4180 {not available when compiled without the |+quickfix|
4181 feature}
4182 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4183 and the |:grep| command.
4184 When it is empty, an internally generated temp file will be used.
4185 When "##" is included, it is replaced by a number to make the name
4186 unique. This makes sure that the ":make" command doesn't overwrite an
4187 existing file.
4188 NOT used for the ":cf" command. See 'errorfile' for that.
4189 Environment variables are expanded |:set_env|.
4190 See |option-backslash| about including spaces and backslashes.
4191 This option cannot be set from a |modeline| or in the |sandbox|, for
4192 security reasons.
4193
4194 *'makeprg'* *'mp'*
4195'makeprg' 'mp' string (default "make", VMS: "MMS")
4196 global or local to buffer |global-local|
4197 {not in Vi}
4198 Program to use for the ":make" command. See |:make_makeprg|. This
4199 option may contain '%' and '#' characters, which are expanded like
4200 when used in a command-line. Environment variables are expanded
4201 |:set_env|. See |option-backslash| about including spaces and
4202 backslashes. Note that a '|' must be escaped twice: once for ":set"
4203 and once for the interpretation of a command. When you use a filter
4204 called "myfilter" do it like this: >
4205 :set makeprg=gmake\ \\\|\ myfilter
4206< The placeholder "$*" can be given (even multiple times) to specify
4207 where the arguments will be included, for example: >
4208 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4209< This option cannot be set from a |modeline| or in the |sandbox|, for
4210 security reasons.
4211
4212 *'matchpairs'* *'mps'*
4213'matchpairs' 'mps' string (default "(:),{:},[:]")
4214 local to buffer
4215 {not in Vi}
4216 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 must be different. The characters must be separated by a colon. The
4219 pairs must be separated by a comma. Example for including '<' and '>'
4220 (HTML): >
4221 :set mps+=<:>
4222
4223< A more exotic example, to jump between the '=' and ';' in an
4224 assignment, useful for languages like C and Java: >
4225 :au FileType c,cpp,java set mps+==:;
4226
4227< For a more advanced way of using "%", see the matchit.vim plugin in
4228 the $VIMRUNTIME/macros directory. |add-local-help|
4229
4230 *'matchtime'* *'mat'*
4231'matchtime' 'mat' number (default 5)
4232 global
4233 {not in Vi}{in Nvi}
4234 Tenths of a second to show the matching paren, when 'showmatch' is
4235 set. Note that this is not in milliseconds, like other options that
4236 set a time. This is to be compatible with Nvi.
4237
4238 *'maxfuncdepth'* *'mfd'*
4239'maxfuncdepth' 'mfd' number (default 100)
4240 global
4241 {not in Vi}
4242 Maximum depth of function calls for user functions. This normally
4243 catches endless recursion. When using a recursive function with
4244 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4245 more memory, there is the danger of failing when memory is exhausted.
4246 See also |:function|.
4247
4248 *'maxmapdepth'* *'mmd'* *E223*
4249'maxmapdepth' 'mmd' number (default 1000)
4250 global
4251 {not in Vi}
4252 Maximum number of times a mapping is done without resulting in a
4253 character to be used. This normally catches endless mappings, like
4254 ":map x y" with ":map y x". It still does not catch ":map g wg",
4255 because the 'w' is used before the next mapping is done. See also
4256 |key-mapping|.
4257
4258 *'maxmem'* *'mm'*
4259'maxmem' 'mm' number (default between 256 to 5120 (system
4260 dependent) or half the amount of memory
4261 available)
4262 global
4263 {not in Vi}
4264 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4265 limit is reached allocating extra memory for a buffer will cause
4266 other memory to be freed. Maximum value 2000000. Use this to work
4267 without a limit. Also see 'maxmemtot'.
4268
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004269 *'maxmempattern'* *'mmp'*
4270'maxmempattern' 'mmp' number (default 1000)
4271 global
4272 {not in Vi}
4273 Maximum amount of memory (in Kbyte) to use for pattern matching.
4274 Maximum value 2000000. Use this to work without a limit.
4275 *E363*
4276 When Vim runs into the limit it gives an error message mostly behaves
4277 like CTRL-C was typed.
4278 Running into the limit often means that the pattern is very
4279 inefficient or too complex. This may already happen with the pattern
4280 "\(.\)*" on a very long line. ".*" works much better.
4281 Vim may run out of memory before hitting the 'maxmempattern' limit.
4282
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 *'maxmemtot'* *'mmt'*
4284'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4285 dependent) or half the amount of memory
4286 available)
4287 global
4288 {not in Vi}
4289 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004290 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 'maxmem'.
4292
4293 *'menuitems'* *'mis'*
4294'menuitems' 'mis' number (default 25)
4295 global
4296 {not in Vi}
4297 {not available when compiled without the |+menu|
4298 feature}
4299 Maximum number of items to use in a menu. Used for menus that are
4300 generated from a list of items, e.g., the Buffers menu. Changing this
4301 option has no direct effect, the menu must be refreshed first.
4302
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004303 *'mkspellmem'* *'msm'*
4304'mkspellmem' 'msm' string (default "460000,2000,500")
4305 global
4306 {not in Vi}
4307 {not available when compiled without the |+syntax|
4308 feature}
4309 Parameters for |:mkspell|. This tunes when to start compressing the
4310 word tree. Compression can be slow when there are many words, but
4311 it's needed to avoid running out of memory. The amount of memory used
4312 per word depends very much on how similar the words are, that's why
4313 this tuning is complicated.
4314
4315 There are three numbers, separated by commas:
4316 {start},{inc},{added}
4317
4318 For most languages the uncompressed word tree fits in memory. {start}
4319 gives the amount of memory in Kbyte that can be used before any
4320 compression is done. It should be a bit smaller than the amount of
4321 memory that is available to Vim.
4322
4323 When going over the {start} limit the {inc} number specifies the
4324 amount of memory in Kbyte that can be allocated before another
4325 compression is done. A low number means compression is done after
4326 less words are added, which is slow. A high number means more memory
4327 will be allocated.
4328
4329 After doing compression, {added} times 1024 words can be added before
4330 the {inc} limit is ignored and compression is done when any extra
4331 amount of memory is needed. A low number means there is a smaller
4332 chance of hitting the {inc} limit, less memory is used but it's
4333 slower.
4334
4335 The languages for which these numbers are important are Italian and
4336 Hungarian. The default works for when you have about 512 Mbyte. If
4337 you have 1 Gbyte you could use: >
4338 :set mkspellmem=900000,3000,800
4339< If you have less than 512 Mbyte |:mkspell| may fail for some
4340 languages, no matter what you set 'mkspellmem' to.
4341
Bram Moolenaar071d4272004-06-13 20:20:40 +00004342 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
4343'modeline' 'ml' boolean (Vim default: on, Vi default: off)
4344 local to buffer
4345 *'modelines'* *'mls'*
4346'modelines' 'mls' number (default 5)
4347 global
4348 {not in Vi}
4349 If 'modeline' is on 'modelines' gives the number of lines that is
4350 checked for set commands. If 'modeline' is off or 'modelines' is zero
4351 no lines are checked. See |modeline|.
4352 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4353 set and to the Vim default value when 'compatible' is reset.
4354
4355 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4356'modifiable' 'ma' boolean (default on)
4357 local to buffer
4358 {not in Vi} *E21*
4359 When off the buffer contents cannot be changed. The 'fileformat' and
4360 'fileencoding' options also can't be changed.
4361 Can be reset with the |-M| command line argument.
4362
4363 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4364'modified' 'mod' boolean (default off)
4365 local to buffer
4366 {not in Vi}
4367 When on, the buffer is considered to be modified. This option is set
4368 when:
4369 1. A change was made to the text since it was last written. Using the
4370 |undo| command to go back to the original text will reset the
4371 option. But undoing changes that were made before writing the
4372 buffer will set the option again, since the text is different from
4373 when it was written.
4374 2. 'fileformat' or 'fileencoding' is different from its original
4375 value. The original value is set when the buffer is read or
4376 written. A ":set nomodified" command also resets the original
4377 values to the current values and the 'modified' option will be
4378 reset.
4379 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4380 will be ignored.
4381
4382 *'more'* *'nomore'*
4383'more' boolean (Vim default: on, Vi default: off)
4384 global
4385 {not in Vi}
4386 When on, listings pause when the whole screen is filled. You will get
4387 the |more-prompt|. When this option is off there are no pauses, the
4388 listing continues until finished.
4389 NOTE: This option is set to the Vi default value when 'compatible' is
4390 set and to the Vim default value when 'compatible' is reset.
4391
4392 *'mouse'* *E538*
4393'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4394 global
4395 {not in Vi}
4396 Enable the use of the mouse. Only works for certain terminals
4397 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4398 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4399 The mouse can be enabled for different modes:
4400 n Normal mode
4401 v Visual mode
4402 i Insert mode
4403 c Command-line mode
4404 h all previous modes when editing a help file
4405 a all previous modes
4406 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 Normally you would enable the mouse in all four modes with: >
4408 :set mouse=a
4409< When the mouse is not enabled, the GUI will still use the mouse for
4410 modeless selection. This doesn't move the text cursor.
4411
4412 See |mouse-using|. Also see |'clipboard'|.
4413
4414 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004415 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 the mouse buttons can still be used by keeping the shift key pressed.
4417 Also see the 'clipboard' option.
4418
4419 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4420'mousefocus' 'mousef' boolean (default off)
4421 global
4422 {not in Vi}
4423 {only works in the GUI}
4424 The window that the mouse pointer is on is automatically activated.
4425 When changing the window layout or window focus in another way, the
4426 mouse pointer is moved to the window with keyboard focus. Off is the
4427 default because it makes using the pull down menus a little goofy, as
4428 a pointer transit may activate a window unintentionally.
4429
4430 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4431'mousehide' 'mh' boolean (default on)
4432 global
4433 {not in Vi}
4434 {only works in the GUI}
4435 When on, the mouse pointer is hidden when characters are typed.
4436 The mouse pointer is restored when the mouse is moved.
4437
4438 *'mousemodel'* *'mousem'*
4439'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4440 global
4441 {not in Vi}
4442 Sets the model to use for the mouse. The name mostly specifies what
4443 the right mouse button is used for:
4444 extend Right mouse button extends a selection. This works
4445 like in an xterm.
4446 popup Right mouse button pops up a menu. The shifted left
4447 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004448 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004449 popup_setpos Like "popup", but the cursor will be moved to the
4450 position where the mouse was clicked, and thus the
4451 selected operation will act upon the clicked object.
4452 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004453 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 course, that right clicking outside a selection will
4455 end Visual mode.
4456 Overview of what button does what for each model:
4457 mouse extend popup(_setpos) ~
4458 left click place cursor place cursor
4459 left drag start selection start selection
4460 shift-left search word extend selection
4461 right click extend selection popup menu (place cursor)
4462 right drag extend selection -
4463 middle click paste paste
4464
4465 In the "popup" model the right mouse button produces a pop-up menu.
4466 You need to define this first, see |popup-menu|.
4467
4468 Note that you can further refine the meaning of buttons with mappings.
4469 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4470 selection (because that's handled in the GUI code directly).
4471
4472 The 'mousemodel' option is set by the |:behave| command.
4473
4474 *'mouseshape'* *'mouses'* *E547*
4475'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004476 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 global
4478 {not in Vi}
4479 {only available when compiled with the |+mouseshape|
4480 feature}
4481 This option tells Vim what the mouse pointer should look like in
4482 different modes. The option is a comma separated list of parts, much
4483 like used for 'guicursor'. Each part consist of a mode/location-list
4484 and an argument-list:
4485 mode-list:shape,mode-list:shape,..
4486 The mode-list is a dash separated list of these modes/locations:
4487 In a normal window: ~
4488 n Normal mode
4489 v Visual mode
4490 ve Visual mode with 'selection' "exclusive" (same as 'v',
4491 if not specified)
4492 o Operator-pending mode
4493 i Insert mode
4494 r Replace mode
4495
4496 Others: ~
4497 c appending to the command-line
4498 ci inserting in the command-line
4499 cr replacing in the command-line
4500 m at the 'Hit ENTER' or 'More' prompts
4501 ml idem, but cursor in the last line
4502 e any mode, pointer below last window
4503 s any mode, pointer on a status line
4504 sd any mode, while dragging a status line
4505 vs any mode, pointer on a vertical separator line
4506 vd any mode, while dragging a vertical separator line
4507 a everywhere
4508
4509 The shape is one of the following:
4510 avail name looks like ~
4511 w x arrow Normal mouse pointer
4512 w x blank no pointer at all (use with care!)
4513 w x beam I-beam
4514 w x updown up-down sizing arrows
4515 w x leftright left-right sizing arrows
4516 w x busy The system's usual busy pointer
4517 w x no The system's usual 'no input' pointer
4518 x udsizing indicates up-down resizing
4519 x lrsizing indicates left-right resizing
4520 x crosshair like a big thin +
4521 x hand1 black hand
4522 x hand2 white hand
4523 x pencil what you write with
4524 x question big ?
4525 x rightup-arrow arrow pointing right-up
4526 w x up-arrow arrow pointing up
4527 x <number> any X11 pointer number (see X11/cursorfont.h)
4528
4529 The "avail" column contains a 'w' if the shape is available for Win32,
4530 x for X11.
4531 Any modes not specified or shapes not available use the normal mouse
4532 pointer.
4533
4534 Example: >
4535 :set mouseshape=s:udsizing,m:no
4536< will make the mouse turn to a sizing arrow over the status lines and
4537 indicate no input when the hit-enter prompt is displayed (since
4538 clicking the mouse has no effect in this state.)
4539
4540 *'mousetime'* *'mouset'*
4541'mousetime' 'mouset' number (default 500)
4542 global
4543 {not in Vi}
4544 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4545 time in msec between two mouse clicks for the second click to be
4546 recognized as a multi click.
4547
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004548 *'mzquantum'* *'mzq'*
4549'mzquantum' 'mzq' number (default 100)
4550 global
4551 {not in Vi}
4552 {not available when compiled without the |+mzscheme|
4553 feature}
4554 The number of milliseconds between polls for MzScheme threads.
4555 Negative or zero value means no thread scheduling.
4556
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 *'nrformats'* *'nf'*
4558'nrformats' 'nf' string (default "octal,hex")
4559 local to buffer
4560 {not in Vi}
4561 This defines what bases Vim will consider for numbers when using the
4562 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4563 respectively; see |CTRL-A| for more info on these commands.
4564 alpha if included, single alphabetical characters will be
4565 incremented or decremented. This is useful for a list with a
4566 letter index a), b), etc.
4567 octal if included, numbers that start with a zero will be considered
4568 to be octal. Example: Using CTRL-A on "007" results in "010".
4569 hex if included, numbers starting with "0x" or "0X" will be
4570 considered to be hexadecimal. Example: Using CTRL-X on
4571 "0x100" results in "0x0ff".
4572 Numbers which simply begin with a digit in the range 1-9 are always
4573 considered decimal. This also happens for numbers that are not
4574 recognized as octal or hex.
4575
4576 *'number'* *'nu'* *'nonumber'* *'nonu'*
4577'number' 'nu' boolean (default off)
4578 local to window
4579 Print the line number in front of each line. When the 'n' option is
4580 excluded from 'cpoptions' a wrapped line will not use the column of
4581 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004582 The 'numberwidth' option can be used to set the room used for the line
4583 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 When a long, wrapped line doesn't start with the first character, '-'
4585 characters are put before the number.
4586 See |hl-LineNr| for the highlighting used for the number.
4587
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004588 *'numberwidth'* *'nuw'*
4589'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4590 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004591 {not in Vi}
4592 {only available when compiled with the |+linebreak|
4593 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004594 Minimal number of columns to use for the line number. Only relevant
4595 when the 'number' option is set.
4596 Since one space is always between the number and the text, there is
4597 one less character for the number itself.
4598 The value is the minimum width. A bigger width is used when needed to
4599 fit the highest line number in the buffer. Thus with the Vim default
4600 of 4 there is room for a line number up to 999. When the buffer has
4601 1000 lines five columns will be used.
4602 The minimum value is 1, the maximum value is 10.
4603 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4604
Bram Moolenaare344bea2005-09-01 20:46:49 +00004605 *'occultfunc'* *'ofu'*
4606'occultfunc' 'ofu' string (default: empty)
4607 local to buffer
4608 {not in Vi}
4609 {not available when compiled without the +eval
4610 or +insert_expand feature}
4611 This option specifies a function to be used for CTRL-X CTRL-O
4612 completion. |i_CTRL-X_CTRL-O|
4613
4614 For the use of the function see 'completefunc'.
4615
4616
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 *'osfiletype'* *'oft'* *E366*
4618'osfiletype' 'oft' string (RISC-OS default: "Text",
4619 others default: "")
4620 local to buffer
4621 {not in Vi}
4622 {only available when compiled with the |+osfiletype|
4623 feature}
4624 Some operating systems store extra information about files besides
4625 name, datestamp and permissions. This option contains the extra
4626 information, the nature of which will vary between systems.
4627 The value of this option is usually set when the file is loaded, and
4628 use to set the file type when file is written.
4629 It can affect the pattern matching of the automatic commands.
4630 |autocmd-osfiletypes|
4631
4632 *'paragraphs'* *'para'*
4633'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4634 global
4635 Specifies the nroff macros that separate paragraphs. These are pairs
4636 of two letters (see |object-motions|).
4637
4638 *'paste'* *'nopaste'*
4639'paste' boolean (default off)
4640 global
4641 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004642 Put Vim in Paste mode. This is useful if you want to cut or copy
4643 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004644 unexpected effects.
4645 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 knows about pasting and will mostly do the right thing without 'paste'
4648 being set. The same is true for a terminal where Vim handles the
4649 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004650 This option is reset when starting the GUI. Thus if you set it in
4651 your .vimrc it will work in a terminal, but not in the GUI. Setting
4652 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4653 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 When the 'paste' option is switched on (also when it was already on):
4655 - mapping in Insert mode and Command-line mode is disabled
4656 - abbreviations are disabled
4657 - 'textwidth' is set to 0
4658 - 'wrapmargin' is set to 0
4659 - 'autoindent' is reset
4660 - 'smartindent' is reset
4661 - 'softtabstop' is set to 0
4662 - 'revins' is reset
4663 - 'ruler' is reset
4664 - 'showmatch' is reset
4665 - 'formatoptions' is used like it is empty
4666 These options keep their value, but their effect is disabled:
4667 - 'lisp'
4668 - 'indentexpr'
4669 - 'cindent'
4670 NOTE: When you start editing another file while the 'paste' option is
4671 on, settings from the modelines or autocommands may change the
4672 settings again, causing trouble when pasting text. You might want to
4673 set the 'paste' option again.
4674 When the 'paste' option is reset the mentioned options are restored to
4675 the value before the moment 'paste' was switched from off to on.
4676 Resetting 'paste' before ever setting it does not have any effect.
4677 Since mapping doesn't work while 'paste' is active, you need to use
4678 the 'pastetoggle' option to toggle the 'paste' option with some key.
4679
4680 *'pastetoggle'* *'pt'*
4681'pastetoggle' 'pt' string (default "")
4682 global
4683 {not in Vi}
4684 When non-empty, specifies the key sequence that toggles the 'paste'
4685 option. This is like specifying a mapping: >
4686 :map {keys} :set invpaste<CR>
4687< Where {keys} is the value of 'pastetoggle'.
4688 The difference is that it will work even when 'paste' is set.
4689 'pastetoggle' works in Insert mode and Normal mode, but not in
4690 Command-line mode.
4691 Mappings are checked first, thus overrule 'pastetoggle'. However,
4692 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4693 this: >
4694 :map <F10> :set paste<CR>
4695 :map <F11> :set nopaste<CR>
4696 :imap <F10> <C-O>:set paste<CR>
4697 :imap <F11> <nop>
4698 :set pastetoggle=<F11>
4699< This will make <F10> start paste mode and <F11> stop paste mode.
4700 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4701 mode everything is inserted literally, except the 'pastetoggle' key
4702 sequence.
4703
4704 *'pex'* *'patchexpr'*
4705'patchexpr' 'pex' string (default "")
4706 global
4707 {not in Vi}
4708 {not available when compiled without the |+diff|
4709 feature}
4710 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004711 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712
4713 *'patchmode'* *'pm'* *E206*
4714'patchmode' 'pm' string (default "")
4715 global
4716 {not in Vi}
4717 When non-empty the oldest version of a file is kept. This can be used
4718 to keep the original version of a file if you are changing files in a
4719 source distribution. Only the first time that a file is written a
4720 copy of the original file will be kept. The name of the copy is the
4721 name of the original file with the string in the 'patchmode' option
4722 appended. This option should start with a dot. Use a string like
4723 ".org". 'backupdir' must not be empty for this to work (Detail: The
4724 backup file is renamed to the patchmode file after the new file has
4725 been successfully written, that's why it must be possible to write a
4726 backup file). If there was no file to be backed up, an empty file is
4727 created.
4728 When the 'backupskip' pattern matches, a patchmode file is not made.
4729 Using 'patchmode' for compressed files appends the extension at the
4730 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4731 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004732 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733
4734 *'path'* *'pa'* *E343* *E345* *E347*
4735'path' 'pa' string (default on Unix: ".,/usr/include,,"
4736 on OS/2: ".,/emx/include,,"
4737 other systems: ".,,")
4738 global or local to buffer |global-local|
4739 {not in Vi}
4740 This is a list of directories which will be searched when using the
4741 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4742 being searched for has a relative path (not starting with '/'). The
4743 directories in the 'path' option may be relative or absolute.
4744 - Use commas to separate directory names: >
4745 :set path=.,/usr/local/include,/usr/include
4746< - Spaces can also be used to separate directory names (for backwards
4747 compatibility with version 3.0). To have a space in a directory
4748 name, precede it with an extra backslash, and escape the space: >
4749 :set path=.,/dir/with\\\ space
4750< - To include a comma in a directory name precede it with an extra
4751 backslash: >
4752 :set path=.,/dir/with\\,comma
4753< - To search relative to the directory of the current file, use: >
4754 :set path=.
4755< - To search in the current directory use an empty string between two
4756 commas: >
4757 :set path=,,
4758< - A directory name may end in a ':' or '/'.
4759 - Environment variables are expanded |:set_env|.
4760 - When using |netrw.vim| URLs can be used. For example, adding
4761 "http://www.vim.org" will make ":find index.html" work.
4762 - Search upwards and downwards in a directory tree:
4763 1) "*" matches a sequence of characters, e.g.: >
4764 :set path=/usr/include/*
4765< means all subdirectories in /usr/include (but not /usr/include
4766 itself). >
4767 :set path=/usr/*c
4768< matches /usr/doc and /usr/src.
4769 2) "**" matches a subtree, up to 100 directories deep. Example: >
4770 :set path=/home/user_x/src/**
4771< means search in the whole subtree under "/home/usr_x/src".
4772 3) If the path ends with a ';', this path is the startpoint
4773 for upward search.
4774 See |file-searching| for more info and exact syntax.
4775 {not available when compiled without the |+path_extra| feature}
4776 - Careful with '\' characters, type two to get one in the option: >
4777 :set path=.,c:\\include
4778< Or just use '/' instead: >
4779 :set path=.,c:/include
4780< Don't forget "." or files won't even be found in the same directory as
4781 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004782 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 it is something like 256 or 1024 characters.
4784 You can check if all the include files are found, using the value of
4785 'path', see |:checkpath|.
4786 The use of |:set+=| and |:set-=| is preferred when adding or removing
4787 directories from the list. This avoids problems when a future version
4788 uses another default. To remove the current directory use: >
4789 :set path-=
4790< To add the current directory use: >
4791 :set path+=
4792< To use an environment variable, you probably need to replace the
4793 separator. Here is an example to append $INCL, in which directory
4794 names are separated with a semi-colon: >
4795 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
4796< Replace the ';' with a ':' or whatever separator is used. Note that
4797 this doesn't work when $INCL contains a comma or white space.
4798
4799 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
4800'preserveindent' 'pi' boolean (default off)
4801 local to buffer
4802 {not in Vi}
4803 When changing the indent of the current line, preserve as much of the
4804 indent structure as possible. Normally the indent is replaced by a
4805 series of tabs followed by spaces as required (unless |'expandtab'| is
4806 enabled, in which case only spaces are used). Enabling this option
4807 means the indent will preserve as many existing characters as possible
4808 for indenting, and only add additional tabs or spaces as required.
4809 NOTE: When using ">>" multiple times the resulting indent is a mix of
4810 tabs and spaces. You might not like this.
4811 NOTE: 'preserveindent' is reset when 'compatible' is set.
4812 Also see 'copyindent'.
4813 Use |:retab| to clean up white space.
4814
4815 *'previewheight'* *'pvh'*
4816'previewheight' 'pvh' number (default 12)
4817 global
4818 {not in Vi}
4819 {not available when compiled without the |+windows| or
4820 |+quickfix| feature}
4821 Default height for a preview window. Used for |:ptag| and associated
4822 commands. Used for |CTRL-W_}| when no count is given.
4823
4824 *'previewwindow'* *'nopreviewwindow'*
4825 *'pvw'* *'nopvw'* *E590*
4826'previewwindow' 'pvw' boolean (default off)
4827 local to window
4828 {not in Vi}
4829 {not available when compiled without the |+windows| or
4830 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004831 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 set. It's normally not set directly, but by using one of the commands
4833 |:ptag|, |:pedit|, etc.
4834
4835 *'printdevice'* *'pdev'*
4836'printdevice' 'pdev' string (default empty)
4837 global
4838 {not in Vi}
4839 {only available when compiled with the |+printer|
4840 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004841 The name of the printer to be used for |:hardcopy|.
4842 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004843 This option cannot be set from a |modeline| or in the |sandbox|, for
4844 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845
Bram Moolenaar8299df92004-07-10 09:47:34 +00004846 *'printencoding'* *'penc'*
4847'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 global
4849 {not in Vi}
4850 {only available when compiled with the |+printer|
4851 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004852 Sets the character encoding used when printing.
4853 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854
4855 *'printexpr'* *'pexpr'*
4856'printexpr' 'pexpr' String (default: see below)
4857 global
4858 {not in Vi}
4859 {only available when compiled with the |+printer|
4860 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004861 Expression used to print the PostScript produced with |:hardcopy|.
4862 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863
Bram Moolenaar8299df92004-07-10 09:47:34 +00004864 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865'printfont' 'pfn' string (default "courier")
4866 global
4867 {not in Vi}
4868 {only available when compiled with the |+printer|
4869 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004870 The name of the font that will be used for |:hardcopy|.
4871 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872
4873 *'printheader'* *'pheader'*
4874'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
4875 global
4876 {not in Vi}
4877 {only available when compiled with the |+printer|
4878 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004879 The format of the header produced in |:hardcopy| output.
4880 See |pheader-option|.
4881
4882 *'printmbcharset'* *'pmbcs'*
4883'printmbcharset' 'pmbcs' string (default "")
4884 global
4885 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004886 {only available when compiled with the |+printer|,
4887 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004888 The CJK character set to be used for CJK output from |:hardcopy|.
4889 See |pmbcs-option|.
4890
4891 *'printmbfont'* *'pmbfn'*
4892'printmbfont' 'pmbfn' string (default "")
4893 global
4894 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004895 {only available when compiled with the |+printer|,
4896 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004897 List of font names to be used for CJK output from |:hardcopy|.
4898 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
4900 *'printoptions'* *'popt'*
4901'printoptions' 'popt' string (default "")
4902 global
4903 {not in Vi}
4904 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00004905 List of items that control the format of the output of |:hardcopy|.
4906 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907
Bram Moolenaar26a60b42005-02-22 08:49:11 +00004908 *'prompt'* *'noprompt'*
4909'prompt' boolean (default on)
4910 global
4911 When on a ":" prompt is used in Ex mode.
4912
Bram Moolenaar677ee682005-01-27 14:41:15 +00004913 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004914'quoteescape' 'qe' string (default "\")
4915 local to buffer
4916 {not in Vi}
4917 The characters that are used to escape quotes in a string. Used for
4918 objects like a', a" and a` |a'|.
4919 When one of the characters in this option is found inside a string,
4920 the following character will be skipped. The default value makes the
4921 text "foo\"bar\\" considered to be one string.
4922
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
4924'readonly' 'ro' boolean (default off)
4925 local to buffer
4926 If on, writes fail unless you use a '!'. Protects you from
4927 accidentally overwriting a file. Default on when Vim is started
4928 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004929 When using ":w!" the 'readonly' option is reset for the current
4930 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004931 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00004932 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
4934 *'remap'* *'noremap'*
4935'remap' boolean (default on)
4936 global
4937 Allows for mappings to work recursively. If you do not want this for
4938 a single entry, use the :noremap[!] command.
4939
4940 *'report'*
4941'report' number (default 2)
4942 global
4943 Threshold for reporting number of lines changed. When the number of
4944 changed lines is more than 'report' a message will be given for most
4945 ":" commands. If you want it always, set 'report' to 0.
4946 For the ":substitute" command the number of substitutions is used
4947 instead of the number of lines.
4948
4949 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
4950'restorescreen' 'rs' boolean (default on)
4951 global
4952 {not in Vi} {only in Windows 95/NT console version}
4953 When set, the screen contents is restored when exiting Vim. This also
4954 happens when executing external commands.
4955
4956 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
4957 options in your .vimrc. To disable restoring:
4958 set t_ti= t_te=
4959 To enable restoring (for an xterm):
4960 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
4961 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
4962
4963 *'revins'* *'ri'* *'norevins'* *'nori'*
4964'revins' 'ri' boolean (default off)
4965 global
4966 {not in Vi}
4967 {only available when compiled with the |+rightleft|
4968 feature}
4969 Inserting characters in Insert mode will work backwards. See "typing
4970 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
4971 command in Insert mode, when 'allowrevins' is set.
4972 NOTE: This option is reset when 'compatible' or 'paste' is set.
4973
4974 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
4975'rightleft' 'rl' boolean (default off)
4976 local to window
4977 {not in Vi}
4978 {only available when compiled with the |+rightleft|
4979 feature}
4980 When on, display orientation becomes right-to-left, i.e., characters
4981 that are stored in the file appear from the right to the left.
4982 Using this option, it is possible to edit files for languages that
4983 are written from the right to the left such as Hebrew and Arabic.
4984 This option is per window, so it is possible to edit mixed files
4985 simultaneously, or to view the same file in both ways (this is
4986 useful whenever you have a mixed text file with both right-to-left
4987 and left-to-right strings so that both sets are displayed properly
4988 in different windows). Also see |rileft.txt|.
4989
4990 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
4991'rightleftcmd' 'rlc' string (default "search")
4992 local to window
4993 {not in Vi}
4994 {only available when compiled with the |+rightleft|
4995 feature}
4996 Each word in this option enables the command line editing to work in
4997 right-to-left mode for a group of commands:
4998
4999 search "/" and "?" commands
5000
5001 This is useful for languages such as Hebrew, Arabic and Farsi.
5002 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5003
5004 *'ruler'* *'ru'* *'noruler'* *'noru'*
5005'ruler' 'ru' boolean (default off)
5006 global
5007 {not in Vi}
5008 {not available when compiled without the
5009 |+cmdline_info| feature}
5010 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005011 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 text in the file is shown on the far right:
5013 Top first line is visible
5014 Bot last line is visible
5015 All first and last line are visible
5016 45% relative position in the file
5017 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005018 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005020 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021 this option takes precedence over 'ruler' and 'rulerformat'
5022 If the number of characters displayed is different from the number of
5023 bytes in the text (e.g., for a TAB or a multi-byte character), both
5024 the text column (byte number) and the screen column are shown,
5025 separated with a dash.
5026 For an empty line "0-1" is shown.
5027 For an empty buffer the line number will also be zero: "0,0-1".
5028 This option is reset when the 'paste' option is set.
5029 If you don't want to see the ruler all the time but want to know where
5030 you are, use "g CTRL-G" |g_CTRL-G|.
5031 NOTE: This option is reset when 'compatible' is set.
5032
5033 *'rulerformat'* *'ruf'*
5034'rulerformat' 'ruf' string (default empty)
5035 global
5036 {not in Vi}
5037 {not available when compiled without the |+statusline|
5038 feature}
5039 When this option is not empty, it determines the content of the ruler
5040 string, as displayed for the 'ruler' option.
5041 The format of this option, is like that of 'statusline'.
5042 The default ruler width is 17 characters. To make the ruler 15
5043 characters wide, put "%15(" at the start and "%)" at the end.
5044 Example: >
5045 :set rulerformat=%15(%c%V\ %p%%%)
5046<
5047 *'runtimepath'* *'rtp'* *vimfiles*
5048'runtimepath' 'rtp' string (default:
5049 Unix: "$HOME/.vim,
5050 $VIM/vimfiles,
5051 $VIMRUNTIME,
5052 $VIM/vimfiles/after,
5053 $HOME/.vim/after"
5054 Amiga: "home:vimfiles,
5055 $VIM/vimfiles,
5056 $VIMRUNTIME,
5057 $VIM/vimfiles/after,
5058 home:vimfiles/after"
5059 PC, OS/2: "$HOME/vimfiles,
5060 $VIM/vimfiles,
5061 $VIMRUNTIME,
5062 $VIM/vimfiles/after,
5063 $HOME/vimfiles/after"
5064 Macintosh: "$VIM:vimfiles,
5065 $VIMRUNTIME,
5066 $VIM:vimfiles:after"
5067 RISC-OS: "Choices:vimfiles,
5068 $VIMRUNTIME,
5069 Choices:vimfiles/after"
5070 VMS: "sys$login:vimfiles,
5071 $VIM/vimfiles,
5072 $VIMRUNTIME,
5073 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005074 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 global
5076 {not in Vi}
5077 This is a list of directories which will be searched for runtime
5078 files:
5079 filetype.vim filetypes by file name |new-filetype|
5080 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005081 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 colors/ color scheme files |:colorscheme|
5083 compiler/ compiler files |:compiler|
5084 doc/ documentation |write-local-help|
5085 ftplugin/ filetype plugins |write-filetype-plugin|
5086 indent/ indent scripts |indent-expression|
5087 keymap/ key mapping files |mbyte-keymap|
5088 lang/ menu translations |:menutrans|
5089 menu.vim GUI menus |menu.vim|
5090 plugin/ plugin scripts |write-plugin|
5091 print/ files for printing |postscript-print-encoding|
5092 syntax/ syntax files |mysyntaxfile|
5093 tutor/ files for vimtutor |tutor|
5094
5095 And any other file searched for with the |:runtime| command.
5096
5097 The defaults for most systems are setup to search five locations:
5098 1. In your home directory, for your personal preferences.
5099 2. In a system-wide Vim directory, for preferences from the system
5100 administrator.
5101 3. In $VIMRUNTIME, for files distributed with Vim.
5102 *after-directory*
5103 4. In the "after" directory in the system-wide Vim directory. This is
5104 for the system administrator to overrule or add to the distributed
5105 defaults (rarely needed)
5106 5. In the "after" directory in your home directory. This is for
5107 personal preferences to overrule or add to the distributed defaults
5108 or system-wide settings (rarely needed).
5109
5110 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5111 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005112 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 wildcards.
5114 See |:runtime|.
5115 Example: >
5116 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5117< This will use the directory "~/vimruntime" first (containing your
5118 personal Vim runtime files), then "/mygroup/vim" (shared between a
5119 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5120 files).
5121 You probably should always include $VIMRUNTIME somewhere, to use the
5122 distributed runtime files. You can put a directory before $VIMRUNTIME
5123 to find files which replace a distributed runtime files. You can put
5124 a directory after $VIMRUNTIME to find files which add to distributed
5125 runtime files.
5126 This option cannot be set from a |modeline| or in the |sandbox|, for
5127 security reasons.
5128
5129 *'scroll'* *'scr'*
5130'scroll' 'scr' number (default: half the window height)
5131 local to window
5132 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5133 set to half the number of lines in the window when the window size
5134 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005135 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5137 the number of screen lines instead of file lines, makes a difference
5138 when lines wrap}
5139
5140 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5141'scrollbind' 'scb' boolean (default off)
5142 local to window
5143 {not in Vi}
5144 {not available when compiled without the |+scrollbind|
5145 feature}
5146 See also |scroll-binding|. When this option is set, the current
5147 window scrolls as other scrollbind windows (windows that also have
5148 this option set) scroll. This option is useful for viewing the
5149 differences between two versions of a file, see 'diff'.
5150 See |'scrollopt'| for options that determine how this option should be
5151 interpreted.
5152 This option is mostly reset when splitting a window to edit another
5153 file. This means that ":split | edit file" results in two windows
5154 with scroll-binding, but ":split file" does not.
5155
5156 *'scrolljump'* *'sj'*
5157'scrolljump' 'sj' number (default 1)
5158 global
5159 {not in Vi}
5160 Minimal number of lines to scroll when the cursor gets off the
5161 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5162 CTRL-D). Useful if your terminal scrolls very slowly.
5163 NOTE: This option is set to 1 when 'compatible' is set.
5164
5165 *'scrolloff'* *'so'*
5166'scrolloff' 'so' number (default 0)
5167 global
5168 {not in Vi}
5169 Minimal number of screen lines to keep above and below the cursor.
5170 This will make some context visible around where you are working. If
5171 you set it to a very large value (999) the cursor line will always be
5172 in the middle of the window (except at the start or end of the file or
5173 when long lines wrap).
5174 For scrolling horizontally see 'sidescrolloff'.
5175 NOTE: This option is set to 0 when 'compatible' is set.
5176
5177 *'scrollopt'* *'sbo'*
5178'scrollopt' 'sbo' string (default "ver,jump")
5179 global
5180 {not available when compiled without the |+scrollbind|
5181 feature}
5182 {not in Vi}
5183 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005184 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5185 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 The following words are available:
5187 ver Bind vertical scrolling for 'scrollbind' windows
5188 hor Bind horizontal scrolling for 'scrollbind' windows
5189 jump Applies to the offset between two windows for vertical
5190 scrolling. This offset is the difference in the first
5191 displayed line of the bound windows. When moving
5192 around in a window, another 'scrollbind' window may
5193 reach a position before the start or after the end of
5194 the buffer. The offset is not changed though, when
5195 moving back the 'scrollbind' window will try to scroll
5196 to the desired position when possible.
5197 When now making that window the current one, two
5198 things can be done with the relative offset:
5199 1. When "jump" is not included, the relative offset is
5200 adjusted for the scroll position in the new current
5201 window. When going back to the other window, the
5202 the new relative offset will be used.
5203 2. When "jump" is included, the other windows are
5204 scrolled to keep the same relative offset. When
5205 going back to the other window, it still uses the
5206 same relative offset.
5207 Also see |scroll-binding|.
5208
5209 *'sections'* *'sect'*
5210'sections' 'sect' string (default "SHNHH HUnhsh")
5211 global
5212 Specifies the nroff macros that separate sections. These are pairs of
5213 two letters (See |object-motions|). The default makes a section start
5214 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5215
5216 *'secure'* *'nosecure'* *E523*
5217'secure' boolean (default off)
5218 global
5219 {not in Vi}
5220 When on, ":autocmd", shell and write commands are not allowed in
5221 ".vimrc" and ".exrc" in the current directory and map commands are
5222 displayed. Switch it off only if you know that you will not run into
5223 problems, or when the 'exrc' option is off. On Unix this option is
5224 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005225 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 'secure' at the end of your ~/.vimrc then.
5227 This option cannot be set from a |modeline| or in the |sandbox|, for
5228 security reasons.
5229
5230 *'selection'* *'sel'*
5231'selection' 'sel' string (default "inclusive")
5232 global
5233 {not in Vi}
5234 This option defines the behavior of the selection. It is only used
5235 in Visual and Select mode.
5236 Possible values:
5237 value past line inclusive ~
5238 old no yes
5239 inclusive yes yes
5240 exclusive yes no
5241 "past line" means that the cursor is allowed to be positioned one
5242 character past the line.
5243 "inclusive" means that the last character of the selection is included
5244 in an operation. For example, when "x" is used to delete the
5245 selection.
5246 Note that when "exclusive" is used and selecting from the end
5247 backwards, you cannot include the last character of a line, when
5248 starting in Normal mode and 'virtualedit' empty.
5249
5250 The 'selection' option is set by the |:behave| command.
5251
5252 *'selectmode'* *'slm'*
5253'selectmode' 'slm' string (default "")
5254 global
5255 {not in Vi}
5256 This is a comma separated list of words, which specifies when to start
5257 Select mode instead of Visual mode, when a selection is started.
5258 Possible values:
5259 mouse when using the mouse
5260 key when using shifted special keys
5261 cmd when using "v", "V" or CTRL-V
5262 See |Select-mode|.
5263 The 'selectmode' option is set by the |:behave| command.
5264
5265 *'sessionoptions'* *'ssop'*
5266'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
5267 help,options,winsize")
5268 global
5269 {not in Vi}
5270 {not available when compiled without the +mksession
5271 feature}
5272 Changes the effect of the |:mksession| command. It is a comma
5273 separated list of words. Each word enables saving and restoring
5274 something:
5275 word save and restore ~
5276 blank empty windows
5277 buffers hidden and unloaded buffers, not just those in windows
5278 curdir the current directory
5279 folds manually created folds, opened/closed folds and local
5280 fold options
5281 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005282 and contain at least one lowercase letter. Only
5283 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005284 help the help window
5285 localoptions options and mappings local to a window or buffer (not
5286 global values for local options)
5287 options all options and mappings (also global values for local
5288 options)
5289 resize size of the Vim window: 'lines' and 'columns'
5290 sesdir the directory in which the session file is located
5291 will become the current directory (useful with
5292 projects accessed over a network from different
5293 systems)
5294 slash backslashes in file names replaced with forward
5295 slashes
5296 unix with Unix end-of-line format (single <NL>), even when
5297 on Windows or DOS
5298 winpos position of the whole Vim window
5299 winsize window sizes
5300
5301 Don't include both "curdir" and "sesdir".
5302 When "curdir" nor "sesdir" is included, file names are stored with
5303 absolute paths.
5304 "slash" and "unix" are useful on Windows when sharing session files
5305 with Unix. The Unix version of Vim cannot source dos format scripts,
5306 but the Windows version of Vim can source unix format scripts.
5307
5308 *'shell'* *'sh'* *E91*
5309'shell' 'sh' string (default $SHELL or "sh",
5310 MS-DOS and Win32: "command.com" or
5311 "cmd.exe", OS/2: "cmd")
5312 global
5313 Name of the shell to use for ! and :! commands. When changing the
5314 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5315 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005316 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317 See |option-backslash| about including spaces and backslashes.
5318 Environment variables are expanded |:set_env|.
5319 If the name of the shell contains a space, you might need to enclose
5320 it in quotes. Example: >
5321 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5322< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005323 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 "-f" is not inside the quotes, because it is not part of the command
5325 name. And Vim automagically recognizes the backslashes that are path
5326 separators.
5327 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5328 variable to change the way external commands are executed. See the
5329 libc.inf file of DJGPP.
5330 Under MS-Windows, when the executable ends in ".com" it must be
5331 included. Thus setting the shell to "command.com" or "4dos.com"
5332 works, but "command" and "4dos" do not work for all commands (e.g.,
5333 filtering).
5334 For unknown reasons, when using "4dos.com" the current directory is
5335 changed to "C:\". To avoid this set 'shell' like this: >
5336 :set shell=command.com\ /c\ 4dos
5337< This option cannot be set from a |modeline| or in the |sandbox|, for
5338 security reasons.
5339
5340 *'shellcmdflag'* *'shcf'*
5341'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5342 does not contain "sh" somewhere: "/c")
5343 global
5344 {not in Vi}
5345 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5346 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5347 systems, the default is set according to the value of 'shell', to
5348 reduce the need to set this option by the user. It's not used for
5349 OS/2 (EMX figures this out itself). See |option-backslash| about
5350 including spaces and backslashes. See |dos-shell|.
5351 This option cannot be set from a |modeline| or in the |sandbox|, for
5352 security reasons.
5353
5354 *'shellpipe'* *'sp'*
5355'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5356 global
5357 {not in Vi}
5358 {not available when compiled without the |+quickfix|
5359 feature}
5360 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005361 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 including spaces and backslashes.
5363 The name of the temporary file can be represented by "%s" if necessary
5364 (the file name is appended automatically if no %s appears in the value
5365 of this option).
5366 For the Amiga and MS-DOS the default is ">". The output is directly
5367 saved in a file and not echoed to the screen.
5368 For Unix the default it "| tee". The stdout of the compiler is saved
5369 in a file and echoed to the screen. If the 'shell' option is "csh" or
5370 "tcsh" after initializations, the default becomes "|& tee". If the
5371 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5372 "2>&1| tee". This means that stderr is also included.
5373 The initialization of this option is done after reading the ".vimrc"
5374 and the other initializations, so that when the 'shell' option is set
5375 there, the 'shellpipe' option changes automatically, unless it was
5376 explicitly set before.
5377 When 'shellpipe' is set to an empty string, no redirection of the
5378 ":make" output will be done. This is useful if you use a 'makeprg'
5379 that writes to 'makeef' by itself. If you want no piping, but do
5380 want to include the 'makeef', set 'shellpipe' to a single space.
5381 Don't forget to precede the space with a backslash: ":set sp=\ ".
5382 In the future pipes may be used for filtering and this option will
5383 become obsolete (at least for Unix).
5384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
5386
5387 *'shellquote'* *'shq'*
5388'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5389 contains "sh" somewhere: "\"")
5390 global
5391 {not in Vi}
5392 Quoting character(s), put around the command passed to the shell, for
5393 the "!" and ":!" commands. The redirection is kept outside of the
5394 quoting. See 'shellxquote' to include the redirection. It's
5395 probably not useful to set both options.
5396 This is an empty string by default. Only known to be useful for
5397 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5398 or bash, where it should be "\"". The default is adjusted according
5399 the value of 'shell', to reduce the need to set this option by the
5400 user. See |dos-shell|.
5401 This option cannot be set from a |modeline| or in the |sandbox|, for
5402 security reasons.
5403
5404 *'shellredir'* *'srr'*
5405'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5406 global
5407 {not in Vi}
5408 String to be used to put the output of a filter command in a temporary
5409 file. See also |:!|. See |option-backslash| about including spaces
5410 and backslashes.
5411 The name of the temporary file can be represented by "%s" if necessary
5412 (the file name is appended automatically if no %s appears in the value
5413 of this option).
5414 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5415 or "zsh" during initializations, the default becomes ">&". If the
5416 'shell' option is "sh", "ksh" or "bash" the default becomes
5417 ">%s 2>&1". This means that stderr is also included.
5418 For Win32, the Unix checks are done and additionally "cmd" is checked
5419 for, which makes the default ">%s 2>&1". Also, the same names with
5420 ".exe" appended are checked for.
5421 The initialization of this option is done after reading the ".vimrc"
5422 and the other initializations, so that when the 'shell' option is set
5423 there, the 'shellredir' option changes automatically unless it was
5424 explicitly set before.
5425 In the future pipes may be used for filtering and this option will
5426 become obsolete (at least for Unix).
5427 This option cannot be set from a |modeline| or in the |sandbox|, for
5428 security reasons.
5429
5430 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5431'shellslash' 'ssl' boolean (default off)
5432 global
5433 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5434 When set, a forward slash is used when expanding file names. This is
5435 useful when a Unix-like shell is used instead of command.com or
5436 cmd.exe. Backward slashes can still be typed, but they are changed to
5437 forward slashes by Vim.
5438 Note that setting or resetting this option has no effect for some
5439 existing file names, thus this option needs to be set before opening
5440 any file for best results. This might change in the future.
5441 'shellslash' only works when a backslash can be used as a path
5442 separator. To test if this is so use: >
5443 if exists('+shellslash')
5444<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005445 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5446'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5447 global
5448 {not in Vi}
5449 When on, use temp files for shell commands. When off use a pipe.
5450 When using a pipe is not possible temp files are used anyway.
5451 Currently a pipe is only supported on Unix. You can check it with: >
5452 :if has("filterpipe")
5453< The advantage of using a pipe is that nobody can read the temp file
5454 and the 'shell' command does not need to support redirection.
5455 The advantage of using a temp file is that the file type and encoding
5456 can be detected.
5457 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5458 |FilterWritePost| autocommands event are not triggered when
5459 'shelltemp' is off.
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 *'shelltype'* *'st'*
5462'shelltype' 'st' number (default 0)
5463 global
5464 {not in Vi} {only for the Amiga}
5465 On the Amiga this option influences the way how the commands work
5466 which use a shell.
5467 0 and 1: always use the shell
5468 2 and 3: use the shell only to filter lines
5469 4 and 5: use shell only for ':sh' command
5470 When not using the shell, the command is executed directly.
5471
5472 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5473 1 and 3: use "shell cmd" to start external commands
5474
5475 *'shellxquote'* *'sxq'*
5476'shellxquote' 'sxq' string (default: "";
5477 for Win32, when 'shell' contains "sh"
5478 somewhere: "\""
5479 for Unix, when using system(): "\"")
5480 global
5481 {not in Vi}
5482 Quoting character(s), put around the command passed to the shell, for
5483 the "!" and ":!" commands. Includes the redirection. See
5484 'shellquote' to exclude the redirection. It's probably not useful
5485 to set both options.
5486 This is an empty string by default. Known to be useful for
5487 third-party shells when using the Win32 version, such as the MKS Korn
5488 Shell or bash, where it should be "\"". The default is adjusted
5489 according the value of 'shell', to reduce the need to set this option
5490 by the user. See |dos-shell|.
5491 This option cannot be set from a |modeline| or in the |sandbox|, for
5492 security reasons.
5493
5494 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5495'shiftround' 'sr' boolean (default off)
5496 global
5497 {not in Vi}
5498 Round indent to multiple of 'shiftwidth'. Applies to > and <
5499 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5500 a multiple of 'shiftwidth' (this is Vi compatible).
5501 NOTE: This option is reset when 'compatible' is set.
5502
5503 *'shiftwidth'* *'sw'*
5504'shiftwidth' 'sw' number (default 8)
5505 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005506 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 |'cindent'|, |>>|, |<<|, etc.
5508
5509 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005510'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5511 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 global
5513 {not in Vi}
5514 This option helps to avoid all the |hit-enter| prompts caused by file
5515 messages, for example with CTRL-G, and to avoid some other messages.
5516 It is a list of flags:
5517 flag meaning when present ~
5518 f use "(3 of 5)" instead of "(file 3 of 5)"
5519 i use "[noeol]" instead of "[Incomplete last line]"
5520 l use "999L, 888C" instead of "999 lines, 888 characters"
5521 m use "[+]" instead of "[Modified]"
5522 n use "[New]" instead of "[New File]"
5523 r use "[RO]" instead of "[readonly]"
5524 w use "[w]" instead of "written" for file write message
5525 and "[a]" instead of "appended" for ':w >> file' command
5526 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5527 "[unix format]" and "[mac]" instead of "[mac format]".
5528 a all of the above abbreviations
5529
5530 o overwrite message for writing a file with subsequent message
5531 for reading a file (useful for ":wn" or when 'autowrite' on)
5532 O message for reading a file overwrites any previous message.
5533 Also for quickfix message (e.g., ":cn").
5534 s don't give "search hit BOTTOM, continuing at TOP" or "search
5535 hit TOP, continuing at BOTTOM" messages
5536 t truncate file message at the start if it is too long to fit
5537 on the command-line, "<" will appear in the left most column.
5538 Ignored in Ex mode.
5539 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005540 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005541 Ignored in Ex mode.
5542 W don't give "written" or "[w]" when writing a file
5543 A don't give the "ATTENTION" message when an existing swap file
5544 is found.
5545 I don't give the intro message when starting Vim |:intro|.
5546
5547 This gives you the opportunity to avoid that a change between buffers
5548 requires you to hit <Enter>, but still gives as useful a message as
5549 possible for the space available. To get the whole message that you
5550 would have got with 'shm' empty, use ":file!"
5551 Useful values:
5552 shm= No abbreviation of message.
5553 shm=a Abbreviation, but no loss of information.
5554 shm=at Abbreviation, and truncate message when necessary.
5555
5556 NOTE: This option is set to the Vi default value when 'compatible' is
5557 set and to the Vim default value when 'compatible' is reset.
5558
5559 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5560'shortname' 'sn' boolean (default off)
5561 local to buffer
5562 {not in Vi, not in MS-DOS versions}
5563 Filenames are assumed to be 8 characters plus one extension of 3
5564 characters. Multiple dots in file names are not allowed. When this
5565 option is on, dots in file names are replaced with underscores when
5566 adding an extension (".~" or ".swp"). This option is not available
5567 for MS-DOS, because then it would always be on. This option is useful
5568 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5569 or crossdos. When running the Win32 GUI version under Win32s, this
5570 option is always on by default.
5571
5572 *'showbreak'* *'sbr'* *E595*
5573'showbreak' 'sbr' string (default "")
5574 global
5575 {not in Vi}
5576 {not available when compiled without the |+linebreak|
5577 feature}
5578 String to put at the start of lines that have been wrapped. Useful
5579 values are "> " or "+++ ".
5580 Only printable single-cell characters are allowed, excluding <Tab> and
5581 comma (in a future version the comma might be used to separate the
5582 part that is shown at the end and at the start of a line).
5583 The characters are highlighted according to the '@' flag in
5584 'highlight'.
5585 Note that tabs after the showbreak will be displayed differently.
5586 If you want the 'showbreak' to appear in between line numbers, add the
5587 "n" flag to 'cpoptions'.
5588
5589 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5590'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5591 off)
5592 global
5593 {not in Vi}
5594 {not available when compiled without the
5595 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005596 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 terminal is slow.
5598 In Visual mode the size of the selected area is shown:
5599 - When selecting characters within a line, the number of characters.
5600 - When selecting more than one line, the number of lines.
5601 - When selecting a block, the size in screen characters: linesxcolumns.
5602 NOTE: This option is set to the Vi default value when 'compatible' is
5603 set and to the Vim default value when 'compatible' is reset.
5604
5605 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5606'showfulltag' 'sft' boolean (default off)
5607 global
5608 {not in Vi}
5609 When completing a word in insert mode (see |ins-completion|) from the
5610 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005611 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 matched a C function, you can see a template for what arguments are
5613 required (coding style permitting).
5614
5615 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5616'showmatch' 'sm' boolean (default off)
5617 global
5618 When a bracket is inserted, briefly jump to the matching one. The
5619 jump is only done if the match can be seen on the screen. The time to
5620 show the match can be set with 'matchtime'.
5621 A Beep is given if there is no match (no matter if the match can be
5622 seen or not). This option is reset when the 'paste' option is set.
5623 When the 'm' flag is not included in 'cpoptions', typing a character
5624 will immediately move the cursor back to where it belongs.
5625 See the "sm" field in 'guicursor' for setting the cursor shape and
5626 blinking when showing the match.
5627 The 'matchpairs' option can be used to specify the characters to show
5628 matches for. 'rightleft' and 'revins' are used to look for opposite
5629 matches.
5630 Note: For the use of the short form parental guidance is advised.
5631
5632 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5633'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5634 global
5635 If in Insert, Replace or Visual mode put a message on the last line.
5636 Use the 'M' flag in 'highlight' to set the type of highlighting for
5637 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005638 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005639 doesn't mean XIM is really active, especially when 'imactivatekey' is
5640 not set.
5641 NOTE: This option is set to the Vi default value when 'compatible' is
5642 set and to the Vim default value when 'compatible' is reset.
5643
5644 *'sidescroll'* *'ss'*
5645'sidescroll' 'ss' number (default 0)
5646 global
5647 {not in Vi}
5648 The minimal number of columns to scroll horizontally. Used only when
5649 the 'wrap' option is off and the cursor is moved off of the screen.
5650 When it is zero the cursor will be put in the middle of the screen.
5651 When using a slow terminal set it to a large number or 0. When using
5652 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5653 commands.
5654
5655 *'sidescrolloff'* *'siso'*
5656'sidescrolloff' 'siso' number (default 0)
5657 global
5658 {not in Vi}
5659 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005660 right of the cursor if 'nowrap' is set. Setting this option to a value
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 greater than 0 while having |'sidescroll'| also at a non-zero value
5662 makes some context visible in the line you are scrolling in
5663 horizontally (except at the end and beginning of the line). Setting
5664 this option to a large value (like 999) has the effect of keeping the
5665 cursor horizontally centered in the window, as long as one does not
5666 come too close to the beginning or end of the line.
5667 NOTE: This option is set to 0 when 'compatible' is set.
5668
5669 Example: Try this together with 'sidescroll' and 'listchars' as
5670 in the following example to never allow the cursor to move
5671 onto the "extends" character:
5672
5673 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5674 :set sidescrolloff=1
5675
5676
5677 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5678'smartcase' 'scs' boolean (default off)
5679 global
5680 {not in Vi}
5681 Override the 'ignorecase' option if the search pattern contains upper
5682 case characters. Only used when the search pattern is typed and
5683 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5686 recalling the search pattern from history and hitting <Enter>.
5687 NOTE: This option is reset when 'compatible' is set.
5688
5689 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5690'smartindent' 'si' boolean (default off)
5691 local to buffer
5692 {not in Vi}
5693 {not available when compiled without the
5694 |+smartindent| feature}
5695 Do smart autoindenting when starting a new line. Works for C-like
5696 programs, but can also be used for other languages. 'cindent' does
5697 something like this, works better in most cases, but is more strict,
5698 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5699 'indentexpr' is a more advanced alternative.
5700 Normally 'autoindent' should also be on when using 'smartindent'.
5701 An indent is automatically inserted:
5702 - After a line ending in '{'.
5703 - After a line starting with a keyword from 'cinwords'.
5704 - Before a line starting with '}' (only with the "O" command).
5705 When typing '}' as the first character in a new line, that line is
5706 given the same indent as the matching '{'.
5707 When typing '#' as the first character in a new line, the indent for
5708 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005709 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5711 When using the ">>" command, lines starting with '#' are not shifted
5712 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005713 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714 is set smart indenting is disabled.
5715
5716 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5717'smarttab' 'sta' boolean (default off)
5718 global
5719 {not in Vi}
5720 When on, a <Tab> in front of a line inserts blanks according to
5721 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete
5722 a 'shiftwidth' worth of space at the start of the line.
5723 When off a <Tab> always inserts blanks according to 'tabstop'.
5724 'shiftwidth' is only used for shifting text left or right
5725 |shift-left-right|.
5726 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5727 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005728 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729 NOTE: This option is reset when 'compatible' is set.
5730
5731 *'softtabstop'* *'sts'*
5732'softtabstop' 'sts' number (default 0)
5733 local to buffer
5734 {not in Vi}
5735 Number of spaces that a <Tab> counts for while performing editing
5736 operations, like inserting a <Tab> or using <BS>. It "feels" like
5737 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5738 used. This is useful to keep the 'ts' setting at its standard value
5739 of 8, while being able to edit like it is set to 'sts'. However,
5740 commands like "x" still work on the actual characters.
5741 When 'sts' is zero, this feature is off.
5742 'softtabstop' is set to 0 when the 'paste' option is set.
5743 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5744 spaces is minimized by using <Tab>s.
5745 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
5746 set.
5747 NOTE: This option is set to 0 when 'compatible' is set.
5748
Bram Moolenaar217ad922005-03-20 22:37:15 +00005749 *'spell'* *'nospell'*
5750'spell' boolean (default off)
5751 local to window
5752 {not in Vi}
5753 {not available when compiled without the |+syntax|
5754 feature}
5755 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005756 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005757
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005758 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005759'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005760 local to buffer
5761 {not in Vi}
5762 {not available when compiled without the |+syntax|
5763 feature}
5764 Pattern to locate the end of a sentence. The following word will be
5765 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005766 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005767 When this check is not wanted make this option empty.
5768 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00005769 Be careful with special characters, see |option-backslash| about
5770 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005771 To set this option automatically depending on the language, see
5772 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005773
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005774 *'spellfile'* *'spf'*
5775'spellfile' 'spf' string (default empty)
5776 local to buffer
5777 {not in Vi}
5778 {not available when compiled without the |+syntax|
5779 feature}
5780 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00005781 commands. It must end in ".{encoding}.add". You need to include the
5782 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00005783 *E765*
5784 It may also be a comma separated list of names. A count before the
5785 |zg| and |zw| commands can be used to access each. This allows using
5786 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005787 When a word is added while this option is empty Vim will set it for
5788 you: Using the first "spell" directory in 'runtimepath' that is
Bram Moolenaar3b506942005-06-23 22:36:45 +00005789 writable and the first language name that appears in 'spelllang',
5790 ignoring the region.
5791 The resulting ".spl" file will be used for spell checking, it does not
5792 have to appear in 'spelllang'.
5793 Normally one file is used for all regions, but you can add the region
5794 name if you want to. However, it will then only be used when
5795 'spellfile' is set to it, for entries in 'spelllang' only files
5796 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00005797 This option cannot be set from a |modeline| or in the |sandbox|, for
5798 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005799
Bram Moolenaar217ad922005-03-20 22:37:15 +00005800 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00005801'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00005802 local to buffer
5803 {not in Vi}
5804 {not available when compiled without the |+syntax|
5805 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00005806 A comma separated list of word list names. When the 'spell' option is
5807 on spellchecking will be done for these languages. Example: >
5808 set spelllang=en_us,nl,medical
5809< This means US English, Dutch and medical words are recognized. Words
5810 that are not recognized will be highlighted.
5811 The word list name must not include a comma or dot. Using a dash is
5812 recommended to separate the two letter language name from a
5813 specification. Thus "en-rare" is used for rare English words.
5814 A region name must come last and have the form "_xx", where "xx" is
5815 the two-letter, lower case region name. You can use more than one
5816 region by listing them: "en_us,en_ca" supports both US and Canadian
5817 English, but not words specific for Australia, New Zealand or Great
5818 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005819 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005820 As a special case the name of a .spl file can be given as-is. The
5821 first "_xx" in the name is removed and used as the region name
5822 (_xx is an underscore, two letters and followed by a non-letter).
5823 This is mainly for testing purposes. You must make sure the correct
5824 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005825 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00005826 idea to set 'spelllang' after setting 'encoding' to avoid loading the
5827 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00005828 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00005829
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00005830 After this option has been set successfully, Vim will source the files
5831 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
5832 up to the first comma, dot or underscore. See |set-spc-auto|.
5833
5834
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005835 *'spellsuggest'* *'sps'*
5836'spellsuggest' 'sps' string (default "best")
5837 global
5838 {not in Vi}
5839 {not available when compiled without the |+syntax|
5840 feature}
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005841 Methods used for spelling suggestions. Both for the |z?| command and
5842 the |spellsuggest()| function. This is a comma-separated list of
5843 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005844
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005845 best Internal method that works best for English. Finds
5846 changes like "fast" and uses a bit of sound-a-like
5847 scoring to improve the ordering.
5848
5849 double Internal method that uses two methods and mixes the
5850 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005851 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005852 word. That only works when the language specifies
5853 sound folding. Can be slow and doesn't always give
5854 better results.
5855
5856 fast Internal method that only checks for simple changes:
5857 character inserts/deletes/swaps. Works well for
5858 simple typing mistakes.
5859
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005860 {number} The maximum number of suggestions listed for |z?|.
5861 Not used for |spellsuggest()|. The number of
5862 suggestions is never more than the value of 'lines'
5863 minus two.
5864
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00005865 file:{filename} Read file {filename}, which must have two columns,
5866 separated by a slash. The first column contains the
5867 bad word, the second column the suggested good word.
5868 Example:
5869 theribal/terrible ~
5870 Use this for common mistakes that do not appear at the
5871 top of the suggestion list with the internal methods.
5872 Lines without a slash are ignored, use this for
5873 comments.
5874 The file is used for all languages.
5875
5876 expr:{expr} Evaluate expression {expr}. Use a function to avoid
5877 trouble with spaces. |v:val| holds the badly spelled
5878 word. The expression must evaluate to a List of
5879 Lists, each with a suggestion and a score.
5880 Example:
5881 [['the', 33], ['that', 44]]
5882 Set 'verbose' and use |z?| to see the scores that the
5883 internal methods use. A lower score is better.
5884 This may invoke |spellsuggest()| if you temporarily
5885 set 'spellsuggest' to exclude the "expr:" part.
5886 Errors are silently ignored, unless you set the
5887 'verbose' option to a non-zero value.
5888
5889 Only one of "best", "double" or "fast" may be used. The others may
5890 appear several times in any order. Example: >
5891 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
5892<
5893 This option cannot be set from a |modeline| or in the |sandbox|, for
5894 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00005895
5896
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
5898'splitbelow' 'sb' boolean (default off)
5899 global
5900 {not in Vi}
5901 {not available when compiled without the +windows
5902 feature}
5903 When on, splitting a window will put the new window below the current
5904 one. |:split|
5905
5906 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
5907'splitright' 'spr' boolean (default off)
5908 global
5909 {not in Vi}
5910 {not available when compiled without the +vertsplit
5911 feature}
5912 When on, splitting a window will put the new window right of the
5913 current one. |:vsplit|
5914
5915 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
5916'startofline' 'sol' boolean (default on)
5917 global
5918 {not in Vi}
5919 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00005920 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005921 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00005922 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005923 with a linewise operator, with "%" with a count and to buffer changing
5924 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
5925 only has a line number, e.g., ":25" or ":+".
5926 In case of buffer changing commands the cursor is placed at the column
5927 where it was the last time the buffer was edited.
5928 NOTE: This option is set when 'compatible' is set.
5929
5930 *'statusline'* *'stl'* *E540* *E541* *E542*
5931'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00005932 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005933 {not in Vi}
5934 {not available when compiled without the |+statusline|
5935 feature}
5936 When nonempty, this option determines the content of the status line.
5937 Also see |status-line|.
5938
5939 The option consists of printf style '%' items interspersed with
5940 normal text. Each status line item is of the form:
5941 %-0{minwid}.{maxwid}{item}
5942 All fields except the {item} is optional. A single percent sign can
5943 be given as "%%". Up to 80 items can be specified.
5944
5945 Note that the only effect of 'ruler' when this option is set (and
5946 'laststatus' is 2) is controlling the output of |CTRL-G|.
5947
5948 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00005949 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005951 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005952 minwid Minimum width of the item, padding as set by '-' & '0'.
5953 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005954 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 on the left for text items. Numeric items will be
5956 shifted down to maxwid-2 digits followed by '>'number
5957 where number is the amount of missing digits, much like
5958 an exponential notation.
5959 item A one letter code as described below.
5960
5961 Following is a description of the possible statusline items. The
5962 second character in "item" is the type:
5963 N for number
5964 S for string
5965 F for flags as described below
5966 - not applicable
5967
5968 item meaning ~
5969 f S Path to the file in the buffer, relative to current directory.
5970 F S Full path to the file in the buffer.
5971 t S File name (tail) of file in the buffer.
5972 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
5973 M F Modified flag, text is ",+" or ",-".
5974 r F Readonly flag, text is " [RO]".
5975 R F Readonly flag, text is ",RO".
5976 h F Help buffer flag, text is " [help]".
5977 H F Help buffer flag, text is ",HLP".
5978 w F Preview window flag, text is " [Preview]".
5979 W F Preview window flag, text is ",PRV".
5980 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
5981 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
5982 {not available when compiled without |+autocmd| feature}
5983 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
5984 being used: "<keymap>"
5985 n N Buffer number.
5986 b N Value of byte under cursor.
5987 B N As above, in hexadecimal.
5988 o N Byte number in file of byte under cursor, first byte is 1.
5989 Mnemonic: Offset from start of file (with one added)
5990 {not available when compiled without |+byte_offset| feature}
5991 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00005992 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 l N Line number.
5994 L N Number of lines in buffer.
5995 c N Column number.
5996 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005997 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005998 p N Percentage through file in lines as in |CTRL-G|.
5999 P S Percentage through file of displayed window. This is like the
6000 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006001 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 Empty if the argument file count is zero or one.
6003 { NF Evaluate expression between '{' and '}' and substitute result.
6004 ( - Start of item group. Can be used for setting the width and
6005 alignment of a section. Must be followed by %) somewhere.
6006 ) - End of item group. No width fields allowed.
6007 < - Where to truncate line if too long. Default is at the start.
6008 No width fields allowed.
6009 = - Separation point between left and right aligned items.
6010 No width fields allowed.
6011 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006012 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 The difference between User{N} and StatusLine will be applied
6014 to StatusLineNC for the statusline of non-current windows.
6015 The number N must be between 1 and 9. See |hl-User1..9|
6016
6017 Display of flags are controlled by the following heuristic:
6018 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006019 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 with a space it is assumed that it wants to separate itself from
6021 anything but other flags. That is: A leading comma is removed if the
6022 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006023 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006024 make a nice display when flags are used like in the examples below.
6025
Bram Moolenaar582fd852005-03-28 20:58:01 +00006026 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006027 not set) and a minwid is not set for the group, the whole group will
6028 become empty. This will make a group like the following disappear
6029 completely from the statusline when none of the flags are set. >
6030 :set statusline=...%(\ [%M%R%H]%)...
6031<
6032 Beware that an expression is evaluated each and every time the status
6033 line is displayed. The current buffer and current window will be set
6034 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006035 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006036 The variable "actual_curbuf" is set to the 'bufnr()' number of the
6037 real current buffer. The expression is evaluated in the |sandbox|.
6038
6039 If the statusline is not updated when you want it (e.g., after setting
6040 a variable that's used in an expression), you can force an update by
6041 setting an option without changing its value. Example: >
6042 :let &ro = &ro
6043
6044< A result of all digits is regarded a number for display purposes.
6045 Otherwise the result is taken as flag text and applied to the rules
6046 described above.
6047
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006048 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6050 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6051
6052 Examples:
6053 Emulate standard status line with 'ruler' set >
6054 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6055< Similar, but add ASCII value of char under the cursor (like "ga") >
6056 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6057< Display byte count and byte value, modified flag in red. >
6058 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6059 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6060< Display a ,GZ flag if a compressed file is loaded >
6061 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6062< In the |:autocmd|'s: >
6063 :let b:gzflag = 1
6064< And: >
6065 :unlet b:gzflag
6066< And define this function: >
6067 :function VarExists(var, val)
6068 : if exists(a:var) | return a:val | else | return '' | endif
6069 :endfunction
6070<
6071 *'suffixes'* *'su'*
6072'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6073 global
6074 {not in Vi}
6075 Files with these suffixes get a lower priority when multiple files
6076 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006077 suffixes. Spaces after the comma are ignored. A dot is also seen as
6078 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079 separator, precede it with a backslash (see |option-backslash| about
6080 including spaces and backslashes).
6081 See 'wildignore' for completely ignoring files.
6082 The use of |:set+=| and |:set-=| is preferred when adding or removing
6083 suffixes from the list. This avoids problems when a future version
6084 uses another default.
6085
6086 *'suffixesadd'* *'sua'*
6087'suffixesadd' 'sua' string (default "")
6088 local to buffer
6089 {not in Vi}
6090 {not available when compiled without the
6091 |+file_in_path| feature}
6092 Comma separated list of suffixes, which are used when searching for a
6093 file for the "gf", "[I", etc. commands. Example: >
6094 :set suffixesadd=.java
6095<
6096 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6097'swapfile' 'swf' boolean (default on)
6098 local to buffer
6099 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006100 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006101 swapfile is not wanted for a specific buffer. For example, with
6102 confidential information that even root must not be able to access.
6103 Careful: All text will be in memory:
6104 - Don't use this for big files.
6105 - Recovery will be impossible!
6106 A swapfile will only be present when |'updatecount'| is non-zero and
6107 'swapfile' is set.
6108 When 'swapfile' is reset, the swap file for the current buffer is
6109 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6110 non-zero, a swap file is immediately created.
6111 Also see |swap-file| and |'swapsync'|.
6112
6113 This option is used together with 'bufhidden' and 'buftype' to
6114 specify special kinds of buffers. See |special-buffers|.
6115
6116 *'swapsync'* *'sws'*
6117'swapsync' 'sws' string (default "fsync")
6118 global
6119 {not in Vi}
6120 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006121 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006122 When this option is empty parts of the swap file may be in memory and
6123 not written to disk. When the system crashes you may lose more work.
6124 On Unix the system does a sync now and then without Vim asking for it,
6125 so the disadvantage of setting this option off is small. On some
6126 systems the swap file will not be written at all. For a unix system
6127 setting it to "sync" will use the sync() call instead of the default
6128 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006129 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130
6131 *'switchbuf'* *'swb'*
6132'switchbuf' 'swb' string (default "")
6133 global
6134 {not in Vi}
6135 This option controls the behavior when switching between buffers.
6136 Possible values (comma separated list):
6137 useopen If included, jump to the first open window that
6138 contains the specified buffer (if there is one).
6139 Otherwise: Do not examine other windows.
6140 This setting is checked with |quickfix| commands, when
6141 jumping to errors (":cc", ":cn", "cp", etc.). It is
6142 also used in all buffer related split commands, for
6143 example ":sbuffer", ":sbnext", or ":sbrewind".
6144 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006145 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 Supported in |quickfix| commands that display errors.
6147
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006148 *'synmaxcol'* *'smc'*
6149'synmaxcol' 'smc' number (default 3000)
6150 local to buffer
6151 {not in Vi}
6152 {not available when compiled without the |+syntax|
6153 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006154 Maximum column in which to search for syntax items. In long lines the
6155 text after this column is not highlighted and following lines may not
6156 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006157 This helps to avoid very slow redrawing for an XML file that is one
6158 long line.
6159 Set to zero to remove the limit.
6160
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 *'syntax'* *'syn'*
6162'syntax' 'syn' string (default empty)
6163 local to buffer
6164 {not in Vi}
6165 {not available when compiled without the |+syntax|
6166 feature}
6167 When this option is set, the syntax with this name is loaded, unless
6168 syntax highlighting has been switched off with ":syntax off".
6169 Otherwise this option does not always reflect the current syntax (the
6170 b:current_syntax variable does).
6171 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006172 not automatically recognized. Example, in an IDL file: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006173 /* vim: set syntax=idl : */
6174< To switch off syntax highlighting for the current file, use: >
6175 :set syntax=OFF
6176< To switch syntax highlighting on according to the current value of the
6177 'filetype' option: >
6178 :set syntax=ON
6179< What actually happens when setting the 'syntax' option is that the
6180 Syntax autocommand event is triggered with the value as argument.
6181 This option is not copied to another buffer, independent of the 's' or
6182 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006183 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006184
6185 *'tabstop'* *'ts'*
6186'tabstop' 'ts' number (default 8)
6187 local to buffer
6188 Number of spaces that a <Tab> in the file counts for. Also see
6189 |:retab| command, and 'softtabstop' option.
6190
6191 Note: Setting 'tabstop' to any other value than 8 can make your file
6192 appear wrong in many places (e.g., when printing it).
6193
6194 There are four main ways to use tabs in Vim:
6195 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6196 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6197 will use a mix of tabs and spaces, but typing Tab and BS will
6198 behave like a tab appears every 4 (or 3) characters.
6199 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6200 'expandtab'. This way you will always insert spaces. The
6201 formatting will never be messed up when 'tabstop' is changed.
6202 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006203 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 works when using Vim to edit the file.
6205 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6206 'noexpandtab'. This should then work (for initial indents only)
6207 for any tabstop setting that people use. It might be nice to have
6208 tabs after the first non-blank inserted as spaces if you do this
6209 though. Otherwise aligned comments will be wrong when 'tabstop' is
6210 changed.
6211
6212 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6213'tagbsearch' 'tbs' boolean (default on)
6214 global
6215 {not in Vi}
6216 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006217 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 searching makes searching for a tag a LOT faster, but a linear search
6219 will find more tags if the tags file wasn't properly sorted.
6220 Vim normally assumes that your tags files are sorted, or indicate that
6221 they are not sorted. Only when this is not the case does the
6222 'tagbsearch' option need to be switched off.
6223
6224 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006225 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 certain files, or retry all files with a linear search. When
6227 'tagbsearch' is off, only a linear search is done.
6228
6229 Linear searching is done anyway, for one file, when Vim finds a line
6230 at the start of the file indicating that it's not sorted: >
6231 !_TAG_FILE_SORTED 0 /some command/
6232< [The whitespace before and after the '0' must be a single <Tab>]
6233
6234 When a binary search was done and no match was found in any of the
6235 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6236 instead of a normal tag name, a retry is done with a linear search.
6237 Tags in unsorted tags files, and matches with different case will only
6238 be found in the retry.
6239
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006240 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 linear search can be avoided for the 'ignorecase' case. Use a value
6242 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6243 case-fold sorted with the -f switch to "sort" in most unices, as in
6244 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6245 5.3 or higher the -f or --fold-case-sort switch can be used for this
6246 as well. Note that case must be folded to uppercase for this to work.
6247
6248 When 'tagbsearch' is off, tags searching is slower when a full match
6249 exists, but faster when no full match exists. Tags in unsorted tags
6250 files may only be found with 'tagbsearch' off.
6251 When the tags file is not sorted, or sorted in a wrong way (not on
6252 ASCII byte value), 'tagbsearch' should be off, or the line given above
6253 must be included in the tags file.
6254 This option doesn't affect commands that find all matching tags (e.g.,
6255 command-line completion and ":help").
6256 {Vi: always uses binary search in some versions}
6257
6258 *'taglength'* *'tl'*
6259'taglength' 'tl' number (default 0)
6260 global
6261 If non-zero, tags are significant up to this number of characters.
6262
6263 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6264'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6265 global
6266 {not in Vi}
6267 If on and using a tag file in another directory, file names in that
6268 tag file are relative to the directory where the tag file is.
6269 NOTE: This option is set to the Vi default value when 'compatible' is
6270 set and to the Vim default value when 'compatible' is reset.
6271
6272 *'tags'* *'tag'* *E433*
6273'tags' 'tag' string (default "./tags,tags", when compiled with
6274 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6275 global or local to buffer |global-local|
6276 Filenames for the tag command, separated by spaces or commas. To
6277 include a space or comma in a file name, precede it with a backslash
6278 (see |option-backslash| about including spaces and backslashes).
6279 When a file name starts with "./", the '.' is replaced with the path
6280 of the current file. But only when the 'd' flag is not included in
6281 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6282 |tags-option|.
6283 "*", "**" and other wildcards can be used to search for tags files in
6284 a directory tree. See |file-searching|. {not available when compiled
6285 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006286 The |tagfiles()| function can be used to get a list of the file names
6287 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006288 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6289 files are also supported. They are automatically recognized. The
6290 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6291 differences are ignored (MS-Windows). |emacs-tags|
6292 The use of |:set+=| and |:set-=| is preferred when adding or removing
6293 file names from the list. This avoids problems when a future version
6294 uses another default.
6295 {Vi: default is "tags /usr/lib/tags"}
6296
6297 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6298'tagstack' 'tgst' boolean (default on)
6299 global
6300 {not in all versions of Vi}
6301 When on, the |tagstack| is used normally. When off, a ":tag" or
6302 ":tselect" command with an argument will not push the tag onto the
6303 tagstack. A following ":tag" without an argument, a ":pop" command or
6304 any other command that uses the tagstack will use the unmodified
6305 tagstack, but does change the pointer to the active entry.
6306 Resetting this option is useful when using a ":tag" command in a
6307 mapping which should not change the tagstack.
6308
6309 *'term'* *E529* *E530* *E531*
6310'term' string (default is $TERM, if that fails:
6311 in the GUI: "builtin_gui"
6312 on Amiga: "amiga"
6313 on BeOS: "beos-ansi"
6314 on Mac: "mac-ansi"
6315 on MiNT: "vt52"
6316 on MS-DOS: "pcterm"
6317 on OS/2: "os2ansi"
6318 on Unix: "ansi"
6319 on VMS: "ansi"
6320 on Win 32: "win32")
6321 global
6322 Name of the terminal. Used for choosing the terminal control
6323 characters. Environment variables are expanded |:set_env|.
6324 For example: >
6325 :set term=$TERM
6326< See |termcap|.
6327
6328 *'termbidi'* *'tbidi'*
6329 *'notermbidi'* *'notbidi'*
6330'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6331 global
6332 {not in Vi}
6333 {only available when compiled with the |+arabic|
6334 feature}
6335 The terminal is in charge of Bi-directionality of text (as specified
6336 by Unicode). The terminal is also expected to do the required shaping
6337 that some languages (such as Arabic) require.
6338 Setting this option implies that 'rightleft' will not be set when
6339 'arabic' is set and the value of 'arabicshape' will be ignored.
6340 Note that setting 'termbidi' has the immediate effect that
6341 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6342 This option is reset when the GUI is started.
6343 For further details see |arabic.txt|.
6344
6345 *'termencoding'* *'tenc'*
6346'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6347 Macintosh GUI: "macroman")
6348 global
6349 {only available when compiled with the |+multi_byte|
6350 feature}
6351 {not in Vi}
6352 Encoding used for the terminal. This specifies what character
6353 encoding the keyboard produces and the display will understand. For
6354 the GUI it only applies to the keyboard ('encoding' is used for the
6355 display).
6356 In the Win32 console version the default value is the console codepage
6357 when it differs from the ANSI codepage.
6358 *E617*
6359 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6360 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6361 Any attempts to set a different value will be rejected, and an error
6362 message is shown.
6363 For the Win32 GUI 'termencoding' is not used for typed characters,
6364 because the Win32 system always passes Unicode characters.
6365 When empty, the same encoding is used as for the 'encoding' option.
6366 This is the normal value.
6367 Not all combinations for 'termencoding' and 'encoding' are valid. See
6368 |encoding-table|.
6369 The value for this option must be supported by internal conversions or
6370 iconv(). When this is not possible no conversion will be done and you
6371 will probably experience problems with non-ASCII characters.
6372 Example: You are working with the locale set to euc-jp (Japanese) and
6373 want to edit a UTF-8 file: >
6374 :let &termencoding = &encoding
6375 :set encoding=utf-8
6376< You need to do this when your system has no locale support for UTF-8.
6377
6378 *'terse'* *'noterse'*
6379'terse' boolean (default off)
6380 global
6381 When set: Add 's' flag to 'shortmess' option (this makes the message
6382 for a search that hits the start or end of the file not being
6383 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6384 shortens a lot of messages}
6385
6386 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6387'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6388 global
6389 {not in Vi}
6390 This option is obsolete. Use 'fileformats'.
6391 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6392 set to the default value for the current system. When 'textauto' is
6393 reset, 'fileformats' is made empty.
6394 NOTE: This option is set to the Vi default value when 'compatible' is
6395 set and to the Vim default value when 'compatible' is reset.
6396
6397 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6398'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6399 others: default off)
6400 local to buffer
6401 {not in Vi}
6402 This option is obsolete. Use 'fileformat'.
6403 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6404 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6405 "unix".
6406
6407 *'textwidth'* *'tw'*
6408'textwidth' 'tw' number (default 0)
6409 local to buffer
6410 {not in Vi}
6411 Maximum width of text that is being inserted. A longer line will be
6412 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006413 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6414 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006415 'formatoptions' and |ins-textwidth|.
6416 NOTE: This option is set to 0 when 'compatible' is set.
6417
6418 *'thesaurus'* *'tsr'*
6419'thesaurus' 'tsr' string (default "")
6420 global or local to buffer |global-local|
6421 {not in Vi}
6422 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006423 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 the file should contain words with similar meaning, separated by
6425 non-keyword characters (white space is preferred). Maximum line
6426 length is 510 bytes.
6427 To obtain a file to be used here, check out the wordlist FAQ at
6428 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006429 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 after a comma are ignored, otherwise spaces are included in the file
6431 name. See |option-backslash| about using backslashes.
6432 The use of |:set+=| and |:set-=| is preferred when adding or removing
6433 directories from the list. This avoids problems when a future version
6434 uses another default.
6435 Backticks cannot be used in this option for security reasons.
6436
6437 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6438'tildeop' 'top' boolean (default off)
6439 global
6440 {not in Vi}
6441 When on: The tilde command "~" behaves like an operator.
6442 NOTE: This option is reset when 'compatible' is set.
6443
6444 *'timeout'* *'to'* *'notimeout'* *'noto'*
6445'timeout' 'to' boolean (default on)
6446 global
6447 *'ttimeout'* *'nottimeout'*
6448'ttimeout' boolean (default off)
6449 global
6450 {not in Vi}
6451 These two options together determine the behavior when part of a
6452 mapped key sequence or keyboard code has been received:
6453
6454 'timeout' 'ttimeout' action ~
6455 off off do not time out
6456 on on or off time out on :mappings and key codes
6457 off on time out on key codes
6458
6459 If both options are off, Vim will wait until either the complete
6460 mapping or key sequence has been received, or it is clear that there
6461 is no mapping or key sequence for the received characters. For
6462 example: if you have mapped "vl" and Vim has received 'v', the next
6463 character is needed to see if the 'v' is followed by an 'l'.
6464 When one of the options is on, Vim will wait for about 1 second for
6465 the next character to arrive. After that the already received
6466 characters are interpreted as single characters. The waiting time can
6467 be changed with the 'timeoutlen' option.
6468 On slow terminals or very busy systems timing out may cause
6469 malfunctioning cursor keys. If both options are off, Vim waits
6470 forever after an entered <Esc> if there are key codes that start
6471 with <Esc>. You will have to type <Esc> twice. If you do not have
6472 problems with key codes, but would like to have :mapped key
6473 sequences not timing out in 1 second, set the 'ttimeout' option and
6474 reset the 'timeout' option.
6475
6476 NOTE: 'ttimeout' is reset when 'compatible' is set.
6477
6478 *'timeoutlen'* *'tm'*
6479'timeoutlen' 'tm' number (default 1000)
6480 global
6481 {not in all versions of Vi}
6482 *'ttimeoutlen'* *'ttm'*
6483'ttimeoutlen' 'ttm' number (default -1)
6484 global
6485 {not in Vi}
6486 The time in milliseconds that is waited for a key code or mapped key
6487 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6488 when part of a command has been typed.
6489 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6490 different timeout value for key codes is desired set 'ttimeoutlen' to
6491 a non-negative number.
6492
6493 ttimeoutlen mapping delay key code delay ~
6494 < 0 'timeoutlen' 'timeoutlen'
6495 >= 0 'timeoutlen' 'ttimeoutlen'
6496
6497 The timeout only happens when the 'timeout' and 'ttimeout' options
6498 tell so. A useful setting would be >
6499 :set timeout timeoutlen=3000 ttimeoutlen=100
6500< (time out on mapping after three seconds, time out on key codes after
6501 a tenth of a second).
6502
6503 *'title'* *'notitle'*
6504'title' boolean (default off, on when title can be restored)
6505 global
6506 {not in Vi}
6507 {not available when compiled without the |+title|
6508 feature}
6509 When on, the title of the window will be set to the value of
6510 'titlestring' (if it is not empty), or to:
6511 filename [+=-] (path) - VIM
6512 Where:
6513 filename the name of the file being edited
6514 - indicates the file cannot be modified, 'ma' off
6515 + indicates the file was modified
6516 = indicates the file is read-only
6517 =+ indicates the file is read-only and modified
6518 (path) is the path of the file being edited
6519 - VIM the server name |v:servername| or "VIM"
6520 Only works if the terminal supports setting window titles
6521 (currently Amiga console, Win32 console, all GUI versions and
6522 terminals with a non- empty 't_ts' option - these are Unix xterm and
6523 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6524 *X11*
6525 When Vim was compiled with HAVE_X11 defined, the original title will
6526 be restored if possible. The output of ":version" will include "+X11"
6527 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6528 works for the icon name |'icon'|.
6529 But: When Vim was started with the |-X| argument, restoring the title
6530 will not work (except in the GUI).
6531 If the title cannot be restored, it is set to the value of 'titleold'.
6532 You might want to restore the title outside of Vim then.
6533 When using an xterm from a remote machine you can use this command:
6534 rsh machine_name xterm -display $DISPLAY &
6535 then the WINDOWID environment variable should be inherited and the
6536 title of the window should change back to what it should be after
6537 exiting Vim.
6538
6539 *'titlelen'*
6540'titlelen' number (default 85)
6541 global
6542 {not in Vi}
6543 {not available when compiled without the |+title|
6544 feature}
6545 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006546 title. When the title is longer, only the end of the path name is
6547 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 Using a percentage makes this adapt to the width of the window. But
6549 it won't work perfectly, because the actual number of characters
6550 available also depends on the font used and other things in the title
6551 bar. When 'titlelen' is zero the full path is used. Otherwise,
6552 values from 1 to 30000 percent can be used.
6553 'titlelen' is also used for the 'titlestring' option.
6554
6555 *'titleold'*
6556'titleold' string (default "Thanks for flying Vim")
6557 global
6558 {not in Vi}
6559 {only available when compiled with the |+title|
6560 feature}
6561 This option will be used for the window title when exiting Vim if the
6562 original title cannot be restored. Only happens if 'title' is on or
6563 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006564 This option cannot be set from a |modeline| or in the |sandbox|, for
6565 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 *'titlestring'*
6567'titlestring' string (default "")
6568 global
6569 {not in Vi}
6570 {not available when compiled without the |+title|
6571 feature}
6572 When this option is not empty, it will be used for the title of the
6573 window. This happens only when the 'title' option is on.
6574 Only works if the terminal supports setting window titles (currently
6575 Amiga console, Win32 console, all GUI versions and terminals with a
6576 non-empty 't_ts' option).
6577 When Vim was compiled with HAVE_X11 defined, the original title will
6578 be restored if possible |X11|.
6579 When this option contains printf-style '%' items, they will be
6580 expanded according to the rules used for 'statusline'.
6581 Example: >
6582 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6583 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6584< The value of 'titlelen' is used to align items in the middle or right
6585 of the available space.
6586 Some people prefer to have the file name first: >
6587 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6588< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006589 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590 separating space only when needed.
6591 NOTE: Use of special characters in 'titlestring' may cause the display
6592 to be garbled (e.g., when it contains a CR or NL character).
6593 {not available when compiled without the |+statusline| feature}
6594
6595 *'toolbar'* *'tb'*
6596'toolbar' 'tb' string (default "icons,tooltips")
6597 global
6598 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6599 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006600 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 possible values are:
6602 icons Toolbar buttons are shown with icons.
6603 text Toolbar buttons shown with text.
6604 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006605 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 tooltips Tooltips are active for toolbar buttons.
6607 Tooltips refer to the popup help text which appears after the mouse
6608 cursor is placed over a toolbar button for a brief moment.
6609
6610 If you want the toolbar to be shown with icons as well as text, do the
6611 following: >
6612 :set tb=icons,text
6613< Motif and Athena cannot display icons and text at the same time. They
6614 will show icons if both are requested.
6615
6616 If none of the strings specified in 'toolbar' are valid or if
6617 'toolbar' is empty, this option is ignored. If you want to disable
6618 the toolbar, you need to set the 'guioptions' option. For example: >
6619 :set guioptions-=T
6620< Also see |gui-toolbar|.
6621
6622 *'toolbariconsize'* *'tbis'*
6623'toolbariconsize' 'tbis' string (default "small")
6624 global
6625 {not in Vi}
6626 {only in the GTK+ 2 GUI}
6627 Controls the size of toolbar icons. The possible values are:
6628 tiny Use tiny toolbar icons.
6629 small Use small toolbar icons (default).
6630 medium Use medium-sized toolbar icons.
6631 large Use large toolbar icons.
6632 The exact dimensions in pixels of the various icon sizes depend on
6633 the current theme. Common dimensions are large=32x32, medium=24x24,
6634 small=20x20 and tiny=16x16.
6635
6636 If 'toolbariconsize' is empty, the global default size as determined
6637 by user preferences or the current theme is used.
6638
6639 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6640'ttybuiltin' 'tbi' boolean (default on)
6641 global
6642 {not in Vi}
6643 When on, the builtin termcaps are searched before the external ones.
6644 When off the builtin termcaps are searched after the external ones.
6645 When this option is changed, you should set the 'term' option next for
6646 the change to take effect, for example: >
6647 :set notbi term=$TERM
6648< See also |termcap|.
6649 Rationale: The default for this option is "on", because the builtin
6650 termcap entries are generally better (many systems contain faulty
6651 xterm entries...).
6652
6653 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6654'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6655 sun-cmd, screen, rxvt, dtterm or
6656 iris-ansi; also on when running Vim in
6657 a DOS console)
6658 global
6659 {not in Vi}
6660 Indicates a fast terminal connection. More characters will be sent to
6661 the screen for redrawing, instead of using insert/delete line
6662 commands. Improves smoothness of redrawing when there are multiple
6663 windows and the terminal does not support a scrolling region.
6664 Also enables the extra writing of characters at the end of each screen
6665 line for lines that wrap. This helps when using copy/paste with the
6666 mouse in an xterm and other terminals.
6667
6668 *'ttymouse'* *'ttym'*
6669'ttymouse' 'ttym' string (default depends on 'term')
6670 global
6671 {not in Vi}
6672 {only in Unix and VMS, doesn't work in the GUI; not
6673 available when compiled without |+mouse|}
6674 Name of the terminal type for which mouse codes are to be recognized.
6675 Currently these three strings are valid:
6676 *xterm-mouse*
6677 xterm xterm-like mouse handling. The mouse generates
6678 "<Esc>[Mscr", where "scr" is three bytes:
6679 "s" = button state
6680 "c" = column plus 33
6681 "r" = row plus 33
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006682 This only works up to 223 columns! See "dec" for a
6683 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 xterm2 Works like "xterm", but with the xterm reporting the
6685 mouse position while the mouse is dragged. This works
6686 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00006687 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 work. See below for how Vim detects this
6689 automatically.
6690 *netterm-mouse*
6691 netterm NetTerm mouse handling. The mouse generates
6692 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
6693 for the row and column.
6694 *dec-mouse*
6695 dec DEC terminal mouse handling. The mouse generates a
6696 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00006697 This is also available for an Xterm, if it was
6698 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 *jsbterm-mouse*
6700 jsbterm JSB term mouse handling.
6701 *pterm-mouse*
6702 pterm QNX pterm mouse handling.
6703
6704 The mouse handling must be enabled at compile time |+mouse_xterm|
6705 |+mouse_dec| |+mouse_netterm|.
6706 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
6707 recognized, if enabled at compile time. DEC terminal mouse codes
6708 are recognized if enabled at compile time, and 'ttymouse' is not
6709 "xterm" (because the xterm and dec mouse codes conflict).
6710 This option is automatically set to "xterm", when the 'term' option is
6711 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
6712 or "xterm2" already. The main use of this option is to set it to
6713 "xterm", when the terminal name doesn't start with "xterm", but it can
6714 handle xterm mouse codes.
6715 The "xterm2" value will be set if the xterm version is reported to be
6716 95 of higher. This only works when compiled with the |+termresponse|
6717 feature and if |t_RV| is set to the escape sequence to request the
6718 xterm version number. Otherwise "xterm2" must be set explicitly.
6719 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
6720 t_RV to an empty string: >
6721 :set t_RV=
6722<
6723 *'ttyscroll'* *'tsl'*
6724'ttyscroll' 'tsl' number (default 999)
6725 global
6726 Maximum number of lines to scroll the screen. If there are more lines
6727 to scroll the window is redrawn. For terminals where scrolling is
6728 very slow and redrawing is not slow this can be set to a small number,
6729 e.g., 3, to speed up displaying.
6730
6731 *'ttytype'* *'tty'*
6732'ttytype' 'tty' string (default from $TERM)
6733 global
6734 Alias for 'term', see above.
6735
6736 *'undolevels'* *'ul'*
6737'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
6738 Win32 and OS/2)
6739 global
6740 {not in Vi}
6741 Maximum number of changes that can be undone. Since undo information
6742 is kept in memory, higher numbers will cause more memory to be used
6743 (nevertheless, a single change can use an unlimited amount of memory).
6744 Set to 0 for Vi compatibility: One level of undo and "u" undoes
6745 itself: >
6746 set ul=0
6747< But you can also get Vi compatibility by including the 'u' flag in
6748 'cpoptions', and still be able to use CTRL-R to repeat undo.
6749 Set to a negative number for no undo at all: >
6750 set ul=-1
6751< This helps when you run out of memory for a single change.
6752 Also see |undo-two-ways|.
6753
6754 *'updatecount'* *'uc'*
6755'updatecount' 'uc' number (default: 200)
6756 global
6757 {not in Vi}
6758 After typing this many characters the swap file will be written to
6759 disk. When zero, no swap file will be created at all (see chapter on
6760 recovery |crash-recovery|). 'updatecount' is set to zero by starting
6761 Vim with the "-n" option, see |startup|. When editing in readonly
6762 mode this option will be initialized to 10000.
6763 The swapfile can be disabled per buffer with |'swapfile'|.
6764 When 'updatecount' is set from zero to non-zero, swap files are
6765 created for all buffers that have 'swapfile' set. When 'updatecount'
6766 is set to zero, existing swap files are not deleted.
6767 Also see |'swapsync'|.
6768 This option has no meaning in buffers where |'buftype'| is "nofile"
6769 or "nowrite".
6770
6771 *'updatetime'* *'ut'*
6772'updatetime' 'ut' number (default 4000)
6773 global
6774 {not in Vi}
6775 If this many milliseconds nothing is typed the swap file will be
6776 written to disk (see |crash-recovery|). Also used for the
6777 |CursorHold| autocommand event.
6778
6779 *'verbose'* *'vbs'*
6780'verbose' 'vbs' number (default 0)
6781 global
6782 {not in Vi, although some versions have a boolean
6783 verbose option}
6784 When bigger than zero, Vim will give messages about what it is doing.
6785 Currently, these messages are given:
6786 >= 1 When the viminfo file is read or written.
6787 >= 2 When a file is ":source"'ed.
6788 >= 5 Every searched tags file.
6789 >= 8 Files for which a group of autocommands is executed.
6790 >= 9 Every executed autocommand.
6791 >= 12 Every executed function.
6792 >= 13 When an exception is thrown, caught, finished, or discarded.
6793 >= 14 Anything pending in a ":finally" clause.
6794 >= 15 Every executed Ex command (truncated at 200 characters).
6795
6796 This option can also be set with the "-V" argument. See |-V|.
6797 This option is also set by the |:verbose| command.
6798
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00006799 When the 'verbosefile' option is set then the verbose messages are not
6800 displayed.
6801
6802 *'verbosefile'* *'vfile'*
6803'verbosefile' 'vfile' string (default empty)
6804 global
6805 {not in Vi}
6806 When not empty all messages are written in a file with this name.
6807 When the file exists messages are appended.
6808 Writing to the file ends when Vim exits or when 'verbosefile' is made
6809 empty.
6810 Setting 'verbosefile' to a new value is like making it empty first.
6811 The difference with |:redir| is that verbose messages are not
6812 displayed when 'verbosefile' is set.
6813
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 *'viewdir'* *'vdir'*
6815'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
6816 "$VIM/vimfiles/view",
6817 for Unix: "~/.vim/view",
6818 for Macintosh: "$VIM:vimfiles:view"
6819 for VMS: "sys$login:vimfiles/view"
6820 for RiscOS: "Choices:vimfiles/view")
6821 global
6822 {not in Vi}
6823 {not available when compiled without the +mksession
6824 feature}
6825 Name of the directory where to store files for |:mkview|.
6826 This option cannot be set from a |modeline| or in the |sandbox|, for
6827 security reasons.
6828
6829 *'viewoptions'* *'vop'*
6830'viewoptions' 'vop' string (default: "folds,options,cursor")
6831 global
6832 {not in Vi}
6833 {not available when compiled without the +mksession
6834 feature}
6835 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006836 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837 word save and restore ~
6838 cursor cursor position in file and in window
6839 folds manually created folds, opened/closed folds and local
6840 fold options
6841 options options and mappings local to a window or buffer (not
6842 global values for local options)
6843 slash backslashes in file names replaced with forward
6844 slashes
6845 unix with Unix end-of-line format (single <NL>), even when
6846 on Windows or DOS
6847
6848 "slash" and "unix" are useful on Windows when sharing view files
6849 with Unix. The Unix version of Vim cannot source dos format scripts,
6850 but the Windows version of Vim can source unix format scripts.
6851
6852 *'viminfo'* *'vi'* *E526* *E527* *E528*
6853'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
6854 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
6855 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
6856 for others: '20,<50,s10,h)
6857 global
6858 {not in Vi}
6859 {not available when compiled without the |+viminfo|
6860 feature}
6861 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006862 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 separated list of parameters, each consisting of a single character
6864 identifying the particular parameter, followed by a number or string
6865 which specifies the value of that parameter. If a particular
6866 character is left out, then the default value is used for that
6867 parameter. The following is a list of the identifying characters and
6868 the effect of their value.
6869 CHAR VALUE ~
6870 ! When included, save and restore global variables that start
6871 with an uppercase letter, and don't contain a lowercase
6872 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00006873 and "_K_L_M" are not. Only String and Number types are
6874 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 " Maximum number of lines saved for each register. Old name of
6876 the '<' item, with the disadvantage that you need to put a
6877 backslash before the ", otherwise it will be recognized as the
6878 start of a comment!
6879 % When included, save and restore the buffer list. If Vim is
6880 started with a file name argument, the buffer list is not
6881 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006882 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 without a file name and buffers for help files are not written
6884 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00006885 When followed by a number, the number specifies the maximum
6886 number of buffers that are stored. Without a number all
6887 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888 ' Maximum number of previously edited files for which the marks
6889 are remembered. This parameter must always be included when
6890 'viminfo' is non-empty.
6891 Including this item also means that the |jumplist| and the
6892 |changelist| are stored in the viminfo file.
6893 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006894 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 patterns are also saved. When not included, the value of
6896 'history' is used.
6897 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006898 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 < Maximum number of lines saved for each register. If zero then
6900 registers are not saved. When not included, all lines are
6901 saved. '"' is the old name for this item.
6902 Also see the 's' item below: limit specified in Kbyte.
6903 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006904 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006905 c When included, convert the text in the viminfo file from the
6906 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00006907 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 f Whether file marks need to be stored. If zero, file marks ('0
6909 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006910 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 cursor position (when exiting or when doing ":wviminfo").
6912 h Disable the effect of 'hlsearch' when loading the viminfo
6913 file. When not included, it depends on whether ":nohlsearch"
6914 has been used since the last search command.
6915 n Name of the viminfo file. The name must immediately follow
6916 the 'n'. Must be the last one! If the "-i" argument was
6917 given when starting Vim, that file name overrides the one
6918 given here with 'viminfo'. Environment variables are expanded
6919 when opening the file, not when setting the option.
6920 r Removable media. The argument is a string (up to the next
6921 ','). This parameter can be given several times. Each
6922 specifies the start of a path for which no marks will be
6923 stored. This is to avoid removable media. For MS-DOS you
6924 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
6925 also use it for temp files, e.g., for Unix: "r/tmp". Case is
6926 ignored. Maximum length of each 'r' argument is 50
6927 characters.
6928 s Maximum size of an item in Kbyte. If zero then registers are
6929 not saved. Currently only applies to registers. The default
6930 "s10" will exclude registers with more than 10 Kbyte of text.
6931 Also see the '<' item above: line count limit.
6932
6933 Example: >
6934 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
6935<
6936 '50 Marks will be remembered for the last 50 files you
6937 edited.
6938 <1000 Contents of registers (up to 1000 lines each) will be
6939 remembered.
6940 s100 Registers with more than 100 Kbyte text are skipped.
6941 :0 Command-line history will not be saved.
6942 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
6943 no / Since '/' is not specified, the default will be used,
6944 that is, save all of the search history, and also the
6945 previous search and substitute patterns.
6946 no % The buffer list will not be saved nor read back.
6947 no h 'hlsearch' highlighting will be restored.
6948
6949 When setting 'viminfo' from an empty value you can use |:rviminfo| to
6950 load the contents of the file, this is not done automatically.
6951
6952 This option cannot be set from a |modeline| or in the |sandbox|, for
6953 security reasons.
6954
6955 *'virtualedit'* *'ve'*
6956'virtualedit' 've' string (default "")
6957 global
6958 {not in Vi}
6959 {not available when compiled without the
6960 |+virtualedit| feature}
6961 A comma separated list of these words:
6962 block Allow virtual editing in Visual block mode.
6963 insert Allow virtual editing in Insert mode.
6964 all Allow virtual editing in all modes.
6965 Virtual editing means that the cursor can be positioned where there is
6966 no actual character. This can be halfway into a Tab or beyond the end
6967 of the line. Useful for selecting a rectangle in Visual mode and
6968 editing a table.
6969
6970 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
6971'visualbell' 'vb' boolean (default off)
6972 global
6973 {not in Vi}
6974 Use visual bell instead of beeping. The terminal code to display the
6975 visual bell is given with 't_vb'. When no beep or flash is wanted,
6976 use ":set vb t_vb=".
6977 Note: When the GUI starts, 't_vb' is reset to its default value. You
6978 might want to set it again in your |gvimrc|.
6979 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
6980 for 20 msec. If you want to use a different time, use "<Esc>|40f",
6981 where 40 is the time in msec.
6982 Does not work on the Amiga, you always get a screen flash.
6983 Also see 'errorbells'.
6984
6985 *'warn'* *'nowarn'*
6986'warn' boolean (default on)
6987 global
6988 Give a warning message when a shell command is used while the buffer
6989 has been changed.
6990
6991 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
6992'weirdinvert' 'wiv' boolean (default off)
6993 global
6994 {not in Vi}
6995 This option has the same effect as the 't_xs' termcap option.
6996 It is provided for backwards compatibility with version 4.x.
6997 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
6998 vice versa. Has no effect when the GUI is running.
6999
7000 *'whichwrap'* *'ww'*
7001'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7002 global
7003 {not in Vi}
7004 Allow specified keys that move the cursor left/right to move to the
7005 previous/next line when the cursor is on the first/last character in
7006 the line. Concatenate characters to allow this for these keys:
7007 char key mode ~
7008 b <BS> Normal and Visual
7009 s <Space> Normal and Visual
7010 h "h" Normal and Visual
7011 l "l" Normal and Visual
7012 < <Left> Normal and Visual
7013 > <Right> Normal and Visual
7014 ~ "~" Normal
7015 [ <Left> Insert and Replace
7016 ] <Right> Insert and Replace
7017 For example: >
7018 :set ww=<,>,[,]
7019< allows wrap only when cursor keys are used.
7020 When the movement keys are used in combination with a delete or change
7021 operator, the <EOL> also counts for a character. This makes "3h"
7022 different from "3dh" when the cursor crosses the end of a line. This
7023 is also true for "x" and "X", because they do the same as "dl" and
7024 "dh". If you use this, you may also want to use the mapping
7025 ":map <BS> X" to make backspace delete the character in front of the
7026 cursor.
7027 When 'l' is included, you get a side effect: "yl" on an empty line
7028 will include the <EOL>, so that "p" will insert a new line.
7029 NOTE: This option is set to the Vi default value when 'compatible' is
7030 set and to the Vim default value when 'compatible' is reset.
7031
7032 *'wildchar'* *'wc'*
7033'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7034 global
7035 {not in Vi}
7036 Character you have to type to start wildcard expansion in the
7037 command-line, as specified with 'wildmode'.
7038 The character is not recognized when used inside a macro. See
7039 'wildcharm' for that.
7040 Although 'wc' is a number option, you can set it to a special key: >
7041 :set wc=<Esc>
7042< NOTE: This option is set to the Vi default value when 'compatible' is
7043 set and to the Vim default value when 'compatible' is reset.
7044
7045 *'wildcharm'* *'wcm'*
7046'wildcharm' 'wcm' number (default: none (0))
7047 global
7048 {not in Vi}
7049 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007050 recognized when used inside a macro. You can find "spare" command-line
7051 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007052 you'll never actually type 'wildcharm', just use it in mappings that
7053 automatically invoke completion mode, e.g.: >
7054 :set wcm=<C-Z>
7055 :cmap ss so $vim/sessions/*.vim<C-Z>
7056< Then after typing :ss you can use CTRL-P & CTRL-N.
7057
7058 *'wildignore'* *'wig'*
7059'wildignore' 'wig' string (default "")
7060 global
7061 {not in Vi}
7062 {not available when compiled without the |+wildignore|
7063 feature}
7064 A list of file patterns. A file that matches with one of these
7065 patterns is ignored when completing file or directory names.
7066 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7067 Also see 'suffixes'.
7068 Example: >
7069 :set wildignore=*.o,*.obj
7070< The use of |:set+=| and |:set-=| is preferred when adding or removing
7071 a pattern from the list. This avoids problems when a future version
7072 uses another default.
7073
7074 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7075'wildmenu' 'wmnu' boolean (default off)
7076 global
7077 {not in Vi}
7078 {not available if compiled without the |+wildmenu|
7079 feature}
7080 When 'wildmenu' is on, command-line completion operates in an enhanced
7081 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7082 the possible matches are shown just above the command line, with the
7083 first match highlighted (overwriting the status line, if there is
7084 one). Keys that show the previous/next match, such as <Tab> or
7085 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7086 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7087 specified. "longest" and "list" do not start "wildmenu" mode.
7088 If there are more matches than can fit in the line, a ">" is shown on
7089 the right and/or a "<" is shown on the left. The status line scrolls
7090 as needed.
7091 The "wildmenu" mode is abandoned when a key is hit that is not used
7092 for selecting a completion.
7093 While the "wildmenu" is active the following keys have special
7094 meanings:
7095
7096 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7097 <Down> - in filename/menu name completion: move into a
7098 subdirectory or submenu.
7099 <CR> - in menu completion, when the cursor is just after a
7100 dot: move into a submenu.
7101 <Up> - in filename/menu name completion: move up into
7102 parent directory or parent menu.
7103
7104 This makes the menus accessible from the console |console-menus|.
7105
7106 If you prefer the <Left> and <Right> keys to move the cursor instead
7107 of selecting a different match, use this: >
7108 :cnoremap <Left> <Space><BS><Left>
7109 :cnoremap <Right> <Space><BS><Right>
7110<
7111 The "WildMenu" highlighting is used for displaying the current match
7112 |hl-WildMenu|.
7113
7114 *'wildmode'* *'wim'*
7115'wildmode' 'wim' string (Vim default: "full")
7116 global
7117 {not in Vi}
7118 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007119 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007120 part specifies what to do for each consecutive use of 'wildchar. The
7121 first part specifies the behavior for the first use of 'wildchar',
7122 The second part for the second use, etc.
7123 These are the possible values for each part:
7124 "" Complete only the first match.
7125 "full" Complete the next full match. After the last match,
7126 the original string is used and then the first match
7127 again.
7128 "longest" Complete till longest common string. If this doesn't
7129 result in a longer string, use the next part.
7130 "longest:full" Like "longest", but also start 'wildmenu' if it is
7131 enabled.
7132 "list" When more than one match, list all matches.
7133 "list:full" When more than one match, list all matches and
7134 complete first match.
7135 "list:longest" When more than one match, list all matches and
7136 complete till longest common string.
7137 When there is only a single match, it is fully completed in all cases.
7138
7139 Examples: >
7140 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007141< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 :set wildmode=longest,full
7143< Complete longest common string, then each full match >
7144 :set wildmode=list:full
7145< List all matches and complete each full match >
7146 :set wildmode=list,full
7147< List all matches without completing, then each full match >
7148 :set wildmode=longest,list
7149< Complete longest common string, then list alternatives.
7150
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007151 *'wildoptions'* *'wop'*
7152'wildoptions' 'wop' string (default "")
7153 global
7154 {not in Vi}
7155 {not available when compiled without the |+wildignore|
7156 feature}
7157 A list of words that change how command line completion is done.
7158 Currently only one word is allowed:
7159 tagfile When using CTRL-D to list matching tags, the kind of
7160 tag and the file of the tag is listed. Only one match
7161 is displayed per line. Often used tag kinds are:
7162 d #define
7163 f function
7164 Also see |cmdline-completion|.
7165
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 *'winaltkeys'* *'wak'*
7167'winaltkeys' 'wak' string (default "menu")
7168 global
7169 {not in Vi}
7170 {only used in Win32, Motif, GTK and Photon GUI}
7171 Some GUI versions allow the access to menu entries by using the ALT
7172 key in combination with a character that appears underlined in the
7173 menu. This conflicts with the use of the ALT key for mappings and
7174 entering special characters. This option tells what to do:
7175 no Don't use ALT keys for menus. ALT key combinations can be
7176 mapped, but there is no automatic handling. This can then be
7177 done with the |:simalt| command.
7178 yes ALT key handling is done by the windowing system. ALT key
7179 combinations cannot be mapped.
7180 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007181 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 keys can be mapped.
7183 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7184 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007185 This option is not used for <F10>; on Win32 and with GTK <F10> will
7186 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007187
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007188 *'window'* *'wi'*
7189'window' 'wi' number (default screen height - 1)
7190 global
7191 Window height. Do not confuse this with the height of the Vim window,
7192 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007193 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7194 value is smaller than 'lines' minus one. The screen will scroll
7195 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007196 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7197 in a much smarter way, taking care of wrapping lines.
7198 When resizing the Vim window, the value is smaller than 1 or more than
7199 or equal to 'lines' it will be set to 'lines' minus 1.
7200 {Vi also uses the option to specify the number of displayed lines}
7201
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 *'winheight'* *'wh'* *E591*
7203'winheight' 'wh' number (default 1)
7204 global
7205 {not in Vi}
7206 {not available when compiled without the +windows
7207 feature}
7208 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007209 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 current window is smaller, its size is increased, at the cost of the
7211 height of other windows. Set it to 999 to make the current window
7212 always fill the screen (although this has the drawback that ":all"
7213 will create only two windows). Set it to a small number for normal
7214 editing.
7215 Minimum value is 1.
7216 The height is not adjusted after one of the commands to change the
7217 height of the current window.
7218 'winheight' applies to the current window. Use 'winminheight' to set
7219 the minimal height for other windows.
7220
7221 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7222'winfixheight' 'wfh' boolean (default off)
7223 local to window
7224 {not in Vi}
7225 {not available when compiled without the +windows
7226 feature}
7227 Keep the window height when windows are opened or closed and
7228 'equalalways' is set. Set by default for the |preview-window| and
7229 |quickfix-window|.
7230 The height may be changed anyway when running out of room.
7231
7232 *'winminheight'* *'wmh'*
7233'winminheight' 'wmh' number (default 1)
7234 global
7235 {not in Vi}
7236 {not available when compiled without the +windows
7237 feature}
7238 The minimal height of a window, when it's not the current window.
7239 This is a hard minimum, windows will never become smaller.
7240 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7241 status bar) if necessary. They will return to at least one line when
7242 they become active (since the cursor has to have somewhere to go.)
7243 Use 'winheight' to set the minimal height of the current window.
7244 This option is only checked when making a window smaller. Don't use a
7245 large number, it will cause errors when opening more than a few
7246 windows. A value of 0 to 3 is reasonable.
7247
7248 *'winminwidth'* *'wmw'*
7249'winminwidth' 'wmw' number (default 1)
7250 global
7251 {not in Vi}
7252 {not available when compiled without the +vertsplit
7253 feature}
7254 The minimal width of a window, when it's not the current window.
7255 This is a hard minimum, windows will never become smaller.
7256 When set to zero, windows may be "squashed" to zero columns (i.e. just
7257 a vertical separator) if necessary. They will return to at least one
7258 line when they become active (since the cursor has to have somewhere
7259 to go.)
7260 Use 'winwidth' to set the minimal width of the current window.
7261 This option is only checked when making a window smaller. Don't use a
7262 large number, it will cause errors when opening more than a few
7263 windows. A value of 0 to 12 is reasonable.
7264
7265 *'winwidth'* *'wiw'* *E592*
7266'winwidth' 'wiw' number (default 20)
7267 global
7268 {not in Vi}
7269 {not available when compiled without the +vertsplit
7270 feature}
7271 Minimal number of columns for the current window. This is not a hard
7272 minimum, Vim will use fewer columns if there is not enough room. If
7273 the current window is smaller, its size is increased, at the cost of
7274 the width of other windows. Set it to 999 to make the current window
7275 always fill the screen. Set it to a small number for normal editing.
7276 The width is not adjusted after one of the commands to change the
7277 width of the current window.
7278 'winwidth' applies to the current window. Use 'winminwidth' to set
7279 the minimal width for other windows.
7280
7281 *'wrap'* *'nowrap'*
7282'wrap' boolean (default on)
7283 local to window
7284 {not in Vi}
7285 This option changes how text is displayed. It doesn't change the text
7286 in the buffer, see 'textwidth' for that.
7287 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007288 displaying continues on the next line. When off lines will not wrap
7289 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 moved to a part that is not shown, the screen will scroll
7291 horizontally.
7292 The line will be broken in the middle of a word if necessary. See
7293 'linebreak' to get the break at a word boundary.
7294 To make scrolling horizontally a bit more useful, try this: >
7295 :set sidescroll=5
7296 :set listchars+=precedes:<,extends:>
7297< See 'sidescroll', 'listchars' and |wrap-off|.
7298
7299 *'wrapmargin'* *'wm'*
7300'wrapmargin' 'wm' number (default 0)
7301 local to buffer
7302 Number of characters from the right window border where wrapping
7303 starts. When typing text beyond this limit, an <EOL> will be inserted
7304 and inserting continues on the next line.
7305 Options that add a margin, such as 'number' and 'foldcolumn', cause
7306 the text width to be further reduced. This is Vi compatible.
7307 When 'textwidth' is non-zero, this option is not used.
7308 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7309 and less usefully}
7310
7311 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7312'wrapscan' 'ws' boolean (default on) *E384* *E385*
7313 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007314 Searches wrap around the end of the file. Also applies to |]s| and
7315 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316
7317 *'write'* *'nowrite'*
7318'write' boolean (default on)
7319 global
7320 {not in Vi}
7321 Allows writing files. When not set, writing a file is not allowed.
7322 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007323 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007324 argument. Filtering text is still possible, even though this requires
7325 writing a temporary file.
7326
7327 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7328'writeany' 'wa' boolean (default off)
7329 global
7330 Allows writing to any file with no need for "!" override.
7331
7332 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7333'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7334 otherwise)
7335 global
7336 {not in Vi}
7337 Make a backup before overwriting a file. The backup is removed after
7338 the file was successfully written, unless the 'backup' option is
7339 also on. Reset this option if your file system is almost full. See
7340 |backup-table| for another explanation.
7341 When the 'backupskip' pattern matches, a backup is not made anyway.
7342 NOTE: This option is set to the default value when 'compatible' is
7343 set.
7344
7345 *'writedelay'* *'wd'*
7346'writedelay' 'wd' number (default 0)
7347 global
7348 {not in Vi}
7349 The number of microseconds to wait for each character sent to the
7350 screen. When non-zero, characters are sent to the terminal one by
7351 one. For MS-DOS pcterm this does not work. For debugging purposes.
7352
7353 vim:tw=78:ts=8:ft=help:norl: