blob: c3e91ed2d9301e8fab1d1dd372f3f2162fde9d97 [file] [log] [blame]
Bram Moolenaarbf884932013-04-05 22:26:15 +02001*options.txt* For Vim version 7.3. Last change: 2013 Apr 05
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
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
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100702 Vim may set this option automatically at startup time when Vim is
703 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200704 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100705
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
707'antialias' 'anti' boolean (default: off)
708 global
709 {not in Vi}
710 {only available when compiled with GUI enabled
711 on Mac OS X}
712 This option only has an effect in the GUI version of Vim on Mac OS X
713 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
714 which can be easier to read at certain sizes on certain displays.
715 Setting this option can sometimes cause problems if 'guifont' is set
716 to its default (empty string).
717
718 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
719'autochdir' 'acd' boolean (default off)
720 global
721 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200722 {only available when compiled with it, use
723 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000724 When on, Vim will change the current working directory whenever you
725 open a file, switch buffers, delete a buffer or open/close a window.
726 It will change to the directory containing the file which was opened
727 or selected.
728 This option is provided for backward compatibility with the Vim
729 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000730 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
733'arabic' 'arab' boolean (default off)
734 local to window
735 {not in Vi}
736 {only available when compiled with the |+arabic|
737 feature}
738 This option can be set to start editing Arabic text.
739 Setting this option will:
740 - Set the 'rightleft' option, unless 'termbidi' is set.
741 - Set the 'arabicshape' option, unless 'termbidi' is set.
742 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
743 between typing English and Arabic key mapping.
744 - Set the 'delcombine' option
745 Note that 'encoding' must be "utf-8" for working with Arabic text.
746
747 Resetting this option will:
748 - Reset the 'rightleft' option.
749 - Disable the use of 'keymap' (without changing its value).
750 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200751 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 Also see |arabic.txt|.
753
754 *'arabicshape'* *'arshape'*
755 *'noarabicshape'* *'noarshape'*
756'arabicshape' 'arshape' boolean (default on)
757 global
758 {not in Vi}
759 {only available when compiled with the |+arabic|
760 feature}
761 When on and 'termbidi' is off, the required visual character
762 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200763 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 one which encompasses:
765 a) the changing/morphing of characters based on their location
766 within a word (initial, medial, final and stand-alone).
767 b) the enabling of the ability to compose characters
768 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100769 When disabled the display shows each character's true stand-alone
770 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000771 Arabic is a complex language which requires other settings, for
772 further details see |arabic.txt|.
773
774 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
775'autoindent' 'ai' boolean (default off)
776 local to buffer
777 Copy indent from current line when starting a new line (typing <CR>
778 in Insert mode or when using the "o" or "O" command). If you do not
779 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000780 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
781 to another line has the same effect, unless the 'I' flag is included
782 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000783 When autoindent is on, formatting (with the "gq" command or when you
784 reach 'textwidth' in Insert mode) uses the indentation of the first
785 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000786 When 'smartindent' or 'cindent' is on the indent is changed in
787 a different way.
788 The 'autoindent' option is reset when the 'paste' option is set.
789 {small difference from Vi: After the indent is deleted when typing
790 <Esc> or <CR>, the cursor position when moving up or down is after the
791 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
792
793 *'autoread'* *'ar'* *'noautoread'* *'noar'*
794'autoread' 'ar' boolean (default off)
795 global or local to buffer |global-local|
796 {not in Vi}
797 When a file has been detected to have been changed outside of Vim and
798 it has not been changed inside of Vim, automatically read it again.
799 When the file has been deleted this is not done. |timestamp|
800 If this option has a local value, use this command to switch back to
801 using the global value: >
802 :set autoread<
803<
804 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
805'autowrite' 'aw' boolean (default off)
806 global
807 Write the contents of the file, if it has been modified, on each
808 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000809 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
811 Note that for some commands the 'autowrite' option is not used, see
812 'autowriteall' for that.
813
814 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
815'autowriteall' 'awa' boolean (default off)
816 global
817 {not in Vi}
818 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
819 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
820 Setting this option also implies that Vim behaves like 'autowrite' has
821 been set.
822
823 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200824'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825 global
826 {not in Vi}
827 When set to "dark", Vim will try to use colors that look good on a
828 dark background. When set to "light", Vim will try to use colors that
829 look good on a light background. Any other value is illegal.
830 Vim tries to set the default value according to the terminal used.
831 This will not always be correct.
832 Setting this option does not change the background color, it tells Vim
833 what the background color looks like. For changing the background
834 color, see |:hi-normal|.
835
836 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000837 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000838 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100839 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840 setting 'background' will cause the color scheme to be reloaded. If
841 the color scheme adjusts to the value of 'background' this will work.
842 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100843 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844
845 When setting 'background' to the default value with: >
846 :set background&
847< Vim will guess the value. In the GUI this should work correctly,
848 in other cases Vim might not be able to guess the right value.
849
850 When starting the GUI, the default value for 'background' will be
851 "light". When the value is not set in the .gvimrc, and Vim detects
852 that the background is actually quite dark, 'background' is set to
853 "dark". But this happens only AFTER the .gvimrc file has been read
854 (because the window needs to be opened to find the actual background
855 color). To get around this, force the GUI window to be opened by
856 putting a ":gui" command in the .gvimrc file, before where the value
857 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200858
859 For MS-DOS, Windows and OS/2 the default is "dark".
860 For other systems "dark" is used when 'term' is "linux",
861 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
862 background. Otherwise the default is "light".
863
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 Normally this option would be set in the .vimrc file. Possibly
865 depending on the terminal name. Example: >
866 :if &term == "pcterm"
867 : set background=dark
868 :endif
869< When this option is set, the default settings for the highlight groups
870 will change. To use other settings, place ":highlight" commands AFTER
871 the setting of the 'background' option.
872 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
873 to select the colors for syntax highlighting. After changing this
874 option, you must load syntax.vim again to see the result. This can be
875 done with ":syntax on".
876
877 *'backspace'* *'bs'*
878'backspace' 'bs' string (default "")
879 global
880 {not in Vi}
881 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
882 mode. This is a list of items, separated by commas. Each item allows
883 a way to backspace over something:
884 value effect ~
885 indent allow backspacing over autoindent
886 eol allow backspacing over line breaks (join lines)
887 start allow backspacing over the start of insert; CTRL-W and CTRL-U
888 stop once at the start of insert.
889
890 When the value is empty, Vi compatible backspacing is used.
891
892 For backwards compatibility with version 5.4 and earlier:
893 value effect ~
894 0 same as ":set backspace=" (Vi compatible)
895 1 same as ":set backspace=indent,eol"
896 2 same as ":set backspace=indent,eol,start"
897
898 See |:fixdel| if your <BS> or <Del> key does not do what you want.
899 NOTE: This option is set to "" when 'compatible' is set.
900
901 *'backup'* *'bk'* *'nobackup'* *'nobk'*
902'backup' 'bk' boolean (default off)
903 global
904 {not in Vi}
905 Make a backup before overwriting a file. Leave it around after the
906 file has been successfully written. If you do not want to keep the
907 backup file, but you do want a backup while the file is being
908 written, reset this option and set the 'writebackup' option (this is
909 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000910 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 |backup-table| for more explanations.
912 When the 'backupskip' pattern matches, a backup is not made anyway.
913 When 'patchmode' is set, the backup may be renamed to become the
914 oldest version of a file.
915 NOTE: This option is reset when 'compatible' is set.
916
917 *'backupcopy'* *'bkc'*
918'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
919 global
920 {not in Vi}
921 When writing a file and a backup is made, this option tells how it's
922 done. This is a comma separated list of words.
923
924 The main values are:
925 "yes" make a copy of the file and overwrite the original one
926 "no" rename the file and write a new one
927 "auto" one of the previous, what works best
928
929 Extra values that can be combined with the ones above are:
930 "breaksymlink" always break symlinks when writing
931 "breakhardlink" always break hardlinks when writing
932
933 Making a copy and overwriting the original file:
934 - Takes extra time to copy the file.
935 + When the file has special attributes, is a (hard/symbolic) link or
936 has a resource fork, all this is preserved.
937 - When the file is a link the backup will have the name of the link,
938 not of the real file.
939
940 Renaming the file and writing a new one:
941 + It's fast.
942 - Sometimes not all attributes of the file can be copied to the new
943 file.
944 - When the file is a link the new file will not be a link.
945
946 The "auto" value is the middle way: When Vim sees that renaming file
947 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000948 the file is not a link) that is used. When problems are expected, a
949 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000950
951 The "breaksymlink" and "breakhardlink" values can be used in
952 combination with any of "yes", "no" and "auto". When included, they
953 force Vim to always break either symbolic or hard links by doing
954 exactly what the "no" option does, renaming the original file to
955 become the backup and writing a new file in its place. This can be
956 useful for example in source trees where all the files are symbolic or
957 hard links and any changes should stay in the local source tree, not
958 be propagated back to the original source.
959 *crontab*
960 One situation where "no" and "auto" will cause problems: A program
961 that opens a file, invokes Vim to edit that file, and then tests if
962 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000963 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 example.
965
966 When a copy is made, the original file is truncated and then filled
967 with the new text. This means that protection bits, owner and
968 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000969 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 group of the backup is set to the group of the original file. If this
971 fails, the protection bits for the group are made the same as for
972 others.
973
974 When the file is renamed this is the other way around: The backup has
975 the same attributes of the original file, and the newly written file
976 is owned by the current user. When the file was a (hard/symbolic)
977 link, the new file will not! That's why the "auto" value doesn't
978 rename when the file is a link. The owner and group of the newly
979 written file will be set to the same ones as the original file, but
980 the system may refuse to do this. In that case the "auto" value will
981 again not rename the file.
982
983 *'backupdir'* *'bdir'*
984'backupdir' 'bdir' string (default for Amiga: ".,t:",
985 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
986 for Unix: ".,~/tmp,~/")
987 global
988 {not in Vi}
989 List of directories for the backup file, separated with commas.
990 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100991 where this is possible. The directory must exist, Vim will not
992 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +0100993 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 impossible!). Writing may fail because of this.
995 - A directory "." means to put the backup file in the same directory
996 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000997 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000998 put the backup file relative to where the edited file is. The
999 leading "." is replaced with the path name of the edited file.
1000 ("." inside a directory name has no special meaning).
1001 - Spaces after the comma are ignored, other spaces are considered part
1002 of the directory name. To have a space at the start of a directory
1003 name, precede it with a backslash.
1004 - To include a comma in a directory name precede it with a backslash.
1005 - A directory name may end in an '/'.
1006 - Environment variables are expanded |:set_env|.
1007 - Careful with '\' characters, type one before a space, type two to
1008 get one in the option (see |option-backslash|), for example: >
1009 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1010< - For backwards compatibility with Vim version 3.0 a '>' at the start
1011 of the option is removed.
1012 See also 'backup' and 'writebackup' options.
1013 If you want to hide your backup files on Unix, consider this value: >
1014 :set backupdir=./.backup,~/.backup,.,/tmp
1015< You must create a ".backup" directory in each directory and in your
1016 home directory for this to work properly.
1017 The use of |:set+=| and |:set-=| is preferred when adding or removing
1018 directories from the list. This avoids problems when a future version
1019 uses another default.
1020 This option cannot be set from a |modeline| or in the |sandbox|, for
1021 security reasons.
1022
1023 *'backupext'* *'bex'* *E589*
1024'backupext' 'bex' string (default "~", for VMS: "_")
1025 global
1026 {not in Vi}
1027 String which is appended to a file name to make the name of the
1028 backup file. The default is quite unusual, because this avoids
1029 accidentally overwriting existing files with a backup file. You might
1030 prefer using ".bak", but make sure that you don't have files with
1031 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001032 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001034 If you like to keep a lot of backups, you could use a BufWritePre
1035 autocommand to change 'backupext' just before writing the file to
1036 include a timestamp. >
1037 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1038< Use 'backupdir' to put the backup in a different directory.
1039
Bram Moolenaar071d4272004-06-13 20:20:40 +00001040 *'backupskip'* *'bsk'*
1041'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1042 global
1043 {not in Vi}
1044 {not available when compiled without the |+wildignore|
1045 feature}
1046 A list of file patterns. When one of the patterns matches with the
1047 name of the file which is written, no backup file is created. Both
1048 the specified file name and the full path name of the file are used.
1049 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1050 Watch out for special characters, see |option-backslash|.
1051 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001052 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001053
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001054 WARNING: Not having a backup file means that when Vim fails to write
1055 your buffer correctly and then, for whatever reason, Vim exits, you
1056 lose both the original file and what you were writing. Only disable
1057 backups if you don't care about losing the file.
1058
Bram Moolenaar02467872007-05-06 13:22:01 +00001059 Note that environment variables are not expanded. If you want to use
1060 $HOME you must expand it explicitly, e.g.: >
1061 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1062
1063< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001064 backup would be made by renaming the original file crontab won't see
1065 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066
1067 *'balloondelay'* *'bdlay'*
1068'balloondelay' 'bdlay' number (default: 600)
1069 global
1070 {not in Vi}
1071 {only available when compiled with the |+balloon_eval|
1072 feature}
1073 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1074
1075 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1076'ballooneval' 'beval' boolean (default off)
1077 global
1078 {not in Vi}
1079 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001080 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 Switch on the |balloon-eval| functionality.
1082
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001083 *'balloonexpr'* *'bexpr'*
1084'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001085 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001086 {not in Vi}
1087 {only available when compiled with the |+balloon_eval|
1088 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001089 Expression for text to show in evaluation balloon. It is only used
1090 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091
1092 v:beval_bufnr number of the buffer in which balloon is going to show
1093 v:beval_winnr number of the window
1094 v:beval_lnum line number
1095 v:beval_col column number (byte index)
1096 v:beval_text word under or after the mouse pointer
1097
1098 The evaluation of the expression must not have side effects!
1099 Example: >
1100 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001101 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001102 \', column ' . v:beval_col .
1103 \ ' of file ' . bufname(v:beval_bufnr) .
1104 \ ' on word "' . v:beval_text . '"'
1105 endfunction
1106 set bexpr=MyBalloonExpr()
1107 set ballooneval
1108<
1109 NOTE: The balloon is displayed only if the cursor is on a text
1110 character. If the result of evaluating 'balloonexpr' is not empty,
1111 Vim does not try to send a message to an external debugger (Netbeans
1112 or Sun Workshop).
1113
Bram Moolenaar30b65812012-07-12 22:01:11 +02001114 The expression will be evaluated in the |sandbox| when set from a
1115 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001116
1117 It is not allowed to change text or jump to another window while
1118 evaluating 'balloonexpr' |textlock|.
1119
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001120 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001121 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001122< When they are supported "\n" characters will start a new line. If the
1123 expression evaluates to a |List| this is equal to using each List item
1124 as a string and putting "\n" in between them.
1125
Bram Moolenaar071d4272004-06-13 20:20:40 +00001126 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1127'binary' 'bin' boolean (default off)
1128 local to buffer
1129 {not in Vi}
1130 This option should be set before editing a binary file. You can also
1131 use the |-b| Vim argument. When this option is switched on a few
1132 options will be changed (also when it already was on):
1133 'textwidth' will be set to 0
1134 'wrapmargin' will be set to 0
1135 'modeline' will be off
1136 'expandtab' will be off
1137 Also, 'fileformat' and 'fileformats' options will not be used, the
1138 file is read and written like 'fileformat' was "unix" (a single <NL>
1139 separates lines).
1140 The 'fileencoding' and 'fileencodings' options will not be used, the
1141 file is read without conversion.
1142 NOTE: When you start editing a(nother) file while the 'bin' option is
1143 on, settings from autocommands may change the settings again (e.g.,
1144 'textwidth'), causing trouble when editing. You might want to set
1145 'bin' again when the file has been loaded.
1146 The previous values of these options are remembered and restored when
1147 'bin' is switched from on to off. Each buffer has its own set of
1148 saved option values.
1149 To edit a file with 'binary' set you can use the |++bin| argument.
1150 This avoids you have to do ":set bin", which would have effect for all
1151 files you edit.
1152 When writing a file the <EOL> for the last line is only written if
1153 there was one in the original file (normally Vim appends an <EOL> to
1154 the last line if there is none; this would make the file longer). See
1155 the 'endofline' option.
1156
1157 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1158'bioskey' 'biosk' boolean (default on)
1159 global
1160 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001161 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001162 better to detect CTRL-C, but only works for the console. When using a
1163 terminal over a serial port reset this option.
1164 Also see |'conskey'|.
1165
1166 *'bomb'* *'nobomb'*
1167'bomb' boolean (default off)
1168 local to buffer
1169 {not in Vi}
1170 {only available when compiled with the |+multi_byte|
1171 feature}
1172 When writing a file and the following conditions are met, a BOM (Byte
1173 Order Mark) is prepended to the file:
1174 - this option is on
1175 - the 'binary' option is off
1176 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1177 endian variants.
1178 Some applications use the BOM to recognize the encoding of the file.
1179 Often used for UCS-2 files on MS-Windows. For other applications it
1180 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001181 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001182 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1183 check for the presence of the BOM is done and 'bomb' set accordingly.
1184 Unless 'binary' is set, it is removed from the first line, so that you
1185 don't see it when editing. When you don't change the options, the BOM
1186 will be restored when writing the file.
1187
1188 *'breakat'* *'brk'*
1189'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1190 global
1191 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001192 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 feature}
1194 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001195 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1196 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001197
1198 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001199'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001201 {not in Vi} {only for Motif, Athena, GTK, Mac and
1202 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001204 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001205 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206 buffer Use the directory of the related buffer.
1207 current Use the current directory.
1208 {path} Use the specified directory
1209
1210 *'bufhidden'* *'bh'*
1211'bufhidden' 'bh' string (default: "")
1212 local to buffer
1213 {not in Vi}
1214 {not available when compiled without the |+quickfix|
1215 feature}
1216 This option specifies what happens when a buffer is no longer
1217 displayed in a window:
1218 <empty> follow the global 'hidden' option
1219 hide hide the buffer (don't unload it), also when 'hidden'
1220 is not set
1221 unload unload the buffer, also when 'hidden' is set or using
1222 |:hide|
1223 delete delete the buffer from the buffer list, also when
1224 'hidden' is set or using |:hide|, like using
1225 |:bdelete|
1226 wipe wipe out the buffer from the buffer list, also when
1227 'hidden' is set or using |:hide|, like using
1228 |:bwipeout|
1229
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001230 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001231 are lost without a warning. Also, these values may break autocommands
1232 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001233 This option is used together with 'buftype' and 'swapfile' to specify
1234 special kinds of buffers. See |special-buffers|.
1235
1236 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1237'buflisted' 'bl' boolean (default: on)
1238 local to buffer
1239 {not in Vi}
1240 When this option is set, the buffer shows up in the buffer list. If
1241 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1242 This option is reset by Vim for buffers that are only used to remember
1243 a file name or marks. Vim sets it when starting to edit a buffer.
1244 But not when moving to a buffer with ":buffer".
1245
1246 *'buftype'* *'bt'* *E382*
1247'buftype' 'bt' string (default: "")
1248 local to buffer
1249 {not in Vi}
1250 {not available when compiled without the |+quickfix|
1251 feature}
1252 The value of this option specifies the type of a buffer:
1253 <empty> normal buffer
1254 nofile buffer which is not related to a file and will not be
1255 written
1256 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001257 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001258 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001259 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001261 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 help help buffer (you are not supposed to set this
1263 manually)
1264
1265 This option is used together with 'bufhidden' and 'swapfile' to
1266 specify special kinds of buffers. See |special-buffers|.
1267
1268 Be careful with changing this option, it can have many side effects!
1269
Bram Moolenaar280f1262006-01-30 00:14:18 +00001270 A "quickfix" buffer is only used for the error list and the location
1271 list. This value is set by the |:cwindow| and |:lwindow| commands and
1272 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273
1274 "nofile" and "nowrite" buffers are similar:
1275 both: The buffer is not to be written to disk, ":w" doesn't
1276 work (":w filename" does work though).
1277 both: The buffer is never considered to be |'modified'|.
1278 There is no warning when the changes will be lost, for
1279 example when you quit Vim.
1280 both: A swap file is only created when using too much memory
1281 (when 'swapfile' has been reset there is never a swap
1282 file).
1283 nofile only: The buffer name is fixed, it is not handled like a
1284 file name. It is not modified in response to a |:cd|
1285 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001286 *E676*
1287 "acwrite" implies that the buffer name is not related to a file, like
1288 "nofile", but it will be written. Thus, in contrast to "nofile" and
1289 "nowrite", ":w" does work and a modified buffer can't be abandoned
1290 without saving. For writing there must be matching |BufWriteCmd|,
1291 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292
1293 *'casemap'* *'cmp'*
1294'casemap' 'cmp' string (default: "internal,keepascii")
1295 global
1296 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001297 {only available when compiled with the |+multi_byte|
1298 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299 Specifies details about changing the case of letters. It may contain
1300 these words, separated by a comma:
1301 internal Use internal case mapping functions, the current
1302 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001303 matters when 'encoding' is a Unicode encoding,
1304 "latin1" or "iso-8859-15". When "internal" is
1305 omitted, the towupper() and towlower() system library
1306 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001307 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1308 case mapping, the current locale is not effective.
1309 This probably only matters for Turkish.
1310
1311 *'cdpath'* *'cd'* *E344* *E346*
1312'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1313 global
1314 {not in Vi}
1315 {not available when compiled without the
1316 |+file_in_path| feature}
1317 This is a list of directories which will be searched when using the
1318 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001319 for has a relative path, not an absolute part starting with "/", "./"
1320 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001321 The 'cdpath' option's value has the same form and semantics as
1322 |'path'|. Also see |file-searching|.
1323 The default value is taken from $CDPATH, with a "," prepended to look
1324 in the current directory first.
1325 If the default value taken from $CDPATH is not what you want, include
1326 a modified version of the following command in your vimrc file to
1327 override it: >
1328 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1329< This option cannot be set from a |modeline| or in the |sandbox|, for
1330 security reasons.
1331 (parts of 'cdpath' can be passed to the shell to expand file names).
1332
1333 *'cedit'*
1334'cedit' string (Vi default: "", Vim default: CTRL-F)
1335 global
1336 {not in Vi}
1337 {not available when compiled without the |+vertsplit|
1338 feature}
1339 The key used in Command-line Mode to open the command-line window.
1340 The default is CTRL-F when 'compatible' is off.
1341 Only non-printable keys are allowed.
1342 The key can be specified as a single character, but it is difficult to
1343 type. The preferred way is to use the <> notation. Examples: >
1344 :set cedit=<C-Y>
1345 :set cedit=<Esc>
1346< |Nvi| also has this option, but it only uses the first character.
1347 See |cmdwin|.
1348
1349 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1350'charconvert' 'ccv' string (default "")
1351 global
1352 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001353 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 {not in Vi}
1355 An expression that is used for character encoding conversion. It is
1356 evaluated when a file that is to be read or has been written has a
1357 different encoding from what is desired.
1358 'charconvert' is not used when the internal iconv() function is
1359 supported and is able to do the conversion. Using iconv() is
1360 preferred, because it is much faster.
1361 'charconvert' is not used when reading stdin |--|, because there is no
1362 file to convert from. You will have to save the text in a file first.
1363 The expression must return zero or an empty string for success,
1364 non-zero for failure.
1365 The possible encoding names encountered are in 'encoding'.
1366 Additionally, names given in 'fileencodings' and 'fileencoding' are
1367 used.
1368 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1369 is done internally by Vim, 'charconvert' is not used for this.
1370 'charconvert' is also used to convert the viminfo file, if the 'c'
1371 flag is present in 'viminfo'. Also used for Unicode conversion.
1372 Example: >
1373 set charconvert=CharConvert()
1374 fun CharConvert()
1375 system("recode "
1376 \ . v:charconvert_from . ".." . v:charconvert_to
1377 \ . " <" . v:fname_in . " >" v:fname_out)
1378 return v:shell_error
1379 endfun
1380< The related Vim variables are:
1381 v:charconvert_from name of the current encoding
1382 v:charconvert_to name of the desired encoding
1383 v:fname_in name of the input file
1384 v:fname_out name of the output file
1385 Note that v:fname_in and v:fname_out will never be the same.
1386 Note that v:charconvert_from and v:charconvert_to may be different
1387 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1388 Encryption is not done by Vim when using 'charconvert'. If you want
1389 to encrypt the file after conversion, 'charconvert' should take care
1390 of this.
1391 This option cannot be set from a |modeline| or in the |sandbox|, for
1392 security reasons.
1393
1394 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1395'cindent' 'cin' boolean (default off)
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+cindent|
1399 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001400 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 that trigger reindenting in insert mode and 'cinoptions' to set your
1402 preferred indent style.
1403 If 'indentexpr' is not empty, it overrules 'cindent'.
1404 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1405 the "=" operator indents using this algorithm rather than calling an
1406 external program.
1407 See |C-indenting|.
1408 When you don't like the way 'cindent' works, try the 'smartindent'
1409 option or 'indentexpr'.
1410 This option is not used when 'paste' is set.
1411 NOTE: This option is reset when 'compatible' is set.
1412
1413 *'cinkeys'* *'cink'*
1414'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1415 local to buffer
1416 {not in Vi}
1417 {not available when compiled without the |+cindent|
1418 feature}
1419 A list of keys that, when typed in Insert mode, cause reindenting of
1420 the current line. Only used if 'cindent' is on and 'indentexpr' is
1421 empty.
1422 For the format of this option see |cinkeys-format|.
1423 See |C-indenting|.
1424
1425 *'cinoptions'* *'cino'*
1426'cinoptions' 'cino' string (default "")
1427 local to buffer
1428 {not in Vi}
1429 {not available when compiled without the |+cindent|
1430 feature}
1431 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1432 program. See |cinoptions-values| for the values of this option, and
1433 |C-indenting| for info on C indenting in general.
1434
1435
1436 *'cinwords'* *'cinw'*
1437'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1438 local to buffer
1439 {not in Vi}
1440 {not available when compiled without both the
1441 |+cindent| and the |+smartindent| features}
1442 These keywords start an extra indent in the next line when
1443 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1444 an appropriate place (inside {}).
1445 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1446 matter, include the keyword both the uppercase and lowercase:
1447 "if,If,IF".
1448
1449 *'clipboard'* *'cb'*
1450'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1451 for X-windows, "" otherwise)
1452 global
1453 {not in Vi}
1454 {only in GUI versions or when the |+xterm_clipboard|
1455 feature is included}
1456 This option is a list of comma separated names.
1457 These names are recognized:
1458
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001459 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 unnamed When included, Vim will use the clipboard register '*'
1461 for all yank, delete, change and put operations which
1462 would normally go to the unnamed register. When a
1463 register is explicitly specified, it will always be
1464 used regardless of whether "unnamed" is in 'clipboard'
1465 or not. The clipboard register can always be
1466 explicitly accessed using the "* notation. Also see
1467 |gui-clipboard|.
1468
Bram Moolenaar30b65812012-07-12 22:01:11 +02001469 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001470 unnamedplus A variant of the "unnamed" flag which uses the
1471 clipboard register '+' (|quoteplus|) instead of
1472 register '*' for all yank, delete, change and put
1473 operations which would normally go to the unnamed
1474 register. When "unnamed" is also included to the
1475 option, yank operations (but not delete, change or
1476 put) will additionally copy the text into register
1477 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001478 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001479 Availability can be checked with: >
1480 if has('unnamedplus')
1481<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001482 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 autoselect Works like the 'a' flag in 'guioptions': If present,
1484 then whenever Visual mode is started, or the Visual
1485 area extended, Vim tries to become the owner of the
1486 windowing system's global selection or put the
1487 selected text on the clipboard used by the selection
1488 register "*. See |guioptions_a| and |quotestar| for
1489 details. When the GUI is active, the 'a' flag in
1490 'guioptions' is used, when the GUI is not active, this
1491 "autoselect" flag is used.
1492 Also applies to the modeless selection.
1493
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001494 *clipboard-autoselectplus*
1495 autoselectplus Like "autoselect" but using the + register instead of
1496 the * register. Compare to the 'P' flag in
1497 'guioptions'.
1498
1499 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500 autoselectml Like "autoselect", but for the modeless selection
1501 only. Compare to the 'A' flag in 'guioptions'.
1502
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001503 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001504 html When the clipboard contains HTML, use this when
1505 pasting. When putting text on the clipboard, mark it
1506 as HTML. This works to copy rendered HTML from
1507 Firefox, paste it as raw HTML in Vim, select the HTML
1508 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001509 You probably want to add this only temporarily,
1510 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001511 Only supported for GTK version 2 and later.
1512 Only available with the |+multi_byte| feature.
1513
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001514 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001515 exclude:{pattern}
1516 Defines a pattern that is matched against the name of
1517 the terminal 'term'. If there is a match, no
1518 connection will be made to the X server. This is
1519 useful in this situation:
1520 - Running Vim in a console.
1521 - $DISPLAY is set to start applications on another
1522 display.
1523 - You do not want to connect to the X server in the
1524 console, but do want this in a terminal emulator.
1525 To never connect to the X server use: >
1526 exclude:.*
1527< This has the same effect as using the |-X| argument.
1528 Note that when there is no connection to the X server
1529 the window title won't be restored and the clipboard
1530 cannot be accessed.
1531 The value of 'magic' is ignored, {pattern} is
1532 interpreted as if 'magic' was on.
1533 The rest of the option value will be used for
1534 {pattern}, this must be the last entry.
1535
1536 *'cmdheight'* *'ch'*
1537'cmdheight' 'ch' number (default 1)
1538 global
1539 {not in Vi}
1540 Number of screen lines to use for the command-line. Helps avoiding
1541 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001542 The value of this option is stored with the tab page, so that each tab
1543 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544
1545 *'cmdwinheight'* *'cwh'*
1546'cmdwinheight' 'cwh' number (default 7)
1547 global
1548 {not in Vi}
1549 {not available when compiled without the |+vertsplit|
1550 feature}
1551 Number of screen lines to use for the command-line window. |cmdwin|
1552
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001553 *'colorcolumn'* *'cc'*
1554'colorcolumn' 'cc' string (default "")
1555 local to window
1556 {not in Vi}
1557 {not available when compiled without the |+syntax|
1558 feature}
1559 'colorcolumn' is a comma separated list of screen columns that are
1560 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1561 text. Will make screen redrawing slower.
1562 The screen column can be an absolute number, or a number preceded with
1563 '+' or '-', which is added to or subtracted from 'textwidth'. >
1564
1565 :set cc=+1 " highlight column after 'textwidth'
1566 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1567 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1568<
1569 When 'textwidth' is zero then the items with '-' and '+' are not used.
1570 A maximum of 256 columns are highlighted.
1571
Bram Moolenaar071d4272004-06-13 20:20:40 +00001572 *'columns'* *'co'* *E594*
1573'columns' 'co' number (default 80 or terminal width)
1574 global
1575 {not in Vi}
1576 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001577 initialization and does not have to be set by hand. Also see
1578 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 When Vim is running in the GUI or in a resizable window, setting this
1580 option will cause the window size to be changed. When you only want
1581 to use the size for the GUI, put the command in your |gvimrc| file.
1582 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001583 number of columns of the display, the display may be messed up. For
1584 the GUI it is always possible and Vim limits the number of columns to
1585 what fits on the screen. You can use this command to get the widest
1586 window possible: >
1587 :set columns=9999
1588< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589
1590 *'comments'* *'com'* *E524* *E525*
1591'comments' 'com' string (default
1592 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1593 local to buffer
1594 {not in Vi}
1595 {not available when compiled without the |+comments|
1596 feature}
1597 A comma separated list of strings that can start a comment line. See
1598 |format-comments|. See |option-backslash| about using backslashes to
1599 insert a space.
1600
1601 *'commentstring'* *'cms'* *E537*
1602'commentstring' 'cms' string (default "/*%s*/")
1603 local to buffer
1604 {not in Vi}
1605 {not available when compiled without the |+folding|
1606 feature}
1607 A template for a comment. The "%s" in the value is replaced with the
1608 comment text. Currently only used to add markers for folding, see
1609 |fold-marker|.
1610
1611 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001612'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1613 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 global
1615 {not in Vi}
1616 This option has the effect of making Vim either more Vi-compatible, or
1617 make Vim behave in a more useful way.
1618 This is a special kind of option, because when it's set or reset,
1619 other options are also changed as a side effect. CAREFUL: Setting or
1620 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001621 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622 set this option in your vimrc file, you should probably put it at the
1623 very start.
1624 By default this option is on and the Vi defaults are used for the
1625 options. This default was chosen for those people who want to use Vim
1626 just like Vi, and don't even (want to) know about the 'compatible'
1627 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001628 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001629 this option is switched off, and all options that have not been
1630 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001631 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001632 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001633 happen for the system-wide vimrc or gvimrc file, nor for a file given
1634 with the |-u| argument). Also see |compatible-default| and
1635 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 You can also set this option with the "-C" argument, and reset it with
1637 "-N". See |-C| and |-N|.
1638 Switching this option off makes the Vim defaults be used for options
1639 that have a different Vi and Vim default value. See the options
1640 marked with a '+' below. Other options are not modified.
1641 At the moment this option is set, several other options will be set
1642 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001643 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 editing.
1645 See also 'cpoptions'.
1646
1647 option + set value effect ~
1648
1649 'allowrevins' off no CTRL-_ command
1650 'backupcopy' Unix: "yes" backup file is a copy
1651 others: "auto" copy or rename backup file
1652 'backspace' "" normal backspace
1653 'backup' off no backup file
1654 'cindent' off no C code indentation
1655 'cedit' + "" no key to open the |cmdwin|
1656 'cpoptions' + (all flags) Vi-compatible flags
1657 'cscopetag' off don't use cscope for ":tag"
1658 'cscopetagorder' 0 see |cscopetagorder|
1659 'cscopeverbose' off see |cscopeverbose|
1660 'digraph' off no digraphs
1661 'esckeys' + off no <Esc>-keys in Insert mode
1662 'expandtab' off tabs not expanded to spaces
1663 'fileformats' + "" no automatic file format detection,
1664 "dos,unix" except for DOS, Windows and OS/2
1665 'formatoptions' + "vt" Vi compatible formatting
1666 'gdefault' off no default 'g' flag for ":s"
1667 'history' + 0 no commandline history
1668 'hkmap' off no Hebrew keyboard mapping
1669 'hkmapp' off no phonetic Hebrew keyboard mapping
1670 'hlsearch' off no highlighting of search matches
1671 'incsearch' off no incremental searching
1672 'indentexpr' "" no indenting by expression
1673 'insertmode' off do not start in Insert mode
1674 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1675 characters and '_'
1676 'joinspaces' on insert 2 spaces after period
1677 'modeline' + off no modelines
1678 'more' + off no pauses in listings
1679 'revins' off no reverse insert
1680 'ruler' off no ruler
1681 'scrolljump' 1 no jump scroll
1682 'scrolloff' 0 no scroll offset
1683 'shiftround' off indent not rounded to shiftwidth
1684 'shortmess' + "" no shortening of messages
1685 'showcmd' + off command characters not shown
1686 'showmode' + off current mode not shown
1687 'smartcase' off no automatic ignore case switch
1688 'smartindent' off no smart indentation
1689 'smarttab' off no smart tab size
1690 'softtabstop' 0 tabs are always 'tabstop' positions
1691 'startofline' on goto startofline with some commands
1692 'tagrelative' + off tag file names are not relative
1693 'textauto' + off no automatic textmode detection
1694 'textwidth' 0 no automatic line wrap
1695 'tildeop' off tilde is not an operator
1696 'ttimeout' off no terminal timeout
1697 'whichwrap' + "" left-right movements don't wrap
1698 'wildchar' + CTRL-E only when the current value is <Tab>
1699 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001700 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701
1702 *'complete'* *'cpt'* *E535*
1703'complete' 'cpt' string (default: ".,w,b,u,t,i")
1704 local to buffer
1705 {not in Vi}
1706 This option specifies how keyword completion |ins-completion| works
1707 when CTRL-P or CTRL-N are used. It is also used for whole-line
1708 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1709 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001710 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 w scan buffers from other windows
1712 b scan other loaded buffers that are in the buffer list
1713 u scan the unloaded buffers that are in the buffer list
1714 U scan the buffers that are not in the buffer list
1715 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001716 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 k{dict} scan the file {dict}. Several "k" flags can be given,
1718 patterns are valid too. For example: >
1719 :set cpt=k/usr/dict/*,k~/spanish
1720< s scan the files given with the 'thesaurus' option
1721 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1722 are valid too.
1723 i scan current and included files
1724 d scan current and included files for defined name or macro
1725 |i_CTRL-X_CTRL-D|
1726 ] tag completion
1727 t same as "]"
1728
1729 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1730 not executed, this may lead to unexpected completions from some files
1731 (gzipped files for example). Unloaded buffers are not scanned for
1732 whole-line completion.
1733
1734 The default is ".,w,b,u,t,i", which means to scan:
1735 1. the current buffer
1736 2. buffers in other windows
1737 3. other loaded buffers
1738 4. unloaded buffers
1739 5. tags
1740 6. included files
1741
1742 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001743 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1744 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001746 *'completefunc'* *'cfu'*
1747'completefunc' 'cfu' string (default: empty)
1748 local to buffer
1749 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001750 {not available when compiled without the |+eval|
1751 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001752 This option specifies a function to be used for Insert mode completion
1753 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001754 See |complete-functions| for an explanation of how the function is
1755 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001756 This option cannot be set from a |modeline| or in the |sandbox|, for
1757 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001758
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001759 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001760'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001761 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001762 {not available when compiled without the
1763 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001764 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001765 A comma separated list of options for Insert mode completion
1766 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001767
1768 menu Use a popup menu to show the possible completions. The
1769 menu is only shown when there is more than one match and
1770 sufficient colors are available. |ins-completion-menu|
1771
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001772 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001773 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001774 match, e.g., what file it comes from.
1775
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001776 longest Only insert the longest common text of the matches. If
1777 the menu is displayed you can use CTRL-L to add more
1778 characters. Whether case is ignored depends on the kind
1779 of completion. For buffer text the 'ignorecase' option is
1780 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001781
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001782 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001783 completion in the preview window. Only works in
1784 combination with "menu" or "menuone".
1785
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001786
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001787 *'concealcursor'* *'cocu'*
1788'concealcursor' 'cocu' string (default: "")
1789 local to window
1790 {not in Vi}
1791 {not available when compiled without the |+conceal|
1792 feature}
1793 Sets the modes in which text in the cursor line can also be concealed.
1794 When the current mode is listed then concealing happens just like in
1795 other lines.
1796 n Normal mode
1797 v Visual mode
1798 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001799 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001800
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001801 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001802 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001803 are moving around text is concealed, but when starting to insert text
1804 or selecting a Visual area the concealed text is displayed, so that
1805 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001806 Keep in mind that the cursor position is not always where it's
1807 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001808
1809
1810'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001811 number (default 0)
1812 local to window
1813 {not in Vi}
1814 {not available when compiled without the |+conceal|
1815 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001816 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1817 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001818
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001819 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001820 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001821 1 Each block of concealed text is replaced with one
1822 character. If the syntax item does not have a custom
1823 replacement character defined (see |:syn-cchar|) the
1824 character defined in 'listchars' is used (default is a
1825 space).
1826 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001827 2 Concealed text is completely hidden unless it has a
1828 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001829 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001830 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001831
Bram Moolenaara7781e02010-07-19 20:13:22 +02001832 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001833 edit and copy the text. This can be changed with the 'concealcursor'
1834 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001835
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1837'confirm' 'cf' boolean (default off)
1838 global
1839 {not in Vi}
1840 When 'confirm' is on, certain operations that would normally
1841 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1842 instead raise a |dialog| asking if you wish to save the current
1843 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1844 If 'confirm' is off you can still activate confirmation for one
1845 command only (this is most useful in mappings) with the |:confirm|
1846 command.
1847 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1848
1849 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1850'conskey' 'consk' boolean (default off)
1851 global
1852 {not in Vi} {only for MS-DOS}
1853 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001854 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 three methods of console input are available:
1856 'conskey' 'bioskey' action ~
1857 on on or off direct console input
1858 off on BIOS
1859 off off STDIN
1860
1861 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1862'copyindent' 'ci' boolean (default off)
1863 local to buffer
1864 {not in Vi}
1865 Copy the structure of the existing lines indent when autoindenting a
1866 new line. Normally the new indent is reconstructed by a series of
1867 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1868 in which case only spaces are used). Enabling this option makes the
1869 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001870 existing line. 'expandtab' has no effect on these characters, a Tab
1871 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 line, the remaining space is filled in the normal manner.
1873 NOTE: 'copyindent' is reset when 'compatible' is set.
1874 Also see 'preserveindent'.
1875
1876 *'cpoptions'* *'cpo'*
1877'cpoptions' 'cpo' string (Vim default: "aABceFs",
1878 Vi default: all flags)
1879 global
1880 {not in Vi}
1881 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001882 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 not being vi-compatible is mostly or sometimes preferred.
1884 'cpoptions' stands for "compatible-options".
1885 Commas can be added for readability.
1886 To avoid problems with flags that are added in the future, use the
1887 "+=" and "-=" feature of ":set" |add-option-flags|.
1888 NOTE: This option is set to the Vi default value when 'compatible' is
1889 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001890 NOTE: This option is set to the POSIX default value at startup when
1891 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001892 variable exists |posix|. This means Vim tries to behave like the
1893 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894
1895 contains behavior ~
1896 *cpo-a*
1897 a When included, a ":read" command with a file name
1898 argument will set the alternate file name for the
1899 current window.
1900 *cpo-A*
1901 A When included, a ":write" command with a file name
1902 argument will set the alternate file name for the
1903 current window.
1904 *cpo-b*
1905 b "\|" in a ":map" command is recognized as the end of
1906 the map command. The '\' is included in the mapping,
1907 the text after the '|' is interpreted as the next
1908 command. Use a CTRL-V instead of a backslash to
1909 include the '|' in the mapping. Applies to all
1910 mapping, abbreviation, menu and autocmd commands.
1911 See also |map_bar|.
1912 *cpo-B*
1913 B A backslash has no special meaning in mappings,
1914 abbreviations and the "to" part of the menu commands.
1915 Remove this flag to be able to use a backslash like a
1916 CTRL-V. For example, the command ":map X \<Esc>"
1917 results in X being mapped to:
1918 'B' included: "\^[" (^[ is a real <Esc>)
1919 'B' excluded: "<Esc>" (5 characters)
1920 ('<' excluded in both cases)
1921 *cpo-c*
1922 c Searching continues at the end of any match at the
1923 cursor position, but not further than the start of the
1924 next line. When not present searching continues
1925 one character from the cursor position. With 'c'
1926 "abababababab" only gets three matches when repeating
1927 "/abab", without 'c' there are five matches.
1928 *cpo-C*
1929 C Do not concatenate sourced lines that start with a
1930 backslash. See |line-continuation|.
1931 *cpo-d*
1932 d Using "./" in the 'tags' option doesn't mean to use
1933 the tags file relative to the current file, but the
1934 tags file in the current directory.
1935 *cpo-D*
1936 D Can't use CTRL-K to enter a digraph after Normal mode
1937 commands with a character argument, like |r|, |f| and
1938 |t|.
1939 *cpo-e*
1940 e When executing a register with ":@r", always add a
1941 <CR> to the last line, also when the register is not
1942 linewise. If this flag is not present, the register
1943 is not linewise and the last line does not end in a
1944 <CR>, then the last line is put on the command-line
1945 and can be edited before hitting <CR>.
1946 *cpo-E*
1947 E It is an error when using "y", "d", "c", "g~", "gu" or
1948 "gU" on an Empty region. The operators only work when
1949 at least one character is to be operate on. Example:
1950 This makes "y0" fail in the first column.
1951 *cpo-f*
1952 f When included, a ":read" command with a file name
1953 argument will set the file name for the current buffer,
1954 if the current buffer doesn't have a file name yet.
1955 *cpo-F*
1956 F When included, a ":write" command with a file name
1957 argument will set the file name for the current
1958 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001959 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 *cpo-g*
1961 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001962 *cpo-H*
1963 H When using "I" on a line with only blanks, insert
1964 before the last blank. Without this flag insert after
1965 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 *cpo-i*
1967 i When included, interrupting the reading of a file will
1968 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001969 *cpo-I*
1970 I When moving the cursor up or down just after inserting
1971 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 *cpo-j*
1973 j When joining lines, only add two spaces after a '.',
1974 not after '!' or '?'. Also see 'joinspaces'.
1975 *cpo-J*
1976 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001977 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 white space.
1979 *cpo-k*
1980 k Disable the recognition of raw key codes in
1981 mappings, abbreviations, and the "to" part of menu
1982 commands. For example, if <Key> sends ^[OA (where ^[
1983 is <Esc>), the command ":map X ^[OA" results in X
1984 being mapped to:
1985 'k' included: "^[OA" (3 characters)
1986 'k' excluded: "<Key>" (one key code)
1987 Also see the '<' flag below.
1988 *cpo-K*
1989 K Don't wait for a key code to complete when it is
1990 halfway a mapping. This breaks mapping <F1><F1> when
1991 only part of the second <F1> has been read. It
1992 enables cancelling the mapping by typing <F1><Esc>.
1993 *cpo-l*
1994 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001995 literally, only "\]", "\^", "\-" and "\\" are special.
1996 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1998 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001999 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 *cpo-L*
2001 L When the 'list' option is set, 'wrapmargin',
2002 'textwidth', 'softtabstop' and Virtual Replace mode
2003 (see |gR|) count a <Tab> as two characters, instead of
2004 the normal behavior of a <Tab>.
2005 *cpo-m*
2006 m When included, a showmatch will always wait half a
2007 second. When not included, a showmatch will wait half
2008 a second or until a character is typed. |'showmatch'|
2009 *cpo-M*
2010 M When excluded, "%" matching will take backslashes into
2011 account. Thus in "( \( )" and "\( ( \)" the outer
2012 parenthesis match. When included "%" ignores
2013 backslashes, which is Vi compatible.
2014 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002015 n When included, the column used for 'number' and
2016 'relativenumber' will also be used for text of wrapped
2017 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 *cpo-o*
2019 o Line offset to search command is not remembered for
2020 next search.
2021 *cpo-O*
2022 O Don't complain if a file is being overwritten, even
2023 when it didn't exist when editing it. This is a
2024 protection against a file unexpectedly created by
2025 someone else. Vi didn't complain about this.
2026 *cpo-p*
2027 p Vi compatible Lisp indenting. When not present, a
2028 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002029 *cpo-P*
2030 P When included, a ":write" command that appends to a
2031 file will set the file name for the current buffer, if
2032 the current buffer doesn't have a file name yet and
2033 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002034 *cpo-q*
2035 q When joining multiple lines leave the cursor at the
2036 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 *cpo-r*
2038 r Redo ("." command) uses "/" to repeat a search
2039 command, instead of the actually used search string.
2040 *cpo-R*
2041 R Remove marks from filtered lines. Without this flag
2042 marks are kept like |:keepmarks| was used.
2043 *cpo-s*
2044 s Set buffer options when entering the buffer for the
2045 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002046 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 set when the buffer is created.
2048 *cpo-S*
2049 S Set buffer options always when entering a buffer
2050 (except 'readonly', 'fileformat', 'filetype' and
2051 'syntax'). This is the (most) Vi compatible setting.
2052 The options are set to the values in the current
2053 buffer. When you change an option and go to another
2054 buffer, the value is copied. Effectively makes the
2055 buffer options global to all buffers.
2056
2057 's' 'S' copy buffer options
2058 no no when buffer created
2059 yes no when buffer first entered (default)
2060 X yes each time when buffer entered (vi comp.)
2061 *cpo-t*
2062 t Search pattern for the tag command is remembered for
2063 "n" command. Otherwise Vim only puts the pattern in
2064 the history for search pattern, but doesn't change the
2065 last used search pattern.
2066 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002067 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 *cpo-v*
2069 v Backspaced characters remain visible on the screen in
2070 Insert mode. Without this flag the characters are
2071 erased from the screen right away. With this flag the
2072 screen newly typed text overwrites backspaced
2073 characters.
2074 *cpo-w*
2075 w When using "cw" on a blank character, only change one
2076 character and not all blanks until the start of the
2077 next word.
2078 *cpo-W*
2079 W Don't overwrite a readonly file. When omitted, ":w!"
2080 overwrites a readonly file, if possible.
2081 *cpo-x*
2082 x <Esc> on the command-line executes the command-line.
2083 The default in Vim is to abandon the command-line,
2084 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002085 *cpo-X*
2086 X When using a count with "R" the replaced text is
2087 deleted only once. Also when repeating "R" with "."
2088 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 *cpo-y*
2090 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002091 *cpo-Z*
2092 Z When using "w!" while the 'readonly' option is set,
2093 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 *cpo-!*
2095 ! When redoing a filter command, use the last used
2096 external command, whatever it was. Otherwise the last
2097 used -filter- command is used.
2098 *cpo-$*
2099 $ When making a change to one line, don't redisplay the
2100 line, but put a '$' at the end of the changed text.
2101 The changed text will be overwritten when you type the
2102 new text. The line is redisplayed if you type any
2103 command that moves the cursor from the insertion
2104 point.
2105 *cpo-%*
2106 % Vi-compatible matching is done for the "%" command.
2107 Does not recognize "#if", "#endif", etc.
2108 Does not recognize "/*" and "*/".
2109 Parens inside single and double quotes are also
2110 counted, causing a string that contains a paren to
2111 disturb the matching. For example, in a line like
2112 "if (strcmp("foo(", s))" the first paren does not
2113 match the last one. When this flag is not included,
2114 parens inside single and double quotes are treated
2115 specially. When matching a paren outside of quotes,
2116 everything inside quotes is ignored. When matching a
2117 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002118 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002119 This flag is also used for other features, such as
2120 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002121 *cpo--*
2122 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002123 it would go above the first line or below the last
2124 line. Without it the cursor moves to the first or
2125 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002126 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002127 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002128 *cpo-+*
2129 + When included, a ":write file" command will reset the
2130 'modified' flag of the buffer, even though the buffer
2131 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002132 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002133 * Use ":*" in the same way as ":@". When not included,
2134 ":*" is an alias for ":'<,'>", select the Visual area.
2135 *cpo-<*
2136 < Disable the recognition of special key codes in |<>|
2137 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002138 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139 ":map X <Tab>" results in X being mapped to:
2140 '<' included: "<Tab>" (5 characters)
2141 '<' excluded: "^I" (^I is a real <Tab>)
2142 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002143 *cpo->*
2144 > When appending to a register, put a line break before
2145 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002146 *cpo-;*
2147 ; When using |,| or |;| to repeat the last |t| search
2148 and the cursor is right in front of the searched
2149 character, the cursor won't move. When not included,
2150 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002151 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002152
2153 POSIX flags. These are not included in the Vi default value, except
2154 when $VIM_POSIX was set on startup. |posix|
2155
2156 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002157 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002158 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002159 *cpo-&*
2160 & When ":preserve" was used keep the swap file when
2161 exiting normally while this buffer is still loaded.
2162 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002163 *cpo-\*
2164 \ Backslash in a [] range in a search pattern is taken
2165 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002166 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2167 '\' excluded: "/[ \-]" finds <Space> and '-'
2168 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002169 *cpo-/*
2170 / When "%" is used as the replacement string in a |:s|
2171 command, use the previous replacement string. |:s%|
2172 *cpo-{*
2173 { The |{| and |}| commands also stop at a "{" character
2174 at the start of a line.
2175 *cpo-.*
2176 . The ":chdir" and ":cd" commands fail if the current
2177 buffer is modified, unless ! is used. Vim doesn't
2178 need this, since it remembers the full path of an
2179 opened file.
2180 *cpo-bar*
2181 | The value of the $LINES and $COLUMNS environment
2182 variables overrule the terminal size values obtained
2183 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002184
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002186 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002187'cryptmethod' string (default "zip")
2188 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002189 {not in Vi}
2190 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002191 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002192 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002193 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002194 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002195 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002196 or later, files can NOT be read by Vim 7.2 and older.
2197 This adds a "seed" to the file, every time you write
2198 the file the encrypted bytes will be different.
2199
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002200 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002201 to the detected method of the file being read. Thus if you write it
2202 without changing 'cryptmethod' the same method will be used.
2203 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002204 explicitly write it, you don't get a warning unless there are other
2205 modifications. Also see |:X|.
2206
2207 When setting the global value to an empty string, it will end up with
2208 the value "zip". When setting the local value to an empty string the
2209 buffer will use the global value.
2210
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002211 When a new encryption method is added in a later version of Vim, and
2212 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002213 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002214
2215
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 *'cscopepathcomp'* *'cspc'*
2217'cscopepathcomp' 'cspc' number (default 0)
2218 global
2219 {not available when compiled without the |+cscope|
2220 feature}
2221 {not in Vi}
2222 Determines how many components of the path to show in a list of tags.
2223 See |cscopepathcomp|.
2224
2225 *'cscopeprg'* *'csprg'*
2226'cscopeprg' 'csprg' string (default "cscope")
2227 global
2228 {not available when compiled without the |+cscope|
2229 feature}
2230 {not in Vi}
2231 Specifies the command to execute cscope. See |cscopeprg|.
2232 This option cannot be set from a |modeline| or in the |sandbox|, for
2233 security reasons.
2234
2235 *'cscopequickfix'* *'csqf'*
2236'cscopequickfix' 'csqf' string (default "")
2237 global
2238 {not available when compiled without the |+cscope|
2239 or |+quickfix| features}
2240 {not in Vi}
2241 Specifies whether to use quickfix window to show cscope results.
2242 See |cscopequickfix|.
2243
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002244 *'cscoperelative'* *'csre'*
2245'cscoperelative' 'csre' boolean (default off)
2246 global
2247 {not available when compiled without the |+cscope|
2248 feature}
2249 {not in Vi}
2250 In the absence of a prefix (-P) for cscope. setting this option enables
2251 to use the basename of cscope.out path as the prefix.
2252 See |cscoperelative|.
2253
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2255'cscopetag' 'cst' boolean (default off)
2256 global
2257 {not available when compiled without the |+cscope|
2258 feature}
2259 {not in Vi}
2260 Use cscope for tag commands. See |cscope-options|.
2261 NOTE: This option is reset when 'compatible' is set.
2262
2263 *'cscopetagorder'* *'csto'*
2264'cscopetagorder' 'csto' number (default 0)
2265 global
2266 {not available when compiled without the |+cscope|
2267 feature}
2268 {not in Vi}
2269 Determines the order in which ":cstag" performs a search. See
2270 |cscopetagorder|.
2271 NOTE: This option is set to 0 when 'compatible' is set.
2272
2273 *'cscopeverbose'* *'csverb'*
2274 *'nocscopeverbose'* *'nocsverb'*
2275'cscopeverbose' 'csverb' boolean (default off)
2276 global
2277 {not available when compiled without the |+cscope|
2278 feature}
2279 {not in Vi}
2280 Give messages when adding a cscope database. See |cscopeverbose|.
2281 NOTE: This option is reset when 'compatible' is set.
2282
Bram Moolenaar860cae12010-06-05 23:22:07 +02002283 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2284'cursorbind' 'crb' boolean (default off)
2285 local to window
2286 {not in Vi}
2287 {not available when compiled without the |+cursorbind|
2288 feature}
2289 When this option is set, as the cursor in the current
2290 window moves other cursorbound windows (windows that also have
2291 this option set) move their cursors to the corresponding line and
2292 column. This option is useful for viewing the
2293 differences between two versions of a file (see 'diff'); in diff mode,
2294 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002295 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002296
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002297
2298 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2299'cursorcolumn' 'cuc' boolean (default off)
2300 local to window
2301 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002302 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002303 feature}
2304 Highlight the screen column of the cursor with CursorColumn
2305 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2306 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002307 If you only want the highlighting in the current window you can use
2308 these autocommands: >
2309 au WinLeave * set nocursorline nocursorcolumn
2310 au WinEnter * set cursorline cursorcolumn
2311<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002312
2313 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2314'cursorline' 'cul' boolean (default off)
2315 local to window
2316 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002317 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002318 feature}
2319 Highlight the screen line of the cursor with CursorLine
2320 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2321 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002322 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002323 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002324
2325
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 *'debug'*
2327'debug' string (default "")
2328 global
2329 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002330 These values can be used:
2331 msg Error messages that would otherwise be omitted will be given
2332 anyway.
2333 throw Error messages that would otherwise be omitted will be given
2334 anyway and also throw an exception and set |v:errmsg|.
2335 beep A message will be given when otherwise only a beep would be
2336 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002337 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002338 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2339 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340
2341 *'define'* *'def'*
2342'define' 'def' string (default "^\s*#\s*define")
2343 global or local to buffer |global-local|
2344 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002345 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 pattern, just like for the "/" command. This option is used for the
2347 commands like "[i" and "[d" |include-search|. The 'isident' option is
2348 used to recognize the defined name after the match:
2349 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2350 See |option-backslash| about inserting backslashes to include a space
2351 or backslash.
2352 The default value is for C programs. For C++ this value would be
2353 useful, to include const type declarations: >
2354 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2355< When using the ":set" command, you need to double the backslashes!
2356
2357 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2358'delcombine' 'deco' boolean (default off)
2359 global
2360 {not in Vi}
2361 {only available when compiled with the |+multi_byte|
2362 feature}
2363 If editing Unicode and this option is set, backspace and Normal mode
2364 "x" delete each combining character on its own. When it is off (the
2365 default) the character along with its combining characters are
2366 deleted.
2367 Note: When 'delcombine' is set "xx" may work different from "2x"!
2368
2369 This is useful for Arabic, Hebrew and many other languages where one
2370 may have combining characters overtop of base characters, and want
2371 to remove only the combining ones.
2372
2373 *'dictionary'* *'dict'*
2374'dictionary' 'dict' string (default "")
2375 global or local to buffer |global-local|
2376 {not in Vi}
2377 List of file names, separated by commas, that are used to lookup words
2378 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2379 contain a list of words. This can be one word per line, or several
2380 words per line, separated by non-keyword characters (white space is
2381 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002382 When this option is empty, or an entry "spell" is present, spell
2383 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002384 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 after a comma are ignored, otherwise spaces are included in the file
2386 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002387 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 Where to find a list of words?
2389 - On FreeBSD, there is the file "/usr/share/dict/words".
2390 - In the Simtel archive, look in the "msdos/linguist" directory.
2391 - In "miscfiles" of the GNU collection.
2392 The use of |:set+=| and |:set-=| is preferred when adding or removing
2393 directories from the list. This avoids problems when a future version
2394 uses another default.
2395 Backticks cannot be used in this option for security reasons.
2396
2397 *'diff'* *'nodiff'*
2398'diff' boolean (default off)
2399 local to window
2400 {not in Vi}
2401 {not available when compiled without the |+diff|
2402 feature}
2403 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002404 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405
2406 *'dex'* *'diffexpr'*
2407'diffexpr' 'dex' string (default "")
2408 global
2409 {not in Vi}
2410 {not available when compiled without the |+diff|
2411 feature}
2412 Expression which is evaluated to obtain an ed-style diff file from two
2413 versions of a file. See |diff-diffexpr|.
2414 This option cannot be set from a |modeline| or in the |sandbox|, for
2415 security reasons.
2416
2417 *'dip'* *'diffopt'*
2418'diffopt' 'dip' string (default "filler")
2419 global
2420 {not in Vi}
2421 {not available when compiled without the |+diff|
2422 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002423 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 All are optional. Items must be separated by a comma.
2425
2426 filler Show filler lines, to keep the text
2427 synchronized with a window that has inserted
2428 lines at the same position. Mostly useful
2429 when windows are side-by-side and 'scrollbind'
2430 is set.
2431
2432 context:{n} Use a context of {n} lines between a change
2433 and a fold that contains unchanged lines.
2434 When omitted a context of six lines is used.
2435 See |fold-diff|.
2436
2437 icase Ignore changes in case of text. "a" and "A"
2438 are considered the same. Adds the "-i" flag
2439 to the "diff" command if 'diffexpr' is empty.
2440
2441 iwhite Ignore changes in amount of white space. Adds
2442 the "-b" flag to the "diff" command if
2443 'diffexpr' is empty. Check the documentation
2444 of the "diff" command for what this does
2445 exactly. It should ignore adding trailing
2446 white space, but not leading white space.
2447
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002448 horizontal Start diff mode with horizontal splits (unless
2449 explicitly specified otherwise).
2450
2451 vertical Start diff mode with vertical splits (unless
2452 explicitly specified otherwise).
2453
2454 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2455 starting diff mode. Without this 2 is used.
2456
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 Examples: >
2458
2459 :set diffopt=filler,context:4
2460 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002461 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462<
2463 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2464'digraph' 'dg' boolean (default off)
2465 global
2466 {not in Vi}
2467 {not available when compiled without the |+digraphs|
2468 feature}
2469 Enable the entering of digraphs in Insert mode with {char1} <BS>
2470 {char2}. See |digraphs|.
2471 NOTE: This option is reset when 'compatible' is set.
2472
2473 *'directory'* *'dir'*
2474'directory' 'dir' string (default for Amiga: ".,t:",
2475 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2476 for Unix: ".,~/tmp,/var/tmp,/tmp")
2477 global
2478 List of directory names for the swap file, separated with commas.
2479 - The swap file will be created in the first directory where this is
2480 possible.
2481 - Empty means that no swap file will be used (recovery is
2482 impossible!).
2483 - A directory "." means to put the swap file in the same directory as
2484 the edited file. On Unix, a dot is prepended to the file name, so
2485 it doesn't show in a directory listing. On MS-Windows the "hidden"
2486 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002487 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 put the swap file relative to where the edited file is. The leading
2489 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002490 - For Unix and Win32, if a directory ends in two path separators "//"
2491 or "\\", the swap file name will be built from the complete path to
2492 the file with all path separators substituted to percent '%' signs.
2493 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002494 On Win32, when a separating comma is following, you must use "//",
2495 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496 - Spaces after the comma are ignored, other spaces are considered part
2497 of the directory name. To have a space at the start of a directory
2498 name, precede it with a backslash.
2499 - To include a comma in a directory name precede it with a backslash.
2500 - A directory name may end in an ':' or '/'.
2501 - Environment variables are expanded |:set_env|.
2502 - Careful with '\' characters, type one before a space, type two to
2503 get one in the option (see |option-backslash|), for example: >
2504 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2505< - For backwards compatibility with Vim version 3.0 a '>' at the start
2506 of the option is removed.
2507 Using "." first in the list is recommended. This means that editing
2508 the same file twice will result in a warning. Using "/tmp" on Unix is
2509 discouraged: When the system crashes you lose the swap file.
2510 "/var/tmp" is often not cleared when rebooting, thus is a better
2511 choice than "/tmp". But it can contain a lot of files, your swap
2512 files get lost in the crowd. That is why a "tmp" directory in your
2513 home directory is tried first.
2514 The use of |:set+=| and |:set-=| is preferred when adding or removing
2515 directories from the list. This avoids problems when a future version
2516 uses another default.
2517 This option cannot be set from a |modeline| or in the |sandbox|, for
2518 security reasons.
2519 {Vi: directory to put temp file in, defaults to "/tmp"}
2520
2521 *'display'* *'dy'*
2522'display' 'dy' string (default "")
2523 global
2524 {not in Vi}
2525 Change the way text is displayed. This is comma separated list of
2526 flags:
2527 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002528 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 last line that doesn't fit is replaced with "@" lines.
2530 uhex Show unprintable characters hexadecimal as <xx>
2531 instead of using ^C and ~C.
2532
2533 *'eadirection'* *'ead'*
2534'eadirection' 'ead' string (default "both")
2535 global
2536 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002537 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 feature}
2539 Tells when the 'equalalways' option applies:
2540 ver vertically, width of windows is not affected
2541 hor horizontally, height of windows is not affected
2542 both width and height of windows is affected
2543
2544 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2545'edcompatible' 'ed' boolean (default off)
2546 global
2547 Makes the 'g' and 'c' flags of the ":substitute" command to be
2548 toggled each time the flag is given. See |complex-change|. See
2549 also 'gdefault' option.
2550 Switching this option on is discouraged!
2551
2552 *'encoding'* *'enc'* *E543*
2553'encoding' 'enc' string (default: "latin1" or value from $LANG)
2554 global
2555 {only available when compiled with the |+multi_byte|
2556 feature}
2557 {not in Vi}
2558 Sets the character encoding used inside Vim. It applies to text in
2559 the buffers, registers, Strings in expressions, text stored in the
2560 viminfo file, etc. It sets the kind of characters which Vim can work
2561 with. See |encoding-names| for the possible values.
2562
2563 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002564 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002566 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567
Bram Moolenaar865242e2010-07-14 21:12:05 +02002568 This option cannot be set from a |modeline|. It would most likely
2569 corrupt the text.
2570
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2572 "utf-8". Although care has been taken to allow different values of
2573 'encoding', "utf-8" is the natural choice for the environment and
2574 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002575 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576 versions, and to avoid changing the encoding of newly created files
2577 without your knowledge (in case 'fileencodings' is empty).
2578
2579 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002580 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 iconv() or as specified with 'charconvert'.
2582
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002583 If you need to know whether 'encoding' is a multi-byte encoding, you
2584 can use: >
2585 if has("multi_byte_encoding")
2586<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 Normally 'encoding' will be equal to your current locale. This will
2588 be the default if Vim recognizes your environment settings. If
2589 'encoding' is not set to the current locale, 'termencoding' must be
2590 set to convert typed and displayed text. See |encoding-table|.
2591
2592 When you set this option, it fires the |EncodingChanged| autocommand
2593 event so that you can set up fonts if necessary.
2594
2595 When the option is set, the value is converted to lowercase. Thus
2596 you can set it with uppercase values too. Underscores are translated
2597 to '-' signs.
2598 When the encoding is recognized, it is changed to the standard name.
2599 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2600 "iso-8859-2" and "utf8" becomes "utf-8".
2601
2602 Note: "latin1" is also used when the encoding could not be detected.
2603 This only works when editing files in the same encoding! When the
2604 actual character set is not latin1, make sure 'fileencoding' and
2605 'fileencodings' are empty. When conversion is needed, switch to using
2606 utf-8.
2607
2608 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2609 You don't notice this while editing, but it does matter for the
2610 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2611 setting 'encoding' to one of these values instead of utf-8 only has
2612 effect for encoding used for files when 'fileencoding' is empty.
2613
Bram Moolenaar661b1822005-07-28 22:36:45 +00002614 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2615 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002616
2617 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2618'endofline' 'eol' boolean (default on)
2619 local to buffer
2620 {not in Vi}
2621 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002622 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002623 option is automatically set when starting to edit a new file, unless
2624 the file does not have an <EOL> for the last line in the file, in
2625 which case it is reset. Normally you don't have to set or reset this
2626 option. When 'binary' is off the value is not used when writing the
2627 file. When 'binary' is on it is used to remember the presence of a
2628 <EOL> for the last line in the file, so that when you write the file
2629 the situation from the original file can be kept. But you can change
2630 it if you want to.
2631
2632 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2633'equalalways' 'ea' boolean (default on)
2634 global
2635 {not in Vi}
2636 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002637 splitting or closing a window. This also happens the moment the
2638 option is switched on. When off, splitting a window will reduce the
2639 size of the current window and leave the other windows the same. When
2640 closing a window the extra lines are given to the window next to it
2641 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 When mixing vertically and horizontally split windows, a minimal size
2643 is computed and some windows may be larger if there is room. The
2644 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002645 Changing the height and width of a window can be avoided by setting
2646 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002647 If a window size is specified when creating a new window sizes are
2648 currently not equalized (it's complicated, but may be implemented in
2649 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650
2651 *'equalprg'* *'ep'*
2652'equalprg' 'ep' string (default "")
2653 global or local to buffer |global-local|
2654 {not in Vi}
2655 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002656 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002657 or 'indentexpr'. When Vim was compiled without internal formatting,
2658 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002659 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 about including spaces and backslashes.
2661 This option cannot be set from a |modeline| or in the |sandbox|, for
2662 security reasons.
2663
2664 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2665'errorbells' 'eb' boolean (default off)
2666 global
2667 Ring the bell (beep or screen flash) for error messages. This only
2668 makes a difference for error messages, the bell will be used always
2669 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002670 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671 screen flash or do nothing.
2672
2673 *'errorfile'* *'ef'*
2674'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2675 others: "errors.err")
2676 global
2677 {not in Vi}
2678 {not available when compiled without the |+quickfix|
2679 feature}
2680 Name of the errorfile for the QuickFix mode (see |:cf|).
2681 When the "-q" command-line argument is used, 'errorfile' is set to the
2682 following argument. See |-q|.
2683 NOT used for the ":make" command. See 'makeef' for that.
2684 Environment variables are expanded |:set_env|.
2685 See |option-backslash| about including spaces and backslashes.
2686 This option cannot be set from a |modeline| or in the |sandbox|, for
2687 security reasons.
2688
2689 *'errorformat'* *'efm'*
2690'errorformat' 'efm' string (default is very long)
2691 global or local to buffer |global-local|
2692 {not in Vi}
2693 {not available when compiled without the |+quickfix|
2694 feature}
2695 Scanf-like description of the format for the lines in the error file
2696 (see |errorformat|).
2697
2698 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2699'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2700 global
2701 {not in Vi}
2702 Function keys that start with an <Esc> are recognized in Insert
2703 mode. When this option is off, the cursor and function keys cannot be
2704 used in Insert mode if they start with an <Esc>. The advantage of
2705 this is that the single <Esc> is recognized immediately, instead of
2706 after one second. Instead of resetting this option, you might want to
2707 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2708 when 'esckeys' is off, you can still map anything, but the cursor keys
2709 won't work by default.
2710 NOTE: This option is set to the Vi default value when 'compatible' is
2711 set and to the Vim default value when 'compatible' is reset.
2712
2713 *'eventignore'* *'ei'*
2714'eventignore' 'ei' string (default "")
2715 global
2716 {not in Vi}
2717 {not available when compiled without the |+autocmd|
2718 feature}
2719 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002720 When set to "all" or when "all" is one of the items, all autocommand
2721 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 Otherwise this is a comma separated list of event names. Example: >
2723 :set ei=WinEnter,WinLeave
2724<
2725 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2726'expandtab' 'et' boolean (default off)
2727 local to buffer
2728 {not in Vi}
2729 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002730 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2732 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2733 NOTE: This option is reset when 'compatible' is set.
2734
2735 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2736'exrc' 'ex' boolean (default off)
2737 global
2738 {not in Vi}
2739 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2740 directory. If you switch this option on you should also consider
2741 setting the 'secure' option (see |initialization|). Using a local
2742 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2743 also see |.vimrc| and |gui-init|.
2744 This option cannot be set from a |modeline| or in the |sandbox|, for
2745 security reasons.
2746
2747 *'fileencoding'* *'fenc'* *E213*
2748'fileencoding' 'fenc' string (default: "")
2749 local to buffer
2750 {only available when compiled with the |+multi_byte|
2751 feature}
2752 {not in Vi}
2753 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002754
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002756 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 When 'fileencoding' is empty, the same value as 'encoding' will be
2758 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002759 Conversion will also be done when 'encoding' and 'fileencoding' are
2760 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2761 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002763 'encoding' is "utf-8" or another Unicode encoding, conversion
2764 is most likely done in a way that the reverse conversion
2765 results in the same text. When 'encoding' is not "utf-8" some
2766 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002767
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 See 'encoding' for the possible values. Additionally, values may be
2769 specified that can be handled by the converter, see
2770 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002771
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 When reading a file 'fileencoding' will be set from 'fileencodings'.
2773 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002774 'fileencoding', use the |++enc| argument. One exception: when
2775 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002776 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002777
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2779 When the option is set, the value is converted to lowercase. Thus
2780 you can set it with uppercase values too. '_' characters are
2781 replaced with '-'. If a name is recognized from the list for
2782 'encoding', it is replaced by the standard name. For example
2783 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002784
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785 When this option is set, after starting to edit a file, the 'modified'
2786 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002787
2788 Keep in mind that changing 'fenc' from a modeline happens
2789 AFTER the text has been read, thus it applies to when the file will be
2790 written. If you do set 'fenc' in a modeline, you might want to set
2791 'nomodified' to avoid not being able to ":q".
2792
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 This option can not be changed when 'modifiable' is off.
2794
2795 *'fe'*
2796 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002797 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002798 old short name was 'fe', which is no longer used.
2799
2800 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002801'fileencodings' 'fencs' string (default: "ucs-bom",
2802 "ucs-bom,utf-8,default,latin1" when
2803 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 global
2805 {only available when compiled with the |+multi_byte|
2806 feature}
2807 {not in Vi}
2808 This is a list of character encodings considered when starting to edit
2809 an existing file. When a file is read, Vim tries to use the first
2810 mentioned character encoding. If an error is detected, the next one
2811 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002812 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002813 an empty string, which means the value of 'encoding' is used.
2814 WARNING: Conversion can cause loss of information! When
2815 'encoding' is "utf-8" (or one of the other Unicode variants)
2816 conversion is most likely done in a way that the reverse
2817 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002818 "utf-8" some non-ASCII characters may be lost! You can use
2819 the |++bad| argument to specify what is done with characters
2820 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 For an empty file or a file with only ASCII characters most encodings
2822 will work and the first entry of 'fileencodings' will be used (except
2823 "ucs-bom", which requires the BOM to be present). If you prefer
2824 another encoding use an BufReadPost autocommand event to test if your
2825 preferred encoding is to be used. Example: >
2826 au BufReadPost * if search('\S', 'w') == 0 |
2827 \ set fenc=iso-2022-jp | endif
2828< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2829 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002830 When the |++enc| argument is used then the value of 'fileencodings' is
2831 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002832 Note that 'fileencodings' is not used for a new file, the global value
2833 of 'fileencoding' is used instead. You can set it with: >
2834 :setglobal fenc=iso-8859-2
2835< This means that a non-existing file may get a different encoding than
2836 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 The special value "ucs-bom" can be used to check for a Unicode BOM
2838 (Byte Order Mark) at the start of the file. It must not be preceded
2839 by "utf-8" or another Unicode encoding for this to work properly.
2840 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2841 because Vim cannot detect an error, thus the encoding is always
2842 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002843 The special value "default" can be used for the encoding from the
2844 environment. This is the default value for 'encoding'. It is useful
2845 when 'encoding' is set to "utf-8" and your environment uses a
2846 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002847 When 'encoding' is "utf-8" and a file contains an illegal byte
2848 sequence it won't be recognized as UTF-8. You can use the |8g8|
2849 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 WRONG VALUES: WHAT'S WRONG:
2851 latin1,utf-8 "latin1" will always be used
2852 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2853 file
2854 cp1250,latin1 "cp1250" will always be used
2855 If 'fileencodings' is empty, 'fileencoding' is not modified.
2856 See 'fileencoding' for the possible values.
2857 Setting this option does not have an effect until the next time a file
2858 is read.
2859
2860 *'fileformat'* *'ff'*
2861'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2862 Unix default: "unix",
2863 Macintosh default: "mac")
2864 local to buffer
2865 {not in Vi}
2866 This gives the <EOL> of the current buffer, which is used for
2867 reading/writing the buffer from/to a file:
2868 dos <CR> <NL>
2869 unix <NL>
2870 mac <CR>
2871 When "dos" is used, CTRL-Z at the end of a file is ignored.
2872 See |file-formats| and |file-read|.
2873 For the character encoding of the file see 'fileencoding'.
2874 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002875 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 This option is set automatically when starting to edit a file and
2877 'fileformats' is not empty and 'binary' is off.
2878 When this option is set, after starting to edit a file, the 'modified'
2879 option is set, because the file would be different when written.
2880 This option can not be changed when 'modifiable' is off.
2881 For backwards compatibility: When this option is set to "dos",
2882 'textmode' is set, otherwise 'textmode' is reset.
2883
2884 *'fileformats'* *'ffs'*
2885'fileformats' 'ffs' string (default:
2886 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2887 Vim Unix: "unix,dos",
2888 Vim Mac: "mac,unix,dos",
2889 Vi Cygwin: "unix,dos",
2890 Vi others: "")
2891 global
2892 {not in Vi}
2893 This gives the end-of-line (<EOL>) formats that will be tried when
2894 starting to edit a new buffer and when reading a file into an existing
2895 buffer:
2896 - When empty, the format defined with 'fileformat' will be used
2897 always. It is not set automatically.
2898 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002899 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 'fileformats' name will be used when a file is read into an existing
2901 buffer, no matter what 'fileformat' for that buffer is set to.
2902 - When more than one name is present, separated by commas, automatic
2903 <EOL> detection will be done when reading a file. When starting to
2904 edit a file, a check is done for the <EOL>:
2905 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2906 'fileformat' is set to "dos".
2907 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002908 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002910 3. If 'fileformat' has not yet been set, and if 'fileformats'
2911 includes "mac", 'fileformat' is set to "mac".
2912 This means that "mac" is only chosen when:
2913 "unix" is not present or no <NL> is found in the file, and
2914 "dos" is not present or no <CR><NL> is found in the file.
2915 Except: if "unix" was chosen, but there is a <CR> before
2916 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002917 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 4. If 'fileformat' is still not set, the first name from
2919 'fileformats' is used.
2920 When reading a file into an existing buffer, the same is done, but
2921 this happens like 'fileformat' has been set appropriately for that
2922 file only, the option is not changed.
2923 When 'binary' is set, the value of 'fileformats' is not used.
2924
Bram Moolenaar81af9252010-12-10 20:35:50 +01002925 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002926 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2929 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2930 done:
2931 - When 'fileformats' is empty, there is no automatic detection. Dos
2932 format will be used.
2933 - When 'fileformats' is set to one or more names, automatic detection
2934 is done. This is based on the first <NL> in the file: If there is a
2935 <CR> in front of it, Dos format is used, otherwise Unix format is
2936 used.
2937 Also see |file-formats|.
2938 For backwards compatibility: When this option is set to an empty
2939 string or one format (no comma is included), 'textauto' is reset,
2940 otherwise 'textauto' is set.
2941 NOTE: This option is set to the Vi default value when 'compatible' is
2942 set and to the Vim default value when 'compatible' is reset.
2943
Bram Moolenaarbf884932013-04-05 22:26:15 +02002944 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
2945'fileignorecase' 'fic' boolean (default on for systems where case in file
2946 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002947 global
2948 {not in Vi}
2949 When set case is ignored when using file names and directories.
2950 See 'wildignorecase' for only ignoring case when doing completion.
2951
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 *'filetype'* *'ft'*
2953'filetype' 'ft' string (default: "")
2954 local to buffer
2955 {not in Vi}
2956 {not available when compiled without the |+autocmd|
2957 feature}
2958 When this option is set, the FileType autocommand event is triggered.
2959 All autocommands that match with the value of this option will be
2960 executed. Thus the value of 'filetype' is used in place of the file
2961 name.
2962 Otherwise this option does not always reflect the current file type.
2963 This option is normally set when the file type is detected. To enable
2964 this use the ":filetype on" command. |:filetype|
2965 Setting this option to a different value is most useful in a modeline,
2966 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002967 Example, for in an IDL file:
2968 /* vim: set filetype=idl : */ ~
2969 |FileType| |filetypes|
2970 When a dot appears in the value then this separates two filetype
2971 names. Example:
2972 /* vim: set filetype=c.doxygen : */ ~
2973 This will use the "c" filetype first, then the "doxygen" filetype.
2974 This works both for filetype plugins and for syntax files. More than
2975 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 This option is not copied to another buffer, independent of the 's' or
2977 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002978 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002979
2980 *'fillchars'* *'fcs'*
2981'fillchars' 'fcs' string (default "vert:|,fold:-")
2982 global
2983 {not in Vi}
2984 {not available when compiled without the |+windows|
2985 and |+folding| features}
2986 Characters to fill the statuslines and vertical separators.
2987 It is a comma separated list of items:
2988
2989 item default Used for ~
2990 stl:c ' ' or '^' statusline of the current window
2991 stlnc:c ' ' or '-' statusline of the non-current windows
2992 vert:c '|' vertical separators |:vsplit|
2993 fold:c '-' filling 'foldtext'
2994 diff:c '-' deleted lines of the 'diff' option
2995
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002996 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997 "stlnc" the space will be used when there is highlighting, '^' or '-'
2998 otherwise.
2999
3000 Example: >
3001 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3002< This is similar to the default, except that these characters will also
3003 be used when there is highlighting.
3004
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003005 for "stl" and "stlnc" only single-byte values are supported.
3006
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 The highlighting used for these items:
3008 item highlight group ~
3009 stl:c StatusLine |hl-StatusLine|
3010 stlnc:c StatusLineNC |hl-StatusLineNC|
3011 vert:c VertSplit |hl-VertSplit|
3012 fold:c Folded |hl-Folded|
3013 diff:c DiffDelete |hl-DiffDelete|
3014
3015 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3016'fkmap' 'fk' boolean (default off) *E198*
3017 global
3018 {not in Vi}
3019 {only available when compiled with the |+rightleft|
3020 feature}
3021 When on, the keyboard is mapped for the Farsi character set.
3022 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024
3025 *'foldclose'* *'fcl'*
3026'foldclose' 'fcl' string (default "")
3027 global
3028 {not in Vi}
3029 {not available when compiled without the |+folding|
3030 feature}
3031 When set to "all", a fold is closed when the cursor isn't in it and
3032 its level is higher than 'foldlevel'. Useful if you want folds to
3033 automatically close when moving out of them.
3034
3035 *'foldcolumn'* *'fdc'*
3036'foldcolumn' 'fdc' number (default 0)
3037 local to window
3038 {not in Vi}
3039 {not available when compiled without the |+folding|
3040 feature}
3041 When non-zero, a column with the specified width is shown at the side
3042 of the window which indicates open and closed folds. The maximum
3043 value is 12.
3044 See |folding|.
3045
3046 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3047'foldenable' 'fen' boolean (default on)
3048 local to window
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 When off, all folds are open. This option can be used to quickly
3053 switch between showing all text unfolded and viewing the text with
3054 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003055 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 'foldenable' is off.
3057 This option is set by commands that create a new fold or close a fold.
3058 See |folding|.
3059
3060 *'foldexpr'* *'fde'*
3061'foldexpr' 'fde' string (default: "0")
3062 local to window
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003065 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003067 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003068
Bram Moolenaar30b65812012-07-12 22:01:11 +02003069 The expression will be evaluated in the |sandbox| if set from a
3070 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003071 This option can't be set from a |modeline| when the 'diff' option is
3072 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003073
3074 It is not allowed to change text or jump to another window while
3075 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076
3077 *'foldignore'* *'fdi'*
3078'foldignore' 'fdi' string (default: "#")
3079 local to window
3080 {not in Vi}
3081 {not available when compiled without the |+folding|
3082 feature}
3083 Used only when 'foldmethod' is "indent". Lines starting with
3084 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003085 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086 The default "#" works well for C programs. See |fold-indent|.
3087
3088 *'foldlevel'* *'fdl'*
3089'foldlevel' 'fdl' number (default: 0)
3090 local to window
3091 {not in Vi}
3092 {not available when compiled without the |+folding|
3093 feature}
3094 Sets the fold level: Folds with a higher level will be closed.
3095 Setting this option to zero will close all folds. Higher numbers will
3096 close fewer folds.
3097 This option is set by commands like |zm|, |zM| and |zR|.
3098 See |fold-foldlevel|.
3099
3100 *'foldlevelstart'* *'fdls'*
3101'foldlevelstart' 'fdls' number (default: -1)
3102 global
3103 {not in Vi}
3104 {not available when compiled without the |+folding|
3105 feature}
3106 Sets 'foldlevel' when starting to edit another buffer in a window.
3107 Useful to always start editing with all folds closed (value zero),
3108 some folds closed (one) or no folds closed (99).
3109 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003110 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 ignores this option and closes all folds.
3112 It is also done before BufReadPre autocommands, to allow an autocmd to
3113 overrule the 'foldlevel' value for specific files.
3114 When the value is negative, it is not used.
3115
3116 *'foldmarker'* *'fmr'* *E536*
3117'foldmarker' 'fmr' string (default: "{{{,}}}")
3118 local to window
3119 {not in Vi}
3120 {not available when compiled without the |+folding|
3121 feature}
3122 The start and end marker used when 'foldmethod' is "marker". There
3123 must be one comma, which separates the start and end marker. The
3124 marker is a literal string (a regular expression would be too slow).
3125 See |fold-marker|.
3126
3127 *'foldmethod'* *'fdm'*
3128'foldmethod' 'fdm' string (default: "manual")
3129 local to window
3130 {not in Vi}
3131 {not available when compiled without the |+folding|
3132 feature}
3133 The kind of folding used for the current window. Possible values:
3134 |fold-manual| manual Folds are created manually.
3135 |fold-indent| indent Lines with equal indent form a fold.
3136 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3137 |fold-marker| marker Markers are used to specify folds.
3138 |fold-syntax| syntax Syntax highlighting items specify folds.
3139 |fold-diff| diff Fold text that is not changed.
3140
3141 *'foldminlines'* *'fml'*
3142'foldminlines' 'fml' number (default: 1)
3143 local to window
3144 {not in Vi}
3145 {not available when compiled without the |+folding|
3146 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003147 Sets the number of screen lines above which a fold can be displayed
3148 closed. Also for manually closed folds. With the default value of
3149 one a fold can only be closed if it takes up two or more screen lines.
3150 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003151 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 "zc" to close a fold, which is displayed open because it's smaller
3153 than 'foldminlines', a following "zc" may close a containing fold.
3154
3155 *'foldnestmax'* *'fdn'*
3156'foldnestmax' 'fdn' number (default: 20)
3157 local to window
3158 {not in Vi}
3159 {not available when compiled without the |+folding|
3160 feature}
3161 Sets the maximum nesting of folds for the "indent" and "syntax"
3162 methods. This avoids that too many folds will be created. Using more
3163 than 20 doesn't work, because the internal limit is 20.
3164
3165 *'foldopen'* *'fdo'*
3166'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3167 search,tag,undo")
3168 global
3169 {not in Vi}
3170 {not available when compiled without the |+folding|
3171 feature}
3172 Specifies for which type of commands folds will be opened, if the
3173 command moves the cursor into a closed fold. It is a comma separated
3174 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003175 NOTE: When the command is part of a mapping this option is not used.
3176 Add the |zv| command to the mapping to get the same effect.
3177 (rationale: the mapping may want to control opening folds itself)
3178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 item commands ~
3180 all any
3181 block "(", "{", "[[", "[{", etc.
3182 hor horizontal movements: "l", "w", "fx", etc.
3183 insert any command in Insert mode
3184 jump far jumps: "G", "gg", etc.
3185 mark jumping to a mark: "'m", CTRL-O, etc.
3186 percent "%"
3187 quickfix ":cn", ":crew", ":make", etc.
3188 search search for a pattern: "/", "n", "*", "gd", etc.
3189 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003190 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 tag jumping to a tag: ":ta", CTRL-T, etc.
3192 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 When a movement command is used for an operator (e.g., "dl" or "y%")
3194 this option is not used. This means the operator will include the
3195 whole closed fold.
3196 Note that vertical movements are not here, because it would make it
3197 very difficult to move onto a closed fold.
3198 In insert mode the folds containing the cursor will always be open
3199 when text is inserted.
3200 To close folds you can re-apply 'foldlevel' with the |zx| command or
3201 set the 'foldclose' option to "all".
3202
3203 *'foldtext'* *'fdt'*
3204'foldtext' 'fdt' string (default: "foldtext()")
3205 local to window
3206 {not in Vi}
3207 {not available when compiled without the |+folding|
3208 feature}
3209 An expression which is used to specify the text displayed for a closed
3210 fold. See |fold-foldtext|.
3211
Bram Moolenaar30b65812012-07-12 22:01:11 +02003212 The expression will be evaluated in the |sandbox| if set from a
3213 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003214
3215 It is not allowed to change text or jump to another window while
3216 evaluating 'foldtext' |textlock|.
3217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 *'formatoptions'* *'fo'*
3219'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3220 local to buffer
3221 {not in Vi}
3222 This is a sequence of letters which describes how automatic
3223 formatting is to be done. See |fo-table|. When the 'paste' option is
3224 on, no formatting is done (like 'formatoptions' is empty). Commas can
3225 be inserted for readability.
3226 To avoid problems with flags that are added in the future, use the
3227 "+=" and "-=" feature of ":set" |add-option-flags|.
3228 NOTE: This option is set to the Vi default value when 'compatible' is
3229 set and to the Vim default value when 'compatible' is reset.
3230
Bram Moolenaar86b68352004-12-27 21:59:20 +00003231 *'formatlistpat'* *'flp'*
3232'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3233 local to buffer
3234 {not in Vi}
3235 A pattern that is used to recognize a list header. This is used for
3236 the "n" flag in 'formatoptions'.
3237 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003238 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003239 while still checking more characters. There must be a character
3240 following the pattern, when it matches the whole line it is handled
3241 like there is no match.
3242 The default recognizes a number, followed by an optional punctuation
3243 character and white space.
3244
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 *'formatprg'* *'fp'*
3246'formatprg' 'fp' string (default "")
3247 global
3248 {not in Vi}
3249 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003250 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003252 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003253 If the 'formatexpr' option is not empty it will be used instead.
3254 Otherwise, if 'formatprg' option is an empty string, the internal
3255 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003256 Environment variables are expanded |:set_env|. See |option-backslash|
3257 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003258 This option cannot be set from a |modeline| or in the |sandbox|, for
3259 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003261 *'formatexpr'* *'fex'*
3262'formatexpr' 'fex' string (default "")
3263 local to buffer
3264 {not in Vi}
3265 {not available when compiled without the |+eval|
3266 feature}
3267 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003268 operator or automatic formatting (see 'formatoptions'). When this
3269 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003270
3271 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003272 The |v:count| variable holds the number of lines to be formatted.
3273 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003274 inserted if the expression is being evaluated due to
3275 automatic formatting. This can be empty. Don't insert
3276 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003277
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003278 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003279 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003280< This will invoke the mylang#Format() function in the
3281 autoload/mylang.vim file in 'runtimepath'. |autoload|
3282
3283 The expression is also evaluated when 'textwidth' is set and adding
3284 text beyond that limit. This happens under the same conditions as
3285 when internal formatting is used. Make sure the cursor is kept in the
3286 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003287 return "i" or "R" in this situation.
3288
3289 When the expression evaluates to non-zero Vim will fall back to using
3290 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003291
Bram Moolenaar30b65812012-07-12 22:01:11 +02003292 The expression will be evaluated in the |sandbox| when set from a
3293 modeline, see |sandbox-option|. That stops the option from working,
3294 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003295
3296 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003297'fsync' 'fs' boolean (default on)
3298 global
3299 {not in Vi}
3300 When on, the library function fsync() will be called after writing a
3301 file. This will flush a file to disk, ensuring that it is safely
3302 written even on filesystems which do metadata-only journaling. This
3303 will force the harddrive to spin up on Linux systems running in laptop
3304 mode, so it may be undesirable in some situations. Be warned that
3305 turning this off increases the chances of data loss after a crash. On
3306 systems without an fsync() implementation, this variable is always
3307 off.
3308 Also see 'swapsync' for controlling fsync() on swap files.
3309
Bram Moolenaar071d4272004-06-13 20:20:40 +00003310 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3311'gdefault' 'gd' boolean (default off)
3312 global
3313 {not in Vi}
3314 When on, the ":substitute" flag 'g' is default on. This means that
3315 all matches in a line are substituted instead of one. When a 'g' flag
3316 is given to a ":substitute" command, this will toggle the substitution
3317 of all or one match. See |complex-change|.
3318
3319 command 'gdefault' on 'gdefault' off ~
3320 :s/// subst. all subst. one
3321 :s///g subst. one subst. all
3322 :s///gg subst. all subst. one
3323
3324 NOTE: This option is reset when 'compatible' is set.
3325
3326 *'grepformat'* *'gfm'*
3327'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3328 global
3329 {not in Vi}
3330 Format to recognize for the ":grep" command output.
3331 This is a scanf-like string that uses the same format as the
3332 'errorformat' option: see |errorformat|.
3333
3334 *'grepprg'* *'gp'*
3335'grepprg' 'gp' string (default "grep -n ",
3336 Unix: "grep -n $* /dev/null",
3337 Win32: "findstr /n" or "grep -n",
3338 VMS: "SEARCH/NUMBERS ")
3339 global or local to buffer |global-local|
3340 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003341 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003342 and '#' characters, which are expanded like when used in a command-
3343 line. The placeholder "$*" is allowed to specify where the arguments
3344 will be included. Environment variables are expanded |:set_env|. See
3345 |option-backslash| about including spaces and backslashes.
3346 When your "grep" accepts the "-H" argument, use this to make ":grep"
3347 also work well with a single file: >
3348 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003349< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003350 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3351 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003352 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 apply equally to 'grepprg'.
3354 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3355 otherwise it's "grep -n".
3356 This option cannot be set from a |modeline| or in the |sandbox|, for
3357 security reasons.
3358
3359 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3360'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3361 ve:ver35-Cursor,
3362 o:hor50-Cursor,
3363 i-ci:ver25-Cursor/lCursor,
3364 r-cr:hor20-Cursor/lCursor,
3365 sm:block-Cursor
3366 -blinkwait175-blinkoff150-blinkon175",
3367 for MS-DOS and Win32 console:
3368 "n-v-c:block,o:hor50,i-ci:hor15,
3369 r-cr:hor30,sm:block")
3370 global
3371 {not in Vi}
3372 {only available when compiled with GUI enabled, and
3373 for MS-DOS and Win32 console}
3374 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003375 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 the height of the cursor can be changed. This can be done by
3377 specifying a block cursor, or a percentage for a vertical or
3378 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003379 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003381 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 mode-list and an argument-list:
3383 mode-list:argument-list,mode-list:argument-list,..
3384 The mode-list is a dash separated list of these modes:
3385 n Normal mode
3386 v Visual mode
3387 ve Visual mode with 'selection' "exclusive" (same as 'v',
3388 if not specified)
3389 o Operator-pending mode
3390 i Insert mode
3391 r Replace mode
3392 c Command-line Normal (append) mode
3393 ci Command-line Insert mode
3394 cr Command-line Replace mode
3395 sm showmatch in Insert mode
3396 a all modes
3397 The argument-list is a dash separated list of these arguments:
3398 hor{N} horizontal bar, {N} percent of the character height
3399 ver{N} vertical bar, {N} percent of the character width
3400 block block cursor, fills the whole character
3401 [only one of the above three should be present]
3402 blinkwait{N} *cursor-blinking*
3403 blinkon{N}
3404 blinkoff{N}
3405 blink times for cursor: blinkwait is the delay before
3406 the cursor starts blinking, blinkon is the time that
3407 the cursor is shown and blinkoff is the time that the
3408 cursor is not shown. The times are in msec. When one
3409 of the numbers is zero, there is no blinking. The
3410 default is: "blinkwait700-blinkon400-blinkoff250".
3411 These numbers are used for a missing entry. This
3412 means that blinking is enabled by default. To switch
3413 blinking off you can use "blinkon0". The cursor only
3414 blinks when Vim is waiting for input, not while
3415 executing a command.
3416 To make the cursor blink in an xterm, see
3417 |xterm-blink|.
3418 {group-name}
3419 a highlight group name, that sets the color and font
3420 for the cursor
3421 {group-name}/{group-name}
3422 Two highlight group names, the first is used when
3423 no language mappings are used, the other when they
3424 are. |language-mapping|
3425
3426 Examples of parts:
3427 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3428 block cursor with colors from the "nCursor"
3429 highlight group
3430 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3431 In Insert and Command-line Insert mode, use a
3432 30% vertical bar cursor with colors from the
3433 "iCursor" highlight group. Blink a bit
3434 faster.
3435
3436 The 'a' mode is different. It will set the given argument-list for
3437 all modes. It does not reset anything to defaults. This can be used
3438 to do a common setting for all modes. For example, to switch off
3439 blinking: "a:blinkon0"
3440
3441 Examples of cursor highlighting: >
3442 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3443 :highlight Cursor gui=NONE guifg=bg guibg=fg
3444<
3445 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003446 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447'guifont' 'gfn' string (default "")
3448 global
3449 {not in Vi}
3450 {only available when compiled with GUI enabled}
3451 This is a list of fonts which will be used for the GUI version of Vim.
3452 In its simplest form the value is just one font name. When
3453 the font cannot be found you will get an error message. To try other
3454 font names a list can be specified, font names separated with commas.
3455 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003456
Bram Moolenaar05159a02005-02-26 23:04:13 +00003457 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3458 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003459
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460 Spaces after a comma are ignored. To include a comma in a font name
3461 precede it with a backslash. Setting an option requires an extra
3462 backslash before a space and a backslash. See also
3463 |option-backslash|. For example: >
3464 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003465< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003466 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003467
3468 If none of the fonts can be loaded, Vim will keep the current setting.
3469 If an empty font list is given, Vim will try using other resource
3470 settings (for X, it will use the Vim.font resource), and finally it
3471 will try some builtin default which should always be there ("7x13" in
3472 the case of X). The font names given should be "normal" fonts. Vim
3473 will try to find the related bold and italic fonts.
3474
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003475 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003476 :set guifont=*
3477< will bring up a font requester, where you can pick the font you want.
3478
3479 The font name depends on the GUI used. See |setting-guifont| for a
3480 way to set 'guifont' for various systems.
3481
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 For the GTK+ 2 GUI the font name looks like this: >
3483 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003484< That's all. XLFDs are not used. For Chinese this is reported to work
3485 well: >
3486 if has("gui_gtk2")
3487 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3488 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3489 endif
3490<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003491 For Mac OSX you can use something like this: >
3492 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003493< Also see 'macatsui', it can help fix display problems.
3494 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003496 width). An exception is GTK 2: all fonts are accepted, but
3497 mono-spaced fonts look best.
3498
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 To preview a font on X11, you might be able to use the "xfontsel"
3500 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003501
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 For the Win32 GUI *E244* *E245*
3503 - takes these options in the font name:
3504 hXX - height is XX (points, can be floating-point)
3505 wXX - width is XX (points, can be floating-point)
3506 b - bold
3507 i - italic
3508 u - underline
3509 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003510 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3512 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3513 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003514 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515
3516 Use a ':' to separate the options.
3517 - A '_' can be used in the place of a space, so you don't need to use
3518 backslashes to escape the spaces.
3519 - Examples: >
3520 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3521 :set guifont=Andale_Mono:h7.5:w4.5
3522< See also |font-sizes|.
3523
3524 *'guifontset'* *'gfs'*
3525 *E250* *E252* *E234* *E597* *E598*
3526'guifontset' 'gfs' string (default "")
3527 global
3528 {not in Vi}
3529 {only available when compiled with GUI enabled and
3530 with the |+xfontset| feature}
3531 {not available in the GTK+ 2 GUI}
3532 When not empty, specifies two (or more) fonts to be used. The first
3533 one for normal English, the second one for your special language. See
3534 |xfontset|.
3535 Setting this option also means that all font names will be handled as
3536 a fontset name. Also the ones used for the "font" argument of the
3537 |:highlight| command.
3538 The fonts must match with the current locale. If fonts for the
3539 character sets that the current locale uses are not included, setting
3540 'guifontset' will fail.
3541 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3542 the comma-separated names are alternative names, one of which will be
3543 used. In 'guifontset' the whole string is one fontset name,
3544 including the commas. It is not possible to specify alternative
3545 fontset names.
3546 This example works on many X11 systems: >
3547 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3548<
3549 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3550'guifontwide' 'gfw' string (default "")
3551 global
3552 {not in Vi}
3553 {only available when compiled with GUI enabled}
3554 When not empty, specifies a comma-separated list of fonts to be used
3555 for double-width characters. The first font that can be loaded is
3556 used.
3557 Note: The size of these fonts must be exactly twice as wide as the one
3558 specified with 'guifont' and the same height.
3559
3560 All GUI versions but GTK+ 2:
3561
3562 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3563 'guifontset' is empty or invalid.
3564 When 'guifont' is set and a valid font is found in it and
3565 'guifontwide' is empty Vim will attempt to find a matching
3566 double-width font and set 'guifontwide' to it.
3567
3568 GTK+ 2 GUI only: *guifontwide_gtk2*
3569
3570 If set and valid, 'guifontwide' is always used for double width
3571 characters, even if 'encoding' is not set to "utf-8".
3572 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003573 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 font for characters not available in 'guifont'. Thus you do not need
3575 to set 'guifontwide' at all unless you want to override the choice
3576 made by Pango/Xft.
3577
Bram Moolenaar0f272122013-01-23 18:37:40 +01003578 Windows +multibyte only: *guifontwide_win_mbyte*
3579
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003580 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003581
Bram Moolenaar071d4272004-06-13 20:20:40 +00003582 *'guiheadroom'* *'ghr'*
3583'guiheadroom' 'ghr' number (default 50)
3584 global
3585 {not in Vi} {only for GTK and X11 GUI}
3586 The number of pixels subtracted from the screen height when fitting
3587 the GUI window on the screen. Set this before the GUI is started,
3588 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003589 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 lines will be left for window decorations and other items on the
3591 screen. Set it to a negative value to allow windows taller than the
3592 screen.
3593
3594 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003595'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3596 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 global
3598 {not in Vi}
3599 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003600 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 sequence of letters which describes what components and options of the
3602 GUI should be used.
3603 To avoid problems with flags that are added in the future, use the
3604 "+=" and "-=" feature of ":set" |add-option-flags|.
3605
3606 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003607 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 'a' Autoselect: If present, then whenever VISUAL mode is started,
3609 or the Visual area extended, Vim tries to become the owner of
3610 the windowing system's global selection. This means that the
3611 Visually highlighted text is available for pasting into other
3612 applications as well as into Vim itself. When the Visual mode
3613 ends, possibly due to an operation on the text, or when an
3614 application wants to paste the selection, the highlighted text
3615 is automatically yanked into the "* selection register.
3616 Thus the selection is still available for pasting into other
3617 applications after the VISUAL mode has ended.
3618 If not present, then Vim won't become the owner of the
3619 windowing system's global selection unless explicitly told to
3620 by a yank or delete operation for the "* register.
3621 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003622 *'go-P'*
3623 'P' Like autoselect but using the "+ register instead of the "*
3624 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003625 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 applies to the modeless selection.
3628
3629 'guioptions' autoselect Visual autoselect modeless ~
3630 "" - -
3631 "a" yes yes
3632 "A" - yes
3633 "aA" yes yes
3634
Bram Moolenaar02467872007-05-06 13:22:01 +00003635 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 'c' Use console dialogs instead of popup dialogs for simple
3637 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003638 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003639 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003640 'guitablabel' can be used to change the text in the labels.
3641 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003642 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003643 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003644 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 'f' Foreground: Don't use fork() to detach the GUI from the shell
3646 where it was started. Use this for programs that wait for the
3647 editor to finish (e.g., an e-mail program). Alternatively you
3648 can use "gvim -f" or ":gui -f" to start the GUI in the
3649 foreground. |gui-fork|
3650 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003651 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003652 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3654 corner of the window. It's black&white on non-GTK, because of
3655 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003656 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003658 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003659 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003661 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003662 file is sourced the system menu has already been loaded; the
3663 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003664 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665 'g' Grey menu items: Make menu items that are not active grey. If
3666 'g' is not included inactive menu items are not shown at all.
3667 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003668 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 't' Include tearoff menu items. Currently only works for Win32,
3670 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003671 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003672 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003673 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003674 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003676 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 'R' Right-hand scrollbar is present when there is a vertically
3678 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003679 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003681 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 'L' Left-hand scrollbar is present when there is a vertically
3683 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003684 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3686 the longest visible line, or on the cursor line if the 'h'
3687 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003688 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 'h' Limit horizontal scrollbar size to the length of the cursor
3690 line. Reduces computations. |gui-horiz-scroll|
3691
3692 And yes, you may even have scrollbars on the left AND the right if
3693 you really want to :-). See |gui-scrollbars| for more information.
3694
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003695 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696 'v' Use a vertical button layout for dialogs. When not included,
3697 a horizontal layout is preferred, but when it doesn't fit a
3698 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003699 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003700 'p' Use Pointer callbacks for X11 GUI. This is required for some
3701 window managers. If the cursor is not blinking or hollow at
3702 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003703 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003704 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003705 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707
Bram Moolenaar02467872007-05-06 13:22:01 +00003708
Bram Moolenaar071d4272004-06-13 20:20:40 +00003709 *'guipty'* *'noguipty'*
3710'guipty' boolean (default on)
3711 global
3712 {not in Vi}
3713 {only available when compiled with GUI enabled}
3714 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3715 I/O to/from shell commands. See |gui-pty|.
3716
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003717 *'guitablabel'* *'gtl'*
3718'guitablabel' 'gtl' string (default empty)
3719 global
3720 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003721 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003722 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003723 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003724 pages line. When empty and when the result is empty Vim will use a
3725 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003726
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003727 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003728 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003729
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003730 Only used when the GUI tab pages line is displayed. 'e' must be
3731 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3732 used.
3733
Bram Moolenaar57657d82006-04-21 22:12:41 +00003734 *'guitabtooltip'* *'gtt'*
3735'guitabtooltip' 'gtt' string (default empty)
3736 global
3737 {not in Vi}
3738 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003739 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003740 When nonempty describes the text to use in a tooltip for the GUI tab
3741 pages line. When empty Vim will use a default tooltip.
3742 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003743 You can include a line break. Simplest method is to use |:let|: >
3744 :let &guitabtooltip = "line one\nline two"
3745<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003746
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 *'helpfile'* *'hf'*
3748'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3749 (others) "$VIMRUNTIME/doc/help.txt")
3750 global
3751 {not in Vi}
3752 Name of the main help file. All distributed help files should be
3753 placed together in one directory. Additionally, all "doc" directories
3754 in 'runtimepath' will be used.
3755 Environment variables are expanded |:set_env|. For example:
3756 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003757 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 spaces and backslashes.
3759 This option cannot be set from a |modeline| or in the |sandbox|, for
3760 security reasons.
3761
3762 *'helpheight'* *'hh'*
3763'helpheight' 'hh' number (default 20)
3764 global
3765 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003766 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 feature}
3768 Minimal initial height of the help window when it is opened with the
3769 ":help" command. The initial height of the help window is half of the
3770 current window, or (when the 'ea' option is on) the same as other
3771 windows. When the height is less than 'helpheight', the height is
3772 set to 'helpheight'. Set to zero to disable.
3773
3774 *'helplang'* *'hlg'*
3775'helplang' 'hlg' string (default: messages language or empty)
3776 global
3777 {only available when compiled with the |+multi_lang|
3778 feature}
3779 {not in Vi}
3780 Comma separated list of languages. Vim will use the first language
3781 for which the desired help can be found. The English help will always
3782 be used as a last resort. You can add "en" to prefer English over
3783 another language, but that will only find tags that exist in that
3784 language and not in the English help.
3785 Example: >
3786 :set helplang=de,it
3787< This will first search German, then Italian and finally English help
3788 files.
3789 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3790 try to find the tag in the current language before using this option.
3791 See |help-translated|.
3792
3793 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3794'hidden' 'hid' boolean (default off)
3795 global
3796 {not in Vi}
3797 When off a buffer is unloaded when it is |abandon|ed. When on a
3798 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3799 displayed in another window, it does not become hidden, of course.
3800 The commands that move through the buffer list sometimes make a buffer
3801 hidden although the 'hidden' option is off: When the buffer is
3802 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003803 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003804 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 This option is set for one command with ":hide {command}" |:hide|.
3806 WARNING: It's easy to forget that you have changes in hidden buffers.
3807 Think twice when using ":q!" or ":qa!".
3808
3809 *'highlight'* *'hl'*
3810'highlight' 'hl' string (default (as a single string):
3811 "8:SpecialKey,@:NonText,d:Directory,
3812 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003813 M:ModeMsg,n:LineNr,N:CursorLineNr,
3814 r:Question,s:StatusLine,S:StatusLineNC,
3815 c:VertSplit, t:Title,v:Visual,
3816 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 f:Folded,F:FoldColumn,A:DiffAdd,
3818 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003819 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003820 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003821 +:Pmenu,=:PmenuSel,
3822 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 global
3824 {not in Vi}
3825 This option can be used to set highlighting mode for various
3826 occasions. It is a comma separated list of character pairs. The
3827 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003828 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3830 |hl-NonText| @ '~' and '@' at the end of the window and
3831 characters from 'showbreak'
3832 |hl-Directory| d directories in CTRL-D listing and other special
3833 things in listings
3834 |hl-ErrorMsg| e error messages
3835 h (obsolete, ignored)
3836 |hl-IncSearch| i 'incsearch' highlighting
3837 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3838 |hl-MoreMsg| m |more-prompt|
3839 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003840 |hl-LineNr| n line number for ":number" and ":#" commands, and
3841 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003842 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3843 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003844 |hl-Question| r |hit-enter| prompt and yes/no questions
3845 |hl-StatusLine| s status line of current window |status-line|
3846 |hl-StatusLineNC| S status lines of not-current windows
3847 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3848 |hl-VertSplit| c column used to separate vertically split windows
3849 |hl-Visual| v Visual mode
3850 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3851 Selection" Only X11 Gui's |gui-x11| and
3852 |xterm-clipboard|.
3853 |hl-WarningMsg| w warning messages
3854 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3855 |hl-Folded| f line used for closed folds
3856 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003857 |hl-DiffAdd| A added line in diff mode
3858 |hl-DiffChange| C changed line in diff mode
3859 |hl-DiffDelete| D deleted line in diff mode
3860 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003862 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003863 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003864 |hl-SpellRare| R rare word |spell|
3865 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003866 |hl-Conceal| - the placeholders used for concealed characters
3867 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003868 |hl-Pmenu| + popup menu normal line
3869 |hl-PmenuSel| = popup menu normal line
3870 |hl-PmenuSbar| x popup menu scrollbar
3871 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003872
3873 The display modes are:
3874 r reverse (termcap entry "mr" and "me")
3875 i italic (termcap entry "ZH" and "ZR")
3876 b bold (termcap entry "md" and "me")
3877 s standout (termcap entry "so" and "se")
3878 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003879 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003880 n no highlighting
3881 - no highlighting
3882 : use a highlight group
3883 The default is used for occasions that are not included.
3884 If you want to change what the display modes do, see |dos-colors|
3885 for an example.
3886 When using the ':' display mode, this must be followed by the name of
3887 a highlight group. A highlight group can be used to define any type
3888 of highlighting, including using color. See |:highlight| on how to
3889 define one. The default uses a different group for each occasion.
3890 See |highlight-default| for the default highlight groups.
3891
3892 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3893'hlsearch' 'hls' boolean (default off)
3894 global
3895 {not in Vi}
3896 {not available when compiled without the
3897 |+extra_search| feature}
3898 When there is a previous search pattern, highlight all its matches.
3899 The type of highlighting used can be set with the 'l' occasion in the
3900 'highlight' option. This uses the "Search" highlight group by
3901 default. Note that only the matching text is highlighted, any offsets
3902 are not applied.
3903 See also: 'incsearch' and |:match|.
3904 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003905 off with |:nohlsearch|. This does not change the option value, as
3906 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003907 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003908 When the search pattern can match an end-of-line, Vim will try to
3909 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003910 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003911 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003912 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003913 You can specify whether the highlight status is restored on startup
3914 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 NOTE: This option is reset when 'compatible' is set.
3916
3917 *'history'* *'hi'*
3918'history' 'hi' number (Vim default: 20, Vi default: 0)
3919 global
3920 {not in Vi}
3921 A history of ":" commands, and a history of previous search patterns
3922 are remembered. This option decides how many entries may be stored in
3923 each of these histories (see |cmdline-editing|).
3924 NOTE: This option is set to the Vi default value when 'compatible' is
3925 set and to the Vim default value when 'compatible' is reset.
3926
3927 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3928'hkmap' 'hk' boolean (default off)
3929 global
3930 {not in Vi}
3931 {only available when compiled with the |+rightleft|
3932 feature}
3933 When on, the keyboard is mapped for the Hebrew character set.
3934 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3935 toggle this option. See |rileft.txt|.
3936 NOTE: This option is reset when 'compatible' is set.
3937
3938 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3939'hkmapp' 'hkp' boolean (default off)
3940 global
3941 {not in Vi}
3942 {only available when compiled with the |+rightleft|
3943 feature}
3944 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3945 This is useful if you have a non-Hebrew keyboard.
3946 See |rileft.txt|.
3947 NOTE: This option is reset when 'compatible' is set.
3948
3949 *'icon'* *'noicon'*
3950'icon' boolean (default off, on when title can be restored)
3951 global
3952 {not in Vi}
3953 {not available when compiled without the |+title|
3954 feature}
3955 When on, the icon text of the window will be set to the value of
3956 'iconstring' (if it is not empty), or to the name of the file
3957 currently being edited. Only the last part of the name is used.
3958 Overridden by the 'iconstring' option.
3959 Only works if the terminal supports setting window icons (currently
3960 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3961 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3962 builtin termcap).
3963 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003964 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 X11.
3966
3967 *'iconstring'*
3968'iconstring' string (default "")
3969 global
3970 {not in Vi}
3971 {not available when compiled without the |+title|
3972 feature}
3973 When this option is not empty, it will be used for the icon text of
3974 the window. This happens only when the 'icon' option is on.
3975 Only works if the terminal supports setting window icon text
3976 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3977 Does not work for MS Windows.
3978 When Vim was compiled with HAVE_X11 defined, the original icon will be
3979 restored if possible |X11|.
3980 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003981 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003982 'titlestring' for example settings.
3983 {not available when compiled without the |+statusline| feature}
3984
3985 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3986'ignorecase' 'ic' boolean (default off)
3987 global
3988 Ignore case in search patterns. Also used when searching in the tags
3989 file.
3990 Also see 'smartcase'.
3991 Can be overruled by using "\c" or "\C" in the pattern, see
3992 |/ignorecase|.
3993
3994 *'imactivatekey'* *'imak'*
3995'imactivatekey' 'imak' string (default "")
3996 global
3997 {not in Vi}
3998 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003999 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 Specifies the key that your Input Method in X-Windows uses for
4001 activation. When this is specified correctly, vim can fully control
4002 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4003 You can't use this option to change the activation key, the option
4004 tells Vim what the key is.
4005 Format:
4006 [MODIFIER_FLAG-]KEY_STRING
4007
4008 These characters can be used for MODIFIER_FLAG (case is ignored):
4009 S Shift key
4010 L Lock key
4011 C Control key
4012 1 Mod1 key
4013 2 Mod2 key
4014 3 Mod3 key
4015 4 Mod4 key
4016 5 Mod5 key
4017 Combinations are allowed, for example "S-C-space" or "SC-space" are
4018 both shift+ctrl+space.
4019 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4020
4021 Example: >
4022 :set imactivatekey=S-space
4023< "S-space" means shift+space. This is the activation key for kinput2 +
4024 canna (Japanese), and ami (Korean).
4025
4026 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4027'imcmdline' 'imc' boolean (default off)
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 always on when starting to edit a command
4033 line, unless entering a search pattern (see 'imsearch' for that).
4034 Setting this option is useful when your input method allows entering
4035 English characters directly, e.g., when it's used to type accented
4036 characters with dead keys.
4037
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004038 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4040 global
4041 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004042 {only available when compiled with the |+xim|,
4043 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004044 When set the Input Method is never used. This is useful to disable
4045 the IM when it doesn't work properly.
4046 Currently this option is on by default for SGI/IRIX machines. This
4047 may change in later releases.
4048
4049 *'iminsert'* *'imi'*
4050'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4051 local to buffer
4052 {not in Vi}
4053 Specifies whether :lmap or an Input Method (IM) is to be used in
4054 Insert mode. Valid values:
4055 0 :lmap is off and IM is off
4056 1 :lmap is ON and IM is off
4057 2 :lmap is off and IM is ON
4058 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4059 or |global-ime|.
4060 To always reset the option to zero when leaving Insert mode with <Esc>
4061 this can be used: >
4062 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4063< This makes :lmap and IM turn off automatically when leaving Insert
4064 mode.
4065 Note that this option changes when using CTRL-^ in Insert mode
4066 |i_CTRL-^|.
4067 The value is set to 1 when setting 'keymap' to a valid keymap name.
4068 It is also used for the argument of commands like "r" and "f".
4069 The value 0 may not work correctly with Athena and Motif with some XIM
4070 methods. Use 'imdisable' to disable XIM then.
4071
4072 *'imsearch'* *'ims'*
4073'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4074 local to buffer
4075 {not in Vi}
4076 Specifies whether :lmap or an Input Method (IM) is to be used when
4077 entering a search pattern. Valid values:
4078 -1 the value of 'iminsert' is used, makes it look like
4079 'iminsert' is also used when typing a search pattern
4080 0 :lmap is off and IM is off
4081 1 :lmap is ON and IM is off
4082 2 :lmap is off and IM is ON
4083 Note that this option changes when using CTRL-^ in Command-line mode
4084 |c_CTRL-^|.
4085 The value is set to 1 when it is not -1 and setting the 'keymap'
4086 option to a valid keymap name.
4087 The value 0 may not work correctly with Athena and Motif with some XIM
4088 methods. Use 'imdisable' to disable XIM then.
4089
4090 *'include'* *'inc'*
4091'include' 'inc' string (default "^\s*#\s*include")
4092 global or local to buffer |global-local|
4093 {not in Vi}
4094 {not available when compiled without the
4095 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004096 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 pattern, just like for the "/" command (See |pattern|). The default
4098 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004099 "]I", "[d", etc.
4100 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004101 comes after the matched pattern. But if "\zs" appears in the pattern
4102 then the text matched from "\zs" to the end, or until "\ze" if it
4103 appears, is used as the file name. Use this to include characters
4104 that are not in 'isfname', such as a space. You can then use
4105 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004106 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107
4108 *'includeexpr'* *'inex'*
4109'includeexpr' 'inex' string (default "")
4110 local to buffer
4111 {not in Vi}
4112 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004113 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004115 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 :set includeexpr=substitute(v:fname,'\\.','/','g')
4117< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004118
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004120 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 Also used for |<cfile>|.
4122
Bram Moolenaar30b65812012-07-12 22:01:11 +02004123 The expression will be evaluated in the |sandbox| when set from a
4124 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004125
4126 It is not allowed to change text or jump to another window while
4127 evaluating 'includeexpr' |textlock|.
4128
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4130'incsearch' 'is' boolean (default off)
4131 global
4132 {not in Vi}
4133 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004134 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004135 While typing a search command, show where the pattern, as it was typed
4136 so far, matches. The matched string is highlighted. If the pattern
4137 is invalid or not found, nothing is shown. The screen will be updated
4138 often, this is only useful on fast terminals.
4139 Note that the match will be shown, but the cursor will return to its
4140 original position when no match is found and when pressing <Esc>. You
4141 still need to finish the search command with <Enter> to move the
4142 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004143 When compiled with the |+reltime| feature Vim only searches for about
4144 half a second. With a complicated pattern and/or a lot of text the
4145 match may not be found. This is to avoid that Vim hangs while you
4146 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004147 The highlighting can be set with the 'i' flag in 'highlight'.
4148 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004149 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004150 to the command line. If 'ignorecase' and 'smartcase' are set and the
4151 command line has no uppercase characters, the added character is
4152 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004153 CTRL-R CTRL-W can be used to add the word at the end of the current
4154 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 NOTE: This option is reset when 'compatible' is set.
4156
4157 *'indentexpr'* *'inde'*
4158'indentexpr' 'inde' string (default "")
4159 local to buffer
4160 {not in Vi}
4161 {not available when compiled without the |+cindent|
4162 or |+eval| features}
4163 Expression which is evaluated to obtain the proper indent for a line.
4164 It is used when a new line is created, for the |=| operator and
4165 in Insert mode as specified with the 'indentkeys' option.
4166 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004167 'smartindent' indenting. When 'lisp' is set, this option is
4168 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 When 'paste' is set this option is not used for indenting.
4170 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004171 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 when the expression is evaluated (but it may be moved around).
4173 The expression must return the number of spaces worth of indent. It
4174 can return "-1" to keep the current indent (this means 'autoindent' is
4175 used for the indent).
4176 Functions useful for computing the indent are |indent()|, |cindent()|
4177 and |lispindent()|.
4178 The evaluation of the expression must not have side effects! It must
4179 not change the text, jump to another window, etc. Afterwards the
4180 cursor position is always restored, thus the cursor may be moved.
4181 Normally this option would be set to call a function: >
4182 :set indentexpr=GetMyIndent()
4183< Error messages will be suppressed, unless the 'debug' option contains
4184 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004185 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 NOTE: This option is made empty when 'compatible' is set.
4187
Bram Moolenaar30b65812012-07-12 22:01:11 +02004188 The expression will be evaluated in the |sandbox| when set from a
4189 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004190
4191 It is not allowed to change text or jump to another window while
4192 evaluating 'indentexpr' |textlock|.
4193
4194
Bram Moolenaar071d4272004-06-13 20:20:40 +00004195 *'indentkeys'* *'indk'*
4196'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4197 local to buffer
4198 {not in Vi}
4199 {not available when compiled without the |+cindent|
4200 feature}
4201 A list of keys that, when typed in Insert mode, cause reindenting of
4202 the current line. Only happens if 'indentexpr' isn't empty.
4203 The format is identical to 'cinkeys', see |indentkeys-format|.
4204 See |C-indenting| and |indent-expression|.
4205
4206 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4207'infercase' 'inf' boolean (default off)
4208 local to buffer
4209 {not in Vi}
4210 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004211 'ignorecase' is also on, the case of the match is adjusted depending
4212 on the typed text. If the typed text contains a lowercase letter
4213 where the match has an upper case letter, the completed part is made
4214 lowercase. If the typed text has no lowercase letters and the match
4215 has a lowercase letter where the typed text has an uppercase letter,
4216 and there is a letter before it, the completed part is made uppercase.
4217 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218
4219 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4220'insertmode' 'im' boolean (default off)
4221 global
4222 {not in Vi}
4223 Makes Vim work in a way that Insert mode is the default mode. Useful
4224 if you want to use Vim as a modeless editor. Used for |evim|.
4225 These Insert mode commands will be useful:
4226 - Use the cursor keys to move around.
4227 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4228 this is a mapping, it is executed as if 'insertmode' was off.
4229 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004231 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4232 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233
4234 These items change when 'insertmode' is set:
4235 - when starting to edit of a file, Vim goes to Insert mode.
4236 - <Esc> in Insert mode is a no-op and beeps.
4237 - <Esc> in Normal mode makes Vim go to Insert mode.
4238 - CTRL-L in Insert mode is a command, it is not inserted.
4239 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4240 However, when <Esc> is used inside a mapping, it behaves like
4241 'insertmode' was not set. This was done to be able to use the same
4242 mappings with 'insertmode' set or not set.
4243 When executing commands with |:normal| 'insertmode' is not used.
4244
4245 NOTE: This option is reset when 'compatible' is set.
4246
4247 *'isfname'* *'isf'*
4248'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4249 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4250 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4251 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4252 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4253 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4254 global
4255 {not in Vi}
4256 The characters specified by this option are included in file names and
4257 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004258 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 Multi-byte characters 256 and above are always included, only the
4260 characters up to 255 are specified with this option.
4261 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004262 Think twice before adding white space to this option. Although a
4263 space may appear inside a file name, the effect will be that Vim
4264 doesn't know where a file name starts or ends when doing completion.
4265 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266
4267 Note that on systems using a backslash as path separator, Vim tries to
4268 do its best to make it work as you would expect. That is a bit
4269 tricky, since Vi originally used the backslash to escape special
4270 characters. Vim will not remove a backslash in front of a normal file
4271 name character on these systems, but it will on Unix and alikes. The
4272 '&' and '^' are not included by default, because these are special for
4273 cmd.exe.
4274
4275 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 Each part can be a single character number or a range. A range is two
4277 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 decimal number between 0 and 255 or the ASCII character itself (does
4279 not work for digits). Example:
4280 "_,-,128-140,#-43" (include '_' and '-' and the range
4281 128 to 140 and '#' to 43)
4282 If a part starts with '^', the following character number or range
4283 will be excluded from the option. The option is interpreted from left
4284 to right. Put the excluded character after the range where it is
4285 included. To include '^' itself use it as the last character of the
4286 option or the end of a range. Example:
4287 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4288 If the character is '@', all characters where isalpha() returns TRUE
4289 are included. Normally these are the characters a to z and A to Z,
4290 plus accented characters. To include '@' itself use "@-@". Examples:
4291 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004292 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 "a-z,A-Z,@-@" All letters plus the '@' character.
4294 A comma can be included by using it where a character number is
4295 expected. Example:
4296 "48-57,,,_" Digits, comma and underscore.
4297 A comma can be excluded by prepending a '^'. Example:
4298 " -~,^,,9" All characters from space to '~', excluding
4299 comma, plus <Tab>.
4300 See |option-backslash| about including spaces and backslashes.
4301
4302 *'isident'* *'isi'*
4303'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4304 "@,48-57,_,128-167,224-235"
4305 otherwise: "@,48-57,_,192-255")
4306 global
4307 {not in Vi}
4308 The characters given by this option are included in identifiers.
4309 Identifiers are used in recognizing environment variables and after a
4310 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004311 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 option.
4313 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004314 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4316
4317 *'iskeyword'* *'isk'*
4318'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4319 "@,48-57,_,128-167,224-235"
4320 otherwise: "@,48-57,_,192-255"
4321 Vi default: "@,48-57,_")
4322 local to buffer
4323 {not in Vi}
4324 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004325 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 'isfname' for a description of the format of this option. For C
4327 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4328 For a help file it is set to all non-blank printable characters except
4329 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4330 command).
4331 When the 'lisp' option is on the '-' character is always included.
4332 NOTE: This option is set to the Vi default value when 'compatible' is
4333 set and to the Vim default value when 'compatible' is reset.
4334
4335 *'isprint'* *'isp'*
4336'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4337 "@,~-255"; otherwise: "@,161-255")
4338 global
4339 {not in Vi}
4340 The characters given by this option are displayed directly on the
4341 screen. It is also used for "\p" in a |pattern|. The characters from
4342 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4343 even when they are not included in 'isprint' or excluded. See
4344 'isfname' for a description of the format of this option.
4345
4346 Non-printable characters are displayed with two characters:
4347 0 - 31 "^@" - "^_"
4348 32 - 126 always single characters
4349 127 "^?"
4350 128 - 159 "~@" - "~_"
4351 160 - 254 "| " - "|~"
4352 255 "~?"
4353 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4354 displayed as <xx>, with the hexadecimal value of the byte.
4355 When 'display' contains "uhex" all unprintable characters are
4356 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004357 The SpecialKey highlighting will be used for unprintable characters.
4358 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
4360 Multi-byte characters 256 and above are always included, only the
4361 characters up to 255 are specified with this option. When a character
4362 is printable but it is not available in the current font, a
4363 replacement character will be shown.
4364 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4365 There is no option to specify these characters.
4366
4367 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4368'joinspaces' 'js' boolean (default on)
4369 global
4370 {not in Vi}
4371 Insert two spaces after a '.', '?' and '!' with a join command.
4372 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4373 Otherwise only one space is inserted.
4374 NOTE: This option is set when 'compatible' is set.
4375
4376 *'key'*
4377'key' string (default "")
4378 local to buffer
4379 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004380 {only available when compiled with the |+cryptv|
4381 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004383 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 Careful: Do not set the key value by hand, someone might see the typed
4385 key. Use the |:X| command. But you can make 'key' empty: >
4386 :set key=
4387< It is not possible to get the value of this option with ":set key" or
4388 "echo &key". This is to avoid showing it to someone who shouldn't
4389 know. It also means you cannot see it yourself once you have set it,
4390 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004391 You can use "&key" in an expression to detect whether encryption is
4392 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393
4394 *'keymap'* *'kmp'* *E544*
4395'keymap' 'kmp' string (default "")
4396 local to buffer
4397 {not in Vi}
4398 {only available when compiled with the |+keymap|
4399 feature}
4400 Name of a keyboard mapping. See |mbyte-keymap|.
4401 Setting this option to a valid keymap name has the side effect of
4402 setting 'iminsert' to one, so that the keymap becomes effective.
4403 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004404 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405
4406 *'keymodel'* *'km'*
4407'keymodel' 'km' string (default "")
4408 global
4409 {not in Vi}
4410 List of comma separated words, which enable special things that keys
4411 can do. These values can be used:
4412 startsel Using a shifted special key starts selection (either
4413 Select mode or Visual mode, depending on "key" being
4414 present in 'selectmode').
4415 stopsel Using a not-shifted special key stops selection.
4416 Special keys in this context are the cursor keys, <End>, <Home>,
4417 <PageUp> and <PageDown>.
4418 The 'keymodel' option is set by the |:behave| command.
4419
4420 *'keywordprg'* *'kp'*
4421'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4422 OS/2: "view /", VMS: "help")
4423 global or local to buffer |global-local|
4424 {not in Vi}
4425 Program to use for the |K| command. Environment variables are
4426 expanded |:set_env|. ":help" may be used to access the Vim internal
4427 help. (Note that previously setting the global option to the empty
4428 value did this, which is now deprecated.)
4429 When "man" is used, Vim will automatically translate a count for the
4430 "K" command to a section number. Also for "man -s", in which case the
4431 "-s" is removed when there is no count.
4432 See |option-backslash| about including spaces and backslashes.
4433 Example: >
4434 :set keywordprg=man\ -s
4435< This option cannot be set from a |modeline| or in the |sandbox|, for
4436 security reasons.
4437
4438 *'langmap'* *'lmap'* *E357* *E358*
4439'langmap' 'lmap' string (default "")
4440 global
4441 {not in Vi}
4442 {only available when compiled with the |+langmap|
4443 feature}
4444 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004445 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004446 inserted directly. When in command mode the 'langmap' option takes
4447 care of translating these special characters to the original meaning
4448 of the key. This means you don't have to change the keyboard mode to
4449 be able to execute Normal mode commands.
4450 This is the opposite of the 'keymap' option, where characters are
4451 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004453 Example (for Greek, in UTF-8): *greek* >
4454 :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 +00004455< Example (exchanges meaning of z and y for commands): >
4456 :set langmap=zy,yz,ZY,YZ
4457<
4458 The 'langmap' option is a list of parts, separated with commas. Each
4459 part can be in one of two forms:
4460 1. A list of pairs. Each pair is a "from" character immediately
4461 followed by the "to" character. Examples: "aA", "aAbBcC".
4462 2. A list of "from" characters, a semi-colon and a list of "to"
4463 characters. Example: "abc;ABC"
4464 Example: "aA,fgh;FGH,cCdDeE"
4465 Special characters need to be preceded with a backslash. These are
4466 ";", ',' and backslash itself.
4467
4468 This will allow you to activate vim actions without having to switch
4469 back and forth between the languages. Your language characters will
4470 be understood as normal vim English characters (according to the
4471 langmap mappings) in the following cases:
4472 o Normal/Visual mode (commands, buffer/register names, user mappings)
4473 o Insert/Replace Mode: Register names after CTRL-R
4474 o Insert/Replace Mode: Mappings
4475 Characters entered in Command-line mode will NOT be affected by
4476 this option. Note that this option can be changed at any time
4477 allowing to switch between mappings for different languages/encodings.
4478 Use a mapping to avoid having to type it each time!
4479
4480 *'langmenu'* *'lm'*
4481'langmenu' 'lm' string (default "")
4482 global
4483 {not in Vi}
4484 {only available when compiled with the |+menu| and
4485 |+multi_lang| features}
4486 Language to use for menu translation. Tells which file is loaded
4487 from the "lang" directory in 'runtimepath': >
4488 "lang/menu_" . &langmenu . ".vim"
4489< (without the spaces). For example, to always use the Dutch menus, no
4490 matter what $LANG is set to: >
4491 :set langmenu=nl_NL.ISO_8859-1
4492< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004493 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 If your $LANG is set to a non-English language but you do want to use
4495 the English menus: >
4496 :set langmenu=none
4497< This option must be set before loading menus, switching on filetype
4498 detection or syntax highlighting. Once the menus are defined setting
4499 this option has no effect. But you could do this: >
4500 :source $VIMRUNTIME/delmenu.vim
4501 :set langmenu=de_DE.ISO_8859-1
4502 :source $VIMRUNTIME/menu.vim
4503< Warning: This deletes all menus that you defined yourself!
4504
4505 *'laststatus'* *'ls'*
4506'laststatus' 'ls' number (default 1)
4507 global
4508 {not in Vi}
4509 The value of this option influences when the last window will have a
4510 status line:
4511 0: never
4512 1: only if there are at least two windows
4513 2: always
4514 The screen looks nicer with a status line if you have several
4515 windows, but it takes another screen line. |status-line|
4516
4517 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4518'lazyredraw' 'lz' boolean (default off)
4519 global
4520 {not in Vi}
4521 When this option is set, the screen will not be redrawn while
4522 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004523 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 update use |:redraw|.
4525
4526 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4527'linebreak' 'lbr' boolean (default off)
4528 local to window
4529 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004530 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531 feature}
4532 If on Vim will wrap long lines at a character in 'breakat' rather
4533 than at the last character that fits on the screen. Unlike
4534 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4535 it only affects the way the file is displayed, not its contents. The
4536 value of 'showbreak' is used to put in front of wrapped lines.
4537 This option is not used when the 'wrap' option is off or 'list' is on.
4538 Note that <Tab> characters after an <EOL> are mostly not displayed
4539 with the right amount of white space.
4540
4541 *'lines'* *E593*
4542'lines' number (default 24 or terminal height)
4543 global
4544 Number of lines of the Vim window.
4545 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004546 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 When Vim is running in the GUI or in a resizable window, setting this
4548 option will cause the window size to be changed. When you only want
4549 to use the size for the GUI, put the command in your |gvimrc| file.
4550 Vim limits the number of lines to what fits on the screen. You can
4551 use this command to get the tallest window possible: >
4552 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004553< Minimum value is 2, maximum value is 1000.
4554 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 When you set this option and Vim is unable to change the physical
4556 number of lines of the display, the display may be messed up.
4557
4558 *'linespace'* *'lsp'*
4559'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4560 global
4561 {not in Vi}
4562 {only in the GUI}
4563 Number of pixel lines inserted between characters. Useful if the font
4564 uses the full character cell height, making lines touch each other.
4565 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004566 With some fonts there can be too much room between lines (to have
4567 space for ascents and descents). Then it makes sense to set
4568 'linespace' to a negative value. This may cause display problems
4569 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
4571 *'lisp'* *'nolisp'*
4572'lisp' boolean (default off)
4573 local to buffer
4574 {not available when compiled without the |+lispindent|
4575 feature}
4576 Lisp mode: When <Enter> is typed in insert mode set the indent for
4577 the next line to Lisp standards (well, sort of). Also happens with
4578 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4579 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4580 better. Also see 'lispwords'.
4581 The '-' character is included in keyword characters. Redefines the
4582 "=" operator to use this same indentation algorithm rather than
4583 calling an external program if 'equalprg' is empty.
4584 This option is not used when 'paste' is set.
4585 {Vi: Does it a little bit differently}
4586
4587 *'lispwords'* *'lw'*
4588'lispwords' 'lw' string (default is very long)
4589 global
4590 {not in Vi}
4591 {not available when compiled without the |+lispindent|
4592 feature}
4593 Comma separated list of words that influence the Lisp indenting.
4594 |'lisp'|
4595
4596 *'list'* *'nolist'*
4597'list' boolean (default off)
4598 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004599 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4600 line. Useful to see the difference between tabs and spaces and for
4601 trailing blanks. Further changed by the 'listchars' option.
4602
4603 The cursor is displayed at the start of the space a Tab character
4604 occupies, not at the end as usual in Normal mode. To get this cursor
4605 position while displaying Tabs with spaces, use: >
4606 :set list lcs=tab\ \
4607<
4608 Note that list mode will also affect formatting (set with 'textwidth'
4609 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 changing the way tabs are displayed.
4611
4612 *'listchars'* *'lcs'*
4613'listchars' 'lcs' string (default "eol:$")
4614 global
4615 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004616 Strings to use in 'list' mode and for the |:list| command. It is a
4617 comma separated list of string settings.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004618 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 eol:c Character to show at the end of each line. When
4620 omitted, there is no extra character at the end of the
4621 line.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004622 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004623 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004625 fill the space that the tab normally occupies.
4626 "tab:>-" will show a tab that takes four spaces as
4627 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004628 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004629 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004630 trailing spaces are blank.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004631 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 extends:c Character to show in the last column, when 'wrap' is
4633 off and the line continues beyond the right of the
4634 screen.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004635 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 precedes:c Character to show in the first column, when 'wrap'
4637 is off and there is text preceding the character
4638 visible in the first column.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004639 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004640 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004641 'conceallevel' is set to 1.
Bram Moolenaar30b65812012-07-12 22:01:11 +02004642 *lcs-nbsp*
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004643 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004644 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004646 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004648 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649
4650 Examples: >
4651 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004652 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004653 :set lcs=extends:>,precedes:<
4654< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004655 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004656 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
4658 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4659'loadplugins' 'lpl' boolean (default on)
4660 global
4661 {not in Vi}
4662 When on the plugin scripts are loaded when starting up |load-plugins|.
4663 This option can be reset in your |vimrc| file to disable the loading
4664 of plugins.
4665 Note that using the "-u NONE" and "--noplugin" command line arguments
4666 reset this option. |-u| |--noplugin|
4667
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004668 *'macatsui'* *'nomacatsui'*
4669'macatsui' boolean (default on)
4670 global
4671 {only available in Mac GUI version}
4672 This is a workaround for when drawing doesn't work properly. When set
4673 and compiled with multi-byte support ATSUI text drawing is used. When
4674 not set ATSUI text drawing is not used. Switch this option off when
4675 you experience drawing problems. In a future version the problems may
4676 be solved and this option becomes obsolete. Therefore use this method
4677 to unset it: >
4678 if exists('&macatsui')
4679 set nomacatsui
4680 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004681< Another option to check if you have drawing problems is
4682 'termencoding'.
4683
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684 *'magic'* *'nomagic'*
4685'magic' boolean (default on)
4686 global
4687 Changes the special characters that can be used in search patterns.
4688 See |pattern|.
4689 NOTE: To avoid portability problems with using patterns, always keep
4690 this option at the default "on". Only switch it off when working with
4691 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004692 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004693
4694 *'makeef'* *'mef'*
4695'makeef' 'mef' string (default: "")
4696 global
4697 {not in Vi}
4698 {not available when compiled without the |+quickfix|
4699 feature}
4700 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4701 and the |:grep| command.
4702 When it is empty, an internally generated temp file will be used.
4703 When "##" is included, it is replaced by a number to make the name
4704 unique. This makes sure that the ":make" command doesn't overwrite an
4705 existing file.
4706 NOT used for the ":cf" command. See 'errorfile' for that.
4707 Environment variables are expanded |:set_env|.
4708 See |option-backslash| about including spaces and backslashes.
4709 This option cannot be set from a |modeline| or in the |sandbox|, for
4710 security reasons.
4711
4712 *'makeprg'* *'mp'*
4713'makeprg' 'mp' string (default "make", VMS: "MMS")
4714 global or local to buffer |global-local|
4715 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004716 Program to use for the ":make" command. See |:make_makeprg|.
4717 This option may contain '%' and '#' characters, which are expanded to
4718 the current and alternate file name. |:_%| |:_#|
4719 Environment variables are expanded |:set_env|. See |option-backslash|
4720 about including spaces and backslashes.
4721 Note that a '|' must be escaped twice: once for ":set" and once for
4722 the interpretation of a command. When you use a filter called
4723 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 :set makeprg=gmake\ \\\|\ myfilter
4725< The placeholder "$*" can be given (even multiple times) to specify
4726 where the arguments will be included, for example: >
4727 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4728< This option cannot be set from a |modeline| or in the |sandbox|, for
4729 security reasons.
4730
4731 *'matchpairs'* *'mps'*
4732'matchpairs' 'mps' string (default "(:),{:},[:]")
4733 local to buffer
4734 {not in Vi}
4735 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004736 other.
4737 Only character pairs are allowed that are different, thus you cannot
4738 jump between two double quotes.
4739 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004740 The pairs must be separated by a comma. Example for including '<' and
4741 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 :set mps+=<:>
4743
4744< A more exotic example, to jump between the '=' and ';' in an
4745 assignment, useful for languages like C and Java: >
4746 :au FileType c,cpp,java set mps+==:;
4747
4748< For a more advanced way of using "%", see the matchit.vim plugin in
4749 the $VIMRUNTIME/macros directory. |add-local-help|
4750
4751 *'matchtime'* *'mat'*
4752'matchtime' 'mat' number (default 5)
4753 global
4754 {not in Vi}{in Nvi}
4755 Tenths of a second to show the matching paren, when 'showmatch' is
4756 set. Note that this is not in milliseconds, like other options that
4757 set a time. This is to be compatible with Nvi.
4758
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004759 *'maxcombine'* *'mco'*
4760'maxcombine' 'mco' number (default 2)
4761 global
4762 {not in Vi}
4763 {only available when compiled with the |+multi_byte|
4764 feature}
4765 The maximum number of combining characters supported for displaying.
4766 Only used when 'encoding' is "utf-8".
4767 The default is OK for most languages. Hebrew may require 4.
4768 Maximum value is 6.
4769 Even when this option is set to 2 you can still edit text with more
4770 combining characters, you just can't see them. Use |g8| or |ga|.
4771 See |mbyte-combining|.
4772
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 *'maxfuncdepth'* *'mfd'*
4774'maxfuncdepth' 'mfd' number (default 100)
4775 global
4776 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004777 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004778 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004779 Maximum depth of function calls for user functions. This normally
4780 catches endless recursion. When using a recursive function with
4781 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4782 more memory, there is the danger of failing when memory is exhausted.
4783 See also |:function|.
4784
4785 *'maxmapdepth'* *'mmd'* *E223*
4786'maxmapdepth' 'mmd' number (default 1000)
4787 global
4788 {not in Vi}
4789 Maximum number of times a mapping is done without resulting in a
4790 character to be used. This normally catches endless mappings, like
4791 ":map x y" with ":map y x". It still does not catch ":map g wg",
4792 because the 'w' is used before the next mapping is done. See also
4793 |key-mapping|.
4794
4795 *'maxmem'* *'mm'*
4796'maxmem' 'mm' number (default between 256 to 5120 (system
4797 dependent) or half the amount of memory
4798 available)
4799 global
4800 {not in Vi}
4801 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4802 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004803 other memory to be freed. The maximum usable value is about 2000000.
4804 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004806 *'maxmempattern'* *'mmp'*
4807'maxmempattern' 'mmp' number (default 1000)
4808 global
4809 {not in Vi}
4810 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004811 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004812 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004813 When Vim runs into the limit it gives an error message and mostly
4814 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004815 Running into the limit often means that the pattern is very
4816 inefficient or too complex. This may already happen with the pattern
4817 "\(.\)*" on a very long line. ".*" works much better.
4818 Vim may run out of memory before hitting the 'maxmempattern' limit.
4819
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 *'maxmemtot'* *'mmt'*
4821'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4822 dependent) or half the amount of memory
4823 available)
4824 global
4825 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004826 Maximum amount of memory in Kbyte to use for all buffers together.
4827 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4828 without a limit. On 64 bit machines higher values might work. But
4829 hey, do you really need more than 2 Gbyte for text editing?
4830 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831
4832 *'menuitems'* *'mis'*
4833'menuitems' 'mis' number (default 25)
4834 global
4835 {not in Vi}
4836 {not available when compiled without the |+menu|
4837 feature}
4838 Maximum number of items to use in a menu. Used for menus that are
4839 generated from a list of items, e.g., the Buffers menu. Changing this
4840 option has no direct effect, the menu must be refreshed first.
4841
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004842 *'mkspellmem'* *'msm'*
4843'mkspellmem' 'msm' string (default "460000,2000,500")
4844 global
4845 {not in Vi}
4846 {not available when compiled without the |+syntax|
4847 feature}
4848 Parameters for |:mkspell|. This tunes when to start compressing the
4849 word tree. Compression can be slow when there are many words, but
4850 it's needed to avoid running out of memory. The amount of memory used
4851 per word depends very much on how similar the words are, that's why
4852 this tuning is complicated.
4853
4854 There are three numbers, separated by commas:
4855 {start},{inc},{added}
4856
4857 For most languages the uncompressed word tree fits in memory. {start}
4858 gives the amount of memory in Kbyte that can be used before any
4859 compression is done. It should be a bit smaller than the amount of
4860 memory that is available to Vim.
4861
4862 When going over the {start} limit the {inc} number specifies the
4863 amount of memory in Kbyte that can be allocated before another
4864 compression is done. A low number means compression is done after
4865 less words are added, which is slow. A high number means more memory
4866 will be allocated.
4867
4868 After doing compression, {added} times 1024 words can be added before
4869 the {inc} limit is ignored and compression is done when any extra
4870 amount of memory is needed. A low number means there is a smaller
4871 chance of hitting the {inc} limit, less memory is used but it's
4872 slower.
4873
4874 The languages for which these numbers are important are Italian and
4875 Hungarian. The default works for when you have about 512 Mbyte. If
4876 you have 1 Gbyte you could use: >
4877 :set mkspellmem=900000,3000,800
4878< If you have less than 512 Mbyte |:mkspell| may fail for some
4879 languages, no matter what you set 'mkspellmem' to.
4880
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004882'modeline' 'ml' boolean (Vim default: on (off for root),
4883 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 local to buffer
4885 *'modelines'* *'mls'*
4886'modelines' 'mls' number (default 5)
4887 global
4888 {not in Vi}
4889 If 'modeline' is on 'modelines' gives the number of lines that is
4890 checked for set commands. If 'modeline' is off or 'modelines' is zero
4891 no lines are checked. See |modeline|.
4892 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4893 set and to the Vim default value when 'compatible' is reset.
4894
4895 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4896'modifiable' 'ma' boolean (default on)
4897 local to buffer
4898 {not in Vi} *E21*
4899 When off the buffer contents cannot be changed. The 'fileformat' and
4900 'fileencoding' options also can't be changed.
4901 Can be reset with the |-M| command line argument.
4902
4903 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4904'modified' 'mod' boolean (default off)
4905 local to buffer
4906 {not in Vi}
4907 When on, the buffer is considered to be modified. This option is set
4908 when:
4909 1. A change was made to the text since it was last written. Using the
4910 |undo| command to go back to the original text will reset the
4911 option. But undoing changes that were made before writing the
4912 buffer will set the option again, since the text is different from
4913 when it was written.
4914 2. 'fileformat' or 'fileencoding' is different from its original
4915 value. The original value is set when the buffer is read or
4916 written. A ":set nomodified" command also resets the original
4917 values to the current values and the 'modified' option will be
4918 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004919 This option is not set when a change is made to the buffer as the
4920 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4921 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4922 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4924 will be ignored.
4925
4926 *'more'* *'nomore'*
4927'more' boolean (Vim default: on, Vi default: off)
4928 global
4929 {not in Vi}
4930 When on, listings pause when the whole screen is filled. You will get
4931 the |more-prompt|. When this option is off there are no pauses, the
4932 listing continues until finished.
4933 NOTE: This option is set to the Vi default value when 'compatible' is
4934 set and to the Vim default value when 'compatible' is reset.
4935
4936 *'mouse'* *E538*
4937'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4938 global
4939 {not in Vi}
4940 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004941 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4942 sysmouse and Linux console with gpm). For using the mouse in the
4943 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944 The mouse can be enabled for different modes:
4945 n Normal mode
4946 v Visual mode
4947 i Insert mode
4948 c Command-line mode
4949 h all previous modes when editing a help file
4950 a all previous modes
4951 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 Normally you would enable the mouse in all four modes with: >
4953 :set mouse=a
4954< When the mouse is not enabled, the GUI will still use the mouse for
4955 modeless selection. This doesn't move the text cursor.
4956
4957 See |mouse-using|. Also see |'clipboard'|.
4958
4959 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004960 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004961 the mouse buttons can still be used by keeping the shift key pressed.
4962 Also see the 'clipboard' option.
4963
4964 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4965'mousefocus' 'mousef' boolean (default off)
4966 global
4967 {not in Vi}
4968 {only works in the GUI}
4969 The window that the mouse pointer is on is automatically activated.
4970 When changing the window layout or window focus in another way, the
4971 mouse pointer is moved to the window with keyboard focus. Off is the
4972 default because it makes using the pull down menus a little goofy, as
4973 a pointer transit may activate a window unintentionally.
4974
4975 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4976'mousehide' 'mh' boolean (default on)
4977 global
4978 {not in Vi}
4979 {only works in the GUI}
4980 When on, the mouse pointer is hidden when characters are typed.
4981 The mouse pointer is restored when the mouse is moved.
4982
4983 *'mousemodel'* *'mousem'*
4984'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4985 global
4986 {not in Vi}
4987 Sets the model to use for the mouse. The name mostly specifies what
4988 the right mouse button is used for:
4989 extend Right mouse button extends a selection. This works
4990 like in an xterm.
4991 popup Right mouse button pops up a menu. The shifted left
4992 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004993 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 popup_setpos Like "popup", but the cursor will be moved to the
4995 position where the mouse was clicked, and thus the
4996 selected operation will act upon the clicked object.
4997 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004998 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 course, that right clicking outside a selection will
5000 end Visual mode.
5001 Overview of what button does what for each model:
5002 mouse extend popup(_setpos) ~
5003 left click place cursor place cursor
5004 left drag start selection start selection
5005 shift-left search word extend selection
5006 right click extend selection popup menu (place cursor)
5007 right drag extend selection -
5008 middle click paste paste
5009
5010 In the "popup" model the right mouse button produces a pop-up menu.
5011 You need to define this first, see |popup-menu|.
5012
5013 Note that you can further refine the meaning of buttons with mappings.
5014 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5015 selection (because that's handled in the GUI code directly).
5016
5017 The 'mousemodel' option is set by the |:behave| command.
5018
5019 *'mouseshape'* *'mouses'* *E547*
5020'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005021 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 global
5023 {not in Vi}
5024 {only available when compiled with the |+mouseshape|
5025 feature}
5026 This option tells Vim what the mouse pointer should look like in
5027 different modes. The option is a comma separated list of parts, much
5028 like used for 'guicursor'. Each part consist of a mode/location-list
5029 and an argument-list:
5030 mode-list:shape,mode-list:shape,..
5031 The mode-list is a dash separated list of these modes/locations:
5032 In a normal window: ~
5033 n Normal mode
5034 v Visual mode
5035 ve Visual mode with 'selection' "exclusive" (same as 'v',
5036 if not specified)
5037 o Operator-pending mode
5038 i Insert mode
5039 r Replace mode
5040
5041 Others: ~
5042 c appending to the command-line
5043 ci inserting in the command-line
5044 cr replacing in the command-line
5045 m at the 'Hit ENTER' or 'More' prompts
5046 ml idem, but cursor in the last line
5047 e any mode, pointer below last window
5048 s any mode, pointer on a status line
5049 sd any mode, while dragging a status line
5050 vs any mode, pointer on a vertical separator line
5051 vd any mode, while dragging a vertical separator line
5052 a everywhere
5053
5054 The shape is one of the following:
5055 avail name looks like ~
5056 w x arrow Normal mouse pointer
5057 w x blank no pointer at all (use with care!)
5058 w x beam I-beam
5059 w x updown up-down sizing arrows
5060 w x leftright left-right sizing arrows
5061 w x busy The system's usual busy pointer
5062 w x no The system's usual 'no input' pointer
5063 x udsizing indicates up-down resizing
5064 x lrsizing indicates left-right resizing
5065 x crosshair like a big thin +
5066 x hand1 black hand
5067 x hand2 white hand
5068 x pencil what you write with
5069 x question big ?
5070 x rightup-arrow arrow pointing right-up
5071 w x up-arrow arrow pointing up
5072 x <number> any X11 pointer number (see X11/cursorfont.h)
5073
5074 The "avail" column contains a 'w' if the shape is available for Win32,
5075 x for X11.
5076 Any modes not specified or shapes not available use the normal mouse
5077 pointer.
5078
5079 Example: >
5080 :set mouseshape=s:udsizing,m:no
5081< will make the mouse turn to a sizing arrow over the status lines and
5082 indicate no input when the hit-enter prompt is displayed (since
5083 clicking the mouse has no effect in this state.)
5084
5085 *'mousetime'* *'mouset'*
5086'mousetime' 'mouset' number (default 500)
5087 global
5088 {not in Vi}
5089 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5090 time in msec between two mouse clicks for the second click to be
5091 recognized as a multi click.
5092
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005093 *'mzquantum'* *'mzq'*
5094'mzquantum' 'mzq' number (default 100)
5095 global
5096 {not in Vi}
5097 {not available when compiled without the |+mzscheme|
5098 feature}
5099 The number of milliseconds between polls for MzScheme threads.
5100 Negative or zero value means no thread scheduling.
5101
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 *'nrformats'* *'nf'*
5103'nrformats' 'nf' string (default "octal,hex")
5104 local to buffer
5105 {not in Vi}
5106 This defines what bases Vim will consider for numbers when using the
5107 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5108 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005109 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005111 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005112 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005113 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005114 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115 considered to be hexadecimal. Example: Using CTRL-X on
5116 "0x100" results in "0x0ff".
5117 Numbers which simply begin with a digit in the range 1-9 are always
5118 considered decimal. This also happens for numbers that are not
5119 recognized as octal or hex.
5120
5121 *'number'* *'nu'* *'nonumber'* *'nonu'*
5122'number' 'nu' boolean (default off)
5123 local to window
5124 Print the line number in front of each line. When the 'n' option is
5125 excluded from 'cpoptions' a wrapped line will not use the column of
5126 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005127 The 'numberwidth' option can be used to set the room used for the line
5128 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 When a long, wrapped line doesn't start with the first character, '-'
5130 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005131 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5132 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005133 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005135 *'numberwidth'* *'nuw'*
5136'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5137 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005138 {not in Vi}
5139 {only available when compiled with the |+linebreak|
5140 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005141 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005142 when the 'number' or 'relativenumber' option is set or printing lines
5143 with a line number. Since one space is always between the number and
5144 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005145 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005146 fit the highest line number in the buffer respectively the number of
5147 rows in the window, depending on whether 'number' or 'relativenumber'
5148 is set. Thus with the Vim default of 4 there is room for a line number
5149 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005150 The minimum value is 1, the maximum value is 10.
5151 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5152
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005153 *'omnifunc'* *'ofu'*
5154'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005155 local to buffer
5156 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005157 {not available when compiled without the |+eval|
5158 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005159 This option specifies a function to be used for Insert mode omni
5160 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005161 See |complete-functions| for an explanation of how the function is
5162 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005163 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005164 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005165 This option cannot be set from a |modeline| or in the |sandbox|, for
5166 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005167
5168
Bram Moolenaar02467872007-05-06 13:22:01 +00005169 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005170'opendevice' 'odev' boolean (default off)
5171 global
5172 {not in Vi}
5173 {only for MS-DOS, MS-Windows and OS/2}
5174 Enable reading and writing from devices. This may get Vim stuck on a
5175 device that can be opened but doesn't actually do the I/O. Therefore
5176 it is off by default.
5177 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5178 result in editing a device.
5179
5180
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005181 *'operatorfunc'* *'opfunc'*
5182'operatorfunc' 'opfunc' string (default: empty)
5183 global
5184 {not in Vi}
5185 This option specifies a function to be called by the |g@| operator.
5186 See |:map-operator| for more info and an example.
5187
5188 This option cannot be set from a |modeline| or in the |sandbox|, for
5189 security reasons.
5190
5191
Bram Moolenaar251e1912011-06-19 05:09:16 +02005192 *'osfiletype'* *'oft'*
5193'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194 local to buffer
5195 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005196 This option was supported on RISC OS, which has been removed.
5197
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198
5199 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005200'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 global
5202 Specifies the nroff macros that separate paragraphs. These are pairs
5203 of two letters (see |object-motions|).
5204
5205 *'paste'* *'nopaste'*
5206'paste' boolean (default off)
5207 global
5208 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005209 Put Vim in Paste mode. This is useful if you want to cut or copy
5210 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005211 unexpected effects.
5212 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005213 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 knows about pasting and will mostly do the right thing without 'paste'
5215 being set. The same is true for a terminal where Vim handles the
5216 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005217 This option is reset when starting the GUI. Thus if you set it in
5218 your .vimrc it will work in a terminal, but not in the GUI. Setting
5219 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5220 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 When the 'paste' option is switched on (also when it was already on):
5222 - mapping in Insert mode and Command-line mode is disabled
5223 - abbreviations are disabled
5224 - 'textwidth' is set to 0
5225 - 'wrapmargin' is set to 0
5226 - 'autoindent' is reset
5227 - 'smartindent' is reset
5228 - 'softtabstop' is set to 0
5229 - 'revins' is reset
5230 - 'ruler' is reset
5231 - 'showmatch' is reset
5232 - 'formatoptions' is used like it is empty
5233 These options keep their value, but their effect is disabled:
5234 - 'lisp'
5235 - 'indentexpr'
5236 - 'cindent'
5237 NOTE: When you start editing another file while the 'paste' option is
5238 on, settings from the modelines or autocommands may change the
5239 settings again, causing trouble when pasting text. You might want to
5240 set the 'paste' option again.
5241 When the 'paste' option is reset the mentioned options are restored to
5242 the value before the moment 'paste' was switched from off to on.
5243 Resetting 'paste' before ever setting it does not have any effect.
5244 Since mapping doesn't work while 'paste' is active, you need to use
5245 the 'pastetoggle' option to toggle the 'paste' option with some key.
5246
5247 *'pastetoggle'* *'pt'*
5248'pastetoggle' 'pt' string (default "")
5249 global
5250 {not in Vi}
5251 When non-empty, specifies the key sequence that toggles the 'paste'
5252 option. This is like specifying a mapping: >
5253 :map {keys} :set invpaste<CR>
5254< Where {keys} is the value of 'pastetoggle'.
5255 The difference is that it will work even when 'paste' is set.
5256 'pastetoggle' works in Insert mode and Normal mode, but not in
5257 Command-line mode.
5258 Mappings are checked first, thus overrule 'pastetoggle'. However,
5259 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5260 this: >
5261 :map <F10> :set paste<CR>
5262 :map <F11> :set nopaste<CR>
5263 :imap <F10> <C-O>:set paste<CR>
5264 :imap <F11> <nop>
5265 :set pastetoggle=<F11>
5266< This will make <F10> start paste mode and <F11> stop paste mode.
5267 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5268 mode everything is inserted literally, except the 'pastetoggle' key
5269 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005270 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271
5272 *'pex'* *'patchexpr'*
5273'patchexpr' 'pex' string (default "")
5274 global
5275 {not in Vi}
5276 {not available when compiled without the |+diff|
5277 feature}
5278 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005279 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280
5281 *'patchmode'* *'pm'* *E206*
5282'patchmode' 'pm' string (default "")
5283 global
5284 {not in Vi}
5285 When non-empty the oldest version of a file is kept. This can be used
5286 to keep the original version of a file if you are changing files in a
5287 source distribution. Only the first time that a file is written a
5288 copy of the original file will be kept. The name of the copy is the
5289 name of the original file with the string in the 'patchmode' option
5290 appended. This option should start with a dot. Use a string like
5291 ".org". 'backupdir' must not be empty for this to work (Detail: The
5292 backup file is renamed to the patchmode file after the new file has
5293 been successfully written, that's why it must be possible to write a
5294 backup file). If there was no file to be backed up, an empty file is
5295 created.
5296 When the 'backupskip' pattern matches, a patchmode file is not made.
5297 Using 'patchmode' for compressed files appends the extension at the
5298 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5299 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005300 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005302 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303'path' 'pa' string (default on Unix: ".,/usr/include,,"
5304 on OS/2: ".,/emx/include,,"
5305 other systems: ".,,")
5306 global or local to buffer |global-local|
5307 {not in Vi}
5308 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005309 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5310 provided that the file being searched for has a relative path (not
5311 starting with "/", "./" or "../"). The directories in the 'path'
5312 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 - Use commas to separate directory names: >
5314 :set path=.,/usr/local/include,/usr/include
5315< - Spaces can also be used to separate directory names (for backwards
5316 compatibility with version 3.0). To have a space in a directory
5317 name, precede it with an extra backslash, and escape the space: >
5318 :set path=.,/dir/with\\\ space
5319< - To include a comma in a directory name precede it with an extra
5320 backslash: >
5321 :set path=.,/dir/with\\,comma
5322< - To search relative to the directory of the current file, use: >
5323 :set path=.
5324< - To search in the current directory use an empty string between two
5325 commas: >
5326 :set path=,,
5327< - A directory name may end in a ':' or '/'.
5328 - Environment variables are expanded |:set_env|.
5329 - When using |netrw.vim| URLs can be used. For example, adding
5330 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005331 - Search upwards and downwards in a directory tree using "*", "**" and
5332 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 {not available when compiled without the |+path_extra| feature}
5334 - Careful with '\' characters, type two to get one in the option: >
5335 :set path=.,c:\\include
5336< Or just use '/' instead: >
5337 :set path=.,c:/include
5338< Don't forget "." or files won't even be found in the same directory as
5339 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005340 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 it is something like 256 or 1024 characters.
5342 You can check if all the include files are found, using the value of
5343 'path', see |:checkpath|.
5344 The use of |:set+=| and |:set-=| is preferred when adding or removing
5345 directories from the list. This avoids problems when a future version
5346 uses another default. To remove the current directory use: >
5347 :set path-=
5348< To add the current directory use: >
5349 :set path+=
5350< To use an environment variable, you probably need to replace the
5351 separator. Here is an example to append $INCL, in which directory
5352 names are separated with a semi-colon: >
5353 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5354< Replace the ';' with a ':' or whatever separator is used. Note that
5355 this doesn't work when $INCL contains a comma or white space.
5356
5357 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5358'preserveindent' 'pi' boolean (default off)
5359 local to buffer
5360 {not in Vi}
5361 When changing the indent of the current line, preserve as much of the
5362 indent structure as possible. Normally the indent is replaced by a
5363 series of tabs followed by spaces as required (unless |'expandtab'| is
5364 enabled, in which case only spaces are used). Enabling this option
5365 means the indent will preserve as many existing characters as possible
5366 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005367 'expandtab' does not apply to the preserved white space, a Tab remains
5368 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369 NOTE: When using ">>" multiple times the resulting indent is a mix of
5370 tabs and spaces. You might not like this.
5371 NOTE: 'preserveindent' is reset when 'compatible' is set.
5372 Also see 'copyindent'.
5373 Use |:retab| to clean up white space.
5374
5375 *'previewheight'* *'pvh'*
5376'previewheight' 'pvh' number (default 12)
5377 global
5378 {not in Vi}
5379 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005380 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381 Default height for a preview window. Used for |:ptag| and associated
5382 commands. Used for |CTRL-W_}| when no count is given.
5383
5384 *'previewwindow'* *'nopreviewwindow'*
5385 *'pvw'* *'nopvw'* *E590*
5386'previewwindow' 'pvw' boolean (default off)
5387 local to window
5388 {not in Vi}
5389 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005390 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005391 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 set. It's normally not set directly, but by using one of the commands
5393 |:ptag|, |:pedit|, etc.
5394
5395 *'printdevice'* *'pdev'*
5396'printdevice' 'pdev' string (default empty)
5397 global
5398 {not in Vi}
5399 {only available when compiled with the |+printer|
5400 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005401 The name of the printer to be used for |:hardcopy|.
5402 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005403 This option cannot be set from a |modeline| or in the |sandbox|, for
5404 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405
Bram Moolenaar8299df92004-07-10 09:47:34 +00005406 *'printencoding'* *'penc'*
5407'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 global
5409 {not in Vi}
5410 {only available when compiled with the |+printer|
5411 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005412 Sets the character encoding used when printing.
5413 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
5415 *'printexpr'* *'pexpr'*
5416'printexpr' 'pexpr' String (default: see below)
5417 global
5418 {not in Vi}
5419 {only available when compiled with the |+printer|
5420 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005421 Expression used to print the PostScript produced with |:hardcopy|.
5422 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005423
Bram Moolenaar8299df92004-07-10 09:47:34 +00005424 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005425'printfont' 'pfn' string (default "courier")
5426 global
5427 {not in Vi}
5428 {only available when compiled with the |+printer|
5429 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005430 The name of the font that will be used for |:hardcopy|.
5431 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005432
5433 *'printheader'* *'pheader'*
5434'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5435 global
5436 {not in Vi}
5437 {only available when compiled with the |+printer|
5438 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005439 The format of the header produced in |:hardcopy| output.
5440 See |pheader-option|.
5441
5442 *'printmbcharset'* *'pmbcs'*
5443'printmbcharset' 'pmbcs' string (default "")
5444 global
5445 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005446 {only available when compiled with the |+printer|,
5447 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005448 The CJK character set to be used for CJK output from |:hardcopy|.
5449 See |pmbcs-option|.
5450
5451 *'printmbfont'* *'pmbfn'*
5452'printmbfont' 'pmbfn' string (default "")
5453 global
5454 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005455 {only available when compiled with the |+printer|,
5456 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005457 List of font names to be used for CJK output from |:hardcopy|.
5458 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459
5460 *'printoptions'* *'popt'*
5461'printoptions' 'popt' string (default "")
5462 global
5463 {not in Vi}
5464 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005465 List of items that control the format of the output of |:hardcopy|.
5466 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005468 *'prompt'* *'noprompt'*
5469'prompt' boolean (default on)
5470 global
5471 When on a ":" prompt is used in Ex mode.
5472
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005473 *'pumheight'* *'ph'*
5474'pumheight' 'ph' number (default 0)
5475 global
5476 {not available when compiled without the
5477 |+insert_expand| feature}
5478 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005479 Determines the maximum number of items to show in the popup menu for
5480 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005481 |ins-completion-menu|.
5482
5483
Bram Moolenaar677ee682005-01-27 14:41:15 +00005484 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005485'quoteescape' 'qe' string (default "\")
5486 local to buffer
5487 {not in Vi}
5488 The characters that are used to escape quotes in a string. Used for
5489 objects like a', a" and a` |a'|.
5490 When one of the characters in this option is found inside a string,
5491 the following character will be skipped. The default value makes the
5492 text "foo\"bar\\" considered to be one string.
5493
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5495'readonly' 'ro' boolean (default off)
5496 local to buffer
5497 If on, writes fail unless you use a '!'. Protects you from
5498 accidentally overwriting a file. Default on when Vim is started
5499 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005500 When using ":w!" the 'readonly' option is reset for the current
5501 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005503 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005505 *'redrawtime'* *'rdt'*
5506'redrawtime' 'rdt' number (default 2000)
5507 global
5508 {not in Vi}
5509 {only available when compiled with the |+reltime|
5510 feature}
5511 The time in milliseconds for redrawing the display. This applies to
5512 searching for patterns for 'hlsearch' and |:match| highlighting.
5513 When redrawing takes more than this many milliseconds no further
5514 matches will be highlighted. This is used to avoid that Vim hangs
5515 when using a very complicated pattern.
5516
Bram Moolenaar64486672010-05-16 15:46:46 +02005517 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5518'relativenumber' 'rnu' boolean (default off)
5519 local to window
5520 {not in Vi}
5521 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005522 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005523 precede some vertical motion commands (e.g. j k + -) with, without
5524 having to calculate it yourself. Especially useful in combination with
5525 other commands (e.g. y d c < > gq gw =).
5526 When the 'n' option is excluded from 'cpoptions' a wrapped
5527 line will not use the column of line numbers (this is the default when
5528 'compatible' isn't set).
5529 The 'numberwidth' option can be used to set the room used for the line
5530 number.
5531 When a long, wrapped line doesn't start with the first character, '-'
5532 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005533 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5534 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005535 When setting this option, 'number' is reset.
5536
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 *'remap'* *'noremap'*
5538'remap' boolean (default on)
5539 global
5540 Allows for mappings to work recursively. If you do not want this for
5541 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005542 NOTE: To avoid portability problems with Vim scripts, always keep
5543 this option at the default "on". Only switch it off when working with
5544 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005545
5546 *'report'*
5547'report' number (default 2)
5548 global
5549 Threshold for reporting number of lines changed. When the number of
5550 changed lines is more than 'report' a message will be given for most
5551 ":" commands. If you want it always, set 'report' to 0.
5552 For the ":substitute" command the number of substitutions is used
5553 instead of the number of lines.
5554
5555 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5556'restorescreen' 'rs' boolean (default on)
5557 global
5558 {not in Vi} {only in Windows 95/NT console version}
5559 When set, the screen contents is restored when exiting Vim. This also
5560 happens when executing external commands.
5561
5562 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5563 options in your .vimrc. To disable restoring:
5564 set t_ti= t_te=
5565 To enable restoring (for an xterm):
5566 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5567 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5568
5569 *'revins'* *'ri'* *'norevins'* *'nori'*
5570'revins' 'ri' boolean (default off)
5571 global
5572 {not in Vi}
5573 {only available when compiled with the |+rightleft|
5574 feature}
5575 Inserting characters in Insert mode will work backwards. See "typing
5576 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5577 command in Insert mode, when 'allowrevins' is set.
5578 NOTE: This option is reset when 'compatible' or 'paste' is set.
5579
5580 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5581'rightleft' 'rl' boolean (default off)
5582 local to window
5583 {not in Vi}
5584 {only available when compiled with the |+rightleft|
5585 feature}
5586 When on, display orientation becomes right-to-left, i.e., characters
5587 that are stored in the file appear from the right to the left.
5588 Using this option, it is possible to edit files for languages that
5589 are written from the right to the left such as Hebrew and Arabic.
5590 This option is per window, so it is possible to edit mixed files
5591 simultaneously, or to view the same file in both ways (this is
5592 useful whenever you have a mixed text file with both right-to-left
5593 and left-to-right strings so that both sets are displayed properly
5594 in different windows). Also see |rileft.txt|.
5595
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005596 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597'rightleftcmd' 'rlc' string (default "search")
5598 local to window
5599 {not in Vi}
5600 {only available when compiled with the |+rightleft|
5601 feature}
5602 Each word in this option enables the command line editing to work in
5603 right-to-left mode for a group of commands:
5604
5605 search "/" and "?" commands
5606
5607 This is useful for languages such as Hebrew, Arabic and Farsi.
5608 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5609
5610 *'ruler'* *'ru'* *'noruler'* *'noru'*
5611'ruler' 'ru' boolean (default off)
5612 global
5613 {not in Vi}
5614 {not available when compiled without the
5615 |+cmdline_info| feature}
5616 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005617 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 text in the file is shown on the far right:
5619 Top first line is visible
5620 Bot last line is visible
5621 All first and last line are visible
5622 45% relative position in the file
5623 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005624 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005625 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005626 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 this option takes precedence over 'ruler' and 'rulerformat'
5628 If the number of characters displayed is different from the number of
5629 bytes in the text (e.g., for a TAB or a multi-byte character), both
5630 the text column (byte number) and the screen column are shown,
5631 separated with a dash.
5632 For an empty line "0-1" is shown.
5633 For an empty buffer the line number will also be zero: "0,0-1".
5634 This option is reset when the 'paste' option is set.
5635 If you don't want to see the ruler all the time but want to know where
5636 you are, use "g CTRL-G" |g_CTRL-G|.
5637 NOTE: This option is reset when 'compatible' is set.
5638
5639 *'rulerformat'* *'ruf'*
5640'rulerformat' 'ruf' string (default empty)
5641 global
5642 {not in Vi}
5643 {not available when compiled without the |+statusline|
5644 feature}
5645 When this option is not empty, it determines the content of the ruler
5646 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005647 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 The default ruler width is 17 characters. To make the ruler 15
5649 characters wide, put "%15(" at the start and "%)" at the end.
5650 Example: >
5651 :set rulerformat=%15(%c%V\ %p%%%)
5652<
5653 *'runtimepath'* *'rtp'* *vimfiles*
5654'runtimepath' 'rtp' string (default:
5655 Unix: "$HOME/.vim,
5656 $VIM/vimfiles,
5657 $VIMRUNTIME,
5658 $VIM/vimfiles/after,
5659 $HOME/.vim/after"
5660 Amiga: "home:vimfiles,
5661 $VIM/vimfiles,
5662 $VIMRUNTIME,
5663 $VIM/vimfiles/after,
5664 home:vimfiles/after"
5665 PC, OS/2: "$HOME/vimfiles,
5666 $VIM/vimfiles,
5667 $VIMRUNTIME,
5668 $VIM/vimfiles/after,
5669 $HOME/vimfiles/after"
5670 Macintosh: "$VIM:vimfiles,
5671 $VIMRUNTIME,
5672 $VIM:vimfiles:after"
5673 RISC-OS: "Choices:vimfiles,
5674 $VIMRUNTIME,
5675 Choices:vimfiles/after"
5676 VMS: "sys$login:vimfiles,
5677 $VIM/vimfiles,
5678 $VIMRUNTIME,
5679 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005680 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005681 global
5682 {not in Vi}
5683 This is a list of directories which will be searched for runtime
5684 files:
5685 filetype.vim filetypes by file name |new-filetype|
5686 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005687 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 colors/ color scheme files |:colorscheme|
5689 compiler/ compiler files |:compiler|
5690 doc/ documentation |write-local-help|
5691 ftplugin/ filetype plugins |write-filetype-plugin|
5692 indent/ indent scripts |indent-expression|
5693 keymap/ key mapping files |mbyte-keymap|
5694 lang/ menu translations |:menutrans|
5695 menu.vim GUI menus |menu.vim|
5696 plugin/ plugin scripts |write-plugin|
5697 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005698 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005699 syntax/ syntax files |mysyntaxfile|
5700 tutor/ files for vimtutor |tutor|
5701
5702 And any other file searched for with the |:runtime| command.
5703
5704 The defaults for most systems are setup to search five locations:
5705 1. In your home directory, for your personal preferences.
5706 2. In a system-wide Vim directory, for preferences from the system
5707 administrator.
5708 3. In $VIMRUNTIME, for files distributed with Vim.
5709 *after-directory*
5710 4. In the "after" directory in the system-wide Vim directory. This is
5711 for the system administrator to overrule or add to the distributed
5712 defaults (rarely needed)
5713 5. In the "after" directory in your home directory. This is for
5714 personal preferences to overrule or add to the distributed defaults
5715 or system-wide settings (rarely needed).
5716
5717 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5718 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005719 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 wildcards.
5721 See |:runtime|.
5722 Example: >
5723 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5724< This will use the directory "~/vimruntime" first (containing your
5725 personal Vim runtime files), then "/mygroup/vim" (shared between a
5726 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5727 files).
5728 You probably should always include $VIMRUNTIME somewhere, to use the
5729 distributed runtime files. You can put a directory before $VIMRUNTIME
5730 to find files which replace a distributed runtime files. You can put
5731 a directory after $VIMRUNTIME to find files which add to distributed
5732 runtime files.
5733 This option cannot be set from a |modeline| or in the |sandbox|, for
5734 security reasons.
5735
5736 *'scroll'* *'scr'*
5737'scroll' 'scr' number (default: half the window height)
5738 local to window
5739 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5740 set to half the number of lines in the window when the window size
5741 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005742 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5744 the number of screen lines instead of file lines, makes a difference
5745 when lines wrap}
5746
5747 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5748'scrollbind' 'scb' boolean (default off)
5749 local to window
5750 {not in Vi}
5751 {not available when compiled without the |+scrollbind|
5752 feature}
5753 See also |scroll-binding|. When this option is set, the current
5754 window scrolls as other scrollbind windows (windows that also have
5755 this option set) scroll. This option is useful for viewing the
5756 differences between two versions of a file, see 'diff'.
5757 See |'scrollopt'| for options that determine how this option should be
5758 interpreted.
5759 This option is mostly reset when splitting a window to edit another
5760 file. This means that ":split | edit file" results in two windows
5761 with scroll-binding, but ":split file" does not.
5762
5763 *'scrolljump'* *'sj'*
5764'scrolljump' 'sj' number (default 1)
5765 global
5766 {not in Vi}
5767 Minimal number of lines to scroll when the cursor gets off the
5768 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5769 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005770 When set to a negative number from -1 to -100 this is used as the
5771 percentage of the window height. Thus -50 scrolls half the window
5772 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 NOTE: This option is set to 1 when 'compatible' is set.
5774
5775 *'scrolloff'* *'so'*
5776'scrolloff' 'so' number (default 0)
5777 global
5778 {not in Vi}
5779 Minimal number of screen lines to keep above and below the cursor.
5780 This will make some context visible around where you are working. If
5781 you set it to a very large value (999) the cursor line will always be
5782 in the middle of the window (except at the start or end of the file or
5783 when long lines wrap).
5784 For scrolling horizontally see 'sidescrolloff'.
5785 NOTE: This option is set to 0 when 'compatible' is set.
5786
5787 *'scrollopt'* *'sbo'*
5788'scrollopt' 'sbo' string (default "ver,jump")
5789 global
5790 {not available when compiled without the |+scrollbind|
5791 feature}
5792 {not in Vi}
5793 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005794 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5795 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005796 The following words are available:
5797 ver Bind vertical scrolling for 'scrollbind' windows
5798 hor Bind horizontal scrolling for 'scrollbind' windows
5799 jump Applies to the offset between two windows for vertical
5800 scrolling. This offset is the difference in the first
5801 displayed line of the bound windows. When moving
5802 around in a window, another 'scrollbind' window may
5803 reach a position before the start or after the end of
5804 the buffer. The offset is not changed though, when
5805 moving back the 'scrollbind' window will try to scroll
5806 to the desired position when possible.
5807 When now making that window the current one, two
5808 things can be done with the relative offset:
5809 1. When "jump" is not included, the relative offset is
5810 adjusted for the scroll position in the new current
5811 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005812 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 2. When "jump" is included, the other windows are
5814 scrolled to keep the same relative offset. When
5815 going back to the other window, it still uses the
5816 same relative offset.
5817 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005818 When 'diff' mode is active there always is vertical scroll binding,
5819 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005820
5821 *'sections'* *'sect'*
5822'sections' 'sect' string (default "SHNHH HUnhsh")
5823 global
5824 Specifies the nroff macros that separate sections. These are pairs of
5825 two letters (See |object-motions|). The default makes a section start
5826 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5827
5828 *'secure'* *'nosecure'* *E523*
5829'secure' boolean (default off)
5830 global
5831 {not in Vi}
5832 When on, ":autocmd", shell and write commands are not allowed in
5833 ".vimrc" and ".exrc" in the current directory and map commands are
5834 displayed. Switch it off only if you know that you will not run into
5835 problems, or when the 'exrc' option is off. On Unix this option is
5836 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005837 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 'secure' at the end of your ~/.vimrc then.
5839 This option cannot be set from a |modeline| or in the |sandbox|, for
5840 security reasons.
5841
5842 *'selection'* *'sel'*
5843'selection' 'sel' string (default "inclusive")
5844 global
5845 {not in Vi}
5846 This option defines the behavior of the selection. It is only used
5847 in Visual and Select mode.
5848 Possible values:
5849 value past line inclusive ~
5850 old no yes
5851 inclusive yes yes
5852 exclusive yes no
5853 "past line" means that the cursor is allowed to be positioned one
5854 character past the line.
5855 "inclusive" means that the last character of the selection is included
5856 in an operation. For example, when "x" is used to delete the
5857 selection.
5858 Note that when "exclusive" is used and selecting from the end
5859 backwards, you cannot include the last character of a line, when
5860 starting in Normal mode and 'virtualedit' empty.
5861
5862 The 'selection' option is set by the |:behave| command.
5863
5864 *'selectmode'* *'slm'*
5865'selectmode' 'slm' string (default "")
5866 global
5867 {not in Vi}
5868 This is a comma separated list of words, which specifies when to start
5869 Select mode instead of Visual mode, when a selection is started.
5870 Possible values:
5871 mouse when using the mouse
5872 key when using shifted special keys
5873 cmd when using "v", "V" or CTRL-V
5874 See |Select-mode|.
5875 The 'selectmode' option is set by the |:behave| command.
5876
5877 *'sessionoptions'* *'ssop'*
5878'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005879 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880 global
5881 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005882 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 feature}
5884 Changes the effect of the |:mksession| command. It is a comma
5885 separated list of words. Each word enables saving and restoring
5886 something:
5887 word save and restore ~
5888 blank empty windows
5889 buffers hidden and unloaded buffers, not just those in windows
5890 curdir the current directory
5891 folds manually created folds, opened/closed folds and local
5892 fold options
5893 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005894 and contain at least one lowercase letter. Only
5895 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 help the help window
5897 localoptions options and mappings local to a window or buffer (not
5898 global values for local options)
5899 options all options and mappings (also global values for local
5900 options)
5901 resize size of the Vim window: 'lines' and 'columns'
5902 sesdir the directory in which the session file is located
5903 will become the current directory (useful with
5904 projects accessed over a network from different
5905 systems)
5906 slash backslashes in file names replaced with forward
5907 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005908 tabpages all tab pages; without this only the current tab page
5909 is restored, so that you can make a session for each
5910 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005911 unix with Unix end-of-line format (single <NL>), even when
5912 on Windows or DOS
5913 winpos position of the whole Vim window
5914 winsize window sizes
5915
5916 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005917 When neither "curdir" nor "sesdir" is included, file names are stored
5918 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005919 "slash" and "unix" are useful on Windows when sharing session files
5920 with Unix. The Unix version of Vim cannot source dos format scripts,
5921 but the Windows version of Vim can source unix format scripts.
5922
5923 *'shell'* *'sh'* *E91*
5924'shell' 'sh' string (default $SHELL or "sh",
5925 MS-DOS and Win32: "command.com" or
5926 "cmd.exe", OS/2: "cmd")
5927 global
5928 Name of the shell to use for ! and :! commands. When changing the
5929 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5930 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005931 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005932 See |option-backslash| about including spaces and backslashes.
5933 Environment variables are expanded |:set_env|.
5934 If the name of the shell contains a space, you might need to enclose
5935 it in quotes. Example: >
5936 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5937< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005938 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005939 "-f" is not inside the quotes, because it is not part of the command
5940 name. And Vim automagically recognizes the backslashes that are path
5941 separators.
5942 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5943 variable to change the way external commands are executed. See the
5944 libc.inf file of DJGPP.
5945 Under MS-Windows, when the executable ends in ".com" it must be
5946 included. Thus setting the shell to "command.com" or "4dos.com"
5947 works, but "command" and "4dos" do not work for all commands (e.g.,
5948 filtering).
5949 For unknown reasons, when using "4dos.com" the current directory is
5950 changed to "C:\". To avoid this set 'shell' like this: >
5951 :set shell=command.com\ /c\ 4dos
5952< This option cannot be set from a |modeline| or in the |sandbox|, for
5953 security reasons.
5954
5955 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005956'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005957 MS-DOS and Win32, when 'shell' does not
5958 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 global
5960 {not in Vi}
5961 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5962 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5963 systems, the default is set according to the value of 'shell', to
5964 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005965 OS/2 (EMX figures this out itself).
5966 On Unix it can have more than one flag. Each white space separated
5967 part is passed as an argument to the shell command.
5968 See |option-backslash| about including spaces and backslashes.
5969 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 This option cannot be set from a |modeline| or in the |sandbox|, for
5971 security reasons.
5972
5973 *'shellpipe'* *'sp'*
5974'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5975 global
5976 {not in Vi}
5977 {not available when compiled without the |+quickfix|
5978 feature}
5979 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005980 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 including spaces and backslashes.
5982 The name of the temporary file can be represented by "%s" if necessary
5983 (the file name is appended automatically if no %s appears in the value
5984 of this option).
5985 For the Amiga and MS-DOS the default is ">". The output is directly
5986 saved in a file and not echoed to the screen.
5987 For Unix the default it "| tee". The stdout of the compiler is saved
5988 in a file and echoed to the screen. If the 'shell' option is "csh" or
5989 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005990 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5991 default becomes "2>&1| tee". This means that stderr is also included.
5992 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5993 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005994 The initialization of this option is done after reading the ".vimrc"
5995 and the other initializations, so that when the 'shell' option is set
5996 there, the 'shellpipe' option changes automatically, unless it was
5997 explicitly set before.
5998 When 'shellpipe' is set to an empty string, no redirection of the
5999 ":make" output will be done. This is useful if you use a 'makeprg'
6000 that writes to 'makeef' by itself. If you want no piping, but do
6001 want to include the 'makeef', set 'shellpipe' to a single space.
6002 Don't forget to precede the space with a backslash: ":set sp=\ ".
6003 In the future pipes may be used for filtering and this option will
6004 become obsolete (at least for Unix).
6005 This option cannot be set from a |modeline| or in the |sandbox|, for
6006 security reasons.
6007
6008 *'shellquote'* *'shq'*
6009'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6010 contains "sh" somewhere: "\"")
6011 global
6012 {not in Vi}
6013 Quoting character(s), put around the command passed to the shell, for
6014 the "!" and ":!" commands. The redirection is kept outside of the
6015 quoting. See 'shellxquote' to include the redirection. It's
6016 probably not useful to set both options.
6017 This is an empty string by default. Only known to be useful for
6018 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6019 or bash, where it should be "\"". The default is adjusted according
6020 the value of 'shell', to reduce the need to set this option by the
6021 user. See |dos-shell|.
6022 This option cannot be set from a |modeline| or in the |sandbox|, for
6023 security reasons.
6024
6025 *'shellredir'* *'srr'*
6026'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6027 global
6028 {not in Vi}
6029 String to be used to put the output of a filter command in a temporary
6030 file. See also |:!|. See |option-backslash| about including spaces
6031 and backslashes.
6032 The name of the temporary file can be represented by "%s" if necessary
6033 (the file name is appended automatically if no %s appears in the value
6034 of this option).
6035 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6036 or "zsh" during initializations, the default becomes ">&". If the
6037 'shell' option is "sh", "ksh" or "bash" the default becomes
6038 ">%s 2>&1". This means that stderr is also included.
6039 For Win32, the Unix checks are done and additionally "cmd" is checked
6040 for, which makes the default ">%s 2>&1". Also, the same names with
6041 ".exe" appended are checked for.
6042 The initialization of this option is done after reading the ".vimrc"
6043 and the other initializations, so that when the 'shell' option is set
6044 there, the 'shellredir' option changes automatically unless it was
6045 explicitly set before.
6046 In the future pipes may be used for filtering and this option will
6047 become obsolete (at least for Unix).
6048 This option cannot be set from a |modeline| or in the |sandbox|, for
6049 security reasons.
6050
6051 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6052'shellslash' 'ssl' boolean (default off)
6053 global
6054 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6055 When set, a forward slash is used when expanding file names. This is
6056 useful when a Unix-like shell is used instead of command.com or
6057 cmd.exe. Backward slashes can still be typed, but they are changed to
6058 forward slashes by Vim.
6059 Note that setting or resetting this option has no effect for some
6060 existing file names, thus this option needs to be set before opening
6061 any file for best results. This might change in the future.
6062 'shellslash' only works when a backslash can be used as a path
6063 separator. To test if this is so use: >
6064 if exists('+shellslash')
6065<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006066 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6067'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6068 global
6069 {not in Vi}
6070 When on, use temp files for shell commands. When off use a pipe.
6071 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006072 Currently a pipe is only supported on Unix and MS-Windows 2K and
6073 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006074 :if has("filterpipe")
6075< The advantage of using a pipe is that nobody can read the temp file
6076 and the 'shell' command does not need to support redirection.
6077 The advantage of using a temp file is that the file type and encoding
6078 can be detected.
6079 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6080 |FilterWritePost| autocommands event are not triggered when
6081 'shelltemp' is off.
6082
Bram Moolenaar071d4272004-06-13 20:20:40 +00006083 *'shelltype'* *'st'*
6084'shelltype' 'st' number (default 0)
6085 global
6086 {not in Vi} {only for the Amiga}
6087 On the Amiga this option influences the way how the commands work
6088 which use a shell.
6089 0 and 1: always use the shell
6090 2 and 3: use the shell only to filter lines
6091 4 and 5: use shell only for ':sh' command
6092 When not using the shell, the command is executed directly.
6093
6094 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6095 1 and 3: use "shell cmd" to start external commands
6096
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006097 *'shellxescape'* *'sxe'*
6098'shellxescape' 'sxe' string (default: "";
6099 for MS-DOS and MS-Windows: "\"&|<>()@^")
6100 global
6101 {not in Vi}
6102 When 'shellxquote' is set to "(" then the characters listed in this
6103 option will be escaped with a '^' character. This makes it possible
6104 to execute most external commands with cmd.exe.
6105
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 *'shellxquote'* *'sxq'*
6107'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006108 for Win32, when 'shell' is cmd.exe: "("
6109 for Win32, when 'shell' contains "sh"
6110 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006111 for Unix, when using system(): "\"")
6112 global
6113 {not in Vi}
6114 Quoting character(s), put around the command passed to the shell, for
6115 the "!" and ":!" commands. Includes the redirection. See
6116 'shellquote' to exclude the redirection. It's probably not useful
6117 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006118 When the value is '(' then ')' is appended. When the value is '"('
6119 then ')"' is appended.
6120 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006121 This is an empty string by default on most systems, but is known to be
6122 useful for on Win32 version, either for cmd.exe which automatically
6123 strips off the first and last quote on a command, or 3rd-party shells
6124 such as the MKS Korn Shell or bash, where it should be "\"". The
6125 default is adjusted according the value of 'shell', to reduce the need
6126 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 This option cannot be set from a |modeline| or in the |sandbox|, for
6128 security reasons.
6129
6130 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6131'shiftround' 'sr' boolean (default off)
6132 global
6133 {not in Vi}
6134 Round indent to multiple of 'shiftwidth'. Applies to > and <
6135 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6136 a multiple of 'shiftwidth' (this is Vi compatible).
6137 NOTE: This option is reset when 'compatible' is set.
6138
6139 *'shiftwidth'* *'sw'*
6140'shiftwidth' 'sw' number (default 8)
6141 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006142 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006144 When zero the 'ts' value will be used. Use the |shiftwidth()|
6145 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146
6147 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006148'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6149 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 global
6151 {not in Vi}
6152 This option helps to avoid all the |hit-enter| prompts caused by file
6153 messages, for example with CTRL-G, and to avoid some other messages.
6154 It is a list of flags:
6155 flag meaning when present ~
6156 f use "(3 of 5)" instead of "(file 3 of 5)"
6157 i use "[noeol]" instead of "[Incomplete last line]"
6158 l use "999L, 888C" instead of "999 lines, 888 characters"
6159 m use "[+]" instead of "[Modified]"
6160 n use "[New]" instead of "[New File]"
6161 r use "[RO]" instead of "[readonly]"
6162 w use "[w]" instead of "written" for file write message
6163 and "[a]" instead of "appended" for ':w >> file' command
6164 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6165 "[unix format]" and "[mac]" instead of "[mac format]".
6166 a all of the above abbreviations
6167
6168 o overwrite message for writing a file with subsequent message
6169 for reading a file (useful for ":wn" or when 'autowrite' on)
6170 O message for reading a file overwrites any previous message.
6171 Also for quickfix message (e.g., ":cn").
6172 s don't give "search hit BOTTOM, continuing at TOP" or "search
6173 hit TOP, continuing at BOTTOM" messages
6174 t truncate file message at the start if it is too long to fit
6175 on the command-line, "<" will appear in the left most column.
6176 Ignored in Ex mode.
6177 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006178 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 Ignored in Ex mode.
6180 W don't give "written" or "[w]" when writing a file
6181 A don't give the "ATTENTION" message when an existing swap file
6182 is found.
6183 I don't give the intro message when starting Vim |:intro|.
6184
6185 This gives you the opportunity to avoid that a change between buffers
6186 requires you to hit <Enter>, but still gives as useful a message as
6187 possible for the space available. To get the whole message that you
6188 would have got with 'shm' empty, use ":file!"
6189 Useful values:
6190 shm= No abbreviation of message.
6191 shm=a Abbreviation, but no loss of information.
6192 shm=at Abbreviation, and truncate message when necessary.
6193
6194 NOTE: This option is set to the Vi default value when 'compatible' is
6195 set and to the Vim default value when 'compatible' is reset.
6196
6197 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6198'shortname' 'sn' boolean (default off)
6199 local to buffer
6200 {not in Vi, not in MS-DOS versions}
6201 Filenames are assumed to be 8 characters plus one extension of 3
6202 characters. Multiple dots in file names are not allowed. When this
6203 option is on, dots in file names are replaced with underscores when
6204 adding an extension (".~" or ".swp"). This option is not available
6205 for MS-DOS, because then it would always be on. This option is useful
6206 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6207 or crossdos. When running the Win32 GUI version under Win32s, this
6208 option is always on by default.
6209
6210 *'showbreak'* *'sbr'* *E595*
6211'showbreak' 'sbr' string (default "")
6212 global
6213 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006214 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 feature}
6216 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006217 values are "> " or "+++ ": >
6218 :set showbreak=>\
6219< Note the backslash to escape the trailing space. It's easier like
6220 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006221 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006222< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 comma (in a future version the comma might be used to separate the
6224 part that is shown at the end and at the start of a line).
6225 The characters are highlighted according to the '@' flag in
6226 'highlight'.
6227 Note that tabs after the showbreak will be displayed differently.
6228 If you want the 'showbreak' to appear in between line numbers, add the
6229 "n" flag to 'cpoptions'.
6230
6231 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6232'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6233 off)
6234 global
6235 {not in Vi}
6236 {not available when compiled without the
6237 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006238 Show (partial) command in the last line of the screen. Set this
6239 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006240 In Visual mode the size of the selected area is shown:
6241 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006242 If the number of bytes is different it is also displayed: "2-6"
6243 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006245 - When selecting a block, the size in screen characters:
6246 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 NOTE: This option is set to the Vi default value when 'compatible' is
6248 set and to the Vim default value when 'compatible' is reset.
6249
6250 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6251'showfulltag' 'sft' boolean (default off)
6252 global
6253 {not in Vi}
6254 When completing a word in insert mode (see |ins-completion|) from the
6255 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006256 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 matched a C function, you can see a template for what arguments are
6258 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006259 Note that this doesn't work well together with having "longest" in
6260 'completeopt', because the completion from the search pattern may not
6261 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262
6263 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6264'showmatch' 'sm' boolean (default off)
6265 global
6266 When a bracket is inserted, briefly jump to the matching one. The
6267 jump is only done if the match can be seen on the screen. The time to
6268 show the match can be set with 'matchtime'.
6269 A Beep is given if there is no match (no matter if the match can be
6270 seen or not). This option is reset when the 'paste' option is set.
6271 When the 'm' flag is not included in 'cpoptions', typing a character
6272 will immediately move the cursor back to where it belongs.
6273 See the "sm" field in 'guicursor' for setting the cursor shape and
6274 blinking when showing the match.
6275 The 'matchpairs' option can be used to specify the characters to show
6276 matches for. 'rightleft' and 'revins' are used to look for opposite
6277 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006278 Also see the matchparen plugin for highlighting the match when moving
6279 around |pi_paren.txt|.
6280 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281
6282 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6283'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6284 global
6285 If in Insert, Replace or Visual mode put a message on the last line.
6286 Use the 'M' flag in 'highlight' to set the type of highlighting for
6287 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006288 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 doesn't mean XIM is really active, especially when 'imactivatekey' is
6290 not set.
6291 NOTE: This option is set to the Vi default value when 'compatible' is
6292 set and to the Vim default value when 'compatible' is reset.
6293
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006294 *'showtabline'* *'stal'*
6295'showtabline' 'stal' number (default 1)
6296 global
6297 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006298 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006299 feature}
6300 The value of this option specifies when the line with tab page labels
6301 will be displayed:
6302 0: never
6303 1: only if there are at least two tab pages
6304 2: always
6305 This is both for the GUI and non-GUI implementation of the tab pages
6306 line.
6307 See |tab-page| for more information about tab pages.
6308
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 *'sidescroll'* *'ss'*
6310'sidescroll' 'ss' number (default 0)
6311 global
6312 {not in Vi}
6313 The minimal number of columns to scroll horizontally. Used only when
6314 the 'wrap' option is off and the cursor is moved off of the screen.
6315 When it is zero the cursor will be put in the middle of the screen.
6316 When using a slow terminal set it to a large number or 0. When using
6317 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6318 commands.
6319
6320 *'sidescrolloff'* *'siso'*
6321'sidescrolloff' 'siso' number (default 0)
6322 global
6323 {not in Vi}
6324 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006325 right of the cursor if 'nowrap' is set. Setting this option to a
6326 value greater than 0 while having |'sidescroll'| also at a non-zero
6327 value makes some context visible in the line you are scrolling in
6328 horizontally (except at beginning of the line). Setting this option
6329 to a large value (like 999) has the effect of keeping the cursor
6330 horizontally centered in the window, as long as one does not come too
6331 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 NOTE: This option is set to 0 when 'compatible' is set.
6333
6334 Example: Try this together with 'sidescroll' and 'listchars' as
6335 in the following example to never allow the cursor to move
6336 onto the "extends" character:
6337
6338 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6339 :set sidescrolloff=1
6340
6341
6342 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6343'smartcase' 'scs' boolean (default off)
6344 global
6345 {not in Vi}
6346 Override the 'ignorecase' option if the search pattern contains upper
6347 case characters. Only used when the search pattern is typed and
6348 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006349 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006350 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6351 recalling the search pattern from history and hitting <Enter>.
6352 NOTE: This option is reset when 'compatible' is set.
6353
6354 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6355'smartindent' 'si' boolean (default off)
6356 local to buffer
6357 {not in Vi}
6358 {not available when compiled without the
6359 |+smartindent| feature}
6360 Do smart autoindenting when starting a new line. Works for C-like
6361 programs, but can also be used for other languages. 'cindent' does
6362 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006363 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006364 setting 'si' has no effect. 'indentexpr' is a more advanced
6365 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006366 Normally 'autoindent' should also be on when using 'smartindent'.
6367 An indent is automatically inserted:
6368 - After a line ending in '{'.
6369 - After a line starting with a keyword from 'cinwords'.
6370 - Before a line starting with '}' (only with the "O" command).
6371 When typing '}' as the first character in a new line, that line is
6372 given the same indent as the matching '{'.
6373 When typing '#' as the first character in a new line, the indent for
6374 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006375 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6377 When using the ">>" command, lines starting with '#' are not shifted
6378 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006379 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 is set smart indenting is disabled.
6381
6382 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6383'smarttab' 'sta' boolean (default off)
6384 global
6385 {not in Vi}
6386 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006387 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6388 <BS> will delete a 'shiftwidth' worth of space at the start of the
6389 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006390 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006391 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6392 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006393 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006395 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006396 NOTE: This option is reset when 'compatible' is set.
6397
6398 *'softtabstop'* *'sts'*
6399'softtabstop' 'sts' number (default 0)
6400 local to buffer
6401 {not in Vi}
6402 Number of spaces that a <Tab> counts for while performing editing
6403 operations, like inserting a <Tab> or using <BS>. It "feels" like
6404 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6405 used. This is useful to keep the 'ts' setting at its standard value
6406 of 8, while being able to edit like it is set to 'sts'. However,
6407 commands like "x" still work on the actual characters.
6408 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006409 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 'softtabstop' is set to 0 when the 'paste' option is set.
6411 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6412 spaces is minimized by using <Tab>s.
6413 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6414 set.
6415 NOTE: This option is set to 0 when 'compatible' is set.
6416
Bram Moolenaar217ad922005-03-20 22:37:15 +00006417 *'spell'* *'nospell'*
6418'spell' boolean (default off)
6419 local to window
6420 {not in Vi}
6421 {not available when compiled without the |+syntax|
6422 feature}
6423 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006424 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006425
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006426 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006427'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006428 local to buffer
6429 {not in Vi}
6430 {not available when compiled without the |+syntax|
6431 feature}
6432 Pattern to locate the end of a sentence. The following word will be
6433 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006434 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006435 When this check is not wanted make this option empty.
6436 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006437 Be careful with special characters, see |option-backslash| about
6438 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006439 To set this option automatically depending on the language, see
6440 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006441
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006442 *'spellfile'* *'spf'*
6443'spellfile' 'spf' string (default empty)
6444 local to buffer
6445 {not in Vi}
6446 {not available when compiled without the |+syntax|
6447 feature}
6448 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006449 commands. It must end in ".{encoding}.add". You need to include the
6450 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006451 *E765*
6452 It may also be a comma separated list of names. A count before the
6453 |zg| and |zw| commands can be used to access each. This allows using
6454 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006455 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006456 you: Using the first directory in 'runtimepath' that is writable. If
6457 there is no "spell" directory yet it will be created. For the file
6458 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006459 ignoring the region.
6460 The resulting ".spl" file will be used for spell checking, it does not
6461 have to appear in 'spelllang'.
6462 Normally one file is used for all regions, but you can add the region
6463 name if you want to. However, it will then only be used when
6464 'spellfile' is set to it, for entries in 'spelllang' only files
6465 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006466 This option cannot be set from a |modeline| or in the |sandbox|, for
6467 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006468
Bram Moolenaar217ad922005-03-20 22:37:15 +00006469 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006470'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006471 local to buffer
6472 {not in Vi}
6473 {not available when compiled without the |+syntax|
6474 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006475 A comma separated list of word list names. When the 'spell' option is
6476 on spellchecking will be done for these languages. Example: >
6477 set spelllang=en_us,nl,medical
6478< This means US English, Dutch and medical words are recognized. Words
6479 that are not recognized will be highlighted.
6480 The word list name must not include a comma or dot. Using a dash is
6481 recommended to separate the two letter language name from a
6482 specification. Thus "en-rare" is used for rare English words.
6483 A region name must come last and have the form "_xx", where "xx" is
6484 the two-letter, lower case region name. You can use more than one
6485 region by listing them: "en_us,en_ca" supports both US and Canadian
6486 English, but not words specific for Australia, New Zealand or Great
6487 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006488 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006489 As a special case the name of a .spl file can be given as-is. The
6490 first "_xx" in the name is removed and used as the region name
6491 (_xx is an underscore, two letters and followed by a non-letter).
6492 This is mainly for testing purposes. You must make sure the correct
6493 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006494 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006495 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6496 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006497 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006498
Bram Moolenaar98692072006-02-04 00:57:42 +00006499 If the |spellfile.vim| plugin is active and you use a language name
6500 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6501 will ask you if you want to download the file.
6502
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006503 After this option has been set successfully, Vim will source the files
6504 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006505 up to the first comma, dot or underscore.
6506 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006507
6508
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006509 *'spellsuggest'* *'sps'*
6510'spellsuggest' 'sps' string (default "best")
6511 global
6512 {not in Vi}
6513 {not available when compiled without the |+syntax|
6514 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006515 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006516 the |spellsuggest()| function. This is a comma-separated list of
6517 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006518
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006519 best Internal method that works best for English. Finds
6520 changes like "fast" and uses a bit of sound-a-like
6521 scoring to improve the ordering.
6522
6523 double Internal method that uses two methods and mixes the
6524 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006525 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006526 word. That only works when the language specifies
6527 sound folding. Can be slow and doesn't always give
6528 better results.
6529
6530 fast Internal method that only checks for simple changes:
6531 character inserts/deletes/swaps. Works well for
6532 simple typing mistakes.
6533
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006534 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006535 Not used for |spellsuggest()|. The number of
6536 suggestions is never more than the value of 'lines'
6537 minus two.
6538
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006539 file:{filename} Read file {filename}, which must have two columns,
6540 separated by a slash. The first column contains the
6541 bad word, the second column the suggested good word.
6542 Example:
6543 theribal/terrible ~
6544 Use this for common mistakes that do not appear at the
6545 top of the suggestion list with the internal methods.
6546 Lines without a slash are ignored, use this for
6547 comments.
6548 The file is used for all languages.
6549
6550 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6551 trouble with spaces. |v:val| holds the badly spelled
6552 word. The expression must evaluate to a List of
6553 Lists, each with a suggestion and a score.
6554 Example:
6555 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006556 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006557 internal methods use. A lower score is better.
6558 This may invoke |spellsuggest()| if you temporarily
6559 set 'spellsuggest' to exclude the "expr:" part.
6560 Errors are silently ignored, unless you set the
6561 'verbose' option to a non-zero value.
6562
6563 Only one of "best", "double" or "fast" may be used. The others may
6564 appear several times in any order. Example: >
6565 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6566<
6567 This option cannot be set from a |modeline| or in the |sandbox|, for
6568 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006569
6570
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6572'splitbelow' 'sb' boolean (default off)
6573 global
6574 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006575 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 feature}
6577 When on, splitting a window will put the new window below the current
6578 one. |:split|
6579
6580 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6581'splitright' 'spr' boolean (default off)
6582 global
6583 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006584 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585 feature}
6586 When on, splitting a window will put the new window right of the
6587 current one. |:vsplit|
6588
6589 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6590'startofline' 'sol' boolean (default on)
6591 global
6592 {not in Vi}
6593 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006594 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006595 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006596 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006597 with a linewise operator, with "%" with a count and to buffer changing
6598 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6599 only has a line number, e.g., ":25" or ":+".
6600 In case of buffer changing commands the cursor is placed at the column
6601 where it was the last time the buffer was edited.
6602 NOTE: This option is set when 'compatible' is set.
6603
Bram Moolenaar00654022011-02-25 14:42:19 +01006604 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006605'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006606 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006607 {not in Vi}
6608 {not available when compiled without the |+statusline|
6609 feature}
6610 When nonempty, this option determines the content of the status line.
6611 Also see |status-line|.
6612
6613 The option consists of printf style '%' items interspersed with
6614 normal text. Each status line item is of the form:
6615 %-0{minwid}.{maxwid}{item}
6616 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006617 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618
Bram Moolenaar238a5642006-02-21 22:12:05 +00006619 When the option starts with "%!" then it is used as an expression,
6620 evaluated and the result is used as the option value. Example: >
6621 :set statusline=%!MyStatusLine()
6622< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006623 Note that the "%!" expression is evaluated in the context of the
6624 current window and buffer, while %{} items are evaluated in the
6625 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006626
6627 When there is error while evaluating the option then it will be made
6628 empty to avoid further errors. Otherwise screen updating would loop.
6629
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 Note that the only effect of 'ruler' when this option is set (and
6631 'laststatus' is 2) is controlling the output of |CTRL-G|.
6632
6633 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006634 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006636 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 minwid Minimum width of the item, padding as set by '-' & '0'.
6638 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006639 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006640 on the left for text items. Numeric items will be
6641 shifted down to maxwid-2 digits followed by '>'number
6642 where number is the amount of missing digits, much like
6643 an exponential notation.
6644 item A one letter code as described below.
6645
6646 Following is a description of the possible statusline items. The
6647 second character in "item" is the type:
6648 N for number
6649 S for string
6650 F for flags as described below
6651 - not applicable
6652
6653 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006654 f S Path to the file in the buffer, as typed or relative to current
6655 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 F S Full path to the file in the buffer.
6657 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006658 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006660 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006662 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006663 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006664 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006666 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6668 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006669 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6671 being used: "<keymap>"
6672 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006673 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 B N As above, in hexadecimal.
6675 o N Byte number in file of byte under cursor, first byte is 1.
6676 Mnemonic: Offset from start of file (with one added)
6677 {not available when compiled without |+byte_offset| feature}
6678 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006679 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 l N Line number.
6681 L N Number of lines in buffer.
6682 c N Column number.
6683 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 p N Percentage through file in lines as in |CTRL-G|.
6686 P S Percentage through file of displayed window. This is like the
6687 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006688 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006689 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006690 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006691 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 ( - Start of item group. Can be used for setting the width and
6693 alignment of a section. Must be followed by %) somewhere.
6694 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006695 T N For 'tabline': start of tab page N label. Use %T after the last
6696 label. This information is used for mouse clicks.
6697 X N For 'tabline': start of close tab N label. Use %X after the
6698 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6699 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700 < - Where to truncate line if too long. Default is at the start.
6701 No width fields allowed.
6702 = - Separation point between left and right aligned items.
6703 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006704 # - Set highlight group. The name must follow and then a # again.
6705 Thus use %#HLname# for highlight group HLname. The same
6706 highlighting is used, also for the statusline of non-current
6707 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006709 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006710 The difference between User{N} and StatusLine will be applied
6711 to StatusLineNC for the statusline of non-current windows.
6712 The number N must be between 1 and 9. See |hl-User1..9|
6713
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006714 When displaying a flag, Vim removes the leading comma, if any, when
6715 that flag comes right after plaintext. This will make a nice display
6716 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717
Bram Moolenaar582fd852005-03-28 20:58:01 +00006718 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 not set) and a minwid is not set for the group, the whole group will
6720 become empty. This will make a group like the following disappear
6721 completely from the statusline when none of the flags are set. >
6722 :set statusline=...%(\ [%M%R%H]%)...
6723<
6724 Beware that an expression is evaluated each and every time the status
6725 line is displayed. The current buffer and current window will be set
6726 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006727 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006729 real current buffer.
6730
Bram Moolenaar30b65812012-07-12 22:01:11 +02006731 The 'statusline' option will be evaluated in the |sandbox| if set from
6732 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006733
6734 It is not allowed to change text or jump to another window while
6735 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006736
6737 If the statusline is not updated when you want it (e.g., after setting
6738 a variable that's used in an expression), you can force an update by
6739 setting an option without changing its value. Example: >
6740 :let &ro = &ro
6741
6742< A result of all digits is regarded a number for display purposes.
6743 Otherwise the result is taken as flag text and applied to the rules
6744 described above.
6745
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006746 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6748 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6749
6750 Examples:
6751 Emulate standard status line with 'ruler' set >
6752 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6753< Similar, but add ASCII value of char under the cursor (like "ga") >
6754 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6755< Display byte count and byte value, modified flag in red. >
6756 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6757 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6758< Display a ,GZ flag if a compressed file is loaded >
6759 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6760< In the |:autocmd|'s: >
6761 :let b:gzflag = 1
6762< And: >
6763 :unlet b:gzflag
6764< And define this function: >
6765 :function VarExists(var, val)
6766 : if exists(a:var) | return a:val | else | return '' | endif
6767 :endfunction
6768<
6769 *'suffixes'* *'su'*
6770'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6771 global
6772 {not in Vi}
6773 Files with these suffixes get a lower priority when multiple files
6774 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006775 suffixes. Spaces after the comma are ignored. A dot is also seen as
6776 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006777 separator, precede it with a backslash (see |option-backslash| about
6778 including spaces and backslashes).
6779 See 'wildignore' for completely ignoring files.
6780 The use of |:set+=| and |:set-=| is preferred when adding or removing
6781 suffixes from the list. This avoids problems when a future version
6782 uses another default.
6783
6784 *'suffixesadd'* *'sua'*
6785'suffixesadd' 'sua' string (default "")
6786 local to buffer
6787 {not in Vi}
6788 {not available when compiled without the
6789 |+file_in_path| feature}
6790 Comma separated list of suffixes, which are used when searching for a
6791 file for the "gf", "[I", etc. commands. Example: >
6792 :set suffixesadd=.java
6793<
6794 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6795'swapfile' 'swf' boolean (default on)
6796 local to buffer
6797 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006798 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006799 swapfile is not wanted for a specific buffer. For example, with
6800 confidential information that even root must not be able to access.
6801 Careful: All text will be in memory:
6802 - Don't use this for big files.
6803 - Recovery will be impossible!
6804 A swapfile will only be present when |'updatecount'| is non-zero and
6805 'swapfile' is set.
6806 When 'swapfile' is reset, the swap file for the current buffer is
6807 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6808 non-zero, a swap file is immediately created.
6809 Also see |swap-file| and |'swapsync'|.
6810
6811 This option is used together with 'bufhidden' and 'buftype' to
6812 specify special kinds of buffers. See |special-buffers|.
6813
6814 *'swapsync'* *'sws'*
6815'swapsync' 'sws' string (default "fsync")
6816 global
6817 {not in Vi}
6818 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006819 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006820 When this option is empty parts of the swap file may be in memory and
6821 not written to disk. When the system crashes you may lose more work.
6822 On Unix the system does a sync now and then without Vim asking for it,
6823 so the disadvantage of setting this option off is small. On some
6824 systems the swap file will not be written at all. For a unix system
6825 setting it to "sync" will use the sync() call instead of the default
6826 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006827 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828
6829 *'switchbuf'* *'swb'*
6830'switchbuf' 'swb' string (default "")
6831 global
6832 {not in Vi}
6833 This option controls the behavior when switching between buffers.
6834 Possible values (comma separated list):
6835 useopen If included, jump to the first open window that
6836 contains the specified buffer (if there is one).
6837 Otherwise: Do not examine other windows.
6838 This setting is checked with |quickfix| commands, when
6839 jumping to errors (":cc", ":cn", "cp", etc.). It is
6840 also used in all buffer related split commands, for
6841 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006842 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006843 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006845 a buffer for a |quickfix| command that display errors.
6846 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006847 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006848 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006850 *'synmaxcol'* *'smc'*
6851'synmaxcol' 'smc' number (default 3000)
6852 local to buffer
6853 {not in Vi}
6854 {not available when compiled without the |+syntax|
6855 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006856 Maximum column in which to search for syntax items. In long lines the
6857 text after this column is not highlighted and following lines may not
6858 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006859 This helps to avoid very slow redrawing for an XML file that is one
6860 long line.
6861 Set to zero to remove the limit.
6862
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 *'syntax'* *'syn'*
6864'syntax' 'syn' string (default empty)
6865 local to buffer
6866 {not in Vi}
6867 {not available when compiled without the |+syntax|
6868 feature}
6869 When this option is set, the syntax with this name is loaded, unless
6870 syntax highlighting has been switched off with ":syntax off".
6871 Otherwise this option does not always reflect the current syntax (the
6872 b:current_syntax variable does).
6873 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006874 not automatically recognized. Example, in an IDL file:
6875 /* vim: set syntax=idl : */ ~
6876 When a dot appears in the value then this separates two filetype
6877 names. Example:
6878 /* vim: set syntax=c.doxygen : */ ~
6879 This will use the "c" syntax first, then the "doxygen" syntax.
6880 Note that the second one must be prepared to be loaded as an addition,
6881 otherwise it will be skipped. More than one dot may appear.
6882 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 :set syntax=OFF
6884< To switch syntax highlighting on according to the current value of the
6885 'filetype' option: >
6886 :set syntax=ON
6887< What actually happens when setting the 'syntax' option is that the
6888 Syntax autocommand event is triggered with the value as argument.
6889 This option is not copied to another buffer, independent of the 's' or
6890 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006891 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006893 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006894'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006895 global
6896 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006897 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006898 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006899 When nonempty, this option determines the content of the tab pages
6900 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006901 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006902
6903 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006904 option and only when there is no GUI tab line. When 'e' is in
6905 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006906 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006907
6908 The value is evaluated like with 'statusline'. You can use
6909 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006910 the text to be displayed. Use "%1T" for the first label, "%2T" for
6911 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006912
6913 Keep in mind that only one of the tab pages is the current one, others
6914 are invisible and you can't jump to their windows.
6915
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006916
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006917 *'tabpagemax'* *'tpm'*
6918'tabpagemax' 'tpm' number (default 10)
6919 global
6920 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006921 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006922 feature}
6923 Maximum number of tab pages to be opened by the |-p| command line
6924 argument or the ":tab all" command. |tabpage|
6925
6926
6927 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928'tabstop' 'ts' number (default 8)
6929 local to buffer
6930 Number of spaces that a <Tab> in the file counts for. Also see
6931 |:retab| command, and 'softtabstop' option.
6932
6933 Note: Setting 'tabstop' to any other value than 8 can make your file
6934 appear wrong in many places (e.g., when printing it).
6935
6936 There are four main ways to use tabs in Vim:
6937 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6938 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006939 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006940 behave like a tab appears every 4 (or 3) characters.
6941 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6942 'expandtab'. This way you will always insert spaces. The
6943 formatting will never be messed up when 'tabstop' is changed.
6944 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006945 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006946 works when using Vim to edit the file.
6947 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6948 'noexpandtab'. This should then work (for initial indents only)
6949 for any tabstop setting that people use. It might be nice to have
6950 tabs after the first non-blank inserted as spaces if you do this
6951 though. Otherwise aligned comments will be wrong when 'tabstop' is
6952 changed.
6953
6954 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6955'tagbsearch' 'tbs' boolean (default on)
6956 global
6957 {not in Vi}
6958 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006959 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 searching makes searching for a tag a LOT faster, but a linear search
6961 will find more tags if the tags file wasn't properly sorted.
6962 Vim normally assumes that your tags files are sorted, or indicate that
6963 they are not sorted. Only when this is not the case does the
6964 'tagbsearch' option need to be switched off.
6965
6966 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006967 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 certain files, or retry all files with a linear search. When
6969 'tagbsearch' is off, only a linear search is done.
6970
6971 Linear searching is done anyway, for one file, when Vim finds a line
6972 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006973 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974< [The whitespace before and after the '0' must be a single <Tab>]
6975
6976 When a binary search was done and no match was found in any of the
6977 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6978 instead of a normal tag name, a retry is done with a linear search.
6979 Tags in unsorted tags files, and matches with different case will only
6980 be found in the retry.
6981
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006982 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006983 linear search can be avoided for the 'ignorecase' case. Use a value
6984 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6985 case-fold sorted with the -f switch to "sort" in most unices, as in
6986 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006987 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6988 for this as well. Note that case must be folded to uppercase for this
6989 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006990
6991 When 'tagbsearch' is off, tags searching is slower when a full match
6992 exists, but faster when no full match exists. Tags in unsorted tags
6993 files may only be found with 'tagbsearch' off.
6994 When the tags file is not sorted, or sorted in a wrong way (not on
6995 ASCII byte value), 'tagbsearch' should be off, or the line given above
6996 must be included in the tags file.
6997 This option doesn't affect commands that find all matching tags (e.g.,
6998 command-line completion and ":help").
6999 {Vi: always uses binary search in some versions}
7000
7001 *'taglength'* *'tl'*
7002'taglength' 'tl' number (default 0)
7003 global
7004 If non-zero, tags are significant up to this number of characters.
7005
7006 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7007'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7008 global
7009 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007010 If on and using a tags file in another directory, file names in that
7011 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 NOTE: This option is set to the Vi default value when 'compatible' is
7013 set and to the Vim default value when 'compatible' is reset.
7014
7015 *'tags'* *'tag'* *E433*
7016'tags' 'tag' string (default "./tags,tags", when compiled with
7017 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7018 global or local to buffer |global-local|
7019 Filenames for the tag command, separated by spaces or commas. To
7020 include a space or comma in a file name, precede it with a backslash
7021 (see |option-backslash| about including spaces and backslashes).
7022 When a file name starts with "./", the '.' is replaced with the path
7023 of the current file. But only when the 'd' flag is not included in
7024 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7025 |tags-option|.
7026 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007027 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7028 find all files named "tags" below "/lib". The filename itself cannot
7029 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7030 files called "tags?". {not available when compiled without the
7031 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007032 The |tagfiles()| function can be used to get a list of the file names
7033 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007034 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7035 files are also supported. They are automatically recognized. The
7036 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7037 differences are ignored (MS-Windows). |emacs-tags|
7038 The use of |:set+=| and |:set-=| is preferred when adding or removing
7039 file names from the list. This avoids problems when a future version
7040 uses another default.
7041 {Vi: default is "tags /usr/lib/tags"}
7042
7043 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7044'tagstack' 'tgst' boolean (default on)
7045 global
7046 {not in all versions of Vi}
7047 When on, the |tagstack| is used normally. When off, a ":tag" or
7048 ":tselect" command with an argument will not push the tag onto the
7049 tagstack. A following ":tag" without an argument, a ":pop" command or
7050 any other command that uses the tagstack will use the unmodified
7051 tagstack, but does change the pointer to the active entry.
7052 Resetting this option is useful when using a ":tag" command in a
7053 mapping which should not change the tagstack.
7054
7055 *'term'* *E529* *E530* *E531*
7056'term' string (default is $TERM, if that fails:
7057 in the GUI: "builtin_gui"
7058 on Amiga: "amiga"
7059 on BeOS: "beos-ansi"
7060 on Mac: "mac-ansi"
7061 on MiNT: "vt52"
7062 on MS-DOS: "pcterm"
7063 on OS/2: "os2ansi"
7064 on Unix: "ansi"
7065 on VMS: "ansi"
7066 on Win 32: "win32")
7067 global
7068 Name of the terminal. Used for choosing the terminal control
7069 characters. Environment variables are expanded |:set_env|.
7070 For example: >
7071 :set term=$TERM
7072< See |termcap|.
7073
7074 *'termbidi'* *'tbidi'*
7075 *'notermbidi'* *'notbidi'*
7076'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7077 global
7078 {not in Vi}
7079 {only available when compiled with the |+arabic|
7080 feature}
7081 The terminal is in charge of Bi-directionality of text (as specified
7082 by Unicode). The terminal is also expected to do the required shaping
7083 that some languages (such as Arabic) require.
7084 Setting this option implies that 'rightleft' will not be set when
7085 'arabic' is set and the value of 'arabicshape' will be ignored.
7086 Note that setting 'termbidi' has the immediate effect that
7087 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7088 This option is reset when the GUI is started.
7089 For further details see |arabic.txt|.
7090
7091 *'termencoding'* *'tenc'*
7092'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7093 Macintosh GUI: "macroman")
7094 global
7095 {only available when compiled with the |+multi_byte|
7096 feature}
7097 {not in Vi}
7098 Encoding used for the terminal. This specifies what character
7099 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007100 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007101 display). Except for the Mac when 'macatsui' is off, then
7102 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007103 In the Win32 console version the default value is the console codepage
7104 when it differs from the ANSI codepage.
7105 *E617*
7106 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7107 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7108 Any attempts to set a different value will be rejected, and an error
7109 message is shown.
7110 For the Win32 GUI 'termencoding' is not used for typed characters,
7111 because the Win32 system always passes Unicode characters.
7112 When empty, the same encoding is used as for the 'encoding' option.
7113 This is the normal value.
7114 Not all combinations for 'termencoding' and 'encoding' are valid. See
7115 |encoding-table|.
7116 The value for this option must be supported by internal conversions or
7117 iconv(). When this is not possible no conversion will be done and you
7118 will probably experience problems with non-ASCII characters.
7119 Example: You are working with the locale set to euc-jp (Japanese) and
7120 want to edit a UTF-8 file: >
7121 :let &termencoding = &encoding
7122 :set encoding=utf-8
7123< You need to do this when your system has no locale support for UTF-8.
7124
7125 *'terse'* *'noterse'*
7126'terse' boolean (default off)
7127 global
7128 When set: Add 's' flag to 'shortmess' option (this makes the message
7129 for a search that hits the start or end of the file not being
7130 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7131 shortens a lot of messages}
7132
7133 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7134'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7135 global
7136 {not in Vi}
7137 This option is obsolete. Use 'fileformats'.
7138 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7139 set to the default value for the current system. When 'textauto' is
7140 reset, 'fileformats' is made empty.
7141 NOTE: This option is set to the Vi default value when 'compatible' is
7142 set and to the Vim default value when 'compatible' is reset.
7143
7144 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7145'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7146 others: default off)
7147 local to buffer
7148 {not in Vi}
7149 This option is obsolete. Use 'fileformat'.
7150 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7151 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7152 "unix".
7153
7154 *'textwidth'* *'tw'*
7155'textwidth' 'tw' number (default 0)
7156 local to buffer
7157 {not in Vi}
7158 Maximum width of text that is being inserted. A longer line will be
7159 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007160 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7161 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007163 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 NOTE: This option is set to 0 when 'compatible' is set.
7165
7166 *'thesaurus'* *'tsr'*
7167'thesaurus' 'tsr' string (default "")
7168 global or local to buffer |global-local|
7169 {not in Vi}
7170 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007171 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 the file should contain words with similar meaning, separated by
7173 non-keyword characters (white space is preferred). Maximum line
7174 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007175 To obtain a file to be used here, check out this ftp site:
7176 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007177 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 after a comma are ignored, otherwise spaces are included in the file
7179 name. See |option-backslash| about using backslashes.
7180 The use of |:set+=| and |:set-=| is preferred when adding or removing
7181 directories from the list. This avoids problems when a future version
7182 uses another default.
7183 Backticks cannot be used in this option for security reasons.
7184
7185 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7186'tildeop' 'top' boolean (default off)
7187 global
7188 {not in Vi}
7189 When on: The tilde command "~" behaves like an operator.
7190 NOTE: This option is reset when 'compatible' is set.
7191
7192 *'timeout'* *'to'* *'notimeout'* *'noto'*
7193'timeout' 'to' boolean (default on)
7194 global
7195 *'ttimeout'* *'nottimeout'*
7196'ttimeout' boolean (default off)
7197 global
7198 {not in Vi}
7199 These two options together determine the behavior when part of a
7200 mapped key sequence or keyboard code has been received:
7201
7202 'timeout' 'ttimeout' action ~
7203 off off do not time out
7204 on on or off time out on :mappings and key codes
7205 off on time out on key codes
7206
7207 If both options are off, Vim will wait until either the complete
7208 mapping or key sequence has been received, or it is clear that there
7209 is no mapping or key sequence for the received characters. For
7210 example: if you have mapped "vl" and Vim has received 'v', the next
7211 character is needed to see if the 'v' is followed by an 'l'.
7212 When one of the options is on, Vim will wait for about 1 second for
7213 the next character to arrive. After that the already received
7214 characters are interpreted as single characters. The waiting time can
7215 be changed with the 'timeoutlen' option.
7216 On slow terminals or very busy systems timing out may cause
7217 malfunctioning cursor keys. If both options are off, Vim waits
7218 forever after an entered <Esc> if there are key codes that start
7219 with <Esc>. You will have to type <Esc> twice. If you do not have
7220 problems with key codes, but would like to have :mapped key
7221 sequences not timing out in 1 second, set the 'ttimeout' option and
7222 reset the 'timeout' option.
7223
7224 NOTE: 'ttimeout' is reset when 'compatible' is set.
7225
7226 *'timeoutlen'* *'tm'*
7227'timeoutlen' 'tm' number (default 1000)
7228 global
7229 {not in all versions of Vi}
7230 *'ttimeoutlen'* *'ttm'*
7231'ttimeoutlen' 'ttm' number (default -1)
7232 global
7233 {not in Vi}
7234 The time in milliseconds that is waited for a key code or mapped key
7235 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7236 when part of a command has been typed.
7237 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7238 different timeout value for key codes is desired set 'ttimeoutlen' to
7239 a non-negative number.
7240
7241 ttimeoutlen mapping delay key code delay ~
7242 < 0 'timeoutlen' 'timeoutlen'
7243 >= 0 'timeoutlen' 'ttimeoutlen'
7244
7245 The timeout only happens when the 'timeout' and 'ttimeout' options
7246 tell so. A useful setting would be >
7247 :set timeout timeoutlen=3000 ttimeoutlen=100
7248< (time out on mapping after three seconds, time out on key codes after
7249 a tenth of a second).
7250
7251 *'title'* *'notitle'*
7252'title' boolean (default off, on when title can be restored)
7253 global
7254 {not in Vi}
7255 {not available when compiled without the |+title|
7256 feature}
7257 When on, the title of the window will be set to the value of
7258 'titlestring' (if it is not empty), or to:
7259 filename [+=-] (path) - VIM
7260 Where:
7261 filename the name of the file being edited
7262 - indicates the file cannot be modified, 'ma' off
7263 + indicates the file was modified
7264 = indicates the file is read-only
7265 =+ indicates the file is read-only and modified
7266 (path) is the path of the file being edited
7267 - VIM the server name |v:servername| or "VIM"
7268 Only works if the terminal supports setting window titles
7269 (currently Amiga console, Win32 console, all GUI versions and
7270 terminals with a non- empty 't_ts' option - these are Unix xterm and
7271 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7272 *X11*
7273 When Vim was compiled with HAVE_X11 defined, the original title will
7274 be restored if possible. The output of ":version" will include "+X11"
7275 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7276 works for the icon name |'icon'|.
7277 But: When Vim was started with the |-X| argument, restoring the title
7278 will not work (except in the GUI).
7279 If the title cannot be restored, it is set to the value of 'titleold'.
7280 You might want to restore the title outside of Vim then.
7281 When using an xterm from a remote machine you can use this command:
7282 rsh machine_name xterm -display $DISPLAY &
7283 then the WINDOWID environment variable should be inherited and the
7284 title of the window should change back to what it should be after
7285 exiting Vim.
7286
7287 *'titlelen'*
7288'titlelen' number (default 85)
7289 global
7290 {not in Vi}
7291 {not available when compiled without the |+title|
7292 feature}
7293 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007294 title. When the title is longer, only the end of the path name is
7295 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 Using a percentage makes this adapt to the width of the window. But
7297 it won't work perfectly, because the actual number of characters
7298 available also depends on the font used and other things in the title
7299 bar. When 'titlelen' is zero the full path is used. Otherwise,
7300 values from 1 to 30000 percent can be used.
7301 'titlelen' is also used for the 'titlestring' option.
7302
7303 *'titleold'*
7304'titleold' string (default "Thanks for flying Vim")
7305 global
7306 {not in Vi}
7307 {only available when compiled with the |+title|
7308 feature}
7309 This option will be used for the window title when exiting Vim if the
7310 original title cannot be restored. Only happens if 'title' is on or
7311 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007312 This option cannot be set from a |modeline| or in the |sandbox|, for
7313 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 *'titlestring'*
7315'titlestring' string (default "")
7316 global
7317 {not in Vi}
7318 {not available when compiled without the |+title|
7319 feature}
7320 When this option is not empty, it will be used for the title of the
7321 window. This happens only when the 'title' option is on.
7322 Only works if the terminal supports setting window titles (currently
7323 Amiga console, Win32 console, all GUI versions and terminals with a
7324 non-empty 't_ts' option).
7325 When Vim was compiled with HAVE_X11 defined, the original title will
7326 be restored if possible |X11|.
7327 When this option contains printf-style '%' items, they will be
7328 expanded according to the rules used for 'statusline'.
7329 Example: >
7330 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7331 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7332< The value of 'titlelen' is used to align items in the middle or right
7333 of the available space.
7334 Some people prefer to have the file name first: >
7335 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7336< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007337 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 separating space only when needed.
7339 NOTE: Use of special characters in 'titlestring' may cause the display
7340 to be garbled (e.g., when it contains a CR or NL character).
7341 {not available when compiled without the |+statusline| feature}
7342
7343 *'toolbar'* *'tb'*
7344'toolbar' 'tb' string (default "icons,tooltips")
7345 global
7346 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7347 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007348 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 possible values are:
7350 icons Toolbar buttons are shown with icons.
7351 text Toolbar buttons shown with text.
7352 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007353 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 tooltips Tooltips are active for toolbar buttons.
7355 Tooltips refer to the popup help text which appears after the mouse
7356 cursor is placed over a toolbar button for a brief moment.
7357
7358 If you want the toolbar to be shown with icons as well as text, do the
7359 following: >
7360 :set tb=icons,text
7361< Motif and Athena cannot display icons and text at the same time. They
7362 will show icons if both are requested.
7363
7364 If none of the strings specified in 'toolbar' are valid or if
7365 'toolbar' is empty, this option is ignored. If you want to disable
7366 the toolbar, you need to set the 'guioptions' option. For example: >
7367 :set guioptions-=T
7368< Also see |gui-toolbar|.
7369
7370 *'toolbariconsize'* *'tbis'*
7371'toolbariconsize' 'tbis' string (default "small")
7372 global
7373 {not in Vi}
7374 {only in the GTK+ 2 GUI}
7375 Controls the size of toolbar icons. The possible values are:
7376 tiny Use tiny toolbar icons.
7377 small Use small toolbar icons (default).
7378 medium Use medium-sized toolbar icons.
7379 large Use large toolbar icons.
7380 The exact dimensions in pixels of the various icon sizes depend on
7381 the current theme. Common dimensions are large=32x32, medium=24x24,
7382 small=20x20 and tiny=16x16.
7383
7384 If 'toolbariconsize' is empty, the global default size as determined
7385 by user preferences or the current theme is used.
7386
7387 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7388'ttybuiltin' 'tbi' boolean (default on)
7389 global
7390 {not in Vi}
7391 When on, the builtin termcaps are searched before the external ones.
7392 When off the builtin termcaps are searched after the external ones.
7393 When this option is changed, you should set the 'term' option next for
7394 the change to take effect, for example: >
7395 :set notbi term=$TERM
7396< See also |termcap|.
7397 Rationale: The default for this option is "on", because the builtin
7398 termcap entries are generally better (many systems contain faulty
7399 xterm entries...).
7400
7401 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7402'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7403 sun-cmd, screen, rxvt, dtterm or
7404 iris-ansi; also on when running Vim in
7405 a DOS console)
7406 global
7407 {not in Vi}
7408 Indicates a fast terminal connection. More characters will be sent to
7409 the screen for redrawing, instead of using insert/delete line
7410 commands. Improves smoothness of redrawing when there are multiple
7411 windows and the terminal does not support a scrolling region.
7412 Also enables the extra writing of characters at the end of each screen
7413 line for lines that wrap. This helps when using copy/paste with the
7414 mouse in an xterm and other terminals.
7415
7416 *'ttymouse'* *'ttym'*
7417'ttymouse' 'ttym' string (default depends on 'term')
7418 global
7419 {not in Vi}
7420 {only in Unix and VMS, doesn't work in the GUI; not
7421 available when compiled without |+mouse|}
7422 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007423 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 *xterm-mouse*
7425 xterm xterm-like mouse handling. The mouse generates
7426 "<Esc>[Mscr", where "scr" is three bytes:
7427 "s" = button state
7428 "c" = column plus 33
7429 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007430 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007431 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 xterm2 Works like "xterm", but with the xterm reporting the
7433 mouse position while the mouse is dragged. This works
7434 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007435 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007436 work. See below for how Vim detects this
7437 automatically.
7438 *netterm-mouse*
7439 netterm NetTerm mouse handling. The mouse generates
7440 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7441 for the row and column.
7442 *dec-mouse*
7443 dec DEC terminal mouse handling. The mouse generates a
7444 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007445 This is also available for an Xterm, if it was
7446 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007447 *jsbterm-mouse*
7448 jsbterm JSB term mouse handling.
7449 *pterm-mouse*
7450 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007451 *urxvt-mouse*
7452 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar9b451252012-08-15 17:43:31 +02007453 *sgr-mouse*
7454 sgr Mouse handling for the terminal that emits SGR-styled
7455 mouse reporting. Works with xterm version 277 or
7456 later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007457
7458 The mouse handling must be enabled at compile time |+mouse_xterm|
7459 |+mouse_dec| |+mouse_netterm|.
7460 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7461 recognized, if enabled at compile time. DEC terminal mouse codes
7462 are recognized if enabled at compile time, and 'ttymouse' is not
7463 "xterm" (because the xterm and dec mouse codes conflict).
7464 This option is automatically set to "xterm", when the 'term' option is
7465 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7466 or "xterm2" already. The main use of this option is to set it to
7467 "xterm", when the terminal name doesn't start with "xterm", but it can
7468 handle xterm mouse codes.
Bram Moolenaar2b9578f2012-08-15 16:21:32 +02007469 The "sgr" value will be set if the xterm version is 277 or later.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007471 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007472 feature and if |t_RV| is set to the escape sequence to request the
7473 xterm version number. Otherwise "xterm2" must be set explicitly.
7474 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7475 t_RV to an empty string: >
7476 :set t_RV=
7477<
7478 *'ttyscroll'* *'tsl'*
7479'ttyscroll' 'tsl' number (default 999)
7480 global
7481 Maximum number of lines to scroll the screen. If there are more lines
7482 to scroll the window is redrawn. For terminals where scrolling is
7483 very slow and redrawing is not slow this can be set to a small number,
7484 e.g., 3, to speed up displaying.
7485
7486 *'ttytype'* *'tty'*
7487'ttytype' 'tty' string (default from $TERM)
7488 global
7489 Alias for 'term', see above.
7490
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007491 *'undodir'* *'udir'*
7492'undodir' 'udir' string (default ".")
7493 global
7494 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007495 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007496 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007497 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007498 "." means using the directory of the file. The undo file name for
7499 "file.txt" is ".file.txt.un~".
7500 For other directories the file name is the full path of the edited
7501 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007502 When writing: The first directory that exists is used. "." always
7503 works, no directories after "." will be used for writing.
7504 When reading all entries are tried to find an undo file. The first
7505 undo file that exists is used. When it cannot be read an error is
7506 given, no further entry is used.
7507 See |undo-persistence|.
7508
7509 *'undofile'* *'udf'*
7510'undofile' 'udf' boolean (default off)
7511 local to buffer
7512 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007513 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007514 When on, Vim automatically saves undo history to an undo file when
7515 writing a buffer to a file, and restores undo history from the same
7516 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007517 The directory where the undo file is stored is specified by 'undodir'.
7518 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007519 The undo file is not read when 'undoreload' causes the buffer from
7520 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007521 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007522
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 *'undolevels'* *'ul'*
7524'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7525 Win32 and OS/2)
7526 global
7527 {not in Vi}
7528 Maximum number of changes that can be undone. Since undo information
7529 is kept in memory, higher numbers will cause more memory to be used
7530 (nevertheless, a single change can use an unlimited amount of memory).
7531 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7532 itself: >
7533 set ul=0
7534< But you can also get Vi compatibility by including the 'u' flag in
7535 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007536 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007537 Set to a negative number for no undo at all: >
7538 set ul=-1
7539< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007540 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007542 *'undoreload'* *'ur'*
7543'undoreload' 'ur' number (default 10000)
7544 global
7545 {not in Vi}
7546 Save the whole buffer for undo when reloading it. This applies to the
7547 ":e!" command and reloading for when the buffer changed outside of
7548 Vim. |FileChangedShell|
7549 The save only happens when this options is negative or when the number
7550 of lines is smaller than the value of this option.
7551 Set this option to zero to disable undo for a reload.
7552
7553 When saving undo for a reload, any undo file is not read.
7554
7555 Note that this causes the whole buffer to be stored in memory. Set
7556 this option to a lower value if you run out of memory.
7557
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 *'updatecount'* *'uc'*
7559'updatecount' 'uc' number (default: 200)
7560 global
7561 {not in Vi}
7562 After typing this many characters the swap file will be written to
7563 disk. When zero, no swap file will be created at all (see chapter on
7564 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7565 Vim with the "-n" option, see |startup|. When editing in readonly
7566 mode this option will be initialized to 10000.
7567 The swapfile can be disabled per buffer with |'swapfile'|.
7568 When 'updatecount' is set from zero to non-zero, swap files are
7569 created for all buffers that have 'swapfile' set. When 'updatecount'
7570 is set to zero, existing swap files are not deleted.
7571 Also see |'swapsync'|.
7572 This option has no meaning in buffers where |'buftype'| is "nofile"
7573 or "nowrite".
7574
7575 *'updatetime'* *'ut'*
7576'updatetime' 'ut' number (default 4000)
7577 global
7578 {not in Vi}
7579 If this many milliseconds nothing is typed the swap file will be
7580 written to disk (see |crash-recovery|). Also used for the
7581 |CursorHold| autocommand event.
7582
7583 *'verbose'* *'vbs'*
7584'verbose' 'vbs' number (default 0)
7585 global
7586 {not in Vi, although some versions have a boolean
7587 verbose option}
7588 When bigger than zero, Vim will give messages about what it is doing.
7589 Currently, these messages are given:
7590 >= 1 When the viminfo file is read or written.
7591 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007592 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007593 >= 8 Files for which a group of autocommands is executed.
7594 >= 9 Every executed autocommand.
7595 >= 12 Every executed function.
7596 >= 13 When an exception is thrown, caught, finished, or discarded.
7597 >= 14 Anything pending in a ":finally" clause.
7598 >= 15 Every executed Ex command (truncated at 200 characters).
7599
7600 This option can also be set with the "-V" argument. See |-V|.
7601 This option is also set by the |:verbose| command.
7602
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007603 When the 'verbosefile' option is set then the verbose messages are not
7604 displayed.
7605
7606 *'verbosefile'* *'vfile'*
7607'verbosefile' 'vfile' string (default empty)
7608 global
7609 {not in Vi}
7610 When not empty all messages are written in a file with this name.
7611 When the file exists messages are appended.
7612 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007613 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007614 Setting 'verbosefile' to a new value is like making it empty first.
7615 The difference with |:redir| is that verbose messages are not
7616 displayed when 'verbosefile' is set.
7617
Bram Moolenaar071d4272004-06-13 20:20:40 +00007618 *'viewdir'* *'vdir'*
7619'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7620 "$VIM/vimfiles/view",
7621 for Unix: "~/.vim/view",
7622 for Macintosh: "$VIM:vimfiles:view"
7623 for VMS: "sys$login:vimfiles/view"
7624 for RiscOS: "Choices:vimfiles/view")
7625 global
7626 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007627 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 feature}
7629 Name of the directory where to store files for |:mkview|.
7630 This option cannot be set from a |modeline| or in the |sandbox|, for
7631 security reasons.
7632
7633 *'viewoptions'* *'vop'*
7634'viewoptions' 'vop' string (default: "folds,options,cursor")
7635 global
7636 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007637 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007638 feature}
7639 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007640 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007641 word save and restore ~
7642 cursor cursor position in file and in window
7643 folds manually created folds, opened/closed folds and local
7644 fold options
7645 options options and mappings local to a window or buffer (not
7646 global values for local options)
7647 slash backslashes in file names replaced with forward
7648 slashes
7649 unix with Unix end-of-line format (single <NL>), even when
7650 on Windows or DOS
7651
7652 "slash" and "unix" are useful on Windows when sharing view files
7653 with Unix. The Unix version of Vim cannot source dos format scripts,
7654 but the Windows version of Vim can source unix format scripts.
7655
7656 *'viminfo'* *'vi'* *E526* *E527* *E528*
7657'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007658 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7659 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7660 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 global
7662 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007663 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 feature}
7665 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007666 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 separated list of parameters, each consisting of a single character
7668 identifying the particular parameter, followed by a number or string
7669 which specifies the value of that parameter. If a particular
7670 character is left out, then the default value is used for that
7671 parameter. The following is a list of the identifying characters and
7672 the effect of their value.
7673 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007674 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 ! When included, save and restore global variables that start
7676 with an uppercase letter, and don't contain a lowercase
7677 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007678 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007679 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007680 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 " Maximum number of lines saved for each register. Old name of
7682 the '<' item, with the disadvantage that you need to put a
7683 backslash before the ", otherwise it will be recognized as the
7684 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007685 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 % When included, save and restore the buffer list. If Vim is
7687 started with a file name argument, the buffer list is not
7688 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007689 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 without a file name and buffers for help files are not written
7691 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007692 When followed by a number, the number specifies the maximum
7693 number of buffers that are stored. Without a number all
7694 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007695 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 ' Maximum number of previously edited files for which the marks
7697 are remembered. This parameter must always be included when
7698 'viminfo' is non-empty.
7699 Including this item also means that the |jumplist| and the
7700 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007701 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007703 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007704 patterns are also saved. When not included, the value of
7705 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007706 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007708 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007709 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007710 < Maximum number of lines saved for each register. If zero then
7711 registers are not saved. When not included, all lines are
7712 saved. '"' is the old name for this item.
7713 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007714 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007716 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007717 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007718 c When included, convert the text in the viminfo file from the
7719 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007720 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007721 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007722 f Whether file marks need to be stored. If zero, file marks ('0
7723 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007724 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007725 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007726 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 h Disable the effect of 'hlsearch' when loading the viminfo
7728 file. When not included, it depends on whether ":nohlsearch"
7729 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007730 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 n Name of the viminfo file. The name must immediately follow
7732 the 'n'. Must be the last one! If the "-i" argument was
7733 given when starting Vim, that file name overrides the one
7734 given here with 'viminfo'. Environment variables are expanded
7735 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007736 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007737 r Removable media. The argument is a string (up to the next
7738 ','). This parameter can be given several times. Each
7739 specifies the start of a path for which no marks will be
7740 stored. This is to avoid removable media. For MS-DOS you
7741 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7742 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7743 ignored. Maximum length of each 'r' argument is 50
7744 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007745 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 s Maximum size of an item in Kbyte. If zero then registers are
7747 not saved. Currently only applies to registers. The default
7748 "s10" will exclude registers with more than 10 Kbyte of text.
7749 Also see the '<' item above: line count limit.
7750
7751 Example: >
7752 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7753<
7754 '50 Marks will be remembered for the last 50 files you
7755 edited.
7756 <1000 Contents of registers (up to 1000 lines each) will be
7757 remembered.
7758 s100 Registers with more than 100 Kbyte text are skipped.
7759 :0 Command-line history will not be saved.
7760 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7761 no / Since '/' is not specified, the default will be used,
7762 that is, save all of the search history, and also the
7763 previous search and substitute patterns.
7764 no % The buffer list will not be saved nor read back.
7765 no h 'hlsearch' highlighting will be restored.
7766
7767 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7768 load the contents of the file, this is not done automatically.
7769
7770 This option cannot be set from a |modeline| or in the |sandbox|, for
7771 security reasons.
7772
7773 *'virtualedit'* *'ve'*
7774'virtualedit' 've' string (default "")
7775 global
7776 {not in Vi}
7777 {not available when compiled without the
7778 |+virtualedit| feature}
7779 A comma separated list of these words:
7780 block Allow virtual editing in Visual block mode.
7781 insert Allow virtual editing in Insert mode.
7782 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007783 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007784
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007786 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 of the line. Useful for selecting a rectangle in Visual mode and
7788 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007789 "onemore" is not the same, it will only allow moving the cursor just
7790 after the last character of the line. This makes some commands more
7791 consistent. Previously the cursor was always past the end of the line
7792 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007793 break some plugins or Vim scripts. For example because |l| can move
7794 the cursor after the last character. Use with care!
7795 Using the |$| command will move to the last character in the line, not
7796 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007797 It doesn't make sense to combine "all" with "onemore", but you will
7798 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799
7800 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7801'visualbell' 'vb' boolean (default off)
7802 global
7803 {not in Vi}
7804 Use visual bell instead of beeping. The terminal code to display the
7805 visual bell is given with 't_vb'. When no beep or flash is wanted,
7806 use ":set vb t_vb=".
7807 Note: When the GUI starts, 't_vb' is reset to its default value. You
7808 might want to set it again in your |gvimrc|.
7809 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7810 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7811 where 40 is the time in msec.
7812 Does not work on the Amiga, you always get a screen flash.
7813 Also see 'errorbells'.
7814
7815 *'warn'* *'nowarn'*
7816'warn' boolean (default on)
7817 global
7818 Give a warning message when a shell command is used while the buffer
7819 has been changed.
7820
7821 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7822'weirdinvert' 'wiv' boolean (default off)
7823 global
7824 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007825 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 It is provided for backwards compatibility with version 4.x.
7827 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7828 vice versa. Has no effect when the GUI is running.
7829
7830 *'whichwrap'* *'ww'*
7831'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7832 global
7833 {not in Vi}
7834 Allow specified keys that move the cursor left/right to move to the
7835 previous/next line when the cursor is on the first/last character in
7836 the line. Concatenate characters to allow this for these keys:
7837 char key mode ~
7838 b <BS> Normal and Visual
7839 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007840 h "h" Normal and Visual (not recommended)
7841 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842 < <Left> Normal and Visual
7843 > <Right> Normal and Visual
7844 ~ "~" Normal
7845 [ <Left> Insert and Replace
7846 ] <Right> Insert and Replace
7847 For example: >
7848 :set ww=<,>,[,]
7849< allows wrap only when cursor keys are used.
7850 When the movement keys are used in combination with a delete or change
7851 operator, the <EOL> also counts for a character. This makes "3h"
7852 different from "3dh" when the cursor crosses the end of a line. This
7853 is also true for "x" and "X", because they do the same as "dl" and
7854 "dh". If you use this, you may also want to use the mapping
7855 ":map <BS> X" to make backspace delete the character in front of the
7856 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007857 When 'l' is included and it is used after an operator at the end of a
7858 line then it will not move to the next line. This makes "dl", "cl",
7859 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007860 NOTE: This option is set to the Vi default value when 'compatible' is
7861 set and to the Vim default value when 'compatible' is reset.
7862
7863 *'wildchar'* *'wc'*
7864'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7865 global
7866 {not in Vi}
7867 Character you have to type to start wildcard expansion in the
7868 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007869 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007870 The character is not recognized when used inside a macro. See
7871 'wildcharm' for that.
7872 Although 'wc' is a number option, you can set it to a special key: >
7873 :set wc=<Esc>
7874< NOTE: This option is set to the Vi default value when 'compatible' is
7875 set and to the Vim default value when 'compatible' is reset.
7876
7877 *'wildcharm'* *'wcm'*
7878'wildcharm' 'wcm' number (default: none (0))
7879 global
7880 {not in Vi}
7881 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007882 recognized when used inside a macro. You can find "spare" command-line
7883 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 you'll never actually type 'wildcharm', just use it in mappings that
7885 automatically invoke completion mode, e.g.: >
7886 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007887 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888< Then after typing :ss you can use CTRL-P & CTRL-N.
7889
7890 *'wildignore'* *'wig'*
7891'wildignore' 'wig' string (default "")
7892 global
7893 {not in Vi}
7894 {not available when compiled without the |+wildignore|
7895 feature}
7896 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02007897 patterns is ignored when expanding |wildcards|, completing file or
7898 directory names, and influences the result of |expand()|, |glob()| and
7899 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007900 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7901 Also see 'suffixes'.
7902 Example: >
7903 :set wildignore=*.o,*.obj
7904< The use of |:set+=| and |:set-=| is preferred when adding or removing
7905 a pattern from the list. This avoids problems when a future version
7906 uses another default.
7907
Bram Moolenaar94950a92010-12-02 16:01:29 +01007908
Bram Moolenaar81af9252010-12-10 20:35:50 +01007909 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007910'wildignorecase' 'wic' boolean (default off)
7911 global
7912 {not in Vi}
7913 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01007914 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01007915 Does not apply when the shell is used to expand wildcards, which
7916 happens when there are special characters.
7917
7918
Bram Moolenaar071d4272004-06-13 20:20:40 +00007919 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7920'wildmenu' 'wmnu' boolean (default off)
7921 global
7922 {not in Vi}
7923 {not available if compiled without the |+wildmenu|
7924 feature}
7925 When 'wildmenu' is on, command-line completion operates in an enhanced
7926 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7927 the possible matches are shown just above the command line, with the
7928 first match highlighted (overwriting the status line, if there is
7929 one). Keys that show the previous/next match, such as <Tab> or
7930 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7931 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7932 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01007933 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 If there are more matches than can fit in the line, a ">" is shown on
7935 the right and/or a "<" is shown on the left. The status line scrolls
7936 as needed.
7937 The "wildmenu" mode is abandoned when a key is hit that is not used
7938 for selecting a completion.
7939 While the "wildmenu" is active the following keys have special
7940 meanings:
7941
7942 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7943 <Down> - in filename/menu name completion: move into a
7944 subdirectory or submenu.
7945 <CR> - in menu completion, when the cursor is just after a
7946 dot: move into a submenu.
7947 <Up> - in filename/menu name completion: move up into
7948 parent directory or parent menu.
7949
7950 This makes the menus accessible from the console |console-menus|.
7951
7952 If you prefer the <Left> and <Right> keys to move the cursor instead
7953 of selecting a different match, use this: >
7954 :cnoremap <Left> <Space><BS><Left>
7955 :cnoremap <Right> <Space><BS><Right>
7956<
7957 The "WildMenu" highlighting is used for displaying the current match
7958 |hl-WildMenu|.
7959
7960 *'wildmode'* *'wim'*
7961'wildmode' 'wim' string (Vim default: "full")
7962 global
7963 {not in Vi}
7964 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007965 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007966 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007967 first part specifies the behavior for the first use of 'wildchar',
7968 The second part for the second use, etc.
7969 These are the possible values for each part:
7970 "" Complete only the first match.
7971 "full" Complete the next full match. After the last match,
7972 the original string is used and then the first match
7973 again.
7974 "longest" Complete till longest common string. If this doesn't
7975 result in a longer string, use the next part.
7976 "longest:full" Like "longest", but also start 'wildmenu' if it is
7977 enabled.
7978 "list" When more than one match, list all matches.
7979 "list:full" When more than one match, list all matches and
7980 complete first match.
7981 "list:longest" When more than one match, list all matches and
7982 complete till longest common string.
7983 When there is only a single match, it is fully completed in all cases.
7984
7985 Examples: >
7986 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007987< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 :set wildmode=longest,full
7989< Complete longest common string, then each full match >
7990 :set wildmode=list:full
7991< List all matches and complete each full match >
7992 :set wildmode=list,full
7993< List all matches without completing, then each full match >
7994 :set wildmode=longest,list
7995< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007996 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007998 *'wildoptions'* *'wop'*
7999'wildoptions' 'wop' string (default "")
8000 global
8001 {not in Vi}
8002 {not available when compiled without the |+wildignore|
8003 feature}
8004 A list of words that change how command line completion is done.
8005 Currently only one word is allowed:
8006 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008007 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008008 is displayed per line. Often used tag kinds are:
8009 d #define
8010 f function
8011 Also see |cmdline-completion|.
8012
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 *'winaltkeys'* *'wak'*
8014'winaltkeys' 'wak' string (default "menu")
8015 global
8016 {not in Vi}
8017 {only used in Win32, Motif, GTK and Photon GUI}
8018 Some GUI versions allow the access to menu entries by using the ALT
8019 key in combination with a character that appears underlined in the
8020 menu. This conflicts with the use of the ALT key for mappings and
8021 entering special characters. This option tells what to do:
8022 no Don't use ALT keys for menus. ALT key combinations can be
8023 mapped, but there is no automatic handling. This can then be
8024 done with the |:simalt| command.
8025 yes ALT key handling is done by the windowing system. ALT key
8026 combinations cannot be mapped.
8027 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008028 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 keys can be mapped.
8030 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8031 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008032 This option is not used for <F10>; on Win32 and with GTK <F10> will
8033 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008035 *'window'* *'wi'*
8036'window' 'wi' number (default screen height - 1)
8037 global
8038 Window height. Do not confuse this with the height of the Vim window,
8039 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008040 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8041 value is smaller than 'lines' minus one. The screen will scroll
8042 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008043 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8044 in a much smarter way, taking care of wrapping lines.
8045 When resizing the Vim window, the value is smaller than 1 or more than
8046 or equal to 'lines' it will be set to 'lines' minus 1.
8047 {Vi also uses the option to specify the number of displayed lines}
8048
Bram Moolenaar071d4272004-06-13 20:20:40 +00008049 *'winheight'* *'wh'* *E591*
8050'winheight' 'wh' number (default 1)
8051 global
8052 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008053 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 feature}
8055 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008056 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008057 focus goes to a window that is smaller, its size is increased, at the
8058 cost of the height of other windows.
8059 Set 'winheight' to a small number for normal editing.
8060 Set it to 999 to make the current window fill most of the screen.
8061 Other windows will be only 'winminheight' high. This has the drawback
8062 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8063 to create only two windows, set the option after startup is done,
8064 using the |VimEnter| event: >
8065 au VimEnter * set winheight=999
8066< Minimum value is 1.
8067 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008068 height of the current window.
8069 'winheight' applies to the current window. Use 'winminheight' to set
8070 the minimal height for other windows.
8071
8072 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8073'winfixheight' 'wfh' boolean (default off)
8074 local to window
8075 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008076 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 feature}
8078 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008079 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8080 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008081 The height may be changed anyway when running out of room.
8082
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008083 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8084'winfixwidth' 'wfw' boolean (default off)
8085 local to window
8086 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008087 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008088 feature}
8089 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008090 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008091 The width may be changed anyway when running out of room.
8092
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 *'winminheight'* *'wmh'*
8094'winminheight' 'wmh' number (default 1)
8095 global
8096 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008097 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008098 feature}
8099 The minimal height of a window, when it's not the current window.
8100 This is a hard minimum, windows will never become smaller.
8101 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8102 status bar) if necessary. They will return to at least one line when
8103 they become active (since the cursor has to have somewhere to go.)
8104 Use 'winheight' to set the minimal height of the current window.
8105 This option is only checked when making a window smaller. Don't use a
8106 large number, it will cause errors when opening more than a few
8107 windows. A value of 0 to 3 is reasonable.
8108
8109 *'winminwidth'* *'wmw'*
8110'winminwidth' 'wmw' number (default 1)
8111 global
8112 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008113 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 feature}
8115 The minimal width of a window, when it's not the current window.
8116 This is a hard minimum, windows will never become smaller.
8117 When set to zero, windows may be "squashed" to zero columns (i.e. just
8118 a vertical separator) if necessary. They will return to at least one
8119 line when they become active (since the cursor has to have somewhere
8120 to go.)
8121 Use 'winwidth' to set the minimal width of the current window.
8122 This option is only checked when making a window smaller. Don't use a
8123 large number, it will cause errors when opening more than a few
8124 windows. A value of 0 to 12 is reasonable.
8125
8126 *'winwidth'* *'wiw'* *E592*
8127'winwidth' 'wiw' number (default 20)
8128 global
8129 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008130 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 feature}
8132 Minimal number of columns for the current window. This is not a hard
8133 minimum, Vim will use fewer columns if there is not enough room. If
8134 the current window is smaller, its size is increased, at the cost of
8135 the width of other windows. Set it to 999 to make the current window
8136 always fill the screen. Set it to a small number for normal editing.
8137 The width is not adjusted after one of the commands to change the
8138 width of the current window.
8139 'winwidth' applies to the current window. Use 'winminwidth' to set
8140 the minimal width for other windows.
8141
8142 *'wrap'* *'nowrap'*
8143'wrap' boolean (default on)
8144 local to window
8145 {not in Vi}
8146 This option changes how text is displayed. It doesn't change the text
8147 in the buffer, see 'textwidth' for that.
8148 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008149 displaying continues on the next line. When off lines will not wrap
8150 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 moved to a part that is not shown, the screen will scroll
8152 horizontally.
8153 The line will be broken in the middle of a word if necessary. See
8154 'linebreak' to get the break at a word boundary.
8155 To make scrolling horizontally a bit more useful, try this: >
8156 :set sidescroll=5
8157 :set listchars+=precedes:<,extends:>
8158< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008159 This option can't be set from a |modeline| when the 'diff' option is
8160 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008161
8162 *'wrapmargin'* *'wm'*
8163'wrapmargin' 'wm' number (default 0)
8164 local to buffer
8165 Number of characters from the right window border where wrapping
8166 starts. When typing text beyond this limit, an <EOL> will be inserted
8167 and inserting continues on the next line.
8168 Options that add a margin, such as 'number' and 'foldcolumn', cause
8169 the text width to be further reduced. This is Vi compatible.
8170 When 'textwidth' is non-zero, this option is not used.
8171 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8172 and less usefully}
8173
8174 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8175'wrapscan' 'ws' boolean (default on) *E384* *E385*
8176 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008177 Searches wrap around the end of the file. Also applies to |]s| and
8178 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179
8180 *'write'* *'nowrite'*
8181'write' boolean (default on)
8182 global
8183 {not in Vi}
8184 Allows writing files. When not set, writing a file is not allowed.
8185 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008186 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008187 argument. Filtering text is still possible, even though this requires
8188 writing a temporary file.
8189
8190 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8191'writeany' 'wa' boolean (default off)
8192 global
8193 Allows writing to any file with no need for "!" override.
8194
8195 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8196'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8197 otherwise)
8198 global
8199 {not in Vi}
8200 Make a backup before overwriting a file. The backup is removed after
8201 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008202 also on.
8203 WARNING: Switching this option off means that when Vim fails to write
8204 your buffer correctly and then, for whatever reason, Vim exits, you
8205 lose both the original file and what you were writing. Only reset
8206 this option if your file system is almost full and it makes the write
8207 fail (and make sure not to exit Vim until the write was successful).
8208 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008209 When the 'backupskip' pattern matches, a backup is not made anyway.
8210 NOTE: This option is set to the default value when 'compatible' is
8211 set.
8212
8213 *'writedelay'* *'wd'*
8214'writedelay' 'wd' number (default 0)
8215 global
8216 {not in Vi}
8217 The number of microseconds to wait for each character sent to the
8218 screen. When non-zero, characters are sent to the terminal one by
8219 one. For MS-DOS pcterm this does not work. For debugging purposes.
8220
8221 vim:tw=78:ts=8:ft=help:norl: