blob: 3beb2b0cff76b20da0b78686cbf2a394412460e2 [file] [log] [blame]
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01001*options.txt* For Vim version 7.3. Last change: 2013 Jan 30
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
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
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
280You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000281"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100304:se[t] {option}< For |global-local| options: Remove the local value of
305 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {not in Vi}
307
308 *:setg* *:setglobal*
309:setg[lobal] ... Like ":set" but set only the global value for a local
310 option without changing the local value.
311 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200312 With the "all" argument: display global values for all
313 local options.
314 Without argument: display global values for all local
315 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318For buffer-local and window-local options:
319 Command global value local value ~
320 :set option=value set set
321 :setlocal option=value - set
322:setglobal option=value set -
323 :set option? - display
324 :setlocal option? - display
325:setglobal option? display -
326
327
328Global options with a local value *global-local*
329
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000330Options are global when you mostly use one value for all buffers and windows.
331For some global options it's useful to sometimes have a different local value.
332You can set the local value with ":setlocal". That buffer or window will then
333use the local value, while other buffers and windows continue using the global
334value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336For example, you have two windows, both on C source code. They use the global
337'makeprg' option. If you do this in one of the two windows: >
338 :set makeprg=gmake
339then the other window will switch to the same value. There is no need to set
340the 'makeprg' option in the other C source window too.
341However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000342another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000343files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 :setlocal makeprg=perlmake
345You can switch back to using the global value by making the local value empty: >
346 :setlocal makeprg=
347This only works for a string option. For a boolean option you need to use the
348"<" flag, like this: >
349 :setlocal autoread<
350Note that for non-boolean options using "<" copies the global value to the
351local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000352when the global value changes later). You can also use: >
353 :set path<
354This will make the local value of 'path' empty, so that the global value is
355used. Thus it does the same as: >
356 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357Note: In the future more global options can be made global-local. Using
358":setlocal" on a global option might work differently then.
359
360
361Setting the filetype
362
363:setf[iletype] {filetype} *:setf* *:setfiletype*
364 Set the 'filetype' option to {filetype}, but only if
365 not done yet in a sequence of (nested) autocommands.
366 This is short for: >
367 :if !did_filetype()
368 : setlocal filetype={filetype}
369 :endif
370< This command is used in a filetype.vim file to avoid
371 setting the 'filetype' option twice, causing different
372 settings and syntax files to be loaded.
373 {not in Vi}
374
Bram Moolenaard58e9292011-02-09 17:07:58 +0100375 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
377:opt[ions] Open a window for viewing and setting all options.
378 Options are grouped by function.
379 Offers short help for each option. Hit <CR> on the
380 short help to open a help window with more help for
381 the option.
382 Modify the value of the option and hit <CR> on the
383 "set" line to set the new value. For window and
384 buffer specific options, the last accessed window is
385 used to set the option value in, unless this is a help
386 window, in which case the window below help window is
387 used (skipping the option-window).
388 {not available when compiled without the |+eval| or
389 |+autocmd| features}
390
391 *$HOME*
392Using "~" is like using "$HOME", but it is only recognized at the start of an
393option and after a space or comma.
394
395On Unix systems "~user" can be used too. It is replaced by the home directory
396of user "user". Example: >
397 :set path=~mool/include,/usr/include,.
398
399On Unix systems the form "${HOME}" can be used too. The name between {} can
400contain non-id characters then. Note that if you want to use this for the
401"gf" command, you need to add the '{' and '}' characters to 'isfname'.
402
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100403On MS-Windows, if $HOME is not defined as an environment variable, then
404at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406NOTE: expanding environment variables and "~/" is only done with the ":set"
407command, not when assigning a value to an option with ":let".
408
409
410Note the maximum length of an expanded option is limited. How much depends on
411the system, mostly it is something like 256 or 1024 characters.
412
413 *:fix* *:fixdel*
414:fix[del] Set the value of 't_kD':
415 't_kb' is 't_kD' becomes ~
416 CTRL-? CTRL-H
417 not CTRL-? CTRL-?
418
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
420
421 If your delete key terminal code is wrong, but the
422 code for backspace is alright, you can put this in
423 your .vimrc: >
424 :fixdel
425< This works no matter what the actual code for
426 backspace is.
427
428 If the backspace key terminal code is wrong you can
429 use this: >
430 :if &term == "termname"
431 : set t_kb=^V<BS>
432 : fixdel
433 :endif
434< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000435 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 with your terminal name.
437
438 If your <Delete> key sends a strange key sequence (not
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
440 :if &term == "termname"
441 : set t_kD=^V<Delete>
442 :endif
443< Where "^V" is CTRL-V and "<Delete>" is the delete key
444 (don't type eight characters!). Replace "termname"
445 with your terminal name.
446
447 *Linux-backspace*
448 Note about Linux: By default the backspace key
449 produces CTRL-?, which is wrong. You can fix it by
450 putting this line in your rc.local: >
451 echo "keycode 14 = BackSpace" | loadkeys
452<
453 *NetBSD-backspace*
454 Note about NetBSD: If your backspace doesn't produce
455 the right code, try this: >
456 xmodmap -e "keycode 22 = BackSpace"
457< If this works, add this in your .Xmodmap file: >
458 keysym 22 = BackSpace
459< You need to restart for this to take effect.
460
461==============================================================================
4622. Automatically setting options *auto-setting*
463
464Besides changing options with the ":set" command, there are three alternatives
465to set options automatically for one or more files:
466
4671. When starting Vim initializations are read from various places. See
468 |initialization|. Most of them are performed for all editing sessions,
469 and some of them depend on the directory where Vim is started.
470 You can create an initialization file with |:mkvimrc|, |:mkview| and
471 |:mksession|.
4722. If you start editing a new file, the automatic commands are executed.
473 This can be used to set options for files matching a particular pattern and
474 many other things. See |autocommand|.
4753. If you start editing a new file, and the 'modeline' option is on, a
476 number of lines at the beginning and end of the file are checked for
477 modelines. This is explained here.
478
479 *modeline* *vim:* *vi:* *ex:* *E520*
480There are two forms of modelines. The first form:
481 [text]{white}{vi:|vim:|ex:}[white]{options}
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487{options} a list of option settings, separated with white space or ':',
488 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000489 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000491Example:
492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493
494The second form (this is compatible with some versions of Vi):
495
496 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
497
498[text] any text or empty
499{white} at least one blank character (<Space> or <Tab>)
500{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
501[white] optional white space
502se[t] the string "set " or "se " (note the space)
503{options} a list of options, separated with white space, which is the
504 argument for a ":set" command
505: a colon
506[text] any text or empty
507
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000508Example:
509 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511The white space before {vi:|vim:|ex:} is required. This minimizes the chance
512that a normal word like "lex:" is caught. There is one exception: "vi:" and
513"vim:" can also be at the start of the line (for compatibility with version
5143.0). Using "ex:" at the start of the line will be ignored (this could be
515short for "example:").
516
517 *modeline-local*
518The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000519buffer and window that contain the file. Although it's possible to set global
520options from a modeline, this is unusual. If you have two windows open and
521the files in it set the same global option to a different value, the result
522depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000524When editing a file that was already loaded, only the window-local options
525from the modeline are used. Thus if you manually changed a buffer-local
526option after opening the file, it won't be changed if you edit the same buffer
527in another window. But window-local options will be set.
528
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 *modeline-version*
530If the modeline is only to be used for some versions of Vim, the version
531number can be specified where "vim:" is used:
532 vim{vers}: version {vers} or later
533 vim<{vers}: version before {vers}
534 vim={vers}: version {vers}
535 vim>{vers}: version after {vers}
536{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000537For example, to use a modeline only for Vim 6.0 and later:
538 /* vim600: set foldmethod=marker: */ ~
539To use a modeline for Vim before version 5.7:
540 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541There can be no blanks between "vim" and the ":".
542
543
544The number of lines that are checked can be set with the 'modelines' option.
545If 'modeline' is off or 'modelines' is 0 no lines are checked.
546
547Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000548like:
549 /* vi:ts=4: */ ~
550will give an error message for the trailing "*/". This line is OK:
551 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553If an error is detected the rest of the line is skipped.
554
555If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000556backslash in front of the ':' will be removed. Example:
557 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558This sets the 'dir' option to "c:\tmp". Only a single backslash before the
559':' is removed. Thus to include "\:" you have to specify "\\:".
560
561No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000562might create a Trojan horse text file with modelines). And not all options
563can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000564|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
566are wrapped unexpectedly. So disable modelines before editing untrusted text.
567The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568
569Hint: If you would like to do something else than setting an option, you could
570define an autocommand that checks the file for a specific string. For
571example: >
572 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
573And define a function SetVar() that does something with the line containing
574"VAR".
575
576==============================================================================
5773. Options summary *option-summary*
578
579In the list below all the options are mentioned with their full name and with
580an abbreviation if there is one. Both forms may be used.
581
582In this document when a boolean option is "set" that means that ":set option"
583is entered. When an option is "reset", ":set nooption" is used.
584
585For some options there are two default values: The "Vim default", which is
586used when 'compatible' is not set, and the "Vi default", which is used when
587'compatible' is set.
588
589Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000590are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591different value in each window. For example the 'list' option can be set in
592one window and reset in another for the same text, giving both types of view
593at the same time. There are a few options that are specific to a certain
594file. These can have a different value for each file or buffer. For example
595the 'textwidth' option can be 78 for a normal text file and 0 for a C
596program.
597
598 global one option for all buffers and windows
599 local to window each window has its own copy of this option
600 local to buffer each buffer has its own copy of this option
601
602When creating a new window the option values from the currently active window
603are used as a default value for the window-specific options. For the
604buffer-specific options this depends on the 's' and 'S' flags in the
605'cpoptions' option. If 's' is included (which is the default) the values for
606buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000607first entered. If 'S' is present the options are copied each time the buffer
608is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609present, the options are copied from the currently active buffer when the
610buffer is created.
611
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000612Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000614Not all options are supported in all versions. This depends on the supported
615features and sometimes on the system. A remark about this is in curly braces
616below. When an option is not supported it may still be set without getting an
617error, this is called a hidden option. You can't get the value of a hidden
618option though, it is not stored.
619
620To test if option "foo" can be used with ":set" use something like this: >
621 if exists('&foo')
622This also returns true for a hidden option. To test if option "foo" is really
623supported use something like this: >
624 if exists('+foo')
625<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 *E355*
627A jump table for the options with a short description can be found at |Q_op|.
628
629 *'aleph'* *'al'* *aleph* *Aleph*
630'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
631 global
632 {not in Vi}
633 {only available when compiled with the |+rightleft|
634 feature}
635 The ASCII code for the first letter of the Hebrew alphabet. The
636 routine that maps the keyboard in Hebrew mode, both in Insert mode
637 (when hkmap is set) and on the command-line (when hitting CTRL-_)
638 outputs the Hebrew characters in the range [aleph..aleph+26].
639 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
640 See |rileft.txt|.
641
642 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
643'allowrevins' 'ari' boolean (default off)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
649 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
650 into reverse Insert mode, and don't know how to get out. See
651 'revins'.
652 NOTE: This option is reset when 'compatible' is set.
653
654 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
655'altkeymap' 'akm' boolean (default off)
656 global
657 {not in Vi}
658 {only available when compiled with the |+farsi|
659 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000660 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 the keyboard map between Farsi and English, when 'allowrevins' set.
662
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 is useful to start the Vim in native mode i.e. English (left-to-right
665 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000666 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
668 *'ambiwidth'* *'ambw'*
669'ambiwidth' 'ambw' string (default: "single")
670 global
671 {not in Vi}
672 {only available when compiled with the |+multi_byte|
673 feature}
674 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
675 Tells Vim what to do with characters with East Asian Width Class
676 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
677 letters, Cyrillic letters).
678
679 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000680 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 expected by most users.
682 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200683 *E834* *E835*
684 The value "double" cannot be used if 'listchars' or 'fillchars'
685 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686
687 There are a number of CJK fonts for which the width of glyphs for
688 those characters are solely based on how many octets they take in
689 legacy/traditional CJK encodings. In those encodings, Euro,
690 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 Vim is running inside a terminal (emulators) that uses a CJK font
695 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
696 this option should be set to "double" to match the width perceived
697 by Vim with the width of glyphs in the font. Perhaps it also has
698 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
699 when the system locale is set to one of CJK locales. See Unicode
700 Standard Annex #11 (http://www.unicode.org/reports/tr11).
701
702 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
703'antialias' 'anti' boolean (default: off)
704 global
705 {not in Vi}
706 {only available when compiled with GUI enabled
707 on Mac OS X}
708 This option only has an effect in the GUI version of Vim on Mac OS X
709 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
710 which can be easier to read at certain sizes on certain displays.
711 Setting this option can sometimes cause problems if 'guifont' is set
712 to its default (empty string).
713
714 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
715'autochdir' 'acd' boolean (default off)
716 global
717 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200718 {only available when compiled with it, use
719 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000720 When on, Vim will change the current working directory whenever you
721 open a file, switch buffers, delete a buffer or open/close a window.
722 It will change to the directory containing the file which was opened
723 or selected.
724 This option is provided for backward compatibility with the Vim
725 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000726 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
729'arabic' 'arab' boolean (default off)
730 local to window
731 {not in Vi}
732 {only available when compiled with the |+arabic|
733 feature}
734 This option can be set to start editing Arabic text.
735 Setting this option will:
736 - Set the 'rightleft' option, unless 'termbidi' is set.
737 - Set the 'arabicshape' option, unless 'termbidi' is set.
738 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
739 between typing English and Arabic key mapping.
740 - Set the 'delcombine' option
741 Note that 'encoding' must be "utf-8" for working with Arabic text.
742
743 Resetting this option will:
744 - Reset the 'rightleft' option.
745 - Disable the use of 'keymap' (without changing its value).
746 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200747 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 Also see |arabic.txt|.
749
750 *'arabicshape'* *'arshape'*
751 *'noarabicshape'* *'noarshape'*
752'arabicshape' 'arshape' boolean (default on)
753 global
754 {not in Vi}
755 {only available when compiled with the |+arabic|
756 feature}
757 When on and 'termbidi' is off, the required visual character
758 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200759 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 one which encompasses:
761 a) the changing/morphing of characters based on their location
762 within a word (initial, medial, final and stand-alone).
763 b) the enabling of the ability to compose characters
764 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100765 When disabled the display shows each character's true stand-alone
766 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 Arabic is a complex language which requires other settings, for
768 further details see |arabic.txt|.
769
770 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
771'autoindent' 'ai' boolean (default off)
772 local to buffer
773 Copy indent from current line when starting a new line (typing <CR>
774 in Insert mode or when using the "o" or "O" command). If you do not
775 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000776 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
777 to another line has the same effect, unless the 'I' flag is included
778 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000779 When autoindent is on, formatting (with the "gq" command or when you
780 reach 'textwidth' in Insert mode) uses the indentation of the first
781 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 When 'smartindent' or 'cindent' is on the indent is changed in
783 a different way.
784 The 'autoindent' option is reset when the 'paste' option is set.
785 {small difference from Vi: After the indent is deleted when typing
786 <Esc> or <CR>, the cursor position when moving up or down is after the
787 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
788
789 *'autoread'* *'ar'* *'noautoread'* *'noar'*
790'autoread' 'ar' boolean (default off)
791 global or local to buffer |global-local|
792 {not in Vi}
793 When a file has been detected to have been changed outside of Vim and
794 it has not been changed inside of Vim, automatically read it again.
795 When the file has been deleted this is not done. |timestamp|
796 If this option has a local value, use this command to switch back to
797 using the global value: >
798 :set autoread<
799<
800 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
801'autowrite' 'aw' boolean (default off)
802 global
803 Write the contents of the file, if it has been modified, on each
804 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000805 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
807 Note that for some commands the 'autowrite' option is not used, see
808 'autowriteall' for that.
809
810 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
811'autowriteall' 'awa' boolean (default off)
812 global
813 {not in Vi}
814 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
815 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
816 Setting this option also implies that Vim behaves like 'autowrite' has
817 been set.
818
819 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200820'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 global
822 {not in Vi}
823 When set to "dark", Vim will try to use colors that look good on a
824 dark background. When set to "light", Vim will try to use colors that
825 look good on a light background. Any other value is illegal.
826 Vim tries to set the default value according to the terminal used.
827 This will not always be correct.
828 Setting this option does not change the background color, it tells Vim
829 what the background color looks like. For changing the background
830 color, see |:hi-normal|.
831
832 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000833 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000834 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100835 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 setting 'background' will cause the color scheme to be reloaded. If
837 the color scheme adjusts to the value of 'background' this will work.
838 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100839 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841 When setting 'background' to the default value with: >
842 :set background&
843< Vim will guess the value. In the GUI this should work correctly,
844 in other cases Vim might not be able to guess the right value.
845
846 When starting the GUI, the default value for 'background' will be
847 "light". When the value is not set in the .gvimrc, and Vim detects
848 that the background is actually quite dark, 'background' is set to
849 "dark". But this happens only AFTER the .gvimrc file has been read
850 (because the window needs to be opened to find the actual background
851 color). To get around this, force the GUI window to be opened by
852 putting a ":gui" command in the .gvimrc file, before where the value
853 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200854
855 For MS-DOS, Windows and OS/2 the default is "dark".
856 For other systems "dark" is used when 'term' is "linux",
857 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
858 background. Otherwise the default is "light".
859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 Normally this option would be set in the .vimrc file. Possibly
861 depending on the terminal name. Example: >
862 :if &term == "pcterm"
863 : set background=dark
864 :endif
865< When this option is set, the default settings for the highlight groups
866 will change. To use other settings, place ":highlight" commands AFTER
867 the setting of the 'background' option.
868 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
869 to select the colors for syntax highlighting. After changing this
870 option, you must load syntax.vim again to see the result. This can be
871 done with ":syntax on".
872
873 *'backspace'* *'bs'*
874'backspace' 'bs' string (default "")
875 global
876 {not in Vi}
877 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
878 mode. This is a list of items, separated by commas. Each item allows
879 a way to backspace over something:
880 value effect ~
881 indent allow backspacing over autoindent
882 eol allow backspacing over line breaks (join lines)
883 start allow backspacing over the start of insert; CTRL-W and CTRL-U
884 stop once at the start of insert.
885
886 When the value is empty, Vi compatible backspacing is used.
887
888 For backwards compatibility with version 5.4 and earlier:
889 value effect ~
890 0 same as ":set backspace=" (Vi compatible)
891 1 same as ":set backspace=indent,eol"
892 2 same as ":set backspace=indent,eol,start"
893
894 See |:fixdel| if your <BS> or <Del> key does not do what you want.
895 NOTE: This option is set to "" when 'compatible' is set.
896
897 *'backup'* *'bk'* *'nobackup'* *'nobk'*
898'backup' 'bk' boolean (default off)
899 global
900 {not in Vi}
901 Make a backup before overwriting a file. Leave it around after the
902 file has been successfully written. If you do not want to keep the
903 backup file, but you do want a backup while the file is being
904 written, reset this option and set the 'writebackup' option (this is
905 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 |backup-table| for more explanations.
908 When the 'backupskip' pattern matches, a backup is not made anyway.
909 When 'patchmode' is set, the backup may be renamed to become the
910 oldest version of a file.
911 NOTE: This option is reset when 'compatible' is set.
912
913 *'backupcopy'* *'bkc'*
914'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
915 global
916 {not in Vi}
917 When writing a file and a backup is made, this option tells how it's
918 done. This is a comma separated list of words.
919
920 The main values are:
921 "yes" make a copy of the file and overwrite the original one
922 "no" rename the file and write a new one
923 "auto" one of the previous, what works best
924
925 Extra values that can be combined with the ones above are:
926 "breaksymlink" always break symlinks when writing
927 "breakhardlink" always break hardlinks when writing
928
929 Making a copy and overwriting the original file:
930 - Takes extra time to copy the file.
931 + When the file has special attributes, is a (hard/symbolic) link or
932 has a resource fork, all this is preserved.
933 - When the file is a link the backup will have the name of the link,
934 not of the real file.
935
936 Renaming the file and writing a new one:
937 + It's fast.
938 - Sometimes not all attributes of the file can be copied to the new
939 file.
940 - When the file is a link the new file will not be a link.
941
942 The "auto" value is the middle way: When Vim sees that renaming file
943 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000944 the file is not a link) that is used. When problems are expected, a
945 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947 The "breaksymlink" and "breakhardlink" values can be used in
948 combination with any of "yes", "no" and "auto". When included, they
949 force Vim to always break either symbolic or hard links by doing
950 exactly what the "no" option does, renaming the original file to
951 become the backup and writing a new file in its place. This can be
952 useful for example in source trees where all the files are symbolic or
953 hard links and any changes should stay in the local source tree, not
954 be propagated back to the original source.
955 *crontab*
956 One situation where "no" and "auto" will cause problems: A program
957 that opens a file, invokes Vim to edit that file, and then tests if
958 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000959 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960 example.
961
962 When a copy is made, the original file is truncated and then filled
963 with the new text. This means that protection bits, owner and
964 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000965 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 group of the backup is set to the group of the original file. If this
967 fails, the protection bits for the group are made the same as for
968 others.
969
970 When the file is renamed this is the other way around: The backup has
971 the same attributes of the original file, and the newly written file
972 is owned by the current user. When the file was a (hard/symbolic)
973 link, the new file will not! That's why the "auto" value doesn't
974 rename when the file is a link. The owner and group of the newly
975 written file will be set to the same ones as the original file, but
976 the system may refuse to do this. In that case the "auto" value will
977 again not rename the file.
978
979 *'backupdir'* *'bdir'*
980'backupdir' 'bdir' string (default for Amiga: ".,t:",
981 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
982 for Unix: ".,~/tmp,~/")
983 global
984 {not in Vi}
985 List of directories for the backup file, separated with commas.
986 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100987 where this is possible. The directory must exist, Vim will not
988 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 - Empty means that no backup file will be created ('patchmode' is
990 impossible!). Writing may fail because of this.
991 - A directory "." means to put the backup file in the same directory
992 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000993 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 put the backup file relative to where the edited file is. The
995 leading "." is replaced with the path name of the edited file.
996 ("." inside a directory name has no special meaning).
997 - Spaces after the comma are ignored, other spaces are considered part
998 of the directory name. To have a space at the start of a directory
999 name, precede it with a backslash.
1000 - To include a comma in a directory name precede it with a backslash.
1001 - A directory name may end in an '/'.
1002 - Environment variables are expanded |:set_env|.
1003 - Careful with '\' characters, type one before a space, type two to
1004 get one in the option (see |option-backslash|), for example: >
1005 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1006< - For backwards compatibility with Vim version 3.0 a '>' at the start
1007 of the option is removed.
1008 See also 'backup' and 'writebackup' options.
1009 If you want to hide your backup files on Unix, consider this value: >
1010 :set backupdir=./.backup,~/.backup,.,/tmp
1011< You must create a ".backup" directory in each directory and in your
1012 home directory for this to work properly.
1013 The use of |:set+=| and |:set-=| is preferred when adding or removing
1014 directories from the list. This avoids problems when a future version
1015 uses another default.
1016 This option cannot be set from a |modeline| or in the |sandbox|, for
1017 security reasons.
1018
1019 *'backupext'* *'bex'* *E589*
1020'backupext' 'bex' string (default "~", for VMS: "_")
1021 global
1022 {not in Vi}
1023 String which is appended to a file name to make the name of the
1024 backup file. The default is quite unusual, because this avoids
1025 accidentally overwriting existing files with a backup file. You might
1026 prefer using ".bak", but make sure that you don't have files with
1027 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001028 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001030 If you like to keep a lot of backups, you could use a BufWritePre
1031 autocommand to change 'backupext' just before writing the file to
1032 include a timestamp. >
1033 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1034< Use 'backupdir' to put the backup in a different directory.
1035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 *'backupskip'* *'bsk'*
1037'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1038 global
1039 {not in Vi}
1040 {not available when compiled without the |+wildignore|
1041 feature}
1042 A list of file patterns. When one of the patterns matches with the
1043 name of the file which is written, no backup file is created. Both
1044 the specified file name and the full path name of the file are used.
1045 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1046 Watch out for special characters, see |option-backslash|.
1047 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001048 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001049
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001050 WARNING: Not having a backup file means that when Vim fails to write
1051 your buffer correctly and then, for whatever reason, Vim exits, you
1052 lose both the original file and what you were writing. Only disable
1053 backups if you don't care about losing the file.
1054
Bram Moolenaar02467872007-05-06 13:22:01 +00001055 Note that environment variables are not expanded. If you want to use
1056 $HOME you must expand it explicitly, e.g.: >
1057 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1058
1059< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001060 backup would be made by renaming the original file crontab won't see
1061 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062
1063 *'balloondelay'* *'bdlay'*
1064'balloondelay' 'bdlay' number (default: 600)
1065 global
1066 {not in Vi}
1067 {only available when compiled with the |+balloon_eval|
1068 feature}
1069 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1070
1071 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1072'ballooneval' 'beval' boolean (default off)
1073 global
1074 {not in Vi}
1075 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001076 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 Switch on the |balloon-eval| functionality.
1078
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001079 *'balloonexpr'* *'bexpr'*
1080'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001081 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001082 {not in Vi}
1083 {only available when compiled with the |+balloon_eval|
1084 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001085 Expression for text to show in evaluation balloon. It is only used
1086 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001087
1088 v:beval_bufnr number of the buffer in which balloon is going to show
1089 v:beval_winnr number of the window
1090 v:beval_lnum line number
1091 v:beval_col column number (byte index)
1092 v:beval_text word under or after the mouse pointer
1093
1094 The evaluation of the expression must not have side effects!
1095 Example: >
1096 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001097 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001098 \', column ' . v:beval_col .
1099 \ ' of file ' . bufname(v:beval_bufnr) .
1100 \ ' on word "' . v:beval_text . '"'
1101 endfunction
1102 set bexpr=MyBalloonExpr()
1103 set ballooneval
1104<
1105 NOTE: The balloon is displayed only if the cursor is on a text
1106 character. If the result of evaluating 'balloonexpr' is not empty,
1107 Vim does not try to send a message to an external debugger (Netbeans
1108 or Sun Workshop).
1109
Bram Moolenaar30b65812012-07-12 22:01:11 +02001110 The expression will be evaluated in the |sandbox| when set from a
1111 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001112
1113 It is not allowed to change text or jump to another window while
1114 evaluating 'balloonexpr' |textlock|.
1115
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001116 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001117 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001118< When they are supported "\n" characters will start a new line. If the
1119 expression evaluates to a |List| this is equal to using each List item
1120 as a string and putting "\n" in between them.
1121
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1123'binary' 'bin' boolean (default off)
1124 local to buffer
1125 {not in Vi}
1126 This option should be set before editing a binary file. You can also
1127 use the |-b| Vim argument. When this option is switched on a few
1128 options will be changed (also when it already was on):
1129 'textwidth' will be set to 0
1130 'wrapmargin' will be set to 0
1131 'modeline' will be off
1132 'expandtab' will be off
1133 Also, 'fileformat' and 'fileformats' options will not be used, the
1134 file is read and written like 'fileformat' was "unix" (a single <NL>
1135 separates lines).
1136 The 'fileencoding' and 'fileencodings' options will not be used, the
1137 file is read without conversion.
1138 NOTE: When you start editing a(nother) file while the 'bin' option is
1139 on, settings from autocommands may change the settings again (e.g.,
1140 'textwidth'), causing trouble when editing. You might want to set
1141 'bin' again when the file has been loaded.
1142 The previous values of these options are remembered and restored when
1143 'bin' is switched from on to off. Each buffer has its own set of
1144 saved option values.
1145 To edit a file with 'binary' set you can use the |++bin| argument.
1146 This avoids you have to do ":set bin", which would have effect for all
1147 files you edit.
1148 When writing a file the <EOL> for the last line is only written if
1149 there was one in the original file (normally Vim appends an <EOL> to
1150 the last line if there is none; this would make the file longer). See
1151 the 'endofline' option.
1152
1153 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1154'bioskey' 'biosk' boolean (default on)
1155 global
1156 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001157 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 better to detect CTRL-C, but only works for the console. When using a
1159 terminal over a serial port reset this option.
1160 Also see |'conskey'|.
1161
1162 *'bomb'* *'nobomb'*
1163'bomb' boolean (default off)
1164 local to buffer
1165 {not in Vi}
1166 {only available when compiled with the |+multi_byte|
1167 feature}
1168 When writing a file and the following conditions are met, a BOM (Byte
1169 Order Mark) is prepended to the file:
1170 - this option is on
1171 - the 'binary' option is off
1172 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1173 endian variants.
1174 Some applications use the BOM to recognize the encoding of the file.
1175 Often used for UCS-2 files on MS-Windows. For other applications it
1176 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001177 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1179 check for the presence of the BOM is done and 'bomb' set accordingly.
1180 Unless 'binary' is set, it is removed from the first line, so that you
1181 don't see it when editing. When you don't change the options, the BOM
1182 will be restored when writing the file.
1183
1184 *'breakat'* *'brk'*
1185'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1186 global
1187 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001188 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 feature}
1190 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001191 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1192 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193
1194 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001195'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001197 {not in Vi} {only for Motif, Athena, GTK, Mac and
1198 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001200 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001201 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 buffer Use the directory of the related buffer.
1203 current Use the current directory.
1204 {path} Use the specified directory
1205
1206 *'bufhidden'* *'bh'*
1207'bufhidden' 'bh' string (default: "")
1208 local to buffer
1209 {not in Vi}
1210 {not available when compiled without the |+quickfix|
1211 feature}
1212 This option specifies what happens when a buffer is no longer
1213 displayed in a window:
1214 <empty> follow the global 'hidden' option
1215 hide hide the buffer (don't unload it), also when 'hidden'
1216 is not set
1217 unload unload the buffer, also when 'hidden' is set or using
1218 |:hide|
1219 delete delete the buffer from the buffer list, also when
1220 'hidden' is set or using |:hide|, like using
1221 |:bdelete|
1222 wipe wipe out the buffer from the buffer list, also when
1223 'hidden' is set or using |:hide|, like using
1224 |:bwipeout|
1225
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001226 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001227 are lost without a warning. Also, these values may break autocommands
1228 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 This option is used together with 'buftype' and 'swapfile' to specify
1230 special kinds of buffers. See |special-buffers|.
1231
1232 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1233'buflisted' 'bl' boolean (default: on)
1234 local to buffer
1235 {not in Vi}
1236 When this option is set, the buffer shows up in the buffer list. If
1237 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1238 This option is reset by Vim for buffers that are only used to remember
1239 a file name or marks. Vim sets it when starting to edit a buffer.
1240 But not when moving to a buffer with ":buffer".
1241
1242 *'buftype'* *'bt'* *E382*
1243'buftype' 'bt' string (default: "")
1244 local to buffer
1245 {not in Vi}
1246 {not available when compiled without the |+quickfix|
1247 feature}
1248 The value of this option specifies the type of a buffer:
1249 <empty> normal buffer
1250 nofile buffer which is not related to a file and will not be
1251 written
1252 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001253 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001254 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001255 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001257 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 help help buffer (you are not supposed to set this
1259 manually)
1260
1261 This option is used together with 'bufhidden' and 'swapfile' to
1262 specify special kinds of buffers. See |special-buffers|.
1263
1264 Be careful with changing this option, it can have many side effects!
1265
Bram Moolenaar280f1262006-01-30 00:14:18 +00001266 A "quickfix" buffer is only used for the error list and the location
1267 list. This value is set by the |:cwindow| and |:lwindow| commands and
1268 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269
1270 "nofile" and "nowrite" buffers are similar:
1271 both: The buffer is not to be written to disk, ":w" doesn't
1272 work (":w filename" does work though).
1273 both: The buffer is never considered to be |'modified'|.
1274 There is no warning when the changes will be lost, for
1275 example when you quit Vim.
1276 both: A swap file is only created when using too much memory
1277 (when 'swapfile' has been reset there is never a swap
1278 file).
1279 nofile only: The buffer name is fixed, it is not handled like a
1280 file name. It is not modified in response to a |:cd|
1281 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001282 *E676*
1283 "acwrite" implies that the buffer name is not related to a file, like
1284 "nofile", but it will be written. Thus, in contrast to "nofile" and
1285 "nowrite", ":w" does work and a modified buffer can't be abandoned
1286 without saving. For writing there must be matching |BufWriteCmd|,
1287 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
1289 *'casemap'* *'cmp'*
1290'casemap' 'cmp' string (default: "internal,keepascii")
1291 global
1292 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001293 {only available when compiled with the |+multi_byte|
1294 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 Specifies details about changing the case of letters. It may contain
1296 these words, separated by a comma:
1297 internal Use internal case mapping functions, the current
1298 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001299 matters when 'encoding' is a Unicode encoding,
1300 "latin1" or "iso-8859-15". When "internal" is
1301 omitted, the towupper() and towlower() system library
1302 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1304 case mapping, the current locale is not effective.
1305 This probably only matters for Turkish.
1306
1307 *'cdpath'* *'cd'* *E344* *E346*
1308'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1309 global
1310 {not in Vi}
1311 {not available when compiled without the
1312 |+file_in_path| feature}
1313 This is a list of directories which will be searched when using the
1314 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001315 for has a relative path, not an absolute part starting with "/", "./"
1316 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 The 'cdpath' option's value has the same form and semantics as
1318 |'path'|. Also see |file-searching|.
1319 The default value is taken from $CDPATH, with a "," prepended to look
1320 in the current directory first.
1321 If the default value taken from $CDPATH is not what you want, include
1322 a modified version of the following command in your vimrc file to
1323 override it: >
1324 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1325< This option cannot be set from a |modeline| or in the |sandbox|, for
1326 security reasons.
1327 (parts of 'cdpath' can be passed to the shell to expand file names).
1328
1329 *'cedit'*
1330'cedit' string (Vi default: "", Vim default: CTRL-F)
1331 global
1332 {not in Vi}
1333 {not available when compiled without the |+vertsplit|
1334 feature}
1335 The key used in Command-line Mode to open the command-line window.
1336 The default is CTRL-F when 'compatible' is off.
1337 Only non-printable keys are allowed.
1338 The key can be specified as a single character, but it is difficult to
1339 type. The preferred way is to use the <> notation. Examples: >
1340 :set cedit=<C-Y>
1341 :set cedit=<Esc>
1342< |Nvi| also has this option, but it only uses the first character.
1343 See |cmdwin|.
1344
1345 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1346'charconvert' 'ccv' string (default "")
1347 global
1348 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001349 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 {not in Vi}
1351 An expression that is used for character encoding conversion. It is
1352 evaluated when a file that is to be read or has been written has a
1353 different encoding from what is desired.
1354 'charconvert' is not used when the internal iconv() function is
1355 supported and is able to do the conversion. Using iconv() is
1356 preferred, because it is much faster.
1357 'charconvert' is not used when reading stdin |--|, because there is no
1358 file to convert from. You will have to save the text in a file first.
1359 The expression must return zero or an empty string for success,
1360 non-zero for failure.
1361 The possible encoding names encountered are in 'encoding'.
1362 Additionally, names given in 'fileencodings' and 'fileencoding' are
1363 used.
1364 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1365 is done internally by Vim, 'charconvert' is not used for this.
1366 'charconvert' is also used to convert the viminfo file, if the 'c'
1367 flag is present in 'viminfo'. Also used for Unicode conversion.
1368 Example: >
1369 set charconvert=CharConvert()
1370 fun CharConvert()
1371 system("recode "
1372 \ . v:charconvert_from . ".." . v:charconvert_to
1373 \ . " <" . v:fname_in . " >" v:fname_out)
1374 return v:shell_error
1375 endfun
1376< The related Vim variables are:
1377 v:charconvert_from name of the current encoding
1378 v:charconvert_to name of the desired encoding
1379 v:fname_in name of the input file
1380 v:fname_out name of the output file
1381 Note that v:fname_in and v:fname_out will never be the same.
1382 Note that v:charconvert_from and v:charconvert_to may be different
1383 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1384 Encryption is not done by Vim when using 'charconvert'. If you want
1385 to encrypt the file after conversion, 'charconvert' should take care
1386 of this.
1387 This option cannot be set from a |modeline| or in the |sandbox|, for
1388 security reasons.
1389
1390 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1391'cindent' 'cin' boolean (default off)
1392 local to buffer
1393 {not in Vi}
1394 {not available when compiled without the |+cindent|
1395 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 that trigger reindenting in insert mode and 'cinoptions' to set your
1398 preferred indent style.
1399 If 'indentexpr' is not empty, it overrules 'cindent'.
1400 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1401 the "=" operator indents using this algorithm rather than calling an
1402 external program.
1403 See |C-indenting|.
1404 When you don't like the way 'cindent' works, try the 'smartindent'
1405 option or 'indentexpr'.
1406 This option is not used when 'paste' is set.
1407 NOTE: This option is reset when 'compatible' is set.
1408
1409 *'cinkeys'* *'cink'*
1410'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1411 local to buffer
1412 {not in Vi}
1413 {not available when compiled without the |+cindent|
1414 feature}
1415 A list of keys that, when typed in Insert mode, cause reindenting of
1416 the current line. Only used if 'cindent' is on and 'indentexpr' is
1417 empty.
1418 For the format of this option see |cinkeys-format|.
1419 See |C-indenting|.
1420
1421 *'cinoptions'* *'cino'*
1422'cinoptions' 'cino' string (default "")
1423 local to buffer
1424 {not in Vi}
1425 {not available when compiled without the |+cindent|
1426 feature}
1427 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1428 program. See |cinoptions-values| for the values of this option, and
1429 |C-indenting| for info on C indenting in general.
1430
1431
1432 *'cinwords'* *'cinw'*
1433'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1434 local to buffer
1435 {not in Vi}
1436 {not available when compiled without both the
1437 |+cindent| and the |+smartindent| features}
1438 These keywords start an extra indent in the next line when
1439 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1440 an appropriate place (inside {}).
1441 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1442 matter, include the keyword both the uppercase and lowercase:
1443 "if,If,IF".
1444
1445 *'clipboard'* *'cb'*
1446'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1447 for X-windows, "" otherwise)
1448 global
1449 {not in Vi}
1450 {only in GUI versions or when the |+xterm_clipboard|
1451 feature is included}
1452 This option is a list of comma separated names.
1453 These names are recognized:
1454
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001455 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 unnamed When included, Vim will use the clipboard register '*'
1457 for all yank, delete, change and put operations which
1458 would normally go to the unnamed register. When a
1459 register is explicitly specified, it will always be
1460 used regardless of whether "unnamed" is in 'clipboard'
1461 or not. The clipboard register can always be
1462 explicitly accessed using the "* notation. Also see
1463 |gui-clipboard|.
1464
Bram Moolenaar30b65812012-07-12 22:01:11 +02001465 *clipboard-unnamedplus*
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001466 unnamedplus A variant of "unnamed" flag which uses the clipboard
1467 register '+' (|quoteplus|) instead of register '*' for
1468 all operations except yank. Yank shall copy the text
1469 into register '+' and also into '*' when "unnamed" is
1470 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001471 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001472 Availability can be checked with: >
1473 if has('unnamedplus')
1474<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001475 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 autoselect Works like the 'a' flag in 'guioptions': If present,
1477 then whenever Visual mode is started, or the Visual
1478 area extended, Vim tries to become the owner of the
1479 windowing system's global selection or put the
1480 selected text on the clipboard used by the selection
1481 register "*. See |guioptions_a| and |quotestar| for
1482 details. When the GUI is active, the 'a' flag in
1483 'guioptions' is used, when the GUI is not active, this
1484 "autoselect" flag is used.
1485 Also applies to the modeless selection.
1486
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001487 *clipboard-autoselectplus*
1488 autoselectplus Like "autoselect" but using the + register instead of
1489 the * register. Compare to the 'P' flag in
1490 'guioptions'.
1491
1492 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 autoselectml Like "autoselect", but for the modeless selection
1494 only. Compare to the 'A' flag in 'guioptions'.
1495
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001496 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001497 html When the clipboard contains HTML, use this when
1498 pasting. When putting text on the clipboard, mark it
1499 as HTML. This works to copy rendered HTML from
1500 Firefox, paste it as raw HTML in Vim, select the HTML
1501 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001502 You probably want to add this only temporarily,
1503 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001504 Only supported for GTK version 2 and later.
1505 Only available with the |+multi_byte| feature.
1506
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001507 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 exclude:{pattern}
1509 Defines a pattern that is matched against the name of
1510 the terminal 'term'. If there is a match, no
1511 connection will be made to the X server. This is
1512 useful in this situation:
1513 - Running Vim in a console.
1514 - $DISPLAY is set to start applications on another
1515 display.
1516 - You do not want to connect to the X server in the
1517 console, but do want this in a terminal emulator.
1518 To never connect to the X server use: >
1519 exclude:.*
1520< This has the same effect as using the |-X| argument.
1521 Note that when there is no connection to the X server
1522 the window title won't be restored and the clipboard
1523 cannot be accessed.
1524 The value of 'magic' is ignored, {pattern} is
1525 interpreted as if 'magic' was on.
1526 The rest of the option value will be used for
1527 {pattern}, this must be the last entry.
1528
1529 *'cmdheight'* *'ch'*
1530'cmdheight' 'ch' number (default 1)
1531 global
1532 {not in Vi}
1533 Number of screen lines to use for the command-line. Helps avoiding
1534 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001535 The value of this option is stored with the tab page, so that each tab
1536 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537
1538 *'cmdwinheight'* *'cwh'*
1539'cmdwinheight' 'cwh' number (default 7)
1540 global
1541 {not in Vi}
1542 {not available when compiled without the |+vertsplit|
1543 feature}
1544 Number of screen lines to use for the command-line window. |cmdwin|
1545
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001546 *'colorcolumn'* *'cc'*
1547'colorcolumn' 'cc' string (default "")
1548 local to window
1549 {not in Vi}
1550 {not available when compiled without the |+syntax|
1551 feature}
1552 'colorcolumn' is a comma separated list of screen columns that are
1553 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1554 text. Will make screen redrawing slower.
1555 The screen column can be an absolute number, or a number preceded with
1556 '+' or '-', which is added to or subtracted from 'textwidth'. >
1557
1558 :set cc=+1 " highlight column after 'textwidth'
1559 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1560 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1561<
1562 When 'textwidth' is zero then the items with '-' and '+' are not used.
1563 A maximum of 256 columns are highlighted.
1564
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 *'columns'* *'co'* *E594*
1566'columns' 'co' number (default 80 or terminal width)
1567 global
1568 {not in Vi}
1569 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001570 initialization and does not have to be set by hand. Also see
1571 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 When Vim is running in the GUI or in a resizable window, setting this
1573 option will cause the window size to be changed. When you only want
1574 to use the size for the GUI, put the command in your |gvimrc| file.
1575 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001576 number of columns of the display, the display may be messed up. For
1577 the GUI it is always possible and Vim limits the number of columns to
1578 what fits on the screen. You can use this command to get the widest
1579 window possible: >
1580 :set columns=9999
1581< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582
1583 *'comments'* *'com'* *E524* *E525*
1584'comments' 'com' string (default
1585 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1586 local to buffer
1587 {not in Vi}
1588 {not available when compiled without the |+comments|
1589 feature}
1590 A comma separated list of strings that can start a comment line. See
1591 |format-comments|. See |option-backslash| about using backslashes to
1592 insert a space.
1593
1594 *'commentstring'* *'cms'* *E537*
1595'commentstring' 'cms' string (default "/*%s*/")
1596 local to buffer
1597 {not in Vi}
1598 {not available when compiled without the |+folding|
1599 feature}
1600 A template for a comment. The "%s" in the value is replaced with the
1601 comment text. Currently only used to add markers for folding, see
1602 |fold-marker|.
1603
1604 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001605'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1606 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001607 global
1608 {not in Vi}
1609 This option has the effect of making Vim either more Vi-compatible, or
1610 make Vim behave in a more useful way.
1611 This is a special kind of option, because when it's set or reset,
1612 other options are also changed as a side effect. CAREFUL: Setting or
1613 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001614 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 set this option in your vimrc file, you should probably put it at the
1616 very start.
1617 By default this option is on and the Vi defaults are used for the
1618 options. This default was chosen for those people who want to use Vim
1619 just like Vi, and don't even (want to) know about the 'compatible'
1620 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001621 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001622 this option is switched off, and all options that have not been
1623 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001624 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001625 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001626 happen for the system-wide vimrc or gvimrc file, nor for a file given
1627 with the |-u| argument). Also see |compatible-default| and
1628 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 You can also set this option with the "-C" argument, and reset it with
1630 "-N". See |-C| and |-N|.
1631 Switching this option off makes the Vim defaults be used for options
1632 that have a different Vi and Vim default value. See the options
1633 marked with a '+' below. Other options are not modified.
1634 At the moment this option is set, several other options will be set
1635 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001636 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 editing.
1638 See also 'cpoptions'.
1639
1640 option + set value effect ~
1641
1642 'allowrevins' off no CTRL-_ command
1643 'backupcopy' Unix: "yes" backup file is a copy
1644 others: "auto" copy or rename backup file
1645 'backspace' "" normal backspace
1646 'backup' off no backup file
1647 'cindent' off no C code indentation
1648 'cedit' + "" no key to open the |cmdwin|
1649 'cpoptions' + (all flags) Vi-compatible flags
1650 'cscopetag' off don't use cscope for ":tag"
1651 'cscopetagorder' 0 see |cscopetagorder|
1652 'cscopeverbose' off see |cscopeverbose|
1653 'digraph' off no digraphs
1654 'esckeys' + off no <Esc>-keys in Insert mode
1655 'expandtab' off tabs not expanded to spaces
1656 'fileformats' + "" no automatic file format detection,
1657 "dos,unix" except for DOS, Windows and OS/2
1658 'formatoptions' + "vt" Vi compatible formatting
1659 'gdefault' off no default 'g' flag for ":s"
1660 'history' + 0 no commandline history
1661 'hkmap' off no Hebrew keyboard mapping
1662 'hkmapp' off no phonetic Hebrew keyboard mapping
1663 'hlsearch' off no highlighting of search matches
1664 'incsearch' off no incremental searching
1665 'indentexpr' "" no indenting by expression
1666 'insertmode' off do not start in Insert mode
1667 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1668 characters and '_'
1669 'joinspaces' on insert 2 spaces after period
1670 'modeline' + off no modelines
1671 'more' + off no pauses in listings
1672 'revins' off no reverse insert
1673 'ruler' off no ruler
1674 'scrolljump' 1 no jump scroll
1675 'scrolloff' 0 no scroll offset
1676 'shiftround' off indent not rounded to shiftwidth
1677 'shortmess' + "" no shortening of messages
1678 'showcmd' + off command characters not shown
1679 'showmode' + off current mode not shown
1680 'smartcase' off no automatic ignore case switch
1681 'smartindent' off no smart indentation
1682 'smarttab' off no smart tab size
1683 'softtabstop' 0 tabs are always 'tabstop' positions
1684 'startofline' on goto startofline with some commands
1685 'tagrelative' + off tag file names are not relative
1686 'textauto' + off no automatic textmode detection
1687 'textwidth' 0 no automatic line wrap
1688 'tildeop' off tilde is not an operator
1689 'ttimeout' off no terminal timeout
1690 'whichwrap' + "" left-right movements don't wrap
1691 'wildchar' + CTRL-E only when the current value is <Tab>
1692 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001693 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694
1695 *'complete'* *'cpt'* *E535*
1696'complete' 'cpt' string (default: ".,w,b,u,t,i")
1697 local to buffer
1698 {not in Vi}
1699 This option specifies how keyword completion |ins-completion| works
1700 when CTRL-P or CTRL-N are used. It is also used for whole-line
1701 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1702 and the places to scan. It is a comma separated list of flags:
1703 . scan the current buffer ('wrapscan' is ignored)
1704 w scan buffers from other windows
1705 b scan other loaded buffers that are in the buffer list
1706 u scan the unloaded buffers that are in the buffer list
1707 U scan the buffers that are not in the buffer list
1708 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001709 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 k{dict} scan the file {dict}. Several "k" flags can be given,
1711 patterns are valid too. For example: >
1712 :set cpt=k/usr/dict/*,k~/spanish
1713< s scan the files given with the 'thesaurus' option
1714 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1715 are valid too.
1716 i scan current and included files
1717 d scan current and included files for defined name or macro
1718 |i_CTRL-X_CTRL-D|
1719 ] tag completion
1720 t same as "]"
1721
1722 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1723 not executed, this may lead to unexpected completions from some files
1724 (gzipped files for example). Unloaded buffers are not scanned for
1725 whole-line completion.
1726
1727 The default is ".,w,b,u,t,i", which means to scan:
1728 1. the current buffer
1729 2. buffers in other windows
1730 3. other loaded buffers
1731 4. unloaded buffers
1732 5. tags
1733 6. included files
1734
1735 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001736 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1737 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001739 *'completefunc'* *'cfu'*
1740'completefunc' 'cfu' string (default: empty)
1741 local to buffer
1742 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001743 {not available when compiled without the |+eval|
1744 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001745 This option specifies a function to be used for Insert mode completion
1746 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001747 See |complete-functions| for an explanation of how the function is
1748 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001749 This option cannot be set from a |modeline| or in the |sandbox|, for
1750 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001751
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001752 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001753'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001754 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001755 {not available when compiled without the
1756 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001757 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001758 A comma separated list of options for Insert mode completion
1759 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001760
1761 menu Use a popup menu to show the possible completions. The
1762 menu is only shown when there is more than one match and
1763 sufficient colors are available. |ins-completion-menu|
1764
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001765 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001766 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001767 match, e.g., what file it comes from.
1768
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001769 longest Only insert the longest common text of the matches. If
1770 the menu is displayed you can use CTRL-L to add more
1771 characters. Whether case is ignored depends on the kind
1772 of completion. For buffer text the 'ignorecase' option is
1773 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001774
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001775 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001776 completion in the preview window. Only works in
1777 combination with "menu" or "menuone".
1778
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001779
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001780 *'concealcursor'* *'cocu'*
1781'concealcursor' 'cocu' string (default: "")
1782 local to window
1783 {not in Vi}
1784 {not available when compiled without the |+conceal|
1785 feature}
1786 Sets the modes in which text in the cursor line can also be concealed.
1787 When the current mode is listed then concealing happens just like in
1788 other lines.
1789 n Normal mode
1790 v Visual mode
1791 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001792 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001793
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001794 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001795 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001796 are moving around text is concealed, but when starting to insert text
1797 or selecting a Visual area the concealed text is displayed, so that
1798 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001799 Keep in mind that the cursor position is not always where it's
1800 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001801
1802
1803'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001804 number (default 0)
1805 local to window
1806 {not in Vi}
1807 {not available when compiled without the |+conceal|
1808 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001809 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1810 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001811
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001812 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001813 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001814 1 Each block of concealed text is replaced with one
1815 character. If the syntax item does not have a custom
1816 replacement character defined (see |:syn-cchar|) the
1817 character defined in 'listchars' is used (default is a
1818 space).
1819 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001820 2 Concealed text is completely hidden unless it has a
1821 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001822 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001823 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001824
Bram Moolenaara7781e02010-07-19 20:13:22 +02001825 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001826 edit and copy the text. This can be changed with the 'concealcursor'
1827 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001828
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1830'confirm' 'cf' boolean (default off)
1831 global
1832 {not in Vi}
1833 When 'confirm' is on, certain operations that would normally
1834 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1835 instead raise a |dialog| asking if you wish to save the current
1836 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1837 If 'confirm' is off you can still activate confirmation for one
1838 command only (this is most useful in mappings) with the |:confirm|
1839 command.
1840 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1841
1842 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1843'conskey' 'consk' boolean (default off)
1844 global
1845 {not in Vi} {only for MS-DOS}
1846 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001847 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 three methods of console input are available:
1849 'conskey' 'bioskey' action ~
1850 on on or off direct console input
1851 off on BIOS
1852 off off STDIN
1853
1854 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1855'copyindent' 'ci' boolean (default off)
1856 local to buffer
1857 {not in Vi}
1858 Copy the structure of the existing lines indent when autoindenting a
1859 new line. Normally the new indent is reconstructed by a series of
1860 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1861 in which case only spaces are used). Enabling this option makes the
1862 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001863 existing line. 'expandtab' has no effect on these characters, a Tab
1864 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 line, the remaining space is filled in the normal manner.
1866 NOTE: 'copyindent' is reset when 'compatible' is set.
1867 Also see 'preserveindent'.
1868
1869 *'cpoptions'* *'cpo'*
1870'cpoptions' 'cpo' string (Vim default: "aABceFs",
1871 Vi default: all flags)
1872 global
1873 {not in Vi}
1874 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001875 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 not being vi-compatible is mostly or sometimes preferred.
1877 'cpoptions' stands for "compatible-options".
1878 Commas can be added for readability.
1879 To avoid problems with flags that are added in the future, use the
1880 "+=" and "-=" feature of ":set" |add-option-flags|.
1881 NOTE: This option is set to the Vi default value when 'compatible' is
1882 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001883 NOTE: This option is set to the POSIX default value at startup when
1884 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001885 variable exists |posix|. This means Vim tries to behave like the
1886 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001887
1888 contains behavior ~
1889 *cpo-a*
1890 a When included, a ":read" command with a file name
1891 argument will set the alternate file name for the
1892 current window.
1893 *cpo-A*
1894 A When included, a ":write" command with a file name
1895 argument will set the alternate file name for the
1896 current window.
1897 *cpo-b*
1898 b "\|" in a ":map" command is recognized as the end of
1899 the map command. The '\' is included in the mapping,
1900 the text after the '|' is interpreted as the next
1901 command. Use a CTRL-V instead of a backslash to
1902 include the '|' in the mapping. Applies to all
1903 mapping, abbreviation, menu and autocmd commands.
1904 See also |map_bar|.
1905 *cpo-B*
1906 B A backslash has no special meaning in mappings,
1907 abbreviations and the "to" part of the menu commands.
1908 Remove this flag to be able to use a backslash like a
1909 CTRL-V. For example, the command ":map X \<Esc>"
1910 results in X being mapped to:
1911 'B' included: "\^[" (^[ is a real <Esc>)
1912 'B' excluded: "<Esc>" (5 characters)
1913 ('<' excluded in both cases)
1914 *cpo-c*
1915 c Searching continues at the end of any match at the
1916 cursor position, but not further than the start of the
1917 next line. When not present searching continues
1918 one character from the cursor position. With 'c'
1919 "abababababab" only gets three matches when repeating
1920 "/abab", without 'c' there are five matches.
1921 *cpo-C*
1922 C Do not concatenate sourced lines that start with a
1923 backslash. See |line-continuation|.
1924 *cpo-d*
1925 d Using "./" in the 'tags' option doesn't mean to use
1926 the tags file relative to the current file, but the
1927 tags file in the current directory.
1928 *cpo-D*
1929 D Can't use CTRL-K to enter a digraph after Normal mode
1930 commands with a character argument, like |r|, |f| and
1931 |t|.
1932 *cpo-e*
1933 e When executing a register with ":@r", always add a
1934 <CR> to the last line, also when the register is not
1935 linewise. If this flag is not present, the register
1936 is not linewise and the last line does not end in a
1937 <CR>, then the last line is put on the command-line
1938 and can be edited before hitting <CR>.
1939 *cpo-E*
1940 E It is an error when using "y", "d", "c", "g~", "gu" or
1941 "gU" on an Empty region. The operators only work when
1942 at least one character is to be operate on. Example:
1943 This makes "y0" fail in the first column.
1944 *cpo-f*
1945 f When included, a ":read" command with a file name
1946 argument will set the file name for the current buffer,
1947 if the current buffer doesn't have a file name yet.
1948 *cpo-F*
1949 F When included, a ":write" command with a file name
1950 argument will set the file name for the current
1951 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001952 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 *cpo-g*
1954 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001955 *cpo-H*
1956 H When using "I" on a line with only blanks, insert
1957 before the last blank. Without this flag insert after
1958 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001959 *cpo-i*
1960 i When included, interrupting the reading of a file will
1961 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001962 *cpo-I*
1963 I When moving the cursor up or down just after inserting
1964 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 *cpo-j*
1966 j When joining lines, only add two spaces after a '.',
1967 not after '!' or '?'. Also see 'joinspaces'.
1968 *cpo-J*
1969 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001970 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 white space.
1972 *cpo-k*
1973 k Disable the recognition of raw key codes in
1974 mappings, abbreviations, and the "to" part of menu
1975 commands. For example, if <Key> sends ^[OA (where ^[
1976 is <Esc>), the command ":map X ^[OA" results in X
1977 being mapped to:
1978 'k' included: "^[OA" (3 characters)
1979 'k' excluded: "<Key>" (one key code)
1980 Also see the '<' flag below.
1981 *cpo-K*
1982 K Don't wait for a key code to complete when it is
1983 halfway a mapping. This breaks mapping <F1><F1> when
1984 only part of the second <F1> has been read. It
1985 enables cancelling the mapping by typing <F1><Esc>.
1986 *cpo-l*
1987 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001988 literally, only "\]", "\^", "\-" and "\\" are special.
1989 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001990 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1991 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001992 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 *cpo-L*
1994 L When the 'list' option is set, 'wrapmargin',
1995 'textwidth', 'softtabstop' and Virtual Replace mode
1996 (see |gR|) count a <Tab> as two characters, instead of
1997 the normal behavior of a <Tab>.
1998 *cpo-m*
1999 m When included, a showmatch will always wait half a
2000 second. When not included, a showmatch will wait half
2001 a second or until a character is typed. |'showmatch'|
2002 *cpo-M*
2003 M When excluded, "%" matching will take backslashes into
2004 account. Thus in "( \( )" and "\( ( \)" the outer
2005 parenthesis match. When included "%" ignores
2006 backslashes, which is Vi compatible.
2007 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002008 n When included, the column used for 'number' and
2009 'relativenumber' will also be used for text of wrapped
2010 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 *cpo-o*
2012 o Line offset to search command is not remembered for
2013 next search.
2014 *cpo-O*
2015 O Don't complain if a file is being overwritten, even
2016 when it didn't exist when editing it. This is a
2017 protection against a file unexpectedly created by
2018 someone else. Vi didn't complain about this.
2019 *cpo-p*
2020 p Vi compatible Lisp indenting. When not present, a
2021 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002022 *cpo-P*
2023 P When included, a ":write" command that appends to a
2024 file will set the file name for the current buffer, if
2025 the current buffer doesn't have a file name yet and
2026 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002027 *cpo-q*
2028 q When joining multiple lines leave the cursor at the
2029 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030 *cpo-r*
2031 r Redo ("." command) uses "/" to repeat a search
2032 command, instead of the actually used search string.
2033 *cpo-R*
2034 R Remove marks from filtered lines. Without this flag
2035 marks are kept like |:keepmarks| was used.
2036 *cpo-s*
2037 s Set buffer options when entering the buffer for the
2038 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002039 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 set when the buffer is created.
2041 *cpo-S*
2042 S Set buffer options always when entering a buffer
2043 (except 'readonly', 'fileformat', 'filetype' and
2044 'syntax'). This is the (most) Vi compatible setting.
2045 The options are set to the values in the current
2046 buffer. When you change an option and go to another
2047 buffer, the value is copied. Effectively makes the
2048 buffer options global to all buffers.
2049
2050 's' 'S' copy buffer options
2051 no no when buffer created
2052 yes no when buffer first entered (default)
2053 X yes each time when buffer entered (vi comp.)
2054 *cpo-t*
2055 t Search pattern for the tag command is remembered for
2056 "n" command. Otherwise Vim only puts the pattern in
2057 the history for search pattern, but doesn't change the
2058 last used search pattern.
2059 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002060 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 *cpo-v*
2062 v Backspaced characters remain visible on the screen in
2063 Insert mode. Without this flag the characters are
2064 erased from the screen right away. With this flag the
2065 screen newly typed text overwrites backspaced
2066 characters.
2067 *cpo-w*
2068 w When using "cw" on a blank character, only change one
2069 character and not all blanks until the start of the
2070 next word.
2071 *cpo-W*
2072 W Don't overwrite a readonly file. When omitted, ":w!"
2073 overwrites a readonly file, if possible.
2074 *cpo-x*
2075 x <Esc> on the command-line executes the command-line.
2076 The default in Vim is to abandon the command-line,
2077 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002078 *cpo-X*
2079 X When using a count with "R" the replaced text is
2080 deleted only once. Also when repeating "R" with "."
2081 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 *cpo-y*
2083 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002084 *cpo-Z*
2085 Z When using "w!" while the 'readonly' option is set,
2086 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 *cpo-!*
2088 ! When redoing a filter command, use the last used
2089 external command, whatever it was. Otherwise the last
2090 used -filter- command is used.
2091 *cpo-$*
2092 $ When making a change to one line, don't redisplay the
2093 line, but put a '$' at the end of the changed text.
2094 The changed text will be overwritten when you type the
2095 new text. The line is redisplayed if you type any
2096 command that moves the cursor from the insertion
2097 point.
2098 *cpo-%*
2099 % Vi-compatible matching is done for the "%" command.
2100 Does not recognize "#if", "#endif", etc.
2101 Does not recognize "/*" and "*/".
2102 Parens inside single and double quotes are also
2103 counted, causing a string that contains a paren to
2104 disturb the matching. For example, in a line like
2105 "if (strcmp("foo(", s))" the first paren does not
2106 match the last one. When this flag is not included,
2107 parens inside single and double quotes are treated
2108 specially. When matching a paren outside of quotes,
2109 everything inside quotes is ignored. When matching a
2110 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002111 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002112 This flag is also used for other features, such as
2113 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002114 *cpo--*
2115 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002116 it would go above the first line or below the last
2117 line. Without it the cursor moves to the first or
2118 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002119 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002120 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002121 *cpo-+*
2122 + When included, a ":write file" command will reset the
2123 'modified' flag of the buffer, even though the buffer
2124 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002125 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 * Use ":*" in the same way as ":@". When not included,
2127 ":*" is an alias for ":'<,'>", select the Visual area.
2128 *cpo-<*
2129 < Disable the recognition of special key codes in |<>|
2130 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002131 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 ":map X <Tab>" results in X being mapped to:
2133 '<' included: "<Tab>" (5 characters)
2134 '<' excluded: "^I" (^I is a real <Tab>)
2135 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002136 *cpo->*
2137 > When appending to a register, put a line break before
2138 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002139 *cpo-;*
2140 ; When using |,| or |;| to repeat the last |t| search
2141 and the cursor is right in front of the searched
2142 character, the cursor won't move. When not included,
2143 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002144 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002145
2146 POSIX flags. These are not included in the Vi default value, except
2147 when $VIM_POSIX was set on startup. |posix|
2148
2149 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002150 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002151 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002152 *cpo-&*
2153 & When ":preserve" was used keep the swap file when
2154 exiting normally while this buffer is still loaded.
2155 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002156 *cpo-\*
2157 \ Backslash in a [] range in a search pattern is taken
2158 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002159 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2160 '\' excluded: "/[ \-]" finds <Space> and '-'
2161 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002162 *cpo-/*
2163 / When "%" is used as the replacement string in a |:s|
2164 command, use the previous replacement string. |:s%|
2165 *cpo-{*
2166 { The |{| and |}| commands also stop at a "{" character
2167 at the start of a line.
2168 *cpo-.*
2169 . The ":chdir" and ":cd" commands fail if the current
2170 buffer is modified, unless ! is used. Vim doesn't
2171 need this, since it remembers the full path of an
2172 opened file.
2173 *cpo-bar*
2174 | The value of the $LINES and $COLUMNS environment
2175 variables overrule the terminal size values obtained
2176 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002177
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002179 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002180'cryptmethod' string (default "zip")
2181 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002182 {not in Vi}
2183 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002184 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002185 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002186 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002187 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002188 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002189 or later, files can NOT be read by Vim 7.2 and older.
2190 This adds a "seed" to the file, every time you write
2191 the file the encrypted bytes will be different.
2192
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002193 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002194 to the detected method of the file being read. Thus if you write it
2195 without changing 'cryptmethod' the same method will be used.
2196 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002197 explicitly write it, you don't get a warning unless there are other
2198 modifications. Also see |:X|.
2199
2200 When setting the global value to an empty string, it will end up with
2201 the value "zip". When setting the local value to an empty string the
2202 buffer will use the global value.
2203
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002204 When a new encryption method is added in a later version of Vim, and
2205 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002206 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002207
2208
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 *'cscopepathcomp'* *'cspc'*
2210'cscopepathcomp' 'cspc' number (default 0)
2211 global
2212 {not available when compiled without the |+cscope|
2213 feature}
2214 {not in Vi}
2215 Determines how many components of the path to show in a list of tags.
2216 See |cscopepathcomp|.
2217
2218 *'cscopeprg'* *'csprg'*
2219'cscopeprg' 'csprg' string (default "cscope")
2220 global
2221 {not available when compiled without the |+cscope|
2222 feature}
2223 {not in Vi}
2224 Specifies the command to execute cscope. See |cscopeprg|.
2225 This option cannot be set from a |modeline| or in the |sandbox|, for
2226 security reasons.
2227
2228 *'cscopequickfix'* *'csqf'*
2229'cscopequickfix' 'csqf' string (default "")
2230 global
2231 {not available when compiled without the |+cscope|
2232 or |+quickfix| features}
2233 {not in Vi}
2234 Specifies whether to use quickfix window to show cscope results.
2235 See |cscopequickfix|.
2236
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002237 *'cscoperelative'* *'csre'*
2238'cscoperelative' 'csre' boolean (default off)
2239 global
2240 {not available when compiled without the |+cscope|
2241 feature}
2242 {not in Vi}
2243 In the absence of a prefix (-P) for cscope. setting this option enables
2244 to use the basename of cscope.out path as the prefix.
2245 See |cscoperelative|.
2246
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2248'cscopetag' 'cst' boolean (default off)
2249 global
2250 {not available when compiled without the |+cscope|
2251 feature}
2252 {not in Vi}
2253 Use cscope for tag commands. See |cscope-options|.
2254 NOTE: This option is reset when 'compatible' is set.
2255
2256 *'cscopetagorder'* *'csto'*
2257'cscopetagorder' 'csto' number (default 0)
2258 global
2259 {not available when compiled without the |+cscope|
2260 feature}
2261 {not in Vi}
2262 Determines the order in which ":cstag" performs a search. See
2263 |cscopetagorder|.
2264 NOTE: This option is set to 0 when 'compatible' is set.
2265
2266 *'cscopeverbose'* *'csverb'*
2267 *'nocscopeverbose'* *'nocsverb'*
2268'cscopeverbose' 'csverb' boolean (default off)
2269 global
2270 {not available when compiled without the |+cscope|
2271 feature}
2272 {not in Vi}
2273 Give messages when adding a cscope database. See |cscopeverbose|.
2274 NOTE: This option is reset when 'compatible' is set.
2275
Bram Moolenaar860cae12010-06-05 23:22:07 +02002276 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2277'cursorbind' 'crb' boolean (default off)
2278 local to window
2279 {not in Vi}
2280 {not available when compiled without the |+cursorbind|
2281 feature}
2282 When this option is set, as the cursor in the current
2283 window moves other cursorbound windows (windows that also have
2284 this option set) move their cursors to the corresponding line and
2285 column. This option is useful for viewing the
2286 differences between two versions of a file (see 'diff'); in diff mode,
2287 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002288 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002289
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002290
2291 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2292'cursorcolumn' 'cuc' boolean (default off)
2293 local to window
2294 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002295 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002296 feature}
2297 Highlight the screen column of the cursor with CursorColumn
2298 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2299 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002300 If you only want the highlighting in the current window you can use
2301 these autocommands: >
2302 au WinLeave * set nocursorline nocursorcolumn
2303 au WinEnter * set cursorline cursorcolumn
2304<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002305
2306 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2307'cursorline' 'cul' boolean (default off)
2308 local to window
2309 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002310 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002311 feature}
2312 Highlight the screen line of the cursor with CursorLine
2313 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2314 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002315 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002316 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002317
2318
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 *'debug'*
2320'debug' string (default "")
2321 global
2322 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002323 These values can be used:
2324 msg Error messages that would otherwise be omitted will be given
2325 anyway.
2326 throw Error messages that would otherwise be omitted will be given
2327 anyway and also throw an exception and set |v:errmsg|.
2328 beep A message will be given when otherwise only a beep would be
2329 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002330 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002331 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2332 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333
2334 *'define'* *'def'*
2335'define' 'def' string (default "^\s*#\s*define")
2336 global or local to buffer |global-local|
2337 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002338 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339 pattern, just like for the "/" command. This option is used for the
2340 commands like "[i" and "[d" |include-search|. The 'isident' option is
2341 used to recognize the defined name after the match:
2342 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2343 See |option-backslash| about inserting backslashes to include a space
2344 or backslash.
2345 The default value is for C programs. For C++ this value would be
2346 useful, to include const type declarations: >
2347 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2348< When using the ":set" command, you need to double the backslashes!
2349
2350 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2351'delcombine' 'deco' boolean (default off)
2352 global
2353 {not in Vi}
2354 {only available when compiled with the |+multi_byte|
2355 feature}
2356 If editing Unicode and this option is set, backspace and Normal mode
2357 "x" delete each combining character on its own. When it is off (the
2358 default) the character along with its combining characters are
2359 deleted.
2360 Note: When 'delcombine' is set "xx" may work different from "2x"!
2361
2362 This is useful for Arabic, Hebrew and many other languages where one
2363 may have combining characters overtop of base characters, and want
2364 to remove only the combining ones.
2365
2366 *'dictionary'* *'dict'*
2367'dictionary' 'dict' string (default "")
2368 global or local to buffer |global-local|
2369 {not in Vi}
2370 List of file names, separated by commas, that are used to lookup words
2371 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2372 contain a list of words. This can be one word per line, or several
2373 words per line, separated by non-keyword characters (white space is
2374 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002375 When this option is empty, or an entry "spell" is present, spell
2376 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002377 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 after a comma are ignored, otherwise spaces are included in the file
2379 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002380 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 Where to find a list of words?
2382 - On FreeBSD, there is the file "/usr/share/dict/words".
2383 - In the Simtel archive, look in the "msdos/linguist" directory.
2384 - In "miscfiles" of the GNU collection.
2385 The use of |:set+=| and |:set-=| is preferred when adding or removing
2386 directories from the list. This avoids problems when a future version
2387 uses another default.
2388 Backticks cannot be used in this option for security reasons.
2389
2390 *'diff'* *'nodiff'*
2391'diff' boolean (default off)
2392 local to window
2393 {not in Vi}
2394 {not available when compiled without the |+diff|
2395 feature}
2396 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002397 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002398
2399 *'dex'* *'diffexpr'*
2400'diffexpr' 'dex' string (default "")
2401 global
2402 {not in Vi}
2403 {not available when compiled without the |+diff|
2404 feature}
2405 Expression which is evaluated to obtain an ed-style diff file from two
2406 versions of a file. See |diff-diffexpr|.
2407 This option cannot be set from a |modeline| or in the |sandbox|, for
2408 security reasons.
2409
2410 *'dip'* *'diffopt'*
2411'diffopt' 'dip' string (default "filler")
2412 global
2413 {not in Vi}
2414 {not available when compiled without the |+diff|
2415 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002416 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 All are optional. Items must be separated by a comma.
2418
2419 filler Show filler lines, to keep the text
2420 synchronized with a window that has inserted
2421 lines at the same position. Mostly useful
2422 when windows are side-by-side and 'scrollbind'
2423 is set.
2424
2425 context:{n} Use a context of {n} lines between a change
2426 and a fold that contains unchanged lines.
2427 When omitted a context of six lines is used.
2428 See |fold-diff|.
2429
2430 icase Ignore changes in case of text. "a" and "A"
2431 are considered the same. Adds the "-i" flag
2432 to the "diff" command if 'diffexpr' is empty.
2433
2434 iwhite Ignore changes in amount of white space. Adds
2435 the "-b" flag to the "diff" command if
2436 'diffexpr' is empty. Check the documentation
2437 of the "diff" command for what this does
2438 exactly. It should ignore adding trailing
2439 white space, but not leading white space.
2440
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002441 horizontal Start diff mode with horizontal splits (unless
2442 explicitly specified otherwise).
2443
2444 vertical Start diff mode with vertical splits (unless
2445 explicitly specified otherwise).
2446
2447 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2448 starting diff mode. Without this 2 is used.
2449
Bram Moolenaar071d4272004-06-13 20:20:40 +00002450 Examples: >
2451
2452 :set diffopt=filler,context:4
2453 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002454 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455<
2456 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2457'digraph' 'dg' boolean (default off)
2458 global
2459 {not in Vi}
2460 {not available when compiled without the |+digraphs|
2461 feature}
2462 Enable the entering of digraphs in Insert mode with {char1} <BS>
2463 {char2}. See |digraphs|.
2464 NOTE: This option is reset when 'compatible' is set.
2465
2466 *'directory'* *'dir'*
2467'directory' 'dir' string (default for Amiga: ".,t:",
2468 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2469 for Unix: ".,~/tmp,/var/tmp,/tmp")
2470 global
2471 List of directory names for the swap file, separated with commas.
2472 - The swap file will be created in the first directory where this is
2473 possible.
2474 - Empty means that no swap file will be used (recovery is
2475 impossible!).
2476 - A directory "." means to put the swap file in the same directory as
2477 the edited file. On Unix, a dot is prepended to the file name, so
2478 it doesn't show in a directory listing. On MS-Windows the "hidden"
2479 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002480 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 put the swap file relative to where the edited file is. The leading
2482 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002483 - For Unix and Win32, if a directory ends in two path separators "//"
2484 or "\\", the swap file name will be built from the complete path to
2485 the file with all path separators substituted to percent '%' signs.
2486 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002487 On Win32, when a separating comma is following, you must use "//",
2488 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489 - Spaces after the comma are ignored, other spaces are considered part
2490 of the directory name. To have a space at the start of a directory
2491 name, precede it with a backslash.
2492 - To include a comma in a directory name precede it with a backslash.
2493 - A directory name may end in an ':' or '/'.
2494 - Environment variables are expanded |:set_env|.
2495 - Careful with '\' characters, type one before a space, type two to
2496 get one in the option (see |option-backslash|), for example: >
2497 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2498< - For backwards compatibility with Vim version 3.0 a '>' at the start
2499 of the option is removed.
2500 Using "." first in the list is recommended. This means that editing
2501 the same file twice will result in a warning. Using "/tmp" on Unix is
2502 discouraged: When the system crashes you lose the swap file.
2503 "/var/tmp" is often not cleared when rebooting, thus is a better
2504 choice than "/tmp". But it can contain a lot of files, your swap
2505 files get lost in the crowd. That is why a "tmp" directory in your
2506 home directory is tried first.
2507 The use of |:set+=| and |:set-=| is preferred when adding or removing
2508 directories from the list. This avoids problems when a future version
2509 uses another default.
2510 This option cannot be set from a |modeline| or in the |sandbox|, for
2511 security reasons.
2512 {Vi: directory to put temp file in, defaults to "/tmp"}
2513
2514 *'display'* *'dy'*
2515'display' 'dy' string (default "")
2516 global
2517 {not in Vi}
2518 Change the way text is displayed. This is comma separated list of
2519 flags:
2520 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002521 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522 last line that doesn't fit is replaced with "@" lines.
2523 uhex Show unprintable characters hexadecimal as <xx>
2524 instead of using ^C and ~C.
2525
2526 *'eadirection'* *'ead'*
2527'eadirection' 'ead' string (default "both")
2528 global
2529 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002530 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 feature}
2532 Tells when the 'equalalways' option applies:
2533 ver vertically, width of windows is not affected
2534 hor horizontally, height of windows is not affected
2535 both width and height of windows is affected
2536
2537 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2538'edcompatible' 'ed' boolean (default off)
2539 global
2540 Makes the 'g' and 'c' flags of the ":substitute" command to be
2541 toggled each time the flag is given. See |complex-change|. See
2542 also 'gdefault' option.
2543 Switching this option on is discouraged!
2544
2545 *'encoding'* *'enc'* *E543*
2546'encoding' 'enc' string (default: "latin1" or value from $LANG)
2547 global
2548 {only available when compiled with the |+multi_byte|
2549 feature}
2550 {not in Vi}
2551 Sets the character encoding used inside Vim. It applies to text in
2552 the buffers, registers, Strings in expressions, text stored in the
2553 viminfo file, etc. It sets the kind of characters which Vim can work
2554 with. See |encoding-names| for the possible values.
2555
2556 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002557 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002559 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
Bram Moolenaar865242e2010-07-14 21:12:05 +02002561 This option cannot be set from a |modeline|. It would most likely
2562 corrupt the text.
2563
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2565 "utf-8". Although care has been taken to allow different values of
2566 'encoding', "utf-8" is the natural choice for the environment and
2567 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 versions, and to avoid changing the encoding of newly created files
2570 without your knowledge (in case 'fileencodings' is empty).
2571
2572 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002573 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 iconv() or as specified with 'charconvert'.
2575
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002576 If you need to know whether 'encoding' is a multi-byte encoding, you
2577 can use: >
2578 if has("multi_byte_encoding")
2579<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 Normally 'encoding' will be equal to your current locale. This will
2581 be the default if Vim recognizes your environment settings. If
2582 'encoding' is not set to the current locale, 'termencoding' must be
2583 set to convert typed and displayed text. See |encoding-table|.
2584
2585 When you set this option, it fires the |EncodingChanged| autocommand
2586 event so that you can set up fonts if necessary.
2587
2588 When the option is set, the value is converted to lowercase. Thus
2589 you can set it with uppercase values too. Underscores are translated
2590 to '-' signs.
2591 When the encoding is recognized, it is changed to the standard name.
2592 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2593 "iso-8859-2" and "utf8" becomes "utf-8".
2594
2595 Note: "latin1" is also used when the encoding could not be detected.
2596 This only works when editing files in the same encoding! When the
2597 actual character set is not latin1, make sure 'fileencoding' and
2598 'fileencodings' are empty. When conversion is needed, switch to using
2599 utf-8.
2600
2601 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2602 You don't notice this while editing, but it does matter for the
2603 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2604 setting 'encoding' to one of these values instead of utf-8 only has
2605 effect for encoding used for files when 'fileencoding' is empty.
2606
Bram Moolenaar661b1822005-07-28 22:36:45 +00002607 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2608 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609
2610 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2611'endofline' 'eol' boolean (default on)
2612 local to buffer
2613 {not in Vi}
2614 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002615 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616 option is automatically set when starting to edit a new file, unless
2617 the file does not have an <EOL> for the last line in the file, in
2618 which case it is reset. Normally you don't have to set or reset this
2619 option. When 'binary' is off the value is not used when writing the
2620 file. When 'binary' is on it is used to remember the presence of a
2621 <EOL> for the last line in the file, so that when you write the file
2622 the situation from the original file can be kept. But you can change
2623 it if you want to.
2624
2625 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2626'equalalways' 'ea' boolean (default on)
2627 global
2628 {not in Vi}
2629 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002630 splitting or closing a window. This also happens the moment the
2631 option is switched on. When off, splitting a window will reduce the
2632 size of the current window and leave the other windows the same. When
2633 closing a window the extra lines are given to the window next to it
2634 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 When mixing vertically and horizontally split windows, a minimal size
2636 is computed and some windows may be larger if there is room. The
2637 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002638 Changing the height and width of a window can be avoided by setting
2639 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002640 If a window size is specified when creating a new window sizes are
2641 currently not equalized (it's complicated, but may be implemented in
2642 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643
2644 *'equalprg'* *'ep'*
2645'equalprg' 'ep' string (default "")
2646 global or local to buffer |global-local|
2647 {not in Vi}
2648 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002649 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002650 or 'indentexpr'. When Vim was compiled without internal formatting,
2651 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002652 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 about including spaces and backslashes.
2654 This option cannot be set from a |modeline| or in the |sandbox|, for
2655 security reasons.
2656
2657 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2658'errorbells' 'eb' boolean (default off)
2659 global
2660 Ring the bell (beep or screen flash) for error messages. This only
2661 makes a difference for error messages, the bell will be used always
2662 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002663 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664 screen flash or do nothing.
2665
2666 *'errorfile'* *'ef'*
2667'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2668 others: "errors.err")
2669 global
2670 {not in Vi}
2671 {not available when compiled without the |+quickfix|
2672 feature}
2673 Name of the errorfile for the QuickFix mode (see |:cf|).
2674 When the "-q" command-line argument is used, 'errorfile' is set to the
2675 following argument. See |-q|.
2676 NOT used for the ":make" command. See 'makeef' for that.
2677 Environment variables are expanded |:set_env|.
2678 See |option-backslash| about including spaces and backslashes.
2679 This option cannot be set from a |modeline| or in the |sandbox|, for
2680 security reasons.
2681
2682 *'errorformat'* *'efm'*
2683'errorformat' 'efm' string (default is very long)
2684 global or local to buffer |global-local|
2685 {not in Vi}
2686 {not available when compiled without the |+quickfix|
2687 feature}
2688 Scanf-like description of the format for the lines in the error file
2689 (see |errorformat|).
2690
2691 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2692'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2693 global
2694 {not in Vi}
2695 Function keys that start with an <Esc> are recognized in Insert
2696 mode. When this option is off, the cursor and function keys cannot be
2697 used in Insert mode if they start with an <Esc>. The advantage of
2698 this is that the single <Esc> is recognized immediately, instead of
2699 after one second. Instead of resetting this option, you might want to
2700 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2701 when 'esckeys' is off, you can still map anything, but the cursor keys
2702 won't work by default.
2703 NOTE: This option is set to the Vi default value when 'compatible' is
2704 set and to the Vim default value when 'compatible' is reset.
2705
2706 *'eventignore'* *'ei'*
2707'eventignore' 'ei' string (default "")
2708 global
2709 {not in Vi}
2710 {not available when compiled without the |+autocmd|
2711 feature}
2712 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002713 When set to "all" or when "all" is one of the items, all autocommand
2714 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 Otherwise this is a comma separated list of event names. Example: >
2716 :set ei=WinEnter,WinLeave
2717<
2718 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2719'expandtab' 'et' boolean (default off)
2720 local to buffer
2721 {not in Vi}
2722 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002723 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2725 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2726 NOTE: This option is reset when 'compatible' is set.
2727
2728 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2729'exrc' 'ex' boolean (default off)
2730 global
2731 {not in Vi}
2732 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2733 directory. If you switch this option on you should also consider
2734 setting the 'secure' option (see |initialization|). Using a local
2735 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2736 also see |.vimrc| and |gui-init|.
2737 This option cannot be set from a |modeline| or in the |sandbox|, for
2738 security reasons.
2739
2740 *'fileencoding'* *'fenc'* *E213*
2741'fileencoding' 'fenc' string (default: "")
2742 local to buffer
2743 {only available when compiled with the |+multi_byte|
2744 feature}
2745 {not in Vi}
2746 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002747
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002749 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 When 'fileencoding' is empty, the same value as 'encoding' will be
2751 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002752 Conversion will also be done when 'encoding' and 'fileencoding' are
2753 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2754 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002756 'encoding' is "utf-8" or another Unicode encoding, conversion
2757 is most likely done in a way that the reverse conversion
2758 results in the same text. When 'encoding' is not "utf-8" some
2759 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002760
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 See 'encoding' for the possible values. Additionally, values may be
2762 specified that can be handled by the converter, see
2763 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002764
Bram Moolenaar071d4272004-06-13 20:20:40 +00002765 When reading a file 'fileencoding' will be set from 'fileencodings'.
2766 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002767 'fileencoding', use the |++enc| argument. One exception: when
2768 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002769 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002770
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2772 When the option is set, the value is converted to lowercase. Thus
2773 you can set it with uppercase values too. '_' characters are
2774 replaced with '-'. If a name is recognized from the list for
2775 'encoding', it is replaced by the standard name. For example
2776 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002777
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 When this option is set, after starting to edit a file, the 'modified'
2779 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002780
2781 Keep in mind that changing 'fenc' from a modeline happens
2782 AFTER the text has been read, thus it applies to when the file will be
2783 written. If you do set 'fenc' in a modeline, you might want to set
2784 'nomodified' to avoid not being able to ":q".
2785
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 This option can not be changed when 'modifiable' is off.
2787
2788 *'fe'*
2789 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002790 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 old short name was 'fe', which is no longer used.
2792
2793 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002794'fileencodings' 'fencs' string (default: "ucs-bom",
2795 "ucs-bom,utf-8,default,latin1" when
2796 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 global
2798 {only available when compiled with the |+multi_byte|
2799 feature}
2800 {not in Vi}
2801 This is a list of character encodings considered when starting to edit
2802 an existing file. When a file is read, Vim tries to use the first
2803 mentioned character encoding. If an error is detected, the next one
2804 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002805 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 an empty string, which means the value of 'encoding' is used.
2807 WARNING: Conversion can cause loss of information! When
2808 'encoding' is "utf-8" (or one of the other Unicode variants)
2809 conversion is most likely done in a way that the reverse
2810 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002811 "utf-8" some non-ASCII characters may be lost! You can use
2812 the |++bad| argument to specify what is done with characters
2813 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 For an empty file or a file with only ASCII characters most encodings
2815 will work and the first entry of 'fileencodings' will be used (except
2816 "ucs-bom", which requires the BOM to be present). If you prefer
2817 another encoding use an BufReadPost autocommand event to test if your
2818 preferred encoding is to be used. Example: >
2819 au BufReadPost * if search('\S', 'w') == 0 |
2820 \ set fenc=iso-2022-jp | endif
2821< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2822 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002823 When the |++enc| argument is used then the value of 'fileencodings' is
2824 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002825 Note that 'fileencodings' is not used for a new file, the global value
2826 of 'fileencoding' is used instead. You can set it with: >
2827 :setglobal fenc=iso-8859-2
2828< This means that a non-existing file may get a different encoding than
2829 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 The special value "ucs-bom" can be used to check for a Unicode BOM
2831 (Byte Order Mark) at the start of the file. It must not be preceded
2832 by "utf-8" or another Unicode encoding for this to work properly.
2833 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2834 because Vim cannot detect an error, thus the encoding is always
2835 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002836 The special value "default" can be used for the encoding from the
2837 environment. This is the default value for 'encoding'. It is useful
2838 when 'encoding' is set to "utf-8" and your environment uses a
2839 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002840 When 'encoding' is "utf-8" and a file contains an illegal byte
2841 sequence it won't be recognized as UTF-8. You can use the |8g8|
2842 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843 WRONG VALUES: WHAT'S WRONG:
2844 latin1,utf-8 "latin1" will always be used
2845 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2846 file
2847 cp1250,latin1 "cp1250" will always be used
2848 If 'fileencodings' is empty, 'fileencoding' is not modified.
2849 See 'fileencoding' for the possible values.
2850 Setting this option does not have an effect until the next time a file
2851 is read.
2852
2853 *'fileformat'* *'ff'*
2854'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2855 Unix default: "unix",
2856 Macintosh default: "mac")
2857 local to buffer
2858 {not in Vi}
2859 This gives the <EOL> of the current buffer, which is used for
2860 reading/writing the buffer from/to a file:
2861 dos <CR> <NL>
2862 unix <NL>
2863 mac <CR>
2864 When "dos" is used, CTRL-Z at the end of a file is ignored.
2865 See |file-formats| and |file-read|.
2866 For the character encoding of the file see 'fileencoding'.
2867 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2868 works like it was set to "unix'.
2869 This option is set automatically when starting to edit a file and
2870 'fileformats' is not empty and 'binary' is off.
2871 When this option is set, after starting to edit a file, the 'modified'
2872 option is set, because the file would be different when written.
2873 This option can not be changed when 'modifiable' is off.
2874 For backwards compatibility: When this option is set to "dos",
2875 'textmode' is set, otherwise 'textmode' is reset.
2876
2877 *'fileformats'* *'ffs'*
2878'fileformats' 'ffs' string (default:
2879 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2880 Vim Unix: "unix,dos",
2881 Vim Mac: "mac,unix,dos",
2882 Vi Cygwin: "unix,dos",
2883 Vi others: "")
2884 global
2885 {not in Vi}
2886 This gives the end-of-line (<EOL>) formats that will be tried when
2887 starting to edit a new buffer and when reading a file into an existing
2888 buffer:
2889 - When empty, the format defined with 'fileformat' will be used
2890 always. It is not set automatically.
2891 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 'fileformats' name will be used when a file is read into an existing
2894 buffer, no matter what 'fileformat' for that buffer is set to.
2895 - When more than one name is present, separated by commas, automatic
2896 <EOL> detection will be done when reading a file. When starting to
2897 edit a file, a check is done for the <EOL>:
2898 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2899 'fileformat' is set to "dos".
2900 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002901 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002903 3. If 'fileformat' has not yet been set, and if 'fileformats'
2904 includes "mac", 'fileformat' is set to "mac".
2905 This means that "mac" is only chosen when:
2906 "unix" is not present or no <NL> is found in the file, and
2907 "dos" is not present or no <CR><NL> is found in the file.
2908 Except: if "unix" was chosen, but there is a <CR> before
2909 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002910 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 4. If 'fileformat' is still not set, the first name from
2912 'fileformats' is used.
2913 When reading a file into an existing buffer, the same is done, but
2914 this happens like 'fileformat' has been set appropriately for that
2915 file only, the option is not changed.
2916 When 'binary' is set, the value of 'fileformats' is not used.
2917
Bram Moolenaar81af9252010-12-10 20:35:50 +01002918 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002919 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002920
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2922 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2923 done:
2924 - When 'fileformats' is empty, there is no automatic detection. Dos
2925 format will be used.
2926 - When 'fileformats' is set to one or more names, automatic detection
2927 is done. This is based on the first <NL> in the file: If there is a
2928 <CR> in front of it, Dos format is used, otherwise Unix format is
2929 used.
2930 Also see |file-formats|.
2931 For backwards compatibility: When this option is set to an empty
2932 string or one format (no comma is included), 'textauto' is reset,
2933 otherwise 'textauto' is set.
2934 NOTE: This option is set to the Vi default value when 'compatible' is
2935 set and to the Vim default value when 'compatible' is reset.
2936
2937 *'filetype'* *'ft'*
2938'filetype' 'ft' string (default: "")
2939 local to buffer
2940 {not in Vi}
2941 {not available when compiled without the |+autocmd|
2942 feature}
2943 When this option is set, the FileType autocommand event is triggered.
2944 All autocommands that match with the value of this option will be
2945 executed. Thus the value of 'filetype' is used in place of the file
2946 name.
2947 Otherwise this option does not always reflect the current file type.
2948 This option is normally set when the file type is detected. To enable
2949 this use the ":filetype on" command. |:filetype|
2950 Setting this option to a different value is most useful in a modeline,
2951 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002952 Example, for in an IDL file:
2953 /* vim: set filetype=idl : */ ~
2954 |FileType| |filetypes|
2955 When a dot appears in the value then this separates two filetype
2956 names. Example:
2957 /* vim: set filetype=c.doxygen : */ ~
2958 This will use the "c" filetype first, then the "doxygen" filetype.
2959 This works both for filetype plugins and for syntax files. More than
2960 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 This option is not copied to another buffer, independent of the 's' or
2962 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002963 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964
2965 *'fillchars'* *'fcs'*
2966'fillchars' 'fcs' string (default "vert:|,fold:-")
2967 global
2968 {not in Vi}
2969 {not available when compiled without the |+windows|
2970 and |+folding| features}
2971 Characters to fill the statuslines and vertical separators.
2972 It is a comma separated list of items:
2973
2974 item default Used for ~
2975 stl:c ' ' or '^' statusline of the current window
2976 stlnc:c ' ' or '-' statusline of the non-current windows
2977 vert:c '|' vertical separators |:vsplit|
2978 fold:c '-' filling 'foldtext'
2979 diff:c '-' deleted lines of the 'diff' option
2980
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002981 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 "stlnc" the space will be used when there is highlighting, '^' or '-'
2983 otherwise.
2984
2985 Example: >
2986 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2987< This is similar to the default, except that these characters will also
2988 be used when there is highlighting.
2989
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002990 for "stl" and "stlnc" only single-byte values are supported.
2991
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 The highlighting used for these items:
2993 item highlight group ~
2994 stl:c StatusLine |hl-StatusLine|
2995 stlnc:c StatusLineNC |hl-StatusLineNC|
2996 vert:c VertSplit |hl-VertSplit|
2997 fold:c Folded |hl-Folded|
2998 diff:c DiffDelete |hl-DiffDelete|
2999
3000 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3001'fkmap' 'fk' boolean (default off) *E198*
3002 global
3003 {not in Vi}
3004 {only available when compiled with the |+rightleft|
3005 feature}
3006 When on, the keyboard is mapped for the Farsi character set.
3007 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003008 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009
3010 *'foldclose'* *'fcl'*
3011'foldclose' 'fcl' string (default "")
3012 global
3013 {not in Vi}
3014 {not available when compiled without the |+folding|
3015 feature}
3016 When set to "all", a fold is closed when the cursor isn't in it and
3017 its level is higher than 'foldlevel'. Useful if you want folds to
3018 automatically close when moving out of them.
3019
3020 *'foldcolumn'* *'fdc'*
3021'foldcolumn' 'fdc' number (default 0)
3022 local to window
3023 {not in Vi}
3024 {not available when compiled without the |+folding|
3025 feature}
3026 When non-zero, a column with the specified width is shown at the side
3027 of the window which indicates open and closed folds. The maximum
3028 value is 12.
3029 See |folding|.
3030
3031 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3032'foldenable' 'fen' boolean (default on)
3033 local to window
3034 {not in Vi}
3035 {not available when compiled without the |+folding|
3036 feature}
3037 When off, all folds are open. This option can be used to quickly
3038 switch between showing all text unfolded and viewing the text with
3039 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003040 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 'foldenable' is off.
3042 This option is set by commands that create a new fold or close a fold.
3043 See |folding|.
3044
3045 *'foldexpr'* *'fde'*
3046'foldexpr' 'fde' string (default: "0")
3047 local to window
3048 {not in Vi}
3049 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003050 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003052 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003053
Bram Moolenaar30b65812012-07-12 22:01:11 +02003054 The expression will be evaluated in the |sandbox| if set from a
3055 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003056 This option can't be set from a |modeline| when the 'diff' option is
3057 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003058
3059 It is not allowed to change text or jump to another window while
3060 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061
3062 *'foldignore'* *'fdi'*
3063'foldignore' 'fdi' string (default: "#")
3064 local to window
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
3067 feature}
3068 Used only when 'foldmethod' is "indent". Lines starting with
3069 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003070 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 The default "#" works well for C programs. See |fold-indent|.
3072
3073 *'foldlevel'* *'fdl'*
3074'foldlevel' 'fdl' number (default: 0)
3075 local to window
3076 {not in Vi}
3077 {not available when compiled without the |+folding|
3078 feature}
3079 Sets the fold level: Folds with a higher level will be closed.
3080 Setting this option to zero will close all folds. Higher numbers will
3081 close fewer folds.
3082 This option is set by commands like |zm|, |zM| and |zR|.
3083 See |fold-foldlevel|.
3084
3085 *'foldlevelstart'* *'fdls'*
3086'foldlevelstart' 'fdls' number (default: -1)
3087 global
3088 {not in Vi}
3089 {not available when compiled without the |+folding|
3090 feature}
3091 Sets 'foldlevel' when starting to edit another buffer in a window.
3092 Useful to always start editing with all folds closed (value zero),
3093 some folds closed (one) or no folds closed (99).
3094 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003095 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 ignores this option and closes all folds.
3097 It is also done before BufReadPre autocommands, to allow an autocmd to
3098 overrule the 'foldlevel' value for specific files.
3099 When the value is negative, it is not used.
3100
3101 *'foldmarker'* *'fmr'* *E536*
3102'foldmarker' 'fmr' string (default: "{{{,}}}")
3103 local to window
3104 {not in Vi}
3105 {not available when compiled without the |+folding|
3106 feature}
3107 The start and end marker used when 'foldmethod' is "marker". There
3108 must be one comma, which separates the start and end marker. The
3109 marker is a literal string (a regular expression would be too slow).
3110 See |fold-marker|.
3111
3112 *'foldmethod'* *'fdm'*
3113'foldmethod' 'fdm' string (default: "manual")
3114 local to window
3115 {not in Vi}
3116 {not available when compiled without the |+folding|
3117 feature}
3118 The kind of folding used for the current window. Possible values:
3119 |fold-manual| manual Folds are created manually.
3120 |fold-indent| indent Lines with equal indent form a fold.
3121 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3122 |fold-marker| marker Markers are used to specify folds.
3123 |fold-syntax| syntax Syntax highlighting items specify folds.
3124 |fold-diff| diff Fold text that is not changed.
3125
3126 *'foldminlines'* *'fml'*
3127'foldminlines' 'fml' number (default: 1)
3128 local to window
3129 {not in Vi}
3130 {not available when compiled without the |+folding|
3131 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003132 Sets the number of screen lines above which a fold can be displayed
3133 closed. Also for manually closed folds. With the default value of
3134 one a fold can only be closed if it takes up two or more screen lines.
3135 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003136 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 "zc" to close a fold, which is displayed open because it's smaller
3138 than 'foldminlines', a following "zc" may close a containing fold.
3139
3140 *'foldnestmax'* *'fdn'*
3141'foldnestmax' 'fdn' number (default: 20)
3142 local to window
3143 {not in Vi}
3144 {not available when compiled without the |+folding|
3145 feature}
3146 Sets the maximum nesting of folds for the "indent" and "syntax"
3147 methods. This avoids that too many folds will be created. Using more
3148 than 20 doesn't work, because the internal limit is 20.
3149
3150 *'foldopen'* *'fdo'*
3151'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3152 search,tag,undo")
3153 global
3154 {not in Vi}
3155 {not available when compiled without the |+folding|
3156 feature}
3157 Specifies for which type of commands folds will be opened, if the
3158 command moves the cursor into a closed fold. It is a comma separated
3159 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003160 NOTE: When the command is part of a mapping this option is not used.
3161 Add the |zv| command to the mapping to get the same effect.
3162 (rationale: the mapping may want to control opening folds itself)
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 item commands ~
3165 all any
3166 block "(", "{", "[[", "[{", etc.
3167 hor horizontal movements: "l", "w", "fx", etc.
3168 insert any command in Insert mode
3169 jump far jumps: "G", "gg", etc.
3170 mark jumping to a mark: "'m", CTRL-O, etc.
3171 percent "%"
3172 quickfix ":cn", ":crew", ":make", etc.
3173 search search for a pattern: "/", "n", "*", "gd", etc.
3174 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003175 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 tag jumping to a tag: ":ta", CTRL-T, etc.
3177 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 When a movement command is used for an operator (e.g., "dl" or "y%")
3179 this option is not used. This means the operator will include the
3180 whole closed fold.
3181 Note that vertical movements are not here, because it would make it
3182 very difficult to move onto a closed fold.
3183 In insert mode the folds containing the cursor will always be open
3184 when text is inserted.
3185 To close folds you can re-apply 'foldlevel' with the |zx| command or
3186 set the 'foldclose' option to "all".
3187
3188 *'foldtext'* *'fdt'*
3189'foldtext' 'fdt' string (default: "foldtext()")
3190 local to window
3191 {not in Vi}
3192 {not available when compiled without the |+folding|
3193 feature}
3194 An expression which is used to specify the text displayed for a closed
3195 fold. See |fold-foldtext|.
3196
Bram Moolenaar30b65812012-07-12 22:01:11 +02003197 The expression will be evaluated in the |sandbox| if set from a
3198 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003199
3200 It is not allowed to change text or jump to another window while
3201 evaluating 'foldtext' |textlock|.
3202
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 *'formatoptions'* *'fo'*
3204'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3205 local to buffer
3206 {not in Vi}
3207 This is a sequence of letters which describes how automatic
3208 formatting is to be done. See |fo-table|. When the 'paste' option is
3209 on, no formatting is done (like 'formatoptions' is empty). Commas can
3210 be inserted for readability.
3211 To avoid problems with flags that are added in the future, use the
3212 "+=" and "-=" feature of ":set" |add-option-flags|.
3213 NOTE: This option is set to the Vi default value when 'compatible' is
3214 set and to the Vim default value when 'compatible' is reset.
3215
Bram Moolenaar86b68352004-12-27 21:59:20 +00003216 *'formatlistpat'* *'flp'*
3217'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3218 local to buffer
3219 {not in Vi}
3220 A pattern that is used to recognize a list header. This is used for
3221 the "n" flag in 'formatoptions'.
3222 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003223 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003224 while still checking more characters. There must be a character
3225 following the pattern, when it matches the whole line it is handled
3226 like there is no match.
3227 The default recognizes a number, followed by an optional punctuation
3228 character and white space.
3229
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 *'formatprg'* *'fp'*
3231'formatprg' 'fp' string (default "")
3232 global
3233 {not in Vi}
3234 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003235 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003237 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003238 If the 'formatexpr' option is not empty it will be used instead.
3239 Otherwise, if 'formatprg' option is an empty string, the internal
3240 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003241 Environment variables are expanded |:set_env|. See |option-backslash|
3242 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003243 This option cannot be set from a |modeline| or in the |sandbox|, for
3244 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003246 *'formatexpr'* *'fex'*
3247'formatexpr' 'fex' string (default "")
3248 local to buffer
3249 {not in Vi}
3250 {not available when compiled without the |+eval|
3251 feature}
3252 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003253 operator or automatic formatting (see 'formatoptions'). When this
3254 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003255
3256 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003257 The |v:count| variable holds the number of lines to be formatted.
3258 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003259 inserted if the expression is being evaluated due to
3260 automatic formatting. This can be empty. Don't insert
3261 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003262
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003263 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003264 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003265< This will invoke the mylang#Format() function in the
3266 autoload/mylang.vim file in 'runtimepath'. |autoload|
3267
3268 The expression is also evaluated when 'textwidth' is set and adding
3269 text beyond that limit. This happens under the same conditions as
3270 when internal formatting is used. Make sure the cursor is kept in the
3271 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003272 return "i" or "R" in this situation.
3273
3274 When the expression evaluates to non-zero Vim will fall back to using
3275 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003276
Bram Moolenaar30b65812012-07-12 22:01:11 +02003277 The expression will be evaluated in the |sandbox| when set from a
3278 modeline, see |sandbox-option|. That stops the option from working,
3279 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003280
3281 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003282'fsync' 'fs' boolean (default on)
3283 global
3284 {not in Vi}
3285 When on, the library function fsync() will be called after writing a
3286 file. This will flush a file to disk, ensuring that it is safely
3287 written even on filesystems which do metadata-only journaling. This
3288 will force the harddrive to spin up on Linux systems running in laptop
3289 mode, so it may be undesirable in some situations. Be warned that
3290 turning this off increases the chances of data loss after a crash. On
3291 systems without an fsync() implementation, this variable is always
3292 off.
3293 Also see 'swapsync' for controlling fsync() on swap files.
3294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3296'gdefault' 'gd' boolean (default off)
3297 global
3298 {not in Vi}
3299 When on, the ":substitute" flag 'g' is default on. This means that
3300 all matches in a line are substituted instead of one. When a 'g' flag
3301 is given to a ":substitute" command, this will toggle the substitution
3302 of all or one match. See |complex-change|.
3303
3304 command 'gdefault' on 'gdefault' off ~
3305 :s/// subst. all subst. one
3306 :s///g subst. one subst. all
3307 :s///gg subst. all subst. one
3308
3309 NOTE: This option is reset when 'compatible' is set.
3310
3311 *'grepformat'* *'gfm'*
3312'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3313 global
3314 {not in Vi}
3315 Format to recognize for the ":grep" command output.
3316 This is a scanf-like string that uses the same format as the
3317 'errorformat' option: see |errorformat|.
3318
3319 *'grepprg'* *'gp'*
3320'grepprg' 'gp' string (default "grep -n ",
3321 Unix: "grep -n $* /dev/null",
3322 Win32: "findstr /n" or "grep -n",
3323 VMS: "SEARCH/NUMBERS ")
3324 global or local to buffer |global-local|
3325 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003326 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 and '#' characters, which are expanded like when used in a command-
3328 line. The placeholder "$*" is allowed to specify where the arguments
3329 will be included. Environment variables are expanded |:set_env|. See
3330 |option-backslash| about including spaces and backslashes.
3331 When your "grep" accepts the "-H" argument, use this to make ":grep"
3332 also work well with a single file: >
3333 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003334< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003335 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3336 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003337 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003338 apply equally to 'grepprg'.
3339 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3340 otherwise it's "grep -n".
3341 This option cannot be set from a |modeline| or in the |sandbox|, for
3342 security reasons.
3343
3344 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3345'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3346 ve:ver35-Cursor,
3347 o:hor50-Cursor,
3348 i-ci:ver25-Cursor/lCursor,
3349 r-cr:hor20-Cursor/lCursor,
3350 sm:block-Cursor
3351 -blinkwait175-blinkoff150-blinkon175",
3352 for MS-DOS and Win32 console:
3353 "n-v-c:block,o:hor50,i-ci:hor15,
3354 r-cr:hor30,sm:block")
3355 global
3356 {not in Vi}
3357 {only available when compiled with GUI enabled, and
3358 for MS-DOS and Win32 console}
3359 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003360 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 the height of the cursor can be changed. This can be done by
3362 specifying a block cursor, or a percentage for a vertical or
3363 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003364 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 mode-list and an argument-list:
3368 mode-list:argument-list,mode-list:argument-list,..
3369 The mode-list is a dash separated list of these modes:
3370 n Normal mode
3371 v Visual mode
3372 ve Visual mode with 'selection' "exclusive" (same as 'v',
3373 if not specified)
3374 o Operator-pending mode
3375 i Insert mode
3376 r Replace mode
3377 c Command-line Normal (append) mode
3378 ci Command-line Insert mode
3379 cr Command-line Replace mode
3380 sm showmatch in Insert mode
3381 a all modes
3382 The argument-list is a dash separated list of these arguments:
3383 hor{N} horizontal bar, {N} percent of the character height
3384 ver{N} vertical bar, {N} percent of the character width
3385 block block cursor, fills the whole character
3386 [only one of the above three should be present]
3387 blinkwait{N} *cursor-blinking*
3388 blinkon{N}
3389 blinkoff{N}
3390 blink times for cursor: blinkwait is the delay before
3391 the cursor starts blinking, blinkon is the time that
3392 the cursor is shown and blinkoff is the time that the
3393 cursor is not shown. The times are in msec. When one
3394 of the numbers is zero, there is no blinking. The
3395 default is: "blinkwait700-blinkon400-blinkoff250".
3396 These numbers are used for a missing entry. This
3397 means that blinking is enabled by default. To switch
3398 blinking off you can use "blinkon0". The cursor only
3399 blinks when Vim is waiting for input, not while
3400 executing a command.
3401 To make the cursor blink in an xterm, see
3402 |xterm-blink|.
3403 {group-name}
3404 a highlight group name, that sets the color and font
3405 for the cursor
3406 {group-name}/{group-name}
3407 Two highlight group names, the first is used when
3408 no language mappings are used, the other when they
3409 are. |language-mapping|
3410
3411 Examples of parts:
3412 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3413 block cursor with colors from the "nCursor"
3414 highlight group
3415 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3416 In Insert and Command-line Insert mode, use a
3417 30% vertical bar cursor with colors from the
3418 "iCursor" highlight group. Blink a bit
3419 faster.
3420
3421 The 'a' mode is different. It will set the given argument-list for
3422 all modes. It does not reset anything to defaults. This can be used
3423 to do a common setting for all modes. For example, to switch off
3424 blinking: "a:blinkon0"
3425
3426 Examples of cursor highlighting: >
3427 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3428 :highlight Cursor gui=NONE guifg=bg guibg=fg
3429<
3430 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003431 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432'guifont' 'gfn' string (default "")
3433 global
3434 {not in Vi}
3435 {only available when compiled with GUI enabled}
3436 This is a list of fonts which will be used for the GUI version of Vim.
3437 In its simplest form the value is just one font name. When
3438 the font cannot be found you will get an error message. To try other
3439 font names a list can be specified, font names separated with commas.
3440 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003441
Bram Moolenaar05159a02005-02-26 23:04:13 +00003442 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3443 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003444
Bram Moolenaar071d4272004-06-13 20:20:40 +00003445 Spaces after a comma are ignored. To include a comma in a font name
3446 precede it with a backslash. Setting an option requires an extra
3447 backslash before a space and a backslash. See also
3448 |option-backslash|. For example: >
3449 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003450< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003452
3453 If none of the fonts can be loaded, Vim will keep the current setting.
3454 If an empty font list is given, Vim will try using other resource
3455 settings (for X, it will use the Vim.font resource), and finally it
3456 will try some builtin default which should always be there ("7x13" in
3457 the case of X). The font names given should be "normal" fonts. Vim
3458 will try to find the related bold and italic fonts.
3459
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003460 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003461 :set guifont=*
3462< will bring up a font requester, where you can pick the font you want.
3463
3464 The font name depends on the GUI used. See |setting-guifont| for a
3465 way to set 'guifont' for various systems.
3466
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 For the GTK+ 2 GUI the font name looks like this: >
3468 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003469< That's all. XLFDs are not used. For Chinese this is reported to work
3470 well: >
3471 if has("gui_gtk2")
3472 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3473 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3474 endif
3475<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003476 For Mac OSX you can use something like this: >
3477 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003478< Also see 'macatsui', it can help fix display problems.
3479 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003481 width). An exception is GTK 2: all fonts are accepted, but
3482 mono-spaced fonts look best.
3483
Bram Moolenaar071d4272004-06-13 20:20:40 +00003484 To preview a font on X11, you might be able to use the "xfontsel"
3485 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 For the Win32 GUI *E244* *E245*
3488 - takes these options in the font name:
3489 hXX - height is XX (points, can be floating-point)
3490 wXX - width is XX (points, can be floating-point)
3491 b - bold
3492 i - italic
3493 u - underline
3494 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003495 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3497 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3498 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003499 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500
3501 Use a ':' to separate the options.
3502 - A '_' can be used in the place of a space, so you don't need to use
3503 backslashes to escape the spaces.
3504 - Examples: >
3505 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3506 :set guifont=Andale_Mono:h7.5:w4.5
3507< See also |font-sizes|.
3508
3509 *'guifontset'* *'gfs'*
3510 *E250* *E252* *E234* *E597* *E598*
3511'guifontset' 'gfs' string (default "")
3512 global
3513 {not in Vi}
3514 {only available when compiled with GUI enabled and
3515 with the |+xfontset| feature}
3516 {not available in the GTK+ 2 GUI}
3517 When not empty, specifies two (or more) fonts to be used. The first
3518 one for normal English, the second one for your special language. See
3519 |xfontset|.
3520 Setting this option also means that all font names will be handled as
3521 a fontset name. Also the ones used for the "font" argument of the
3522 |:highlight| command.
3523 The fonts must match with the current locale. If fonts for the
3524 character sets that the current locale uses are not included, setting
3525 'guifontset' will fail.
3526 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3527 the comma-separated names are alternative names, one of which will be
3528 used. In 'guifontset' the whole string is one fontset name,
3529 including the commas. It is not possible to specify alternative
3530 fontset names.
3531 This example works on many X11 systems: >
3532 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3533<
3534 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3535'guifontwide' 'gfw' string (default "")
3536 global
3537 {not in Vi}
3538 {only available when compiled with GUI enabled}
3539 When not empty, specifies a comma-separated list of fonts to be used
3540 for double-width characters. The first font that can be loaded is
3541 used.
3542 Note: The size of these fonts must be exactly twice as wide as the one
3543 specified with 'guifont' and the same height.
3544
3545 All GUI versions but GTK+ 2:
3546
3547 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3548 'guifontset' is empty or invalid.
3549 When 'guifont' is set and a valid font is found in it and
3550 'guifontwide' is empty Vim will attempt to find a matching
3551 double-width font and set 'guifontwide' to it.
3552
3553 GTK+ 2 GUI only: *guifontwide_gtk2*
3554
3555 If set and valid, 'guifontwide' is always used for double width
3556 characters, even if 'encoding' is not set to "utf-8".
3557 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003558 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003559 font for characters not available in 'guifont'. Thus you do not need
3560 to set 'guifontwide' at all unless you want to override the choice
3561 made by Pango/Xft.
3562
Bram Moolenaar0f272122013-01-23 18:37:40 +01003563 Windows +multibyte only: *guifontwide_win_mbyte*
3564
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003565 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003566
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 *'guiheadroom'* *'ghr'*
3568'guiheadroom' 'ghr' number (default 50)
3569 global
3570 {not in Vi} {only for GTK and X11 GUI}
3571 The number of pixels subtracted from the screen height when fitting
3572 the GUI window on the screen. Set this before the GUI is started,
3573 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003574 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 lines will be left for window decorations and other items on the
3576 screen. Set it to a negative value to allow windows taller than the
3577 screen.
3578
3579 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003580'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3581 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 global
3583 {not in Vi}
3584 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003585 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 sequence of letters which describes what components and options of the
3587 GUI should be used.
3588 To avoid problems with flags that are added in the future, use the
3589 "+=" and "-=" feature of ":set" |add-option-flags|.
3590
3591 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003592 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 'a' Autoselect: If present, then whenever VISUAL mode is started,
3594 or the Visual area extended, Vim tries to become the owner of
3595 the windowing system's global selection. This means that the
3596 Visually highlighted text is available for pasting into other
3597 applications as well as into Vim itself. When the Visual mode
3598 ends, possibly due to an operation on the text, or when an
3599 application wants to paste the selection, the highlighted text
3600 is automatically yanked into the "* selection register.
3601 Thus the selection is still available for pasting into other
3602 applications after the VISUAL mode has ended.
3603 If not present, then Vim won't become the owner of the
3604 windowing system's global selection unless explicitly told to
3605 by a yank or delete operation for the "* register.
3606 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003607 *'go-P'*
3608 'P' Like autoselect but using the "+ register instead of the "*
3609 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003610 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003611 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 applies to the modeless selection.
3613
3614 'guioptions' autoselect Visual autoselect modeless ~
3615 "" - -
3616 "a" yes yes
3617 "A" - yes
3618 "aA" yes yes
3619
Bram Moolenaar02467872007-05-06 13:22:01 +00003620 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003621 'c' Use console dialogs instead of popup dialogs for simple
3622 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003623 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003624 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003625 'guitablabel' can be used to change the text in the labels.
3626 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003627 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003628 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003629 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 'f' Foreground: Don't use fork() to detach the GUI from the shell
3631 where it was started. Use this for programs that wait for the
3632 editor to finish (e.g., an e-mail program). Alternatively you
3633 can use "gvim -f" or ":gui -f" to start the GUI in the
3634 foreground. |gui-fork|
3635 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003636 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003637 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003638 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3639 corner of the window. It's black&white on non-GTK, because of
3640 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003641 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003643 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003644 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003646 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 file is sourced the system menu has already been loaded; the
3648 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003649 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 'g' Grey menu items: Make menu items that are not active grey. If
3651 'g' is not included inactive menu items are not shown at all.
3652 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003653 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 't' Include tearoff menu items. Currently only works for Win32,
3655 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003656 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003657 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003658 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003659 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003661 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 'R' Right-hand scrollbar is present when there is a vertically
3663 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003664 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003666 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 'L' Left-hand scrollbar is present when there is a vertically
3668 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003669 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3671 the longest visible line, or on the cursor line if the 'h'
3672 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003673 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674 'h' Limit horizontal scrollbar size to the length of the cursor
3675 line. Reduces computations. |gui-horiz-scroll|
3676
3677 And yes, you may even have scrollbars on the left AND the right if
3678 you really want to :-). See |gui-scrollbars| for more information.
3679
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003680 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 'v' Use a vertical button layout for dialogs. When not included,
3682 a horizontal layout is preferred, but when it doesn't fit a
3683 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003684 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 'p' Use Pointer callbacks for X11 GUI. This is required for some
3686 window managers. If the cursor is not blinking or hollow at
3687 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003688 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003690 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003691 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692
Bram Moolenaar02467872007-05-06 13:22:01 +00003693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 *'guipty'* *'noguipty'*
3695'guipty' boolean (default on)
3696 global
3697 {not in Vi}
3698 {only available when compiled with GUI enabled}
3699 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3700 I/O to/from shell commands. See |gui-pty|.
3701
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003702 *'guitablabel'* *'gtl'*
3703'guitablabel' 'gtl' string (default empty)
3704 global
3705 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003706 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003707 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003708 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003709 pages line. When empty and when the result is empty Vim will use a
3710 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003711
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003712 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003713 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003714
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003715 Only used when the GUI tab pages line is displayed. 'e' must be
3716 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3717 used.
3718
Bram Moolenaar57657d82006-04-21 22:12:41 +00003719 *'guitabtooltip'* *'gtt'*
3720'guitabtooltip' 'gtt' string (default empty)
3721 global
3722 {not in Vi}
3723 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003724 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003725 When nonempty describes the text to use in a tooltip for the GUI tab
3726 pages line. When empty Vim will use a default tooltip.
3727 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003728 You can include a line break. Simplest method is to use |:let|: >
3729 :let &guitabtooltip = "line one\nline two"
3730<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003731
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 *'helpfile'* *'hf'*
3733'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3734 (others) "$VIMRUNTIME/doc/help.txt")
3735 global
3736 {not in Vi}
3737 Name of the main help file. All distributed help files should be
3738 placed together in one directory. Additionally, all "doc" directories
3739 in 'runtimepath' will be used.
3740 Environment variables are expanded |:set_env|. For example:
3741 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003742 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 spaces and backslashes.
3744 This option cannot be set from a |modeline| or in the |sandbox|, for
3745 security reasons.
3746
3747 *'helpheight'* *'hh'*
3748'helpheight' 'hh' number (default 20)
3749 global
3750 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003751 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 feature}
3753 Minimal initial height of the help window when it is opened with the
3754 ":help" command. The initial height of the help window is half of the
3755 current window, or (when the 'ea' option is on) the same as other
3756 windows. When the height is less than 'helpheight', the height is
3757 set to 'helpheight'. Set to zero to disable.
3758
3759 *'helplang'* *'hlg'*
3760'helplang' 'hlg' string (default: messages language or empty)
3761 global
3762 {only available when compiled with the |+multi_lang|
3763 feature}
3764 {not in Vi}
3765 Comma separated list of languages. Vim will use the first language
3766 for which the desired help can be found. The English help will always
3767 be used as a last resort. You can add "en" to prefer English over
3768 another language, but that will only find tags that exist in that
3769 language and not in the English help.
3770 Example: >
3771 :set helplang=de,it
3772< This will first search German, then Italian and finally English help
3773 files.
3774 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3775 try to find the tag in the current language before using this option.
3776 See |help-translated|.
3777
3778 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3779'hidden' 'hid' boolean (default off)
3780 global
3781 {not in Vi}
3782 When off a buffer is unloaded when it is |abandon|ed. When on a
3783 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3784 displayed in another window, it does not become hidden, of course.
3785 The commands that move through the buffer list sometimes make a buffer
3786 hidden although the 'hidden' option is off: When the buffer is
3787 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003788 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003789 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 This option is set for one command with ":hide {command}" |:hide|.
3791 WARNING: It's easy to forget that you have changes in hidden buffers.
3792 Think twice when using ":q!" or ":qa!".
3793
3794 *'highlight'* *'hl'*
3795'highlight' 'hl' string (default (as a single string):
3796 "8:SpecialKey,@:NonText,d:Directory,
3797 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003798 M:ModeMsg,n:LineNr,N:CursorLineNr,
3799 r:Question,s:StatusLine,S:StatusLineNC,
3800 c:VertSplit, t:Title,v:Visual,
3801 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 f:Folded,F:FoldColumn,A:DiffAdd,
3803 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003804 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003805 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003806 +:Pmenu,=:PmenuSel,
3807 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 global
3809 {not in Vi}
3810 This option can be used to set highlighting mode for various
3811 occasions. It is a comma separated list of character pairs. The
3812 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003813 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3815 |hl-NonText| @ '~' and '@' at the end of the window and
3816 characters from 'showbreak'
3817 |hl-Directory| d directories in CTRL-D listing and other special
3818 things in listings
3819 |hl-ErrorMsg| e error messages
3820 h (obsolete, ignored)
3821 |hl-IncSearch| i 'incsearch' highlighting
3822 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3823 |hl-MoreMsg| m |more-prompt|
3824 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003825 |hl-LineNr| n line number for ":number" and ":#" commands, and
3826 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003827 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3828 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 |hl-Question| r |hit-enter| prompt and yes/no questions
3830 |hl-StatusLine| s status line of current window |status-line|
3831 |hl-StatusLineNC| S status lines of not-current windows
3832 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3833 |hl-VertSplit| c column used to separate vertically split windows
3834 |hl-Visual| v Visual mode
3835 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3836 Selection" Only X11 Gui's |gui-x11| and
3837 |xterm-clipboard|.
3838 |hl-WarningMsg| w warning messages
3839 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3840 |hl-Folded| f line used for closed folds
3841 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003842 |hl-DiffAdd| A added line in diff mode
3843 |hl-DiffChange| C changed line in diff mode
3844 |hl-DiffDelete| D deleted line in diff mode
3845 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003847 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003848 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003849 |hl-SpellRare| R rare word |spell|
3850 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003851 |hl-Conceal| - the placeholders used for concealed characters
3852 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003853 |hl-Pmenu| + popup menu normal line
3854 |hl-PmenuSel| = popup menu normal line
3855 |hl-PmenuSbar| x popup menu scrollbar
3856 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857
3858 The display modes are:
3859 r reverse (termcap entry "mr" and "me")
3860 i italic (termcap entry "ZH" and "ZR")
3861 b bold (termcap entry "md" and "me")
3862 s standout (termcap entry "so" and "se")
3863 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003864 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 n no highlighting
3866 - no highlighting
3867 : use a highlight group
3868 The default is used for occasions that are not included.
3869 If you want to change what the display modes do, see |dos-colors|
3870 for an example.
3871 When using the ':' display mode, this must be followed by the name of
3872 a highlight group. A highlight group can be used to define any type
3873 of highlighting, including using color. See |:highlight| on how to
3874 define one. The default uses a different group for each occasion.
3875 See |highlight-default| for the default highlight groups.
3876
3877 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3878'hlsearch' 'hls' boolean (default off)
3879 global
3880 {not in Vi}
3881 {not available when compiled without the
3882 |+extra_search| feature}
3883 When there is a previous search pattern, highlight all its matches.
3884 The type of highlighting used can be set with the 'l' occasion in the
3885 'highlight' option. This uses the "Search" highlight group by
3886 default. Note that only the matching text is highlighted, any offsets
3887 are not applied.
3888 See also: 'incsearch' and |:match|.
3889 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003890 off with |:nohlsearch|. This does not change the option value, as
3891 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003892 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 When the search pattern can match an end-of-line, Vim will try to
3894 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003895 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003897 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003898 You can specify whether the highlight status is restored on startup
3899 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003900 NOTE: This option is reset when 'compatible' is set.
3901
3902 *'history'* *'hi'*
3903'history' 'hi' number (Vim default: 20, Vi default: 0)
3904 global
3905 {not in Vi}
3906 A history of ":" commands, and a history of previous search patterns
3907 are remembered. This option decides how many entries may be stored in
3908 each of these histories (see |cmdline-editing|).
3909 NOTE: This option is set to the Vi default value when 'compatible' is
3910 set and to the Vim default value when 'compatible' is reset.
3911
3912 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3913'hkmap' 'hk' boolean (default off)
3914 global
3915 {not in Vi}
3916 {only available when compiled with the |+rightleft|
3917 feature}
3918 When on, the keyboard is mapped for the Hebrew character set.
3919 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3920 toggle this option. See |rileft.txt|.
3921 NOTE: This option is reset when 'compatible' is set.
3922
3923 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3924'hkmapp' 'hkp' boolean (default off)
3925 global
3926 {not in Vi}
3927 {only available when compiled with the |+rightleft|
3928 feature}
3929 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3930 This is useful if you have a non-Hebrew keyboard.
3931 See |rileft.txt|.
3932 NOTE: This option is reset when 'compatible' is set.
3933
3934 *'icon'* *'noicon'*
3935'icon' boolean (default off, on when title can be restored)
3936 global
3937 {not in Vi}
3938 {not available when compiled without the |+title|
3939 feature}
3940 When on, the icon text of the window will be set to the value of
3941 'iconstring' (if it is not empty), or to the name of the file
3942 currently being edited. Only the last part of the name is used.
3943 Overridden by the 'iconstring' option.
3944 Only works if the terminal supports setting window icons (currently
3945 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3946 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3947 builtin termcap).
3948 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003949 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 X11.
3951
3952 *'iconstring'*
3953'iconstring' string (default "")
3954 global
3955 {not in Vi}
3956 {not available when compiled without the |+title|
3957 feature}
3958 When this option is not empty, it will be used for the icon text of
3959 the window. This happens only when the 'icon' option is on.
3960 Only works if the terminal supports setting window icon text
3961 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3962 Does not work for MS Windows.
3963 When Vim was compiled with HAVE_X11 defined, the original icon will be
3964 restored if possible |X11|.
3965 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003966 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003967 'titlestring' for example settings.
3968 {not available when compiled without the |+statusline| feature}
3969
3970 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3971'ignorecase' 'ic' boolean (default off)
3972 global
3973 Ignore case in search patterns. Also used when searching in the tags
3974 file.
3975 Also see 'smartcase'.
3976 Can be overruled by using "\c" or "\C" in the pattern, see
3977 |/ignorecase|.
3978
3979 *'imactivatekey'* *'imak'*
3980'imactivatekey' 'imak' string (default "")
3981 global
3982 {not in Vi}
3983 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003984 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 Specifies the key that your Input Method in X-Windows uses for
3986 activation. When this is specified correctly, vim can fully control
3987 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3988 You can't use this option to change the activation key, the option
3989 tells Vim what the key is.
3990 Format:
3991 [MODIFIER_FLAG-]KEY_STRING
3992
3993 These characters can be used for MODIFIER_FLAG (case is ignored):
3994 S Shift key
3995 L Lock key
3996 C Control key
3997 1 Mod1 key
3998 2 Mod2 key
3999 3 Mod3 key
4000 4 Mod4 key
4001 5 Mod5 key
4002 Combinations are allowed, for example "S-C-space" or "SC-space" are
4003 both shift+ctrl+space.
4004 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4005
4006 Example: >
4007 :set imactivatekey=S-space
4008< "S-space" means shift+space. This is the activation key for kinput2 +
4009 canna (Japanese), and ami (Korean).
4010
4011 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4012'imcmdline' 'imc' boolean (default off)
4013 global
4014 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004015 {only available when compiled with the |+xim|,
4016 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017 When set the Input Method is always on when starting to edit a command
4018 line, unless entering a search pattern (see 'imsearch' for that).
4019 Setting this option is useful when your input method allows entering
4020 English characters directly, e.g., when it's used to type accented
4021 characters with dead keys.
4022
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004023 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004024'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4025 global
4026 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004027 {only available when compiled with the |+xim|,
4028 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 When set the Input Method is never used. This is useful to disable
4030 the IM when it doesn't work properly.
4031 Currently this option is on by default for SGI/IRIX machines. This
4032 may change in later releases.
4033
4034 *'iminsert'* *'imi'*
4035'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4036 local to buffer
4037 {not in Vi}
4038 Specifies whether :lmap or an Input Method (IM) is to be used in
4039 Insert mode. Valid values:
4040 0 :lmap is off and IM is off
4041 1 :lmap is ON and IM is off
4042 2 :lmap is off and IM is ON
4043 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4044 or |global-ime|.
4045 To always reset the option to zero when leaving Insert mode with <Esc>
4046 this can be used: >
4047 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4048< This makes :lmap and IM turn off automatically when leaving Insert
4049 mode.
4050 Note that this option changes when using CTRL-^ in Insert mode
4051 |i_CTRL-^|.
4052 The value is set to 1 when setting 'keymap' to a valid keymap name.
4053 It is also used for the argument of commands like "r" and "f".
4054 The value 0 may not work correctly with Athena and Motif with some XIM
4055 methods. Use 'imdisable' to disable XIM then.
4056
4057 *'imsearch'* *'ims'*
4058'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4059 local to buffer
4060 {not in Vi}
4061 Specifies whether :lmap or an Input Method (IM) is to be used when
4062 entering a search pattern. Valid values:
4063 -1 the value of 'iminsert' is used, makes it look like
4064 'iminsert' is also used when typing a search pattern
4065 0 :lmap is off and IM is off
4066 1 :lmap is ON and IM is off
4067 2 :lmap is off and IM is ON
4068 Note that this option changes when using CTRL-^ in Command-line mode
4069 |c_CTRL-^|.
4070 The value is set to 1 when it is not -1 and setting the 'keymap'
4071 option to a valid keymap name.
4072 The value 0 may not work correctly with Athena and Motif with some XIM
4073 methods. Use 'imdisable' to disable XIM then.
4074
4075 *'include'* *'inc'*
4076'include' 'inc' string (default "^\s*#\s*include")
4077 global or local to buffer |global-local|
4078 {not in Vi}
4079 {not available when compiled without the
4080 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004081 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 pattern, just like for the "/" command (See |pattern|). The default
4083 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004084 "]I", "[d", etc.
4085 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004086 comes after the matched pattern. But if "\zs" appears in the pattern
4087 then the text matched from "\zs" to the end, or until "\ze" if it
4088 appears, is used as the file name. Use this to include characters
4089 that are not in 'isfname', such as a space. You can then use
4090 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004091 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092
4093 *'includeexpr'* *'inex'*
4094'includeexpr' 'inex' string (default "")
4095 local to buffer
4096 {not in Vi}
4097 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004098 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004100 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 :set includeexpr=substitute(v:fname,'\\.','/','g')
4102< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004103
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004105 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 Also used for |<cfile>|.
4107
Bram Moolenaar30b65812012-07-12 22:01:11 +02004108 The expression will be evaluated in the |sandbox| when set from a
4109 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004110
4111 It is not allowed to change text or jump to another window while
4112 evaluating 'includeexpr' |textlock|.
4113
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4115'incsearch' 'is' boolean (default off)
4116 global
4117 {not in Vi}
4118 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004119 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004120 While typing a search command, show where the pattern, as it was typed
4121 so far, matches. The matched string is highlighted. If the pattern
4122 is invalid or not found, nothing is shown. The screen will be updated
4123 often, this is only useful on fast terminals.
4124 Note that the match will be shown, but the cursor will return to its
4125 original position when no match is found and when pressing <Esc>. You
4126 still need to finish the search command with <Enter> to move the
4127 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004128 When compiled with the |+reltime| feature Vim only searches for about
4129 half a second. With a complicated pattern and/or a lot of text the
4130 match may not be found. This is to avoid that Vim hangs while you
4131 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004132 The highlighting can be set with the 'i' flag in 'highlight'.
4133 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004134 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004135 to the command line. If 'ignorecase' and 'smartcase' are set and the
4136 command line has no uppercase characters, the added character is
4137 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004138 CTRL-R CTRL-W can be used to add the word at the end of the current
4139 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140 NOTE: This option is reset when 'compatible' is set.
4141
4142 *'indentexpr'* *'inde'*
4143'indentexpr' 'inde' string (default "")
4144 local to buffer
4145 {not in Vi}
4146 {not available when compiled without the |+cindent|
4147 or |+eval| features}
4148 Expression which is evaluated to obtain the proper indent for a line.
4149 It is used when a new line is created, for the |=| operator and
4150 in Insert mode as specified with the 'indentkeys' option.
4151 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004152 'smartindent' indenting. When 'lisp' is set, this option is
4153 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 When 'paste' is set this option is not used for indenting.
4155 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004156 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 when the expression is evaluated (but it may be moved around).
4158 The expression must return the number of spaces worth of indent. It
4159 can return "-1" to keep the current indent (this means 'autoindent' is
4160 used for the indent).
4161 Functions useful for computing the indent are |indent()|, |cindent()|
4162 and |lispindent()|.
4163 The evaluation of the expression must not have side effects! It must
4164 not change the text, jump to another window, etc. Afterwards the
4165 cursor position is always restored, thus the cursor may be moved.
4166 Normally this option would be set to call a function: >
4167 :set indentexpr=GetMyIndent()
4168< Error messages will be suppressed, unless the 'debug' option contains
4169 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004170 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 NOTE: This option is made empty when 'compatible' is set.
4172
Bram Moolenaar30b65812012-07-12 22:01:11 +02004173 The expression will be evaluated in the |sandbox| when set from a
4174 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004175
4176 It is not allowed to change text or jump to another window while
4177 evaluating 'indentexpr' |textlock|.
4178
4179
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 *'indentkeys'* *'indk'*
4181'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4182 local to buffer
4183 {not in Vi}
4184 {not available when compiled without the |+cindent|
4185 feature}
4186 A list of keys that, when typed in Insert mode, cause reindenting of
4187 the current line. Only happens if 'indentexpr' isn't empty.
4188 The format is identical to 'cinkeys', see |indentkeys-format|.
4189 See |C-indenting| and |indent-expression|.
4190
4191 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4192'infercase' 'inf' boolean (default off)
4193 local to buffer
4194 {not in Vi}
4195 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004196 'ignorecase' is also on, the case of the match is adjusted depending
4197 on the typed text. If the typed text contains a lowercase letter
4198 where the match has an upper case letter, the completed part is made
4199 lowercase. If the typed text has no lowercase letters and the match
4200 has a lowercase letter where the typed text has an uppercase letter,
4201 and there is a letter before it, the completed part is made uppercase.
4202 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203
4204 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4205'insertmode' 'im' boolean (default off)
4206 global
4207 {not in Vi}
4208 Makes Vim work in a way that Insert mode is the default mode. Useful
4209 if you want to use Vim as a modeless editor. Used for |evim|.
4210 These Insert mode commands will be useful:
4211 - Use the cursor keys to move around.
4212 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4213 this is a mapping, it is executed as if 'insertmode' was off.
4214 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004216 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4217 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218
4219 These items change when 'insertmode' is set:
4220 - when starting to edit of a file, Vim goes to Insert mode.
4221 - <Esc> in Insert mode is a no-op and beeps.
4222 - <Esc> in Normal mode makes Vim go to Insert mode.
4223 - CTRL-L in Insert mode is a command, it is not inserted.
4224 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4225 However, when <Esc> is used inside a mapping, it behaves like
4226 'insertmode' was not set. This was done to be able to use the same
4227 mappings with 'insertmode' set or not set.
4228 When executing commands with |:normal| 'insertmode' is not used.
4229
4230 NOTE: This option is reset when 'compatible' is set.
4231
4232 *'isfname'* *'isf'*
4233'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4234 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4235 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4236 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4237 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4238 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4239 global
4240 {not in Vi}
4241 The characters specified by this option are included in file names and
4242 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 Multi-byte characters 256 and above are always included, only the
4245 characters up to 255 are specified with this option.
4246 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004247 Think twice before adding white space to this option. Although a
4248 space may appear inside a file name, the effect will be that Vim
4249 doesn't know where a file name starts or ends when doing completion.
4250 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251
4252 Note that on systems using a backslash as path separator, Vim tries to
4253 do its best to make it work as you would expect. That is a bit
4254 tricky, since Vi originally used the backslash to escape special
4255 characters. Vim will not remove a backslash in front of a normal file
4256 name character on these systems, but it will on Unix and alikes. The
4257 '&' and '^' are not included by default, because these are special for
4258 cmd.exe.
4259
4260 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004261 Each part can be a single character number or a range. A range is two
4262 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 decimal number between 0 and 255 or the ASCII character itself (does
4264 not work for digits). Example:
4265 "_,-,128-140,#-43" (include '_' and '-' and the range
4266 128 to 140 and '#' to 43)
4267 If a part starts with '^', the following character number or range
4268 will be excluded from the option. The option is interpreted from left
4269 to right. Put the excluded character after the range where it is
4270 included. To include '^' itself use it as the last character of the
4271 option or the end of a range. Example:
4272 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4273 If the character is '@', all characters where isalpha() returns TRUE
4274 are included. Normally these are the characters a to z and A to Z,
4275 plus accented characters. To include '@' itself use "@-@". Examples:
4276 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004277 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 "a-z,A-Z,@-@" All letters plus the '@' character.
4279 A comma can be included by using it where a character number is
4280 expected. Example:
4281 "48-57,,,_" Digits, comma and underscore.
4282 A comma can be excluded by prepending a '^'. Example:
4283 " -~,^,,9" All characters from space to '~', excluding
4284 comma, plus <Tab>.
4285 See |option-backslash| about including spaces and backslashes.
4286
4287 *'isident'* *'isi'*
4288'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4289 "@,48-57,_,128-167,224-235"
4290 otherwise: "@,48-57,_,192-255")
4291 global
4292 {not in Vi}
4293 The characters given by this option are included in identifiers.
4294 Identifiers are used in recognizing environment variables and after a
4295 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004296 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 option.
4298 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004299 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4301
4302 *'iskeyword'* *'isk'*
4303'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4304 "@,48-57,_,128-167,224-235"
4305 otherwise: "@,48-57,_,192-255"
4306 Vi default: "@,48-57,_")
4307 local to buffer
4308 {not in Vi}
4309 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004310 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 'isfname' for a description of the format of this option. For C
4312 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4313 For a help file it is set to all non-blank printable characters except
4314 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4315 command).
4316 When the 'lisp' option is on the '-' character is always included.
4317 NOTE: This option is set to the Vi default value when 'compatible' is
4318 set and to the Vim default value when 'compatible' is reset.
4319
4320 *'isprint'* *'isp'*
4321'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4322 "@,~-255"; otherwise: "@,161-255")
4323 global
4324 {not in Vi}
4325 The characters given by this option are displayed directly on the
4326 screen. It is also used for "\p" in a |pattern|. The characters from
4327 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4328 even when they are not included in 'isprint' or excluded. See
4329 'isfname' for a description of the format of this option.
4330
4331 Non-printable characters are displayed with two characters:
4332 0 - 31 "^@" - "^_"
4333 32 - 126 always single characters
4334 127 "^?"
4335 128 - 159 "~@" - "~_"
4336 160 - 254 "| " - "|~"
4337 255 "~?"
4338 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4339 displayed as <xx>, with the hexadecimal value of the byte.
4340 When 'display' contains "uhex" all unprintable characters are
4341 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004342 The SpecialKey highlighting will be used for unprintable characters.
4343 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004344
4345 Multi-byte characters 256 and above are always included, only the
4346 characters up to 255 are specified with this option. When a character
4347 is printable but it is not available in the current font, a
4348 replacement character will be shown.
4349 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4350 There is no option to specify these characters.
4351
4352 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4353'joinspaces' 'js' boolean (default on)
4354 global
4355 {not in Vi}
4356 Insert two spaces after a '.', '?' and '!' with a join command.
4357 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4358 Otherwise only one space is inserted.
4359 NOTE: This option is set when 'compatible' is set.
4360
4361 *'key'*
4362'key' string (default "")
4363 local to buffer
4364 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004365 {only available when compiled with the |+cryptv|
4366 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004368 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 Careful: Do not set the key value by hand, someone might see the typed
4370 key. Use the |:X| command. But you can make 'key' empty: >
4371 :set key=
4372< It is not possible to get the value of this option with ":set key" or
4373 "echo &key". This is to avoid showing it to someone who shouldn't
4374 know. It also means you cannot see it yourself once you have set it,
4375 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004376 You can use "&key" in an expression to detect whether encryption is
4377 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378
4379 *'keymap'* *'kmp'* *E544*
4380'keymap' 'kmp' string (default "")
4381 local to buffer
4382 {not in Vi}
4383 {only available when compiled with the |+keymap|
4384 feature}
4385 Name of a keyboard mapping. See |mbyte-keymap|.
4386 Setting this option to a valid keymap name has the side effect of
4387 setting 'iminsert' to one, so that the keymap becomes effective.
4388 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004389 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390
4391 *'keymodel'* *'km'*
4392'keymodel' 'km' string (default "")
4393 global
4394 {not in Vi}
4395 List of comma separated words, which enable special things that keys
4396 can do. These values can be used:
4397 startsel Using a shifted special key starts selection (either
4398 Select mode or Visual mode, depending on "key" being
4399 present in 'selectmode').
4400 stopsel Using a not-shifted special key stops selection.
4401 Special keys in this context are the cursor keys, <End>, <Home>,
4402 <PageUp> and <PageDown>.
4403 The 'keymodel' option is set by the |:behave| command.
4404
4405 *'keywordprg'* *'kp'*
4406'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4407 OS/2: "view /", VMS: "help")
4408 global or local to buffer |global-local|
4409 {not in Vi}
4410 Program to use for the |K| command. Environment variables are
4411 expanded |:set_env|. ":help" may be used to access the Vim internal
4412 help. (Note that previously setting the global option to the empty
4413 value did this, which is now deprecated.)
4414 When "man" is used, Vim will automatically translate a count for the
4415 "K" command to a section number. Also for "man -s", in which case the
4416 "-s" is removed when there is no count.
4417 See |option-backslash| about including spaces and backslashes.
4418 Example: >
4419 :set keywordprg=man\ -s
4420< This option cannot be set from a |modeline| or in the |sandbox|, for
4421 security reasons.
4422
4423 *'langmap'* *'lmap'* *E357* *E358*
4424'langmap' 'lmap' string (default "")
4425 global
4426 {not in Vi}
4427 {only available when compiled with the |+langmap|
4428 feature}
4429 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004430 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431 inserted directly. When in command mode the 'langmap' option takes
4432 care of translating these special characters to the original meaning
4433 of the key. This means you don't have to change the keyboard mode to
4434 be able to execute Normal mode commands.
4435 This is the opposite of the 'keymap' option, where characters are
4436 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004438 Example (for Greek, in UTF-8): *greek* >
4439 :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
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440< Example (exchanges meaning of z and y for commands): >
4441 :set langmap=zy,yz,ZY,YZ
4442<
4443 The 'langmap' option is a list of parts, separated with commas. Each
4444 part can be in one of two forms:
4445 1. A list of pairs. Each pair is a "from" character immediately
4446 followed by the "to" character. Examples: "aA", "aAbBcC".
4447 2. A list of "from" characters, a semi-colon and a list of "to"
4448 characters. Example: "abc;ABC"
4449 Example: "aA,fgh;FGH,cCdDeE"
4450 Special characters need to be preceded with a backslash. These are
4451 ";", ',' and backslash itself.
4452
4453 This will allow you to activate vim actions without having to switch
4454 back and forth between the languages. Your language characters will
4455 be understood as normal vim English characters (according to the
4456 langmap mappings) in the following cases:
4457 o Normal/Visual mode (commands, buffer/register names, user mappings)
4458 o Insert/Replace Mode: Register names after CTRL-R
4459 o Insert/Replace Mode: Mappings
4460 Characters entered in Command-line mode will NOT be affected by
4461 this option. Note that this option can be changed at any time
4462 allowing to switch between mappings for different languages/encodings.
4463 Use a mapping to avoid having to type it each time!
4464
4465 *'langmenu'* *'lm'*
4466'langmenu' 'lm' string (default "")
4467 global
4468 {not in Vi}
4469 {only available when compiled with the |+menu| and
4470 |+multi_lang| features}
4471 Language to use for menu translation. Tells which file is loaded
4472 from the "lang" directory in 'runtimepath': >
4473 "lang/menu_" . &langmenu . ".vim"
4474< (without the spaces). For example, to always use the Dutch menus, no
4475 matter what $LANG is set to: >
4476 :set langmenu=nl_NL.ISO_8859-1
4477< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004478 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 If your $LANG is set to a non-English language but you do want to use
4480 the English menus: >
4481 :set langmenu=none
4482< This option must be set before loading menus, switching on filetype
4483 detection or syntax highlighting. Once the menus are defined setting
4484 this option has no effect. But you could do this: >
4485 :source $VIMRUNTIME/delmenu.vim
4486 :set langmenu=de_DE.ISO_8859-1
4487 :source $VIMRUNTIME/menu.vim
4488< Warning: This deletes all menus that you defined yourself!
4489
4490 *'laststatus'* *'ls'*
4491'laststatus' 'ls' number (default 1)
4492 global
4493 {not in Vi}
4494 The value of this option influences when the last window will have a
4495 status line:
4496 0: never
4497 1: only if there are at least two windows
4498 2: always
4499 The screen looks nicer with a status line if you have several
4500 windows, but it takes another screen line. |status-line|
4501
4502 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4503'lazyredraw' 'lz' boolean (default off)
4504 global
4505 {not in Vi}
4506 When this option is set, the screen will not be redrawn while
4507 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004508 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 update use |:redraw|.
4510
4511 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4512'linebreak' 'lbr' boolean (default off)
4513 local to window
4514 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004515 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516 feature}
4517 If on Vim will wrap long lines at a character in 'breakat' rather
4518 than at the last character that fits on the screen. Unlike
4519 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4520 it only affects the way the file is displayed, not its contents. The
4521 value of 'showbreak' is used to put in front of wrapped lines.
4522 This option is not used when the 'wrap' option is off or 'list' is on.
4523 Note that <Tab> characters after an <EOL> are mostly not displayed
4524 with the right amount of white space.
4525
4526 *'lines'* *E593*
4527'lines' number (default 24 or terminal height)
4528 global
4529 Number of lines of the Vim window.
4530 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004531 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532 When Vim is running in the GUI or in a resizable window, setting this
4533 option will cause the window size to be changed. When you only want
4534 to use the size for the GUI, put the command in your |gvimrc| file.
4535 Vim limits the number of lines to what fits on the screen. You can
4536 use this command to get the tallest window possible: >
4537 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004538< Minimum value is 2, maximum value is 1000.
4539 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540 When you set this option and Vim is unable to change the physical
4541 number of lines of the display, the display may be messed up.
4542
4543 *'linespace'* *'lsp'*
4544'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4545 global
4546 {not in Vi}
4547 {only in the GUI}
4548 Number of pixel lines inserted between characters. Useful if the font
4549 uses the full character cell height, making lines touch each other.
4550 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004551 With some fonts there can be too much room between lines (to have
4552 space for ascents and descents). Then it makes sense to set
4553 'linespace' to a negative value. This may cause display problems
4554 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555
4556 *'lisp'* *'nolisp'*
4557'lisp' boolean (default off)
4558 local to buffer
4559 {not available when compiled without the |+lispindent|
4560 feature}
4561 Lisp mode: When <Enter> is typed in insert mode set the indent for
4562 the next line to Lisp standards (well, sort of). Also happens with
4563 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4564 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4565 better. Also see 'lispwords'.
4566 The '-' character is included in keyword characters. Redefines the
4567 "=" operator to use this same indentation algorithm rather than
4568 calling an external program if 'equalprg' is empty.
4569 This option is not used when 'paste' is set.
4570 {Vi: Does it a little bit differently}
4571
4572 *'lispwords'* *'lw'*
4573'lispwords' 'lw' string (default is very long)
4574 global
4575 {not in Vi}
4576 {not available when compiled without the |+lispindent|
4577 feature}
4578 Comma separated list of words that influence the Lisp indenting.
4579 |'lisp'|
4580
4581 *'list'* *'nolist'*
4582'list' boolean (default off)
4583 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004584 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4585 line. Useful to see the difference between tabs and spaces and for
4586 trailing blanks. Further changed by the 'listchars' option.
4587
4588 The cursor is displayed at the start of the space a Tab character
4589 occupies, not at the end as usual in Normal mode. To get this cursor
4590 position while displaying Tabs with spaces, use: >
4591 :set list lcs=tab\ \
4592<
4593 Note that list mode will also affect formatting (set with 'textwidth'
4594 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595 changing the way tabs are displayed.
4596
4597 *'listchars'* *'lcs'*
4598'listchars' 'lcs' string (default "eol:$")
4599 global
4600 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004601 Strings to use in 'list' mode and for the |:list| command. It is a
4602 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004603 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 eol:c Character to show at the end of each line. When
4605 omitted, there is no extra character at the end of the
4606 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004607 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004608 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004609 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004610 fill the space that the tab normally occupies.
4611 "tab:>-" will show a tab that takes four spaces as
4612 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004613 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004614 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004616 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 extends:c Character to show in the last column, when 'wrap' is
4618 off and the line continues beyond the right of the
4619 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004620 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 precedes:c Character to show in the first column, when 'wrap'
4622 is off and there is text preceding the character
4623 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004624 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004625 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004626 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004627 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004628 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004629 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004631 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004633 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634
4635 Examples: >
4636 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004637 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 :set lcs=extends:>,precedes:<
4639< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004640 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004641 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004642
4643 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4644'loadplugins' 'lpl' boolean (default on)
4645 global
4646 {not in Vi}
4647 When on the plugin scripts are loaded when starting up |load-plugins|.
4648 This option can be reset in your |vimrc| file to disable the loading
4649 of plugins.
4650 Note that using the "-u NONE" and "--noplugin" command line arguments
4651 reset this option. |-u| |--noplugin|
4652
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004653 *'macatsui'* *'nomacatsui'*
4654'macatsui' boolean (default on)
4655 global
4656 {only available in Mac GUI version}
4657 This is a workaround for when drawing doesn't work properly. When set
4658 and compiled with multi-byte support ATSUI text drawing is used. When
4659 not set ATSUI text drawing is not used. Switch this option off when
4660 you experience drawing problems. In a future version the problems may
4661 be solved and this option becomes obsolete. Therefore use this method
4662 to unset it: >
4663 if exists('&macatsui')
4664 set nomacatsui
4665 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004666< Another option to check if you have drawing problems is
4667 'termencoding'.
4668
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669 *'magic'* *'nomagic'*
4670'magic' boolean (default on)
4671 global
4672 Changes the special characters that can be used in search patterns.
4673 See |pattern|.
4674 NOTE: To avoid portability problems with using patterns, always keep
4675 this option at the default "on". Only switch it off when working with
4676 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004677 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678
4679 *'makeef'* *'mef'*
4680'makeef' 'mef' string (default: "")
4681 global
4682 {not in Vi}
4683 {not available when compiled without the |+quickfix|
4684 feature}
4685 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4686 and the |:grep| command.
4687 When it is empty, an internally generated temp file will be used.
4688 When "##" is included, it is replaced by a number to make the name
4689 unique. This makes sure that the ":make" command doesn't overwrite an
4690 existing file.
4691 NOT used for the ":cf" command. See 'errorfile' for that.
4692 Environment variables are expanded |:set_env|.
4693 See |option-backslash| about including spaces and backslashes.
4694 This option cannot be set from a |modeline| or in the |sandbox|, for
4695 security reasons.
4696
4697 *'makeprg'* *'mp'*
4698'makeprg' 'mp' string (default "make", VMS: "MMS")
4699 global or local to buffer |global-local|
4700 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004701 Program to use for the ":make" command. See |:make_makeprg|.
4702 This option may contain '%' and '#' characters, which are expanded to
4703 the current and alternate file name. |:_%| |:_#|
4704 Environment variables are expanded |:set_env|. See |option-backslash|
4705 about including spaces and backslashes.
4706 Note that a '|' must be escaped twice: once for ":set" and once for
4707 the interpretation of a command. When you use a filter called
4708 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709 :set makeprg=gmake\ \\\|\ myfilter
4710< The placeholder "$*" can be given (even multiple times) to specify
4711 where the arguments will be included, for example: >
4712 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4713< This option cannot be set from a |modeline| or in the |sandbox|, for
4714 security reasons.
4715
4716 *'matchpairs'* *'mps'*
4717'matchpairs' 'mps' string (default "(:),{:},[:]")
4718 local to buffer
4719 {not in Vi}
4720 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004721 other.
4722 Only character pairs are allowed that are different, thus you cannot
4723 jump between two double quotes.
4724 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004725 The pairs must be separated by a comma. Example for including '<' and
4726 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 :set mps+=<:>
4728
4729< A more exotic example, to jump between the '=' and ';' in an
4730 assignment, useful for languages like C and Java: >
4731 :au FileType c,cpp,java set mps+==:;
4732
4733< For a more advanced way of using "%", see the matchit.vim plugin in
4734 the $VIMRUNTIME/macros directory. |add-local-help|
4735
4736 *'matchtime'* *'mat'*
4737'matchtime' 'mat' number (default 5)
4738 global
4739 {not in Vi}{in Nvi}
4740 Tenths of a second to show the matching paren, when 'showmatch' is
4741 set. Note that this is not in milliseconds, like other options that
4742 set a time. This is to be compatible with Nvi.
4743
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004744 *'maxcombine'* *'mco'*
4745'maxcombine' 'mco' number (default 2)
4746 global
4747 {not in Vi}
4748 {only available when compiled with the |+multi_byte|
4749 feature}
4750 The maximum number of combining characters supported for displaying.
4751 Only used when 'encoding' is "utf-8".
4752 The default is OK for most languages. Hebrew may require 4.
4753 Maximum value is 6.
4754 Even when this option is set to 2 you can still edit text with more
4755 combining characters, you just can't see them. Use |g8| or |ga|.
4756 See |mbyte-combining|.
4757
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758 *'maxfuncdepth'* *'mfd'*
4759'maxfuncdepth' 'mfd' number (default 100)
4760 global
4761 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004762 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004763 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 Maximum depth of function calls for user functions. This normally
4765 catches endless recursion. When using a recursive function with
4766 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4767 more memory, there is the danger of failing when memory is exhausted.
4768 See also |:function|.
4769
4770 *'maxmapdepth'* *'mmd'* *E223*
4771'maxmapdepth' 'mmd' number (default 1000)
4772 global
4773 {not in Vi}
4774 Maximum number of times a mapping is done without resulting in a
4775 character to be used. This normally catches endless mappings, like
4776 ":map x y" with ":map y x". It still does not catch ":map g wg",
4777 because the 'w' is used before the next mapping is done. See also
4778 |key-mapping|.
4779
4780 *'maxmem'* *'mm'*
4781'maxmem' 'mm' number (default between 256 to 5120 (system
4782 dependent) or half the amount of memory
4783 available)
4784 global
4785 {not in Vi}
4786 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4787 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004788 other memory to be freed. The maximum usable value is about 2000000.
4789 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004791 *'maxmempattern'* *'mmp'*
4792'maxmempattern' 'mmp' number (default 1000)
4793 global
4794 {not in Vi}
4795 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004796 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004797 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004798 When Vim runs into the limit it gives an error message and mostly
4799 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004800 Running into the limit often means that the pattern is very
4801 inefficient or too complex. This may already happen with the pattern
4802 "\(.\)*" on a very long line. ".*" works much better.
4803 Vim may run out of memory before hitting the 'maxmempattern' limit.
4804
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 *'maxmemtot'* *'mmt'*
4806'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4807 dependent) or half the amount of memory
4808 available)
4809 global
4810 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004811 Maximum amount of memory in Kbyte to use for all buffers together.
4812 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4813 without a limit. On 64 bit machines higher values might work. But
4814 hey, do you really need more than 2 Gbyte for text editing?
4815 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816
4817 *'menuitems'* *'mis'*
4818'menuitems' 'mis' number (default 25)
4819 global
4820 {not in Vi}
4821 {not available when compiled without the |+menu|
4822 feature}
4823 Maximum number of items to use in a menu. Used for menus that are
4824 generated from a list of items, e.g., the Buffers menu. Changing this
4825 option has no direct effect, the menu must be refreshed first.
4826
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004827 *'mkspellmem'* *'msm'*
4828'mkspellmem' 'msm' string (default "460000,2000,500")
4829 global
4830 {not in Vi}
4831 {not available when compiled without the |+syntax|
4832 feature}
4833 Parameters for |:mkspell|. This tunes when to start compressing the
4834 word tree. Compression can be slow when there are many words, but
4835 it's needed to avoid running out of memory. The amount of memory used
4836 per word depends very much on how similar the words are, that's why
4837 this tuning is complicated.
4838
4839 There are three numbers, separated by commas:
4840 {start},{inc},{added}
4841
4842 For most languages the uncompressed word tree fits in memory. {start}
4843 gives the amount of memory in Kbyte that can be used before any
4844 compression is done. It should be a bit smaller than the amount of
4845 memory that is available to Vim.
4846
4847 When going over the {start} limit the {inc} number specifies the
4848 amount of memory in Kbyte that can be allocated before another
4849 compression is done. A low number means compression is done after
4850 less words are added, which is slow. A high number means more memory
4851 will be allocated.
4852
4853 After doing compression, {added} times 1024 words can be added before
4854 the {inc} limit is ignored and compression is done when any extra
4855 amount of memory is needed. A low number means there is a smaller
4856 chance of hitting the {inc} limit, less memory is used but it's
4857 slower.
4858
4859 The languages for which these numbers are important are Italian and
4860 Hungarian. The default works for when you have about 512 Mbyte. If
4861 you have 1 Gbyte you could use: >
4862 :set mkspellmem=900000,3000,800
4863< If you have less than 512 Mbyte |:mkspell| may fail for some
4864 languages, no matter what you set 'mkspellmem' to.
4865
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004867'modeline' 'ml' boolean (Vim default: on (off for root),
4868 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 local to buffer
4870 *'modelines'* *'mls'*
4871'modelines' 'mls' number (default 5)
4872 global
4873 {not in Vi}
4874 If 'modeline' is on 'modelines' gives the number of lines that is
4875 checked for set commands. If 'modeline' is off or 'modelines' is zero
4876 no lines are checked. See |modeline|.
4877 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4878 set and to the Vim default value when 'compatible' is reset.
4879
4880 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4881'modifiable' 'ma' boolean (default on)
4882 local to buffer
4883 {not in Vi} *E21*
4884 When off the buffer contents cannot be changed. The 'fileformat' and
4885 'fileencoding' options also can't be changed.
4886 Can be reset with the |-M| command line argument.
4887
4888 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4889'modified' 'mod' boolean (default off)
4890 local to buffer
4891 {not in Vi}
4892 When on, the buffer is considered to be modified. This option is set
4893 when:
4894 1. A change was made to the text since it was last written. Using the
4895 |undo| command to go back to the original text will reset the
4896 option. But undoing changes that were made before writing the
4897 buffer will set the option again, since the text is different from
4898 when it was written.
4899 2. 'fileformat' or 'fileencoding' is different from its original
4900 value. The original value is set when the buffer is read or
4901 written. A ":set nomodified" command also resets the original
4902 values to the current values and the 'modified' option will be
4903 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004904 This option is not set when a change is made to the buffer as the
4905 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4906 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4907 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4909 will be ignored.
4910
4911 *'more'* *'nomore'*
4912'more' boolean (Vim default: on, Vi default: off)
4913 global
4914 {not in Vi}
4915 When on, listings pause when the whole screen is filled. You will get
4916 the |more-prompt|. When this option is off there are no pauses, the
4917 listing continues until finished.
4918 NOTE: This option is set to the Vi default value when 'compatible' is
4919 set and to the Vim default value when 'compatible' is reset.
4920
4921 *'mouse'* *E538*
4922'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4923 global
4924 {not in Vi}
4925 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004926 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4927 sysmouse and Linux console with gpm). For using the mouse in the
4928 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 The mouse can be enabled for different modes:
4930 n Normal mode
4931 v Visual mode
4932 i Insert mode
4933 c Command-line mode
4934 h all previous modes when editing a help file
4935 a all previous modes
4936 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 Normally you would enable the mouse in all four modes with: >
4938 :set mouse=a
4939< When the mouse is not enabled, the GUI will still use the mouse for
4940 modeless selection. This doesn't move the text cursor.
4941
4942 See |mouse-using|. Also see |'clipboard'|.
4943
4944 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004945 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 the mouse buttons can still be used by keeping the shift key pressed.
4947 Also see the 'clipboard' option.
4948
4949 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4950'mousefocus' 'mousef' boolean (default off)
4951 global
4952 {not in Vi}
4953 {only works in the GUI}
4954 The window that the mouse pointer is on is automatically activated.
4955 When changing the window layout or window focus in another way, the
4956 mouse pointer is moved to the window with keyboard focus. Off is the
4957 default because it makes using the pull down menus a little goofy, as
4958 a pointer transit may activate a window unintentionally.
4959
4960 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4961'mousehide' 'mh' boolean (default on)
4962 global
4963 {not in Vi}
4964 {only works in the GUI}
4965 When on, the mouse pointer is hidden when characters are typed.
4966 The mouse pointer is restored when the mouse is moved.
4967
4968 *'mousemodel'* *'mousem'*
4969'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4970 global
4971 {not in Vi}
4972 Sets the model to use for the mouse. The name mostly specifies what
4973 the right mouse button is used for:
4974 extend Right mouse button extends a selection. This works
4975 like in an xterm.
4976 popup Right mouse button pops up a menu. The shifted left
4977 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004978 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 popup_setpos Like "popup", but the cursor will be moved to the
4980 position where the mouse was clicked, and thus the
4981 selected operation will act upon the clicked object.
4982 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004983 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004984 course, that right clicking outside a selection will
4985 end Visual mode.
4986 Overview of what button does what for each model:
4987 mouse extend popup(_setpos) ~
4988 left click place cursor place cursor
4989 left drag start selection start selection
4990 shift-left search word extend selection
4991 right click extend selection popup menu (place cursor)
4992 right drag extend selection -
4993 middle click paste paste
4994
4995 In the "popup" model the right mouse button produces a pop-up menu.
4996 You need to define this first, see |popup-menu|.
4997
4998 Note that you can further refine the meaning of buttons with mappings.
4999 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5000 selection (because that's handled in the GUI code directly).
5001
5002 The 'mousemodel' option is set by the |:behave| command.
5003
5004 *'mouseshape'* *'mouses'* *E547*
5005'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005006 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 global
5008 {not in Vi}
5009 {only available when compiled with the |+mouseshape|
5010 feature}
5011 This option tells Vim what the mouse pointer should look like in
5012 different modes. The option is a comma separated list of parts, much
5013 like used for 'guicursor'. Each part consist of a mode/location-list
5014 and an argument-list:
5015 mode-list:shape,mode-list:shape,..
5016 The mode-list is a dash separated list of these modes/locations:
5017 In a normal window: ~
5018 n Normal mode
5019 v Visual mode
5020 ve Visual mode with 'selection' "exclusive" (same as 'v',
5021 if not specified)
5022 o Operator-pending mode
5023 i Insert mode
5024 r Replace mode
5025
5026 Others: ~
5027 c appending to the command-line
5028 ci inserting in the command-line
5029 cr replacing in the command-line
5030 m at the 'Hit ENTER' or 'More' prompts
5031 ml idem, but cursor in the last line
5032 e any mode, pointer below last window
5033 s any mode, pointer on a status line
5034 sd any mode, while dragging a status line
5035 vs any mode, pointer on a vertical separator line
5036 vd any mode, while dragging a vertical separator line
5037 a everywhere
5038
5039 The shape is one of the following:
5040 avail name looks like ~
5041 w x arrow Normal mouse pointer
5042 w x blank no pointer at all (use with care!)
5043 w x beam I-beam
5044 w x updown up-down sizing arrows
5045 w x leftright left-right sizing arrows
5046 w x busy The system's usual busy pointer
5047 w x no The system's usual 'no input' pointer
5048 x udsizing indicates up-down resizing
5049 x lrsizing indicates left-right resizing
5050 x crosshair like a big thin +
5051 x hand1 black hand
5052 x hand2 white hand
5053 x pencil what you write with
5054 x question big ?
5055 x rightup-arrow arrow pointing right-up
5056 w x up-arrow arrow pointing up
5057 x <number> any X11 pointer number (see X11/cursorfont.h)
5058
5059 The "avail" column contains a 'w' if the shape is available for Win32,
5060 x for X11.
5061 Any modes not specified or shapes not available use the normal mouse
5062 pointer.
5063
5064 Example: >
5065 :set mouseshape=s:udsizing,m:no
5066< will make the mouse turn to a sizing arrow over the status lines and
5067 indicate no input when the hit-enter prompt is displayed (since
5068 clicking the mouse has no effect in this state.)
5069
5070 *'mousetime'* *'mouset'*
5071'mousetime' 'mouset' number (default 500)
5072 global
5073 {not in Vi}
5074 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5075 time in msec between two mouse clicks for the second click to be
5076 recognized as a multi click.
5077
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005078 *'mzquantum'* *'mzq'*
5079'mzquantum' 'mzq' number (default 100)
5080 global
5081 {not in Vi}
5082 {not available when compiled without the |+mzscheme|
5083 feature}
5084 The number of milliseconds between polls for MzScheme threads.
5085 Negative or zero value means no thread scheduling.
5086
Bram Moolenaar071d4272004-06-13 20:20:40 +00005087 *'nrformats'* *'nf'*
5088'nrformats' 'nf' string (default "octal,hex")
5089 local to buffer
5090 {not in Vi}
5091 This defines what bases Vim will consider for numbers when using the
5092 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5093 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005094 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005095 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005096 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005097 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005099 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 considered to be hexadecimal. Example: Using CTRL-X on
5101 "0x100" results in "0x0ff".
5102 Numbers which simply begin with a digit in the range 1-9 are always
5103 considered decimal. This also happens for numbers that are not
5104 recognized as octal or hex.
5105
5106 *'number'* *'nu'* *'nonumber'* *'nonu'*
5107'number' 'nu' boolean (default off)
5108 local to window
5109 Print the line number in front of each line. When the 'n' option is
5110 excluded from 'cpoptions' a wrapped line will not use the column of
5111 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005112 The 'numberwidth' option can be used to set the room used for the line
5113 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 When a long, wrapped line doesn't start with the first character, '-'
5115 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005116 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5117 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005118 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005120 *'numberwidth'* *'nuw'*
5121'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5122 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005123 {not in Vi}
5124 {only available when compiled with the |+linebreak|
5125 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005126 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005127 when the 'number' or 'relativenumber' option is set or printing lines
5128 with a line number. Since one space is always between the number and
5129 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005130 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005131 fit the highest line number in the buffer respectively the number of
5132 rows in the window, depending on whether 'number' or 'relativenumber'
5133 is set. Thus with the Vim default of 4 there is room for a line number
5134 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005135 The minimum value is 1, the maximum value is 10.
5136 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5137
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005138 *'omnifunc'* *'ofu'*
5139'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005140 local to buffer
5141 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005142 {not available when compiled without the |+eval|
5143 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005144 This option specifies a function to be used for Insert mode omni
5145 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005146 See |complete-functions| for an explanation of how the function is
5147 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005148 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005149 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005150 This option cannot be set from a |modeline| or in the |sandbox|, for
5151 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005152
5153
Bram Moolenaar02467872007-05-06 13:22:01 +00005154 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005155'opendevice' 'odev' boolean (default off)
5156 global
5157 {not in Vi}
5158 {only for MS-DOS, MS-Windows and OS/2}
5159 Enable reading and writing from devices. This may get Vim stuck on a
5160 device that can be opened but doesn't actually do the I/O. Therefore
5161 it is off by default.
5162 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5163 result in editing a device.
5164
5165
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005166 *'operatorfunc'* *'opfunc'*
5167'operatorfunc' 'opfunc' string (default: empty)
5168 global
5169 {not in Vi}
5170 This option specifies a function to be called by the |g@| operator.
5171 See |:map-operator| for more info and an example.
5172
5173 This option cannot be set from a |modeline| or in the |sandbox|, for
5174 security reasons.
5175
5176
Bram Moolenaar251e1912011-06-19 05:09:16 +02005177 *'osfiletype'* *'oft'*
5178'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 local to buffer
5180 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005181 This option was supported on RISC OS, which has been removed.
5182
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183
5184 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005185'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 global
5187 Specifies the nroff macros that separate paragraphs. These are pairs
5188 of two letters (see |object-motions|).
5189
5190 *'paste'* *'nopaste'*
5191'paste' boolean (default off)
5192 global
5193 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005194 Put Vim in Paste mode. This is useful if you want to cut or copy
5195 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 unexpected effects.
5197 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005198 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 knows about pasting and will mostly do the right thing without 'paste'
5200 being set. The same is true for a terminal where Vim handles the
5201 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005202 This option is reset when starting the GUI. Thus if you set it in
5203 your .vimrc it will work in a terminal, but not in the GUI. Setting
5204 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5205 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 When the 'paste' option is switched on (also when it was already on):
5207 - mapping in Insert mode and Command-line mode is disabled
5208 - abbreviations are disabled
5209 - 'textwidth' is set to 0
5210 - 'wrapmargin' is set to 0
5211 - 'autoindent' is reset
5212 - 'smartindent' is reset
5213 - 'softtabstop' is set to 0
5214 - 'revins' is reset
5215 - 'ruler' is reset
5216 - 'showmatch' is reset
5217 - 'formatoptions' is used like it is empty
5218 These options keep their value, but their effect is disabled:
5219 - 'lisp'
5220 - 'indentexpr'
5221 - 'cindent'
5222 NOTE: When you start editing another file while the 'paste' option is
5223 on, settings from the modelines or autocommands may change the
5224 settings again, causing trouble when pasting text. You might want to
5225 set the 'paste' option again.
5226 When the 'paste' option is reset the mentioned options are restored to
5227 the value before the moment 'paste' was switched from off to on.
5228 Resetting 'paste' before ever setting it does not have any effect.
5229 Since mapping doesn't work while 'paste' is active, you need to use
5230 the 'pastetoggle' option to toggle the 'paste' option with some key.
5231
5232 *'pastetoggle'* *'pt'*
5233'pastetoggle' 'pt' string (default "")
5234 global
5235 {not in Vi}
5236 When non-empty, specifies the key sequence that toggles the 'paste'
5237 option. This is like specifying a mapping: >
5238 :map {keys} :set invpaste<CR>
5239< Where {keys} is the value of 'pastetoggle'.
5240 The difference is that it will work even when 'paste' is set.
5241 'pastetoggle' works in Insert mode and Normal mode, but not in
5242 Command-line mode.
5243 Mappings are checked first, thus overrule 'pastetoggle'. However,
5244 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5245 this: >
5246 :map <F10> :set paste<CR>
5247 :map <F11> :set nopaste<CR>
5248 :imap <F10> <C-O>:set paste<CR>
5249 :imap <F11> <nop>
5250 :set pastetoggle=<F11>
5251< This will make <F10> start paste mode and <F11> stop paste mode.
5252 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5253 mode everything is inserted literally, except the 'pastetoggle' key
5254 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005255 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256
5257 *'pex'* *'patchexpr'*
5258'patchexpr' 'pex' string (default "")
5259 global
5260 {not in Vi}
5261 {not available when compiled without the |+diff|
5262 feature}
5263 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005264 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005265
5266 *'patchmode'* *'pm'* *E206*
5267'patchmode' 'pm' string (default "")
5268 global
5269 {not in Vi}
5270 When non-empty the oldest version of a file is kept. This can be used
5271 to keep the original version of a file if you are changing files in a
5272 source distribution. Only the first time that a file is written a
5273 copy of the original file will be kept. The name of the copy is the
5274 name of the original file with the string in the 'patchmode' option
5275 appended. This option should start with a dot. Use a string like
5276 ".org". 'backupdir' must not be empty for this to work (Detail: The
5277 backup file is renamed to the patchmode file after the new file has
5278 been successfully written, that's why it must be possible to write a
5279 backup file). If there was no file to be backed up, an empty file is
5280 created.
5281 When the 'backupskip' pattern matches, a patchmode file is not made.
5282 Using 'patchmode' for compressed files appends the extension at the
5283 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5284 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005285 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005286
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005287 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288'path' 'pa' string (default on Unix: ".,/usr/include,,"
5289 on OS/2: ".,/emx/include,,"
5290 other systems: ".,,")
5291 global or local to buffer |global-local|
5292 {not in Vi}
5293 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005294 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5295 provided that the file being searched for has a relative path (not
5296 starting with "/", "./" or "../"). The directories in the 'path'
5297 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 - Use commas to separate directory names: >
5299 :set path=.,/usr/local/include,/usr/include
5300< - Spaces can also be used to separate directory names (for backwards
5301 compatibility with version 3.0). To have a space in a directory
5302 name, precede it with an extra backslash, and escape the space: >
5303 :set path=.,/dir/with\\\ space
5304< - To include a comma in a directory name precede it with an extra
5305 backslash: >
5306 :set path=.,/dir/with\\,comma
5307< - To search relative to the directory of the current file, use: >
5308 :set path=.
5309< - To search in the current directory use an empty string between two
5310 commas: >
5311 :set path=,,
5312< - A directory name may end in a ':' or '/'.
5313 - Environment variables are expanded |:set_env|.
5314 - When using |netrw.vim| URLs can be used. For example, adding
5315 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005316 - Search upwards and downwards in a directory tree using "*", "**" and
5317 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 {not available when compiled without the |+path_extra| feature}
5319 - Careful with '\' characters, type two to get one in the option: >
5320 :set path=.,c:\\include
5321< Or just use '/' instead: >
5322 :set path=.,c:/include
5323< Don't forget "." or files won't even be found in the same directory as
5324 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005325 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326 it is something like 256 or 1024 characters.
5327 You can check if all the include files are found, using the value of
5328 'path', see |:checkpath|.
5329 The use of |:set+=| and |:set-=| is preferred when adding or removing
5330 directories from the list. This avoids problems when a future version
5331 uses another default. To remove the current directory use: >
5332 :set path-=
5333< To add the current directory use: >
5334 :set path+=
5335< To use an environment variable, you probably need to replace the
5336 separator. Here is an example to append $INCL, in which directory
5337 names are separated with a semi-colon: >
5338 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5339< Replace the ';' with a ':' or whatever separator is used. Note that
5340 this doesn't work when $INCL contains a comma or white space.
5341
5342 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5343'preserveindent' 'pi' boolean (default off)
5344 local to buffer
5345 {not in Vi}
5346 When changing the indent of the current line, preserve as much of the
5347 indent structure as possible. Normally the indent is replaced by a
5348 series of tabs followed by spaces as required (unless |'expandtab'| is
5349 enabled, in which case only spaces are used). Enabling this option
5350 means the indent will preserve as many existing characters as possible
5351 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005352 'expandtab' does not apply to the preserved white space, a Tab remains
5353 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 NOTE: When using ">>" multiple times the resulting indent is a mix of
5355 tabs and spaces. You might not like this.
5356 NOTE: 'preserveindent' is reset when 'compatible' is set.
5357 Also see 'copyindent'.
5358 Use |:retab| to clean up white space.
5359
5360 *'previewheight'* *'pvh'*
5361'previewheight' 'pvh' number (default 12)
5362 global
5363 {not in Vi}
5364 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005365 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 Default height for a preview window. Used for |:ptag| and associated
5367 commands. Used for |CTRL-W_}| when no count is given.
5368
5369 *'previewwindow'* *'nopreviewwindow'*
5370 *'pvw'* *'nopvw'* *E590*
5371'previewwindow' 'pvw' boolean (default off)
5372 local to window
5373 {not in Vi}
5374 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005375 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005376 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 set. It's normally not set directly, but by using one of the commands
5378 |:ptag|, |:pedit|, etc.
5379
5380 *'printdevice'* *'pdev'*
5381'printdevice' 'pdev' string (default empty)
5382 global
5383 {not in Vi}
5384 {only available when compiled with the |+printer|
5385 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005386 The name of the printer to be used for |:hardcopy|.
5387 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005388 This option cannot be set from a |modeline| or in the |sandbox|, for
5389 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
Bram Moolenaar8299df92004-07-10 09:47:34 +00005391 *'printencoding'* *'penc'*
5392'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 global
5394 {not in Vi}
5395 {only available when compiled with the |+printer|
5396 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005397 Sets the character encoding used when printing.
5398 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
5400 *'printexpr'* *'pexpr'*
5401'printexpr' 'pexpr' String (default: see below)
5402 global
5403 {not in Vi}
5404 {only available when compiled with the |+printer|
5405 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005406 Expression used to print the PostScript produced with |:hardcopy|.
5407 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408
Bram Moolenaar8299df92004-07-10 09:47:34 +00005409 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410'printfont' 'pfn' string (default "courier")
5411 global
5412 {not in Vi}
5413 {only available when compiled with the |+printer|
5414 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005415 The name of the font that will be used for |:hardcopy|.
5416 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417
5418 *'printheader'* *'pheader'*
5419'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5420 global
5421 {not in Vi}
5422 {only available when compiled with the |+printer|
5423 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005424 The format of the header produced in |:hardcopy| output.
5425 See |pheader-option|.
5426
5427 *'printmbcharset'* *'pmbcs'*
5428'printmbcharset' 'pmbcs' string (default "")
5429 global
5430 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005431 {only available when compiled with the |+printer|,
5432 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005433 The CJK character set to be used for CJK output from |:hardcopy|.
5434 See |pmbcs-option|.
5435
5436 *'printmbfont'* *'pmbfn'*
5437'printmbfont' 'pmbfn' string (default "")
5438 global
5439 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005440 {only available when compiled with the |+printer|,
5441 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005442 List of font names to be used for CJK output from |:hardcopy|.
5443 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444
5445 *'printoptions'* *'popt'*
5446'printoptions' 'popt' string (default "")
5447 global
5448 {not in Vi}
5449 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005450 List of items that control the format of the output of |:hardcopy|.
5451 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005453 *'prompt'* *'noprompt'*
5454'prompt' boolean (default on)
5455 global
5456 When on a ":" prompt is used in Ex mode.
5457
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005458 *'pumheight'* *'ph'*
5459'pumheight' 'ph' number (default 0)
5460 global
5461 {not available when compiled without the
5462 |+insert_expand| feature}
5463 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005464 Determines the maximum number of items to show in the popup menu for
5465 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005466 |ins-completion-menu|.
5467
5468
Bram Moolenaar677ee682005-01-27 14:41:15 +00005469 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005470'quoteescape' 'qe' string (default "\")
5471 local to buffer
5472 {not in Vi}
5473 The characters that are used to escape quotes in a string. Used for
5474 objects like a', a" and a` |a'|.
5475 When one of the characters in this option is found inside a string,
5476 the following character will be skipped. The default value makes the
5477 text "foo\"bar\\" considered to be one string.
5478
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5480'readonly' 'ro' boolean (default off)
5481 local to buffer
5482 If on, writes fail unless you use a '!'. Protects you from
5483 accidentally overwriting a file. Default on when Vim is started
5484 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005485 When using ":w!" the 'readonly' option is reset for the current
5486 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005488 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005490 *'redrawtime'* *'rdt'*
5491'redrawtime' 'rdt' number (default 2000)
5492 global
5493 {not in Vi}
5494 {only available when compiled with the |+reltime|
5495 feature}
5496 The time in milliseconds for redrawing the display. This applies to
5497 searching for patterns for 'hlsearch' and |:match| highlighting.
5498 When redrawing takes more than this many milliseconds no further
5499 matches will be highlighted. This is used to avoid that Vim hangs
5500 when using a very complicated pattern.
5501
Bram Moolenaar64486672010-05-16 15:46:46 +02005502 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5503'relativenumber' 'rnu' boolean (default off)
5504 local to window
5505 {not in Vi}
5506 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005507 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005508 precede some vertical motion commands (e.g. j k + -) with, without
5509 having to calculate it yourself. Especially useful in combination with
5510 other commands (e.g. y d c < > gq gw =).
5511 When the 'n' option is excluded from 'cpoptions' a wrapped
5512 line will not use the column of line numbers (this is the default when
5513 'compatible' isn't set).
5514 The 'numberwidth' option can be used to set the room used for the line
5515 number.
5516 When a long, wrapped line doesn't start with the first character, '-'
5517 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005518 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5519 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005520 When setting this option, 'number' is reset.
5521
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 *'remap'* *'noremap'*
5523'remap' boolean (default on)
5524 global
5525 Allows for mappings to work recursively. If you do not want this for
5526 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005527 NOTE: To avoid portability problems with Vim scripts, always keep
5528 this option at the default "on". Only switch it off when working with
5529 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530
5531 *'report'*
5532'report' number (default 2)
5533 global
5534 Threshold for reporting number of lines changed. When the number of
5535 changed lines is more than 'report' a message will be given for most
5536 ":" commands. If you want it always, set 'report' to 0.
5537 For the ":substitute" command the number of substitutions is used
5538 instead of the number of lines.
5539
5540 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5541'restorescreen' 'rs' boolean (default on)
5542 global
5543 {not in Vi} {only in Windows 95/NT console version}
5544 When set, the screen contents is restored when exiting Vim. This also
5545 happens when executing external commands.
5546
5547 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5548 options in your .vimrc. To disable restoring:
5549 set t_ti= t_te=
5550 To enable restoring (for an xterm):
5551 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5552 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5553
5554 *'revins'* *'ri'* *'norevins'* *'nori'*
5555'revins' 'ri' boolean (default off)
5556 global
5557 {not in Vi}
5558 {only available when compiled with the |+rightleft|
5559 feature}
5560 Inserting characters in Insert mode will work backwards. See "typing
5561 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5562 command in Insert mode, when 'allowrevins' is set.
5563 NOTE: This option is reset when 'compatible' or 'paste' is set.
5564
5565 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5566'rightleft' 'rl' boolean (default off)
5567 local to window
5568 {not in Vi}
5569 {only available when compiled with the |+rightleft|
5570 feature}
5571 When on, display orientation becomes right-to-left, i.e., characters
5572 that are stored in the file appear from the right to the left.
5573 Using this option, it is possible to edit files for languages that
5574 are written from the right to the left such as Hebrew and Arabic.
5575 This option is per window, so it is possible to edit mixed files
5576 simultaneously, or to view the same file in both ways (this is
5577 useful whenever you have a mixed text file with both right-to-left
5578 and left-to-right strings so that both sets are displayed properly
5579 in different windows). Also see |rileft.txt|.
5580
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005581 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582'rightleftcmd' 'rlc' string (default "search")
5583 local to window
5584 {not in Vi}
5585 {only available when compiled with the |+rightleft|
5586 feature}
5587 Each word in this option enables the command line editing to work in
5588 right-to-left mode for a group of commands:
5589
5590 search "/" and "?" commands
5591
5592 This is useful for languages such as Hebrew, Arabic and Farsi.
5593 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5594
5595 *'ruler'* *'ru'* *'noruler'* *'noru'*
5596'ruler' 'ru' boolean (default off)
5597 global
5598 {not in Vi}
5599 {not available when compiled without the
5600 |+cmdline_info| feature}
5601 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005602 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 text in the file is shown on the far right:
5604 Top first line is visible
5605 Bot last line is visible
5606 All first and last line are visible
5607 45% relative position in the file
5608 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005609 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005610 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005611 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 this option takes precedence over 'ruler' and 'rulerformat'
5613 If the number of characters displayed is different from the number of
5614 bytes in the text (e.g., for a TAB or a multi-byte character), both
5615 the text column (byte number) and the screen column are shown,
5616 separated with a dash.
5617 For an empty line "0-1" is shown.
5618 For an empty buffer the line number will also be zero: "0,0-1".
5619 This option is reset when the 'paste' option is set.
5620 If you don't want to see the ruler all the time but want to know where
5621 you are, use "g CTRL-G" |g_CTRL-G|.
5622 NOTE: This option is reset when 'compatible' is set.
5623
5624 *'rulerformat'* *'ruf'*
5625'rulerformat' 'ruf' string (default empty)
5626 global
5627 {not in Vi}
5628 {not available when compiled without the |+statusline|
5629 feature}
5630 When this option is not empty, it determines the content of the ruler
5631 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005632 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 The default ruler width is 17 characters. To make the ruler 15
5634 characters wide, put "%15(" at the start and "%)" at the end.
5635 Example: >
5636 :set rulerformat=%15(%c%V\ %p%%%)
5637<
5638 *'runtimepath'* *'rtp'* *vimfiles*
5639'runtimepath' 'rtp' string (default:
5640 Unix: "$HOME/.vim,
5641 $VIM/vimfiles,
5642 $VIMRUNTIME,
5643 $VIM/vimfiles/after,
5644 $HOME/.vim/after"
5645 Amiga: "home:vimfiles,
5646 $VIM/vimfiles,
5647 $VIMRUNTIME,
5648 $VIM/vimfiles/after,
5649 home:vimfiles/after"
5650 PC, OS/2: "$HOME/vimfiles,
5651 $VIM/vimfiles,
5652 $VIMRUNTIME,
5653 $VIM/vimfiles/after,
5654 $HOME/vimfiles/after"
5655 Macintosh: "$VIM:vimfiles,
5656 $VIMRUNTIME,
5657 $VIM:vimfiles:after"
5658 RISC-OS: "Choices:vimfiles,
5659 $VIMRUNTIME,
5660 Choices:vimfiles/after"
5661 VMS: "sys$login:vimfiles,
5662 $VIM/vimfiles,
5663 $VIMRUNTIME,
5664 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005665 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 global
5667 {not in Vi}
5668 This is a list of directories which will be searched for runtime
5669 files:
5670 filetype.vim filetypes by file name |new-filetype|
5671 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005672 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005673 colors/ color scheme files |:colorscheme|
5674 compiler/ compiler files |:compiler|
5675 doc/ documentation |write-local-help|
5676 ftplugin/ filetype plugins |write-filetype-plugin|
5677 indent/ indent scripts |indent-expression|
5678 keymap/ key mapping files |mbyte-keymap|
5679 lang/ menu translations |:menutrans|
5680 menu.vim GUI menus |menu.vim|
5681 plugin/ plugin scripts |write-plugin|
5682 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005683 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005684 syntax/ syntax files |mysyntaxfile|
5685 tutor/ files for vimtutor |tutor|
5686
5687 And any other file searched for with the |:runtime| command.
5688
5689 The defaults for most systems are setup to search five locations:
5690 1. In your home directory, for your personal preferences.
5691 2. In a system-wide Vim directory, for preferences from the system
5692 administrator.
5693 3. In $VIMRUNTIME, for files distributed with Vim.
5694 *after-directory*
5695 4. In the "after" directory in the system-wide Vim directory. This is
5696 for the system administrator to overrule or add to the distributed
5697 defaults (rarely needed)
5698 5. In the "after" directory in your home directory. This is for
5699 personal preferences to overrule or add to the distributed defaults
5700 or system-wide settings (rarely needed).
5701
5702 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5703 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005704 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 wildcards.
5706 See |:runtime|.
5707 Example: >
5708 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5709< This will use the directory "~/vimruntime" first (containing your
5710 personal Vim runtime files), then "/mygroup/vim" (shared between a
5711 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5712 files).
5713 You probably should always include $VIMRUNTIME somewhere, to use the
5714 distributed runtime files. You can put a directory before $VIMRUNTIME
5715 to find files which replace a distributed runtime files. You can put
5716 a directory after $VIMRUNTIME to find files which add to distributed
5717 runtime files.
5718 This option cannot be set from a |modeline| or in the |sandbox|, for
5719 security reasons.
5720
5721 *'scroll'* *'scr'*
5722'scroll' 'scr' number (default: half the window height)
5723 local to window
5724 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5725 set to half the number of lines in the window when the window size
5726 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005727 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5729 the number of screen lines instead of file lines, makes a difference
5730 when lines wrap}
5731
5732 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5733'scrollbind' 'scb' boolean (default off)
5734 local to window
5735 {not in Vi}
5736 {not available when compiled without the |+scrollbind|
5737 feature}
5738 See also |scroll-binding|. When this option is set, the current
5739 window scrolls as other scrollbind windows (windows that also have
5740 this option set) scroll. This option is useful for viewing the
5741 differences between two versions of a file, see 'diff'.
5742 See |'scrollopt'| for options that determine how this option should be
5743 interpreted.
5744 This option is mostly reset when splitting a window to edit another
5745 file. This means that ":split | edit file" results in two windows
5746 with scroll-binding, but ":split file" does not.
5747
5748 *'scrolljump'* *'sj'*
5749'scrolljump' 'sj' number (default 1)
5750 global
5751 {not in Vi}
5752 Minimal number of lines to scroll when the cursor gets off the
5753 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5754 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005755 When set to a negative number from -1 to -100 this is used as the
5756 percentage of the window height. Thus -50 scrolls half the window
5757 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005758 NOTE: This option is set to 1 when 'compatible' is set.
5759
5760 *'scrolloff'* *'so'*
5761'scrolloff' 'so' number (default 0)
5762 global
5763 {not in Vi}
5764 Minimal number of screen lines to keep above and below the cursor.
5765 This will make some context visible around where you are working. If
5766 you set it to a very large value (999) the cursor line will always be
5767 in the middle of the window (except at the start or end of the file or
5768 when long lines wrap).
5769 For scrolling horizontally see 'sidescrolloff'.
5770 NOTE: This option is set to 0 when 'compatible' is set.
5771
5772 *'scrollopt'* *'sbo'*
5773'scrollopt' 'sbo' string (default "ver,jump")
5774 global
5775 {not available when compiled without the |+scrollbind|
5776 feature}
5777 {not in Vi}
5778 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005779 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5780 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005781 The following words are available:
5782 ver Bind vertical scrolling for 'scrollbind' windows
5783 hor Bind horizontal scrolling for 'scrollbind' windows
5784 jump Applies to the offset between two windows for vertical
5785 scrolling. This offset is the difference in the first
5786 displayed line of the bound windows. When moving
5787 around in a window, another 'scrollbind' window may
5788 reach a position before the start or after the end of
5789 the buffer. The offset is not changed though, when
5790 moving back the 'scrollbind' window will try to scroll
5791 to the desired position when possible.
5792 When now making that window the current one, two
5793 things can be done with the relative offset:
5794 1. When "jump" is not included, the relative offset is
5795 adjusted for the scroll position in the new current
5796 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005797 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005798 2. When "jump" is included, the other windows are
5799 scrolled to keep the same relative offset. When
5800 going back to the other window, it still uses the
5801 same relative offset.
5802 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005803 When 'diff' mode is active there always is vertical scroll binding,
5804 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805
5806 *'sections'* *'sect'*
5807'sections' 'sect' string (default "SHNHH HUnhsh")
5808 global
5809 Specifies the nroff macros that separate sections. These are pairs of
5810 two letters (See |object-motions|). The default makes a section start
5811 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5812
5813 *'secure'* *'nosecure'* *E523*
5814'secure' boolean (default off)
5815 global
5816 {not in Vi}
5817 When on, ":autocmd", shell and write commands are not allowed in
5818 ".vimrc" and ".exrc" in the current directory and map commands are
5819 displayed. Switch it off only if you know that you will not run into
5820 problems, or when the 'exrc' option is off. On Unix this option is
5821 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005822 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005823 'secure' at the end of your ~/.vimrc then.
5824 This option cannot be set from a |modeline| or in the |sandbox|, for
5825 security reasons.
5826
5827 *'selection'* *'sel'*
5828'selection' 'sel' string (default "inclusive")
5829 global
5830 {not in Vi}
5831 This option defines the behavior of the selection. It is only used
5832 in Visual and Select mode.
5833 Possible values:
5834 value past line inclusive ~
5835 old no yes
5836 inclusive yes yes
5837 exclusive yes no
5838 "past line" means that the cursor is allowed to be positioned one
5839 character past the line.
5840 "inclusive" means that the last character of the selection is included
5841 in an operation. For example, when "x" is used to delete the
5842 selection.
5843 Note that when "exclusive" is used and selecting from the end
5844 backwards, you cannot include the last character of a line, when
5845 starting in Normal mode and 'virtualedit' empty.
5846
5847 The 'selection' option is set by the |:behave| command.
5848
5849 *'selectmode'* *'slm'*
5850'selectmode' 'slm' string (default "")
5851 global
5852 {not in Vi}
5853 This is a comma separated list of words, which specifies when to start
5854 Select mode instead of Visual mode, when a selection is started.
5855 Possible values:
5856 mouse when using the mouse
5857 key when using shifted special keys
5858 cmd when using "v", "V" or CTRL-V
5859 See |Select-mode|.
5860 The 'selectmode' option is set by the |:behave| command.
5861
5862 *'sessionoptions'* *'ssop'*
5863'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005864 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 global
5866 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005867 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 feature}
5869 Changes the effect of the |:mksession| command. It is a comma
5870 separated list of words. Each word enables saving and restoring
5871 something:
5872 word save and restore ~
5873 blank empty windows
5874 buffers hidden and unloaded buffers, not just those in windows
5875 curdir the current directory
5876 folds manually created folds, opened/closed folds and local
5877 fold options
5878 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005879 and contain at least one lowercase letter. Only
5880 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 help the help window
5882 localoptions options and mappings local to a window or buffer (not
5883 global values for local options)
5884 options all options and mappings (also global values for local
5885 options)
5886 resize size of the Vim window: 'lines' and 'columns'
5887 sesdir the directory in which the session file is located
5888 will become the current directory (useful with
5889 projects accessed over a network from different
5890 systems)
5891 slash backslashes in file names replaced with forward
5892 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005893 tabpages all tab pages; without this only the current tab page
5894 is restored, so that you can make a session for each
5895 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 unix with Unix end-of-line format (single <NL>), even when
5897 on Windows or DOS
5898 winpos position of the whole Vim window
5899 winsize window sizes
5900
5901 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005902 When neither "curdir" nor "sesdir" is included, file names are stored
5903 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005904 "slash" and "unix" are useful on Windows when sharing session files
5905 with Unix. The Unix version of Vim cannot source dos format scripts,
5906 but the Windows version of Vim can source unix format scripts.
5907
5908 *'shell'* *'sh'* *E91*
5909'shell' 'sh' string (default $SHELL or "sh",
5910 MS-DOS and Win32: "command.com" or
5911 "cmd.exe", OS/2: "cmd")
5912 global
5913 Name of the shell to use for ! and :! commands. When changing the
5914 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5915 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005916 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005917 See |option-backslash| about including spaces and backslashes.
5918 Environment variables are expanded |:set_env|.
5919 If the name of the shell contains a space, you might need to enclose
5920 it in quotes. Example: >
5921 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5922< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005923 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005924 "-f" is not inside the quotes, because it is not part of the command
5925 name. And Vim automagically recognizes the backslashes that are path
5926 separators.
5927 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5928 variable to change the way external commands are executed. See the
5929 libc.inf file of DJGPP.
5930 Under MS-Windows, when the executable ends in ".com" it must be
5931 included. Thus setting the shell to "command.com" or "4dos.com"
5932 works, but "command" and "4dos" do not work for all commands (e.g.,
5933 filtering).
5934 For unknown reasons, when using "4dos.com" the current directory is
5935 changed to "C:\". To avoid this set 'shell' like this: >
5936 :set shell=command.com\ /c\ 4dos
5937< This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
5940 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005941'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005942 MS-DOS and Win32, when 'shell' does not
5943 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005944 global
5945 {not in Vi}
5946 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5947 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5948 systems, the default is set according to the value of 'shell', to
5949 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005950 OS/2 (EMX figures this out itself).
5951 On Unix it can have more than one flag. Each white space separated
5952 part is passed as an argument to the shell command.
5953 See |option-backslash| about including spaces and backslashes.
5954 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005955 This option cannot be set from a |modeline| or in the |sandbox|, for
5956 security reasons.
5957
5958 *'shellpipe'* *'sp'*
5959'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5960 global
5961 {not in Vi}
5962 {not available when compiled without the |+quickfix|
5963 feature}
5964 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005965 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 including spaces and backslashes.
5967 The name of the temporary file can be represented by "%s" if necessary
5968 (the file name is appended automatically if no %s appears in the value
5969 of this option).
5970 For the Amiga and MS-DOS the default is ">". The output is directly
5971 saved in a file and not echoed to the screen.
5972 For Unix the default it "| tee". The stdout of the compiler is saved
5973 in a file and echoed to the screen. If the 'shell' option is "csh" or
5974 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005975 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5976 default becomes "2>&1| tee". This means that stderr is also included.
5977 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5978 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005979 The initialization of this option is done after reading the ".vimrc"
5980 and the other initializations, so that when the 'shell' option is set
5981 there, the 'shellpipe' option changes automatically, unless it was
5982 explicitly set before.
5983 When 'shellpipe' is set to an empty string, no redirection of the
5984 ":make" output will be done. This is useful if you use a 'makeprg'
5985 that writes to 'makeef' by itself. If you want no piping, but do
5986 want to include the 'makeef', set 'shellpipe' to a single space.
5987 Don't forget to precede the space with a backslash: ":set sp=\ ".
5988 In the future pipes may be used for filtering and this option will
5989 become obsolete (at least for Unix).
5990 This option cannot be set from a |modeline| or in the |sandbox|, for
5991 security reasons.
5992
5993 *'shellquote'* *'shq'*
5994'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5995 contains "sh" somewhere: "\"")
5996 global
5997 {not in Vi}
5998 Quoting character(s), put around the command passed to the shell, for
5999 the "!" and ":!" commands. The redirection is kept outside of the
6000 quoting. See 'shellxquote' to include the redirection. It's
6001 probably not useful to set both options.
6002 This is an empty string by default. Only known to be useful for
6003 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6004 or bash, where it should be "\"". The default is adjusted according
6005 the value of 'shell', to reduce the need to set this option by the
6006 user. See |dos-shell|.
6007 This option cannot be set from a |modeline| or in the |sandbox|, for
6008 security reasons.
6009
6010 *'shellredir'* *'srr'*
6011'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6012 global
6013 {not in Vi}
6014 String to be used to put the output of a filter command in a temporary
6015 file. See also |:!|. See |option-backslash| about including spaces
6016 and backslashes.
6017 The name of the temporary file can be represented by "%s" if necessary
6018 (the file name is appended automatically if no %s appears in the value
6019 of this option).
6020 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6021 or "zsh" during initializations, the default becomes ">&". If the
6022 'shell' option is "sh", "ksh" or "bash" the default becomes
6023 ">%s 2>&1". This means that stderr is also included.
6024 For Win32, the Unix checks are done and additionally "cmd" is checked
6025 for, which makes the default ">%s 2>&1". Also, the same names with
6026 ".exe" appended are checked for.
6027 The initialization of this option is done after reading the ".vimrc"
6028 and the other initializations, so that when the 'shell' option is set
6029 there, the 'shellredir' option changes automatically unless it was
6030 explicitly set before.
6031 In the future pipes may be used for filtering and this option will
6032 become obsolete (at least for Unix).
6033 This option cannot be set from a |modeline| or in the |sandbox|, for
6034 security reasons.
6035
6036 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6037'shellslash' 'ssl' boolean (default off)
6038 global
6039 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6040 When set, a forward slash is used when expanding file names. This is
6041 useful when a Unix-like shell is used instead of command.com or
6042 cmd.exe. Backward slashes can still be typed, but they are changed to
6043 forward slashes by Vim.
6044 Note that setting or resetting this option has no effect for some
6045 existing file names, thus this option needs to be set before opening
6046 any file for best results. This might change in the future.
6047 'shellslash' only works when a backslash can be used as a path
6048 separator. To test if this is so use: >
6049 if exists('+shellslash')
6050<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006051 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6052'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6053 global
6054 {not in Vi}
6055 When on, use temp files for shell commands. When off use a pipe.
6056 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006057 Currently a pipe is only supported on Unix and MS-Windows 2K and
6058 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006059 :if has("filterpipe")
6060< The advantage of using a pipe is that nobody can read the temp file
6061 and the 'shell' command does not need to support redirection.
6062 The advantage of using a temp file is that the file type and encoding
6063 can be detected.
6064 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6065 |FilterWritePost| autocommands event are not triggered when
6066 'shelltemp' is off.
6067
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 *'shelltype'* *'st'*
6069'shelltype' 'st' number (default 0)
6070 global
6071 {not in Vi} {only for the Amiga}
6072 On the Amiga this option influences the way how the commands work
6073 which use a shell.
6074 0 and 1: always use the shell
6075 2 and 3: use the shell only to filter lines
6076 4 and 5: use shell only for ':sh' command
6077 When not using the shell, the command is executed directly.
6078
6079 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6080 1 and 3: use "shell cmd" to start external commands
6081
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006082 *'shellxescape'* *'sxe'*
6083'shellxescape' 'sxe' string (default: "";
6084 for MS-DOS and MS-Windows: "\"&|<>()@^")
6085 global
6086 {not in Vi}
6087 When 'shellxquote' is set to "(" then the characters listed in this
6088 option will be escaped with a '^' character. This makes it possible
6089 to execute most external commands with cmd.exe.
6090
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 *'shellxquote'* *'sxq'*
6092'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006093 for Win32, when 'shell' is cmd.exe: "("
6094 for Win32, when 'shell' contains "sh"
6095 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006096 for Unix, when using system(): "\"")
6097 global
6098 {not in Vi}
6099 Quoting character(s), put around the command passed to the shell, for
6100 the "!" and ":!" commands. Includes the redirection. See
6101 'shellquote' to exclude the redirection. It's probably not useful
6102 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006103 When the value is '(' then ')' is appended. When the value is '"('
6104 then ')"' is appended.
6105 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006106 This is an empty string by default on most systems, but is known to be
6107 useful for on Win32 version, either for cmd.exe which automatically
6108 strips off the first and last quote on a command, or 3rd-party shells
6109 such as the MKS Korn Shell or bash, where it should be "\"". The
6110 default is adjusted according the value of 'shell', to reduce the need
6111 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 This option cannot be set from a |modeline| or in the |sandbox|, for
6113 security reasons.
6114
6115 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6116'shiftround' 'sr' boolean (default off)
6117 global
6118 {not in Vi}
6119 Round indent to multiple of 'shiftwidth'. Applies to > and <
6120 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6121 a multiple of 'shiftwidth' (this is Vi compatible).
6122 NOTE: This option is reset when 'compatible' is set.
6123
6124 *'shiftwidth'* *'sw'*
6125'shiftwidth' 'sw' number (default 8)
6126 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006127 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006129 When zero the 'ts' value will be used. Use the |shiftwidth()|
6130 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131
6132 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006133'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6134 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006135 global
6136 {not in Vi}
6137 This option helps to avoid all the |hit-enter| prompts caused by file
6138 messages, for example with CTRL-G, and to avoid some other messages.
6139 It is a list of flags:
6140 flag meaning when present ~
6141 f use "(3 of 5)" instead of "(file 3 of 5)"
6142 i use "[noeol]" instead of "[Incomplete last line]"
6143 l use "999L, 888C" instead of "999 lines, 888 characters"
6144 m use "[+]" instead of "[Modified]"
6145 n use "[New]" instead of "[New File]"
6146 r use "[RO]" instead of "[readonly]"
6147 w use "[w]" instead of "written" for file write message
6148 and "[a]" instead of "appended" for ':w >> file' command
6149 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6150 "[unix format]" and "[mac]" instead of "[mac format]".
6151 a all of the above abbreviations
6152
6153 o overwrite message for writing a file with subsequent message
6154 for reading a file (useful for ":wn" or when 'autowrite' on)
6155 O message for reading a file overwrites any previous message.
6156 Also for quickfix message (e.g., ":cn").
6157 s don't give "search hit BOTTOM, continuing at TOP" or "search
6158 hit TOP, continuing at BOTTOM" messages
6159 t truncate file message at the start if it is too long to fit
6160 on the command-line, "<" will appear in the left most column.
6161 Ignored in Ex mode.
6162 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006163 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 Ignored in Ex mode.
6165 W don't give "written" or "[w]" when writing a file
6166 A don't give the "ATTENTION" message when an existing swap file
6167 is found.
6168 I don't give the intro message when starting Vim |:intro|.
6169
6170 This gives you the opportunity to avoid that a change between buffers
6171 requires you to hit <Enter>, but still gives as useful a message as
6172 possible for the space available. To get the whole message that you
6173 would have got with 'shm' empty, use ":file!"
6174 Useful values:
6175 shm= No abbreviation of message.
6176 shm=a Abbreviation, but no loss of information.
6177 shm=at Abbreviation, and truncate message when necessary.
6178
6179 NOTE: This option is set to the Vi default value when 'compatible' is
6180 set and to the Vim default value when 'compatible' is reset.
6181
6182 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6183'shortname' 'sn' boolean (default off)
6184 local to buffer
6185 {not in Vi, not in MS-DOS versions}
6186 Filenames are assumed to be 8 characters plus one extension of 3
6187 characters. Multiple dots in file names are not allowed. When this
6188 option is on, dots in file names are replaced with underscores when
6189 adding an extension (".~" or ".swp"). This option is not available
6190 for MS-DOS, because then it would always be on. This option is useful
6191 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6192 or crossdos. When running the Win32 GUI version under Win32s, this
6193 option is always on by default.
6194
6195 *'showbreak'* *'sbr'* *E595*
6196'showbreak' 'sbr' string (default "")
6197 global
6198 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006199 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 feature}
6201 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006202 values are "> " or "+++ ": >
6203 :set showbreak=>\
6204< Note the backslash to escape the trailing space. It's easier like
6205 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006206 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006207< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 comma (in a future version the comma might be used to separate the
6209 part that is shown at the end and at the start of a line).
6210 The characters are highlighted according to the '@' flag in
6211 'highlight'.
6212 Note that tabs after the showbreak will be displayed differently.
6213 If you want the 'showbreak' to appear in between line numbers, add the
6214 "n" flag to 'cpoptions'.
6215
6216 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6217'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6218 off)
6219 global
6220 {not in Vi}
6221 {not available when compiled without the
6222 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006223 Show (partial) command in the last line of the screen. Set this
6224 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006225 In Visual mode the size of the selected area is shown:
6226 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006227 If the number of bytes is different it is also displayed: "2-6"
6228 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006230 - When selecting a block, the size in screen characters:
6231 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 NOTE: This option is set to the Vi default value when 'compatible' is
6233 set and to the Vim default value when 'compatible' is reset.
6234
6235 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6236'showfulltag' 'sft' boolean (default off)
6237 global
6238 {not in Vi}
6239 When completing a word in insert mode (see |ins-completion|) from the
6240 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006241 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 matched a C function, you can see a template for what arguments are
6243 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006244 Note that this doesn't work well together with having "longest" in
6245 'completeopt', because the completion from the search pattern may not
6246 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247
6248 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6249'showmatch' 'sm' boolean (default off)
6250 global
6251 When a bracket is inserted, briefly jump to the matching one. The
6252 jump is only done if the match can be seen on the screen. The time to
6253 show the match can be set with 'matchtime'.
6254 A Beep is given if there is no match (no matter if the match can be
6255 seen or not). This option is reset when the 'paste' option is set.
6256 When the 'm' flag is not included in 'cpoptions', typing a character
6257 will immediately move the cursor back to where it belongs.
6258 See the "sm" field in 'guicursor' for setting the cursor shape and
6259 blinking when showing the match.
6260 The 'matchpairs' option can be used to specify the characters to show
6261 matches for. 'rightleft' and 'revins' are used to look for opposite
6262 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006263 Also see the matchparen plugin for highlighting the match when moving
6264 around |pi_paren.txt|.
6265 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266
6267 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6268'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6269 global
6270 If in Insert, Replace or Visual mode put a message on the last line.
6271 Use the 'M' flag in 'highlight' to set the type of highlighting for
6272 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006273 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 doesn't mean XIM is really active, especially when 'imactivatekey' is
6275 not set.
6276 NOTE: This option is set to the Vi default value when 'compatible' is
6277 set and to the Vim default value when 'compatible' is reset.
6278
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006279 *'showtabline'* *'stal'*
6280'showtabline' 'stal' number (default 1)
6281 global
6282 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006283 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006284 feature}
6285 The value of this option specifies when the line with tab page labels
6286 will be displayed:
6287 0: never
6288 1: only if there are at least two tab pages
6289 2: always
6290 This is both for the GUI and non-GUI implementation of the tab pages
6291 line.
6292 See |tab-page| for more information about tab pages.
6293
Bram Moolenaar071d4272004-06-13 20:20:40 +00006294 *'sidescroll'* *'ss'*
6295'sidescroll' 'ss' number (default 0)
6296 global
6297 {not in Vi}
6298 The minimal number of columns to scroll horizontally. Used only when
6299 the 'wrap' option is off and the cursor is moved off of the screen.
6300 When it is zero the cursor will be put in the middle of the screen.
6301 When using a slow terminal set it to a large number or 0. When using
6302 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6303 commands.
6304
6305 *'sidescrolloff'* *'siso'*
6306'sidescrolloff' 'siso' number (default 0)
6307 global
6308 {not in Vi}
6309 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006310 right of the cursor if 'nowrap' is set. Setting this option to a
6311 value greater than 0 while having |'sidescroll'| also at a non-zero
6312 value makes some context visible in the line you are scrolling in
6313 horizontally (except at beginning of the line). Setting this option
6314 to a large value (like 999) has the effect of keeping the cursor
6315 horizontally centered in the window, as long as one does not come too
6316 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 NOTE: This option is set to 0 when 'compatible' is set.
6318
6319 Example: Try this together with 'sidescroll' and 'listchars' as
6320 in the following example to never allow the cursor to move
6321 onto the "extends" character:
6322
6323 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6324 :set sidescrolloff=1
6325
6326
6327 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6328'smartcase' 'scs' boolean (default off)
6329 global
6330 {not in Vi}
6331 Override the 'ignorecase' option if the search pattern contains upper
6332 case characters. Only used when the search pattern is typed and
6333 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006334 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6336 recalling the search pattern from history and hitting <Enter>.
6337 NOTE: This option is reset when 'compatible' is set.
6338
6339 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6340'smartindent' 'si' boolean (default off)
6341 local to buffer
6342 {not in Vi}
6343 {not available when compiled without the
6344 |+smartindent| feature}
6345 Do smart autoindenting when starting a new line. Works for C-like
6346 programs, but can also be used for other languages. 'cindent' does
6347 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006348 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006349 setting 'si' has no effect. 'indentexpr' is a more advanced
6350 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 Normally 'autoindent' should also be on when using 'smartindent'.
6352 An indent is automatically inserted:
6353 - After a line ending in '{'.
6354 - After a line starting with a keyword from 'cinwords'.
6355 - Before a line starting with '}' (only with the "O" command).
6356 When typing '}' as the first character in a new line, that line is
6357 given the same indent as the matching '{'.
6358 When typing '#' as the first character in a new line, the indent for
6359 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006360 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6362 When using the ">>" command, lines starting with '#' are not shifted
6363 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006364 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 is set smart indenting is disabled.
6366
6367 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6368'smarttab' 'sta' boolean (default off)
6369 global
6370 {not in Vi}
6371 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006372 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6373 <BS> will delete a 'shiftwidth' worth of space at the start of the
6374 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006375 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006376 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6377 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006378 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006380 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006381 NOTE: This option is reset when 'compatible' is set.
6382
6383 *'softtabstop'* *'sts'*
6384'softtabstop' 'sts' number (default 0)
6385 local to buffer
6386 {not in Vi}
6387 Number of spaces that a <Tab> counts for while performing editing
6388 operations, like inserting a <Tab> or using <BS>. It "feels" like
6389 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6390 used. This is useful to keep the 'ts' setting at its standard value
6391 of 8, while being able to edit like it is set to 'sts'. However,
6392 commands like "x" still work on the actual characters.
6393 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006394 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006395 'softtabstop' is set to 0 when the 'paste' option is set.
6396 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6397 spaces is minimized by using <Tab>s.
6398 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6399 set.
6400 NOTE: This option is set to 0 when 'compatible' is set.
6401
Bram Moolenaar217ad922005-03-20 22:37:15 +00006402 *'spell'* *'nospell'*
6403'spell' boolean (default off)
6404 local to window
6405 {not in Vi}
6406 {not available when compiled without the |+syntax|
6407 feature}
6408 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006409 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006410
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006411 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006412'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006413 local to buffer
6414 {not in Vi}
6415 {not available when compiled without the |+syntax|
6416 feature}
6417 Pattern to locate the end of a sentence. The following word will be
6418 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006419 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006420 When this check is not wanted make this option empty.
6421 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006422 Be careful with special characters, see |option-backslash| about
6423 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006424 To set this option automatically depending on the language, see
6425 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006426
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006427 *'spellfile'* *'spf'*
6428'spellfile' 'spf' string (default empty)
6429 local to buffer
6430 {not in Vi}
6431 {not available when compiled without the |+syntax|
6432 feature}
6433 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006434 commands. It must end in ".{encoding}.add". You need to include the
6435 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006436 *E765*
6437 It may also be a comma separated list of names. A count before the
6438 |zg| and |zw| commands can be used to access each. This allows using
6439 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006440 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006441 you: Using the first directory in 'runtimepath' that is writable. If
6442 there is no "spell" directory yet it will be created. For the file
6443 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006444 ignoring the region.
6445 The resulting ".spl" file will be used for spell checking, it does not
6446 have to appear in 'spelllang'.
6447 Normally one file is used for all regions, but you can add the region
6448 name if you want to. However, it will then only be used when
6449 'spellfile' is set to it, for entries in 'spelllang' only files
6450 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006451 This option cannot be set from a |modeline| or in the |sandbox|, for
6452 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006453
Bram Moolenaar217ad922005-03-20 22:37:15 +00006454 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006455'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006456 local to buffer
6457 {not in Vi}
6458 {not available when compiled without the |+syntax|
6459 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006460 A comma separated list of word list names. When the 'spell' option is
6461 on spellchecking will be done for these languages. Example: >
6462 set spelllang=en_us,nl,medical
6463< This means US English, Dutch and medical words are recognized. Words
6464 that are not recognized will be highlighted.
6465 The word list name must not include a comma or dot. Using a dash is
6466 recommended to separate the two letter language name from a
6467 specification. Thus "en-rare" is used for rare English words.
6468 A region name must come last and have the form "_xx", where "xx" is
6469 the two-letter, lower case region name. You can use more than one
6470 region by listing them: "en_us,en_ca" supports both US and Canadian
6471 English, but not words specific for Australia, New Zealand or Great
6472 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006473 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006474 As a special case the name of a .spl file can be given as-is. The
6475 first "_xx" in the name is removed and used as the region name
6476 (_xx is an underscore, two letters and followed by a non-letter).
6477 This is mainly for testing purposes. You must make sure the correct
6478 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006479 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006480 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6481 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006482 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006483
Bram Moolenaar98692072006-02-04 00:57:42 +00006484 If the |spellfile.vim| plugin is active and you use a language name
6485 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6486 will ask you if you want to download the file.
6487
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006488 After this option has been set successfully, Vim will source the files
6489 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006490 up to the first comma, dot or underscore.
6491 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006492
6493
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006494 *'spellsuggest'* *'sps'*
6495'spellsuggest' 'sps' string (default "best")
6496 global
6497 {not in Vi}
6498 {not available when compiled without the |+syntax|
6499 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006500 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006501 the |spellsuggest()| function. This is a comma-separated list of
6502 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006503
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006504 best Internal method that works best for English. Finds
6505 changes like "fast" and uses a bit of sound-a-like
6506 scoring to improve the ordering.
6507
6508 double Internal method that uses two methods and mixes the
6509 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006510 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006511 word. That only works when the language specifies
6512 sound folding. Can be slow and doesn't always give
6513 better results.
6514
6515 fast Internal method that only checks for simple changes:
6516 character inserts/deletes/swaps. Works well for
6517 simple typing mistakes.
6518
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006519 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006520 Not used for |spellsuggest()|. The number of
6521 suggestions is never more than the value of 'lines'
6522 minus two.
6523
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006524 file:{filename} Read file {filename}, which must have two columns,
6525 separated by a slash. The first column contains the
6526 bad word, the second column the suggested good word.
6527 Example:
6528 theribal/terrible ~
6529 Use this for common mistakes that do not appear at the
6530 top of the suggestion list with the internal methods.
6531 Lines without a slash are ignored, use this for
6532 comments.
6533 The file is used for all languages.
6534
6535 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6536 trouble with spaces. |v:val| holds the badly spelled
6537 word. The expression must evaluate to a List of
6538 Lists, each with a suggestion and a score.
6539 Example:
6540 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006541 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006542 internal methods use. A lower score is better.
6543 This may invoke |spellsuggest()| if you temporarily
6544 set 'spellsuggest' to exclude the "expr:" part.
6545 Errors are silently ignored, unless you set the
6546 'verbose' option to a non-zero value.
6547
6548 Only one of "best", "double" or "fast" may be used. The others may
6549 appear several times in any order. Example: >
6550 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6551<
6552 This option cannot be set from a |modeline| or in the |sandbox|, for
6553 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006554
6555
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6557'splitbelow' 'sb' boolean (default off)
6558 global
6559 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006560 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 feature}
6562 When on, splitting a window will put the new window below the current
6563 one. |:split|
6564
6565 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6566'splitright' 'spr' boolean (default off)
6567 global
6568 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006569 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 feature}
6571 When on, splitting a window will put the new window right of the
6572 current one. |:vsplit|
6573
6574 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6575'startofline' 'sol' boolean (default on)
6576 global
6577 {not in Vi}
6578 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006579 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006580 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006581 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 with a linewise operator, with "%" with a count and to buffer changing
6583 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6584 only has a line number, e.g., ":25" or ":+".
6585 In case of buffer changing commands the cursor is placed at the column
6586 where it was the last time the buffer was edited.
6587 NOTE: This option is set when 'compatible' is set.
6588
Bram Moolenaar00654022011-02-25 14:42:19 +01006589 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006590'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006591 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 {not in Vi}
6593 {not available when compiled without the |+statusline|
6594 feature}
6595 When nonempty, this option determines the content of the status line.
6596 Also see |status-line|.
6597
6598 The option consists of printf style '%' items interspersed with
6599 normal text. Each status line item is of the form:
6600 %-0{minwid}.{maxwid}{item}
6601 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006602 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006603
Bram Moolenaar238a5642006-02-21 22:12:05 +00006604 When the option starts with "%!" then it is used as an expression,
6605 evaluated and the result is used as the option value. Example: >
6606 :set statusline=%!MyStatusLine()
6607< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006608 Note that the "%!" expression is evaluated in the context of the
6609 current window and buffer, while %{} items are evaluated in the
6610 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006611
6612 When there is error while evaluating the option then it will be made
6613 empty to avoid further errors. Otherwise screen updating would loop.
6614
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 Note that the only effect of 'ruler' when this option is set (and
6616 'laststatus' is 2) is controlling the output of |CTRL-G|.
6617
6618 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006619 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006621 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 minwid Minimum width of the item, padding as set by '-' & '0'.
6623 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006624 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 on the left for text items. Numeric items will be
6626 shifted down to maxwid-2 digits followed by '>'number
6627 where number is the amount of missing digits, much like
6628 an exponential notation.
6629 item A one letter code as described below.
6630
6631 Following is a description of the possible statusline items. The
6632 second character in "item" is the type:
6633 N for number
6634 S for string
6635 F for flags as described below
6636 - not applicable
6637
6638 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006639 f S Path to the file in the buffer, as typed or relative to current
6640 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 F S Full path to the file in the buffer.
6642 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006643 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006645 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006647 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006649 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006651 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6653 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006654 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6656 being used: "<keymap>"
6657 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006658 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 B N As above, in hexadecimal.
6660 o N Byte number in file of byte under cursor, first byte is 1.
6661 Mnemonic: Offset from start of file (with one added)
6662 {not available when compiled without |+byte_offset| feature}
6663 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006664 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 l N Line number.
6666 L N Number of lines in buffer.
6667 c N Column number.
6668 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006669 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 p N Percentage through file in lines as in |CTRL-G|.
6671 P S Percentage through file of displayed window. This is like the
6672 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006673 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006675 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006676 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 ( - Start of item group. Can be used for setting the width and
6678 alignment of a section. Must be followed by %) somewhere.
6679 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006680 T N For 'tabline': start of tab page N label. Use %T after the last
6681 label. This information is used for mouse clicks.
6682 X N For 'tabline': start of close tab N label. Use %X after the
6683 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6684 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 < - Where to truncate line if too long. Default is at the start.
6686 No width fields allowed.
6687 = - Separation point between left and right aligned items.
6688 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006689 # - Set highlight group. The name must follow and then a # again.
6690 Thus use %#HLname# for highlight group HLname. The same
6691 highlighting is used, also for the statusline of non-current
6692 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006694 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 The difference between User{N} and StatusLine will be applied
6696 to StatusLineNC for the statusline of non-current windows.
6697 The number N must be between 1 and 9. See |hl-User1..9|
6698
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006699 When displaying a flag, Vim removes the leading comma, if any, when
6700 that flag comes right after plaintext. This will make a nice display
6701 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702
Bram Moolenaar582fd852005-03-28 20:58:01 +00006703 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006704 not set) and a minwid is not set for the group, the whole group will
6705 become empty. This will make a group like the following disappear
6706 completely from the statusline when none of the flags are set. >
6707 :set statusline=...%(\ [%M%R%H]%)...
6708<
6709 Beware that an expression is evaluated each and every time the status
6710 line is displayed. The current buffer and current window will be set
6711 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006712 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006713 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006714 real current buffer.
6715
Bram Moolenaar30b65812012-07-12 22:01:11 +02006716 The 'statusline' option will be evaluated in the |sandbox| if set from
6717 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006718
6719 It is not allowed to change text or jump to another window while
6720 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721
6722 If the statusline is not updated when you want it (e.g., after setting
6723 a variable that's used in an expression), you can force an update by
6724 setting an option without changing its value. Example: >
6725 :let &ro = &ro
6726
6727< A result of all digits is regarded a number for display purposes.
6728 Otherwise the result is taken as flag text and applied to the rules
6729 described above.
6730
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006731 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006732 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6733 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6734
6735 Examples:
6736 Emulate standard status line with 'ruler' set >
6737 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6738< Similar, but add ASCII value of char under the cursor (like "ga") >
6739 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6740< Display byte count and byte value, modified flag in red. >
6741 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6742 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6743< Display a ,GZ flag if a compressed file is loaded >
6744 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6745< In the |:autocmd|'s: >
6746 :let b:gzflag = 1
6747< And: >
6748 :unlet b:gzflag
6749< And define this function: >
6750 :function VarExists(var, val)
6751 : if exists(a:var) | return a:val | else | return '' | endif
6752 :endfunction
6753<
6754 *'suffixes'* *'su'*
6755'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6756 global
6757 {not in Vi}
6758 Files with these suffixes get a lower priority when multiple files
6759 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006760 suffixes. Spaces after the comma are ignored. A dot is also seen as
6761 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 separator, precede it with a backslash (see |option-backslash| about
6763 including spaces and backslashes).
6764 See 'wildignore' for completely ignoring files.
6765 The use of |:set+=| and |:set-=| is preferred when adding or removing
6766 suffixes from the list. This avoids problems when a future version
6767 uses another default.
6768
6769 *'suffixesadd'* *'sua'*
6770'suffixesadd' 'sua' string (default "")
6771 local to buffer
6772 {not in Vi}
6773 {not available when compiled without the
6774 |+file_in_path| feature}
6775 Comma separated list of suffixes, which are used when searching for a
6776 file for the "gf", "[I", etc. commands. Example: >
6777 :set suffixesadd=.java
6778<
6779 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6780'swapfile' 'swf' boolean (default on)
6781 local to buffer
6782 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006783 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 swapfile is not wanted for a specific buffer. For example, with
6785 confidential information that even root must not be able to access.
6786 Careful: All text will be in memory:
6787 - Don't use this for big files.
6788 - Recovery will be impossible!
6789 A swapfile will only be present when |'updatecount'| is non-zero and
6790 'swapfile' is set.
6791 When 'swapfile' is reset, the swap file for the current buffer is
6792 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6793 non-zero, a swap file is immediately created.
6794 Also see |swap-file| and |'swapsync'|.
6795
6796 This option is used together with 'bufhidden' and 'buftype' to
6797 specify special kinds of buffers. See |special-buffers|.
6798
6799 *'swapsync'* *'sws'*
6800'swapsync' 'sws' string (default "fsync")
6801 global
6802 {not in Vi}
6803 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 When this option is empty parts of the swap file may be in memory and
6806 not written to disk. When the system crashes you may lose more work.
6807 On Unix the system does a sync now and then without Vim asking for it,
6808 so the disadvantage of setting this option off is small. On some
6809 systems the swap file will not be written at all. For a unix system
6810 setting it to "sync" will use the sync() call instead of the default
6811 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006812 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813
6814 *'switchbuf'* *'swb'*
6815'switchbuf' 'swb' string (default "")
6816 global
6817 {not in Vi}
6818 This option controls the behavior when switching between buffers.
6819 Possible values (comma separated list):
6820 useopen If included, jump to the first open window that
6821 contains the specified buffer (if there is one).
6822 Otherwise: Do not examine other windows.
6823 This setting is checked with |quickfix| commands, when
6824 jumping to errors (":cc", ":cn", "cp", etc.). It is
6825 also used in all buffer related split commands, for
6826 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006827 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006828 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006829 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006830 a buffer for a |quickfix| command that display errors.
6831 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006832 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006833 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006834
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006835 *'synmaxcol'* *'smc'*
6836'synmaxcol' 'smc' number (default 3000)
6837 local to buffer
6838 {not in Vi}
6839 {not available when compiled without the |+syntax|
6840 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006841 Maximum column in which to search for syntax items. In long lines the
6842 text after this column is not highlighted and following lines may not
6843 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006844 This helps to avoid very slow redrawing for an XML file that is one
6845 long line.
6846 Set to zero to remove the limit.
6847
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 *'syntax'* *'syn'*
6849'syntax' 'syn' string (default empty)
6850 local to buffer
6851 {not in Vi}
6852 {not available when compiled without the |+syntax|
6853 feature}
6854 When this option is set, the syntax with this name is loaded, unless
6855 syntax highlighting has been switched off with ":syntax off".
6856 Otherwise this option does not always reflect the current syntax (the
6857 b:current_syntax variable does).
6858 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006859 not automatically recognized. Example, in an IDL file:
6860 /* vim: set syntax=idl : */ ~
6861 When a dot appears in the value then this separates two filetype
6862 names. Example:
6863 /* vim: set syntax=c.doxygen : */ ~
6864 This will use the "c" syntax first, then the "doxygen" syntax.
6865 Note that the second one must be prepared to be loaded as an addition,
6866 otherwise it will be skipped. More than one dot may appear.
6867 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 :set syntax=OFF
6869< To switch syntax highlighting on according to the current value of the
6870 'filetype' option: >
6871 :set syntax=ON
6872< What actually happens when setting the 'syntax' option is that the
6873 Syntax autocommand event is triggered with the value as argument.
6874 This option is not copied to another buffer, independent of the 's' or
6875 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006876 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006878 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006879'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006880 global
6881 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006882 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006883 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006884 When nonempty, this option determines the content of the tab pages
6885 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006886 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006887
6888 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006889 option and only when there is no GUI tab line. When 'e' is in
6890 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006891 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006892
6893 The value is evaluated like with 'statusline'. You can use
6894 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006895 the text to be displayed. Use "%1T" for the first label, "%2T" for
6896 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006897
6898 Keep in mind that only one of the tab pages is the current one, others
6899 are invisible and you can't jump to their windows.
6900
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006901
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006902 *'tabpagemax'* *'tpm'*
6903'tabpagemax' 'tpm' number (default 10)
6904 global
6905 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006906 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006907 feature}
6908 Maximum number of tab pages to be opened by the |-p| command line
6909 argument or the ":tab all" command. |tabpage|
6910
6911
6912 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006913'tabstop' 'ts' number (default 8)
6914 local to buffer
6915 Number of spaces that a <Tab> in the file counts for. Also see
6916 |:retab| command, and 'softtabstop' option.
6917
6918 Note: Setting 'tabstop' to any other value than 8 can make your file
6919 appear wrong in many places (e.g., when printing it).
6920
6921 There are four main ways to use tabs in Vim:
6922 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6923 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006924 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 behave like a tab appears every 4 (or 3) characters.
6926 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6927 'expandtab'. This way you will always insert spaces. The
6928 formatting will never be messed up when 'tabstop' is changed.
6929 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006930 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006931 works when using Vim to edit the file.
6932 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6933 'noexpandtab'. This should then work (for initial indents only)
6934 for any tabstop setting that people use. It might be nice to have
6935 tabs after the first non-blank inserted as spaces if you do this
6936 though. Otherwise aligned comments will be wrong when 'tabstop' is
6937 changed.
6938
6939 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6940'tagbsearch' 'tbs' boolean (default on)
6941 global
6942 {not in Vi}
6943 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006944 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 searching makes searching for a tag a LOT faster, but a linear search
6946 will find more tags if the tags file wasn't properly sorted.
6947 Vim normally assumes that your tags files are sorted, or indicate that
6948 they are not sorted. Only when this is not the case does the
6949 'tagbsearch' option need to be switched off.
6950
6951 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006952 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 certain files, or retry all files with a linear search. When
6954 'tagbsearch' is off, only a linear search is done.
6955
6956 Linear searching is done anyway, for one file, when Vim finds a line
6957 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006958 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959< [The whitespace before and after the '0' must be a single <Tab>]
6960
6961 When a binary search was done and no match was found in any of the
6962 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6963 instead of a normal tag name, a retry is done with a linear search.
6964 Tags in unsorted tags files, and matches with different case will only
6965 be found in the retry.
6966
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006967 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 linear search can be avoided for the 'ignorecase' case. Use a value
6969 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6970 case-fold sorted with the -f switch to "sort" in most unices, as in
6971 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006972 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6973 for this as well. Note that case must be folded to uppercase for this
6974 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006975
6976 When 'tagbsearch' is off, tags searching is slower when a full match
6977 exists, but faster when no full match exists. Tags in unsorted tags
6978 files may only be found with 'tagbsearch' off.
6979 When the tags file is not sorted, or sorted in a wrong way (not on
6980 ASCII byte value), 'tagbsearch' should be off, or the line given above
6981 must be included in the tags file.
6982 This option doesn't affect commands that find all matching tags (e.g.,
6983 command-line completion and ":help").
6984 {Vi: always uses binary search in some versions}
6985
6986 *'taglength'* *'tl'*
6987'taglength' 'tl' number (default 0)
6988 global
6989 If non-zero, tags are significant up to this number of characters.
6990
6991 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6992'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6993 global
6994 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006995 If on and using a tags file in another directory, file names in that
6996 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006997 NOTE: This option is set to the Vi default value when 'compatible' is
6998 set and to the Vim default value when 'compatible' is reset.
6999
7000 *'tags'* *'tag'* *E433*
7001'tags' 'tag' string (default "./tags,tags", when compiled with
7002 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7003 global or local to buffer |global-local|
7004 Filenames for the tag command, separated by spaces or commas. To
7005 include a space or comma in a file name, precede it with a backslash
7006 (see |option-backslash| about including spaces and backslashes).
7007 When a file name starts with "./", the '.' is replaced with the path
7008 of the current file. But only when the 'd' flag is not included in
7009 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7010 |tags-option|.
7011 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007012 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7013 find all files named "tags" below "/lib". The filename itself cannot
7014 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7015 files called "tags?". {not available when compiled without the
7016 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007017 The |tagfiles()| function can be used to get a list of the file names
7018 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007019 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7020 files are also supported. They are automatically recognized. The
7021 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7022 differences are ignored (MS-Windows). |emacs-tags|
7023 The use of |:set+=| and |:set-=| is preferred when adding or removing
7024 file names from the list. This avoids problems when a future version
7025 uses another default.
7026 {Vi: default is "tags /usr/lib/tags"}
7027
7028 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7029'tagstack' 'tgst' boolean (default on)
7030 global
7031 {not in all versions of Vi}
7032 When on, the |tagstack| is used normally. When off, a ":tag" or
7033 ":tselect" command with an argument will not push the tag onto the
7034 tagstack. A following ":tag" without an argument, a ":pop" command or
7035 any other command that uses the tagstack will use the unmodified
7036 tagstack, but does change the pointer to the active entry.
7037 Resetting this option is useful when using a ":tag" command in a
7038 mapping which should not change the tagstack.
7039
7040 *'term'* *E529* *E530* *E531*
7041'term' string (default is $TERM, if that fails:
7042 in the GUI: "builtin_gui"
7043 on Amiga: "amiga"
7044 on BeOS: "beos-ansi"
7045 on Mac: "mac-ansi"
7046 on MiNT: "vt52"
7047 on MS-DOS: "pcterm"
7048 on OS/2: "os2ansi"
7049 on Unix: "ansi"
7050 on VMS: "ansi"
7051 on Win 32: "win32")
7052 global
7053 Name of the terminal. Used for choosing the terminal control
7054 characters. Environment variables are expanded |:set_env|.
7055 For example: >
7056 :set term=$TERM
7057< See |termcap|.
7058
7059 *'termbidi'* *'tbidi'*
7060 *'notermbidi'* *'notbidi'*
7061'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7062 global
7063 {not in Vi}
7064 {only available when compiled with the |+arabic|
7065 feature}
7066 The terminal is in charge of Bi-directionality of text (as specified
7067 by Unicode). The terminal is also expected to do the required shaping
7068 that some languages (such as Arabic) require.
7069 Setting this option implies that 'rightleft' will not be set when
7070 'arabic' is set and the value of 'arabicshape' will be ignored.
7071 Note that setting 'termbidi' has the immediate effect that
7072 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7073 This option is reset when the GUI is started.
7074 For further details see |arabic.txt|.
7075
7076 *'termencoding'* *'tenc'*
7077'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7078 Macintosh GUI: "macroman")
7079 global
7080 {only available when compiled with the |+multi_byte|
7081 feature}
7082 {not in Vi}
7083 Encoding used for the terminal. This specifies what character
7084 encoding the keyboard produces and the display will understand. For
7085 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007086 display). Except for the Mac when 'macatsui' is off, then
7087 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007088 In the Win32 console version the default value is the console codepage
7089 when it differs from the ANSI codepage.
7090 *E617*
7091 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7092 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7093 Any attempts to set a different value will be rejected, and an error
7094 message is shown.
7095 For the Win32 GUI 'termencoding' is not used for typed characters,
7096 because the Win32 system always passes Unicode characters.
7097 When empty, the same encoding is used as for the 'encoding' option.
7098 This is the normal value.
7099 Not all combinations for 'termencoding' and 'encoding' are valid. See
7100 |encoding-table|.
7101 The value for this option must be supported by internal conversions or
7102 iconv(). When this is not possible no conversion will be done and you
7103 will probably experience problems with non-ASCII characters.
7104 Example: You are working with the locale set to euc-jp (Japanese) and
7105 want to edit a UTF-8 file: >
7106 :let &termencoding = &encoding
7107 :set encoding=utf-8
7108< You need to do this when your system has no locale support for UTF-8.
7109
7110 *'terse'* *'noterse'*
7111'terse' boolean (default off)
7112 global
7113 When set: Add 's' flag to 'shortmess' option (this makes the message
7114 for a search that hits the start or end of the file not being
7115 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7116 shortens a lot of messages}
7117
7118 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7119'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7120 global
7121 {not in Vi}
7122 This option is obsolete. Use 'fileformats'.
7123 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7124 set to the default value for the current system. When 'textauto' is
7125 reset, 'fileformats' is made empty.
7126 NOTE: This option is set to the Vi default value when 'compatible' is
7127 set and to the Vim default value when 'compatible' is reset.
7128
7129 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7130'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7131 others: default off)
7132 local to buffer
7133 {not in Vi}
7134 This option is obsolete. Use 'fileformat'.
7135 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7136 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7137 "unix".
7138
7139 *'textwidth'* *'tw'*
7140'textwidth' 'tw' number (default 0)
7141 local to buffer
7142 {not in Vi}
7143 Maximum width of text that is being inserted. A longer line will be
7144 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007145 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7146 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007148 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 NOTE: This option is set to 0 when 'compatible' is set.
7150
7151 *'thesaurus'* *'tsr'*
7152'thesaurus' 'tsr' string (default "")
7153 global or local to buffer |global-local|
7154 {not in Vi}
7155 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007156 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 the file should contain words with similar meaning, separated by
7158 non-keyword characters (white space is preferred). Maximum line
7159 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007160 To obtain a file to be used here, check out this ftp site:
7161 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007162 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007163 after a comma are ignored, otherwise spaces are included in the file
7164 name. See |option-backslash| about using backslashes.
7165 The use of |:set+=| and |:set-=| is preferred when adding or removing
7166 directories from the list. This avoids problems when a future version
7167 uses another default.
7168 Backticks cannot be used in this option for security reasons.
7169
7170 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7171'tildeop' 'top' boolean (default off)
7172 global
7173 {not in Vi}
7174 When on: The tilde command "~" behaves like an operator.
7175 NOTE: This option is reset when 'compatible' is set.
7176
7177 *'timeout'* *'to'* *'notimeout'* *'noto'*
7178'timeout' 'to' boolean (default on)
7179 global
7180 *'ttimeout'* *'nottimeout'*
7181'ttimeout' boolean (default off)
7182 global
7183 {not in Vi}
7184 These two options together determine the behavior when part of a
7185 mapped key sequence or keyboard code has been received:
7186
7187 'timeout' 'ttimeout' action ~
7188 off off do not time out
7189 on on or off time out on :mappings and key codes
7190 off on time out on key codes
7191
7192 If both options are off, Vim will wait until either the complete
7193 mapping or key sequence has been received, or it is clear that there
7194 is no mapping or key sequence for the received characters. For
7195 example: if you have mapped "vl" and Vim has received 'v', the next
7196 character is needed to see if the 'v' is followed by an 'l'.
7197 When one of the options is on, Vim will wait for about 1 second for
7198 the next character to arrive. After that the already received
7199 characters are interpreted as single characters. The waiting time can
7200 be changed with the 'timeoutlen' option.
7201 On slow terminals or very busy systems timing out may cause
7202 malfunctioning cursor keys. If both options are off, Vim waits
7203 forever after an entered <Esc> if there are key codes that start
7204 with <Esc>. You will have to type <Esc> twice. If you do not have
7205 problems with key codes, but would like to have :mapped key
7206 sequences not timing out in 1 second, set the 'ttimeout' option and
7207 reset the 'timeout' option.
7208
7209 NOTE: 'ttimeout' is reset when 'compatible' is set.
7210
7211 *'timeoutlen'* *'tm'*
7212'timeoutlen' 'tm' number (default 1000)
7213 global
7214 {not in all versions of Vi}
7215 *'ttimeoutlen'* *'ttm'*
7216'ttimeoutlen' 'ttm' number (default -1)
7217 global
7218 {not in Vi}
7219 The time in milliseconds that is waited for a key code or mapped key
7220 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7221 when part of a command has been typed.
7222 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7223 different timeout value for key codes is desired set 'ttimeoutlen' to
7224 a non-negative number.
7225
7226 ttimeoutlen mapping delay key code delay ~
7227 < 0 'timeoutlen' 'timeoutlen'
7228 >= 0 'timeoutlen' 'ttimeoutlen'
7229
7230 The timeout only happens when the 'timeout' and 'ttimeout' options
7231 tell so. A useful setting would be >
7232 :set timeout timeoutlen=3000 ttimeoutlen=100
7233< (time out on mapping after three seconds, time out on key codes after
7234 a tenth of a second).
7235
7236 *'title'* *'notitle'*
7237'title' boolean (default off, on when title can be restored)
7238 global
7239 {not in Vi}
7240 {not available when compiled without the |+title|
7241 feature}
7242 When on, the title of the window will be set to the value of
7243 'titlestring' (if it is not empty), or to:
7244 filename [+=-] (path) - VIM
7245 Where:
7246 filename the name of the file being edited
7247 - indicates the file cannot be modified, 'ma' off
7248 + indicates the file was modified
7249 = indicates the file is read-only
7250 =+ indicates the file is read-only and modified
7251 (path) is the path of the file being edited
7252 - VIM the server name |v:servername| or "VIM"
7253 Only works if the terminal supports setting window titles
7254 (currently Amiga console, Win32 console, all GUI versions and
7255 terminals with a non- empty 't_ts' option - these are Unix xterm and
7256 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7257 *X11*
7258 When Vim was compiled with HAVE_X11 defined, the original title will
7259 be restored if possible. The output of ":version" will include "+X11"
7260 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7261 works for the icon name |'icon'|.
7262 But: When Vim was started with the |-X| argument, restoring the title
7263 will not work (except in the GUI).
7264 If the title cannot be restored, it is set to the value of 'titleold'.
7265 You might want to restore the title outside of Vim then.
7266 When using an xterm from a remote machine you can use this command:
7267 rsh machine_name xterm -display $DISPLAY &
7268 then the WINDOWID environment variable should be inherited and the
7269 title of the window should change back to what it should be after
7270 exiting Vim.
7271
7272 *'titlelen'*
7273'titlelen' number (default 85)
7274 global
7275 {not in Vi}
7276 {not available when compiled without the |+title|
7277 feature}
7278 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007279 title. When the title is longer, only the end of the path name is
7280 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 Using a percentage makes this adapt to the width of the window. But
7282 it won't work perfectly, because the actual number of characters
7283 available also depends on the font used and other things in the title
7284 bar. When 'titlelen' is zero the full path is used. Otherwise,
7285 values from 1 to 30000 percent can be used.
7286 'titlelen' is also used for the 'titlestring' option.
7287
7288 *'titleold'*
7289'titleold' string (default "Thanks for flying Vim")
7290 global
7291 {not in Vi}
7292 {only available when compiled with the |+title|
7293 feature}
7294 This option will be used for the window title when exiting Vim if the
7295 original title cannot be restored. Only happens if 'title' is on or
7296 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007297 This option cannot be set from a |modeline| or in the |sandbox|, for
7298 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007299 *'titlestring'*
7300'titlestring' string (default "")
7301 global
7302 {not in Vi}
7303 {not available when compiled without the |+title|
7304 feature}
7305 When this option is not empty, it will be used for the title of the
7306 window. This happens only when the 'title' option is on.
7307 Only works if the terminal supports setting window titles (currently
7308 Amiga console, Win32 console, all GUI versions and terminals with a
7309 non-empty 't_ts' option).
7310 When Vim was compiled with HAVE_X11 defined, the original title will
7311 be restored if possible |X11|.
7312 When this option contains printf-style '%' items, they will be
7313 expanded according to the rules used for 'statusline'.
7314 Example: >
7315 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7316 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7317< The value of 'titlelen' is used to align items in the middle or right
7318 of the available space.
7319 Some people prefer to have the file name first: >
7320 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7321< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007322 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007323 separating space only when needed.
7324 NOTE: Use of special characters in 'titlestring' may cause the display
7325 to be garbled (e.g., when it contains a CR or NL character).
7326 {not available when compiled without the |+statusline| feature}
7327
7328 *'toolbar'* *'tb'*
7329'toolbar' 'tb' string (default "icons,tooltips")
7330 global
7331 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7332 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007333 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007334 possible values are:
7335 icons Toolbar buttons are shown with icons.
7336 text Toolbar buttons shown with text.
7337 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007338 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007339 tooltips Tooltips are active for toolbar buttons.
7340 Tooltips refer to the popup help text which appears after the mouse
7341 cursor is placed over a toolbar button for a brief moment.
7342
7343 If you want the toolbar to be shown with icons as well as text, do the
7344 following: >
7345 :set tb=icons,text
7346< Motif and Athena cannot display icons and text at the same time. They
7347 will show icons if both are requested.
7348
7349 If none of the strings specified in 'toolbar' are valid or if
7350 'toolbar' is empty, this option is ignored. If you want to disable
7351 the toolbar, you need to set the 'guioptions' option. For example: >
7352 :set guioptions-=T
7353< Also see |gui-toolbar|.
7354
7355 *'toolbariconsize'* *'tbis'*
7356'toolbariconsize' 'tbis' string (default "small")
7357 global
7358 {not in Vi}
7359 {only in the GTK+ 2 GUI}
7360 Controls the size of toolbar icons. The possible values are:
7361 tiny Use tiny toolbar icons.
7362 small Use small toolbar icons (default).
7363 medium Use medium-sized toolbar icons.
7364 large Use large toolbar icons.
7365 The exact dimensions in pixels of the various icon sizes depend on
7366 the current theme. Common dimensions are large=32x32, medium=24x24,
7367 small=20x20 and tiny=16x16.
7368
7369 If 'toolbariconsize' is empty, the global default size as determined
7370 by user preferences or the current theme is used.
7371
7372 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7373'ttybuiltin' 'tbi' boolean (default on)
7374 global
7375 {not in Vi}
7376 When on, the builtin termcaps are searched before the external ones.
7377 When off the builtin termcaps are searched after the external ones.
7378 When this option is changed, you should set the 'term' option next for
7379 the change to take effect, for example: >
7380 :set notbi term=$TERM
7381< See also |termcap|.
7382 Rationale: The default for this option is "on", because the builtin
7383 termcap entries are generally better (many systems contain faulty
7384 xterm entries...).
7385
7386 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7387'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7388 sun-cmd, screen, rxvt, dtterm or
7389 iris-ansi; also on when running Vim in
7390 a DOS console)
7391 global
7392 {not in Vi}
7393 Indicates a fast terminal connection. More characters will be sent to
7394 the screen for redrawing, instead of using insert/delete line
7395 commands. Improves smoothness of redrawing when there are multiple
7396 windows and the terminal does not support a scrolling region.
7397 Also enables the extra writing of characters at the end of each screen
7398 line for lines that wrap. This helps when using copy/paste with the
7399 mouse in an xterm and other terminals.
7400
7401 *'ttymouse'* *'ttym'*
7402'ttymouse' 'ttym' string (default depends on 'term')
7403 global
7404 {not in Vi}
7405 {only in Unix and VMS, doesn't work in the GUI; not
7406 available when compiled without |+mouse|}
7407 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007408 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409 *xterm-mouse*
7410 xterm xterm-like mouse handling. The mouse generates
7411 "<Esc>[Mscr", where "scr" is three bytes:
7412 "s" = button state
7413 "c" = column plus 33
7414 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007415 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007416 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417 xterm2 Works like "xterm", but with the xterm reporting the
7418 mouse position while the mouse is dragged. This works
7419 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007420 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421 work. See below for how Vim detects this
7422 automatically.
7423 *netterm-mouse*
7424 netterm NetTerm mouse handling. The mouse generates
7425 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7426 for the row and column.
7427 *dec-mouse*
7428 dec DEC terminal mouse handling. The mouse generates a
7429 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007430 This is also available for an Xterm, if it was
7431 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 *jsbterm-mouse*
7433 jsbterm JSB term mouse handling.
7434 *pterm-mouse*
7435 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007436 *urxvt-mouse*
7437 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar9b451252012-08-15 17:43:31 +02007438 *sgr-mouse*
7439 sgr Mouse handling for the terminal that emits SGR-styled
7440 mouse reporting. Works with xterm version 277 or
7441 later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007442
7443 The mouse handling must be enabled at compile time |+mouse_xterm|
7444 |+mouse_dec| |+mouse_netterm|.
7445 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7446 recognized, if enabled at compile time. DEC terminal mouse codes
7447 are recognized if enabled at compile time, and 'ttymouse' is not
7448 "xterm" (because the xterm and dec mouse codes conflict).
7449 This option is automatically set to "xterm", when the 'term' option is
7450 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7451 or "xterm2" already. The main use of this option is to set it to
7452 "xterm", when the terminal name doesn't start with "xterm", but it can
7453 handle xterm mouse codes.
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02007454 The "sgr" value will be set if the xterm version is 277 or later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007456 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457 feature and if |t_RV| is set to the escape sequence to request the
7458 xterm version number. Otherwise "xterm2" must be set explicitly.
7459 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7460 t_RV to an empty string: >
7461 :set t_RV=
7462<
7463 *'ttyscroll'* *'tsl'*
7464'ttyscroll' 'tsl' number (default 999)
7465 global
7466 Maximum number of lines to scroll the screen. If there are more lines
7467 to scroll the window is redrawn. For terminals where scrolling is
7468 very slow and redrawing is not slow this can be set to a small number,
7469 e.g., 3, to speed up displaying.
7470
7471 *'ttytype'* *'tty'*
7472'ttytype' 'tty' string (default from $TERM)
7473 global
7474 Alias for 'term', see above.
7475
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007476 *'undodir'* *'udir'*
7477'undodir' 'udir' string (default ".")
7478 global
7479 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007480 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007481 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007482 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007483 "." means using the directory of the file. The undo file name for
7484 "file.txt" is ".file.txt.un~".
7485 For other directories the file name is the full path of the edited
7486 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007487 When writing: The first directory that exists is used. "." always
7488 works, no directories after "." will be used for writing.
7489 When reading all entries are tried to find an undo file. The first
7490 undo file that exists is used. When it cannot be read an error is
7491 given, no further entry is used.
7492 See |undo-persistence|.
7493
7494 *'undofile'* *'udf'*
7495'undofile' 'udf' boolean (default off)
7496 local to buffer
7497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007498 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007499 When on, Vim automatically saves undo history to an undo file when
7500 writing a buffer to a file, and restores undo history from the same
7501 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007502 The directory where the undo file is stored is specified by 'undodir'.
7503 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007504 The undo file is not read when 'undoreload' causes the buffer from
7505 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007506 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007507
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 *'undolevels'* *'ul'*
7509'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7510 Win32 and OS/2)
7511 global
7512 {not in Vi}
7513 Maximum number of changes that can be undone. Since undo information
7514 is kept in memory, higher numbers will cause more memory to be used
7515 (nevertheless, a single change can use an unlimited amount of memory).
7516 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7517 itself: >
7518 set ul=0
7519< But you can also get Vi compatibility by including the 'u' flag in
7520 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007521 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 Set to a negative number for no undo at all: >
7523 set ul=-1
7524< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007525 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007527 *'undoreload'* *'ur'*
7528'undoreload' 'ur' number (default 10000)
7529 global
7530 {not in Vi}
7531 Save the whole buffer for undo when reloading it. This applies to the
7532 ":e!" command and reloading for when the buffer changed outside of
7533 Vim. |FileChangedShell|
7534 The save only happens when this options is negative or when the number
7535 of lines is smaller than the value of this option.
7536 Set this option to zero to disable undo for a reload.
7537
7538 When saving undo for a reload, any undo file is not read.
7539
7540 Note that this causes the whole buffer to be stored in memory. Set
7541 this option to a lower value if you run out of memory.
7542
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 *'updatecount'* *'uc'*
7544'updatecount' 'uc' number (default: 200)
7545 global
7546 {not in Vi}
7547 After typing this many characters the swap file will be written to
7548 disk. When zero, no swap file will be created at all (see chapter on
7549 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7550 Vim with the "-n" option, see |startup|. When editing in readonly
7551 mode this option will be initialized to 10000.
7552 The swapfile can be disabled per buffer with |'swapfile'|.
7553 When 'updatecount' is set from zero to non-zero, swap files are
7554 created for all buffers that have 'swapfile' set. When 'updatecount'
7555 is set to zero, existing swap files are not deleted.
7556 Also see |'swapsync'|.
7557 This option has no meaning in buffers where |'buftype'| is "nofile"
7558 or "nowrite".
7559
7560 *'updatetime'* *'ut'*
7561'updatetime' 'ut' number (default 4000)
7562 global
7563 {not in Vi}
7564 If this many milliseconds nothing is typed the swap file will be
7565 written to disk (see |crash-recovery|). Also used for the
7566 |CursorHold| autocommand event.
7567
7568 *'verbose'* *'vbs'*
7569'verbose' 'vbs' number (default 0)
7570 global
7571 {not in Vi, although some versions have a boolean
7572 verbose option}
7573 When bigger than zero, Vim will give messages about what it is doing.
7574 Currently, these messages are given:
7575 >= 1 When the viminfo file is read or written.
7576 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007577 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007578 >= 8 Files for which a group of autocommands is executed.
7579 >= 9 Every executed autocommand.
7580 >= 12 Every executed function.
7581 >= 13 When an exception is thrown, caught, finished, or discarded.
7582 >= 14 Anything pending in a ":finally" clause.
7583 >= 15 Every executed Ex command (truncated at 200 characters).
7584
7585 This option can also be set with the "-V" argument. See |-V|.
7586 This option is also set by the |:verbose| command.
7587
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007588 When the 'verbosefile' option is set then the verbose messages are not
7589 displayed.
7590
7591 *'verbosefile'* *'vfile'*
7592'verbosefile' 'vfile' string (default empty)
7593 global
7594 {not in Vi}
7595 When not empty all messages are written in a file with this name.
7596 When the file exists messages are appended.
7597 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007598 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007599 Setting 'verbosefile' to a new value is like making it empty first.
7600 The difference with |:redir| is that verbose messages are not
7601 displayed when 'verbosefile' is set.
7602
Bram Moolenaar071d4272004-06-13 20:20:40 +00007603 *'viewdir'* *'vdir'*
7604'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7605 "$VIM/vimfiles/view",
7606 for Unix: "~/.vim/view",
7607 for Macintosh: "$VIM:vimfiles:view"
7608 for VMS: "sys$login:vimfiles/view"
7609 for RiscOS: "Choices:vimfiles/view")
7610 global
7611 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007612 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007613 feature}
7614 Name of the directory where to store files for |:mkview|.
7615 This option cannot be set from a |modeline| or in the |sandbox|, for
7616 security reasons.
7617
7618 *'viewoptions'* *'vop'*
7619'viewoptions' 'vop' string (default: "folds,options,cursor")
7620 global
7621 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007622 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 feature}
7624 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007625 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 word save and restore ~
7627 cursor cursor position in file and in window
7628 folds manually created folds, opened/closed folds and local
7629 fold options
7630 options options and mappings local to a window or buffer (not
7631 global values for local options)
7632 slash backslashes in file names replaced with forward
7633 slashes
7634 unix with Unix end-of-line format (single <NL>), even when
7635 on Windows or DOS
7636
7637 "slash" and "unix" are useful on Windows when sharing view files
7638 with Unix. The Unix version of Vim cannot source dos format scripts,
7639 but the Windows version of Vim can source unix format scripts.
7640
7641 *'viminfo'* *'vi'* *E526* *E527* *E528*
7642'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007643 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7644 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7645 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 global
7647 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007648 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 feature}
7650 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007651 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 separated list of parameters, each consisting of a single character
7653 identifying the particular parameter, followed by a number or string
7654 which specifies the value of that parameter. If a particular
7655 character is left out, then the default value is used for that
7656 parameter. The following is a list of the identifying characters and
7657 the effect of their value.
7658 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007659 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 ! When included, save and restore global variables that start
7661 with an uppercase letter, and don't contain a lowercase
7662 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007663 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007664 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007665 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 " Maximum number of lines saved for each register. Old name of
7667 the '<' item, with the disadvantage that you need to put a
7668 backslash before the ", otherwise it will be recognized as the
7669 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007670 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 % When included, save and restore the buffer list. If Vim is
7672 started with a file name argument, the buffer list is not
7673 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007674 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 without a file name and buffers for help files are not written
7676 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007677 When followed by a number, the number specifies the maximum
7678 number of buffers that are stored. Without a number all
7679 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007680 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 ' Maximum number of previously edited files for which the marks
7682 are remembered. This parameter must always be included when
7683 'viminfo' is non-empty.
7684 Including this item also means that the |jumplist| and the
7685 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007686 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007688 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 patterns are also saved. When not included, the value of
7690 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007691 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007693 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007694 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 < Maximum number of lines saved for each register. If zero then
7696 registers are not saved. When not included, all lines are
7697 saved. '"' is the old name for this item.
7698 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007699 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007701 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007702 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 c When included, convert the text in the viminfo file from the
7704 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007705 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007706 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 f Whether file marks need to be stored. If zero, file marks ('0
7708 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007709 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007711 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007712 h Disable the effect of 'hlsearch' when loading the viminfo
7713 file. When not included, it depends on whether ":nohlsearch"
7714 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007715 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007716 n Name of the viminfo file. The name must immediately follow
7717 the 'n'. Must be the last one! If the "-i" argument was
7718 given when starting Vim, that file name overrides the one
7719 given here with 'viminfo'. Environment variables are expanded
7720 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007721 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 r Removable media. The argument is a string (up to the next
7723 ','). This parameter can be given several times. Each
7724 specifies the start of a path for which no marks will be
7725 stored. This is to avoid removable media. For MS-DOS you
7726 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7727 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7728 ignored. Maximum length of each 'r' argument is 50
7729 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007730 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 s Maximum size of an item in Kbyte. If zero then registers are
7732 not saved. Currently only applies to registers. The default
7733 "s10" will exclude registers with more than 10 Kbyte of text.
7734 Also see the '<' item above: line count limit.
7735
7736 Example: >
7737 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7738<
7739 '50 Marks will be remembered for the last 50 files you
7740 edited.
7741 <1000 Contents of registers (up to 1000 lines each) will be
7742 remembered.
7743 s100 Registers with more than 100 Kbyte text are skipped.
7744 :0 Command-line history will not be saved.
7745 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7746 no / Since '/' is not specified, the default will be used,
7747 that is, save all of the search history, and also the
7748 previous search and substitute patterns.
7749 no % The buffer list will not be saved nor read back.
7750 no h 'hlsearch' highlighting will be restored.
7751
7752 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7753 load the contents of the file, this is not done automatically.
7754
7755 This option cannot be set from a |modeline| or in the |sandbox|, for
7756 security reasons.
7757
7758 *'virtualedit'* *'ve'*
7759'virtualedit' 've' string (default "")
7760 global
7761 {not in Vi}
7762 {not available when compiled without the
7763 |+virtualedit| feature}
7764 A comma separated list of these words:
7765 block Allow virtual editing in Visual block mode.
7766 insert Allow virtual editing in Insert mode.
7767 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007768 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007769
Bram Moolenaar071d4272004-06-13 20:20:40 +00007770 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007771 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007772 of the line. Useful for selecting a rectangle in Visual mode and
7773 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007774 "onemore" is not the same, it will only allow moving the cursor just
7775 after the last character of the line. This makes some commands more
7776 consistent. Previously the cursor was always past the end of the line
7777 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007778 break some plugins or Vim scripts. For example because |l| can move
7779 the cursor after the last character. Use with care!
7780 Using the |$| command will move to the last character in the line, not
7781 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007782 It doesn't make sense to combine "all" with "onemore", but you will
7783 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784
7785 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7786'visualbell' 'vb' boolean (default off)
7787 global
7788 {not in Vi}
7789 Use visual bell instead of beeping. The terminal code to display the
7790 visual bell is given with 't_vb'. When no beep or flash is wanted,
7791 use ":set vb t_vb=".
7792 Note: When the GUI starts, 't_vb' is reset to its default value. You
7793 might want to set it again in your |gvimrc|.
7794 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7795 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7796 where 40 is the time in msec.
7797 Does not work on the Amiga, you always get a screen flash.
7798 Also see 'errorbells'.
7799
7800 *'warn'* *'nowarn'*
7801'warn' boolean (default on)
7802 global
7803 Give a warning message when a shell command is used while the buffer
7804 has been changed.
7805
7806 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7807'weirdinvert' 'wiv' boolean (default off)
7808 global
7809 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007810 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 It is provided for backwards compatibility with version 4.x.
7812 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7813 vice versa. Has no effect when the GUI is running.
7814
7815 *'whichwrap'* *'ww'*
7816'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7817 global
7818 {not in Vi}
7819 Allow specified keys that move the cursor left/right to move to the
7820 previous/next line when the cursor is on the first/last character in
7821 the line. Concatenate characters to allow this for these keys:
7822 char key mode ~
7823 b <BS> Normal and Visual
7824 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007825 h "h" Normal and Visual (not recommended)
7826 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007827 < <Left> Normal and Visual
7828 > <Right> Normal and Visual
7829 ~ "~" Normal
7830 [ <Left> Insert and Replace
7831 ] <Right> Insert and Replace
7832 For example: >
7833 :set ww=<,>,[,]
7834< allows wrap only when cursor keys are used.
7835 When the movement keys are used in combination with a delete or change
7836 operator, the <EOL> also counts for a character. This makes "3h"
7837 different from "3dh" when the cursor crosses the end of a line. This
7838 is also true for "x" and "X", because they do the same as "dl" and
7839 "dh". If you use this, you may also want to use the mapping
7840 ":map <BS> X" to make backspace delete the character in front of the
7841 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007842 When 'l' is included and it is used after an operator at the end of a
7843 line then it will not move to the next line. This makes "dl", "cl",
7844 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 NOTE: This option is set to the Vi default value when 'compatible' is
7846 set and to the Vim default value when 'compatible' is reset.
7847
7848 *'wildchar'* *'wc'*
7849'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7850 global
7851 {not in Vi}
7852 Character you have to type to start wildcard expansion in the
7853 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007854 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007855 The character is not recognized when used inside a macro. See
7856 'wildcharm' for that.
7857 Although 'wc' is a number option, you can set it to a special key: >
7858 :set wc=<Esc>
7859< NOTE: This option is set to the Vi default value when 'compatible' is
7860 set and to the Vim default value when 'compatible' is reset.
7861
7862 *'wildcharm'* *'wcm'*
7863'wildcharm' 'wcm' number (default: none (0))
7864 global
7865 {not in Vi}
7866 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007867 recognized when used inside a macro. You can find "spare" command-line
7868 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869 you'll never actually type 'wildcharm', just use it in mappings that
7870 automatically invoke completion mode, e.g.: >
7871 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007872 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007873< Then after typing :ss you can use CTRL-P & CTRL-N.
7874
7875 *'wildignore'* *'wig'*
7876'wildignore' 'wig' string (default "")
7877 global
7878 {not in Vi}
7879 {not available when compiled without the |+wildignore|
7880 feature}
7881 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02007882 patterns is ignored when expanding |wildcards|, completing file or
7883 directory names, and influences the result of |expand()|, |glob()| and
7884 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007885 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7886 Also see 'suffixes'.
7887 Example: >
7888 :set wildignore=*.o,*.obj
7889< The use of |:set+=| and |:set-=| is preferred when adding or removing
7890 a pattern from the list. This avoids problems when a future version
7891 uses another default.
7892
Bram Moolenaar94950a92010-12-02 16:01:29 +01007893
Bram Moolenaar81af9252010-12-10 20:35:50 +01007894 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007895'wildignorecase' 'wic' boolean (default off)
7896 global
7897 {not in Vi}
7898 When set case is ignored when completing file names and directories.
7899 Has no effect on systems where file name case is generally ignored.
7900 Does not apply when the shell is used to expand wildcards, which
7901 happens when there are special characters.
7902
7903
Bram Moolenaar071d4272004-06-13 20:20:40 +00007904 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7905'wildmenu' 'wmnu' boolean (default off)
7906 global
7907 {not in Vi}
7908 {not available if compiled without the |+wildmenu|
7909 feature}
7910 When 'wildmenu' is on, command-line completion operates in an enhanced
7911 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7912 the possible matches are shown just above the command line, with the
7913 first match highlighted (overwriting the status line, if there is
7914 one). Keys that show the previous/next match, such as <Tab> or
7915 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7916 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7917 specified. "longest" and "list" do not start "wildmenu" mode.
7918 If there are more matches than can fit in the line, a ">" is shown on
7919 the right and/or a "<" is shown on the left. The status line scrolls
7920 as needed.
7921 The "wildmenu" mode is abandoned when a key is hit that is not used
7922 for selecting a completion.
7923 While the "wildmenu" is active the following keys have special
7924 meanings:
7925
7926 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7927 <Down> - in filename/menu name completion: move into a
7928 subdirectory or submenu.
7929 <CR> - in menu completion, when the cursor is just after a
7930 dot: move into a submenu.
7931 <Up> - in filename/menu name completion: move up into
7932 parent directory or parent menu.
7933
7934 This makes the menus accessible from the console |console-menus|.
7935
7936 If you prefer the <Left> and <Right> keys to move the cursor instead
7937 of selecting a different match, use this: >
7938 :cnoremap <Left> <Space><BS><Left>
7939 :cnoremap <Right> <Space><BS><Right>
7940<
7941 The "WildMenu" highlighting is used for displaying the current match
7942 |hl-WildMenu|.
7943
7944 *'wildmode'* *'wim'*
7945'wildmode' 'wim' string (Vim default: "full")
7946 global
7947 {not in Vi}
7948 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007949 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007950 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007951 first part specifies the behavior for the first use of 'wildchar',
7952 The second part for the second use, etc.
7953 These are the possible values for each part:
7954 "" Complete only the first match.
7955 "full" Complete the next full match. After the last match,
7956 the original string is used and then the first match
7957 again.
7958 "longest" Complete till longest common string. If this doesn't
7959 result in a longer string, use the next part.
7960 "longest:full" Like "longest", but also start 'wildmenu' if it is
7961 enabled.
7962 "list" When more than one match, list all matches.
7963 "list:full" When more than one match, list all matches and
7964 complete first match.
7965 "list:longest" When more than one match, list all matches and
7966 complete till longest common string.
7967 When there is only a single match, it is fully completed in all cases.
7968
7969 Examples: >
7970 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007971< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 :set wildmode=longest,full
7973< Complete longest common string, then each full match >
7974 :set wildmode=list:full
7975< List all matches and complete each full match >
7976 :set wildmode=list,full
7977< List all matches without completing, then each full match >
7978 :set wildmode=longest,list
7979< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007980 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007982 *'wildoptions'* *'wop'*
7983'wildoptions' 'wop' string (default "")
7984 global
7985 {not in Vi}
7986 {not available when compiled without the |+wildignore|
7987 feature}
7988 A list of words that change how command line completion is done.
7989 Currently only one word is allowed:
7990 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007991 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007992 is displayed per line. Often used tag kinds are:
7993 d #define
7994 f function
7995 Also see |cmdline-completion|.
7996
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 *'winaltkeys'* *'wak'*
7998'winaltkeys' 'wak' string (default "menu")
7999 global
8000 {not in Vi}
8001 {only used in Win32, Motif, GTK and Photon GUI}
8002 Some GUI versions allow the access to menu entries by using the ALT
8003 key in combination with a character that appears underlined in the
8004 menu. This conflicts with the use of the ALT key for mappings and
8005 entering special characters. This option tells what to do:
8006 no Don't use ALT keys for menus. ALT key combinations can be
8007 mapped, but there is no automatic handling. This can then be
8008 done with the |:simalt| command.
8009 yes ALT key handling is done by the windowing system. ALT key
8010 combinations cannot be mapped.
8011 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008012 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 keys can be mapped.
8014 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8015 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008016 This option is not used for <F10>; on Win32 and with GTK <F10> will
8017 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008019 *'window'* *'wi'*
8020'window' 'wi' number (default screen height - 1)
8021 global
8022 Window height. Do not confuse this with the height of the Vim window,
8023 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008024 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8025 value is smaller than 'lines' minus one. The screen will scroll
8026 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008027 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8028 in a much smarter way, taking care of wrapping lines.
8029 When resizing the Vim window, the value is smaller than 1 or more than
8030 or equal to 'lines' it will be set to 'lines' minus 1.
8031 {Vi also uses the option to specify the number of displayed lines}
8032
Bram Moolenaar071d4272004-06-13 20:20:40 +00008033 *'winheight'* *'wh'* *E591*
8034'winheight' 'wh' number (default 1)
8035 global
8036 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008037 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 feature}
8039 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008040 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008041 focus goes to a window that is smaller, its size is increased, at the
8042 cost of the height of other windows.
8043 Set 'winheight' to a small number for normal editing.
8044 Set it to 999 to make the current window fill most of the screen.
8045 Other windows will be only 'winminheight' high. This has the drawback
8046 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8047 to create only two windows, set the option after startup is done,
8048 using the |VimEnter| event: >
8049 au VimEnter * set winheight=999
8050< Minimum value is 1.
8051 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008052 height of the current window.
8053 'winheight' applies to the current window. Use 'winminheight' to set
8054 the minimal height for other windows.
8055
8056 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8057'winfixheight' 'wfh' boolean (default off)
8058 local to window
8059 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008060 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008061 feature}
8062 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008063 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8064 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008065 The height may be changed anyway when running out of room.
8066
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008067 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8068'winfixwidth' 'wfw' boolean (default off)
8069 local to window
8070 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008071 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008072 feature}
8073 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008074 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008075 The width may be changed anyway when running out of room.
8076
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 *'winminheight'* *'wmh'*
8078'winminheight' 'wmh' number (default 1)
8079 global
8080 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008081 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 feature}
8083 The minimal height of a window, when it's not the current window.
8084 This is a hard minimum, windows will never become smaller.
8085 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8086 status bar) if necessary. They will return to at least one line when
8087 they become active (since the cursor has to have somewhere to go.)
8088 Use 'winheight' to set the minimal height of the current window.
8089 This option is only checked when making a window smaller. Don't use a
8090 large number, it will cause errors when opening more than a few
8091 windows. A value of 0 to 3 is reasonable.
8092
8093 *'winminwidth'* *'wmw'*
8094'winminwidth' 'wmw' number (default 1)
8095 global
8096 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008097 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 feature}
8099 The minimal width of a window, when it's not the current window.
8100 This is a hard minimum, windows will never become smaller.
8101 When set to zero, windows may be "squashed" to zero columns (i.e. just
8102 a vertical separator) if necessary. They will return to at least one
8103 line when they become active (since the cursor has to have somewhere
8104 to go.)
8105 Use 'winwidth' to set the minimal width of the current window.
8106 This option is only checked when making a window smaller. Don't use a
8107 large number, it will cause errors when opening more than a few
8108 windows. A value of 0 to 12 is reasonable.
8109
8110 *'winwidth'* *'wiw'* *E592*
8111'winwidth' 'wiw' number (default 20)
8112 global
8113 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008114 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 feature}
8116 Minimal number of columns for the current window. This is not a hard
8117 minimum, Vim will use fewer columns if there is not enough room. If
8118 the current window is smaller, its size is increased, at the cost of
8119 the width of other windows. Set it to 999 to make the current window
8120 always fill the screen. Set it to a small number for normal editing.
8121 The width is not adjusted after one of the commands to change the
8122 width of the current window.
8123 'winwidth' applies to the current window. Use 'winminwidth' to set
8124 the minimal width for other windows.
8125
8126 *'wrap'* *'nowrap'*
8127'wrap' boolean (default on)
8128 local to window
8129 {not in Vi}
8130 This option changes how text is displayed. It doesn't change the text
8131 in the buffer, see 'textwidth' for that.
8132 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008133 displaying continues on the next line. When off lines will not wrap
8134 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008135 moved to a part that is not shown, the screen will scroll
8136 horizontally.
8137 The line will be broken in the middle of a word if necessary. See
8138 'linebreak' to get the break at a word boundary.
8139 To make scrolling horizontally a bit more useful, try this: >
8140 :set sidescroll=5
8141 :set listchars+=precedes:<,extends:>
8142< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008143 This option can't be set from a |modeline| when the 'diff' option is
8144 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145
8146 *'wrapmargin'* *'wm'*
8147'wrapmargin' 'wm' number (default 0)
8148 local to buffer
8149 Number of characters from the right window border where wrapping
8150 starts. When typing text beyond this limit, an <EOL> will be inserted
8151 and inserting continues on the next line.
8152 Options that add a margin, such as 'number' and 'foldcolumn', cause
8153 the text width to be further reduced. This is Vi compatible.
8154 When 'textwidth' is non-zero, this option is not used.
8155 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8156 and less usefully}
8157
8158 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8159'wrapscan' 'ws' boolean (default on) *E384* *E385*
8160 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008161 Searches wrap around the end of the file. Also applies to |]s| and
8162 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163
8164 *'write'* *'nowrite'*
8165'write' boolean (default on)
8166 global
8167 {not in Vi}
8168 Allows writing files. When not set, writing a file is not allowed.
8169 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008170 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008171 argument. Filtering text is still possible, even though this requires
8172 writing a temporary file.
8173
8174 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8175'writeany' 'wa' boolean (default off)
8176 global
8177 Allows writing to any file with no need for "!" override.
8178
8179 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8180'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8181 otherwise)
8182 global
8183 {not in Vi}
8184 Make a backup before overwriting a file. The backup is removed after
8185 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008186 also on.
8187 WARNING: Switching this option off means that when Vim fails to write
8188 your buffer correctly and then, for whatever reason, Vim exits, you
8189 lose both the original file and what you were writing. Only reset
8190 this option if your file system is almost full and it makes the write
8191 fail (and make sure not to exit Vim until the write was successful).
8192 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008193 When the 'backupskip' pattern matches, a backup is not made anyway.
8194 NOTE: This option is set to the default value when 'compatible' is
8195 set.
8196
8197 *'writedelay'* *'wd'*
8198'writedelay' 'wd' number (default 0)
8199 global
8200 {not in Vi}
8201 The number of microseconds to wait for each character sent to the
8202 screen. When non-zero, characters are sent to the terminal one by
8203 one. For MS-DOS pcterm this does not work. For debugging purposes.
8204
8205 vim:tw=78:ts=8:ft=help:norl: