blob: 6be278aac8032fe0e0c3cf21a029526636623df1 [file] [log] [blame]
Bram Moolenaar00154502013-02-13 16:15:55 +01001*options.txt* For Vim version 7.3. Last change: 2013 Feb 13
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 Moolenaar00154502013-02-13 16:15:55 +01001466 unnamedplus A variant of the "unnamed" flag which uses the
1467 clipboard register '+' (|quoteplus|) instead of
1468 register '*' for all yank, delete, change and put
1469 operations which would normally go to the unnamed
1470 register. When "unnamed" is also included to the
1471 option, yank operations (but not delete, change or
1472 put) will additionally copy the text into register
1473 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001474 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001475 Availability can be checked with: >
1476 if has('unnamedplus')
1477<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001478 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479 autoselect Works like the 'a' flag in 'guioptions': If present,
1480 then whenever Visual mode is started, or the Visual
1481 area extended, Vim tries to become the owner of the
1482 windowing system's global selection or put the
1483 selected text on the clipboard used by the selection
1484 register "*. See |guioptions_a| and |quotestar| for
1485 details. When the GUI is active, the 'a' flag in
1486 'guioptions' is used, when the GUI is not active, this
1487 "autoselect" flag is used.
1488 Also applies to the modeless selection.
1489
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001490 *clipboard-autoselectplus*
1491 autoselectplus Like "autoselect" but using the + register instead of
1492 the * register. Compare to the 'P' flag in
1493 'guioptions'.
1494
1495 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 autoselectml Like "autoselect", but for the modeless selection
1497 only. Compare to the 'A' flag in 'guioptions'.
1498
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001499 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001500 html When the clipboard contains HTML, use this when
1501 pasting. When putting text on the clipboard, mark it
1502 as HTML. This works to copy rendered HTML from
1503 Firefox, paste it as raw HTML in Vim, select the HTML
1504 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001505 You probably want to add this only temporarily,
1506 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001507 Only supported for GTK version 2 and later.
1508 Only available with the |+multi_byte| feature.
1509
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001510 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 exclude:{pattern}
1512 Defines a pattern that is matched against the name of
1513 the terminal 'term'. If there is a match, no
1514 connection will be made to the X server. This is
1515 useful in this situation:
1516 - Running Vim in a console.
1517 - $DISPLAY is set to start applications on another
1518 display.
1519 - You do not want to connect to the X server in the
1520 console, but do want this in a terminal emulator.
1521 To never connect to the X server use: >
1522 exclude:.*
1523< This has the same effect as using the |-X| argument.
1524 Note that when there is no connection to the X server
1525 the window title won't be restored and the clipboard
1526 cannot be accessed.
1527 The value of 'magic' is ignored, {pattern} is
1528 interpreted as if 'magic' was on.
1529 The rest of the option value will be used for
1530 {pattern}, this must be the last entry.
1531
1532 *'cmdheight'* *'ch'*
1533'cmdheight' 'ch' number (default 1)
1534 global
1535 {not in Vi}
1536 Number of screen lines to use for the command-line. Helps avoiding
1537 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001538 The value of this option is stored with the tab page, so that each tab
1539 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540
1541 *'cmdwinheight'* *'cwh'*
1542'cmdwinheight' 'cwh' number (default 7)
1543 global
1544 {not in Vi}
1545 {not available when compiled without the |+vertsplit|
1546 feature}
1547 Number of screen lines to use for the command-line window. |cmdwin|
1548
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001549 *'colorcolumn'* *'cc'*
1550'colorcolumn' 'cc' string (default "")
1551 local to window
1552 {not in Vi}
1553 {not available when compiled without the |+syntax|
1554 feature}
1555 'colorcolumn' is a comma separated list of screen columns that are
1556 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1557 text. Will make screen redrawing slower.
1558 The screen column can be an absolute number, or a number preceded with
1559 '+' or '-', which is added to or subtracted from 'textwidth'. >
1560
1561 :set cc=+1 " highlight column after 'textwidth'
1562 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1563 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1564<
1565 When 'textwidth' is zero then the items with '-' and '+' are not used.
1566 A maximum of 256 columns are highlighted.
1567
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 *'columns'* *'co'* *E594*
1569'columns' 'co' number (default 80 or terminal width)
1570 global
1571 {not in Vi}
1572 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001573 initialization and does not have to be set by hand. Also see
1574 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001575 When Vim is running in the GUI or in a resizable window, setting this
1576 option will cause the window size to be changed. When you only want
1577 to use the size for the GUI, put the command in your |gvimrc| file.
1578 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001579 number of columns of the display, the display may be messed up. For
1580 the GUI it is always possible and Vim limits the number of columns to
1581 what fits on the screen. You can use this command to get the widest
1582 window possible: >
1583 :set columns=9999
1584< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585
1586 *'comments'* *'com'* *E524* *E525*
1587'comments' 'com' string (default
1588 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1589 local to buffer
1590 {not in Vi}
1591 {not available when compiled without the |+comments|
1592 feature}
1593 A comma separated list of strings that can start a comment line. See
1594 |format-comments|. See |option-backslash| about using backslashes to
1595 insert a space.
1596
1597 *'commentstring'* *'cms'* *E537*
1598'commentstring' 'cms' string (default "/*%s*/")
1599 local to buffer
1600 {not in Vi}
1601 {not available when compiled without the |+folding|
1602 feature}
1603 A template for a comment. The "%s" in the value is replaced with the
1604 comment text. Currently only used to add markers for folding, see
1605 |fold-marker|.
1606
1607 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001608'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1609 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 global
1611 {not in Vi}
1612 This option has the effect of making Vim either more Vi-compatible, or
1613 make Vim behave in a more useful way.
1614 This is a special kind of option, because when it's set or reset,
1615 other options are also changed as a side effect. CAREFUL: Setting or
1616 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001617 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 set this option in your vimrc file, you should probably put it at the
1619 very start.
1620 By default this option is on and the Vi defaults are used for the
1621 options. This default was chosen for those people who want to use Vim
1622 just like Vi, and don't even (want to) know about the 'compatible'
1623 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001624 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001625 this option is switched off, and all options that have not been
1626 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001627 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001628 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001629 happen for the system-wide vimrc or gvimrc file, nor for a file given
1630 with the |-u| argument). Also see |compatible-default| and
1631 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 You can also set this option with the "-C" argument, and reset it with
1633 "-N". See |-C| and |-N|.
1634 Switching this option off makes the Vim defaults be used for options
1635 that have a different Vi and Vim default value. See the options
1636 marked with a '+' below. Other options are not modified.
1637 At the moment this option is set, several other options will be set
1638 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001639 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 editing.
1641 See also 'cpoptions'.
1642
1643 option + set value effect ~
1644
1645 'allowrevins' off no CTRL-_ command
1646 'backupcopy' Unix: "yes" backup file is a copy
1647 others: "auto" copy or rename backup file
1648 'backspace' "" normal backspace
1649 'backup' off no backup file
1650 'cindent' off no C code indentation
1651 'cedit' + "" no key to open the |cmdwin|
1652 'cpoptions' + (all flags) Vi-compatible flags
1653 'cscopetag' off don't use cscope for ":tag"
1654 'cscopetagorder' 0 see |cscopetagorder|
1655 'cscopeverbose' off see |cscopeverbose|
1656 'digraph' off no digraphs
1657 'esckeys' + off no <Esc>-keys in Insert mode
1658 'expandtab' off tabs not expanded to spaces
1659 'fileformats' + "" no automatic file format detection,
1660 "dos,unix" except for DOS, Windows and OS/2
1661 'formatoptions' + "vt" Vi compatible formatting
1662 'gdefault' off no default 'g' flag for ":s"
1663 'history' + 0 no commandline history
1664 'hkmap' off no Hebrew keyboard mapping
1665 'hkmapp' off no phonetic Hebrew keyboard mapping
1666 'hlsearch' off no highlighting of search matches
1667 'incsearch' off no incremental searching
1668 'indentexpr' "" no indenting by expression
1669 'insertmode' off do not start in Insert mode
1670 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1671 characters and '_'
1672 'joinspaces' on insert 2 spaces after period
1673 'modeline' + off no modelines
1674 'more' + off no pauses in listings
1675 'revins' off no reverse insert
1676 'ruler' off no ruler
1677 'scrolljump' 1 no jump scroll
1678 'scrolloff' 0 no scroll offset
1679 'shiftround' off indent not rounded to shiftwidth
1680 'shortmess' + "" no shortening of messages
1681 'showcmd' + off command characters not shown
1682 'showmode' + off current mode not shown
1683 'smartcase' off no automatic ignore case switch
1684 'smartindent' off no smart indentation
1685 'smarttab' off no smart tab size
1686 'softtabstop' 0 tabs are always 'tabstop' positions
1687 'startofline' on goto startofline with some commands
1688 'tagrelative' + off tag file names are not relative
1689 'textauto' + off no automatic textmode detection
1690 'textwidth' 0 no automatic line wrap
1691 'tildeop' off tilde is not an operator
1692 'ttimeout' off no terminal timeout
1693 'whichwrap' + "" left-right movements don't wrap
1694 'wildchar' + CTRL-E only when the current value is <Tab>
1695 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001696 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697
1698 *'complete'* *'cpt'* *E535*
1699'complete' 'cpt' string (default: ".,w,b,u,t,i")
1700 local to buffer
1701 {not in Vi}
1702 This option specifies how keyword completion |ins-completion| works
1703 when CTRL-P or CTRL-N are used. It is also used for whole-line
1704 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1705 and the places to scan. It is a comma separated list of flags:
1706 . scan the current buffer ('wrapscan' is ignored)
1707 w scan buffers from other windows
1708 b scan other loaded buffers that are in the buffer list
1709 u scan the unloaded buffers that are in the buffer list
1710 U scan the buffers that are not in the buffer list
1711 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001712 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001713 k{dict} scan the file {dict}. Several "k" flags can be given,
1714 patterns are valid too. For example: >
1715 :set cpt=k/usr/dict/*,k~/spanish
1716< s scan the files given with the 'thesaurus' option
1717 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1718 are valid too.
1719 i scan current and included files
1720 d scan current and included files for defined name or macro
1721 |i_CTRL-X_CTRL-D|
1722 ] tag completion
1723 t same as "]"
1724
1725 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1726 not executed, this may lead to unexpected completions from some files
1727 (gzipped files for example). Unloaded buffers are not scanned for
1728 whole-line completion.
1729
1730 The default is ".,w,b,u,t,i", which means to scan:
1731 1. the current buffer
1732 2. buffers in other windows
1733 3. other loaded buffers
1734 4. unloaded buffers
1735 5. tags
1736 6. included files
1737
1738 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001739 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1740 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001742 *'completefunc'* *'cfu'*
1743'completefunc' 'cfu' string (default: empty)
1744 local to buffer
1745 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001746 {not available when compiled without the |+eval|
1747 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001748 This option specifies a function to be used for Insert mode completion
1749 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001750 See |complete-functions| for an explanation of how the function is
1751 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001752 This option cannot be set from a |modeline| or in the |sandbox|, for
1753 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001754
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001755 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001756'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001757 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001758 {not available when compiled without the
1759 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001760 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001761 A comma separated list of options for Insert mode completion
1762 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001763
1764 menu Use a popup menu to show the possible completions. The
1765 menu is only shown when there is more than one match and
1766 sufficient colors are available. |ins-completion-menu|
1767
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001768 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001769 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001770 match, e.g., what file it comes from.
1771
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001772 longest Only insert the longest common text of the matches. If
1773 the menu is displayed you can use CTRL-L to add more
1774 characters. Whether case is ignored depends on the kind
1775 of completion. For buffer text the 'ignorecase' option is
1776 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001777
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001778 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001779 completion in the preview window. Only works in
1780 combination with "menu" or "menuone".
1781
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001782
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001783 *'concealcursor'* *'cocu'*
1784'concealcursor' 'cocu' string (default: "")
1785 local to window
1786 {not in Vi}
1787 {not available when compiled without the |+conceal|
1788 feature}
1789 Sets the modes in which text in the cursor line can also be concealed.
1790 When the current mode is listed then concealing happens just like in
1791 other lines.
1792 n Normal mode
1793 v Visual mode
1794 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001795 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001796
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001797 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001798 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001799 are moving around text is concealed, but when starting to insert text
1800 or selecting a Visual area the concealed text is displayed, so that
1801 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001802 Keep in mind that the cursor position is not always where it's
1803 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001804
1805
1806'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001807 number (default 0)
1808 local to window
1809 {not in Vi}
1810 {not available when compiled without the |+conceal|
1811 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001812 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1813 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001814
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001815 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001816 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001817 1 Each block of concealed text is replaced with one
1818 character. If the syntax item does not have a custom
1819 replacement character defined (see |:syn-cchar|) the
1820 character defined in 'listchars' is used (default is a
1821 space).
1822 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001823 2 Concealed text is completely hidden unless it has a
1824 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001825 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001826 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001827
Bram Moolenaara7781e02010-07-19 20:13:22 +02001828 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001829 edit and copy the text. This can be changed with the 'concealcursor'
1830 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001831
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1833'confirm' 'cf' boolean (default off)
1834 global
1835 {not in Vi}
1836 When 'confirm' is on, certain operations that would normally
1837 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1838 instead raise a |dialog| asking if you wish to save the current
1839 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1840 If 'confirm' is off you can still activate confirmation for one
1841 command only (this is most useful in mappings) with the |:confirm|
1842 command.
1843 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1844
1845 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1846'conskey' 'consk' boolean (default off)
1847 global
1848 {not in Vi} {only for MS-DOS}
1849 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001850 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001851 three methods of console input are available:
1852 'conskey' 'bioskey' action ~
1853 on on or off direct console input
1854 off on BIOS
1855 off off STDIN
1856
1857 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1858'copyindent' 'ci' boolean (default off)
1859 local to buffer
1860 {not in Vi}
1861 Copy the structure of the existing lines indent when autoindenting a
1862 new line. Normally the new indent is reconstructed by a series of
1863 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1864 in which case only spaces are used). Enabling this option makes the
1865 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001866 existing line. 'expandtab' has no effect on these characters, a Tab
1867 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868 line, the remaining space is filled in the normal manner.
1869 NOTE: 'copyindent' is reset when 'compatible' is set.
1870 Also see 'preserveindent'.
1871
1872 *'cpoptions'* *'cpo'*
1873'cpoptions' 'cpo' string (Vim default: "aABceFs",
1874 Vi default: all flags)
1875 global
1876 {not in Vi}
1877 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001878 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 not being vi-compatible is mostly or sometimes preferred.
1880 'cpoptions' stands for "compatible-options".
1881 Commas can be added for readability.
1882 To avoid problems with flags that are added in the future, use the
1883 "+=" and "-=" feature of ":set" |add-option-flags|.
1884 NOTE: This option is set to the Vi default value when 'compatible' is
1885 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001886 NOTE: This option is set to the POSIX default value at startup when
1887 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001888 variable exists |posix|. This means Vim tries to behave like the
1889 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
1891 contains behavior ~
1892 *cpo-a*
1893 a When included, a ":read" command with a file name
1894 argument will set the alternate file name for the
1895 current window.
1896 *cpo-A*
1897 A When included, a ":write" command with a file name
1898 argument will set the alternate file name for the
1899 current window.
1900 *cpo-b*
1901 b "\|" in a ":map" command is recognized as the end of
1902 the map command. The '\' is included in the mapping,
1903 the text after the '|' is interpreted as the next
1904 command. Use a CTRL-V instead of a backslash to
1905 include the '|' in the mapping. Applies to all
1906 mapping, abbreviation, menu and autocmd commands.
1907 See also |map_bar|.
1908 *cpo-B*
1909 B A backslash has no special meaning in mappings,
1910 abbreviations and the "to" part of the menu commands.
1911 Remove this flag to be able to use a backslash like a
1912 CTRL-V. For example, the command ":map X \<Esc>"
1913 results in X being mapped to:
1914 'B' included: "\^[" (^[ is a real <Esc>)
1915 'B' excluded: "<Esc>" (5 characters)
1916 ('<' excluded in both cases)
1917 *cpo-c*
1918 c Searching continues at the end of any match at the
1919 cursor position, but not further than the start of the
1920 next line. When not present searching continues
1921 one character from the cursor position. With 'c'
1922 "abababababab" only gets three matches when repeating
1923 "/abab", without 'c' there are five matches.
1924 *cpo-C*
1925 C Do not concatenate sourced lines that start with a
1926 backslash. See |line-continuation|.
1927 *cpo-d*
1928 d Using "./" in the 'tags' option doesn't mean to use
1929 the tags file relative to the current file, but the
1930 tags file in the current directory.
1931 *cpo-D*
1932 D Can't use CTRL-K to enter a digraph after Normal mode
1933 commands with a character argument, like |r|, |f| and
1934 |t|.
1935 *cpo-e*
1936 e When executing a register with ":@r", always add a
1937 <CR> to the last line, also when the register is not
1938 linewise. If this flag is not present, the register
1939 is not linewise and the last line does not end in a
1940 <CR>, then the last line is put on the command-line
1941 and can be edited before hitting <CR>.
1942 *cpo-E*
1943 E It is an error when using "y", "d", "c", "g~", "gu" or
1944 "gU" on an Empty region. The operators only work when
1945 at least one character is to be operate on. Example:
1946 This makes "y0" fail in the first column.
1947 *cpo-f*
1948 f When included, a ":read" command with a file name
1949 argument will set the file name for the current buffer,
1950 if the current buffer doesn't have a file name yet.
1951 *cpo-F*
1952 F When included, a ":write" command with a file name
1953 argument will set the file name for the current
1954 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001955 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 *cpo-g*
1957 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001958 *cpo-H*
1959 H When using "I" on a line with only blanks, insert
1960 before the last blank. Without this flag insert after
1961 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962 *cpo-i*
1963 i When included, interrupting the reading of a file will
1964 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001965 *cpo-I*
1966 I When moving the cursor up or down just after inserting
1967 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001968 *cpo-j*
1969 j When joining lines, only add two spaces after a '.',
1970 not after '!' or '?'. Also see 'joinspaces'.
1971 *cpo-J*
1972 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001973 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 white space.
1975 *cpo-k*
1976 k Disable the recognition of raw key codes in
1977 mappings, abbreviations, and the "to" part of menu
1978 commands. For example, if <Key> sends ^[OA (where ^[
1979 is <Esc>), the command ":map X ^[OA" results in X
1980 being mapped to:
1981 'k' included: "^[OA" (3 characters)
1982 'k' excluded: "<Key>" (one key code)
1983 Also see the '<' flag below.
1984 *cpo-K*
1985 K Don't wait for a key code to complete when it is
1986 halfway a mapping. This breaks mapping <F1><F1> when
1987 only part of the second <F1> has been read. It
1988 enables cancelling the mapping by typing <F1><Esc>.
1989 *cpo-l*
1990 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001991 literally, only "\]", "\^", "\-" and "\\" are special.
1992 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1994 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001995 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 *cpo-L*
1997 L When the 'list' option is set, 'wrapmargin',
1998 'textwidth', 'softtabstop' and Virtual Replace mode
1999 (see |gR|) count a <Tab> as two characters, instead of
2000 the normal behavior of a <Tab>.
2001 *cpo-m*
2002 m When included, a showmatch will always wait half a
2003 second. When not included, a showmatch will wait half
2004 a second or until a character is typed. |'showmatch'|
2005 *cpo-M*
2006 M When excluded, "%" matching will take backslashes into
2007 account. Thus in "( \( )" and "\( ( \)" the outer
2008 parenthesis match. When included "%" ignores
2009 backslashes, which is Vi compatible.
2010 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002011 n When included, the column used for 'number' and
2012 'relativenumber' will also be used for text of wrapped
2013 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 *cpo-o*
2015 o Line offset to search command is not remembered for
2016 next search.
2017 *cpo-O*
2018 O Don't complain if a file is being overwritten, even
2019 when it didn't exist when editing it. This is a
2020 protection against a file unexpectedly created by
2021 someone else. Vi didn't complain about this.
2022 *cpo-p*
2023 p Vi compatible Lisp indenting. When not present, a
2024 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002025 *cpo-P*
2026 P When included, a ":write" command that appends to a
2027 file will set the file name for the current buffer, if
2028 the current buffer doesn't have a file name yet and
2029 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002030 *cpo-q*
2031 q When joining multiple lines leave the cursor at the
2032 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 *cpo-r*
2034 r Redo ("." command) uses "/" to repeat a search
2035 command, instead of the actually used search string.
2036 *cpo-R*
2037 R Remove marks from filtered lines. Without this flag
2038 marks are kept like |:keepmarks| was used.
2039 *cpo-s*
2040 s Set buffer options when entering the buffer for the
2041 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002042 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 set when the buffer is created.
2044 *cpo-S*
2045 S Set buffer options always when entering a buffer
2046 (except 'readonly', 'fileformat', 'filetype' and
2047 'syntax'). This is the (most) Vi compatible setting.
2048 The options are set to the values in the current
2049 buffer. When you change an option and go to another
2050 buffer, the value is copied. Effectively makes the
2051 buffer options global to all buffers.
2052
2053 's' 'S' copy buffer options
2054 no no when buffer created
2055 yes no when buffer first entered (default)
2056 X yes each time when buffer entered (vi comp.)
2057 *cpo-t*
2058 t Search pattern for the tag command is remembered for
2059 "n" command. Otherwise Vim only puts the pattern in
2060 the history for search pattern, but doesn't change the
2061 last used search pattern.
2062 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002063 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 *cpo-v*
2065 v Backspaced characters remain visible on the screen in
2066 Insert mode. Without this flag the characters are
2067 erased from the screen right away. With this flag the
2068 screen newly typed text overwrites backspaced
2069 characters.
2070 *cpo-w*
2071 w When using "cw" on a blank character, only change one
2072 character and not all blanks until the start of the
2073 next word.
2074 *cpo-W*
2075 W Don't overwrite a readonly file. When omitted, ":w!"
2076 overwrites a readonly file, if possible.
2077 *cpo-x*
2078 x <Esc> on the command-line executes the command-line.
2079 The default in Vim is to abandon the command-line,
2080 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002081 *cpo-X*
2082 X When using a count with "R" the replaced text is
2083 deleted only once. Also when repeating "R" with "."
2084 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 *cpo-y*
2086 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002087 *cpo-Z*
2088 Z When using "w!" while the 'readonly' option is set,
2089 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 *cpo-!*
2091 ! When redoing a filter command, use the last used
2092 external command, whatever it was. Otherwise the last
2093 used -filter- command is used.
2094 *cpo-$*
2095 $ When making a change to one line, don't redisplay the
2096 line, but put a '$' at the end of the changed text.
2097 The changed text will be overwritten when you type the
2098 new text. The line is redisplayed if you type any
2099 command that moves the cursor from the insertion
2100 point.
2101 *cpo-%*
2102 % Vi-compatible matching is done for the "%" command.
2103 Does not recognize "#if", "#endif", etc.
2104 Does not recognize "/*" and "*/".
2105 Parens inside single and double quotes are also
2106 counted, causing a string that contains a paren to
2107 disturb the matching. For example, in a line like
2108 "if (strcmp("foo(", s))" the first paren does not
2109 match the last one. When this flag is not included,
2110 parens inside single and double quotes are treated
2111 specially. When matching a paren outside of quotes,
2112 everything inside quotes is ignored. When matching a
2113 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002114 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002115 This flag is also used for other features, such as
2116 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002117 *cpo--*
2118 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002119 it would go above the first line or below the last
2120 line. Without it the cursor moves to the first or
2121 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002122 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002123 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002124 *cpo-+*
2125 + When included, a ":write file" command will reset the
2126 'modified' flag of the buffer, even though the buffer
2127 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002128 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 * Use ":*" in the same way as ":@". When not included,
2130 ":*" is an alias for ":'<,'>", select the Visual area.
2131 *cpo-<*
2132 < Disable the recognition of special key codes in |<>|
2133 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002134 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 ":map X <Tab>" results in X being mapped to:
2136 '<' included: "<Tab>" (5 characters)
2137 '<' excluded: "^I" (^I is a real <Tab>)
2138 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002139 *cpo->*
2140 > When appending to a register, put a line break before
2141 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002142 *cpo-;*
2143 ; When using |,| or |;| to repeat the last |t| search
2144 and the cursor is right in front of the searched
2145 character, the cursor won't move. When not included,
2146 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002147 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002148
2149 POSIX flags. These are not included in the Vi default value, except
2150 when $VIM_POSIX was set on startup. |posix|
2151
2152 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002153 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002154 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002155 *cpo-&*
2156 & When ":preserve" was used keep the swap file when
2157 exiting normally while this buffer is still loaded.
2158 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002159 *cpo-\*
2160 \ Backslash in a [] range in a search pattern is taken
2161 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002162 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2163 '\' excluded: "/[ \-]" finds <Space> and '-'
2164 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002165 *cpo-/*
2166 / When "%" is used as the replacement string in a |:s|
2167 command, use the previous replacement string. |:s%|
2168 *cpo-{*
2169 { The |{| and |}| commands also stop at a "{" character
2170 at the start of a line.
2171 *cpo-.*
2172 . The ":chdir" and ":cd" commands fail if the current
2173 buffer is modified, unless ! is used. Vim doesn't
2174 need this, since it remembers the full path of an
2175 opened file.
2176 *cpo-bar*
2177 | The value of the $LINES and $COLUMNS environment
2178 variables overrule the terminal size values obtained
2179 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002182 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002183'cryptmethod' string (default "zip")
2184 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002185 {not in Vi}
2186 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002187 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002188 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002189 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002190 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002191 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002192 or later, files can NOT be read by Vim 7.2 and older.
2193 This adds a "seed" to the file, every time you write
2194 the file the encrypted bytes will be different.
2195
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002196 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002197 to the detected method of the file being read. Thus if you write it
2198 without changing 'cryptmethod' the same method will be used.
2199 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002200 explicitly write it, you don't get a warning unless there are other
2201 modifications. Also see |:X|.
2202
2203 When setting the global value to an empty string, it will end up with
2204 the value "zip". When setting the local value to an empty string the
2205 buffer will use the global value.
2206
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002207 When a new encryption method is added in a later version of Vim, and
2208 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002209 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002210
2211
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 *'cscopepathcomp'* *'cspc'*
2213'cscopepathcomp' 'cspc' number (default 0)
2214 global
2215 {not available when compiled without the |+cscope|
2216 feature}
2217 {not in Vi}
2218 Determines how many components of the path to show in a list of tags.
2219 See |cscopepathcomp|.
2220
2221 *'cscopeprg'* *'csprg'*
2222'cscopeprg' 'csprg' string (default "cscope")
2223 global
2224 {not available when compiled without the |+cscope|
2225 feature}
2226 {not in Vi}
2227 Specifies the command to execute cscope. See |cscopeprg|.
2228 This option cannot be set from a |modeline| or in the |sandbox|, for
2229 security reasons.
2230
2231 *'cscopequickfix'* *'csqf'*
2232'cscopequickfix' 'csqf' string (default "")
2233 global
2234 {not available when compiled without the |+cscope|
2235 or |+quickfix| features}
2236 {not in Vi}
2237 Specifies whether to use quickfix window to show cscope results.
2238 See |cscopequickfix|.
2239
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002240 *'cscoperelative'* *'csre'*
2241'cscoperelative' 'csre' boolean (default off)
2242 global
2243 {not available when compiled without the |+cscope|
2244 feature}
2245 {not in Vi}
2246 In the absence of a prefix (-P) for cscope. setting this option enables
2247 to use the basename of cscope.out path as the prefix.
2248 See |cscoperelative|.
2249
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2251'cscopetag' 'cst' boolean (default off)
2252 global
2253 {not available when compiled without the |+cscope|
2254 feature}
2255 {not in Vi}
2256 Use cscope for tag commands. See |cscope-options|.
2257 NOTE: This option is reset when 'compatible' is set.
2258
2259 *'cscopetagorder'* *'csto'*
2260'cscopetagorder' 'csto' number (default 0)
2261 global
2262 {not available when compiled without the |+cscope|
2263 feature}
2264 {not in Vi}
2265 Determines the order in which ":cstag" performs a search. See
2266 |cscopetagorder|.
2267 NOTE: This option is set to 0 when 'compatible' is set.
2268
2269 *'cscopeverbose'* *'csverb'*
2270 *'nocscopeverbose'* *'nocsverb'*
2271'cscopeverbose' 'csverb' boolean (default off)
2272 global
2273 {not available when compiled without the |+cscope|
2274 feature}
2275 {not in Vi}
2276 Give messages when adding a cscope database. See |cscopeverbose|.
2277 NOTE: This option is reset when 'compatible' is set.
2278
Bram Moolenaar860cae12010-06-05 23:22:07 +02002279 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2280'cursorbind' 'crb' boolean (default off)
2281 local to window
2282 {not in Vi}
2283 {not available when compiled without the |+cursorbind|
2284 feature}
2285 When this option is set, as the cursor in the current
2286 window moves other cursorbound windows (windows that also have
2287 this option set) move their cursors to the corresponding line and
2288 column. This option is useful for viewing the
2289 differences between two versions of a file (see 'diff'); in diff mode,
2290 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002291 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002292
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002293
2294 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2295'cursorcolumn' 'cuc' boolean (default off)
2296 local to window
2297 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002298 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002299 feature}
2300 Highlight the screen column of the cursor with CursorColumn
2301 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2302 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002303 If you only want the highlighting in the current window you can use
2304 these autocommands: >
2305 au WinLeave * set nocursorline nocursorcolumn
2306 au WinEnter * set cursorline cursorcolumn
2307<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002308
2309 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2310'cursorline' 'cul' boolean (default off)
2311 local to window
2312 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002313 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002314 feature}
2315 Highlight the screen line of the cursor with CursorLine
2316 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2317 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002318 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002319 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002320
2321
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 *'debug'*
2323'debug' string (default "")
2324 global
2325 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002326 These values can be used:
2327 msg Error messages that would otherwise be omitted will be given
2328 anyway.
2329 throw Error messages that would otherwise be omitted will be given
2330 anyway and also throw an exception and set |v:errmsg|.
2331 beep A message will be given when otherwise only a beep would be
2332 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002333 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002334 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2335 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336
2337 *'define'* *'def'*
2338'define' 'def' string (default "^\s*#\s*define")
2339 global or local to buffer |global-local|
2340 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002341 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002342 pattern, just like for the "/" command. This option is used for the
2343 commands like "[i" and "[d" |include-search|. The 'isident' option is
2344 used to recognize the defined name after the match:
2345 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2346 See |option-backslash| about inserting backslashes to include a space
2347 or backslash.
2348 The default value is for C programs. For C++ this value would be
2349 useful, to include const type declarations: >
2350 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2351< When using the ":set" command, you need to double the backslashes!
2352
2353 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2354'delcombine' 'deco' boolean (default off)
2355 global
2356 {not in Vi}
2357 {only available when compiled with the |+multi_byte|
2358 feature}
2359 If editing Unicode and this option is set, backspace and Normal mode
2360 "x" delete each combining character on its own. When it is off (the
2361 default) the character along with its combining characters are
2362 deleted.
2363 Note: When 'delcombine' is set "xx" may work different from "2x"!
2364
2365 This is useful for Arabic, Hebrew and many other languages where one
2366 may have combining characters overtop of base characters, and want
2367 to remove only the combining ones.
2368
2369 *'dictionary'* *'dict'*
2370'dictionary' 'dict' string (default "")
2371 global or local to buffer |global-local|
2372 {not in Vi}
2373 List of file names, separated by commas, that are used to lookup words
2374 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2375 contain a list of words. This can be one word per line, or several
2376 words per line, separated by non-keyword characters (white space is
2377 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002378 When this option is empty, or an entry "spell" is present, spell
2379 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002380 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381 after a comma are ignored, otherwise spaces are included in the file
2382 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002383 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 Where to find a list of words?
2385 - On FreeBSD, there is the file "/usr/share/dict/words".
2386 - In the Simtel archive, look in the "msdos/linguist" directory.
2387 - In "miscfiles" of the GNU collection.
2388 The use of |:set+=| and |:set-=| is preferred when adding or removing
2389 directories from the list. This avoids problems when a future version
2390 uses another default.
2391 Backticks cannot be used in this option for security reasons.
2392
2393 *'diff'* *'nodiff'*
2394'diff' boolean (default off)
2395 local to window
2396 {not in Vi}
2397 {not available when compiled without the |+diff|
2398 feature}
2399 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002400 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401
2402 *'dex'* *'diffexpr'*
2403'diffexpr' 'dex' string (default "")
2404 global
2405 {not in Vi}
2406 {not available when compiled without the |+diff|
2407 feature}
2408 Expression which is evaluated to obtain an ed-style diff file from two
2409 versions of a file. See |diff-diffexpr|.
2410 This option cannot be set from a |modeline| or in the |sandbox|, for
2411 security reasons.
2412
2413 *'dip'* *'diffopt'*
2414'diffopt' 'dip' string (default "filler")
2415 global
2416 {not in Vi}
2417 {not available when compiled without the |+diff|
2418 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002419 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 All are optional. Items must be separated by a comma.
2421
2422 filler Show filler lines, to keep the text
2423 synchronized with a window that has inserted
2424 lines at the same position. Mostly useful
2425 when windows are side-by-side and 'scrollbind'
2426 is set.
2427
2428 context:{n} Use a context of {n} lines between a change
2429 and a fold that contains unchanged lines.
2430 When omitted a context of six lines is used.
2431 See |fold-diff|.
2432
2433 icase Ignore changes in case of text. "a" and "A"
2434 are considered the same. Adds the "-i" flag
2435 to the "diff" command if 'diffexpr' is empty.
2436
2437 iwhite Ignore changes in amount of white space. Adds
2438 the "-b" flag to the "diff" command if
2439 'diffexpr' is empty. Check the documentation
2440 of the "diff" command for what this does
2441 exactly. It should ignore adding trailing
2442 white space, but not leading white space.
2443
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002444 horizontal Start diff mode with horizontal splits (unless
2445 explicitly specified otherwise).
2446
2447 vertical Start diff mode with vertical splits (unless
2448 explicitly specified otherwise).
2449
2450 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2451 starting diff mode. Without this 2 is used.
2452
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453 Examples: >
2454
2455 :set diffopt=filler,context:4
2456 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002457 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458<
2459 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2460'digraph' 'dg' boolean (default off)
2461 global
2462 {not in Vi}
2463 {not available when compiled without the |+digraphs|
2464 feature}
2465 Enable the entering of digraphs in Insert mode with {char1} <BS>
2466 {char2}. See |digraphs|.
2467 NOTE: This option is reset when 'compatible' is set.
2468
2469 *'directory'* *'dir'*
2470'directory' 'dir' string (default for Amiga: ".,t:",
2471 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2472 for Unix: ".,~/tmp,/var/tmp,/tmp")
2473 global
2474 List of directory names for the swap file, separated with commas.
2475 - The swap file will be created in the first directory where this is
2476 possible.
2477 - Empty means that no swap file will be used (recovery is
2478 impossible!).
2479 - A directory "." means to put the swap file in the same directory as
2480 the edited file. On Unix, a dot is prepended to the file name, so
2481 it doesn't show in a directory listing. On MS-Windows the "hidden"
2482 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002483 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 put the swap file relative to where the edited file is. The leading
2485 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002486 - For Unix and Win32, if a directory ends in two path separators "//"
2487 or "\\", the swap file name will be built from the complete path to
2488 the file with all path separators substituted to percent '%' signs.
2489 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002490 On Win32, when a separating comma is following, you must use "//",
2491 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002492 - Spaces after the comma are ignored, other spaces are considered part
2493 of the directory name. To have a space at the start of a directory
2494 name, precede it with a backslash.
2495 - To include a comma in a directory name precede it with a backslash.
2496 - A directory name may end in an ':' or '/'.
2497 - Environment variables are expanded |:set_env|.
2498 - Careful with '\' characters, type one before a space, type two to
2499 get one in the option (see |option-backslash|), for example: >
2500 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2501< - For backwards compatibility with Vim version 3.0 a '>' at the start
2502 of the option is removed.
2503 Using "." first in the list is recommended. This means that editing
2504 the same file twice will result in a warning. Using "/tmp" on Unix is
2505 discouraged: When the system crashes you lose the swap file.
2506 "/var/tmp" is often not cleared when rebooting, thus is a better
2507 choice than "/tmp". But it can contain a lot of files, your swap
2508 files get lost in the crowd. That is why a "tmp" directory in your
2509 home directory is tried first.
2510 The use of |:set+=| and |:set-=| is preferred when adding or removing
2511 directories from the list. This avoids problems when a future version
2512 uses another default.
2513 This option cannot be set from a |modeline| or in the |sandbox|, for
2514 security reasons.
2515 {Vi: directory to put temp file in, defaults to "/tmp"}
2516
2517 *'display'* *'dy'*
2518'display' 'dy' string (default "")
2519 global
2520 {not in Vi}
2521 Change the way text is displayed. This is comma separated list of
2522 flags:
2523 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002524 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 last line that doesn't fit is replaced with "@" lines.
2526 uhex Show unprintable characters hexadecimal as <xx>
2527 instead of using ^C and ~C.
2528
2529 *'eadirection'* *'ead'*
2530'eadirection' 'ead' string (default "both")
2531 global
2532 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002533 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 feature}
2535 Tells when the 'equalalways' option applies:
2536 ver vertically, width of windows is not affected
2537 hor horizontally, height of windows is not affected
2538 both width and height of windows is affected
2539
2540 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2541'edcompatible' 'ed' boolean (default off)
2542 global
2543 Makes the 'g' and 'c' flags of the ":substitute" command to be
2544 toggled each time the flag is given. See |complex-change|. See
2545 also 'gdefault' option.
2546 Switching this option on is discouraged!
2547
2548 *'encoding'* *'enc'* *E543*
2549'encoding' 'enc' string (default: "latin1" or value from $LANG)
2550 global
2551 {only available when compiled with the |+multi_byte|
2552 feature}
2553 {not in Vi}
2554 Sets the character encoding used inside Vim. It applies to text in
2555 the buffers, registers, Strings in expressions, text stored in the
2556 viminfo file, etc. It sets the kind of characters which Vim can work
2557 with. See |encoding-names| for the possible values.
2558
2559 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002560 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002561 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002562 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563
Bram Moolenaar865242e2010-07-14 21:12:05 +02002564 This option cannot be set from a |modeline|. It would most likely
2565 corrupt the text.
2566
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2568 "utf-8". Although care has been taken to allow different values of
2569 'encoding', "utf-8" is the natural choice for the environment and
2570 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002571 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 versions, and to avoid changing the encoding of newly created files
2573 without your knowledge (in case 'fileencodings' is empty).
2574
2575 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002576 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 iconv() or as specified with 'charconvert'.
2578
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002579 If you need to know whether 'encoding' is a multi-byte encoding, you
2580 can use: >
2581 if has("multi_byte_encoding")
2582<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 Normally 'encoding' will be equal to your current locale. This will
2584 be the default if Vim recognizes your environment settings. If
2585 'encoding' is not set to the current locale, 'termencoding' must be
2586 set to convert typed and displayed text. See |encoding-table|.
2587
2588 When you set this option, it fires the |EncodingChanged| autocommand
2589 event so that you can set up fonts if necessary.
2590
2591 When the option is set, the value is converted to lowercase. Thus
2592 you can set it with uppercase values too. Underscores are translated
2593 to '-' signs.
2594 When the encoding is recognized, it is changed to the standard name.
2595 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2596 "iso-8859-2" and "utf8" becomes "utf-8".
2597
2598 Note: "latin1" is also used when the encoding could not be detected.
2599 This only works when editing files in the same encoding! When the
2600 actual character set is not latin1, make sure 'fileencoding' and
2601 'fileencodings' are empty. When conversion is needed, switch to using
2602 utf-8.
2603
2604 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2605 You don't notice this while editing, but it does matter for the
2606 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2607 setting 'encoding' to one of these values instead of utf-8 only has
2608 effect for encoding used for files when 'fileencoding' is empty.
2609
Bram Moolenaar661b1822005-07-28 22:36:45 +00002610 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2611 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612
2613 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2614'endofline' 'eol' boolean (default on)
2615 local to buffer
2616 {not in Vi}
2617 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002618 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002619 option is automatically set when starting to edit a new file, unless
2620 the file does not have an <EOL> for the last line in the file, in
2621 which case it is reset. Normally you don't have to set or reset this
2622 option. When 'binary' is off the value is not used when writing the
2623 file. When 'binary' is on it is used to remember the presence of a
2624 <EOL> for the last line in the file, so that when you write the file
2625 the situation from the original file can be kept. But you can change
2626 it if you want to.
2627
2628 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2629'equalalways' 'ea' boolean (default on)
2630 global
2631 {not in Vi}
2632 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002633 splitting or closing a window. This also happens the moment the
2634 option is switched on. When off, splitting a window will reduce the
2635 size of the current window and leave the other windows the same. When
2636 closing a window the extra lines are given to the window next to it
2637 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 When mixing vertically and horizontally split windows, a minimal size
2639 is computed and some windows may be larger if there is room. The
2640 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002641 Changing the height and width of a window can be avoided by setting
2642 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002643 If a window size is specified when creating a new window sizes are
2644 currently not equalized (it's complicated, but may be implemented in
2645 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002646
2647 *'equalprg'* *'ep'*
2648'equalprg' 'ep' string (default "")
2649 global or local to buffer |global-local|
2650 {not in Vi}
2651 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002652 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002653 or 'indentexpr'. When Vim was compiled without internal formatting,
2654 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002655 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 about including spaces and backslashes.
2657 This option cannot be set from a |modeline| or in the |sandbox|, for
2658 security reasons.
2659
2660 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2661'errorbells' 'eb' boolean (default off)
2662 global
2663 Ring the bell (beep or screen flash) for error messages. This only
2664 makes a difference for error messages, the bell will be used always
2665 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002666 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667 screen flash or do nothing.
2668
2669 *'errorfile'* *'ef'*
2670'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2671 others: "errors.err")
2672 global
2673 {not in Vi}
2674 {not available when compiled without the |+quickfix|
2675 feature}
2676 Name of the errorfile for the QuickFix mode (see |:cf|).
2677 When the "-q" command-line argument is used, 'errorfile' is set to the
2678 following argument. See |-q|.
2679 NOT used for the ":make" command. See 'makeef' for that.
2680 Environment variables are expanded |:set_env|.
2681 See |option-backslash| about including spaces and backslashes.
2682 This option cannot be set from a |modeline| or in the |sandbox|, for
2683 security reasons.
2684
2685 *'errorformat'* *'efm'*
2686'errorformat' 'efm' string (default is very long)
2687 global or local to buffer |global-local|
2688 {not in Vi}
2689 {not available when compiled without the |+quickfix|
2690 feature}
2691 Scanf-like description of the format for the lines in the error file
2692 (see |errorformat|).
2693
2694 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2695'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2696 global
2697 {not in Vi}
2698 Function keys that start with an <Esc> are recognized in Insert
2699 mode. When this option is off, the cursor and function keys cannot be
2700 used in Insert mode if they start with an <Esc>. The advantage of
2701 this is that the single <Esc> is recognized immediately, instead of
2702 after one second. Instead of resetting this option, you might want to
2703 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2704 when 'esckeys' is off, you can still map anything, but the cursor keys
2705 won't work by default.
2706 NOTE: This option is set to the Vi default value when 'compatible' is
2707 set and to the Vim default value when 'compatible' is reset.
2708
2709 *'eventignore'* *'ei'*
2710'eventignore' 'ei' string (default "")
2711 global
2712 {not in Vi}
2713 {not available when compiled without the |+autocmd|
2714 feature}
2715 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002716 When set to "all" or when "all" is one of the items, all autocommand
2717 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 Otherwise this is a comma separated list of event names. Example: >
2719 :set ei=WinEnter,WinLeave
2720<
2721 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2722'expandtab' 'et' boolean (default off)
2723 local to buffer
2724 {not in Vi}
2725 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2728 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2729 NOTE: This option is reset when 'compatible' is set.
2730
2731 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2732'exrc' 'ex' boolean (default off)
2733 global
2734 {not in Vi}
2735 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2736 directory. If you switch this option on you should also consider
2737 setting the 'secure' option (see |initialization|). Using a local
2738 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2739 also see |.vimrc| and |gui-init|.
2740 This option cannot be set from a |modeline| or in the |sandbox|, for
2741 security reasons.
2742
2743 *'fileencoding'* *'fenc'* *E213*
2744'fileencoding' 'fenc' string (default: "")
2745 local to buffer
2746 {only available when compiled with the |+multi_byte|
2747 feature}
2748 {not in Vi}
2749 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002750
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002752 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 When 'fileencoding' is empty, the same value as 'encoding' will be
2754 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002755 Conversion will also be done when 'encoding' and 'fileencoding' are
2756 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2757 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002759 'encoding' is "utf-8" or another Unicode encoding, conversion
2760 is most likely done in a way that the reverse conversion
2761 results in the same text. When 'encoding' is not "utf-8" some
2762 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002763
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 See 'encoding' for the possible values. Additionally, values may be
2765 specified that can be handled by the converter, see
2766 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002767
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 When reading a file 'fileencoding' will be set from 'fileencodings'.
2769 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002770 'fileencoding', use the |++enc| argument. One exception: when
2771 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002772 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002773
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2775 When the option is set, the value is converted to lowercase. Thus
2776 you can set it with uppercase values too. '_' characters are
2777 replaced with '-'. If a name is recognized from the list for
2778 'encoding', it is replaced by the standard name. For example
2779 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002780
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 When this option is set, after starting to edit a file, the 'modified'
2782 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002783
2784 Keep in mind that changing 'fenc' from a modeline happens
2785 AFTER the text has been read, thus it applies to when the file will be
2786 written. If you do set 'fenc' in a modeline, you might want to set
2787 'nomodified' to avoid not being able to ":q".
2788
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 This option can not be changed when 'modifiable' is off.
2790
2791 *'fe'*
2792 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002793 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 old short name was 'fe', which is no longer used.
2795
2796 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002797'fileencodings' 'fencs' string (default: "ucs-bom",
2798 "ucs-bom,utf-8,default,latin1" when
2799 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 global
2801 {only available when compiled with the |+multi_byte|
2802 feature}
2803 {not in Vi}
2804 This is a list of character encodings considered when starting to edit
2805 an existing file. When a file is read, Vim tries to use the first
2806 mentioned character encoding. If an error is detected, the next one
2807 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002808 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 an empty string, which means the value of 'encoding' is used.
2810 WARNING: Conversion can cause loss of information! When
2811 'encoding' is "utf-8" (or one of the other Unicode variants)
2812 conversion is most likely done in a way that the reverse
2813 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002814 "utf-8" some non-ASCII characters may be lost! You can use
2815 the |++bad| argument to specify what is done with characters
2816 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 For an empty file or a file with only ASCII characters most encodings
2818 will work and the first entry of 'fileencodings' will be used (except
2819 "ucs-bom", which requires the BOM to be present). If you prefer
2820 another encoding use an BufReadPost autocommand event to test if your
2821 preferred encoding is to be used. Example: >
2822 au BufReadPost * if search('\S', 'w') == 0 |
2823 \ set fenc=iso-2022-jp | endif
2824< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2825 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002826 When the |++enc| argument is used then the value of 'fileencodings' is
2827 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002828 Note that 'fileencodings' is not used for a new file, the global value
2829 of 'fileencoding' is used instead. You can set it with: >
2830 :setglobal fenc=iso-8859-2
2831< This means that a non-existing file may get a different encoding than
2832 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 The special value "ucs-bom" can be used to check for a Unicode BOM
2834 (Byte Order Mark) at the start of the file. It must not be preceded
2835 by "utf-8" or another Unicode encoding for this to work properly.
2836 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2837 because Vim cannot detect an error, thus the encoding is always
2838 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002839 The special value "default" can be used for the encoding from the
2840 environment. This is the default value for 'encoding'. It is useful
2841 when 'encoding' is set to "utf-8" and your environment uses a
2842 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002843 When 'encoding' is "utf-8" and a file contains an illegal byte
2844 sequence it won't be recognized as UTF-8. You can use the |8g8|
2845 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 WRONG VALUES: WHAT'S WRONG:
2847 latin1,utf-8 "latin1" will always be used
2848 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2849 file
2850 cp1250,latin1 "cp1250" will always be used
2851 If 'fileencodings' is empty, 'fileencoding' is not modified.
2852 See 'fileencoding' for the possible values.
2853 Setting this option does not have an effect until the next time a file
2854 is read.
2855
2856 *'fileformat'* *'ff'*
2857'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2858 Unix default: "unix",
2859 Macintosh default: "mac")
2860 local to buffer
2861 {not in Vi}
2862 This gives the <EOL> of the current buffer, which is used for
2863 reading/writing the buffer from/to a file:
2864 dos <CR> <NL>
2865 unix <NL>
2866 mac <CR>
2867 When "dos" is used, CTRL-Z at the end of a file is ignored.
2868 See |file-formats| and |file-read|.
2869 For the character encoding of the file see 'fileencoding'.
2870 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2871 works like it was set to "unix'.
2872 This option is set automatically when starting to edit a file and
2873 'fileformats' is not empty and 'binary' is off.
2874 When this option is set, after starting to edit a file, the 'modified'
2875 option is set, because the file would be different when written.
2876 This option can not be changed when 'modifiable' is off.
2877 For backwards compatibility: When this option is set to "dos",
2878 'textmode' is set, otherwise 'textmode' is reset.
2879
2880 *'fileformats'* *'ffs'*
2881'fileformats' 'ffs' string (default:
2882 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2883 Vim Unix: "unix,dos",
2884 Vim Mac: "mac,unix,dos",
2885 Vi Cygwin: "unix,dos",
2886 Vi others: "")
2887 global
2888 {not in Vi}
2889 This gives the end-of-line (<EOL>) formats that will be tried when
2890 starting to edit a new buffer and when reading a file into an existing
2891 buffer:
2892 - When empty, the format defined with 'fileformat' will be used
2893 always. It is not set automatically.
2894 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002895 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 'fileformats' name will be used when a file is read into an existing
2897 buffer, no matter what 'fileformat' for that buffer is set to.
2898 - When more than one name is present, separated by commas, automatic
2899 <EOL> detection will be done when reading a file. When starting to
2900 edit a file, a check is done for the <EOL>:
2901 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2902 'fileformat' is set to "dos".
2903 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002904 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002906 3. If 'fileformat' has not yet been set, and if 'fileformats'
2907 includes "mac", 'fileformat' is set to "mac".
2908 This means that "mac" is only chosen when:
2909 "unix" is not present or no <NL> is found in the file, and
2910 "dos" is not present or no <CR><NL> is found in the file.
2911 Except: if "unix" was chosen, but there is a <CR> before
2912 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002913 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 4. If 'fileformat' is still not set, the first name from
2915 'fileformats' is used.
2916 When reading a file into an existing buffer, the same is done, but
2917 this happens like 'fileformat' has been set appropriately for that
2918 file only, the option is not changed.
2919 When 'binary' is set, the value of 'fileformats' is not used.
2920
Bram Moolenaar81af9252010-12-10 20:35:50 +01002921 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002922 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002923
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2925 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2926 done:
2927 - When 'fileformats' is empty, there is no automatic detection. Dos
2928 format will be used.
2929 - When 'fileformats' is set to one or more names, automatic detection
2930 is done. This is based on the first <NL> in the file: If there is a
2931 <CR> in front of it, Dos format is used, otherwise Unix format is
2932 used.
2933 Also see |file-formats|.
2934 For backwards compatibility: When this option is set to an empty
2935 string or one format (no comma is included), 'textauto' is reset,
2936 otherwise 'textauto' is set.
2937 NOTE: This option is set to the Vi default value when 'compatible' is
2938 set and to the Vim default value when 'compatible' is reset.
2939
2940 *'filetype'* *'ft'*
2941'filetype' 'ft' string (default: "")
2942 local to buffer
2943 {not in Vi}
2944 {not available when compiled without the |+autocmd|
2945 feature}
2946 When this option is set, the FileType autocommand event is triggered.
2947 All autocommands that match with the value of this option will be
2948 executed. Thus the value of 'filetype' is used in place of the file
2949 name.
2950 Otherwise this option does not always reflect the current file type.
2951 This option is normally set when the file type is detected. To enable
2952 this use the ":filetype on" command. |:filetype|
2953 Setting this option to a different value is most useful in a modeline,
2954 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002955 Example, for in an IDL file:
2956 /* vim: set filetype=idl : */ ~
2957 |FileType| |filetypes|
2958 When a dot appears in the value then this separates two filetype
2959 names. Example:
2960 /* vim: set filetype=c.doxygen : */ ~
2961 This will use the "c" filetype first, then the "doxygen" filetype.
2962 This works both for filetype plugins and for syntax files. More than
2963 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 This option is not copied to another buffer, independent of the 's' or
2965 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002966 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967
2968 *'fillchars'* *'fcs'*
2969'fillchars' 'fcs' string (default "vert:|,fold:-")
2970 global
2971 {not in Vi}
2972 {not available when compiled without the |+windows|
2973 and |+folding| features}
2974 Characters to fill the statuslines and vertical separators.
2975 It is a comma separated list of items:
2976
2977 item default Used for ~
2978 stl:c ' ' or '^' statusline of the current window
2979 stlnc:c ' ' or '-' statusline of the non-current windows
2980 vert:c '|' vertical separators |:vsplit|
2981 fold:c '-' filling 'foldtext'
2982 diff:c '-' deleted lines of the 'diff' option
2983
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002984 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 "stlnc" the space will be used when there is highlighting, '^' or '-'
2986 otherwise.
2987
2988 Example: >
2989 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2990< This is similar to the default, except that these characters will also
2991 be used when there is highlighting.
2992
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002993 for "stl" and "stlnc" only single-byte values are supported.
2994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 The highlighting used for these items:
2996 item highlight group ~
2997 stl:c StatusLine |hl-StatusLine|
2998 stlnc:c StatusLineNC |hl-StatusLineNC|
2999 vert:c VertSplit |hl-VertSplit|
3000 fold:c Folded |hl-Folded|
3001 diff:c DiffDelete |hl-DiffDelete|
3002
3003 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3004'fkmap' 'fk' boolean (default off) *E198*
3005 global
3006 {not in Vi}
3007 {only available when compiled with the |+rightleft|
3008 feature}
3009 When on, the keyboard is mapped for the Farsi character set.
3010 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012
3013 *'foldclose'* *'fcl'*
3014'foldclose' 'fcl' string (default "")
3015 global
3016 {not in Vi}
3017 {not available when compiled without the |+folding|
3018 feature}
3019 When set to "all", a fold is closed when the cursor isn't in it and
3020 its level is higher than 'foldlevel'. Useful if you want folds to
3021 automatically close when moving out of them.
3022
3023 *'foldcolumn'* *'fdc'*
3024'foldcolumn' 'fdc' number (default 0)
3025 local to window
3026 {not in Vi}
3027 {not available when compiled without the |+folding|
3028 feature}
3029 When non-zero, a column with the specified width is shown at the side
3030 of the window which indicates open and closed folds. The maximum
3031 value is 12.
3032 See |folding|.
3033
3034 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3035'foldenable' 'fen' boolean (default on)
3036 local to window
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
3039 feature}
3040 When off, all folds are open. This option can be used to quickly
3041 switch between showing all text unfolded and viewing the text with
3042 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003043 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 'foldenable' is off.
3045 This option is set by commands that create a new fold or close a fold.
3046 See |folding|.
3047
3048 *'foldexpr'* *'fde'*
3049'foldexpr' 'fde' string (default: "0")
3050 local to window
3051 {not in Vi}
3052 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003053 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003055 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003056
Bram Moolenaar30b65812012-07-12 22:01:11 +02003057 The expression will be evaluated in the |sandbox| if set from a
3058 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003059 This option can't be set from a |modeline| when the 'diff' option is
3060 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003061
3062 It is not allowed to change text or jump to another window while
3063 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
3065 *'foldignore'* *'fdi'*
3066'foldignore' 'fdi' string (default: "#")
3067 local to window
3068 {not in Vi}
3069 {not available when compiled without the |+folding|
3070 feature}
3071 Used only when 'foldmethod' is "indent". Lines starting with
3072 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003073 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 The default "#" works well for C programs. See |fold-indent|.
3075
3076 *'foldlevel'* *'fdl'*
3077'foldlevel' 'fdl' number (default: 0)
3078 local to window
3079 {not in Vi}
3080 {not available when compiled without the |+folding|
3081 feature}
3082 Sets the fold level: Folds with a higher level will be closed.
3083 Setting this option to zero will close all folds. Higher numbers will
3084 close fewer folds.
3085 This option is set by commands like |zm|, |zM| and |zR|.
3086 See |fold-foldlevel|.
3087
3088 *'foldlevelstart'* *'fdls'*
3089'foldlevelstart' 'fdls' number (default: -1)
3090 global
3091 {not in Vi}
3092 {not available when compiled without the |+folding|
3093 feature}
3094 Sets 'foldlevel' when starting to edit another buffer in a window.
3095 Useful to always start editing with all folds closed (value zero),
3096 some folds closed (one) or no folds closed (99).
3097 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003098 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 ignores this option and closes all folds.
3100 It is also done before BufReadPre autocommands, to allow an autocmd to
3101 overrule the 'foldlevel' value for specific files.
3102 When the value is negative, it is not used.
3103
3104 *'foldmarker'* *'fmr'* *E536*
3105'foldmarker' 'fmr' string (default: "{{{,}}}")
3106 local to window
3107 {not in Vi}
3108 {not available when compiled without the |+folding|
3109 feature}
3110 The start and end marker used when 'foldmethod' is "marker". There
3111 must be one comma, which separates the start and end marker. The
3112 marker is a literal string (a regular expression would be too slow).
3113 See |fold-marker|.
3114
3115 *'foldmethod'* *'fdm'*
3116'foldmethod' 'fdm' string (default: "manual")
3117 local to window
3118 {not in Vi}
3119 {not available when compiled without the |+folding|
3120 feature}
3121 The kind of folding used for the current window. Possible values:
3122 |fold-manual| manual Folds are created manually.
3123 |fold-indent| indent Lines with equal indent form a fold.
3124 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3125 |fold-marker| marker Markers are used to specify folds.
3126 |fold-syntax| syntax Syntax highlighting items specify folds.
3127 |fold-diff| diff Fold text that is not changed.
3128
3129 *'foldminlines'* *'fml'*
3130'foldminlines' 'fml' number (default: 1)
3131 local to window
3132 {not in Vi}
3133 {not available when compiled without the |+folding|
3134 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003135 Sets the number of screen lines above which a fold can be displayed
3136 closed. Also for manually closed folds. With the default value of
3137 one a fold can only be closed if it takes up two or more screen lines.
3138 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003139 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140 "zc" to close a fold, which is displayed open because it's smaller
3141 than 'foldminlines', a following "zc" may close a containing fold.
3142
3143 *'foldnestmax'* *'fdn'*
3144'foldnestmax' 'fdn' number (default: 20)
3145 local to window
3146 {not in Vi}
3147 {not available when compiled without the |+folding|
3148 feature}
3149 Sets the maximum nesting of folds for the "indent" and "syntax"
3150 methods. This avoids that too many folds will be created. Using more
3151 than 20 doesn't work, because the internal limit is 20.
3152
3153 *'foldopen'* *'fdo'*
3154'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3155 search,tag,undo")
3156 global
3157 {not in Vi}
3158 {not available when compiled without the |+folding|
3159 feature}
3160 Specifies for which type of commands folds will be opened, if the
3161 command moves the cursor into a closed fold. It is a comma separated
3162 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003163 NOTE: When the command is part of a mapping this option is not used.
3164 Add the |zv| command to the mapping to get the same effect.
3165 (rationale: the mapping may want to control opening folds itself)
3166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 item commands ~
3168 all any
3169 block "(", "{", "[[", "[{", etc.
3170 hor horizontal movements: "l", "w", "fx", etc.
3171 insert any command in Insert mode
3172 jump far jumps: "G", "gg", etc.
3173 mark jumping to a mark: "'m", CTRL-O, etc.
3174 percent "%"
3175 quickfix ":cn", ":crew", ":make", etc.
3176 search search for a pattern: "/", "n", "*", "gd", etc.
3177 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003178 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 tag jumping to a tag: ":ta", CTRL-T, etc.
3180 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 When a movement command is used for an operator (e.g., "dl" or "y%")
3182 this option is not used. This means the operator will include the
3183 whole closed fold.
3184 Note that vertical movements are not here, because it would make it
3185 very difficult to move onto a closed fold.
3186 In insert mode the folds containing the cursor will always be open
3187 when text is inserted.
3188 To close folds you can re-apply 'foldlevel' with the |zx| command or
3189 set the 'foldclose' option to "all".
3190
3191 *'foldtext'* *'fdt'*
3192'foldtext' 'fdt' string (default: "foldtext()")
3193 local to window
3194 {not in Vi}
3195 {not available when compiled without the |+folding|
3196 feature}
3197 An expression which is used to specify the text displayed for a closed
3198 fold. See |fold-foldtext|.
3199
Bram Moolenaar30b65812012-07-12 22:01:11 +02003200 The expression will be evaluated in the |sandbox| if set from a
3201 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003202
3203 It is not allowed to change text or jump to another window while
3204 evaluating 'foldtext' |textlock|.
3205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 *'formatoptions'* *'fo'*
3207'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3208 local to buffer
3209 {not in Vi}
3210 This is a sequence of letters which describes how automatic
3211 formatting is to be done. See |fo-table|. When the 'paste' option is
3212 on, no formatting is done (like 'formatoptions' is empty). Commas can
3213 be inserted for readability.
3214 To avoid problems with flags that are added in the future, use the
3215 "+=" and "-=" feature of ":set" |add-option-flags|.
3216 NOTE: This option is set to the Vi default value when 'compatible' is
3217 set and to the Vim default value when 'compatible' is reset.
3218
Bram Moolenaar86b68352004-12-27 21:59:20 +00003219 *'formatlistpat'* *'flp'*
3220'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3221 local to buffer
3222 {not in Vi}
3223 A pattern that is used to recognize a list header. This is used for
3224 the "n" flag in 'formatoptions'.
3225 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003226 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003227 while still checking more characters. There must be a character
3228 following the pattern, when it matches the whole line it is handled
3229 like there is no match.
3230 The default recognizes a number, followed by an optional punctuation
3231 character and white space.
3232
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 *'formatprg'* *'fp'*
3234'formatprg' 'fp' string (default "")
3235 global
3236 {not in Vi}
3237 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003238 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003240 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003241 If the 'formatexpr' option is not empty it will be used instead.
3242 Otherwise, if 'formatprg' option is an empty string, the internal
3243 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003244 Environment variables are expanded |:set_env|. See |option-backslash|
3245 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003246 This option cannot be set from a |modeline| or in the |sandbox|, for
3247 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003248
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003249 *'formatexpr'* *'fex'*
3250'formatexpr' 'fex' string (default "")
3251 local to buffer
3252 {not in Vi}
3253 {not available when compiled without the |+eval|
3254 feature}
3255 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003256 operator or automatic formatting (see 'formatoptions'). When this
3257 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003258
3259 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003260 The |v:count| variable holds the number of lines to be formatted.
3261 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003262 inserted if the expression is being evaluated due to
3263 automatic formatting. This can be empty. Don't insert
3264 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003265
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003266 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003267 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003268< This will invoke the mylang#Format() function in the
3269 autoload/mylang.vim file in 'runtimepath'. |autoload|
3270
3271 The expression is also evaluated when 'textwidth' is set and adding
3272 text beyond that limit. This happens under the same conditions as
3273 when internal formatting is used. Make sure the cursor is kept in the
3274 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003275 return "i" or "R" in this situation.
3276
3277 When the expression evaluates to non-zero Vim will fall back to using
3278 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003279
Bram Moolenaar30b65812012-07-12 22:01:11 +02003280 The expression will be evaluated in the |sandbox| when set from a
3281 modeline, see |sandbox-option|. That stops the option from working,
3282 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003283
3284 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003285'fsync' 'fs' boolean (default on)
3286 global
3287 {not in Vi}
3288 When on, the library function fsync() will be called after writing a
3289 file. This will flush a file to disk, ensuring that it is safely
3290 written even on filesystems which do metadata-only journaling. This
3291 will force the harddrive to spin up on Linux systems running in laptop
3292 mode, so it may be undesirable in some situations. Be warned that
3293 turning this off increases the chances of data loss after a crash. On
3294 systems without an fsync() implementation, this variable is always
3295 off.
3296 Also see 'swapsync' for controlling fsync() on swap files.
3297
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3299'gdefault' 'gd' boolean (default off)
3300 global
3301 {not in Vi}
3302 When on, the ":substitute" flag 'g' is default on. This means that
3303 all matches in a line are substituted instead of one. When a 'g' flag
3304 is given to a ":substitute" command, this will toggle the substitution
3305 of all or one match. See |complex-change|.
3306
3307 command 'gdefault' on 'gdefault' off ~
3308 :s/// subst. all subst. one
3309 :s///g subst. one subst. all
3310 :s///gg subst. all subst. one
3311
3312 NOTE: This option is reset when 'compatible' is set.
3313
3314 *'grepformat'* *'gfm'*
3315'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3316 global
3317 {not in Vi}
3318 Format to recognize for the ":grep" command output.
3319 This is a scanf-like string that uses the same format as the
3320 'errorformat' option: see |errorformat|.
3321
3322 *'grepprg'* *'gp'*
3323'grepprg' 'gp' string (default "grep -n ",
3324 Unix: "grep -n $* /dev/null",
3325 Win32: "findstr /n" or "grep -n",
3326 VMS: "SEARCH/NUMBERS ")
3327 global or local to buffer |global-local|
3328 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003329 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 and '#' characters, which are expanded like when used in a command-
3331 line. The placeholder "$*" is allowed to specify where the arguments
3332 will be included. Environment variables are expanded |:set_env|. See
3333 |option-backslash| about including spaces and backslashes.
3334 When your "grep" accepts the "-H" argument, use this to make ":grep"
3335 also work well with a single file: >
3336 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003337< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003338 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3339 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003340 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 apply equally to 'grepprg'.
3342 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3343 otherwise it's "grep -n".
3344 This option cannot be set from a |modeline| or in the |sandbox|, for
3345 security reasons.
3346
3347 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3348'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3349 ve:ver35-Cursor,
3350 o:hor50-Cursor,
3351 i-ci:ver25-Cursor/lCursor,
3352 r-cr:hor20-Cursor/lCursor,
3353 sm:block-Cursor
3354 -blinkwait175-blinkoff150-blinkon175",
3355 for MS-DOS and Win32 console:
3356 "n-v-c:block,o:hor50,i-ci:hor15,
3357 r-cr:hor30,sm:block")
3358 global
3359 {not in Vi}
3360 {only available when compiled with GUI enabled, and
3361 for MS-DOS and Win32 console}
3362 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003363 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 the height of the cursor can be changed. This can be done by
3365 specifying a block cursor, or a percentage for a vertical or
3366 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003367 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003369 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 mode-list and an argument-list:
3371 mode-list:argument-list,mode-list:argument-list,..
3372 The mode-list is a dash separated list of these modes:
3373 n Normal mode
3374 v Visual mode
3375 ve Visual mode with 'selection' "exclusive" (same as 'v',
3376 if not specified)
3377 o Operator-pending mode
3378 i Insert mode
3379 r Replace mode
3380 c Command-line Normal (append) mode
3381 ci Command-line Insert mode
3382 cr Command-line Replace mode
3383 sm showmatch in Insert mode
3384 a all modes
3385 The argument-list is a dash separated list of these arguments:
3386 hor{N} horizontal bar, {N} percent of the character height
3387 ver{N} vertical bar, {N} percent of the character width
3388 block block cursor, fills the whole character
3389 [only one of the above three should be present]
3390 blinkwait{N} *cursor-blinking*
3391 blinkon{N}
3392 blinkoff{N}
3393 blink times for cursor: blinkwait is the delay before
3394 the cursor starts blinking, blinkon is the time that
3395 the cursor is shown and blinkoff is the time that the
3396 cursor is not shown. The times are in msec. When one
3397 of the numbers is zero, there is no blinking. The
3398 default is: "blinkwait700-blinkon400-blinkoff250".
3399 These numbers are used for a missing entry. This
3400 means that blinking is enabled by default. To switch
3401 blinking off you can use "blinkon0". The cursor only
3402 blinks when Vim is waiting for input, not while
3403 executing a command.
3404 To make the cursor blink in an xterm, see
3405 |xterm-blink|.
3406 {group-name}
3407 a highlight group name, that sets the color and font
3408 for the cursor
3409 {group-name}/{group-name}
3410 Two highlight group names, the first is used when
3411 no language mappings are used, the other when they
3412 are. |language-mapping|
3413
3414 Examples of parts:
3415 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3416 block cursor with colors from the "nCursor"
3417 highlight group
3418 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3419 In Insert and Command-line Insert mode, use a
3420 30% vertical bar cursor with colors from the
3421 "iCursor" highlight group. Blink a bit
3422 faster.
3423
3424 The 'a' mode is different. It will set the given argument-list for
3425 all modes. It does not reset anything to defaults. This can be used
3426 to do a common setting for all modes. For example, to switch off
3427 blinking: "a:blinkon0"
3428
3429 Examples of cursor highlighting: >
3430 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3431 :highlight Cursor gui=NONE guifg=bg guibg=fg
3432<
3433 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003434 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435'guifont' 'gfn' string (default "")
3436 global
3437 {not in Vi}
3438 {only available when compiled with GUI enabled}
3439 This is a list of fonts which will be used for the GUI version of Vim.
3440 In its simplest form the value is just one font name. When
3441 the font cannot be found you will get an error message. To try other
3442 font names a list can be specified, font names separated with commas.
3443 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003444
Bram Moolenaar05159a02005-02-26 23:04:13 +00003445 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3446 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003447
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 Spaces after a comma are ignored. To include a comma in a font name
3449 precede it with a backslash. Setting an option requires an extra
3450 backslash before a space and a backslash. See also
3451 |option-backslash|. For example: >
3452 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003453< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003455
3456 If none of the fonts can be loaded, Vim will keep the current setting.
3457 If an empty font list is given, Vim will try using other resource
3458 settings (for X, it will use the Vim.font resource), and finally it
3459 will try some builtin default which should always be there ("7x13" in
3460 the case of X). The font names given should be "normal" fonts. Vim
3461 will try to find the related bold and italic fonts.
3462
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003463 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003464 :set guifont=*
3465< will bring up a font requester, where you can pick the font you want.
3466
3467 The font name depends on the GUI used. See |setting-guifont| for a
3468 way to set 'guifont' for various systems.
3469
Bram Moolenaar071d4272004-06-13 20:20:40 +00003470 For the GTK+ 2 GUI the font name looks like this: >
3471 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003472< That's all. XLFDs are not used. For Chinese this is reported to work
3473 well: >
3474 if has("gui_gtk2")
3475 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3476 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3477 endif
3478<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003479 For Mac OSX you can use something like this: >
3480 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003481< Also see 'macatsui', it can help fix display problems.
3482 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003483 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003484 width). An exception is GTK 2: all fonts are accepted, but
3485 mono-spaced fonts look best.
3486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 To preview a font on X11, you might be able to use the "xfontsel"
3488 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 For the Win32 GUI *E244* *E245*
3491 - takes these options in the font name:
3492 hXX - height is XX (points, can be floating-point)
3493 wXX - width is XX (points, can be floating-point)
3494 b - bold
3495 i - italic
3496 u - underline
3497 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003498 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3500 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3501 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003502 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503
3504 Use a ':' to separate the options.
3505 - A '_' can be used in the place of a space, so you don't need to use
3506 backslashes to escape the spaces.
3507 - Examples: >
3508 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3509 :set guifont=Andale_Mono:h7.5:w4.5
3510< See also |font-sizes|.
3511
3512 *'guifontset'* *'gfs'*
3513 *E250* *E252* *E234* *E597* *E598*
3514'guifontset' 'gfs' string (default "")
3515 global
3516 {not in Vi}
3517 {only available when compiled with GUI enabled and
3518 with the |+xfontset| feature}
3519 {not available in the GTK+ 2 GUI}
3520 When not empty, specifies two (or more) fonts to be used. The first
3521 one for normal English, the second one for your special language. See
3522 |xfontset|.
3523 Setting this option also means that all font names will be handled as
3524 a fontset name. Also the ones used for the "font" argument of the
3525 |:highlight| command.
3526 The fonts must match with the current locale. If fonts for the
3527 character sets that the current locale uses are not included, setting
3528 'guifontset' will fail.
3529 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3530 the comma-separated names are alternative names, one of which will be
3531 used. In 'guifontset' the whole string is one fontset name,
3532 including the commas. It is not possible to specify alternative
3533 fontset names.
3534 This example works on many X11 systems: >
3535 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3536<
3537 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3538'guifontwide' 'gfw' string (default "")
3539 global
3540 {not in Vi}
3541 {only available when compiled with GUI enabled}
3542 When not empty, specifies a comma-separated list of fonts to be used
3543 for double-width characters. The first font that can be loaded is
3544 used.
3545 Note: The size of these fonts must be exactly twice as wide as the one
3546 specified with 'guifont' and the same height.
3547
3548 All GUI versions but GTK+ 2:
3549
3550 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3551 'guifontset' is empty or invalid.
3552 When 'guifont' is set and a valid font is found in it and
3553 'guifontwide' is empty Vim will attempt to find a matching
3554 double-width font and set 'guifontwide' to it.
3555
3556 GTK+ 2 GUI only: *guifontwide_gtk2*
3557
3558 If set and valid, 'guifontwide' is always used for double width
3559 characters, even if 'encoding' is not set to "utf-8".
3560 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003561 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 font for characters not available in 'guifont'. Thus you do not need
3563 to set 'guifontwide' at all unless you want to override the choice
3564 made by Pango/Xft.
3565
Bram Moolenaar0f272122013-01-23 18:37:40 +01003566 Windows +multibyte only: *guifontwide_win_mbyte*
3567
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003568 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003569
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 *'guiheadroom'* *'ghr'*
3571'guiheadroom' 'ghr' number (default 50)
3572 global
3573 {not in Vi} {only for GTK and X11 GUI}
3574 The number of pixels subtracted from the screen height when fitting
3575 the GUI window on the screen. Set this before the GUI is started,
3576 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003577 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 lines will be left for window decorations and other items on the
3579 screen. Set it to a negative value to allow windows taller than the
3580 screen.
3581
3582 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003583'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3584 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 global
3586 {not in Vi}
3587 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003588 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 sequence of letters which describes what components and options of the
3590 GUI should be used.
3591 To avoid problems with flags that are added in the future, use the
3592 "+=" and "-=" feature of ":set" |add-option-flags|.
3593
3594 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003595 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 'a' Autoselect: If present, then whenever VISUAL mode is started,
3597 or the Visual area extended, Vim tries to become the owner of
3598 the windowing system's global selection. This means that the
3599 Visually highlighted text is available for pasting into other
3600 applications as well as into Vim itself. When the Visual mode
3601 ends, possibly due to an operation on the text, or when an
3602 application wants to paste the selection, the highlighted text
3603 is automatically yanked into the "* selection register.
3604 Thus the selection is still available for pasting into other
3605 applications after the VISUAL mode has ended.
3606 If not present, then Vim won't become the owner of the
3607 windowing system's global selection unless explicitly told to
3608 by a yank or delete operation for the "* register.
3609 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003610 *'go-P'*
3611 'P' Like autoselect but using the "+ register instead of the "*
3612 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003613 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003614 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 applies to the modeless selection.
3616
3617 'guioptions' autoselect Visual autoselect modeless ~
3618 "" - -
3619 "a" yes yes
3620 "A" - yes
3621 "aA" yes yes
3622
Bram Moolenaar02467872007-05-06 13:22:01 +00003623 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'c' Use console dialogs instead of popup dialogs for simple
3625 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003626 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003627 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003628 'guitablabel' can be used to change the text in the labels.
3629 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003630 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003631 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003632 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 'f' Foreground: Don't use fork() to detach the GUI from the shell
3634 where it was started. Use this for programs that wait for the
3635 editor to finish (e.g., an e-mail program). Alternatively you
3636 can use "gvim -f" or ":gui -f" to start the GUI in the
3637 foreground. |gui-fork|
3638 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003639 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003640 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3642 corner of the window. It's black&white on non-GTK, because of
3643 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003644 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003646 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003647 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003649 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 file is sourced the system menu has already been loaded; the
3651 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003652 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'g' Grey menu items: Make menu items that are not active grey. If
3654 'g' is not included inactive menu items are not shown at all.
3655 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003656 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 't' Include tearoff menu items. Currently only works for Win32,
3658 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003659 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003660 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003661 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003662 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003664 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 'R' Right-hand scrollbar is present when there is a vertically
3666 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003667 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003669 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 'L' Left-hand scrollbar is present when there is a vertically
3671 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003672 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3674 the longest visible line, or on the cursor line if the 'h'
3675 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003676 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 'h' Limit horizontal scrollbar size to the length of the cursor
3678 line. Reduces computations. |gui-horiz-scroll|
3679
3680 And yes, you may even have scrollbars on the left AND the right if
3681 you really want to :-). See |gui-scrollbars| for more information.
3682
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003683 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684 'v' Use a vertical button layout for dialogs. When not included,
3685 a horizontal layout is preferred, but when it doesn't fit a
3686 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003687 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 'p' Use Pointer callbacks for X11 GUI. This is required for some
3689 window managers. If the cursor is not blinking or hollow at
3690 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003691 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003693 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003694 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695
Bram Moolenaar02467872007-05-06 13:22:01 +00003696
Bram Moolenaar071d4272004-06-13 20:20:40 +00003697 *'guipty'* *'noguipty'*
3698'guipty' boolean (default on)
3699 global
3700 {not in Vi}
3701 {only available when compiled with GUI enabled}
3702 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3703 I/O to/from shell commands. See |gui-pty|.
3704
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003705 *'guitablabel'* *'gtl'*
3706'guitablabel' 'gtl' string (default empty)
3707 global
3708 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003709 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003710 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003711 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003712 pages line. When empty and when the result is empty Vim will use a
3713 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003714
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003715 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003716 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003717
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003718 Only used when the GUI tab pages line is displayed. 'e' must be
3719 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3720 used.
3721
Bram Moolenaar57657d82006-04-21 22:12:41 +00003722 *'guitabtooltip'* *'gtt'*
3723'guitabtooltip' 'gtt' string (default empty)
3724 global
3725 {not in Vi}
3726 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003727 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003728 When nonempty describes the text to use in a tooltip for the GUI tab
3729 pages line. When empty Vim will use a default tooltip.
3730 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003731 You can include a line break. Simplest method is to use |:let|: >
3732 :let &guitabtooltip = "line one\nline two"
3733<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003734
Bram Moolenaar071d4272004-06-13 20:20:40 +00003735 *'helpfile'* *'hf'*
3736'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3737 (others) "$VIMRUNTIME/doc/help.txt")
3738 global
3739 {not in Vi}
3740 Name of the main help file. All distributed help files should be
3741 placed together in one directory. Additionally, all "doc" directories
3742 in 'runtimepath' will be used.
3743 Environment variables are expanded |:set_env|. For example:
3744 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003745 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 spaces and backslashes.
3747 This option cannot be set from a |modeline| or in the |sandbox|, for
3748 security reasons.
3749
3750 *'helpheight'* *'hh'*
3751'helpheight' 'hh' number (default 20)
3752 global
3753 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003754 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 feature}
3756 Minimal initial height of the help window when it is opened with the
3757 ":help" command. The initial height of the help window is half of the
3758 current window, or (when the 'ea' option is on) the same as other
3759 windows. When the height is less than 'helpheight', the height is
3760 set to 'helpheight'. Set to zero to disable.
3761
3762 *'helplang'* *'hlg'*
3763'helplang' 'hlg' string (default: messages language or empty)
3764 global
3765 {only available when compiled with the |+multi_lang|
3766 feature}
3767 {not in Vi}
3768 Comma separated list of languages. Vim will use the first language
3769 for which the desired help can be found. The English help will always
3770 be used as a last resort. You can add "en" to prefer English over
3771 another language, but that will only find tags that exist in that
3772 language and not in the English help.
3773 Example: >
3774 :set helplang=de,it
3775< This will first search German, then Italian and finally English help
3776 files.
3777 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3778 try to find the tag in the current language before using this option.
3779 See |help-translated|.
3780
3781 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3782'hidden' 'hid' boolean (default off)
3783 global
3784 {not in Vi}
3785 When off a buffer is unloaded when it is |abandon|ed. When on a
3786 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3787 displayed in another window, it does not become hidden, of course.
3788 The commands that move through the buffer list sometimes make a buffer
3789 hidden although the 'hidden' option is off: When the buffer is
3790 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003791 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003792 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 This option is set for one command with ":hide {command}" |:hide|.
3794 WARNING: It's easy to forget that you have changes in hidden buffers.
3795 Think twice when using ":q!" or ":qa!".
3796
3797 *'highlight'* *'hl'*
3798'highlight' 'hl' string (default (as a single string):
3799 "8:SpecialKey,@:NonText,d:Directory,
3800 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003801 M:ModeMsg,n:LineNr,N:CursorLineNr,
3802 r:Question,s:StatusLine,S:StatusLineNC,
3803 c:VertSplit, t:Title,v:Visual,
3804 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 f:Folded,F:FoldColumn,A:DiffAdd,
3806 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003807 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003808 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003809 +:Pmenu,=:PmenuSel,
3810 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811 global
3812 {not in Vi}
3813 This option can be used to set highlighting mode for various
3814 occasions. It is a comma separated list of character pairs. The
3815 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003816 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3818 |hl-NonText| @ '~' and '@' at the end of the window and
3819 characters from 'showbreak'
3820 |hl-Directory| d directories in CTRL-D listing and other special
3821 things in listings
3822 |hl-ErrorMsg| e error messages
3823 h (obsolete, ignored)
3824 |hl-IncSearch| i 'incsearch' highlighting
3825 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3826 |hl-MoreMsg| m |more-prompt|
3827 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003828 |hl-LineNr| n line number for ":number" and ":#" commands, and
3829 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003830 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3831 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 |hl-Question| r |hit-enter| prompt and yes/no questions
3833 |hl-StatusLine| s status line of current window |status-line|
3834 |hl-StatusLineNC| S status lines of not-current windows
3835 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3836 |hl-VertSplit| c column used to separate vertically split windows
3837 |hl-Visual| v Visual mode
3838 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3839 Selection" Only X11 Gui's |gui-x11| and
3840 |xterm-clipboard|.
3841 |hl-WarningMsg| w warning messages
3842 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3843 |hl-Folded| f line used for closed folds
3844 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003845 |hl-DiffAdd| A added line in diff mode
3846 |hl-DiffChange| C changed line in diff mode
3847 |hl-DiffDelete| D deleted line in diff mode
3848 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003850 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003851 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003852 |hl-SpellRare| R rare word |spell|
3853 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003854 |hl-Conceal| - the placeholders used for concealed characters
3855 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003856 |hl-Pmenu| + popup menu normal line
3857 |hl-PmenuSel| = popup menu normal line
3858 |hl-PmenuSbar| x popup menu scrollbar
3859 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860
3861 The display modes are:
3862 r reverse (termcap entry "mr" and "me")
3863 i italic (termcap entry "ZH" and "ZR")
3864 b bold (termcap entry "md" and "me")
3865 s standout (termcap entry "so" and "se")
3866 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003867 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 n no highlighting
3869 - no highlighting
3870 : use a highlight group
3871 The default is used for occasions that are not included.
3872 If you want to change what the display modes do, see |dos-colors|
3873 for an example.
3874 When using the ':' display mode, this must be followed by the name of
3875 a highlight group. A highlight group can be used to define any type
3876 of highlighting, including using color. See |:highlight| on how to
3877 define one. The default uses a different group for each occasion.
3878 See |highlight-default| for the default highlight groups.
3879
3880 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3881'hlsearch' 'hls' boolean (default off)
3882 global
3883 {not in Vi}
3884 {not available when compiled without the
3885 |+extra_search| feature}
3886 When there is a previous search pattern, highlight all its matches.
3887 The type of highlighting used can be set with the 'l' occasion in the
3888 'highlight' option. This uses the "Search" highlight group by
3889 default. Note that only the matching text is highlighted, any offsets
3890 are not applied.
3891 See also: 'incsearch' and |:match|.
3892 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003893 off with |:nohlsearch|. This does not change the option value, as
3894 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003895 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003896 When the search pattern can match an end-of-line, Vim will try to
3897 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003898 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003900 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003901 You can specify whether the highlight status is restored on startup
3902 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 NOTE: This option is reset when 'compatible' is set.
3904
3905 *'history'* *'hi'*
3906'history' 'hi' number (Vim default: 20, Vi default: 0)
3907 global
3908 {not in Vi}
3909 A history of ":" commands, and a history of previous search patterns
3910 are remembered. This option decides how many entries may be stored in
3911 each of these histories (see |cmdline-editing|).
3912 NOTE: This option is set to the Vi default value when 'compatible' is
3913 set and to the Vim default value when 'compatible' is reset.
3914
3915 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3916'hkmap' 'hk' boolean (default off)
3917 global
3918 {not in Vi}
3919 {only available when compiled with the |+rightleft|
3920 feature}
3921 When on, the keyboard is mapped for the Hebrew character set.
3922 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3923 toggle this option. See |rileft.txt|.
3924 NOTE: This option is reset when 'compatible' is set.
3925
3926 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3927'hkmapp' 'hkp' boolean (default off)
3928 global
3929 {not in Vi}
3930 {only available when compiled with the |+rightleft|
3931 feature}
3932 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3933 This is useful if you have a non-Hebrew keyboard.
3934 See |rileft.txt|.
3935 NOTE: This option is reset when 'compatible' is set.
3936
3937 *'icon'* *'noicon'*
3938'icon' boolean (default off, on when title can be restored)
3939 global
3940 {not in Vi}
3941 {not available when compiled without the |+title|
3942 feature}
3943 When on, the icon text of the window will be set to the value of
3944 'iconstring' (if it is not empty), or to the name of the file
3945 currently being edited. Only the last part of the name is used.
3946 Overridden by the 'iconstring' option.
3947 Only works if the terminal supports setting window icons (currently
3948 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3949 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3950 builtin termcap).
3951 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003952 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 X11.
3954
3955 *'iconstring'*
3956'iconstring' string (default "")
3957 global
3958 {not in Vi}
3959 {not available when compiled without the |+title|
3960 feature}
3961 When this option is not empty, it will be used for the icon text of
3962 the window. This happens only when the 'icon' option is on.
3963 Only works if the terminal supports setting window icon text
3964 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3965 Does not work for MS Windows.
3966 When Vim was compiled with HAVE_X11 defined, the original icon will be
3967 restored if possible |X11|.
3968 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003969 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970 'titlestring' for example settings.
3971 {not available when compiled without the |+statusline| feature}
3972
3973 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3974'ignorecase' 'ic' boolean (default off)
3975 global
3976 Ignore case in search patterns. Also used when searching in the tags
3977 file.
3978 Also see 'smartcase'.
3979 Can be overruled by using "\c" or "\C" in the pattern, see
3980 |/ignorecase|.
3981
3982 *'imactivatekey'* *'imak'*
3983'imactivatekey' 'imak' string (default "")
3984 global
3985 {not in Vi}
3986 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003987 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 Specifies the key that your Input Method in X-Windows uses for
3989 activation. When this is specified correctly, vim can fully control
3990 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3991 You can't use this option to change the activation key, the option
3992 tells Vim what the key is.
3993 Format:
3994 [MODIFIER_FLAG-]KEY_STRING
3995
3996 These characters can be used for MODIFIER_FLAG (case is ignored):
3997 S Shift key
3998 L Lock key
3999 C Control key
4000 1 Mod1 key
4001 2 Mod2 key
4002 3 Mod3 key
4003 4 Mod4 key
4004 5 Mod5 key
4005 Combinations are allowed, for example "S-C-space" or "SC-space" are
4006 both shift+ctrl+space.
4007 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4008
4009 Example: >
4010 :set imactivatekey=S-space
4011< "S-space" means shift+space. This is the activation key for kinput2 +
4012 canna (Japanese), and ami (Korean).
4013
4014 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4015'imcmdline' 'imc' boolean (default off)
4016 global
4017 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004018 {only available when compiled with the |+xim|,
4019 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 When set the Input Method is always on when starting to edit a command
4021 line, unless entering a search pattern (see 'imsearch' for that).
4022 Setting this option is useful when your input method allows entering
4023 English characters directly, e.g., when it's used to type accented
4024 characters with dead keys.
4025
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004026 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4028 global
4029 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004030 {only available when compiled with the |+xim|,
4031 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 When set the Input Method is never used. This is useful to disable
4033 the IM when it doesn't work properly.
4034 Currently this option is on by default for SGI/IRIX machines. This
4035 may change in later releases.
4036
4037 *'iminsert'* *'imi'*
4038'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4039 local to buffer
4040 {not in Vi}
4041 Specifies whether :lmap or an Input Method (IM) is to be used in
4042 Insert mode. Valid values:
4043 0 :lmap is off and IM is off
4044 1 :lmap is ON and IM is off
4045 2 :lmap is off and IM is ON
4046 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4047 or |global-ime|.
4048 To always reset the option to zero when leaving Insert mode with <Esc>
4049 this can be used: >
4050 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4051< This makes :lmap and IM turn off automatically when leaving Insert
4052 mode.
4053 Note that this option changes when using CTRL-^ in Insert mode
4054 |i_CTRL-^|.
4055 The value is set to 1 when setting 'keymap' to a valid keymap name.
4056 It is also used for the argument of commands like "r" and "f".
4057 The value 0 may not work correctly with Athena and Motif with some XIM
4058 methods. Use 'imdisable' to disable XIM then.
4059
4060 *'imsearch'* *'ims'*
4061'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4062 local to buffer
4063 {not in Vi}
4064 Specifies whether :lmap or an Input Method (IM) is to be used when
4065 entering a search pattern. Valid values:
4066 -1 the value of 'iminsert' is used, makes it look like
4067 'iminsert' is also used when typing a search pattern
4068 0 :lmap is off and IM is off
4069 1 :lmap is ON and IM is off
4070 2 :lmap is off and IM is ON
4071 Note that this option changes when using CTRL-^ in Command-line mode
4072 |c_CTRL-^|.
4073 The value is set to 1 when it is not -1 and setting the 'keymap'
4074 option to a valid keymap name.
4075 The value 0 may not work correctly with Athena and Motif with some XIM
4076 methods. Use 'imdisable' to disable XIM then.
4077
4078 *'include'* *'inc'*
4079'include' 'inc' string (default "^\s*#\s*include")
4080 global or local to buffer |global-local|
4081 {not in Vi}
4082 {not available when compiled without the
4083 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004084 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 pattern, just like for the "/" command (See |pattern|). The default
4086 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004087 "]I", "[d", etc.
4088 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004089 comes after the matched pattern. But if "\zs" appears in the pattern
4090 then the text matched from "\zs" to the end, or until "\ze" if it
4091 appears, is used as the file name. Use this to include characters
4092 that are not in 'isfname', such as a space. You can then use
4093 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004094 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095
4096 *'includeexpr'* *'inex'*
4097'includeexpr' 'inex' string (default "")
4098 local to buffer
4099 {not in Vi}
4100 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004101 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004102 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004103 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 :set includeexpr=substitute(v:fname,'\\.','/','g')
4105< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004106
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004108 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 Also used for |<cfile>|.
4110
Bram Moolenaar30b65812012-07-12 22:01:11 +02004111 The expression will be evaluated in the |sandbox| when set from a
4112 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004113
4114 It is not allowed to change text or jump to another window while
4115 evaluating 'includeexpr' |textlock|.
4116
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4118'incsearch' 'is' boolean (default off)
4119 global
4120 {not in Vi}
4121 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004122 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004123 While typing a search command, show where the pattern, as it was typed
4124 so far, matches. The matched string is highlighted. If the pattern
4125 is invalid or not found, nothing is shown. The screen will be updated
4126 often, this is only useful on fast terminals.
4127 Note that the match will be shown, but the cursor will return to its
4128 original position when no match is found and when pressing <Esc>. You
4129 still need to finish the search command with <Enter> to move the
4130 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004131 When compiled with the |+reltime| feature Vim only searches for about
4132 half a second. With a complicated pattern and/or a lot of text the
4133 match may not be found. This is to avoid that Vim hangs while you
4134 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004135 The highlighting can be set with the 'i' flag in 'highlight'.
4136 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004137 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004138 to the command line. If 'ignorecase' and 'smartcase' are set and the
4139 command line has no uppercase characters, the added character is
4140 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004141 CTRL-R CTRL-W can be used to add the word at the end of the current
4142 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 NOTE: This option is reset when 'compatible' is set.
4144
4145 *'indentexpr'* *'inde'*
4146'indentexpr' 'inde' string (default "")
4147 local to buffer
4148 {not in Vi}
4149 {not available when compiled without the |+cindent|
4150 or |+eval| features}
4151 Expression which is evaluated to obtain the proper indent for a line.
4152 It is used when a new line is created, for the |=| operator and
4153 in Insert mode as specified with the 'indentkeys' option.
4154 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004155 'smartindent' indenting. When 'lisp' is set, this option is
4156 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004157 When 'paste' is set this option is not used for indenting.
4158 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004159 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 when the expression is evaluated (but it may be moved around).
4161 The expression must return the number of spaces worth of indent. It
4162 can return "-1" to keep the current indent (this means 'autoindent' is
4163 used for the indent).
4164 Functions useful for computing the indent are |indent()|, |cindent()|
4165 and |lispindent()|.
4166 The evaluation of the expression must not have side effects! It must
4167 not change the text, jump to another window, etc. Afterwards the
4168 cursor position is always restored, thus the cursor may be moved.
4169 Normally this option would be set to call a function: >
4170 :set indentexpr=GetMyIndent()
4171< Error messages will be suppressed, unless the 'debug' option contains
4172 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004173 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 NOTE: This option is made empty when 'compatible' is set.
4175
Bram Moolenaar30b65812012-07-12 22:01:11 +02004176 The expression will be evaluated in the |sandbox| when set from a
4177 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004178
4179 It is not allowed to change text or jump to another window while
4180 evaluating 'indentexpr' |textlock|.
4181
4182
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 *'indentkeys'* *'indk'*
4184'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4185 local to buffer
4186 {not in Vi}
4187 {not available when compiled without the |+cindent|
4188 feature}
4189 A list of keys that, when typed in Insert mode, cause reindenting of
4190 the current line. Only happens if 'indentexpr' isn't empty.
4191 The format is identical to 'cinkeys', see |indentkeys-format|.
4192 See |C-indenting| and |indent-expression|.
4193
4194 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4195'infercase' 'inf' boolean (default off)
4196 local to buffer
4197 {not in Vi}
4198 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004199 'ignorecase' is also on, the case of the match is adjusted depending
4200 on the typed text. If the typed text contains a lowercase letter
4201 where the match has an upper case letter, the completed part is made
4202 lowercase. If the typed text has no lowercase letters and the match
4203 has a lowercase letter where the typed text has an uppercase letter,
4204 and there is a letter before it, the completed part is made uppercase.
4205 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206
4207 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4208'insertmode' 'im' boolean (default off)
4209 global
4210 {not in Vi}
4211 Makes Vim work in a way that Insert mode is the default mode. Useful
4212 if you want to use Vim as a modeless editor. Used for |evim|.
4213 These Insert mode commands will be useful:
4214 - Use the cursor keys to move around.
4215 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4216 this is a mapping, it is executed as if 'insertmode' was off.
4217 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004219 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4220 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
4222 These items change when 'insertmode' is set:
4223 - when starting to edit of a file, Vim goes to Insert mode.
4224 - <Esc> in Insert mode is a no-op and beeps.
4225 - <Esc> in Normal mode makes Vim go to Insert mode.
4226 - CTRL-L in Insert mode is a command, it is not inserted.
4227 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4228 However, when <Esc> is used inside a mapping, it behaves like
4229 'insertmode' was not set. This was done to be able to use the same
4230 mappings with 'insertmode' set or not set.
4231 When executing commands with |:normal| 'insertmode' is not used.
4232
4233 NOTE: This option is reset when 'compatible' is set.
4234
4235 *'isfname'* *'isf'*
4236'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4237 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4238 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4239 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4240 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4241 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4242 global
4243 {not in Vi}
4244 The characters specified by this option are included in file names and
4245 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004246 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 Multi-byte characters 256 and above are always included, only the
4248 characters up to 255 are specified with this option.
4249 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004250 Think twice before adding white space to this option. Although a
4251 space may appear inside a file name, the effect will be that Vim
4252 doesn't know where a file name starts or ends when doing completion.
4253 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254
4255 Note that on systems using a backslash as path separator, Vim tries to
4256 do its best to make it work as you would expect. That is a bit
4257 tricky, since Vi originally used the backslash to escape special
4258 characters. Vim will not remove a backslash in front of a normal file
4259 name character on these systems, but it will on Unix and alikes. The
4260 '&' and '^' are not included by default, because these are special for
4261 cmd.exe.
4262
4263 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004264 Each part can be a single character number or a range. A range is two
4265 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 decimal number between 0 and 255 or the ASCII character itself (does
4267 not work for digits). Example:
4268 "_,-,128-140,#-43" (include '_' and '-' and the range
4269 128 to 140 and '#' to 43)
4270 If a part starts with '^', the following character number or range
4271 will be excluded from the option. The option is interpreted from left
4272 to right. Put the excluded character after the range where it is
4273 included. To include '^' itself use it as the last character of the
4274 option or the end of a range. Example:
4275 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4276 If the character is '@', all characters where isalpha() returns TRUE
4277 are included. Normally these are the characters a to z and A to Z,
4278 plus accented characters. To include '@' itself use "@-@". Examples:
4279 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004280 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 "a-z,A-Z,@-@" All letters plus the '@' character.
4282 A comma can be included by using it where a character number is
4283 expected. Example:
4284 "48-57,,,_" Digits, comma and underscore.
4285 A comma can be excluded by prepending a '^'. Example:
4286 " -~,^,,9" All characters from space to '~', excluding
4287 comma, plus <Tab>.
4288 See |option-backslash| about including spaces and backslashes.
4289
4290 *'isident'* *'isi'*
4291'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4292 "@,48-57,_,128-167,224-235"
4293 otherwise: "@,48-57,_,192-255")
4294 global
4295 {not in Vi}
4296 The characters given by this option are included in identifiers.
4297 Identifiers are used in recognizing environment variables and after a
4298 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004299 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 option.
4301 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004302 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4304
4305 *'iskeyword'* *'isk'*
4306'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4307 "@,48-57,_,128-167,224-235"
4308 otherwise: "@,48-57,_,192-255"
4309 Vi default: "@,48-57,_")
4310 local to buffer
4311 {not in Vi}
4312 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004313 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 'isfname' for a description of the format of this option. For C
4315 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4316 For a help file it is set to all non-blank printable characters except
4317 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4318 command).
4319 When the 'lisp' option is on the '-' character is always included.
4320 NOTE: This option is set to the Vi default value when 'compatible' is
4321 set and to the Vim default value when 'compatible' is reset.
4322
4323 *'isprint'* *'isp'*
4324'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4325 "@,~-255"; otherwise: "@,161-255")
4326 global
4327 {not in Vi}
4328 The characters given by this option are displayed directly on the
4329 screen. It is also used for "\p" in a |pattern|. The characters from
4330 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4331 even when they are not included in 'isprint' or excluded. See
4332 'isfname' for a description of the format of this option.
4333
4334 Non-printable characters are displayed with two characters:
4335 0 - 31 "^@" - "^_"
4336 32 - 126 always single characters
4337 127 "^?"
4338 128 - 159 "~@" - "~_"
4339 160 - 254 "| " - "|~"
4340 255 "~?"
4341 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4342 displayed as <xx>, with the hexadecimal value of the byte.
4343 When 'display' contains "uhex" all unprintable characters are
4344 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004345 The SpecialKey highlighting will be used for unprintable characters.
4346 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347
4348 Multi-byte characters 256 and above are always included, only the
4349 characters up to 255 are specified with this option. When a character
4350 is printable but it is not available in the current font, a
4351 replacement character will be shown.
4352 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4353 There is no option to specify these characters.
4354
4355 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4356'joinspaces' 'js' boolean (default on)
4357 global
4358 {not in Vi}
4359 Insert two spaces after a '.', '?' and '!' with a join command.
4360 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4361 Otherwise only one space is inserted.
4362 NOTE: This option is set when 'compatible' is set.
4363
4364 *'key'*
4365'key' string (default "")
4366 local to buffer
4367 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004368 {only available when compiled with the |+cryptv|
4369 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004371 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 Careful: Do not set the key value by hand, someone might see the typed
4373 key. Use the |:X| command. But you can make 'key' empty: >
4374 :set key=
4375< It is not possible to get the value of this option with ":set key" or
4376 "echo &key". This is to avoid showing it to someone who shouldn't
4377 know. It also means you cannot see it yourself once you have set it,
4378 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004379 You can use "&key" in an expression to detect whether encryption is
4380 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381
4382 *'keymap'* *'kmp'* *E544*
4383'keymap' 'kmp' string (default "")
4384 local to buffer
4385 {not in Vi}
4386 {only available when compiled with the |+keymap|
4387 feature}
4388 Name of a keyboard mapping. See |mbyte-keymap|.
4389 Setting this option to a valid keymap name has the side effect of
4390 setting 'iminsert' to one, so that the keymap becomes effective.
4391 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004392 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393
4394 *'keymodel'* *'km'*
4395'keymodel' 'km' string (default "")
4396 global
4397 {not in Vi}
4398 List of comma separated words, which enable special things that keys
4399 can do. These values can be used:
4400 startsel Using a shifted special key starts selection (either
4401 Select mode or Visual mode, depending on "key" being
4402 present in 'selectmode').
4403 stopsel Using a not-shifted special key stops selection.
4404 Special keys in this context are the cursor keys, <End>, <Home>,
4405 <PageUp> and <PageDown>.
4406 The 'keymodel' option is set by the |:behave| command.
4407
4408 *'keywordprg'* *'kp'*
4409'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4410 OS/2: "view /", VMS: "help")
4411 global or local to buffer |global-local|
4412 {not in Vi}
4413 Program to use for the |K| command. Environment variables are
4414 expanded |:set_env|. ":help" may be used to access the Vim internal
4415 help. (Note that previously setting the global option to the empty
4416 value did this, which is now deprecated.)
4417 When "man" is used, Vim will automatically translate a count for the
4418 "K" command to a section number. Also for "man -s", in which case the
4419 "-s" is removed when there is no count.
4420 See |option-backslash| about including spaces and backslashes.
4421 Example: >
4422 :set keywordprg=man\ -s
4423< This option cannot be set from a |modeline| or in the |sandbox|, for
4424 security reasons.
4425
4426 *'langmap'* *'lmap'* *E357* *E358*
4427'langmap' 'lmap' string (default "")
4428 global
4429 {not in Vi}
4430 {only available when compiled with the |+langmap|
4431 feature}
4432 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004433 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 inserted directly. When in command mode the 'langmap' option takes
4435 care of translating these special characters to the original meaning
4436 of the key. This means you don't have to change the keyboard mode to
4437 be able to execute Normal mode commands.
4438 This is the opposite of the 'keymap' option, where characters are
4439 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004441 Example (for Greek, in UTF-8): *greek* >
4442 :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 +00004443< Example (exchanges meaning of z and y for commands): >
4444 :set langmap=zy,yz,ZY,YZ
4445<
4446 The 'langmap' option is a list of parts, separated with commas. Each
4447 part can be in one of two forms:
4448 1. A list of pairs. Each pair is a "from" character immediately
4449 followed by the "to" character. Examples: "aA", "aAbBcC".
4450 2. A list of "from" characters, a semi-colon and a list of "to"
4451 characters. Example: "abc;ABC"
4452 Example: "aA,fgh;FGH,cCdDeE"
4453 Special characters need to be preceded with a backslash. These are
4454 ";", ',' and backslash itself.
4455
4456 This will allow you to activate vim actions without having to switch
4457 back and forth between the languages. Your language characters will
4458 be understood as normal vim English characters (according to the
4459 langmap mappings) in the following cases:
4460 o Normal/Visual mode (commands, buffer/register names, user mappings)
4461 o Insert/Replace Mode: Register names after CTRL-R
4462 o Insert/Replace Mode: Mappings
4463 Characters entered in Command-line mode will NOT be affected by
4464 this option. Note that this option can be changed at any time
4465 allowing to switch between mappings for different languages/encodings.
4466 Use a mapping to avoid having to type it each time!
4467
4468 *'langmenu'* *'lm'*
4469'langmenu' 'lm' string (default "")
4470 global
4471 {not in Vi}
4472 {only available when compiled with the |+menu| and
4473 |+multi_lang| features}
4474 Language to use for menu translation. Tells which file is loaded
4475 from the "lang" directory in 'runtimepath': >
4476 "lang/menu_" . &langmenu . ".vim"
4477< (without the spaces). For example, to always use the Dutch menus, no
4478 matter what $LANG is set to: >
4479 :set langmenu=nl_NL.ISO_8859-1
4480< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004481 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 If your $LANG is set to a non-English language but you do want to use
4483 the English menus: >
4484 :set langmenu=none
4485< This option must be set before loading menus, switching on filetype
4486 detection or syntax highlighting. Once the menus are defined setting
4487 this option has no effect. But you could do this: >
4488 :source $VIMRUNTIME/delmenu.vim
4489 :set langmenu=de_DE.ISO_8859-1
4490 :source $VIMRUNTIME/menu.vim
4491< Warning: This deletes all menus that you defined yourself!
4492
4493 *'laststatus'* *'ls'*
4494'laststatus' 'ls' number (default 1)
4495 global
4496 {not in Vi}
4497 The value of this option influences when the last window will have a
4498 status line:
4499 0: never
4500 1: only if there are at least two windows
4501 2: always
4502 The screen looks nicer with a status line if you have several
4503 windows, but it takes another screen line. |status-line|
4504
4505 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4506'lazyredraw' 'lz' boolean (default off)
4507 global
4508 {not in Vi}
4509 When this option is set, the screen will not be redrawn while
4510 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004511 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004512 update use |:redraw|.
4513
4514 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4515'linebreak' 'lbr' boolean (default off)
4516 local to window
4517 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004518 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 feature}
4520 If on Vim will wrap long lines at a character in 'breakat' rather
4521 than at the last character that fits on the screen. Unlike
4522 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4523 it only affects the way the file is displayed, not its contents. The
4524 value of 'showbreak' is used to put in front of wrapped lines.
4525 This option is not used when the 'wrap' option is off or 'list' is on.
4526 Note that <Tab> characters after an <EOL> are mostly not displayed
4527 with the right amount of white space.
4528
4529 *'lines'* *E593*
4530'lines' number (default 24 or terminal height)
4531 global
4532 Number of lines of the Vim window.
4533 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004534 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 When Vim is running in the GUI or in a resizable window, setting this
4536 option will cause the window size to be changed. When you only want
4537 to use the size for the GUI, put the command in your |gvimrc| file.
4538 Vim limits the number of lines to what fits on the screen. You can
4539 use this command to get the tallest window possible: >
4540 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004541< Minimum value is 2, maximum value is 1000.
4542 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 When you set this option and Vim is unable to change the physical
4544 number of lines of the display, the display may be messed up.
4545
4546 *'linespace'* *'lsp'*
4547'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4548 global
4549 {not in Vi}
4550 {only in the GUI}
4551 Number of pixel lines inserted between characters. Useful if the font
4552 uses the full character cell height, making lines touch each other.
4553 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004554 With some fonts there can be too much room between lines (to have
4555 space for ascents and descents). Then it makes sense to set
4556 'linespace' to a negative value. This may cause display problems
4557 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 *'lisp'* *'nolisp'*
4560'lisp' boolean (default off)
4561 local to buffer
4562 {not available when compiled without the |+lispindent|
4563 feature}
4564 Lisp mode: When <Enter> is typed in insert mode set the indent for
4565 the next line to Lisp standards (well, sort of). Also happens with
4566 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4567 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4568 better. Also see 'lispwords'.
4569 The '-' character is included in keyword characters. Redefines the
4570 "=" operator to use this same indentation algorithm rather than
4571 calling an external program if 'equalprg' is empty.
4572 This option is not used when 'paste' is set.
4573 {Vi: Does it a little bit differently}
4574
4575 *'lispwords'* *'lw'*
4576'lispwords' 'lw' string (default is very long)
4577 global
4578 {not in Vi}
4579 {not available when compiled without the |+lispindent|
4580 feature}
4581 Comma separated list of words that influence the Lisp indenting.
4582 |'lisp'|
4583
4584 *'list'* *'nolist'*
4585'list' boolean (default off)
4586 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004587 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4588 line. Useful to see the difference between tabs and spaces and for
4589 trailing blanks. Further changed by the 'listchars' option.
4590
4591 The cursor is displayed at the start of the space a Tab character
4592 occupies, not at the end as usual in Normal mode. To get this cursor
4593 position while displaying Tabs with spaces, use: >
4594 :set list lcs=tab\ \
4595<
4596 Note that list mode will also affect formatting (set with 'textwidth'
4597 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598 changing the way tabs are displayed.
4599
4600 *'listchars'* *'lcs'*
4601'listchars' 'lcs' string (default "eol:$")
4602 global
4603 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004604 Strings to use in 'list' mode and for the |:list| command. It is a
4605 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004606 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607 eol:c Character to show at the end of each line. When
4608 omitted, there is no extra character at the end of the
4609 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004610 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004611 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004613 fill the space that the tab normally occupies.
4614 "tab:>-" will show a tab that takes four spaces as
4615 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004616 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004617 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004619 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 extends:c Character to show in the last column, when 'wrap' is
4621 off and the line continues beyond the right of the
4622 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004623 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 precedes:c Character to show in the first column, when 'wrap'
4625 is off and there is text preceding the character
4626 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004627 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004628 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004629 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004630 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004631 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004632 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004634 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004636 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004637
4638 Examples: >
4639 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004640 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641 :set lcs=extends:>,precedes:<
4642< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004643 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004644 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
4646 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4647'loadplugins' 'lpl' boolean (default on)
4648 global
4649 {not in Vi}
4650 When on the plugin scripts are loaded when starting up |load-plugins|.
4651 This option can be reset in your |vimrc| file to disable the loading
4652 of plugins.
4653 Note that using the "-u NONE" and "--noplugin" command line arguments
4654 reset this option. |-u| |--noplugin|
4655
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004656 *'macatsui'* *'nomacatsui'*
4657'macatsui' boolean (default on)
4658 global
4659 {only available in Mac GUI version}
4660 This is a workaround for when drawing doesn't work properly. When set
4661 and compiled with multi-byte support ATSUI text drawing is used. When
4662 not set ATSUI text drawing is not used. Switch this option off when
4663 you experience drawing problems. In a future version the problems may
4664 be solved and this option becomes obsolete. Therefore use this method
4665 to unset it: >
4666 if exists('&macatsui')
4667 set nomacatsui
4668 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004669< Another option to check if you have drawing problems is
4670 'termencoding'.
4671
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 *'magic'* *'nomagic'*
4673'magic' boolean (default on)
4674 global
4675 Changes the special characters that can be used in search patterns.
4676 See |pattern|.
4677 NOTE: To avoid portability problems with using patterns, always keep
4678 this option at the default "on". Only switch it off when working with
4679 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004680 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681
4682 *'makeef'* *'mef'*
4683'makeef' 'mef' string (default: "")
4684 global
4685 {not in Vi}
4686 {not available when compiled without the |+quickfix|
4687 feature}
4688 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4689 and the |:grep| command.
4690 When it is empty, an internally generated temp file will be used.
4691 When "##" is included, it is replaced by a number to make the name
4692 unique. This makes sure that the ":make" command doesn't overwrite an
4693 existing file.
4694 NOT used for the ":cf" command. See 'errorfile' for that.
4695 Environment variables are expanded |:set_env|.
4696 See |option-backslash| about including spaces and backslashes.
4697 This option cannot be set from a |modeline| or in the |sandbox|, for
4698 security reasons.
4699
4700 *'makeprg'* *'mp'*
4701'makeprg' 'mp' string (default "make", VMS: "MMS")
4702 global or local to buffer |global-local|
4703 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004704 Program to use for the ":make" command. See |:make_makeprg|.
4705 This option may contain '%' and '#' characters, which are expanded to
4706 the current and alternate file name. |:_%| |:_#|
4707 Environment variables are expanded |:set_env|. See |option-backslash|
4708 about including spaces and backslashes.
4709 Note that a '|' must be escaped twice: once for ":set" and once for
4710 the interpretation of a command. When you use a filter called
4711 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 :set makeprg=gmake\ \\\|\ myfilter
4713< The placeholder "$*" can be given (even multiple times) to specify
4714 where the arguments will be included, for example: >
4715 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4716< This option cannot be set from a |modeline| or in the |sandbox|, for
4717 security reasons.
4718
4719 *'matchpairs'* *'mps'*
4720'matchpairs' 'mps' string (default "(:),{:},[:]")
4721 local to buffer
4722 {not in Vi}
4723 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004724 other.
4725 Only character pairs are allowed that are different, thus you cannot
4726 jump between two double quotes.
4727 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004728 The pairs must be separated by a comma. Example for including '<' and
4729 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 :set mps+=<:>
4731
4732< A more exotic example, to jump between the '=' and ';' in an
4733 assignment, useful for languages like C and Java: >
4734 :au FileType c,cpp,java set mps+==:;
4735
4736< For a more advanced way of using "%", see the matchit.vim plugin in
4737 the $VIMRUNTIME/macros directory. |add-local-help|
4738
4739 *'matchtime'* *'mat'*
4740'matchtime' 'mat' number (default 5)
4741 global
4742 {not in Vi}{in Nvi}
4743 Tenths of a second to show the matching paren, when 'showmatch' is
4744 set. Note that this is not in milliseconds, like other options that
4745 set a time. This is to be compatible with Nvi.
4746
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004747 *'maxcombine'* *'mco'*
4748'maxcombine' 'mco' number (default 2)
4749 global
4750 {not in Vi}
4751 {only available when compiled with the |+multi_byte|
4752 feature}
4753 The maximum number of combining characters supported for displaying.
4754 Only used when 'encoding' is "utf-8".
4755 The default is OK for most languages. Hebrew may require 4.
4756 Maximum value is 6.
4757 Even when this option is set to 2 you can still edit text with more
4758 combining characters, you just can't see them. Use |g8| or |ga|.
4759 See |mbyte-combining|.
4760
Bram Moolenaar071d4272004-06-13 20:20:40 +00004761 *'maxfuncdepth'* *'mfd'*
4762'maxfuncdepth' 'mfd' number (default 100)
4763 global
4764 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004765 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004766 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 Maximum depth of function calls for user functions. This normally
4768 catches endless recursion. When using a recursive function with
4769 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4770 more memory, there is the danger of failing when memory is exhausted.
4771 See also |:function|.
4772
4773 *'maxmapdepth'* *'mmd'* *E223*
4774'maxmapdepth' 'mmd' number (default 1000)
4775 global
4776 {not in Vi}
4777 Maximum number of times a mapping is done without resulting in a
4778 character to be used. This normally catches endless mappings, like
4779 ":map x y" with ":map y x". It still does not catch ":map g wg",
4780 because the 'w' is used before the next mapping is done. See also
4781 |key-mapping|.
4782
4783 *'maxmem'* *'mm'*
4784'maxmem' 'mm' number (default between 256 to 5120 (system
4785 dependent) or half the amount of memory
4786 available)
4787 global
4788 {not in Vi}
4789 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4790 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004791 other memory to be freed. The maximum usable value is about 2000000.
4792 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004794 *'maxmempattern'* *'mmp'*
4795'maxmempattern' 'mmp' number (default 1000)
4796 global
4797 {not in Vi}
4798 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004799 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004800 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004801 When Vim runs into the limit it gives an error message and mostly
4802 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004803 Running into the limit often means that the pattern is very
4804 inefficient or too complex. This may already happen with the pattern
4805 "\(.\)*" on a very long line. ".*" works much better.
4806 Vim may run out of memory before hitting the 'maxmempattern' limit.
4807
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 *'maxmemtot'* *'mmt'*
4809'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4810 dependent) or half the amount of memory
4811 available)
4812 global
4813 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004814 Maximum amount of memory in Kbyte to use for all buffers together.
4815 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4816 without a limit. On 64 bit machines higher values might work. But
4817 hey, do you really need more than 2 Gbyte for text editing?
4818 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819
4820 *'menuitems'* *'mis'*
4821'menuitems' 'mis' number (default 25)
4822 global
4823 {not in Vi}
4824 {not available when compiled without the |+menu|
4825 feature}
4826 Maximum number of items to use in a menu. Used for menus that are
4827 generated from a list of items, e.g., the Buffers menu. Changing this
4828 option has no direct effect, the menu must be refreshed first.
4829
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004830 *'mkspellmem'* *'msm'*
4831'mkspellmem' 'msm' string (default "460000,2000,500")
4832 global
4833 {not in Vi}
4834 {not available when compiled without the |+syntax|
4835 feature}
4836 Parameters for |:mkspell|. This tunes when to start compressing the
4837 word tree. Compression can be slow when there are many words, but
4838 it's needed to avoid running out of memory. The amount of memory used
4839 per word depends very much on how similar the words are, that's why
4840 this tuning is complicated.
4841
4842 There are three numbers, separated by commas:
4843 {start},{inc},{added}
4844
4845 For most languages the uncompressed word tree fits in memory. {start}
4846 gives the amount of memory in Kbyte that can be used before any
4847 compression is done. It should be a bit smaller than the amount of
4848 memory that is available to Vim.
4849
4850 When going over the {start} limit the {inc} number specifies the
4851 amount of memory in Kbyte that can be allocated before another
4852 compression is done. A low number means compression is done after
4853 less words are added, which is slow. A high number means more memory
4854 will be allocated.
4855
4856 After doing compression, {added} times 1024 words can be added before
4857 the {inc} limit is ignored and compression is done when any extra
4858 amount of memory is needed. A low number means there is a smaller
4859 chance of hitting the {inc} limit, less memory is used but it's
4860 slower.
4861
4862 The languages for which these numbers are important are Italian and
4863 Hungarian. The default works for when you have about 512 Mbyte. If
4864 you have 1 Gbyte you could use: >
4865 :set mkspellmem=900000,3000,800
4866< If you have less than 512 Mbyte |:mkspell| may fail for some
4867 languages, no matter what you set 'mkspellmem' to.
4868
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004870'modeline' 'ml' boolean (Vim default: on (off for root),
4871 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 local to buffer
4873 *'modelines'* *'mls'*
4874'modelines' 'mls' number (default 5)
4875 global
4876 {not in Vi}
4877 If 'modeline' is on 'modelines' gives the number of lines that is
4878 checked for set commands. If 'modeline' is off or 'modelines' is zero
4879 no lines are checked. See |modeline|.
4880 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4881 set and to the Vim default value when 'compatible' is reset.
4882
4883 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4884'modifiable' 'ma' boolean (default on)
4885 local to buffer
4886 {not in Vi} *E21*
4887 When off the buffer contents cannot be changed. The 'fileformat' and
4888 'fileencoding' options also can't be changed.
4889 Can be reset with the |-M| command line argument.
4890
4891 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4892'modified' 'mod' boolean (default off)
4893 local to buffer
4894 {not in Vi}
4895 When on, the buffer is considered to be modified. This option is set
4896 when:
4897 1. A change was made to the text since it was last written. Using the
4898 |undo| command to go back to the original text will reset the
4899 option. But undoing changes that were made before writing the
4900 buffer will set the option again, since the text is different from
4901 when it was written.
4902 2. 'fileformat' or 'fileencoding' is different from its original
4903 value. The original value is set when the buffer is read or
4904 written. A ":set nomodified" command also resets the original
4905 values to the current values and the 'modified' option will be
4906 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004907 This option is not set when a change is made to the buffer as the
4908 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4909 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4910 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004911 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4912 will be ignored.
4913
4914 *'more'* *'nomore'*
4915'more' boolean (Vim default: on, Vi default: off)
4916 global
4917 {not in Vi}
4918 When on, listings pause when the whole screen is filled. You will get
4919 the |more-prompt|. When this option is off there are no pauses, the
4920 listing continues until finished.
4921 NOTE: This option is set to the Vi default value when 'compatible' is
4922 set and to the Vim default value when 'compatible' is reset.
4923
4924 *'mouse'* *E538*
4925'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4926 global
4927 {not in Vi}
4928 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004929 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4930 sysmouse and Linux console with gpm). For using the mouse in the
4931 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932 The mouse can be enabled for different modes:
4933 n Normal mode
4934 v Visual mode
4935 i Insert mode
4936 c Command-line mode
4937 h all previous modes when editing a help file
4938 a all previous modes
4939 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004940 Normally you would enable the mouse in all four modes with: >
4941 :set mouse=a
4942< When the mouse is not enabled, the GUI will still use the mouse for
4943 modeless selection. This doesn't move the text cursor.
4944
4945 See |mouse-using|. Also see |'clipboard'|.
4946
4947 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004948 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 the mouse buttons can still be used by keeping the shift key pressed.
4950 Also see the 'clipboard' option.
4951
4952 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4953'mousefocus' 'mousef' boolean (default off)
4954 global
4955 {not in Vi}
4956 {only works in the GUI}
4957 The window that the mouse pointer is on is automatically activated.
4958 When changing the window layout or window focus in another way, the
4959 mouse pointer is moved to the window with keyboard focus. Off is the
4960 default because it makes using the pull down menus a little goofy, as
4961 a pointer transit may activate a window unintentionally.
4962
4963 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4964'mousehide' 'mh' boolean (default on)
4965 global
4966 {not in Vi}
4967 {only works in the GUI}
4968 When on, the mouse pointer is hidden when characters are typed.
4969 The mouse pointer is restored when the mouse is moved.
4970
4971 *'mousemodel'* *'mousem'*
4972'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4973 global
4974 {not in Vi}
4975 Sets the model to use for the mouse. The name mostly specifies what
4976 the right mouse button is used for:
4977 extend Right mouse button extends a selection. This works
4978 like in an xterm.
4979 popup Right mouse button pops up a menu. The shifted left
4980 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004981 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004982 popup_setpos Like "popup", but the cursor will be moved to the
4983 position where the mouse was clicked, and thus the
4984 selected operation will act upon the clicked object.
4985 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004986 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004987 course, that right clicking outside a selection will
4988 end Visual mode.
4989 Overview of what button does what for each model:
4990 mouse extend popup(_setpos) ~
4991 left click place cursor place cursor
4992 left drag start selection start selection
4993 shift-left search word extend selection
4994 right click extend selection popup menu (place cursor)
4995 right drag extend selection -
4996 middle click paste paste
4997
4998 In the "popup" model the right mouse button produces a pop-up menu.
4999 You need to define this first, see |popup-menu|.
5000
5001 Note that you can further refine the meaning of buttons with mappings.
5002 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5003 selection (because that's handled in the GUI code directly).
5004
5005 The 'mousemodel' option is set by the |:behave| command.
5006
5007 *'mouseshape'* *'mouses'* *E547*
5008'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005009 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010 global
5011 {not in Vi}
5012 {only available when compiled with the |+mouseshape|
5013 feature}
5014 This option tells Vim what the mouse pointer should look like in
5015 different modes. The option is a comma separated list of parts, much
5016 like used for 'guicursor'. Each part consist of a mode/location-list
5017 and an argument-list:
5018 mode-list:shape,mode-list:shape,..
5019 The mode-list is a dash separated list of these modes/locations:
5020 In a normal window: ~
5021 n Normal mode
5022 v Visual mode
5023 ve Visual mode with 'selection' "exclusive" (same as 'v',
5024 if not specified)
5025 o Operator-pending mode
5026 i Insert mode
5027 r Replace mode
5028
5029 Others: ~
5030 c appending to the command-line
5031 ci inserting in the command-line
5032 cr replacing in the command-line
5033 m at the 'Hit ENTER' or 'More' prompts
5034 ml idem, but cursor in the last line
5035 e any mode, pointer below last window
5036 s any mode, pointer on a status line
5037 sd any mode, while dragging a status line
5038 vs any mode, pointer on a vertical separator line
5039 vd any mode, while dragging a vertical separator line
5040 a everywhere
5041
5042 The shape is one of the following:
5043 avail name looks like ~
5044 w x arrow Normal mouse pointer
5045 w x blank no pointer at all (use with care!)
5046 w x beam I-beam
5047 w x updown up-down sizing arrows
5048 w x leftright left-right sizing arrows
5049 w x busy The system's usual busy pointer
5050 w x no The system's usual 'no input' pointer
5051 x udsizing indicates up-down resizing
5052 x lrsizing indicates left-right resizing
5053 x crosshair like a big thin +
5054 x hand1 black hand
5055 x hand2 white hand
5056 x pencil what you write with
5057 x question big ?
5058 x rightup-arrow arrow pointing right-up
5059 w x up-arrow arrow pointing up
5060 x <number> any X11 pointer number (see X11/cursorfont.h)
5061
5062 The "avail" column contains a 'w' if the shape is available for Win32,
5063 x for X11.
5064 Any modes not specified or shapes not available use the normal mouse
5065 pointer.
5066
5067 Example: >
5068 :set mouseshape=s:udsizing,m:no
5069< will make the mouse turn to a sizing arrow over the status lines and
5070 indicate no input when the hit-enter prompt is displayed (since
5071 clicking the mouse has no effect in this state.)
5072
5073 *'mousetime'* *'mouset'*
5074'mousetime' 'mouset' number (default 500)
5075 global
5076 {not in Vi}
5077 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5078 time in msec between two mouse clicks for the second click to be
5079 recognized as a multi click.
5080
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005081 *'mzquantum'* *'mzq'*
5082'mzquantum' 'mzq' number (default 100)
5083 global
5084 {not in Vi}
5085 {not available when compiled without the |+mzscheme|
5086 feature}
5087 The number of milliseconds between polls for MzScheme threads.
5088 Negative or zero value means no thread scheduling.
5089
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 *'nrformats'* *'nf'*
5091'nrformats' 'nf' string (default "octal,hex")
5092 local to buffer
5093 {not in Vi}
5094 This defines what bases Vim will consider for numbers when using the
5095 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5096 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005097 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005099 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005100 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005102 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 considered to be hexadecimal. Example: Using CTRL-X on
5104 "0x100" results in "0x0ff".
5105 Numbers which simply begin with a digit in the range 1-9 are always
5106 considered decimal. This also happens for numbers that are not
5107 recognized as octal or hex.
5108
5109 *'number'* *'nu'* *'nonumber'* *'nonu'*
5110'number' 'nu' boolean (default off)
5111 local to window
5112 Print the line number in front of each line. When the 'n' option is
5113 excluded from 'cpoptions' a wrapped line will not use the column of
5114 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005115 The 'numberwidth' option can be used to set the room used for the line
5116 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 When a long, wrapped line doesn't start with the first character, '-'
5118 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005119 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5120 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005121 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005123 *'numberwidth'* *'nuw'*
5124'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5125 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005126 {not in Vi}
5127 {only available when compiled with the |+linebreak|
5128 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005129 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005130 when the 'number' or 'relativenumber' option is set or printing lines
5131 with a line number. Since one space is always between the number and
5132 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005133 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005134 fit the highest line number in the buffer respectively the number of
5135 rows in the window, depending on whether 'number' or 'relativenumber'
5136 is set. Thus with the Vim default of 4 there is room for a line number
5137 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005138 The minimum value is 1, the maximum value is 10.
5139 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5140
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005141 *'omnifunc'* *'ofu'*
5142'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005143 local to buffer
5144 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005145 {not available when compiled without the |+eval|
5146 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005147 This option specifies a function to be used for Insert mode omni
5148 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005149 See |complete-functions| for an explanation of how the function is
5150 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005151 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005152 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005153 This option cannot be set from a |modeline| or in the |sandbox|, for
5154 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005155
5156
Bram Moolenaar02467872007-05-06 13:22:01 +00005157 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005158'opendevice' 'odev' boolean (default off)
5159 global
5160 {not in Vi}
5161 {only for MS-DOS, MS-Windows and OS/2}
5162 Enable reading and writing from devices. This may get Vim stuck on a
5163 device that can be opened but doesn't actually do the I/O. Therefore
5164 it is off by default.
5165 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5166 result in editing a device.
5167
5168
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005169 *'operatorfunc'* *'opfunc'*
5170'operatorfunc' 'opfunc' string (default: empty)
5171 global
5172 {not in Vi}
5173 This option specifies a function to be called by the |g@| operator.
5174 See |:map-operator| for more info and an example.
5175
5176 This option cannot be set from a |modeline| or in the |sandbox|, for
5177 security reasons.
5178
5179
Bram Moolenaar251e1912011-06-19 05:09:16 +02005180 *'osfiletype'* *'oft'*
5181'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 local to buffer
5183 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005184 This option was supported on RISC OS, which has been removed.
5185
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186
5187 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005188'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 global
5190 Specifies the nroff macros that separate paragraphs. These are pairs
5191 of two letters (see |object-motions|).
5192
5193 *'paste'* *'nopaste'*
5194'paste' boolean (default off)
5195 global
5196 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005197 Put Vim in Paste mode. This is useful if you want to cut or copy
5198 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199 unexpected effects.
5200 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005201 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 knows about pasting and will mostly do the right thing without 'paste'
5203 being set. The same is true for a terminal where Vim handles the
5204 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005205 This option is reset when starting the GUI. Thus if you set it in
5206 your .vimrc it will work in a terminal, but not in the GUI. Setting
5207 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5208 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 When the 'paste' option is switched on (also when it was already on):
5210 - mapping in Insert mode and Command-line mode is disabled
5211 - abbreviations are disabled
5212 - 'textwidth' is set to 0
5213 - 'wrapmargin' is set to 0
5214 - 'autoindent' is reset
5215 - 'smartindent' is reset
5216 - 'softtabstop' is set to 0
5217 - 'revins' is reset
5218 - 'ruler' is reset
5219 - 'showmatch' is reset
5220 - 'formatoptions' is used like it is empty
5221 These options keep their value, but their effect is disabled:
5222 - 'lisp'
5223 - 'indentexpr'
5224 - 'cindent'
5225 NOTE: When you start editing another file while the 'paste' option is
5226 on, settings from the modelines or autocommands may change the
5227 settings again, causing trouble when pasting text. You might want to
5228 set the 'paste' option again.
5229 When the 'paste' option is reset the mentioned options are restored to
5230 the value before the moment 'paste' was switched from off to on.
5231 Resetting 'paste' before ever setting it does not have any effect.
5232 Since mapping doesn't work while 'paste' is active, you need to use
5233 the 'pastetoggle' option to toggle the 'paste' option with some key.
5234
5235 *'pastetoggle'* *'pt'*
5236'pastetoggle' 'pt' string (default "")
5237 global
5238 {not in Vi}
5239 When non-empty, specifies the key sequence that toggles the 'paste'
5240 option. This is like specifying a mapping: >
5241 :map {keys} :set invpaste<CR>
5242< Where {keys} is the value of 'pastetoggle'.
5243 The difference is that it will work even when 'paste' is set.
5244 'pastetoggle' works in Insert mode and Normal mode, but not in
5245 Command-line mode.
5246 Mappings are checked first, thus overrule 'pastetoggle'. However,
5247 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5248 this: >
5249 :map <F10> :set paste<CR>
5250 :map <F11> :set nopaste<CR>
5251 :imap <F10> <C-O>:set paste<CR>
5252 :imap <F11> <nop>
5253 :set pastetoggle=<F11>
5254< This will make <F10> start paste mode and <F11> stop paste mode.
5255 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5256 mode everything is inserted literally, except the 'pastetoggle' key
5257 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005258 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005259
5260 *'pex'* *'patchexpr'*
5261'patchexpr' 'pex' string (default "")
5262 global
5263 {not in Vi}
5264 {not available when compiled without the |+diff|
5265 feature}
5266 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005267 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
5269 *'patchmode'* *'pm'* *E206*
5270'patchmode' 'pm' string (default "")
5271 global
5272 {not in Vi}
5273 When non-empty the oldest version of a file is kept. This can be used
5274 to keep the original version of a file if you are changing files in a
5275 source distribution. Only the first time that a file is written a
5276 copy of the original file will be kept. The name of the copy is the
5277 name of the original file with the string in the 'patchmode' option
5278 appended. This option should start with a dot. Use a string like
5279 ".org". 'backupdir' must not be empty for this to work (Detail: The
5280 backup file is renamed to the patchmode file after the new file has
5281 been successfully written, that's why it must be possible to write a
5282 backup file). If there was no file to be backed up, an empty file is
5283 created.
5284 When the 'backupskip' pattern matches, a patchmode file is not made.
5285 Using 'patchmode' for compressed files appends the extension at the
5286 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5287 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005288 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005290 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291'path' 'pa' string (default on Unix: ".,/usr/include,,"
5292 on OS/2: ".,/emx/include,,"
5293 other systems: ".,,")
5294 global or local to buffer |global-local|
5295 {not in Vi}
5296 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005297 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5298 provided that the file being searched for has a relative path (not
5299 starting with "/", "./" or "../"). The directories in the 'path'
5300 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 - Use commas to separate directory names: >
5302 :set path=.,/usr/local/include,/usr/include
5303< - Spaces can also be used to separate directory names (for backwards
5304 compatibility with version 3.0). To have a space in a directory
5305 name, precede it with an extra backslash, and escape the space: >
5306 :set path=.,/dir/with\\\ space
5307< - To include a comma in a directory name precede it with an extra
5308 backslash: >
5309 :set path=.,/dir/with\\,comma
5310< - To search relative to the directory of the current file, use: >
5311 :set path=.
5312< - To search in the current directory use an empty string between two
5313 commas: >
5314 :set path=,,
5315< - A directory name may end in a ':' or '/'.
5316 - Environment variables are expanded |:set_env|.
5317 - When using |netrw.vim| URLs can be used. For example, adding
5318 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005319 - Search upwards and downwards in a directory tree using "*", "**" and
5320 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 {not available when compiled without the |+path_extra| feature}
5322 - Careful with '\' characters, type two to get one in the option: >
5323 :set path=.,c:\\include
5324< Or just use '/' instead: >
5325 :set path=.,c:/include
5326< Don't forget "." or files won't even be found in the same directory as
5327 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005328 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005329 it is something like 256 or 1024 characters.
5330 You can check if all the include files are found, using the value of
5331 'path', see |:checkpath|.
5332 The use of |:set+=| and |:set-=| is preferred when adding or removing
5333 directories from the list. This avoids problems when a future version
5334 uses another default. To remove the current directory use: >
5335 :set path-=
5336< To add the current directory use: >
5337 :set path+=
5338< To use an environment variable, you probably need to replace the
5339 separator. Here is an example to append $INCL, in which directory
5340 names are separated with a semi-colon: >
5341 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5342< Replace the ';' with a ':' or whatever separator is used. Note that
5343 this doesn't work when $INCL contains a comma or white space.
5344
5345 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5346'preserveindent' 'pi' boolean (default off)
5347 local to buffer
5348 {not in Vi}
5349 When changing the indent of the current line, preserve as much of the
5350 indent structure as possible. Normally the indent is replaced by a
5351 series of tabs followed by spaces as required (unless |'expandtab'| is
5352 enabled, in which case only spaces are used). Enabling this option
5353 means the indent will preserve as many existing characters as possible
5354 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005355 'expandtab' does not apply to the preserved white space, a Tab remains
5356 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 NOTE: When using ">>" multiple times the resulting indent is a mix of
5358 tabs and spaces. You might not like this.
5359 NOTE: 'preserveindent' is reset when 'compatible' is set.
5360 Also see 'copyindent'.
5361 Use |:retab| to clean up white space.
5362
5363 *'previewheight'* *'pvh'*
5364'previewheight' 'pvh' number (default 12)
5365 global
5366 {not in Vi}
5367 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005368 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 Default height for a preview window. Used for |:ptag| and associated
5370 commands. Used for |CTRL-W_}| when no count is given.
5371
5372 *'previewwindow'* *'nopreviewwindow'*
5373 *'pvw'* *'nopvw'* *E590*
5374'previewwindow' 'pvw' boolean (default off)
5375 local to window
5376 {not in Vi}
5377 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005378 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005379 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 set. It's normally not set directly, but by using one of the commands
5381 |:ptag|, |:pedit|, etc.
5382
5383 *'printdevice'* *'pdev'*
5384'printdevice' 'pdev' string (default empty)
5385 global
5386 {not in Vi}
5387 {only available when compiled with the |+printer|
5388 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005389 The name of the printer to be used for |:hardcopy|.
5390 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005391 This option cannot be set from a |modeline| or in the |sandbox|, for
5392 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393
Bram Moolenaar8299df92004-07-10 09:47:34 +00005394 *'printencoding'* *'penc'*
5395'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 global
5397 {not in Vi}
5398 {only available when compiled with the |+printer|
5399 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005400 Sets the character encoding used when printing.
5401 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402
5403 *'printexpr'* *'pexpr'*
5404'printexpr' 'pexpr' String (default: see below)
5405 global
5406 {not in Vi}
5407 {only available when compiled with the |+printer|
5408 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005409 Expression used to print the PostScript produced with |:hardcopy|.
5410 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411
Bram Moolenaar8299df92004-07-10 09:47:34 +00005412 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005413'printfont' 'pfn' string (default "courier")
5414 global
5415 {not in Vi}
5416 {only available when compiled with the |+printer|
5417 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005418 The name of the font that will be used for |:hardcopy|.
5419 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005420
5421 *'printheader'* *'pheader'*
5422'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5423 global
5424 {not in Vi}
5425 {only available when compiled with the |+printer|
5426 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005427 The format of the header produced in |:hardcopy| output.
5428 See |pheader-option|.
5429
5430 *'printmbcharset'* *'pmbcs'*
5431'printmbcharset' 'pmbcs' string (default "")
5432 global
5433 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005434 {only available when compiled with the |+printer|,
5435 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005436 The CJK character set to be used for CJK output from |:hardcopy|.
5437 See |pmbcs-option|.
5438
5439 *'printmbfont'* *'pmbfn'*
5440'printmbfont' 'pmbfn' string (default "")
5441 global
5442 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005443 {only available when compiled with the |+printer|,
5444 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005445 List of font names to be used for CJK output from |:hardcopy|.
5446 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447
5448 *'printoptions'* *'popt'*
5449'printoptions' 'popt' string (default "")
5450 global
5451 {not in Vi}
5452 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005453 List of items that control the format of the output of |:hardcopy|.
5454 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005455
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005456 *'prompt'* *'noprompt'*
5457'prompt' boolean (default on)
5458 global
5459 When on a ":" prompt is used in Ex mode.
5460
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005461 *'pumheight'* *'ph'*
5462'pumheight' 'ph' number (default 0)
5463 global
5464 {not available when compiled without the
5465 |+insert_expand| feature}
5466 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005467 Determines the maximum number of items to show in the popup menu for
5468 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005469 |ins-completion-menu|.
5470
5471
Bram Moolenaar677ee682005-01-27 14:41:15 +00005472 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005473'quoteescape' 'qe' string (default "\")
5474 local to buffer
5475 {not in Vi}
5476 The characters that are used to escape quotes in a string. Used for
5477 objects like a', a" and a` |a'|.
5478 When one of the characters in this option is found inside a string,
5479 the following character will be skipped. The default value makes the
5480 text "foo\"bar\\" considered to be one string.
5481
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5483'readonly' 'ro' boolean (default off)
5484 local to buffer
5485 If on, writes fail unless you use a '!'. Protects you from
5486 accidentally overwriting a file. Default on when Vim is started
5487 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005488 When using ":w!" the 'readonly' option is reset for the current
5489 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005491 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005493 *'redrawtime'* *'rdt'*
5494'redrawtime' 'rdt' number (default 2000)
5495 global
5496 {not in Vi}
5497 {only available when compiled with the |+reltime|
5498 feature}
5499 The time in milliseconds for redrawing the display. This applies to
5500 searching for patterns for 'hlsearch' and |:match| highlighting.
5501 When redrawing takes more than this many milliseconds no further
5502 matches will be highlighted. This is used to avoid that Vim hangs
5503 when using a very complicated pattern.
5504
Bram Moolenaar64486672010-05-16 15:46:46 +02005505 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5506'relativenumber' 'rnu' boolean (default off)
5507 local to window
5508 {not in Vi}
5509 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005510 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005511 precede some vertical motion commands (e.g. j k + -) with, without
5512 having to calculate it yourself. Especially useful in combination with
5513 other commands (e.g. y d c < > gq gw =).
5514 When the 'n' option is excluded from 'cpoptions' a wrapped
5515 line will not use the column of line numbers (this is the default when
5516 'compatible' isn't set).
5517 The 'numberwidth' option can be used to set the room used for the line
5518 number.
5519 When a long, wrapped line doesn't start with the first character, '-'
5520 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005521 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5522 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005523 When setting this option, 'number' is reset.
5524
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 *'remap'* *'noremap'*
5526'remap' boolean (default on)
5527 global
5528 Allows for mappings to work recursively. If you do not want this for
5529 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005530 NOTE: To avoid portability problems with Vim scripts, always keep
5531 this option at the default "on". Only switch it off when working with
5532 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533
5534 *'report'*
5535'report' number (default 2)
5536 global
5537 Threshold for reporting number of lines changed. When the number of
5538 changed lines is more than 'report' a message will be given for most
5539 ":" commands. If you want it always, set 'report' to 0.
5540 For the ":substitute" command the number of substitutions is used
5541 instead of the number of lines.
5542
5543 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5544'restorescreen' 'rs' boolean (default on)
5545 global
5546 {not in Vi} {only in Windows 95/NT console version}
5547 When set, the screen contents is restored when exiting Vim. This also
5548 happens when executing external commands.
5549
5550 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5551 options in your .vimrc. To disable restoring:
5552 set t_ti= t_te=
5553 To enable restoring (for an xterm):
5554 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5555 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5556
5557 *'revins'* *'ri'* *'norevins'* *'nori'*
5558'revins' 'ri' boolean (default off)
5559 global
5560 {not in Vi}
5561 {only available when compiled with the |+rightleft|
5562 feature}
5563 Inserting characters in Insert mode will work backwards. See "typing
5564 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5565 command in Insert mode, when 'allowrevins' is set.
5566 NOTE: This option is reset when 'compatible' or 'paste' is set.
5567
5568 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5569'rightleft' 'rl' boolean (default off)
5570 local to window
5571 {not in Vi}
5572 {only available when compiled with the |+rightleft|
5573 feature}
5574 When on, display orientation becomes right-to-left, i.e., characters
5575 that are stored in the file appear from the right to the left.
5576 Using this option, it is possible to edit files for languages that
5577 are written from the right to the left such as Hebrew and Arabic.
5578 This option is per window, so it is possible to edit mixed files
5579 simultaneously, or to view the same file in both ways (this is
5580 useful whenever you have a mixed text file with both right-to-left
5581 and left-to-right strings so that both sets are displayed properly
5582 in different windows). Also see |rileft.txt|.
5583
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005584 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585'rightleftcmd' 'rlc' string (default "search")
5586 local to window
5587 {not in Vi}
5588 {only available when compiled with the |+rightleft|
5589 feature}
5590 Each word in this option enables the command line editing to work in
5591 right-to-left mode for a group of commands:
5592
5593 search "/" and "?" commands
5594
5595 This is useful for languages such as Hebrew, Arabic and Farsi.
5596 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5597
5598 *'ruler'* *'ru'* *'noruler'* *'noru'*
5599'ruler' 'ru' boolean (default off)
5600 global
5601 {not in Vi}
5602 {not available when compiled without the
5603 |+cmdline_info| feature}
5604 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005605 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 text in the file is shown on the far right:
5607 Top first line is visible
5608 Bot last line is visible
5609 All first and last line are visible
5610 45% relative position in the file
5611 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005612 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005614 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 this option takes precedence over 'ruler' and 'rulerformat'
5616 If the number of characters displayed is different from the number of
5617 bytes in the text (e.g., for a TAB or a multi-byte character), both
5618 the text column (byte number) and the screen column are shown,
5619 separated with a dash.
5620 For an empty line "0-1" is shown.
5621 For an empty buffer the line number will also be zero: "0,0-1".
5622 This option is reset when the 'paste' option is set.
5623 If you don't want to see the ruler all the time but want to know where
5624 you are, use "g CTRL-G" |g_CTRL-G|.
5625 NOTE: This option is reset when 'compatible' is set.
5626
5627 *'rulerformat'* *'ruf'*
5628'rulerformat' 'ruf' string (default empty)
5629 global
5630 {not in Vi}
5631 {not available when compiled without the |+statusline|
5632 feature}
5633 When this option is not empty, it determines the content of the ruler
5634 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005635 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 The default ruler width is 17 characters. To make the ruler 15
5637 characters wide, put "%15(" at the start and "%)" at the end.
5638 Example: >
5639 :set rulerformat=%15(%c%V\ %p%%%)
5640<
5641 *'runtimepath'* *'rtp'* *vimfiles*
5642'runtimepath' 'rtp' string (default:
5643 Unix: "$HOME/.vim,
5644 $VIM/vimfiles,
5645 $VIMRUNTIME,
5646 $VIM/vimfiles/after,
5647 $HOME/.vim/after"
5648 Amiga: "home:vimfiles,
5649 $VIM/vimfiles,
5650 $VIMRUNTIME,
5651 $VIM/vimfiles/after,
5652 home:vimfiles/after"
5653 PC, OS/2: "$HOME/vimfiles,
5654 $VIM/vimfiles,
5655 $VIMRUNTIME,
5656 $VIM/vimfiles/after,
5657 $HOME/vimfiles/after"
5658 Macintosh: "$VIM:vimfiles,
5659 $VIMRUNTIME,
5660 $VIM:vimfiles:after"
5661 RISC-OS: "Choices:vimfiles,
5662 $VIMRUNTIME,
5663 Choices:vimfiles/after"
5664 VMS: "sys$login:vimfiles,
5665 $VIM/vimfiles,
5666 $VIMRUNTIME,
5667 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005668 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 global
5670 {not in Vi}
5671 This is a list of directories which will be searched for runtime
5672 files:
5673 filetype.vim filetypes by file name |new-filetype|
5674 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005675 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 colors/ color scheme files |:colorscheme|
5677 compiler/ compiler files |:compiler|
5678 doc/ documentation |write-local-help|
5679 ftplugin/ filetype plugins |write-filetype-plugin|
5680 indent/ indent scripts |indent-expression|
5681 keymap/ key mapping files |mbyte-keymap|
5682 lang/ menu translations |:menutrans|
5683 menu.vim GUI menus |menu.vim|
5684 plugin/ plugin scripts |write-plugin|
5685 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005686 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 syntax/ syntax files |mysyntaxfile|
5688 tutor/ files for vimtutor |tutor|
5689
5690 And any other file searched for with the |:runtime| command.
5691
5692 The defaults for most systems are setup to search five locations:
5693 1. In your home directory, for your personal preferences.
5694 2. In a system-wide Vim directory, for preferences from the system
5695 administrator.
5696 3. In $VIMRUNTIME, for files distributed with Vim.
5697 *after-directory*
5698 4. In the "after" directory in the system-wide Vim directory. This is
5699 for the system administrator to overrule or add to the distributed
5700 defaults (rarely needed)
5701 5. In the "after" directory in your home directory. This is for
5702 personal preferences to overrule or add to the distributed defaults
5703 or system-wide settings (rarely needed).
5704
5705 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5706 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005707 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 wildcards.
5709 See |:runtime|.
5710 Example: >
5711 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5712< This will use the directory "~/vimruntime" first (containing your
5713 personal Vim runtime files), then "/mygroup/vim" (shared between a
5714 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5715 files).
5716 You probably should always include $VIMRUNTIME somewhere, to use the
5717 distributed runtime files. You can put a directory before $VIMRUNTIME
5718 to find files which replace a distributed runtime files. You can put
5719 a directory after $VIMRUNTIME to find files which add to distributed
5720 runtime files.
5721 This option cannot be set from a |modeline| or in the |sandbox|, for
5722 security reasons.
5723
5724 *'scroll'* *'scr'*
5725'scroll' 'scr' number (default: half the window height)
5726 local to window
5727 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5728 set to half the number of lines in the window when the window size
5729 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005730 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5732 the number of screen lines instead of file lines, makes a difference
5733 when lines wrap}
5734
5735 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5736'scrollbind' 'scb' boolean (default off)
5737 local to window
5738 {not in Vi}
5739 {not available when compiled without the |+scrollbind|
5740 feature}
5741 See also |scroll-binding|. When this option is set, the current
5742 window scrolls as other scrollbind windows (windows that also have
5743 this option set) scroll. This option is useful for viewing the
5744 differences between two versions of a file, see 'diff'.
5745 See |'scrollopt'| for options that determine how this option should be
5746 interpreted.
5747 This option is mostly reset when splitting a window to edit another
5748 file. This means that ":split | edit file" results in two windows
5749 with scroll-binding, but ":split file" does not.
5750
5751 *'scrolljump'* *'sj'*
5752'scrolljump' 'sj' number (default 1)
5753 global
5754 {not in Vi}
5755 Minimal number of lines to scroll when the cursor gets off the
5756 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5757 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005758 When set to a negative number from -1 to -100 this is used as the
5759 percentage of the window height. Thus -50 scrolls half the window
5760 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005761 NOTE: This option is set to 1 when 'compatible' is set.
5762
5763 *'scrolloff'* *'so'*
5764'scrolloff' 'so' number (default 0)
5765 global
5766 {not in Vi}
5767 Minimal number of screen lines to keep above and below the cursor.
5768 This will make some context visible around where you are working. If
5769 you set it to a very large value (999) the cursor line will always be
5770 in the middle of the window (except at the start or end of the file or
5771 when long lines wrap).
5772 For scrolling horizontally see 'sidescrolloff'.
5773 NOTE: This option is set to 0 when 'compatible' is set.
5774
5775 *'scrollopt'* *'sbo'*
5776'scrollopt' 'sbo' string (default "ver,jump")
5777 global
5778 {not available when compiled without the |+scrollbind|
5779 feature}
5780 {not in Vi}
5781 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005782 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5783 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784 The following words are available:
5785 ver Bind vertical scrolling for 'scrollbind' windows
5786 hor Bind horizontal scrolling for 'scrollbind' windows
5787 jump Applies to the offset between two windows for vertical
5788 scrolling. This offset is the difference in the first
5789 displayed line of the bound windows. When moving
5790 around in a window, another 'scrollbind' window may
5791 reach a position before the start or after the end of
5792 the buffer. The offset is not changed though, when
5793 moving back the 'scrollbind' window will try to scroll
5794 to the desired position when possible.
5795 When now making that window the current one, two
5796 things can be done with the relative offset:
5797 1. When "jump" is not included, the relative offset is
5798 adjusted for the scroll position in the new current
5799 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005800 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005801 2. When "jump" is included, the other windows are
5802 scrolled to keep the same relative offset. When
5803 going back to the other window, it still uses the
5804 same relative offset.
5805 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005806 When 'diff' mode is active there always is vertical scroll binding,
5807 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005808
5809 *'sections'* *'sect'*
5810'sections' 'sect' string (default "SHNHH HUnhsh")
5811 global
5812 Specifies the nroff macros that separate sections. These are pairs of
5813 two letters (See |object-motions|). The default makes a section start
5814 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5815
5816 *'secure'* *'nosecure'* *E523*
5817'secure' boolean (default off)
5818 global
5819 {not in Vi}
5820 When on, ":autocmd", shell and write commands are not allowed in
5821 ".vimrc" and ".exrc" in the current directory and map commands are
5822 displayed. Switch it off only if you know that you will not run into
5823 problems, or when the 'exrc' option is off. On Unix this option is
5824 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 'secure' at the end of your ~/.vimrc then.
5827 This option cannot be set from a |modeline| or in the |sandbox|, for
5828 security reasons.
5829
5830 *'selection'* *'sel'*
5831'selection' 'sel' string (default "inclusive")
5832 global
5833 {not in Vi}
5834 This option defines the behavior of the selection. It is only used
5835 in Visual and Select mode.
5836 Possible values:
5837 value past line inclusive ~
5838 old no yes
5839 inclusive yes yes
5840 exclusive yes no
5841 "past line" means that the cursor is allowed to be positioned one
5842 character past the line.
5843 "inclusive" means that the last character of the selection is included
5844 in an operation. For example, when "x" is used to delete the
5845 selection.
5846 Note that when "exclusive" is used and selecting from the end
5847 backwards, you cannot include the last character of a line, when
5848 starting in Normal mode and 'virtualedit' empty.
5849
5850 The 'selection' option is set by the |:behave| command.
5851
5852 *'selectmode'* *'slm'*
5853'selectmode' 'slm' string (default "")
5854 global
5855 {not in Vi}
5856 This is a comma separated list of words, which specifies when to start
5857 Select mode instead of Visual mode, when a selection is started.
5858 Possible values:
5859 mouse when using the mouse
5860 key when using shifted special keys
5861 cmd when using "v", "V" or CTRL-V
5862 See |Select-mode|.
5863 The 'selectmode' option is set by the |:behave| command.
5864
5865 *'sessionoptions'* *'ssop'*
5866'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005867 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868 global
5869 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005870 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 feature}
5872 Changes the effect of the |:mksession| command. It is a comma
5873 separated list of words. Each word enables saving and restoring
5874 something:
5875 word save and restore ~
5876 blank empty windows
5877 buffers hidden and unloaded buffers, not just those in windows
5878 curdir the current directory
5879 folds manually created folds, opened/closed folds and local
5880 fold options
5881 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005882 and contain at least one lowercase letter. Only
5883 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 help the help window
5885 localoptions options and mappings local to a window or buffer (not
5886 global values for local options)
5887 options all options and mappings (also global values for local
5888 options)
5889 resize size of the Vim window: 'lines' and 'columns'
5890 sesdir the directory in which the session file is located
5891 will become the current directory (useful with
5892 projects accessed over a network from different
5893 systems)
5894 slash backslashes in file names replaced with forward
5895 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005896 tabpages all tab pages; without this only the current tab page
5897 is restored, so that you can make a session for each
5898 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 unix with Unix end-of-line format (single <NL>), even when
5900 on Windows or DOS
5901 winpos position of the whole Vim window
5902 winsize window sizes
5903
5904 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005905 When neither "curdir" nor "sesdir" is included, file names are stored
5906 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 "slash" and "unix" are useful on Windows when sharing session files
5908 with Unix. The Unix version of Vim cannot source dos format scripts,
5909 but the Windows version of Vim can source unix format scripts.
5910
5911 *'shell'* *'sh'* *E91*
5912'shell' 'sh' string (default $SHELL or "sh",
5913 MS-DOS and Win32: "command.com" or
5914 "cmd.exe", OS/2: "cmd")
5915 global
5916 Name of the shell to use for ! and :! commands. When changing the
5917 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5918 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005919 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 See |option-backslash| about including spaces and backslashes.
5921 Environment variables are expanded |:set_env|.
5922 If the name of the shell contains a space, you might need to enclose
5923 it in quotes. Example: >
5924 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5925< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005926 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 "-f" is not inside the quotes, because it is not part of the command
5928 name. And Vim automagically recognizes the backslashes that are path
5929 separators.
5930 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5931 variable to change the way external commands are executed. See the
5932 libc.inf file of DJGPP.
5933 Under MS-Windows, when the executable ends in ".com" it must be
5934 included. Thus setting the shell to "command.com" or "4dos.com"
5935 works, but "command" and "4dos" do not work for all commands (e.g.,
5936 filtering).
5937 For unknown reasons, when using "4dos.com" the current directory is
5938 changed to "C:\". To avoid this set 'shell' like this: >
5939 :set shell=command.com\ /c\ 4dos
5940< This option cannot be set from a |modeline| or in the |sandbox|, for
5941 security reasons.
5942
5943 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005944'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005945 MS-DOS and Win32, when 'shell' does not
5946 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005947 global
5948 {not in Vi}
5949 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5950 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5951 systems, the default is set according to the value of 'shell', to
5952 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005953 OS/2 (EMX figures this out itself).
5954 On Unix it can have more than one flag. Each white space separated
5955 part is passed as an argument to the shell command.
5956 See |option-backslash| about including spaces and backslashes.
5957 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005958 This option cannot be set from a |modeline| or in the |sandbox|, for
5959 security reasons.
5960
5961 *'shellpipe'* *'sp'*
5962'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5963 global
5964 {not in Vi}
5965 {not available when compiled without the |+quickfix|
5966 feature}
5967 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005968 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 including spaces and backslashes.
5970 The name of the temporary file can be represented by "%s" if necessary
5971 (the file name is appended automatically if no %s appears in the value
5972 of this option).
5973 For the Amiga and MS-DOS the default is ">". The output is directly
5974 saved in a file and not echoed to the screen.
5975 For Unix the default it "| tee". The stdout of the compiler is saved
5976 in a file and echoed to the screen. If the 'shell' option is "csh" or
5977 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005978 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5979 default becomes "2>&1| tee". This means that stderr is also included.
5980 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5981 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005982 The initialization of this option is done after reading the ".vimrc"
5983 and the other initializations, so that when the 'shell' option is set
5984 there, the 'shellpipe' option changes automatically, unless it was
5985 explicitly set before.
5986 When 'shellpipe' is set to an empty string, no redirection of the
5987 ":make" output will be done. This is useful if you use a 'makeprg'
5988 that writes to 'makeef' by itself. If you want no piping, but do
5989 want to include the 'makeef', set 'shellpipe' to a single space.
5990 Don't forget to precede the space with a backslash: ":set sp=\ ".
5991 In the future pipes may be used for filtering and this option will
5992 become obsolete (at least for Unix).
5993 This option cannot be set from a |modeline| or in the |sandbox|, for
5994 security reasons.
5995
5996 *'shellquote'* *'shq'*
5997'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5998 contains "sh" somewhere: "\"")
5999 global
6000 {not in Vi}
6001 Quoting character(s), put around the command passed to the shell, for
6002 the "!" and ":!" commands. The redirection is kept outside of the
6003 quoting. See 'shellxquote' to include the redirection. It's
6004 probably not useful to set both options.
6005 This is an empty string by default. Only known to be useful for
6006 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6007 or bash, where it should be "\"". The default is adjusted according
6008 the value of 'shell', to reduce the need to set this option by the
6009 user. See |dos-shell|.
6010 This option cannot be set from a |modeline| or in the |sandbox|, for
6011 security reasons.
6012
6013 *'shellredir'* *'srr'*
6014'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6015 global
6016 {not in Vi}
6017 String to be used to put the output of a filter command in a temporary
6018 file. See also |:!|. See |option-backslash| about including spaces
6019 and backslashes.
6020 The name of the temporary file can be represented by "%s" if necessary
6021 (the file name is appended automatically if no %s appears in the value
6022 of this option).
6023 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6024 or "zsh" during initializations, the default becomes ">&". If the
6025 'shell' option is "sh", "ksh" or "bash" the default becomes
6026 ">%s 2>&1". This means that stderr is also included.
6027 For Win32, the Unix checks are done and additionally "cmd" is checked
6028 for, which makes the default ">%s 2>&1". Also, the same names with
6029 ".exe" appended are checked for.
6030 The initialization of this option is done after reading the ".vimrc"
6031 and the other initializations, so that when the 'shell' option is set
6032 there, the 'shellredir' option changes automatically unless it was
6033 explicitly set before.
6034 In the future pipes may be used for filtering and this option will
6035 become obsolete (at least for Unix).
6036 This option cannot be set from a |modeline| or in the |sandbox|, for
6037 security reasons.
6038
6039 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6040'shellslash' 'ssl' boolean (default off)
6041 global
6042 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6043 When set, a forward slash is used when expanding file names. This is
6044 useful when a Unix-like shell is used instead of command.com or
6045 cmd.exe. Backward slashes can still be typed, but they are changed to
6046 forward slashes by Vim.
6047 Note that setting or resetting this option has no effect for some
6048 existing file names, thus this option needs to be set before opening
6049 any file for best results. This might change in the future.
6050 'shellslash' only works when a backslash can be used as a path
6051 separator. To test if this is so use: >
6052 if exists('+shellslash')
6053<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006054 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6055'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6056 global
6057 {not in Vi}
6058 When on, use temp files for shell commands. When off use a pipe.
6059 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006060 Currently a pipe is only supported on Unix and MS-Windows 2K and
6061 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006062 :if has("filterpipe")
6063< The advantage of using a pipe is that nobody can read the temp file
6064 and the 'shell' command does not need to support redirection.
6065 The advantage of using a temp file is that the file type and encoding
6066 can be detected.
6067 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6068 |FilterWritePost| autocommands event are not triggered when
6069 'shelltemp' is off.
6070
Bram Moolenaar071d4272004-06-13 20:20:40 +00006071 *'shelltype'* *'st'*
6072'shelltype' 'st' number (default 0)
6073 global
6074 {not in Vi} {only for the Amiga}
6075 On the Amiga this option influences the way how the commands work
6076 which use a shell.
6077 0 and 1: always use the shell
6078 2 and 3: use the shell only to filter lines
6079 4 and 5: use shell only for ':sh' command
6080 When not using the shell, the command is executed directly.
6081
6082 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6083 1 and 3: use "shell cmd" to start external commands
6084
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006085 *'shellxescape'* *'sxe'*
6086'shellxescape' 'sxe' string (default: "";
6087 for MS-DOS and MS-Windows: "\"&|<>()@^")
6088 global
6089 {not in Vi}
6090 When 'shellxquote' is set to "(" then the characters listed in this
6091 option will be escaped with a '^' character. This makes it possible
6092 to execute most external commands with cmd.exe.
6093
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 *'shellxquote'* *'sxq'*
6095'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006096 for Win32, when 'shell' is cmd.exe: "("
6097 for Win32, when 'shell' contains "sh"
6098 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 for Unix, when using system(): "\"")
6100 global
6101 {not in Vi}
6102 Quoting character(s), put around the command passed to the shell, for
6103 the "!" and ":!" commands. Includes the redirection. See
6104 'shellquote' to exclude the redirection. It's probably not useful
6105 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006106 When the value is '(' then ')' is appended. When the value is '"('
6107 then ')"' is appended.
6108 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006109 This is an empty string by default on most systems, but is known to be
6110 useful for on Win32 version, either for cmd.exe which automatically
6111 strips off the first and last quote on a command, or 3rd-party shells
6112 such as the MKS Korn Shell or bash, where it should be "\"". The
6113 default is adjusted according the value of 'shell', to reduce the need
6114 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 This option cannot be set from a |modeline| or in the |sandbox|, for
6116 security reasons.
6117
6118 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6119'shiftround' 'sr' boolean (default off)
6120 global
6121 {not in Vi}
6122 Round indent to multiple of 'shiftwidth'. Applies to > and <
6123 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6124 a multiple of 'shiftwidth' (this is Vi compatible).
6125 NOTE: This option is reset when 'compatible' is set.
6126
6127 *'shiftwidth'* *'sw'*
6128'shiftwidth' 'sw' number (default 8)
6129 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006130 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006131 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006132 When zero the 'ts' value will be used. Use the |shiftwidth()|
6133 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134
6135 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006136'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6137 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006138 global
6139 {not in Vi}
6140 This option helps to avoid all the |hit-enter| prompts caused by file
6141 messages, for example with CTRL-G, and to avoid some other messages.
6142 It is a list of flags:
6143 flag meaning when present ~
6144 f use "(3 of 5)" instead of "(file 3 of 5)"
6145 i use "[noeol]" instead of "[Incomplete last line]"
6146 l use "999L, 888C" instead of "999 lines, 888 characters"
6147 m use "[+]" instead of "[Modified]"
6148 n use "[New]" instead of "[New File]"
6149 r use "[RO]" instead of "[readonly]"
6150 w use "[w]" instead of "written" for file write message
6151 and "[a]" instead of "appended" for ':w >> file' command
6152 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6153 "[unix format]" and "[mac]" instead of "[mac format]".
6154 a all of the above abbreviations
6155
6156 o overwrite message for writing a file with subsequent message
6157 for reading a file (useful for ":wn" or when 'autowrite' on)
6158 O message for reading a file overwrites any previous message.
6159 Also for quickfix message (e.g., ":cn").
6160 s don't give "search hit BOTTOM, continuing at TOP" or "search
6161 hit TOP, continuing at BOTTOM" messages
6162 t truncate file message at the start if it is too long to fit
6163 on the command-line, "<" will appear in the left most column.
6164 Ignored in Ex mode.
6165 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006166 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 Ignored in Ex mode.
6168 W don't give "written" or "[w]" when writing a file
6169 A don't give the "ATTENTION" message when an existing swap file
6170 is found.
6171 I don't give the intro message when starting Vim |:intro|.
6172
6173 This gives you the opportunity to avoid that a change between buffers
6174 requires you to hit <Enter>, but still gives as useful a message as
6175 possible for the space available. To get the whole message that you
6176 would have got with 'shm' empty, use ":file!"
6177 Useful values:
6178 shm= No abbreviation of message.
6179 shm=a Abbreviation, but no loss of information.
6180 shm=at Abbreviation, and truncate message when necessary.
6181
6182 NOTE: This option is set to the Vi default value when 'compatible' is
6183 set and to the Vim default value when 'compatible' is reset.
6184
6185 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6186'shortname' 'sn' boolean (default off)
6187 local to buffer
6188 {not in Vi, not in MS-DOS versions}
6189 Filenames are assumed to be 8 characters plus one extension of 3
6190 characters. Multiple dots in file names are not allowed. When this
6191 option is on, dots in file names are replaced with underscores when
6192 adding an extension (".~" or ".swp"). This option is not available
6193 for MS-DOS, because then it would always be on. This option is useful
6194 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6195 or crossdos. When running the Win32 GUI version under Win32s, this
6196 option is always on by default.
6197
6198 *'showbreak'* *'sbr'* *E595*
6199'showbreak' 'sbr' string (default "")
6200 global
6201 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006202 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006203 feature}
6204 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006205 values are "> " or "+++ ": >
6206 :set showbreak=>\
6207< Note the backslash to escape the trailing space. It's easier like
6208 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006209 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006210< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 comma (in a future version the comma might be used to separate the
6212 part that is shown at the end and at the start of a line).
6213 The characters are highlighted according to the '@' flag in
6214 'highlight'.
6215 Note that tabs after the showbreak will be displayed differently.
6216 If you want the 'showbreak' to appear in between line numbers, add the
6217 "n" flag to 'cpoptions'.
6218
6219 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6220'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6221 off)
6222 global
6223 {not in Vi}
6224 {not available when compiled without the
6225 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006226 Show (partial) command in the last line of the screen. Set this
6227 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006228 In Visual mode the size of the selected area is shown:
6229 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006230 If the number of bytes is different it is also displayed: "2-6"
6231 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006233 - When selecting a block, the size in screen characters:
6234 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 NOTE: This option is set to the Vi default value when 'compatible' is
6236 set and to the Vim default value when 'compatible' is reset.
6237
6238 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6239'showfulltag' 'sft' boolean (default off)
6240 global
6241 {not in Vi}
6242 When completing a word in insert mode (see |ins-completion|) from the
6243 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006244 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 matched a C function, you can see a template for what arguments are
6246 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006247 Note that this doesn't work well together with having "longest" in
6248 'completeopt', because the completion from the search pattern may not
6249 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250
6251 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6252'showmatch' 'sm' boolean (default off)
6253 global
6254 When a bracket is inserted, briefly jump to the matching one. The
6255 jump is only done if the match can be seen on the screen. The time to
6256 show the match can be set with 'matchtime'.
6257 A Beep is given if there is no match (no matter if the match can be
6258 seen or not). This option is reset when the 'paste' option is set.
6259 When the 'm' flag is not included in 'cpoptions', typing a character
6260 will immediately move the cursor back to where it belongs.
6261 See the "sm" field in 'guicursor' for setting the cursor shape and
6262 blinking when showing the match.
6263 The 'matchpairs' option can be used to specify the characters to show
6264 matches for. 'rightleft' and 'revins' are used to look for opposite
6265 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006266 Also see the matchparen plugin for highlighting the match when moving
6267 around |pi_paren.txt|.
6268 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269
6270 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6271'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6272 global
6273 If in Insert, Replace or Visual mode put a message on the last line.
6274 Use the 'M' flag in 'highlight' to set the type of highlighting for
6275 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006276 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006277 doesn't mean XIM is really active, especially when 'imactivatekey' is
6278 not set.
6279 NOTE: This option is set to the Vi default value when 'compatible' is
6280 set and to the Vim default value when 'compatible' is reset.
6281
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006282 *'showtabline'* *'stal'*
6283'showtabline' 'stal' number (default 1)
6284 global
6285 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006286 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006287 feature}
6288 The value of this option specifies when the line with tab page labels
6289 will be displayed:
6290 0: never
6291 1: only if there are at least two tab pages
6292 2: always
6293 This is both for the GUI and non-GUI implementation of the tab pages
6294 line.
6295 See |tab-page| for more information about tab pages.
6296
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 *'sidescroll'* *'ss'*
6298'sidescroll' 'ss' number (default 0)
6299 global
6300 {not in Vi}
6301 The minimal number of columns to scroll horizontally. Used only when
6302 the 'wrap' option is off and the cursor is moved off of the screen.
6303 When it is zero the cursor will be put in the middle of the screen.
6304 When using a slow terminal set it to a large number or 0. When using
6305 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6306 commands.
6307
6308 *'sidescrolloff'* *'siso'*
6309'sidescrolloff' 'siso' number (default 0)
6310 global
6311 {not in Vi}
6312 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006313 right of the cursor if 'nowrap' is set. Setting this option to a
6314 value greater than 0 while having |'sidescroll'| also at a non-zero
6315 value makes some context visible in the line you are scrolling in
6316 horizontally (except at beginning of the line). Setting this option
6317 to a large value (like 999) has the effect of keeping the cursor
6318 horizontally centered in the window, as long as one does not come too
6319 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 NOTE: This option is set to 0 when 'compatible' is set.
6321
6322 Example: Try this together with 'sidescroll' and 'listchars' as
6323 in the following example to never allow the cursor to move
6324 onto the "extends" character:
6325
6326 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6327 :set sidescrolloff=1
6328
6329
6330 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6331'smartcase' 'scs' boolean (default off)
6332 global
6333 {not in Vi}
6334 Override the 'ignorecase' option if the search pattern contains upper
6335 case characters. Only used when the search pattern is typed and
6336 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006337 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6339 recalling the search pattern from history and hitting <Enter>.
6340 NOTE: This option is reset when 'compatible' is set.
6341
6342 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6343'smartindent' 'si' boolean (default off)
6344 local to buffer
6345 {not in Vi}
6346 {not available when compiled without the
6347 |+smartindent| feature}
6348 Do smart autoindenting when starting a new line. Works for C-like
6349 programs, but can also be used for other languages. 'cindent' does
6350 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006351 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006352 setting 'si' has no effect. 'indentexpr' is a more advanced
6353 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 Normally 'autoindent' should also be on when using 'smartindent'.
6355 An indent is automatically inserted:
6356 - After a line ending in '{'.
6357 - After a line starting with a keyword from 'cinwords'.
6358 - Before a line starting with '}' (only with the "O" command).
6359 When typing '}' as the first character in a new line, that line is
6360 given the same indent as the matching '{'.
6361 When typing '#' as the first character in a new line, the indent for
6362 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006363 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6365 When using the ">>" command, lines starting with '#' are not shifted
6366 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006367 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006368 is set smart indenting is disabled.
6369
6370 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6371'smarttab' 'sta' boolean (default off)
6372 global
6373 {not in Vi}
6374 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006375 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6376 <BS> will delete a 'shiftwidth' worth of space at the start of the
6377 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006378 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006379 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6380 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006381 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006383 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 NOTE: This option is reset when 'compatible' is set.
6385
6386 *'softtabstop'* *'sts'*
6387'softtabstop' 'sts' number (default 0)
6388 local to buffer
6389 {not in Vi}
6390 Number of spaces that a <Tab> counts for while performing editing
6391 operations, like inserting a <Tab> or using <BS>. It "feels" like
6392 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6393 used. This is useful to keep the 'ts' setting at its standard value
6394 of 8, while being able to edit like it is set to 'sts'. However,
6395 commands like "x" still work on the actual characters.
6396 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006397 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 'softtabstop' is set to 0 when the 'paste' option is set.
6399 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6400 spaces is minimized by using <Tab>s.
6401 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6402 set.
6403 NOTE: This option is set to 0 when 'compatible' is set.
6404
Bram Moolenaar217ad922005-03-20 22:37:15 +00006405 *'spell'* *'nospell'*
6406'spell' boolean (default off)
6407 local to window
6408 {not in Vi}
6409 {not available when compiled without the |+syntax|
6410 feature}
6411 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006412 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006413
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006414 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006415'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006416 local to buffer
6417 {not in Vi}
6418 {not available when compiled without the |+syntax|
6419 feature}
6420 Pattern to locate the end of a sentence. The following word will be
6421 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006422 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006423 When this check is not wanted make this option empty.
6424 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006425 Be careful with special characters, see |option-backslash| about
6426 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006427 To set this option automatically depending on the language, see
6428 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006429
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006430 *'spellfile'* *'spf'*
6431'spellfile' 'spf' string (default empty)
6432 local to buffer
6433 {not in Vi}
6434 {not available when compiled without the |+syntax|
6435 feature}
6436 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006437 commands. It must end in ".{encoding}.add". You need to include the
6438 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006439 *E765*
6440 It may also be a comma separated list of names. A count before the
6441 |zg| and |zw| commands can be used to access each. This allows using
6442 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006443 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006444 you: Using the first directory in 'runtimepath' that is writable. If
6445 there is no "spell" directory yet it will be created. For the file
6446 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006447 ignoring the region.
6448 The resulting ".spl" file will be used for spell checking, it does not
6449 have to appear in 'spelllang'.
6450 Normally one file is used for all regions, but you can add the region
6451 name if you want to. However, it will then only be used when
6452 'spellfile' is set to it, for entries in 'spelllang' only files
6453 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006454 This option cannot be set from a |modeline| or in the |sandbox|, for
6455 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006456
Bram Moolenaar217ad922005-03-20 22:37:15 +00006457 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006458'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006459 local to buffer
6460 {not in Vi}
6461 {not available when compiled without the |+syntax|
6462 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006463 A comma separated list of word list names. When the 'spell' option is
6464 on spellchecking will be done for these languages. Example: >
6465 set spelllang=en_us,nl,medical
6466< This means US English, Dutch and medical words are recognized. Words
6467 that are not recognized will be highlighted.
6468 The word list name must not include a comma or dot. Using a dash is
6469 recommended to separate the two letter language name from a
6470 specification. Thus "en-rare" is used for rare English words.
6471 A region name must come last and have the form "_xx", where "xx" is
6472 the two-letter, lower case region name. You can use more than one
6473 region by listing them: "en_us,en_ca" supports both US and Canadian
6474 English, but not words specific for Australia, New Zealand or Great
6475 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006476 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006477 As a special case the name of a .spl file can be given as-is. The
6478 first "_xx" in the name is removed and used as the region name
6479 (_xx is an underscore, two letters and followed by a non-letter).
6480 This is mainly for testing purposes. You must make sure the correct
6481 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006482 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006483 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6484 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006485 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006486
Bram Moolenaar98692072006-02-04 00:57:42 +00006487 If the |spellfile.vim| plugin is active and you use a language name
6488 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6489 will ask you if you want to download the file.
6490
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006491 After this option has been set successfully, Vim will source the files
6492 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006493 up to the first comma, dot or underscore.
6494 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006495
6496
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006497 *'spellsuggest'* *'sps'*
6498'spellsuggest' 'sps' string (default "best")
6499 global
6500 {not in Vi}
6501 {not available when compiled without the |+syntax|
6502 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006503 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006504 the |spellsuggest()| function. This is a comma-separated list of
6505 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006506
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006507 best Internal method that works best for English. Finds
6508 changes like "fast" and uses a bit of sound-a-like
6509 scoring to improve the ordering.
6510
6511 double Internal method that uses two methods and mixes the
6512 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006513 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006514 word. That only works when the language specifies
6515 sound folding. Can be slow and doesn't always give
6516 better results.
6517
6518 fast Internal method that only checks for simple changes:
6519 character inserts/deletes/swaps. Works well for
6520 simple typing mistakes.
6521
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006522 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006523 Not used for |spellsuggest()|. The number of
6524 suggestions is never more than the value of 'lines'
6525 minus two.
6526
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006527 file:{filename} Read file {filename}, which must have two columns,
6528 separated by a slash. The first column contains the
6529 bad word, the second column the suggested good word.
6530 Example:
6531 theribal/terrible ~
6532 Use this for common mistakes that do not appear at the
6533 top of the suggestion list with the internal methods.
6534 Lines without a slash are ignored, use this for
6535 comments.
6536 The file is used for all languages.
6537
6538 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6539 trouble with spaces. |v:val| holds the badly spelled
6540 word. The expression must evaluate to a List of
6541 Lists, each with a suggestion and a score.
6542 Example:
6543 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006544 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006545 internal methods use. A lower score is better.
6546 This may invoke |spellsuggest()| if you temporarily
6547 set 'spellsuggest' to exclude the "expr:" part.
6548 Errors are silently ignored, unless you set the
6549 'verbose' option to a non-zero value.
6550
6551 Only one of "best", "double" or "fast" may be used. The others may
6552 appear several times in any order. Example: >
6553 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6554<
6555 This option cannot be set from a |modeline| or in the |sandbox|, for
6556 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006557
6558
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6560'splitbelow' 'sb' boolean (default off)
6561 global
6562 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006563 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 feature}
6565 When on, splitting a window will put the new window below the current
6566 one. |:split|
6567
6568 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6569'splitright' 'spr' boolean (default off)
6570 global
6571 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006572 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 feature}
6574 When on, splitting a window will put the new window right of the
6575 current one. |:vsplit|
6576
6577 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6578'startofline' 'sol' boolean (default on)
6579 global
6580 {not in Vi}
6581 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006582 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006583 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006584 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 with a linewise operator, with "%" with a count and to buffer changing
6586 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6587 only has a line number, e.g., ":25" or ":+".
6588 In case of buffer changing commands the cursor is placed at the column
6589 where it was the last time the buffer was edited.
6590 NOTE: This option is set when 'compatible' is set.
6591
Bram Moolenaar00654022011-02-25 14:42:19 +01006592 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006594 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 {not in Vi}
6596 {not available when compiled without the |+statusline|
6597 feature}
6598 When nonempty, this option determines the content of the status line.
6599 Also see |status-line|.
6600
6601 The option consists of printf style '%' items interspersed with
6602 normal text. Each status line item is of the form:
6603 %-0{minwid}.{maxwid}{item}
6604 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006605 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606
Bram Moolenaar238a5642006-02-21 22:12:05 +00006607 When the option starts with "%!" then it is used as an expression,
6608 evaluated and the result is used as the option value. Example: >
6609 :set statusline=%!MyStatusLine()
6610< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006611 Note that the "%!" expression is evaluated in the context of the
6612 current window and buffer, while %{} items are evaluated in the
6613 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006614
6615 When there is error while evaluating the option then it will be made
6616 empty to avoid further errors. Otherwise screen updating would loop.
6617
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 Note that the only effect of 'ruler' when this option is set (and
6619 'laststatus' is 2) is controlling the output of |CTRL-G|.
6620
6621 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006622 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006624 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 minwid Minimum width of the item, padding as set by '-' & '0'.
6626 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006627 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 on the left for text items. Numeric items will be
6629 shifted down to maxwid-2 digits followed by '>'number
6630 where number is the amount of missing digits, much like
6631 an exponential notation.
6632 item A one letter code as described below.
6633
6634 Following is a description of the possible statusline items. The
6635 second character in "item" is the type:
6636 N for number
6637 S for string
6638 F for flags as described below
6639 - not applicable
6640
6641 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006642 f S Path to the file in the buffer, as typed or relative to current
6643 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 F S Full path to the file in the buffer.
6645 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006646 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006648 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006650 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006652 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006654 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6656 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006657 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6659 being used: "<keymap>"
6660 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006661 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 B N As above, in hexadecimal.
6663 o N Byte number in file of byte under cursor, first byte is 1.
6664 Mnemonic: Offset from start of file (with one added)
6665 {not available when compiled without |+byte_offset| feature}
6666 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006667 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 l N Line number.
6669 L N Number of lines in buffer.
6670 c N Column number.
6671 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006672 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006673 p N Percentage through file in lines as in |CTRL-G|.
6674 P S Percentage through file of displayed window. This is like the
6675 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006676 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006677 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006678 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006679 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 ( - Start of item group. Can be used for setting the width and
6681 alignment of a section. Must be followed by %) somewhere.
6682 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006683 T N For 'tabline': start of tab page N label. Use %T after the last
6684 label. This information is used for mouse clicks.
6685 X N For 'tabline': start of close tab N label. Use %X after the
6686 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6687 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 < - Where to truncate line if too long. Default is at the start.
6689 No width fields allowed.
6690 = - Separation point between left and right aligned items.
6691 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006692 # - Set highlight group. The name must follow and then a # again.
6693 Thus use %#HLname# for highlight group HLname. The same
6694 highlighting is used, also for the statusline of non-current
6695 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006697 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698 The difference between User{N} and StatusLine will be applied
6699 to StatusLineNC for the statusline of non-current windows.
6700 The number N must be between 1 and 9. See |hl-User1..9|
6701
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006702 When displaying a flag, Vim removes the leading comma, if any, when
6703 that flag comes right after plaintext. This will make a nice display
6704 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006705
Bram Moolenaar582fd852005-03-28 20:58:01 +00006706 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006707 not set) and a minwid is not set for the group, the whole group will
6708 become empty. This will make a group like the following disappear
6709 completely from the statusline when none of the flags are set. >
6710 :set statusline=...%(\ [%M%R%H]%)...
6711<
6712 Beware that an expression is evaluated each and every time the status
6713 line is displayed. The current buffer and current window will be set
6714 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006715 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006717 real current buffer.
6718
Bram Moolenaar30b65812012-07-12 22:01:11 +02006719 The 'statusline' option will be evaluated in the |sandbox| if set from
6720 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006721
6722 It is not allowed to change text or jump to another window while
6723 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006724
6725 If the statusline is not updated when you want it (e.g., after setting
6726 a variable that's used in an expression), you can force an update by
6727 setting an option without changing its value. Example: >
6728 :let &ro = &ro
6729
6730< A result of all digits is regarded a number for display purposes.
6731 Otherwise the result is taken as flag text and applied to the rules
6732 described above.
6733
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006734 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6736 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6737
6738 Examples:
6739 Emulate standard status line with 'ruler' set >
6740 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6741< Similar, but add ASCII value of char under the cursor (like "ga") >
6742 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6743< Display byte count and byte value, modified flag in red. >
6744 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6745 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6746< Display a ,GZ flag if a compressed file is loaded >
6747 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6748< In the |:autocmd|'s: >
6749 :let b:gzflag = 1
6750< And: >
6751 :unlet b:gzflag
6752< And define this function: >
6753 :function VarExists(var, val)
6754 : if exists(a:var) | return a:val | else | return '' | endif
6755 :endfunction
6756<
6757 *'suffixes'* *'su'*
6758'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6759 global
6760 {not in Vi}
6761 Files with these suffixes get a lower priority when multiple files
6762 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006763 suffixes. Spaces after the comma are ignored. A dot is also seen as
6764 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006765 separator, precede it with a backslash (see |option-backslash| about
6766 including spaces and backslashes).
6767 See 'wildignore' for completely ignoring files.
6768 The use of |:set+=| and |:set-=| is preferred when adding or removing
6769 suffixes from the list. This avoids problems when a future version
6770 uses another default.
6771
6772 *'suffixesadd'* *'sua'*
6773'suffixesadd' 'sua' string (default "")
6774 local to buffer
6775 {not in Vi}
6776 {not available when compiled without the
6777 |+file_in_path| feature}
6778 Comma separated list of suffixes, which are used when searching for a
6779 file for the "gf", "[I", etc. commands. Example: >
6780 :set suffixesadd=.java
6781<
6782 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6783'swapfile' 'swf' boolean (default on)
6784 local to buffer
6785 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006786 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 swapfile is not wanted for a specific buffer. For example, with
6788 confidential information that even root must not be able to access.
6789 Careful: All text will be in memory:
6790 - Don't use this for big files.
6791 - Recovery will be impossible!
6792 A swapfile will only be present when |'updatecount'| is non-zero and
6793 'swapfile' is set.
6794 When 'swapfile' is reset, the swap file for the current buffer is
6795 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6796 non-zero, a swap file is immediately created.
6797 Also see |swap-file| and |'swapsync'|.
6798
6799 This option is used together with 'bufhidden' and 'buftype' to
6800 specify special kinds of buffers. See |special-buffers|.
6801
6802 *'swapsync'* *'sws'*
6803'swapsync' 'sws' string (default "fsync")
6804 global
6805 {not in Vi}
6806 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006807 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 When this option is empty parts of the swap file may be in memory and
6809 not written to disk. When the system crashes you may lose more work.
6810 On Unix the system does a sync now and then without Vim asking for it,
6811 so the disadvantage of setting this option off is small. On some
6812 systems the swap file will not be written at all. For a unix system
6813 setting it to "sync" will use the sync() call instead of the default
6814 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006815 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006816
6817 *'switchbuf'* *'swb'*
6818'switchbuf' 'swb' string (default "")
6819 global
6820 {not in Vi}
6821 This option controls the behavior when switching between buffers.
6822 Possible values (comma separated list):
6823 useopen If included, jump to the first open window that
6824 contains the specified buffer (if there is one).
6825 Otherwise: Do not examine other windows.
6826 This setting is checked with |quickfix| commands, when
6827 jumping to errors (":cc", ":cn", "cp", etc.). It is
6828 also used in all buffer related split commands, for
6829 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006830 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006831 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006833 a buffer for a |quickfix| command that display errors.
6834 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006835 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006836 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006837
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006838 *'synmaxcol'* *'smc'*
6839'synmaxcol' 'smc' number (default 3000)
6840 local to buffer
6841 {not in Vi}
6842 {not available when compiled without the |+syntax|
6843 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006844 Maximum column in which to search for syntax items. In long lines the
6845 text after this column is not highlighted and following lines may not
6846 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006847 This helps to avoid very slow redrawing for an XML file that is one
6848 long line.
6849 Set to zero to remove the limit.
6850
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 *'syntax'* *'syn'*
6852'syntax' 'syn' string (default empty)
6853 local to buffer
6854 {not in Vi}
6855 {not available when compiled without the |+syntax|
6856 feature}
6857 When this option is set, the syntax with this name is loaded, unless
6858 syntax highlighting has been switched off with ":syntax off".
6859 Otherwise this option does not always reflect the current syntax (the
6860 b:current_syntax variable does).
6861 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006862 not automatically recognized. Example, in an IDL file:
6863 /* vim: set syntax=idl : */ ~
6864 When a dot appears in the value then this separates two filetype
6865 names. Example:
6866 /* vim: set syntax=c.doxygen : */ ~
6867 This will use the "c" syntax first, then the "doxygen" syntax.
6868 Note that the second one must be prepared to be loaded as an addition,
6869 otherwise it will be skipped. More than one dot may appear.
6870 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 :set syntax=OFF
6872< To switch syntax highlighting on according to the current value of the
6873 'filetype' option: >
6874 :set syntax=ON
6875< What actually happens when setting the 'syntax' option is that the
6876 Syntax autocommand event is triggered with the value as argument.
6877 This option is not copied to another buffer, independent of the 's' or
6878 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006879 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006881 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006882'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006883 global
6884 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006885 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006886 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006887 When nonempty, this option determines the content of the tab pages
6888 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006889 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006890
6891 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006892 option and only when there is no GUI tab line. When 'e' is in
6893 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006894 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006895
6896 The value is evaluated like with 'statusline'. You can use
6897 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006898 the text to be displayed. Use "%1T" for the first label, "%2T" for
6899 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006900
6901 Keep in mind that only one of the tab pages is the current one, others
6902 are invisible and you can't jump to their windows.
6903
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006904
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006905 *'tabpagemax'* *'tpm'*
6906'tabpagemax' 'tpm' number (default 10)
6907 global
6908 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006909 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006910 feature}
6911 Maximum number of tab pages to be opened by the |-p| command line
6912 argument or the ":tab all" command. |tabpage|
6913
6914
6915 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006916'tabstop' 'ts' number (default 8)
6917 local to buffer
6918 Number of spaces that a <Tab> in the file counts for. Also see
6919 |:retab| command, and 'softtabstop' option.
6920
6921 Note: Setting 'tabstop' to any other value than 8 can make your file
6922 appear wrong in many places (e.g., when printing it).
6923
6924 There are four main ways to use tabs in Vim:
6925 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6926 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006927 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 behave like a tab appears every 4 (or 3) characters.
6929 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6930 'expandtab'. This way you will always insert spaces. The
6931 formatting will never be messed up when 'tabstop' is changed.
6932 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006933 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 works when using Vim to edit the file.
6935 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6936 'noexpandtab'. This should then work (for initial indents only)
6937 for any tabstop setting that people use. It might be nice to have
6938 tabs after the first non-blank inserted as spaces if you do this
6939 though. Otherwise aligned comments will be wrong when 'tabstop' is
6940 changed.
6941
6942 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6943'tagbsearch' 'tbs' boolean (default on)
6944 global
6945 {not in Vi}
6946 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006947 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 searching makes searching for a tag a LOT faster, but a linear search
6949 will find more tags if the tags file wasn't properly sorted.
6950 Vim normally assumes that your tags files are sorted, or indicate that
6951 they are not sorted. Only when this is not the case does the
6952 'tagbsearch' option need to be switched off.
6953
6954 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006955 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 certain files, or retry all files with a linear search. When
6957 'tagbsearch' is off, only a linear search is done.
6958
6959 Linear searching is done anyway, for one file, when Vim finds a line
6960 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006961 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962< [The whitespace before and after the '0' must be a single <Tab>]
6963
6964 When a binary search was done and no match was found in any of the
6965 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6966 instead of a normal tag name, a retry is done with a linear search.
6967 Tags in unsorted tags files, and matches with different case will only
6968 be found in the retry.
6969
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006970 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 linear search can be avoided for the 'ignorecase' case. Use a value
6972 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6973 case-fold sorted with the -f switch to "sort" in most unices, as in
6974 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006975 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6976 for this as well. Note that case must be folded to uppercase for this
6977 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006978
6979 When 'tagbsearch' is off, tags searching is slower when a full match
6980 exists, but faster when no full match exists. Tags in unsorted tags
6981 files may only be found with 'tagbsearch' off.
6982 When the tags file is not sorted, or sorted in a wrong way (not on
6983 ASCII byte value), 'tagbsearch' should be off, or the line given above
6984 must be included in the tags file.
6985 This option doesn't affect commands that find all matching tags (e.g.,
6986 command-line completion and ":help").
6987 {Vi: always uses binary search in some versions}
6988
6989 *'taglength'* *'tl'*
6990'taglength' 'tl' number (default 0)
6991 global
6992 If non-zero, tags are significant up to this number of characters.
6993
6994 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6995'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6996 global
6997 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006998 If on and using a tags file in another directory, file names in that
6999 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007000 NOTE: This option is set to the Vi default value when 'compatible' is
7001 set and to the Vim default value when 'compatible' is reset.
7002
7003 *'tags'* *'tag'* *E433*
7004'tags' 'tag' string (default "./tags,tags", when compiled with
7005 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7006 global or local to buffer |global-local|
7007 Filenames for the tag command, separated by spaces or commas. To
7008 include a space or comma in a file name, precede it with a backslash
7009 (see |option-backslash| about including spaces and backslashes).
7010 When a file name starts with "./", the '.' is replaced with the path
7011 of the current file. But only when the 'd' flag is not included in
7012 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7013 |tags-option|.
7014 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007015 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7016 find all files named "tags" below "/lib". The filename itself cannot
7017 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7018 files called "tags?". {not available when compiled without the
7019 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007020 The |tagfiles()| function can be used to get a list of the file names
7021 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007022 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7023 files are also supported. They are automatically recognized. The
7024 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7025 differences are ignored (MS-Windows). |emacs-tags|
7026 The use of |:set+=| and |:set-=| is preferred when adding or removing
7027 file names from the list. This avoids problems when a future version
7028 uses another default.
7029 {Vi: default is "tags /usr/lib/tags"}
7030
7031 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7032'tagstack' 'tgst' boolean (default on)
7033 global
7034 {not in all versions of Vi}
7035 When on, the |tagstack| is used normally. When off, a ":tag" or
7036 ":tselect" command with an argument will not push the tag onto the
7037 tagstack. A following ":tag" without an argument, a ":pop" command or
7038 any other command that uses the tagstack will use the unmodified
7039 tagstack, but does change the pointer to the active entry.
7040 Resetting this option is useful when using a ":tag" command in a
7041 mapping which should not change the tagstack.
7042
7043 *'term'* *E529* *E530* *E531*
7044'term' string (default is $TERM, if that fails:
7045 in the GUI: "builtin_gui"
7046 on Amiga: "amiga"
7047 on BeOS: "beos-ansi"
7048 on Mac: "mac-ansi"
7049 on MiNT: "vt52"
7050 on MS-DOS: "pcterm"
7051 on OS/2: "os2ansi"
7052 on Unix: "ansi"
7053 on VMS: "ansi"
7054 on Win 32: "win32")
7055 global
7056 Name of the terminal. Used for choosing the terminal control
7057 characters. Environment variables are expanded |:set_env|.
7058 For example: >
7059 :set term=$TERM
7060< See |termcap|.
7061
7062 *'termbidi'* *'tbidi'*
7063 *'notermbidi'* *'notbidi'*
7064'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7065 global
7066 {not in Vi}
7067 {only available when compiled with the |+arabic|
7068 feature}
7069 The terminal is in charge of Bi-directionality of text (as specified
7070 by Unicode). The terminal is also expected to do the required shaping
7071 that some languages (such as Arabic) require.
7072 Setting this option implies that 'rightleft' will not be set when
7073 'arabic' is set and the value of 'arabicshape' will be ignored.
7074 Note that setting 'termbidi' has the immediate effect that
7075 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7076 This option is reset when the GUI is started.
7077 For further details see |arabic.txt|.
7078
7079 *'termencoding'* *'tenc'*
7080'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7081 Macintosh GUI: "macroman")
7082 global
7083 {only available when compiled with the |+multi_byte|
7084 feature}
7085 {not in Vi}
7086 Encoding used for the terminal. This specifies what character
7087 encoding the keyboard produces and the display will understand. For
7088 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007089 display). Except for the Mac when 'macatsui' is off, then
7090 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007091 In the Win32 console version the default value is the console codepage
7092 when it differs from the ANSI codepage.
7093 *E617*
7094 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7095 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7096 Any attempts to set a different value will be rejected, and an error
7097 message is shown.
7098 For the Win32 GUI 'termencoding' is not used for typed characters,
7099 because the Win32 system always passes Unicode characters.
7100 When empty, the same encoding is used as for the 'encoding' option.
7101 This is the normal value.
7102 Not all combinations for 'termencoding' and 'encoding' are valid. See
7103 |encoding-table|.
7104 The value for this option must be supported by internal conversions or
7105 iconv(). When this is not possible no conversion will be done and you
7106 will probably experience problems with non-ASCII characters.
7107 Example: You are working with the locale set to euc-jp (Japanese) and
7108 want to edit a UTF-8 file: >
7109 :let &termencoding = &encoding
7110 :set encoding=utf-8
7111< You need to do this when your system has no locale support for UTF-8.
7112
7113 *'terse'* *'noterse'*
7114'terse' boolean (default off)
7115 global
7116 When set: Add 's' flag to 'shortmess' option (this makes the message
7117 for a search that hits the start or end of the file not being
7118 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7119 shortens a lot of messages}
7120
7121 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7122'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7123 global
7124 {not in Vi}
7125 This option is obsolete. Use 'fileformats'.
7126 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7127 set to the default value for the current system. When 'textauto' is
7128 reset, 'fileformats' is made empty.
7129 NOTE: This option is set to the Vi default value when 'compatible' is
7130 set and to the Vim default value when 'compatible' is reset.
7131
7132 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7133'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7134 others: default off)
7135 local to buffer
7136 {not in Vi}
7137 This option is obsolete. Use 'fileformat'.
7138 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7139 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7140 "unix".
7141
7142 *'textwidth'* *'tw'*
7143'textwidth' 'tw' number (default 0)
7144 local to buffer
7145 {not in Vi}
7146 Maximum width of text that is being inserted. A longer line will be
7147 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007148 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7149 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007151 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007152 NOTE: This option is set to 0 when 'compatible' is set.
7153
7154 *'thesaurus'* *'tsr'*
7155'thesaurus' 'tsr' string (default "")
7156 global or local to buffer |global-local|
7157 {not in Vi}
7158 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 the file should contain words with similar meaning, separated by
7161 non-keyword characters (white space is preferred). Maximum line
7162 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007163 To obtain a file to be used here, check out this ftp site:
7164 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007165 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 after a comma are ignored, otherwise spaces are included in the file
7167 name. See |option-backslash| about using backslashes.
7168 The use of |:set+=| and |:set-=| is preferred when adding or removing
7169 directories from the list. This avoids problems when a future version
7170 uses another default.
7171 Backticks cannot be used in this option for security reasons.
7172
7173 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7174'tildeop' 'top' boolean (default off)
7175 global
7176 {not in Vi}
7177 When on: The tilde command "~" behaves like an operator.
7178 NOTE: This option is reset when 'compatible' is set.
7179
7180 *'timeout'* *'to'* *'notimeout'* *'noto'*
7181'timeout' 'to' boolean (default on)
7182 global
7183 *'ttimeout'* *'nottimeout'*
7184'ttimeout' boolean (default off)
7185 global
7186 {not in Vi}
7187 These two options together determine the behavior when part of a
7188 mapped key sequence or keyboard code has been received:
7189
7190 'timeout' 'ttimeout' action ~
7191 off off do not time out
7192 on on or off time out on :mappings and key codes
7193 off on time out on key codes
7194
7195 If both options are off, Vim will wait until either the complete
7196 mapping or key sequence has been received, or it is clear that there
7197 is no mapping or key sequence for the received characters. For
7198 example: if you have mapped "vl" and Vim has received 'v', the next
7199 character is needed to see if the 'v' is followed by an 'l'.
7200 When one of the options is on, Vim will wait for about 1 second for
7201 the next character to arrive. After that the already received
7202 characters are interpreted as single characters. The waiting time can
7203 be changed with the 'timeoutlen' option.
7204 On slow terminals or very busy systems timing out may cause
7205 malfunctioning cursor keys. If both options are off, Vim waits
7206 forever after an entered <Esc> if there are key codes that start
7207 with <Esc>. You will have to type <Esc> twice. If you do not have
7208 problems with key codes, but would like to have :mapped key
7209 sequences not timing out in 1 second, set the 'ttimeout' option and
7210 reset the 'timeout' option.
7211
7212 NOTE: 'ttimeout' is reset when 'compatible' is set.
7213
7214 *'timeoutlen'* *'tm'*
7215'timeoutlen' 'tm' number (default 1000)
7216 global
7217 {not in all versions of Vi}
7218 *'ttimeoutlen'* *'ttm'*
7219'ttimeoutlen' 'ttm' number (default -1)
7220 global
7221 {not in Vi}
7222 The time in milliseconds that is waited for a key code or mapped key
7223 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7224 when part of a command has been typed.
7225 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7226 different timeout value for key codes is desired set 'ttimeoutlen' to
7227 a non-negative number.
7228
7229 ttimeoutlen mapping delay key code delay ~
7230 < 0 'timeoutlen' 'timeoutlen'
7231 >= 0 'timeoutlen' 'ttimeoutlen'
7232
7233 The timeout only happens when the 'timeout' and 'ttimeout' options
7234 tell so. A useful setting would be >
7235 :set timeout timeoutlen=3000 ttimeoutlen=100
7236< (time out on mapping after three seconds, time out on key codes after
7237 a tenth of a second).
7238
7239 *'title'* *'notitle'*
7240'title' boolean (default off, on when title can be restored)
7241 global
7242 {not in Vi}
7243 {not available when compiled without the |+title|
7244 feature}
7245 When on, the title of the window will be set to the value of
7246 'titlestring' (if it is not empty), or to:
7247 filename [+=-] (path) - VIM
7248 Where:
7249 filename the name of the file being edited
7250 - indicates the file cannot be modified, 'ma' off
7251 + indicates the file was modified
7252 = indicates the file is read-only
7253 =+ indicates the file is read-only and modified
7254 (path) is the path of the file being edited
7255 - VIM the server name |v:servername| or "VIM"
7256 Only works if the terminal supports setting window titles
7257 (currently Amiga console, Win32 console, all GUI versions and
7258 terminals with a non- empty 't_ts' option - these are Unix xterm and
7259 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7260 *X11*
7261 When Vim was compiled with HAVE_X11 defined, the original title will
7262 be restored if possible. The output of ":version" will include "+X11"
7263 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7264 works for the icon name |'icon'|.
7265 But: When Vim was started with the |-X| argument, restoring the title
7266 will not work (except in the GUI).
7267 If the title cannot be restored, it is set to the value of 'titleold'.
7268 You might want to restore the title outside of Vim then.
7269 When using an xterm from a remote machine you can use this command:
7270 rsh machine_name xterm -display $DISPLAY &
7271 then the WINDOWID environment variable should be inherited and the
7272 title of the window should change back to what it should be after
7273 exiting Vim.
7274
7275 *'titlelen'*
7276'titlelen' number (default 85)
7277 global
7278 {not in Vi}
7279 {not available when compiled without the |+title|
7280 feature}
7281 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007282 title. When the title is longer, only the end of the path name is
7283 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 Using a percentage makes this adapt to the width of the window. But
7285 it won't work perfectly, because the actual number of characters
7286 available also depends on the font used and other things in the title
7287 bar. When 'titlelen' is zero the full path is used. Otherwise,
7288 values from 1 to 30000 percent can be used.
7289 'titlelen' is also used for the 'titlestring' option.
7290
7291 *'titleold'*
7292'titleold' string (default "Thanks for flying Vim")
7293 global
7294 {not in Vi}
7295 {only available when compiled with the |+title|
7296 feature}
7297 This option will be used for the window title when exiting Vim if the
7298 original title cannot be restored. Only happens if 'title' is on or
7299 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007300 This option cannot be set from a |modeline| or in the |sandbox|, for
7301 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 *'titlestring'*
7303'titlestring' string (default "")
7304 global
7305 {not in Vi}
7306 {not available when compiled without the |+title|
7307 feature}
7308 When this option is not empty, it will be used for the title of the
7309 window. This happens only when the 'title' option is on.
7310 Only works if the terminal supports setting window titles (currently
7311 Amiga console, Win32 console, all GUI versions and terminals with a
7312 non-empty 't_ts' option).
7313 When Vim was compiled with HAVE_X11 defined, the original title will
7314 be restored if possible |X11|.
7315 When this option contains printf-style '%' items, they will be
7316 expanded according to the rules used for 'statusline'.
7317 Example: >
7318 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7319 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7320< The value of 'titlelen' is used to align items in the middle or right
7321 of the available space.
7322 Some people prefer to have the file name first: >
7323 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7324< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007325 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 separating space only when needed.
7327 NOTE: Use of special characters in 'titlestring' may cause the display
7328 to be garbled (e.g., when it contains a CR or NL character).
7329 {not available when compiled without the |+statusline| feature}
7330
7331 *'toolbar'* *'tb'*
7332'toolbar' 'tb' string (default "icons,tooltips")
7333 global
7334 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7335 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007336 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 possible values are:
7338 icons Toolbar buttons are shown with icons.
7339 text Toolbar buttons shown with text.
7340 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007341 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 tooltips Tooltips are active for toolbar buttons.
7343 Tooltips refer to the popup help text which appears after the mouse
7344 cursor is placed over a toolbar button for a brief moment.
7345
7346 If you want the toolbar to be shown with icons as well as text, do the
7347 following: >
7348 :set tb=icons,text
7349< Motif and Athena cannot display icons and text at the same time. They
7350 will show icons if both are requested.
7351
7352 If none of the strings specified in 'toolbar' are valid or if
7353 'toolbar' is empty, this option is ignored. If you want to disable
7354 the toolbar, you need to set the 'guioptions' option. For example: >
7355 :set guioptions-=T
7356< Also see |gui-toolbar|.
7357
7358 *'toolbariconsize'* *'tbis'*
7359'toolbariconsize' 'tbis' string (default "small")
7360 global
7361 {not in Vi}
7362 {only in the GTK+ 2 GUI}
7363 Controls the size of toolbar icons. The possible values are:
7364 tiny Use tiny toolbar icons.
7365 small Use small toolbar icons (default).
7366 medium Use medium-sized toolbar icons.
7367 large Use large toolbar icons.
7368 The exact dimensions in pixels of the various icon sizes depend on
7369 the current theme. Common dimensions are large=32x32, medium=24x24,
7370 small=20x20 and tiny=16x16.
7371
7372 If 'toolbariconsize' is empty, the global default size as determined
7373 by user preferences or the current theme is used.
7374
7375 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7376'ttybuiltin' 'tbi' boolean (default on)
7377 global
7378 {not in Vi}
7379 When on, the builtin termcaps are searched before the external ones.
7380 When off the builtin termcaps are searched after the external ones.
7381 When this option is changed, you should set the 'term' option next for
7382 the change to take effect, for example: >
7383 :set notbi term=$TERM
7384< See also |termcap|.
7385 Rationale: The default for this option is "on", because the builtin
7386 termcap entries are generally better (many systems contain faulty
7387 xterm entries...).
7388
7389 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7390'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7391 sun-cmd, screen, rxvt, dtterm or
7392 iris-ansi; also on when running Vim in
7393 a DOS console)
7394 global
7395 {not in Vi}
7396 Indicates a fast terminal connection. More characters will be sent to
7397 the screen for redrawing, instead of using insert/delete line
7398 commands. Improves smoothness of redrawing when there are multiple
7399 windows and the terminal does not support a scrolling region.
7400 Also enables the extra writing of characters at the end of each screen
7401 line for lines that wrap. This helps when using copy/paste with the
7402 mouse in an xterm and other terminals.
7403
7404 *'ttymouse'* *'ttym'*
7405'ttymouse' 'ttym' string (default depends on 'term')
7406 global
7407 {not in Vi}
7408 {only in Unix and VMS, doesn't work in the GUI; not
7409 available when compiled without |+mouse|}
7410 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007411 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 *xterm-mouse*
7413 xterm xterm-like mouse handling. The mouse generates
7414 "<Esc>[Mscr", where "scr" is three bytes:
7415 "s" = button state
7416 "c" = column plus 33
7417 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007418 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007419 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007420 xterm2 Works like "xterm", but with the xterm reporting the
7421 mouse position while the mouse is dragged. This works
7422 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007423 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 work. See below for how Vim detects this
7425 automatically.
7426 *netterm-mouse*
7427 netterm NetTerm mouse handling. The mouse generates
7428 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7429 for the row and column.
7430 *dec-mouse*
7431 dec DEC terminal mouse handling. The mouse generates a
7432 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007433 This is also available for an Xterm, if it was
7434 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *jsbterm-mouse*
7436 jsbterm JSB term mouse handling.
7437 *pterm-mouse*
7438 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007439 *urxvt-mouse*
7440 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar9b451252012-08-15 17:43:31 +02007441 *sgr-mouse*
7442 sgr Mouse handling for the terminal that emits SGR-styled
7443 mouse reporting. Works with xterm version 277 or
7444 later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007445
7446 The mouse handling must be enabled at compile time |+mouse_xterm|
7447 |+mouse_dec| |+mouse_netterm|.
7448 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7449 recognized, if enabled at compile time. DEC terminal mouse codes
7450 are recognized if enabled at compile time, and 'ttymouse' is not
7451 "xterm" (because the xterm and dec mouse codes conflict).
7452 This option is automatically set to "xterm", when the 'term' option is
7453 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7454 or "xterm2" already. The main use of this option is to set it to
7455 "xterm", when the terminal name doesn't start with "xterm", but it can
7456 handle xterm mouse codes.
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02007457 The "sgr" value will be set if the xterm version is 277 or later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007459 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 feature and if |t_RV| is set to the escape sequence to request the
7461 xterm version number. Otherwise "xterm2" must be set explicitly.
7462 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7463 t_RV to an empty string: >
7464 :set t_RV=
7465<
7466 *'ttyscroll'* *'tsl'*
7467'ttyscroll' 'tsl' number (default 999)
7468 global
7469 Maximum number of lines to scroll the screen. If there are more lines
7470 to scroll the window is redrawn. For terminals where scrolling is
7471 very slow and redrawing is not slow this can be set to a small number,
7472 e.g., 3, to speed up displaying.
7473
7474 *'ttytype'* *'tty'*
7475'ttytype' 'tty' string (default from $TERM)
7476 global
7477 Alias for 'term', see above.
7478
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007479 *'undodir'* *'udir'*
7480'undodir' 'udir' string (default ".")
7481 global
7482 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007483 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007484 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007485 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007486 "." means using the directory of the file. The undo file name for
7487 "file.txt" is ".file.txt.un~".
7488 For other directories the file name is the full path of the edited
7489 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007490 When writing: The first directory that exists is used. "." always
7491 works, no directories after "." will be used for writing.
7492 When reading all entries are tried to find an undo file. The first
7493 undo file that exists is used. When it cannot be read an error is
7494 given, no further entry is used.
7495 See |undo-persistence|.
7496
7497 *'undofile'* *'udf'*
7498'undofile' 'udf' boolean (default off)
7499 local to buffer
7500 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007501 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007502 When on, Vim automatically saves undo history to an undo file when
7503 writing a buffer to a file, and restores undo history from the same
7504 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007505 The directory where the undo file is stored is specified by 'undodir'.
7506 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007507 The undo file is not read when 'undoreload' causes the buffer from
7508 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007509 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007510
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 *'undolevels'* *'ul'*
7512'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7513 Win32 and OS/2)
7514 global
7515 {not in Vi}
7516 Maximum number of changes that can be undone. Since undo information
7517 is kept in memory, higher numbers will cause more memory to be used
7518 (nevertheless, a single change can use an unlimited amount of memory).
7519 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7520 itself: >
7521 set ul=0
7522< But you can also get Vi compatibility by including the 'u' flag in
7523 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007524 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 Set to a negative number for no undo at all: >
7526 set ul=-1
7527< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007528 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007530 *'undoreload'* *'ur'*
7531'undoreload' 'ur' number (default 10000)
7532 global
7533 {not in Vi}
7534 Save the whole buffer for undo when reloading it. This applies to the
7535 ":e!" command and reloading for when the buffer changed outside of
7536 Vim. |FileChangedShell|
7537 The save only happens when this options is negative or when the number
7538 of lines is smaller than the value of this option.
7539 Set this option to zero to disable undo for a reload.
7540
7541 When saving undo for a reload, any undo file is not read.
7542
7543 Note that this causes the whole buffer to be stored in memory. Set
7544 this option to a lower value if you run out of memory.
7545
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 *'updatecount'* *'uc'*
7547'updatecount' 'uc' number (default: 200)
7548 global
7549 {not in Vi}
7550 After typing this many characters the swap file will be written to
7551 disk. When zero, no swap file will be created at all (see chapter on
7552 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7553 Vim with the "-n" option, see |startup|. When editing in readonly
7554 mode this option will be initialized to 10000.
7555 The swapfile can be disabled per buffer with |'swapfile'|.
7556 When 'updatecount' is set from zero to non-zero, swap files are
7557 created for all buffers that have 'swapfile' set. When 'updatecount'
7558 is set to zero, existing swap files are not deleted.
7559 Also see |'swapsync'|.
7560 This option has no meaning in buffers where |'buftype'| is "nofile"
7561 or "nowrite".
7562
7563 *'updatetime'* *'ut'*
7564'updatetime' 'ut' number (default 4000)
7565 global
7566 {not in Vi}
7567 If this many milliseconds nothing is typed the swap file will be
7568 written to disk (see |crash-recovery|). Also used for the
7569 |CursorHold| autocommand event.
7570
7571 *'verbose'* *'vbs'*
7572'verbose' 'vbs' number (default 0)
7573 global
7574 {not in Vi, although some versions have a boolean
7575 verbose option}
7576 When bigger than zero, Vim will give messages about what it is doing.
7577 Currently, these messages are given:
7578 >= 1 When the viminfo file is read or written.
7579 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007580 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007581 >= 8 Files for which a group of autocommands is executed.
7582 >= 9 Every executed autocommand.
7583 >= 12 Every executed function.
7584 >= 13 When an exception is thrown, caught, finished, or discarded.
7585 >= 14 Anything pending in a ":finally" clause.
7586 >= 15 Every executed Ex command (truncated at 200 characters).
7587
7588 This option can also be set with the "-V" argument. See |-V|.
7589 This option is also set by the |:verbose| command.
7590
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007591 When the 'verbosefile' option is set then the verbose messages are not
7592 displayed.
7593
7594 *'verbosefile'* *'vfile'*
7595'verbosefile' 'vfile' string (default empty)
7596 global
7597 {not in Vi}
7598 When not empty all messages are written in a file with this name.
7599 When the file exists messages are appended.
7600 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007601 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007602 Setting 'verbosefile' to a new value is like making it empty first.
7603 The difference with |:redir| is that verbose messages are not
7604 displayed when 'verbosefile' is set.
7605
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 *'viewdir'* *'vdir'*
7607'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7608 "$VIM/vimfiles/view",
7609 for Unix: "~/.vim/view",
7610 for Macintosh: "$VIM:vimfiles:view"
7611 for VMS: "sys$login:vimfiles/view"
7612 for RiscOS: "Choices:vimfiles/view")
7613 global
7614 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007615 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007616 feature}
7617 Name of the directory where to store files for |:mkview|.
7618 This option cannot be set from a |modeline| or in the |sandbox|, for
7619 security reasons.
7620
7621 *'viewoptions'* *'vop'*
7622'viewoptions' 'vop' string (default: "folds,options,cursor")
7623 global
7624 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007625 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 feature}
7627 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007628 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 word save and restore ~
7630 cursor cursor position in file and in window
7631 folds manually created folds, opened/closed folds and local
7632 fold options
7633 options options and mappings local to a window or buffer (not
7634 global values for local options)
7635 slash backslashes in file names replaced with forward
7636 slashes
7637 unix with Unix end-of-line format (single <NL>), even when
7638 on Windows or DOS
7639
7640 "slash" and "unix" are useful on Windows when sharing view files
7641 with Unix. The Unix version of Vim cannot source dos format scripts,
7642 but the Windows version of Vim can source unix format scripts.
7643
7644 *'viminfo'* *'vi'* *E526* *E527* *E528*
7645'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007646 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7647 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7648 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 global
7650 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007651 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007652 feature}
7653 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007654 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 separated list of parameters, each consisting of a single character
7656 identifying the particular parameter, followed by a number or string
7657 which specifies the value of that parameter. If a particular
7658 character is left out, then the default value is used for that
7659 parameter. The following is a list of the identifying characters and
7660 the effect of their value.
7661 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007662 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 ! When included, save and restore global variables that start
7664 with an uppercase letter, and don't contain a lowercase
7665 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007666 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007667 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007668 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 " Maximum number of lines saved for each register. Old name of
7670 the '<' item, with the disadvantage that you need to put a
7671 backslash before the ", otherwise it will be recognized as the
7672 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007673 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 % When included, save and restore the buffer list. If Vim is
7675 started with a file name argument, the buffer list is not
7676 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007677 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 without a file name and buffers for help files are not written
7679 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007680 When followed by a number, the number specifies the maximum
7681 number of buffers that are stored. Without a number all
7682 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007683 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 ' Maximum number of previously edited files for which the marks
7685 are remembered. This parameter must always be included when
7686 'viminfo' is non-empty.
7687 Including this item also means that the |jumplist| and the
7688 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007689 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007691 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007692 patterns are also saved. When not included, the value of
7693 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007694 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007695 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007696 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007697 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 < Maximum number of lines saved for each register. If zero then
7699 registers are not saved. When not included, all lines are
7700 saved. '"' is the old name for this item.
7701 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007702 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007704 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007705 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 c When included, convert the text in the viminfo file from the
7707 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007708 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007709 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 f Whether file marks need to be stored. If zero, file marks ('0
7711 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007712 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007714 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 h Disable the effect of 'hlsearch' when loading the viminfo
7716 file. When not included, it depends on whether ":nohlsearch"
7717 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007718 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007719 n Name of the viminfo file. The name must immediately follow
7720 the 'n'. Must be the last one! If the "-i" argument was
7721 given when starting Vim, that file name overrides the one
7722 given here with 'viminfo'. Environment variables are expanded
7723 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007724 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 r Removable media. The argument is a string (up to the next
7726 ','). This parameter can be given several times. Each
7727 specifies the start of a path for which no marks will be
7728 stored. This is to avoid removable media. For MS-DOS you
7729 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7730 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7731 ignored. Maximum length of each 'r' argument is 50
7732 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007733 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 s Maximum size of an item in Kbyte. If zero then registers are
7735 not saved. Currently only applies to registers. The default
7736 "s10" will exclude registers with more than 10 Kbyte of text.
7737 Also see the '<' item above: line count limit.
7738
7739 Example: >
7740 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7741<
7742 '50 Marks will be remembered for the last 50 files you
7743 edited.
7744 <1000 Contents of registers (up to 1000 lines each) will be
7745 remembered.
7746 s100 Registers with more than 100 Kbyte text are skipped.
7747 :0 Command-line history will not be saved.
7748 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7749 no / Since '/' is not specified, the default will be used,
7750 that is, save all of the search history, and also the
7751 previous search and substitute patterns.
7752 no % The buffer list will not be saved nor read back.
7753 no h 'hlsearch' highlighting will be restored.
7754
7755 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7756 load the contents of the file, this is not done automatically.
7757
7758 This option cannot be set from a |modeline| or in the |sandbox|, for
7759 security reasons.
7760
7761 *'virtualedit'* *'ve'*
7762'virtualedit' 've' string (default "")
7763 global
7764 {not in Vi}
7765 {not available when compiled without the
7766 |+virtualedit| feature}
7767 A comma separated list of these words:
7768 block Allow virtual editing in Visual block mode.
7769 insert Allow virtual editing in Insert mode.
7770 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007771 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007772
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007774 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007775 of the line. Useful for selecting a rectangle in Visual mode and
7776 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007777 "onemore" is not the same, it will only allow moving the cursor just
7778 after the last character of the line. This makes some commands more
7779 consistent. Previously the cursor was always past the end of the line
7780 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007781 break some plugins or Vim scripts. For example because |l| can move
7782 the cursor after the last character. Use with care!
7783 Using the |$| command will move to the last character in the line, not
7784 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007785 It doesn't make sense to combine "all" with "onemore", but you will
7786 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787
7788 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7789'visualbell' 'vb' boolean (default off)
7790 global
7791 {not in Vi}
7792 Use visual bell instead of beeping. The terminal code to display the
7793 visual bell is given with 't_vb'. When no beep or flash is wanted,
7794 use ":set vb t_vb=".
7795 Note: When the GUI starts, 't_vb' is reset to its default value. You
7796 might want to set it again in your |gvimrc|.
7797 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7798 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7799 where 40 is the time in msec.
7800 Does not work on the Amiga, you always get a screen flash.
7801 Also see 'errorbells'.
7802
7803 *'warn'* *'nowarn'*
7804'warn' boolean (default on)
7805 global
7806 Give a warning message when a shell command is used while the buffer
7807 has been changed.
7808
7809 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7810'weirdinvert' 'wiv' boolean (default off)
7811 global
7812 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007813 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 It is provided for backwards compatibility with version 4.x.
7815 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7816 vice versa. Has no effect when the GUI is running.
7817
7818 *'whichwrap'* *'ww'*
7819'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7820 global
7821 {not in Vi}
7822 Allow specified keys that move the cursor left/right to move to the
7823 previous/next line when the cursor is on the first/last character in
7824 the line. Concatenate characters to allow this for these keys:
7825 char key mode ~
7826 b <BS> Normal and Visual
7827 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007828 h "h" Normal and Visual (not recommended)
7829 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 < <Left> Normal and Visual
7831 > <Right> Normal and Visual
7832 ~ "~" Normal
7833 [ <Left> Insert and Replace
7834 ] <Right> Insert and Replace
7835 For example: >
7836 :set ww=<,>,[,]
7837< allows wrap only when cursor keys are used.
7838 When the movement keys are used in combination with a delete or change
7839 operator, the <EOL> also counts for a character. This makes "3h"
7840 different from "3dh" when the cursor crosses the end of a line. This
7841 is also true for "x" and "X", because they do the same as "dl" and
7842 "dh". If you use this, you may also want to use the mapping
7843 ":map <BS> X" to make backspace delete the character in front of the
7844 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007845 When 'l' is included and it is used after an operator at the end of a
7846 line then it will not move to the next line. This makes "dl", "cl",
7847 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 NOTE: This option is set to the Vi default value when 'compatible' is
7849 set and to the Vim default value when 'compatible' is reset.
7850
7851 *'wildchar'* *'wc'*
7852'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7853 global
7854 {not in Vi}
7855 Character you have to type to start wildcard expansion in the
7856 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007857 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007858 The character is not recognized when used inside a macro. See
7859 'wildcharm' for that.
7860 Although 'wc' is a number option, you can set it to a special key: >
7861 :set wc=<Esc>
7862< NOTE: This option is set to the Vi default value when 'compatible' is
7863 set and to the Vim default value when 'compatible' is reset.
7864
7865 *'wildcharm'* *'wcm'*
7866'wildcharm' 'wcm' number (default: none (0))
7867 global
7868 {not in Vi}
7869 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007870 recognized when used inside a macro. You can find "spare" command-line
7871 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 you'll never actually type 'wildcharm', just use it in mappings that
7873 automatically invoke completion mode, e.g.: >
7874 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007875 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876< Then after typing :ss you can use CTRL-P & CTRL-N.
7877
7878 *'wildignore'* *'wig'*
7879'wildignore' 'wig' string (default "")
7880 global
7881 {not in Vi}
7882 {not available when compiled without the |+wildignore|
7883 feature}
7884 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02007885 patterns is ignored when expanding |wildcards|, completing file or
7886 directory names, and influences the result of |expand()|, |glob()| and
7887 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7889 Also see 'suffixes'.
7890 Example: >
7891 :set wildignore=*.o,*.obj
7892< The use of |:set+=| and |:set-=| is preferred when adding or removing
7893 a pattern from the list. This avoids problems when a future version
7894 uses another default.
7895
Bram Moolenaar94950a92010-12-02 16:01:29 +01007896
Bram Moolenaar81af9252010-12-10 20:35:50 +01007897 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007898'wildignorecase' 'wic' boolean (default off)
7899 global
7900 {not in Vi}
7901 When set case is ignored when completing file names and directories.
7902 Has no effect on systems where file name case is generally ignored.
7903 Does not apply when the shell is used to expand wildcards, which
7904 happens when there are special characters.
7905
7906
Bram Moolenaar071d4272004-06-13 20:20:40 +00007907 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7908'wildmenu' 'wmnu' boolean (default off)
7909 global
7910 {not in Vi}
7911 {not available if compiled without the |+wildmenu|
7912 feature}
7913 When 'wildmenu' is on, command-line completion operates in an enhanced
7914 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7915 the possible matches are shown just above the command line, with the
7916 first match highlighted (overwriting the status line, if there is
7917 one). Keys that show the previous/next match, such as <Tab> or
7918 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7919 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7920 specified. "longest" and "list" do not start "wildmenu" mode.
7921 If there are more matches than can fit in the line, a ">" is shown on
7922 the right and/or a "<" is shown on the left. The status line scrolls
7923 as needed.
7924 The "wildmenu" mode is abandoned when a key is hit that is not used
7925 for selecting a completion.
7926 While the "wildmenu" is active the following keys have special
7927 meanings:
7928
7929 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7930 <Down> - in filename/menu name completion: move into a
7931 subdirectory or submenu.
7932 <CR> - in menu completion, when the cursor is just after a
7933 dot: move into a submenu.
7934 <Up> - in filename/menu name completion: move up into
7935 parent directory or parent menu.
7936
7937 This makes the menus accessible from the console |console-menus|.
7938
7939 If you prefer the <Left> and <Right> keys to move the cursor instead
7940 of selecting a different match, use this: >
7941 :cnoremap <Left> <Space><BS><Left>
7942 :cnoremap <Right> <Space><BS><Right>
7943<
7944 The "WildMenu" highlighting is used for displaying the current match
7945 |hl-WildMenu|.
7946
7947 *'wildmode'* *'wim'*
7948'wildmode' 'wim' string (Vim default: "full")
7949 global
7950 {not in Vi}
7951 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007952 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007953 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 first part specifies the behavior for the first use of 'wildchar',
7955 The second part for the second use, etc.
7956 These are the possible values for each part:
7957 "" Complete only the first match.
7958 "full" Complete the next full match. After the last match,
7959 the original string is used and then the first match
7960 again.
7961 "longest" Complete till longest common string. If this doesn't
7962 result in a longer string, use the next part.
7963 "longest:full" Like "longest", but also start 'wildmenu' if it is
7964 enabled.
7965 "list" When more than one match, list all matches.
7966 "list:full" When more than one match, list all matches and
7967 complete first match.
7968 "list:longest" When more than one match, list all matches and
7969 complete till longest common string.
7970 When there is only a single match, it is fully completed in all cases.
7971
7972 Examples: >
7973 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007974< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 :set wildmode=longest,full
7976< Complete longest common string, then each full match >
7977 :set wildmode=list:full
7978< List all matches and complete each full match >
7979 :set wildmode=list,full
7980< List all matches without completing, then each full match >
7981 :set wildmode=longest,list
7982< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007983 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007985 *'wildoptions'* *'wop'*
7986'wildoptions' 'wop' string (default "")
7987 global
7988 {not in Vi}
7989 {not available when compiled without the |+wildignore|
7990 feature}
7991 A list of words that change how command line completion is done.
7992 Currently only one word is allowed:
7993 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007994 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007995 is displayed per line. Often used tag kinds are:
7996 d #define
7997 f function
7998 Also see |cmdline-completion|.
7999
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 *'winaltkeys'* *'wak'*
8001'winaltkeys' 'wak' string (default "menu")
8002 global
8003 {not in Vi}
8004 {only used in Win32, Motif, GTK and Photon GUI}
8005 Some GUI versions allow the access to menu entries by using the ALT
8006 key in combination with a character that appears underlined in the
8007 menu. This conflicts with the use of the ALT key for mappings and
8008 entering special characters. This option tells what to do:
8009 no Don't use ALT keys for menus. ALT key combinations can be
8010 mapped, but there is no automatic handling. This can then be
8011 done with the |:simalt| command.
8012 yes ALT key handling is done by the windowing system. ALT key
8013 combinations cannot be mapped.
8014 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008015 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016 keys can be mapped.
8017 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8018 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008019 This option is not used for <F10>; on Win32 and with GTK <F10> will
8020 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008021
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008022 *'window'* *'wi'*
8023'window' 'wi' number (default screen height - 1)
8024 global
8025 Window height. Do not confuse this with the height of the Vim window,
8026 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008027 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8028 value is smaller than 'lines' minus one. The screen will scroll
8029 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008030 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8031 in a much smarter way, taking care of wrapping lines.
8032 When resizing the Vim window, the value is smaller than 1 or more than
8033 or equal to 'lines' it will be set to 'lines' minus 1.
8034 {Vi also uses the option to specify the number of displayed lines}
8035
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 *'winheight'* *'wh'* *E591*
8037'winheight' 'wh' number (default 1)
8038 global
8039 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008040 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008041 feature}
8042 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008043 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008044 focus goes to a window that is smaller, its size is increased, at the
8045 cost of the height of other windows.
8046 Set 'winheight' to a small number for normal editing.
8047 Set it to 999 to make the current window fill most of the screen.
8048 Other windows will be only 'winminheight' high. This has the drawback
8049 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8050 to create only two windows, set the option after startup is done,
8051 using the |VimEnter| event: >
8052 au VimEnter * set winheight=999
8053< Minimum value is 1.
8054 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 height of the current window.
8056 'winheight' applies to the current window. Use 'winminheight' to set
8057 the minimal height for other windows.
8058
8059 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8060'winfixheight' 'wfh' boolean (default off)
8061 local to window
8062 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008063 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008064 feature}
8065 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008066 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8067 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 The height may be changed anyway when running out of room.
8069
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008070 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8071'winfixwidth' 'wfw' boolean (default off)
8072 local to window
8073 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008074 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008075 feature}
8076 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008077 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008078 The width may be changed anyway when running out of room.
8079
Bram Moolenaar071d4272004-06-13 20:20:40 +00008080 *'winminheight'* *'wmh'*
8081'winminheight' 'wmh' number (default 1)
8082 global
8083 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008084 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 feature}
8086 The minimal height of a window, when it's not the current window.
8087 This is a hard minimum, windows will never become smaller.
8088 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8089 status bar) if necessary. They will return to at least one line when
8090 they become active (since the cursor has to have somewhere to go.)
8091 Use 'winheight' to set the minimal height of the current window.
8092 This option is only checked when making a window smaller. Don't use a
8093 large number, it will cause errors when opening more than a few
8094 windows. A value of 0 to 3 is reasonable.
8095
8096 *'winminwidth'* *'wmw'*
8097'winminwidth' 'wmw' number (default 1)
8098 global
8099 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008100 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008101 feature}
8102 The minimal width of a window, when it's not the current window.
8103 This is a hard minimum, windows will never become smaller.
8104 When set to zero, windows may be "squashed" to zero columns (i.e. just
8105 a vertical separator) if necessary. They will return to at least one
8106 line when they become active (since the cursor has to have somewhere
8107 to go.)
8108 Use 'winwidth' to set the minimal width of the current window.
8109 This option is only checked when making a window smaller. Don't use a
8110 large number, it will cause errors when opening more than a few
8111 windows. A value of 0 to 12 is reasonable.
8112
8113 *'winwidth'* *'wiw'* *E592*
8114'winwidth' 'wiw' number (default 20)
8115 global
8116 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008117 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 feature}
8119 Minimal number of columns for the current window. This is not a hard
8120 minimum, Vim will use fewer columns if there is not enough room. If
8121 the current window is smaller, its size is increased, at the cost of
8122 the width of other windows. Set it to 999 to make the current window
8123 always fill the screen. Set it to a small number for normal editing.
8124 The width is not adjusted after one of the commands to change the
8125 width of the current window.
8126 'winwidth' applies to the current window. Use 'winminwidth' to set
8127 the minimal width for other windows.
8128
8129 *'wrap'* *'nowrap'*
8130'wrap' boolean (default on)
8131 local to window
8132 {not in Vi}
8133 This option changes how text is displayed. It doesn't change the text
8134 in the buffer, see 'textwidth' for that.
8135 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008136 displaying continues on the next line. When off lines will not wrap
8137 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008138 moved to a part that is not shown, the screen will scroll
8139 horizontally.
8140 The line will be broken in the middle of a word if necessary. See
8141 'linebreak' to get the break at a word boundary.
8142 To make scrolling horizontally a bit more useful, try this: >
8143 :set sidescroll=5
8144 :set listchars+=precedes:<,extends:>
8145< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008146 This option can't be set from a |modeline| when the 'diff' option is
8147 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008148
8149 *'wrapmargin'* *'wm'*
8150'wrapmargin' 'wm' number (default 0)
8151 local to buffer
8152 Number of characters from the right window border where wrapping
8153 starts. When typing text beyond this limit, an <EOL> will be inserted
8154 and inserting continues on the next line.
8155 Options that add a margin, such as 'number' and 'foldcolumn', cause
8156 the text width to be further reduced. This is Vi compatible.
8157 When 'textwidth' is non-zero, this option is not used.
8158 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8159 and less usefully}
8160
8161 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8162'wrapscan' 'ws' boolean (default on) *E384* *E385*
8163 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008164 Searches wrap around the end of the file. Also applies to |]s| and
8165 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008166
8167 *'write'* *'nowrite'*
8168'write' boolean (default on)
8169 global
8170 {not in Vi}
8171 Allows writing files. When not set, writing a file is not allowed.
8172 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008173 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008174 argument. Filtering text is still possible, even though this requires
8175 writing a temporary file.
8176
8177 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8178'writeany' 'wa' boolean (default off)
8179 global
8180 Allows writing to any file with no need for "!" override.
8181
8182 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8183'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8184 otherwise)
8185 global
8186 {not in Vi}
8187 Make a backup before overwriting a file. The backup is removed after
8188 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008189 also on.
8190 WARNING: Switching this option off means that when Vim fails to write
8191 your buffer correctly and then, for whatever reason, Vim exits, you
8192 lose both the original file and what you were writing. Only reset
8193 this option if your file system is almost full and it makes the write
8194 fail (and make sure not to exit Vim until the write was successful).
8195 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196 When the 'backupskip' pattern matches, a backup is not made anyway.
8197 NOTE: This option is set to the default value when 'compatible' is
8198 set.
8199
8200 *'writedelay'* *'wd'*
8201'writedelay' 'wd' number (default 0)
8202 global
8203 {not in Vi}
8204 The number of microseconds to wait for each character sent to the
8205 screen. When non-zero, characters are sent to the terminal one by
8206 one. For MS-DOS pcterm this does not work. For debugging purposes.
8207
8208 vim:tw=78:ts=8:ft=help:norl: