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