blob: b3cd34cb30906f2bbb81e4eb07dc5d0e0255ec69 [file] [log] [blame]
Bram Moolenaar88774fd2015-08-25 19:52:04 +02001*options.txt* For Vim version 7.4. Last change: 2015 Aug 25
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
Bram Moolenaar88774fd2015-08-25 19:52:04 +020053:se[t] all& Set all options to their default value. The values of
54 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
65 {not in Vi}
Bram Moolenaar071d4272004-06-13 20:20:40 +000066
67 *:set-args* *E487* *E521*
68:se[t] {option}={value} or
69:se[t] {option}:{value}
70 Set string or number option to {value}.
71 For numeric options the value can be given in decimal,
Bram Moolenaar18400e62015-01-27 15:58:40 +010072 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000073 The old value can be inserted by typing 'wildchar' (by
74 default this is a <Tab> or CTRL-E if 'compatible' is
75 set). See |cmdline-completion|.
76 White space between {option} and '=' is allowed and
77 will be ignored. White space between '=' and {value}
78 is not allowed.
79 See |option-backslash| for using white space and
80 backslashes in {value}.
81
82:se[t] {option}+={value} *:set+=*
83 Add the {value} to a number option, or append the
84 {value} to a string option. When the option is a
85 comma separated list, a comma is added, unless the
86 value was empty.
87 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000088 are removed. When adding a flag that was already
89 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000090 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000091 {not in Vi}
92
93:se[t] {option}^={value} *:set^=*
94 Multiply the {value} to a number option, or prepend
95 the {value} to a string option. When the option is a
96 comma separated list, a comma is added, unless the
97 value was empty.
98 Also see |:set-args| above.
99 {not in Vi}
100
101:se[t] {option}-={value} *:set-=*
102 Subtract the {value} from a number option, or remove
103 the {value} from a string option, if it is there.
104 If the {value} is not found in a string option, there
105 is no error or warning. When the option is a comma
106 separated list, a comma is deleted, unless the option
107 becomes empty.
108 When the option is a list of flags, {value} must be
109 exactly as they appear in the option. Remove flags
110 one by one to avoid problems.
111 Also see |:set-args| above.
112 {not in Vi}
113
114The {option} arguments to ":set" may be repeated. For example: >
115 :set ai nosi sw=3 ts=3
116If you make an error in one of the arguments, an error message will be given
117and the following arguments will be ignored.
118
119 *:set-verbose*
120When 'verbose' is non-zero, displaying an option value will also tell where it
121was last set. Example: >
122 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123< shiftwidth=4 ~
124 Last set from modeline ~
125 cindent ~
126 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
127This is only done when specific option values are requested, not for ":verbose
128set all" or ":verbose set" without an argument.
129When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130When the option was set while executing a function, user command or
131autocommand, the script in which it was defined is reported.
132Note that an option may also have been set as a side effect of setting
133'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000134A few special texts:
135 Last set from modeline ~
136 Option was set in a |modeline|.
137 Last set from --cmd argument ~
138 Option was set with command line argument |--cmd| or +.
139 Last set from -c argument ~
140 Option was set with command line argument |-c|, +, |-S| or
141 |-q|.
142 Last set from environment variable ~
143 Option was set from an environment variable, $VIMINIT,
144 $GVIMINIT or $EXINIT.
145 Last set from error handler ~
146 Option was cleared when evaluating it resulted in an error.
147
Bram Moolenaardb84e452010-08-15 13:50:43 +0200148{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149
150 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000151For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152override the value from the termcap. You can then use it in a mapping. If
153the "xx" part contains special characters, use the <t_xx> form: >
154 :set <t_#4>=^[Ot
155This can also be used to translate a special code for a normal key. For
156example, if Alt-b produces <Esc>b, use this: >
157 :set <M-b>=^[b
158(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
159The advantage over a mapping is that it works in all situations.
160
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100161You can define any key codes, e.g.: >
162 :set t_xy=^[foo;
163There is no warning for using a name that isn't recognized. You can map these
164codes as you like: >
165 :map <t_xy> something
166< *E846*
167When a key code is not set, it's like it does not exist. Trying to get its
168value will result in an error: >
169 :set t_kb=
170 :set t_kb
171 E846: Key code not set: t_kb
172
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000173The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
174security reasons.
175
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000177at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178"set all" probably does not fit on the screen, causing Vim to give the
179|more-prompt|.
180
181 *option-backslash*
182To include white space in a string option value it has to be preceded with a
183backslash. To include a backslash you have to use two. Effectively this
184means that the number of backslashes in an option value is halved (rounded
185down).
186A few examples: >
187 :set tags=tags\ /usr/tags results in "tags /usr/tags"
188 :set tags=tags\\,file results in "tags\,file"
189 :set tags=tags\\\ file results in "tags\ file"
190
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000191The "|" character separates a ":set" command from a following command. To
192include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193'titlestring' option to "hi|there": >
194 :set titlestring=hi\|there
195This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
196 :set titlestring=hi|set iconstring=there
197
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000198Similarly, the double quote character starts a comment. To include the '"' in
199the option value, use '\"' instead. This example sets the 'titlestring'
200option to 'hi "there"': >
201 :set titlestring=hi\ \"there\"
202
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000203For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000204precise: For options that expect a file name (those where environment
205variables are expanded) a backslash before a normal file name character is not
206removed. But a backslash before a special character (space, backslash, comma,
207etc.) is used like explained above.
208There is one special situation, when the value starts with "\\": >
209 :set dir=\\machine\path results in "\\machine\path"
210 :set dir=\\\\machine\\path results in "\\machine\path"
211 :set dir=\\path\\file results in "\\path\file" (wrong!)
212For the first one the start is kept, but for the second one the backslashes
213are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000214halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000215result which is probably not what you want. Avoid it.
216
217 *add-option-flags* *remove-option-flags*
218 *E539* *E550* *E551* *E552*
219Some options are a list of flags. When you want to add a flag to such an
220option, without changing the existing ones, you can do it like this: >
221 :set guioptions+=a
222Remove a flag from an option like this: >
223 :set guioptions-=a
224This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000225Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000226the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
227doesn't appear.
228
229 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000230Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231environment variable exists the '$' and the following environment variable
232name is replaced with its value. If it does not exist the '$' and the name
233are not modified. Any non-id character (not a letter, digit or '_') may
234follow the environment variable name. That character and what follows is
235appended to the value of the environment variable. Examples: >
236 :set term=$TERM.new
237 :set path=/usr/$INCLUDE,$HOME/include,.
238When adding or removing a string from an option with ":set opt-=val" or ":set
239opt+=val" the expansion is done before the adding or removing.
240
241
242Handling of local options *local-options*
243
244Some of the options only apply to a window or buffer. Each window or buffer
245has its own copy of this option, thus can each have their own value. This
246allows you to set 'list' in one window but not in another. And set
247'shiftwidth' to 3 in one buffer and 4 in another.
248
249The following explains what happens to these local options in specific
250situations. You don't really need to know all of this, since Vim mostly uses
251the option values you would expect. Unfortunately, doing what the user
252expects is a bit complicated...
253
254When splitting a window, the local options are copied to the new window. Thus
255right after the split the contents of the two windows look the same.
256
257When editing a new buffer, its local option values must be initialized. Since
258the local options of the current buffer might be specifically for that buffer,
259these are not used. Instead, for each buffer-local option there also is a
260global value, which is used for new buffers. With ":set" both the local and
261global value is changed. With "setlocal" only the local value is changed,
262thus this value is not used when editing a new buffer.
263
264When editing a buffer that has been edited before, the last used window
265options are used again. If this buffer has been edited in this window, the
266values from back then are used. Otherwise the values from the window where
267the buffer was edited last are used.
268
269It's possible to set a local window option specifically for a type of buffer.
270When you edit another buffer in the same window, you don't want to keep
271using these local window options. Therefore Vim keeps a global value of the
272local window options, which is used when editing another buffer. Each window
273has its own copy of these values. Thus these are local to the window, but
274global to all buffers in the window. With this you can do: >
275 :e one
276 :set list
277 :e two
278Now the 'list' option will also be set in "two", since with the ":set list"
279command you have also set the global value. >
280 :set nolist
281 :e one
282 :setlocal list
283 :e two
284Now the 'list' option is not set, because ":set nolist" resets the global
285value, ":setlocal list" only changes the local value and ":e two" gets the
286global value. Note that if you do this next: >
287 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200288You will get back the 'list' value as it was the last time you edited "one".
289The options local to a window are remembered for each buffer. This also
290happens when the buffer is not loaded, but they are lost when the buffer is
291wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292
293 *:setl* *:setlocal*
294:setl[ocal] ... Like ":set" but set only the value local to the
295 current buffer or window. Not all options have a
296 local value. If the option does not have a local
297 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200298 With the "all" argument: display local values for all
299 local options.
300 Without argument: Display local values for all local
301 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000303 local value. For a global/local boolean option, when
304 the global value is being used, "--" is displayed
305 before the option name.
306 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307 shown (but that might change in the future).
308 {not in Vi}
309
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000310:setl[ocal] {option}< Set the local value of {option} to its global value by
311 copying the value.
312 {not in Vi}
313
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100314:se[t] {option}< For |global-local| options: Remove the local value of
315 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318 *:setg* *:setglobal*
319:setg[lobal] ... Like ":set" but set only the global value for a local
320 option without changing the local value.
321 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200322 With the "all" argument: display global values for all
323 local options.
324 Without argument: display global values for all local
325 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000326 {not in Vi}
327
328For buffer-local and window-local options:
329 Command global value local value ~
330 :set option=value set set
331 :setlocal option=value - set
332:setglobal option=value set -
333 :set option? - display
334 :setlocal option? - display
335:setglobal option? display -
336
337
338Global options with a local value *global-local*
339
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000340Options are global when you mostly use one value for all buffers and windows.
341For some global options it's useful to sometimes have a different local value.
342You can set the local value with ":setlocal". That buffer or window will then
343use the local value, while other buffers and windows continue using the global
344value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345
346For example, you have two windows, both on C source code. They use the global
347'makeprg' option. If you do this in one of the two windows: >
348 :set makeprg=gmake
349then the other window will switch to the same value. There is no need to set
350the 'makeprg' option in the other C source window too.
351However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000352another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000353files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 :setlocal makeprg=perlmake
355You can switch back to using the global value by making the local value empty: >
356 :setlocal makeprg=
357This only works for a string option. For a boolean option you need to use the
358"<" flag, like this: >
359 :setlocal autoread<
360Note that for non-boolean options using "<" copies the global value to the
361local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000362when the global value changes later). You can also use: >
363 :set path<
364This will make the local value of 'path' empty, so that the global value is
365used. Thus it does the same as: >
366 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000367Note: In the future more global options can be made global-local. Using
368":setlocal" on a global option might work differently then.
369
370
371Setting the filetype
372
373:setf[iletype] {filetype} *:setf* *:setfiletype*
374 Set the 'filetype' option to {filetype}, but only if
375 not done yet in a sequence of (nested) autocommands.
376 This is short for: >
377 :if !did_filetype()
378 : setlocal filetype={filetype}
379 :endif
380< This command is used in a filetype.vim file to avoid
381 setting the 'filetype' option twice, causing different
382 settings and syntax files to be loaded.
383 {not in Vi}
384
Bram Moolenaard58e9292011-02-09 17:07:58 +0100385 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000386:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
387:opt[ions] Open a window for viewing and setting all options.
388 Options are grouped by function.
389 Offers short help for each option. Hit <CR> on the
390 short help to open a help window with more help for
391 the option.
392 Modify the value of the option and hit <CR> on the
393 "set" line to set the new value. For window and
394 buffer specific options, the last accessed window is
395 used to set the option value in, unless this is a help
396 window, in which case the window below help window is
397 used (skipping the option-window).
398 {not available when compiled without the |+eval| or
399 |+autocmd| features}
400
401 *$HOME*
402Using "~" is like using "$HOME", but it is only recognized at the start of an
403option and after a space or comma.
404
405On Unix systems "~user" can be used too. It is replaced by the home directory
406of user "user". Example: >
407 :set path=~mool/include,/usr/include,.
408
409On Unix systems the form "${HOME}" can be used too. The name between {} can
410contain non-id characters then. Note that if you want to use this for the
411"gf" command, you need to add the '{' and '}' characters to 'isfname'.
412
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100413On MS-Windows, if $HOME is not defined as an environment variable, then
414at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
415
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416NOTE: expanding environment variables and "~/" is only done with the ":set"
417command, not when assigning a value to an option with ":let".
418
419
420Note the maximum length of an expanded option is limited. How much depends on
421the system, mostly it is something like 256 or 1024 characters.
422
423 *:fix* *:fixdel*
424:fix[del] Set the value of 't_kD':
425 't_kb' is 't_kD' becomes ~
426 CTRL-? CTRL-H
427 not CTRL-? CTRL-?
428
429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
430
431 If your delete key terminal code is wrong, but the
432 code for backspace is alright, you can put this in
433 your .vimrc: >
434 :fixdel
435< This works no matter what the actual code for
436 backspace is.
437
438 If the backspace key terminal code is wrong you can
439 use this: >
440 :if &term == "termname"
441 : set t_kb=^V<BS>
442 : fixdel
443 :endif
444< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000445 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446 with your terminal name.
447
448 If your <Delete> key sends a strange key sequence (not
449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
450 :if &term == "termname"
451 : set t_kD=^V<Delete>
452 :endif
453< Where "^V" is CTRL-V and "<Delete>" is the delete key
454 (don't type eight characters!). Replace "termname"
455 with your terminal name.
456
457 *Linux-backspace*
458 Note about Linux: By default the backspace key
459 produces CTRL-?, which is wrong. You can fix it by
460 putting this line in your rc.local: >
461 echo "keycode 14 = BackSpace" | loadkeys
462<
463 *NetBSD-backspace*
464 Note about NetBSD: If your backspace doesn't produce
465 the right code, try this: >
466 xmodmap -e "keycode 22 = BackSpace"
467< If this works, add this in your .Xmodmap file: >
468 keysym 22 = BackSpace
469< You need to restart for this to take effect.
470
471==============================================================================
4722. Automatically setting options *auto-setting*
473
474Besides changing options with the ":set" command, there are three alternatives
475to set options automatically for one or more files:
476
4771. When starting Vim initializations are read from various places. See
478 |initialization|. Most of them are performed for all editing sessions,
479 and some of them depend on the directory where Vim is started.
480 You can create an initialization file with |:mkvimrc|, |:mkview| and
481 |:mksession|.
4822. If you start editing a new file, the automatic commands are executed.
483 This can be used to set options for files matching a particular pattern and
484 many other things. See |autocommand|.
4853. If you start editing a new file, and the 'modeline' option is on, a
486 number of lines at the beginning and end of the file are checked for
487 modelines. This is explained here.
488
489 *modeline* *vim:* *vi:* *ex:* *E520*
490There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200491 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200493[text] any text or empty
494{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200495{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200496[white] optional white space
497{options} a list of option settings, separated with white space
498 or ':', where each part between ':' is the argument
499 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar14b69452013-06-29 23:05:20 +0200501Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000502 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000504
505The second form (this is compatible with some versions of Vi):
506
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200509[text] any text or empty
510{white} at least one blank character (<Space> or <Tab>)
511{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
512[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200513se[t] the string "set " or "se " (note the space); When
514 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515{options} a list of options, separated with white space, which
516 is the argument for a ":set" command
517: a colon
518[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000519
Bram Moolenaar14b69452013-06-29 23:05:20 +0200520Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000521 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
525chance that a normal word like "lex:" is caught. There is one exception:
526"vi:" and "vim:" can also be at the start of the line (for compatibility with
527version 3.0). Using "ex:" at the start of the line will be ignored (this
528could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529
530 *modeline-local*
531The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000532buffer and window that contain the file. Although it's possible to set global
533options from a modeline, this is unusual. If you have two windows open and
534the files in it set the same global option to a different value, the result
535depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000537When editing a file that was already loaded, only the window-local options
538from the modeline are used. Thus if you manually changed a buffer-local
539option after opening the file, it won't be changed if you edit the same buffer
540in another window. But window-local options will be set.
541
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 *modeline-version*
543If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200544number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545 vim{vers}: version {vers} or later
546 vim<{vers}: version before {vers}
547 vim={vers}: version {vers}
548 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100549{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
550For example, to use a modeline only for Vim 7.0:
551 /* vim700: set foldmethod=marker */ ~
552To use a modeline for Vim after version 7.2:
553 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554There can be no blanks between "vim" and the ":".
555
556
557The number of lines that are checked can be set with the 'modelines' option.
558If 'modeline' is off or 'modelines' is 0 no lines are checked.
559
560Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000561like:
562 /* vi:ts=4: */ ~
563will give an error message for the trailing "*/". This line is OK:
564 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000565
566If an error is detected the rest of the line is skipped.
567
568If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569backslash in front of the ':' will be removed. Example:
570 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000571This sets the 'dir' option to "c:\tmp". Only a single backslash before the
572':' is removed. Thus to include "\:" you have to specify "\\:".
573
574No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000575might create a Trojan horse text file with modelines). And not all options
576can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000577|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000578causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
579are wrapped unexpectedly. So disable modelines before editing untrusted text.
580The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581
582Hint: If you would like to do something else than setting an option, you could
583define an autocommand that checks the file for a specific string. For
584example: >
585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
586And define a function SetVar() that does something with the line containing
587"VAR".
588
589==============================================================================
5903. Options summary *option-summary*
591
592In the list below all the options are mentioned with their full name and with
593an abbreviation if there is one. Both forms may be used.
594
595In this document when a boolean option is "set" that means that ":set option"
596is entered. When an option is "reset", ":set nooption" is used.
597
598For some options there are two default values: The "Vim default", which is
599used when 'compatible' is not set, and the "Vi default", which is used when
600'compatible' is set.
601
602Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000603are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000604different value in each window. For example the 'list' option can be set in
605one window and reset in another for the same text, giving both types of view
606at the same time. There are a few options that are specific to a certain
607file. These can have a different value for each file or buffer. For example
608the 'textwidth' option can be 78 for a normal text file and 0 for a C
609program.
610
611 global one option for all buffers and windows
612 local to window each window has its own copy of this option
613 local to buffer each buffer has its own copy of this option
614
615When creating a new window the option values from the currently active window
616are used as a default value for the window-specific options. For the
617buffer-specific options this depends on the 's' and 'S' flags in the
618'cpoptions' option. If 's' is included (which is the default) the values for
619buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000620first entered. If 'S' is present the options are copied each time the buffer
621is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622present, the options are copied from the currently active buffer when the
623buffer is created.
624
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000625Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000627Not all options are supported in all versions. This depends on the supported
628features and sometimes on the system. A remark about this is in curly braces
629below. When an option is not supported it may still be set without getting an
630error, this is called a hidden option. You can't get the value of a hidden
631option though, it is not stored.
632
633To test if option "foo" can be used with ":set" use something like this: >
634 if exists('&foo')
635This also returns true for a hidden option. To test if option "foo" is really
636supported use something like this: >
637 if exists('+foo')
638<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 *E355*
640A jump table for the options with a short description can be found at |Q_op|.
641
642 *'aleph'* *'al'* *aleph* *Aleph*
643'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 The ASCII code for the first letter of the Hebrew alphabet. The
649 routine that maps the keyboard in Hebrew mode, both in Insert mode
650 (when hkmap is set) and on the command-line (when hitting CTRL-_)
651 outputs the Hebrew characters in the range [aleph..aleph+26].
652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
653 See |rileft.txt|.
654
655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
656'allowrevins' 'ari' boolean (default off)
657 global
658 {not in Vi}
659 {only available when compiled with the |+rightleft|
660 feature}
661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
663 into reverse Insert mode, and don't know how to get out. See
664 'revins'.
665 NOTE: This option is reset when 'compatible' is set.
666
667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
668'altkeymap' 'akm' boolean (default off)
669 global
670 {not in Vi}
671 {only available when compiled with the |+farsi|
672 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 the keyboard map between Farsi and English, when 'allowrevins' set.
675
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 is useful to start the Vim in native mode i.e. English (left-to-right
678 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000679 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680
681 *'ambiwidth'* *'ambw'*
682'ambiwidth' 'ambw' string (default: "single")
683 global
684 {not in Vi}
685 {only available when compiled with the |+multi_byte|
686 feature}
687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaarbf884932013-04-05 22:26:15 +0200717 escape sequence to request cursor position report.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100718
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
720'antialias' 'anti' boolean (default: off)
721 global
722 {not in Vi}
723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
730
731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
732'autochdir' 'acd' boolean (default off)
733 global
734 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
746 {not in Vi}
747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
769 {not in Vi}
770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
799 The 'autoindent' option is reset when the 'paste' option is set.
800 {small difference from Vi: After the indent is deleted when typing
801 <Esc> or <CR>, the cursor position when moving up or down is after the
802 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
803
804 *'autoread'* *'ar'* *'noautoread'* *'noar'*
805'autoread' 'ar' boolean (default off)
806 global or local to buffer |global-local|
807 {not in Vi}
808 When a file has been detected to have been changed outside of Vim and
809 it has not been changed inside of Vim, automatically read it again.
810 When the file has been deleted this is not done. |timestamp|
811 If this option has a local value, use this command to switch back to
812 using the global value: >
813 :set autoread<
814<
815 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
816'autowrite' 'aw' boolean (default off)
817 global
818 Write the contents of the file, if it has been modified, on each
819 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000820 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
822 Note that for some commands the 'autowrite' option is not used, see
823 'autowriteall' for that.
824
825 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
826'autowriteall' 'awa' boolean (default off)
827 global
828 {not in Vi}
829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
837 {not in Vi}
838 When set to "dark", Vim will try to use colors that look good on a
839 dark background. When set to "light", Vim will try to use colors that
840 look good on a light background. Any other value is illegal.
841 Vim tries to set the default value according to the terminal used.
842 This will not always be correct.
843 Setting this option does not change the background color, it tells Vim
844 what the background color looks like. For changing the background
845 color, see |:hi-normal|.
846
847 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000848 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000849 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100850 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 setting 'background' will cause the color scheme to be reloaded. If
852 the color scheme adjusts to the value of 'background' this will work.
853 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100854 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856 When setting 'background' to the default value with: >
857 :set background&
858< Vim will guess the value. In the GUI this should work correctly,
859 in other cases Vim might not be able to guess the right value.
860
861 When starting the GUI, the default value for 'background' will be
862 "light". When the value is not set in the .gvimrc, and Vim detects
863 that the background is actually quite dark, 'background' is set to
864 "dark". But this happens only AFTER the .gvimrc file has been read
865 (because the window needs to be opened to find the actual background
866 color). To get around this, force the GUI window to be opened by
867 putting a ":gui" command in the .gvimrc file, before where the value
868 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200869
870 For MS-DOS, Windows and OS/2 the default is "dark".
871 For other systems "dark" is used when 'term' is "linux",
872 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
873 background. Otherwise the default is "light".
874
Bram Moolenaar071d4272004-06-13 20:20:40 +0000875 Normally this option would be set in the .vimrc file. Possibly
876 depending on the terminal name. Example: >
877 :if &term == "pcterm"
878 : set background=dark
879 :endif
880< When this option is set, the default settings for the highlight groups
881 will change. To use other settings, place ":highlight" commands AFTER
882 the setting of the 'background' option.
883 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
884 to select the colors for syntax highlighting. After changing this
885 option, you must load syntax.vim again to see the result. This can be
886 done with ":syntax on".
887
888 *'backspace'* *'bs'*
889'backspace' 'bs' string (default "")
890 global
891 {not in Vi}
892 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
893 mode. This is a list of items, separated by commas. Each item allows
894 a way to backspace over something:
895 value effect ~
896 indent allow backspacing over autoindent
897 eol allow backspacing over line breaks (join lines)
898 start allow backspacing over the start of insert; CTRL-W and CTRL-U
899 stop once at the start of insert.
900
901 When the value is empty, Vi compatible backspacing is used.
902
903 For backwards compatibility with version 5.4 and earlier:
904 value effect ~
905 0 same as ":set backspace=" (Vi compatible)
906 1 same as ":set backspace=indent,eol"
907 2 same as ":set backspace=indent,eol,start"
908
909 See |:fixdel| if your <BS> or <Del> key does not do what you want.
910 NOTE: This option is set to "" when 'compatible' is set.
911
912 *'backup'* *'bk'* *'nobackup'* *'nobk'*
913'backup' 'bk' boolean (default off)
914 global
915 {not in Vi}
916 Make a backup before overwriting a file. Leave it around after the
917 file has been successfully written. If you do not want to keep the
918 backup file, but you do want a backup while the file is being
919 written, reset this option and set the 'writebackup' option (this is
920 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000921 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922 |backup-table| for more explanations.
923 When the 'backupskip' pattern matches, a backup is not made anyway.
924 When 'patchmode' is set, the backup may be renamed to become the
925 oldest version of a file.
926 NOTE: This option is reset when 'compatible' is set.
927
928 *'backupcopy'* *'bkc'*
929'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200930 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 {not in Vi}
932 When writing a file and a backup is made, this option tells how it's
933 done. This is a comma separated list of words.
934
935 The main values are:
936 "yes" make a copy of the file and overwrite the original one
937 "no" rename the file and write a new one
938 "auto" one of the previous, what works best
939
940 Extra values that can be combined with the ones above are:
941 "breaksymlink" always break symlinks when writing
942 "breakhardlink" always break hardlinks when writing
943
944 Making a copy and overwriting the original file:
945 - Takes extra time to copy the file.
946 + When the file has special attributes, is a (hard/symbolic) link or
947 has a resource fork, all this is preserved.
948 - When the file is a link the backup will have the name of the link,
949 not of the real file.
950
951 Renaming the file and writing a new one:
952 + It's fast.
953 - Sometimes not all attributes of the file can be copied to the new
954 file.
955 - When the file is a link the new file will not be a link.
956
957 The "auto" value is the middle way: When Vim sees that renaming file
958 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000959 the file is not a link) that is used. When problems are expected, a
960 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000961
962 The "breaksymlink" and "breakhardlink" values can be used in
963 combination with any of "yes", "no" and "auto". When included, they
964 force Vim to always break either symbolic or hard links by doing
965 exactly what the "no" option does, renaming the original file to
966 become the backup and writing a new file in its place. This can be
967 useful for example in source trees where all the files are symbolic or
968 hard links and any changes should stay in the local source tree, not
969 be propagated back to the original source.
970 *crontab*
971 One situation where "no" and "auto" will cause problems: A program
972 that opens a file, invokes Vim to edit that file, and then tests if
973 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000974 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 example.
976
977 When a copy is made, the original file is truncated and then filled
978 with the new text. This means that protection bits, owner and
979 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000980 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 group of the backup is set to the group of the original file. If this
982 fails, the protection bits for the group are made the same as for
983 others.
984
985 When the file is renamed this is the other way around: The backup has
986 the same attributes of the original file, and the newly written file
987 is owned by the current user. When the file was a (hard/symbolic)
988 link, the new file will not! That's why the "auto" value doesn't
989 rename when the file is a link. The owner and group of the newly
990 written file will be set to the same ones as the original file, but
991 the system may refuse to do this. In that case the "auto" value will
992 again not rename the file.
993
994 *'backupdir'* *'bdir'*
995'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +0100996 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000997 for Unix: ".,~/tmp,~/")
998 global
999 {not in Vi}
1000 List of directories for the backup file, separated with commas.
1001 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001002 where this is possible. The directory must exist, Vim will not
1003 create it for you.
Bram Moolenaar34700a62013-03-07 13:20:54 +01001004 - Empty means that no backup file will be created ( 'patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 impossible!). Writing may fail because of this.
1006 - A directory "." means to put the backup file in the same directory
1007 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001008 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 put the backup file relative to where the edited file is. The
1010 leading "." is replaced with the path name of the edited file.
1011 ("." inside a directory name has no special meaning).
1012 - Spaces after the comma are ignored, other spaces are considered part
1013 of the directory name. To have a space at the start of a directory
1014 name, precede it with a backslash.
1015 - To include a comma in a directory name precede it with a backslash.
1016 - A directory name may end in an '/'.
1017 - Environment variables are expanded |:set_env|.
1018 - Careful with '\' characters, type one before a space, type two to
1019 get one in the option (see |option-backslash|), for example: >
1020 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1021< - For backwards compatibility with Vim version 3.0 a '>' at the start
1022 of the option is removed.
1023 See also 'backup' and 'writebackup' options.
1024 If you want to hide your backup files on Unix, consider this value: >
1025 :set backupdir=./.backup,~/.backup,.,/tmp
1026< You must create a ".backup" directory in each directory and in your
1027 home directory for this to work properly.
1028 The use of |:set+=| and |:set-=| is preferred when adding or removing
1029 directories from the list. This avoids problems when a future version
1030 uses another default.
1031 This option cannot be set from a |modeline| or in the |sandbox|, for
1032 security reasons.
1033
1034 *'backupext'* *'bex'* *E589*
1035'backupext' 'bex' string (default "~", for VMS: "_")
1036 global
1037 {not in Vi}
1038 String which is appended to a file name to make the name of the
1039 backup file. The default is quite unusual, because this avoids
1040 accidentally overwriting existing files with a backup file. You might
1041 prefer using ".bak", but make sure that you don't have files with
1042 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001043 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001044
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001045 If you like to keep a lot of backups, you could use a BufWritePre
1046 autocommand to change 'backupext' just before writing the file to
1047 include a timestamp. >
1048 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1049< Use 'backupdir' to put the backup in a different directory.
1050
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 *'backupskip'* *'bsk'*
1052'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1053 global
1054 {not in Vi}
1055 {not available when compiled without the |+wildignore|
1056 feature}
1057 A list of file patterns. When one of the patterns matches with the
1058 name of the file which is written, no backup file is created. Both
1059 the specified file name and the full path name of the file are used.
1060 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1061 Watch out for special characters, see |option-backslash|.
1062 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001063 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001064
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001065 WARNING: Not having a backup file means that when Vim fails to write
1066 your buffer correctly and then, for whatever reason, Vim exits, you
1067 lose both the original file and what you were writing. Only disable
1068 backups if you don't care about losing the file.
1069
Bram Moolenaar02467872007-05-06 13:22:01 +00001070 Note that environment variables are not expanded. If you want to use
1071 $HOME you must expand it explicitly, e.g.: >
1072 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1073
1074< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001075 backup would be made by renaming the original file crontab won't see
1076 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077
1078 *'balloondelay'* *'bdlay'*
1079'balloondelay' 'bdlay' number (default: 600)
1080 global
1081 {not in Vi}
1082 {only available when compiled with the |+balloon_eval|
1083 feature}
1084 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1085
1086 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1087'ballooneval' 'beval' boolean (default off)
1088 global
1089 {not in Vi}
1090 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001091 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092 Switch on the |balloon-eval| functionality.
1093
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001094 *'balloonexpr'* *'bexpr'*
1095'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001096 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001097 {not in Vi}
1098 {only available when compiled with the |+balloon_eval|
1099 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001100 Expression for text to show in evaluation balloon. It is only used
1101 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001102
1103 v:beval_bufnr number of the buffer in which balloon is going to show
1104 v:beval_winnr number of the window
1105 v:beval_lnum line number
1106 v:beval_col column number (byte index)
1107 v:beval_text word under or after the mouse pointer
1108
1109 The evaluation of the expression must not have side effects!
1110 Example: >
1111 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001112 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001113 \', column ' . v:beval_col .
1114 \ ' of file ' . bufname(v:beval_bufnr) .
1115 \ ' on word "' . v:beval_text . '"'
1116 endfunction
1117 set bexpr=MyBalloonExpr()
1118 set ballooneval
1119<
1120 NOTE: The balloon is displayed only if the cursor is on a text
1121 character. If the result of evaluating 'balloonexpr' is not empty,
1122 Vim does not try to send a message to an external debugger (Netbeans
1123 or Sun Workshop).
1124
Bram Moolenaar30b65812012-07-12 22:01:11 +02001125 The expression will be evaluated in the |sandbox| when set from a
1126 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001127
1128 It is not allowed to change text or jump to another window while
1129 evaluating 'balloonexpr' |textlock|.
1130
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001131 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001132 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001133< When they are supported "\n" characters will start a new line. If the
1134 expression evaluates to a |List| this is equal to using each List item
1135 as a string and putting "\n" in between them.
1136
Bram Moolenaar165bc692015-07-21 17:53:25 +02001137 *'belloff'* *'bo'*
1138'belloff' 'bo' string (default "")
1139 global
1140 {not in Vi}
1141 Specifies for which events the bell will not be rung. It is a comma
1142 separated list of items. For each item that is present, the bell
1143 will be silenced. This is most useful to specify specific events in
1144 insert mode to be silenced.
1145
1146 item meaning when present ~
1147 all All events.
1148 backspace When hitting <BS> or <Del> and deleting results in an
1149 error.
1150 cursor Fail to move around using the cursor keys or
1151 <PageUp>/<PageDown> in |Insert-mode|.
1152 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1153 |i_CTRL-X_CTRL-T|.
1154 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1155 |i_CTRL-E|.
1156 ctrlg Unknown Char after <C-G> in Insert mode.
1157 error Other Error occurred (e.g. try to join last line)
1158 (mostly used in |Normal-mode| or |Cmdline-mode|).
1159 esc hitting <Esc> in |Normal-mode|.
1160 ex In |Visual-mode|, hitting |Q| results in an error.
1161 hangul Error occurred when using hangul input.
1162 insertmode Pressing <Esc> in 'insertmode'.
1163 lang Calling the beep module for Lua/Mzscheme/TCL.
1164 mess No output available for |g<|.
1165 showmatch Error occurred for 'showmatch' function.
1166 operator Empty region error |cpo-E|.
1167 register Unknown register after <C-R> in |Insert-mode|.
1168 shell Bell from shell output |:!|.
1169 spell Error happened on spell suggest.
1170 wildmode More matches in |cmdline-completion| available
1171 (depends on the 'wildmode' setting).
1172
1173 This is most useful, to fine tune when in insert mode the bell should
1174 be rung. For normal mode and ex commands, the bell is often rung to
1175 indicate that an error occurred. It can be silenced by adding the
1176 "error" keyword.
1177
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1179'binary' 'bin' boolean (default off)
1180 local to buffer
1181 {not in Vi}
1182 This option should be set before editing a binary file. You can also
1183 use the |-b| Vim argument. When this option is switched on a few
1184 options will be changed (also when it already was on):
1185 'textwidth' will be set to 0
1186 'wrapmargin' will be set to 0
1187 'modeline' will be off
1188 'expandtab' will be off
1189 Also, 'fileformat' and 'fileformats' options will not be used, the
1190 file is read and written like 'fileformat' was "unix" (a single <NL>
1191 separates lines).
1192 The 'fileencoding' and 'fileencodings' options will not be used, the
1193 file is read without conversion.
1194 NOTE: When you start editing a(nother) file while the 'bin' option is
1195 on, settings from autocommands may change the settings again (e.g.,
1196 'textwidth'), causing trouble when editing. You might want to set
1197 'bin' again when the file has been loaded.
1198 The previous values of these options are remembered and restored when
1199 'bin' is switched from on to off. Each buffer has its own set of
1200 saved option values.
1201 To edit a file with 'binary' set you can use the |++bin| argument.
1202 This avoids you have to do ":set bin", which would have effect for all
1203 files you edit.
1204 When writing a file the <EOL> for the last line is only written if
1205 there was one in the original file (normally Vim appends an <EOL> to
1206 the last line if there is none; this would make the file longer). See
1207 the 'endofline' option.
1208
1209 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1210'bioskey' 'biosk' boolean (default on)
1211 global
1212 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001213 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 better to detect CTRL-C, but only works for the console. When using a
1215 terminal over a serial port reset this option.
1216 Also see |'conskey'|.
1217
1218 *'bomb'* *'nobomb'*
1219'bomb' boolean (default off)
1220 local to buffer
1221 {not in Vi}
1222 {only available when compiled with the |+multi_byte|
1223 feature}
1224 When writing a file and the following conditions are met, a BOM (Byte
1225 Order Mark) is prepended to the file:
1226 - this option is on
1227 - the 'binary' option is off
1228 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1229 endian variants.
1230 Some applications use the BOM to recognize the encoding of the file.
1231 Often used for UCS-2 files on MS-Windows. For other applications it
1232 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001233 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1235 check for the presence of the BOM is done and 'bomb' set accordingly.
1236 Unless 'binary' is set, it is removed from the first line, so that you
1237 don't see it when editing. When you don't change the options, the BOM
1238 will be restored when writing the file.
1239
1240 *'breakat'* *'brk'*
1241'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1242 global
1243 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001244 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 feature}
1246 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001247 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1248 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001250 *'breakindent'* *'bri'*
1251'breakindent' 'bri' boolean (default off)
1252 local to window
1253 {not in Vi}
1254 {not available when compiled without the |+linebreak|
1255 feature}
1256 Every wrapped line will continue visually indented (same amount of
1257 space as the beginning of that line), thus preserving horizontal blocks
1258 of text.
1259
1260 *'breakindentopt'* *'briopt'*
1261'breakindentopt' 'briopt' string (default empty)
1262 local to window
1263 {not in Vi}
1264 {not available when compiled without the |+linebreak|
1265 feature}
1266 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001267 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001268 min:{n} Minimum text width that will be kept after
1269 applying 'breakindent', even if the resulting
1270 text should normally be narrower. This prevents
1271 text indented almost to the right window border
1272 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001273 shift:{n} After applying 'breakindent', the wrapped line's
1274 beginning will be shifted by the given number of
1275 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001276 indentation (negative) or emphasizing the line
1277 continuation (positive).
1278 sbr Display the 'showbreak' value before applying the
1279 additional indent.
1280 The default value for min is 20 and shift is 0.
1281
Bram Moolenaar071d4272004-06-13 20:20:40 +00001282 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001283'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001285 {not in Vi} {only for Motif, Athena, GTK, Mac and
1286 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001288 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001289 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 buffer Use the directory of the related buffer.
1291 current Use the current directory.
1292 {path} Use the specified directory
1293
1294 *'bufhidden'* *'bh'*
1295'bufhidden' 'bh' string (default: "")
1296 local to buffer
1297 {not in Vi}
1298 {not available when compiled without the |+quickfix|
1299 feature}
1300 This option specifies what happens when a buffer is no longer
1301 displayed in a window:
1302 <empty> follow the global 'hidden' option
1303 hide hide the buffer (don't unload it), also when 'hidden'
1304 is not set
1305 unload unload the buffer, also when 'hidden' is set or using
1306 |:hide|
1307 delete delete the buffer from the buffer list, also when
1308 'hidden' is set or using |:hide|, like using
1309 |:bdelete|
1310 wipe wipe out the buffer from the buffer list, also when
1311 'hidden' is set or using |:hide|, like using
1312 |:bwipeout|
1313
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001314 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001315 are lost without a warning. Also, these values may break autocommands
1316 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 This option is used together with 'buftype' and 'swapfile' to specify
1318 special kinds of buffers. See |special-buffers|.
1319
1320 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1321'buflisted' 'bl' boolean (default: on)
1322 local to buffer
1323 {not in Vi}
1324 When this option is set, the buffer shows up in the buffer list. If
1325 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1326 This option is reset by Vim for buffers that are only used to remember
1327 a file name or marks. Vim sets it when starting to edit a buffer.
1328 But not when moving to a buffer with ":buffer".
1329
1330 *'buftype'* *'bt'* *E382*
1331'buftype' 'bt' string (default: "")
1332 local to buffer
1333 {not in Vi}
1334 {not available when compiled without the |+quickfix|
1335 feature}
1336 The value of this option specifies the type of a buffer:
1337 <empty> normal buffer
1338 nofile buffer which is not related to a file and will not be
1339 written
1340 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001341 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001342 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001343 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001345 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 help help buffer (you are not supposed to set this
1347 manually)
1348
1349 This option is used together with 'bufhidden' and 'swapfile' to
1350 specify special kinds of buffers. See |special-buffers|.
1351
1352 Be careful with changing this option, it can have many side effects!
1353
Bram Moolenaar280f1262006-01-30 00:14:18 +00001354 A "quickfix" buffer is only used for the error list and the location
1355 list. This value is set by the |:cwindow| and |:lwindow| commands and
1356 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
1358 "nofile" and "nowrite" buffers are similar:
1359 both: The buffer is not to be written to disk, ":w" doesn't
1360 work (":w filename" does work though).
1361 both: The buffer is never considered to be |'modified'|.
1362 There is no warning when the changes will be lost, for
1363 example when you quit Vim.
1364 both: A swap file is only created when using too much memory
1365 (when 'swapfile' has been reset there is never a swap
1366 file).
1367 nofile only: The buffer name is fixed, it is not handled like a
1368 file name. It is not modified in response to a |:cd|
1369 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001370 both: When using ":e bufname" and already editing "bufname"
1371 the buffer is made empty and autocommands are
1372 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001373 *E676*
1374 "acwrite" implies that the buffer name is not related to a file, like
1375 "nofile", but it will be written. Thus, in contrast to "nofile" and
1376 "nowrite", ":w" does work and a modified buffer can't be abandoned
1377 without saving. For writing there must be matching |BufWriteCmd|,
1378 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379
1380 *'casemap'* *'cmp'*
1381'casemap' 'cmp' string (default: "internal,keepascii")
1382 global
1383 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001384 {only available when compiled with the |+multi_byte|
1385 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001386 Specifies details about changing the case of letters. It may contain
1387 these words, separated by a comma:
1388 internal Use internal case mapping functions, the current
1389 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001390 matters when 'encoding' is a Unicode encoding,
1391 "latin1" or "iso-8859-15". When "internal" is
1392 omitted, the towupper() and towlower() system library
1393 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001394 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1395 case mapping, the current locale is not effective.
1396 This probably only matters for Turkish.
1397
1398 *'cdpath'* *'cd'* *E344* *E346*
1399'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1400 global
1401 {not in Vi}
1402 {not available when compiled without the
1403 |+file_in_path| feature}
1404 This is a list of directories which will be searched when using the
1405 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001406 for has a relative path, not an absolute part starting with "/", "./"
1407 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 The 'cdpath' option's value has the same form and semantics as
1409 |'path'|. Also see |file-searching|.
1410 The default value is taken from $CDPATH, with a "," prepended to look
1411 in the current directory first.
1412 If the default value taken from $CDPATH is not what you want, include
1413 a modified version of the following command in your vimrc file to
1414 override it: >
1415 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1416< This option cannot be set from a |modeline| or in the |sandbox|, for
1417 security reasons.
1418 (parts of 'cdpath' can be passed to the shell to expand file names).
1419
1420 *'cedit'*
1421'cedit' string (Vi default: "", Vim default: CTRL-F)
1422 global
1423 {not in Vi}
1424 {not available when compiled without the |+vertsplit|
1425 feature}
1426 The key used in Command-line Mode to open the command-line window.
1427 The default is CTRL-F when 'compatible' is off.
1428 Only non-printable keys are allowed.
1429 The key can be specified as a single character, but it is difficult to
1430 type. The preferred way is to use the <> notation. Examples: >
1431 :set cedit=<C-Y>
1432 :set cedit=<Esc>
1433< |Nvi| also has this option, but it only uses the first character.
1434 See |cmdwin|.
1435
1436 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1437'charconvert' 'ccv' string (default "")
1438 global
1439 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001440 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 {not in Vi}
1442 An expression that is used for character encoding conversion. It is
1443 evaluated when a file that is to be read or has been written has a
1444 different encoding from what is desired.
1445 'charconvert' is not used when the internal iconv() function is
1446 supported and is able to do the conversion. Using iconv() is
1447 preferred, because it is much faster.
1448 'charconvert' is not used when reading stdin |--|, because there is no
1449 file to convert from. You will have to save the text in a file first.
1450 The expression must return zero or an empty string for success,
1451 non-zero for failure.
1452 The possible encoding names encountered are in 'encoding'.
1453 Additionally, names given in 'fileencodings' and 'fileencoding' are
1454 used.
1455 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1456 is done internally by Vim, 'charconvert' is not used for this.
1457 'charconvert' is also used to convert the viminfo file, if the 'c'
1458 flag is present in 'viminfo'. Also used for Unicode conversion.
1459 Example: >
1460 set charconvert=CharConvert()
1461 fun CharConvert()
1462 system("recode "
1463 \ . v:charconvert_from . ".." . v:charconvert_to
1464 \ . " <" . v:fname_in . " >" v:fname_out)
1465 return v:shell_error
1466 endfun
1467< The related Vim variables are:
1468 v:charconvert_from name of the current encoding
1469 v:charconvert_to name of the desired encoding
1470 v:fname_in name of the input file
1471 v:fname_out name of the output file
1472 Note that v:fname_in and v:fname_out will never be the same.
1473 Note that v:charconvert_from and v:charconvert_to may be different
1474 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1475 Encryption is not done by Vim when using 'charconvert'. If you want
1476 to encrypt the file after conversion, 'charconvert' should take care
1477 of this.
1478 This option cannot be set from a |modeline| or in the |sandbox|, for
1479 security reasons.
1480
1481 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1482'cindent' 'cin' boolean (default off)
1483 local to buffer
1484 {not in Vi}
1485 {not available when compiled without the |+cindent|
1486 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001487 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001488 that trigger reindenting in insert mode and 'cinoptions' to set your
1489 preferred indent style.
1490 If 'indentexpr' is not empty, it overrules 'cindent'.
1491 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1492 the "=" operator indents using this algorithm rather than calling an
1493 external program.
1494 See |C-indenting|.
1495 When you don't like the way 'cindent' works, try the 'smartindent'
1496 option or 'indentexpr'.
1497 This option is not used when 'paste' is set.
1498 NOTE: This option is reset when 'compatible' is set.
1499
1500 *'cinkeys'* *'cink'*
1501'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1502 local to buffer
1503 {not in Vi}
1504 {not available when compiled without the |+cindent|
1505 feature}
1506 A list of keys that, when typed in Insert mode, cause reindenting of
1507 the current line. Only used if 'cindent' is on and 'indentexpr' is
1508 empty.
1509 For the format of this option see |cinkeys-format|.
1510 See |C-indenting|.
1511
1512 *'cinoptions'* *'cino'*
1513'cinoptions' 'cino' string (default "")
1514 local to buffer
1515 {not in Vi}
1516 {not available when compiled without the |+cindent|
1517 feature}
1518 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1519 program. See |cinoptions-values| for the values of this option, and
1520 |C-indenting| for info on C indenting in general.
1521
1522
1523 *'cinwords'* *'cinw'*
1524'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without both the
1528 |+cindent| and the |+smartindent| features}
1529 These keywords start an extra indent in the next line when
1530 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1531 an appropriate place (inside {}).
1532 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1533 matter, include the keyword both the uppercase and lowercase:
1534 "if,If,IF".
1535
1536 *'clipboard'* *'cb'*
1537'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1538 for X-windows, "" otherwise)
1539 global
1540 {not in Vi}
1541 {only in GUI versions or when the |+xterm_clipboard|
1542 feature is included}
1543 This option is a list of comma separated names.
1544 These names are recognized:
1545
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001546 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 unnamed When included, Vim will use the clipboard register '*'
1548 for all yank, delete, change and put operations which
1549 would normally go to the unnamed register. When a
1550 register is explicitly specified, it will always be
1551 used regardless of whether "unnamed" is in 'clipboard'
1552 or not. The clipboard register can always be
1553 explicitly accessed using the "* notation. Also see
1554 |gui-clipboard|.
1555
Bram Moolenaar30b65812012-07-12 22:01:11 +02001556 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001557 unnamedplus A variant of the "unnamed" flag which uses the
1558 clipboard register '+' (|quoteplus|) instead of
1559 register '*' for all yank, delete, change and put
1560 operations which would normally go to the unnamed
1561 register. When "unnamed" is also included to the
1562 option, yank operations (but not delete, change or
1563 put) will additionally copy the text into register
1564 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001565 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001566 Availability can be checked with: >
1567 if has('unnamedplus')
1568<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001569 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 autoselect Works like the 'a' flag in 'guioptions': If present,
1571 then whenever Visual mode is started, or the Visual
1572 area extended, Vim tries to become the owner of the
1573 windowing system's global selection or put the
1574 selected text on the clipboard used by the selection
1575 register "*. See |guioptions_a| and |quotestar| for
1576 details. When the GUI is active, the 'a' flag in
1577 'guioptions' is used, when the GUI is not active, this
1578 "autoselect" flag is used.
1579 Also applies to the modeless selection.
1580
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001581 *clipboard-autoselectplus*
1582 autoselectplus Like "autoselect" but using the + register instead of
1583 the * register. Compare to the 'P' flag in
1584 'guioptions'.
1585
1586 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 autoselectml Like "autoselect", but for the modeless selection
1588 only. Compare to the 'A' flag in 'guioptions'.
1589
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001590 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001591 html When the clipboard contains HTML, use this when
1592 pasting. When putting text on the clipboard, mark it
1593 as HTML. This works to copy rendered HTML from
1594 Firefox, paste it as raw HTML in Vim, select the HTML
1595 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001596 You probably want to add this only temporarily,
1597 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001598 Only supported for GTK version 2 and later.
1599 Only available with the |+multi_byte| feature.
1600
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001601 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 exclude:{pattern}
1603 Defines a pattern that is matched against the name of
1604 the terminal 'term'. If there is a match, no
1605 connection will be made to the X server. This is
1606 useful in this situation:
1607 - Running Vim in a console.
1608 - $DISPLAY is set to start applications on another
1609 display.
1610 - You do not want to connect to the X server in the
1611 console, but do want this in a terminal emulator.
1612 To never connect to the X server use: >
1613 exclude:.*
1614< This has the same effect as using the |-X| argument.
1615 Note that when there is no connection to the X server
1616 the window title won't be restored and the clipboard
1617 cannot be accessed.
1618 The value of 'magic' is ignored, {pattern} is
1619 interpreted as if 'magic' was on.
1620 The rest of the option value will be used for
1621 {pattern}, this must be the last entry.
1622
1623 *'cmdheight'* *'ch'*
1624'cmdheight' 'ch' number (default 1)
1625 global
1626 {not in Vi}
1627 Number of screen lines to use for the command-line. Helps avoiding
1628 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001629 The value of this option is stored with the tab page, so that each tab
1630 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631
1632 *'cmdwinheight'* *'cwh'*
1633'cmdwinheight' 'cwh' number (default 7)
1634 global
1635 {not in Vi}
1636 {not available when compiled without the |+vertsplit|
1637 feature}
1638 Number of screen lines to use for the command-line window. |cmdwin|
1639
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001640 *'colorcolumn'* *'cc'*
1641'colorcolumn' 'cc' string (default "")
1642 local to window
1643 {not in Vi}
1644 {not available when compiled without the |+syntax|
1645 feature}
1646 'colorcolumn' is a comma separated list of screen columns that are
1647 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1648 text. Will make screen redrawing slower.
1649 The screen column can be an absolute number, or a number preceded with
1650 '+' or '-', which is added to or subtracted from 'textwidth'. >
1651
1652 :set cc=+1 " highlight column after 'textwidth'
1653 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1654 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1655<
1656 When 'textwidth' is zero then the items with '-' and '+' are not used.
1657 A maximum of 256 columns are highlighted.
1658
Bram Moolenaar071d4272004-06-13 20:20:40 +00001659 *'columns'* *'co'* *E594*
1660'columns' 'co' number (default 80 or terminal width)
1661 global
1662 {not in Vi}
1663 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001664 initialization and does not have to be set by hand. Also see
1665 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666 When Vim is running in the GUI or in a resizable window, setting this
1667 option will cause the window size to be changed. When you only want
1668 to use the size for the GUI, put the command in your |gvimrc| file.
1669 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001670 number of columns of the display, the display may be messed up. For
1671 the GUI it is always possible and Vim limits the number of columns to
1672 what fits on the screen. You can use this command to get the widest
1673 window possible: >
1674 :set columns=9999
1675< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676
1677 *'comments'* *'com'* *E524* *E525*
1678'comments' 'com' string (default
1679 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1680 local to buffer
1681 {not in Vi}
1682 {not available when compiled without the |+comments|
1683 feature}
1684 A comma separated list of strings that can start a comment line. See
1685 |format-comments|. See |option-backslash| about using backslashes to
1686 insert a space.
1687
1688 *'commentstring'* *'cms'* *E537*
1689'commentstring' 'cms' string (default "/*%s*/")
1690 local to buffer
1691 {not in Vi}
1692 {not available when compiled without the |+folding|
1693 feature}
1694 A template for a comment. The "%s" in the value is replaced with the
1695 comment text. Currently only used to add markers for folding, see
1696 |fold-marker|.
1697
1698 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001699'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1700 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701 global
1702 {not in Vi}
1703 This option has the effect of making Vim either more Vi-compatible, or
1704 make Vim behave in a more useful way.
1705 This is a special kind of option, because when it's set or reset,
1706 other options are also changed as a side effect. CAREFUL: Setting or
1707 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001708 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 set this option in your vimrc file, you should probably put it at the
1710 very start.
1711 By default this option is on and the Vi defaults are used for the
1712 options. This default was chosen for those people who want to use Vim
1713 just like Vi, and don't even (want to) know about the 'compatible'
1714 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001715 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001716 this option is switched off, and all options that have not been
1717 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001718 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001719 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001720 happen for the system-wide vimrc or gvimrc file, nor for a file given
1721 with the |-u| argument). Also see |compatible-default| and
1722 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 You can also set this option with the "-C" argument, and reset it with
1724 "-N". See |-C| and |-N|.
1725 Switching this option off makes the Vim defaults be used for options
1726 that have a different Vi and Vim default value. See the options
1727 marked with a '+' below. Other options are not modified.
1728 At the moment this option is set, several other options will be set
1729 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001730 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 editing.
1732 See also 'cpoptions'.
1733
1734 option + set value effect ~
1735
1736 'allowrevins' off no CTRL-_ command
1737 'backupcopy' Unix: "yes" backup file is a copy
1738 others: "auto" copy or rename backup file
1739 'backspace' "" normal backspace
1740 'backup' off no backup file
1741 'cindent' off no C code indentation
1742 'cedit' + "" no key to open the |cmdwin|
1743 'cpoptions' + (all flags) Vi-compatible flags
1744 'cscopetag' off don't use cscope for ":tag"
1745 'cscopetagorder' 0 see |cscopetagorder|
1746 'cscopeverbose' off see |cscopeverbose|
1747 'digraph' off no digraphs
1748 'esckeys' + off no <Esc>-keys in Insert mode
1749 'expandtab' off tabs not expanded to spaces
1750 'fileformats' + "" no automatic file format detection,
1751 "dos,unix" except for DOS, Windows and OS/2
1752 'formatoptions' + "vt" Vi compatible formatting
1753 'gdefault' off no default 'g' flag for ":s"
1754 'history' + 0 no commandline history
1755 'hkmap' off no Hebrew keyboard mapping
1756 'hkmapp' off no phonetic Hebrew keyboard mapping
1757 'hlsearch' off no highlighting of search matches
1758 'incsearch' off no incremental searching
1759 'indentexpr' "" no indenting by expression
1760 'insertmode' off do not start in Insert mode
1761 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1762 characters and '_'
1763 'joinspaces' on insert 2 spaces after period
1764 'modeline' + off no modelines
1765 'more' + off no pauses in listings
1766 'revins' off no reverse insert
1767 'ruler' off no ruler
1768 'scrolljump' 1 no jump scroll
1769 'scrolloff' 0 no scroll offset
1770 'shiftround' off indent not rounded to shiftwidth
1771 'shortmess' + "" no shortening of messages
1772 'showcmd' + off command characters not shown
1773 'showmode' + off current mode not shown
1774 'smartcase' off no automatic ignore case switch
1775 'smartindent' off no smart indentation
1776 'smarttab' off no smart tab size
1777 'softtabstop' 0 tabs are always 'tabstop' positions
1778 'startofline' on goto startofline with some commands
1779 'tagrelative' + off tag file names are not relative
1780 'textauto' + off no automatic textmode detection
1781 'textwidth' 0 no automatic line wrap
1782 'tildeop' off tilde is not an operator
1783 'ttimeout' off no terminal timeout
1784 'whichwrap' + "" left-right movements don't wrap
1785 'wildchar' + CTRL-E only when the current value is <Tab>
1786 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001787 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789 *'complete'* *'cpt'* *E535*
1790'complete' 'cpt' string (default: ".,w,b,u,t,i")
1791 local to buffer
1792 {not in Vi}
1793 This option specifies how keyword completion |ins-completion| works
1794 when CTRL-P or CTRL-N are used. It is also used for whole-line
1795 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1796 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar34700a62013-03-07 13:20:54 +01001797 . scan the current buffer ( 'wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 w scan buffers from other windows
1799 b scan other loaded buffers that are in the buffer list
1800 u scan the unloaded buffers that are in the buffer list
1801 U scan the buffers that are not in the buffer list
1802 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001803 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 k{dict} scan the file {dict}. Several "k" flags can be given,
1805 patterns are valid too. For example: >
1806 :set cpt=k/usr/dict/*,k~/spanish
1807< s scan the files given with the 'thesaurus' option
1808 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1809 are valid too.
1810 i scan current and included files
1811 d scan current and included files for defined name or macro
1812 |i_CTRL-X_CTRL-D|
1813 ] tag completion
1814 t same as "]"
1815
1816 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1817 not executed, this may lead to unexpected completions from some files
1818 (gzipped files for example). Unloaded buffers are not scanned for
1819 whole-line completion.
1820
1821 The default is ".,w,b,u,t,i", which means to scan:
1822 1. the current buffer
1823 2. buffers in other windows
1824 3. other loaded buffers
1825 4. unloaded buffers
1826 5. tags
1827 6. included files
1828
1829 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001830 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1831 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001833 *'completefunc'* *'cfu'*
1834'completefunc' 'cfu' string (default: empty)
1835 local to buffer
1836 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001837 {not available when compiled without the |+eval|
1838 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001839 This option specifies a function to be used for Insert mode completion
1840 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001841 See |complete-functions| for an explanation of how the function is
1842 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001843 This option cannot be set from a |modeline| or in the |sandbox|, for
1844 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001845
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001846 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001847'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001848 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001849 {not available when compiled without the
1850 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001851 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001852 A comma separated list of options for Insert mode completion
1853 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001854
1855 menu Use a popup menu to show the possible completions. The
1856 menu is only shown when there is more than one match and
1857 sufficient colors are available. |ins-completion-menu|
1858
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001859 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001860 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001861 match, e.g., what file it comes from.
1862
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001863 longest Only insert the longest common text of the matches. If
1864 the menu is displayed you can use CTRL-L to add more
1865 characters. Whether case is ignored depends on the kind
1866 of completion. For buffer text the 'ignorecase' option is
1867 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001868
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001869 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001870 completion in the preview window. Only works in
1871 combination with "menu" or "menuone".
1872
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001873 noinsert Do not insert any text for a match until the user selects
1874 a match from the menu. Only works in combination with
1875 "menu" or "menuone". No effect if "longest" is present.
1876
1877 noselect Do not select a match in the menu, force the user to
1878 select one from the menu. Only works in combination with
1879 "menu" or "menuone".
1880
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001881
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001882 *'concealcursor'* *'cocu'*
1883'concealcursor' 'cocu' string (default: "")
1884 local to window
1885 {not in Vi}
1886 {not available when compiled without the |+conceal|
1887 feature}
1888 Sets the modes in which text in the cursor line can also be concealed.
1889 When the current mode is listed then concealing happens just like in
1890 other lines.
1891 n Normal mode
1892 v Visual mode
1893 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001894 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001895
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001896 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001897 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001898 are moving around text is concealed, but when starting to insert text
1899 or selecting a Visual area the concealed text is displayed, so that
1900 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001901 Keep in mind that the cursor position is not always where it's
1902 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001903
1904
1905'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001906 number (default 0)
1907 local to window
1908 {not in Vi}
1909 {not available when compiled without the |+conceal|
1910 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001911 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1912 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001913
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001914 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001915 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001916 1 Each block of concealed text is replaced with one
1917 character. If the syntax item does not have a custom
1918 replacement character defined (see |:syn-cchar|) the
1919 character defined in 'listchars' is used (default is a
1920 space).
1921 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001922 2 Concealed text is completely hidden unless it has a
1923 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001924 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001925 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001926
Bram Moolenaara7781e02010-07-19 20:13:22 +02001927 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001928 edit and copy the text. This can be changed with the 'concealcursor'
1929 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001930
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1932'confirm' 'cf' boolean (default off)
1933 global
1934 {not in Vi}
1935 When 'confirm' is on, certain operations that would normally
1936 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1937 instead raise a |dialog| asking if you wish to save the current
1938 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1939 If 'confirm' is off you can still activate confirmation for one
1940 command only (this is most useful in mappings) with the |:confirm|
1941 command.
1942 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1943
1944 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1945'conskey' 'consk' boolean (default off)
1946 global
1947 {not in Vi} {only for MS-DOS}
1948 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001949 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001950 three methods of console input are available:
1951 'conskey' 'bioskey' action ~
1952 on on or off direct console input
1953 off on BIOS
1954 off off STDIN
1955
1956 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1957'copyindent' 'ci' boolean (default off)
1958 local to buffer
1959 {not in Vi}
1960 Copy the structure of the existing lines indent when autoindenting a
1961 new line. Normally the new indent is reconstructed by a series of
1962 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1963 in which case only spaces are used). Enabling this option makes the
1964 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001965 existing line. 'expandtab' has no effect on these characters, a Tab
1966 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 line, the remaining space is filled in the normal manner.
1968 NOTE: 'copyindent' is reset when 'compatible' is set.
1969 Also see 'preserveindent'.
1970
1971 *'cpoptions'* *'cpo'*
1972'cpoptions' 'cpo' string (Vim default: "aABceFs",
1973 Vi default: all flags)
1974 global
1975 {not in Vi}
1976 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02001977 this indicates Vi-compatible behavior. This is used for things where
1978 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 'cpoptions' stands for "compatible-options".
1980 Commas can be added for readability.
1981 To avoid problems with flags that are added in the future, use the
1982 "+=" and "-=" feature of ":set" |add-option-flags|.
1983 NOTE: This option is set to the Vi default value when 'compatible' is
1984 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001985 NOTE: This option is set to the POSIX default value at startup when
1986 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001987 variable exists |posix|. This means Vim tries to behave like the
1988 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989
1990 contains behavior ~
1991 *cpo-a*
1992 a When included, a ":read" command with a file name
1993 argument will set the alternate file name for the
1994 current window.
1995 *cpo-A*
1996 A When included, a ":write" command with a file name
1997 argument will set the alternate file name for the
1998 current window.
1999 *cpo-b*
2000 b "\|" in a ":map" command is recognized as the end of
2001 the map command. The '\' is included in the mapping,
2002 the text after the '|' is interpreted as the next
2003 command. Use a CTRL-V instead of a backslash to
2004 include the '|' in the mapping. Applies to all
2005 mapping, abbreviation, menu and autocmd commands.
2006 See also |map_bar|.
2007 *cpo-B*
2008 B A backslash has no special meaning in mappings,
2009 abbreviations and the "to" part of the menu commands.
2010 Remove this flag to be able to use a backslash like a
2011 CTRL-V. For example, the command ":map X \<Esc>"
2012 results in X being mapped to:
2013 'B' included: "\^[" (^[ is a real <Esc>)
2014 'B' excluded: "<Esc>" (5 characters)
2015 ('<' excluded in both cases)
2016 *cpo-c*
2017 c Searching continues at the end of any match at the
2018 cursor position, but not further than the start of the
2019 next line. When not present searching continues
2020 one character from the cursor position. With 'c'
2021 "abababababab" only gets three matches when repeating
2022 "/abab", without 'c' there are five matches.
2023 *cpo-C*
2024 C Do not concatenate sourced lines that start with a
2025 backslash. See |line-continuation|.
2026 *cpo-d*
2027 d Using "./" in the 'tags' option doesn't mean to use
2028 the tags file relative to the current file, but the
2029 tags file in the current directory.
2030 *cpo-D*
2031 D Can't use CTRL-K to enter a digraph after Normal mode
2032 commands with a character argument, like |r|, |f| and
2033 |t|.
2034 *cpo-e*
2035 e When executing a register with ":@r", always add a
2036 <CR> to the last line, also when the register is not
2037 linewise. If this flag is not present, the register
2038 is not linewise and the last line does not end in a
2039 <CR>, then the last line is put on the command-line
2040 and can be edited before hitting <CR>.
2041 *cpo-E*
2042 E It is an error when using "y", "d", "c", "g~", "gu" or
2043 "gU" on an Empty region. The operators only work when
2044 at least one character is to be operate on. Example:
2045 This makes "y0" fail in the first column.
2046 *cpo-f*
2047 f When included, a ":read" command with a file name
2048 argument will set the file name for the current buffer,
2049 if the current buffer doesn't have a file name yet.
2050 *cpo-F*
2051 F When included, a ":write" command with a file name
2052 argument will set the file name for the current
2053 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002054 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 *cpo-g*
2056 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002057 *cpo-H*
2058 H When using "I" on a line with only blanks, insert
2059 before the last blank. Without this flag insert after
2060 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 *cpo-i*
2062 i When included, interrupting the reading of a file will
2063 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002064 *cpo-I*
2065 I When moving the cursor up or down just after inserting
2066 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 *cpo-j*
2068 j When joining lines, only add two spaces after a '.',
2069 not after '!' or '?'. Also see 'joinspaces'.
2070 *cpo-J*
2071 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002072 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 white space.
2074 *cpo-k*
2075 k Disable the recognition of raw key codes in
2076 mappings, abbreviations, and the "to" part of menu
2077 commands. For example, if <Key> sends ^[OA (where ^[
2078 is <Esc>), the command ":map X ^[OA" results in X
2079 being mapped to:
2080 'k' included: "^[OA" (3 characters)
2081 'k' excluded: "<Key>" (one key code)
2082 Also see the '<' flag below.
2083 *cpo-K*
2084 K Don't wait for a key code to complete when it is
2085 halfway a mapping. This breaks mapping <F1><F1> when
2086 only part of the second <F1> has been read. It
2087 enables cancelling the mapping by typing <F1><Esc>.
2088 *cpo-l*
2089 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002090 literally, only "\]", "\^", "\-" and "\\" are special.
2091 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2093 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002094 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 *cpo-L*
2096 L When the 'list' option is set, 'wrapmargin',
2097 'textwidth', 'softtabstop' and Virtual Replace mode
2098 (see |gR|) count a <Tab> as two characters, instead of
2099 the normal behavior of a <Tab>.
2100 *cpo-m*
2101 m When included, a showmatch will always wait half a
2102 second. When not included, a showmatch will wait half
2103 a second or until a character is typed. |'showmatch'|
2104 *cpo-M*
2105 M When excluded, "%" matching will take backslashes into
2106 account. Thus in "( \( )" and "\( ( \)" the outer
2107 parenthesis match. When included "%" ignores
2108 backslashes, which is Vi compatible.
2109 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002110 n When included, the column used for 'number' and
2111 'relativenumber' will also be used for text of wrapped
2112 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002113 *cpo-o*
2114 o Line offset to search command is not remembered for
2115 next search.
2116 *cpo-O*
2117 O Don't complain if a file is being overwritten, even
2118 when it didn't exist when editing it. This is a
2119 protection against a file unexpectedly created by
2120 someone else. Vi didn't complain about this.
2121 *cpo-p*
2122 p Vi compatible Lisp indenting. When not present, a
2123 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002124 *cpo-P*
2125 P When included, a ":write" command that appends to a
2126 file will set the file name for the current buffer, if
2127 the current buffer doesn't have a file name yet and
2128 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002129 *cpo-q*
2130 q When joining multiple lines leave the cursor at the
2131 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002132 *cpo-r*
2133 r Redo ("." command) uses "/" to repeat a search
2134 command, instead of the actually used search string.
2135 *cpo-R*
2136 R Remove marks from filtered lines. Without this flag
2137 marks are kept like |:keepmarks| was used.
2138 *cpo-s*
2139 s Set buffer options when entering the buffer for the
2140 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002141 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 set when the buffer is created.
2143 *cpo-S*
2144 S Set buffer options always when entering a buffer
2145 (except 'readonly', 'fileformat', 'filetype' and
2146 'syntax'). This is the (most) Vi compatible setting.
2147 The options are set to the values in the current
2148 buffer. When you change an option and go to another
2149 buffer, the value is copied. Effectively makes the
2150 buffer options global to all buffers.
2151
2152 's' 'S' copy buffer options
2153 no no when buffer created
2154 yes no when buffer first entered (default)
2155 X yes each time when buffer entered (vi comp.)
2156 *cpo-t*
2157 t Search pattern for the tag command is remembered for
2158 "n" command. Otherwise Vim only puts the pattern in
2159 the history for search pattern, but doesn't change the
2160 last used search pattern.
2161 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002162 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 *cpo-v*
2164 v Backspaced characters remain visible on the screen in
2165 Insert mode. Without this flag the characters are
2166 erased from the screen right away. With this flag the
2167 screen newly typed text overwrites backspaced
2168 characters.
2169 *cpo-w*
2170 w When using "cw" on a blank character, only change one
2171 character and not all blanks until the start of the
2172 next word.
2173 *cpo-W*
2174 W Don't overwrite a readonly file. When omitted, ":w!"
2175 overwrites a readonly file, if possible.
2176 *cpo-x*
2177 x <Esc> on the command-line executes the command-line.
2178 The default in Vim is to abandon the command-line,
2179 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002180 *cpo-X*
2181 X When using a count with "R" the replaced text is
2182 deleted only once. Also when repeating "R" with "."
2183 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002184 *cpo-y*
2185 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002186 *cpo-Z*
2187 Z When using "w!" while the 'readonly' option is set,
2188 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189 *cpo-!*
2190 ! When redoing a filter command, use the last used
2191 external command, whatever it was. Otherwise the last
2192 used -filter- command is used.
2193 *cpo-$*
2194 $ When making a change to one line, don't redisplay the
2195 line, but put a '$' at the end of the changed text.
2196 The changed text will be overwritten when you type the
2197 new text. The line is redisplayed if you type any
2198 command that moves the cursor from the insertion
2199 point.
2200 *cpo-%*
2201 % Vi-compatible matching is done for the "%" command.
2202 Does not recognize "#if", "#endif", etc.
2203 Does not recognize "/*" and "*/".
2204 Parens inside single and double quotes are also
2205 counted, causing a string that contains a paren to
2206 disturb the matching. For example, in a line like
2207 "if (strcmp("foo(", s))" the first paren does not
2208 match the last one. When this flag is not included,
2209 parens inside single and double quotes are treated
2210 specially. When matching a paren outside of quotes,
2211 everything inside quotes is ignored. When matching a
2212 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002213 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002214 This flag is also used for other features, such as
2215 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002216 *cpo--*
2217 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002218 it would go above the first line or below the last
2219 line. Without it the cursor moves to the first or
2220 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002221 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002222 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002223 *cpo-+*
2224 + When included, a ":write file" command will reset the
2225 'modified' flag of the buffer, even though the buffer
2226 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002227 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 * Use ":*" in the same way as ":@". When not included,
2229 ":*" is an alias for ":'<,'>", select the Visual area.
2230 *cpo-<*
2231 < Disable the recognition of special key codes in |<>|
2232 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002233 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 ":map X <Tab>" results in X being mapped to:
2235 '<' included: "<Tab>" (5 characters)
2236 '<' excluded: "^I" (^I is a real <Tab>)
2237 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002238 *cpo->*
2239 > When appending to a register, put a line break before
2240 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002241 *cpo-;*
2242 ; When using |,| or |;| to repeat the last |t| search
2243 and the cursor is right in front of the searched
2244 character, the cursor won't move. When not included,
2245 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002246 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002247
2248 POSIX flags. These are not included in the Vi default value, except
2249 when $VIM_POSIX was set on startup. |posix|
2250
2251 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002252 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002253 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002254 *cpo-&*
2255 & When ":preserve" was used keep the swap file when
2256 exiting normally while this buffer is still loaded.
2257 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002258 *cpo-\*
2259 \ Backslash in a [] range in a search pattern is taken
2260 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002261 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2262 '\' excluded: "/[ \-]" finds <Space> and '-'
2263 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002264 *cpo-/*
2265 / When "%" is used as the replacement string in a |:s|
2266 command, use the previous replacement string. |:s%|
2267 *cpo-{*
2268 { The |{| and |}| commands also stop at a "{" character
2269 at the start of a line.
2270 *cpo-.*
2271 . The ":chdir" and ":cd" commands fail if the current
2272 buffer is modified, unless ! is used. Vim doesn't
2273 need this, since it remembers the full path of an
2274 opened file.
2275 *cpo-bar*
2276 | The value of the $LINES and $COLUMNS environment
2277 variables overrule the terminal size values obtained
2278 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002279
Bram Moolenaar071d4272004-06-13 20:20:40 +00002280
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002281 *'cryptmethod'* *'cm'*
Bram Moolenaar32efaf62014-11-05 17:02:17 +01002282'cryptmethod' 'cm' string (default "zip")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002283 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002284 {not in Vi}
2285 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002286 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002287 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002288 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002289 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002290 blowfish Blowfish method. Medium strong encryption but it has
2291 an implementation flaw. Requires Vim 7.3 or later,
2292 files can NOT be read by Vim 7.2 and older. This adds
2293 a "seed" to the file, every time you write the file
2294 the encrypted bytes will be different.
2295 *blowfish2*
2296 blowfish2 Blowfish method. Medium strong encryption. Requires
2297 Vim 7.4.399 or later, files can NOT be read by Vim 7.3
2298 and older. This adds a "seed" to the file, every time
2299 you write the file the encrypted bytes will be
2300 different. The whole undo file is encrypted, not just
2301 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002302
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002303 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002304 to the detected method of the file being read. Thus if you write it
2305 without changing 'cryptmethod' the same method will be used.
2306 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002307 explicitly write it, you don't get a warning unless there are other
2308 modifications. Also see |:X|.
2309
2310 When setting the global value to an empty string, it will end up with
2311 the value "zip". When setting the local value to an empty string the
2312 buffer will use the global value.
2313
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002314 When a new encryption method is added in a later version of Vim, and
2315 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002316 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002317
2318
Bram Moolenaar071d4272004-06-13 20:20:40 +00002319 *'cscopepathcomp'* *'cspc'*
2320'cscopepathcomp' 'cspc' number (default 0)
2321 global
2322 {not available when compiled without the |+cscope|
2323 feature}
2324 {not in Vi}
2325 Determines how many components of the path to show in a list of tags.
2326 See |cscopepathcomp|.
2327
2328 *'cscopeprg'* *'csprg'*
2329'cscopeprg' 'csprg' string (default "cscope")
2330 global
2331 {not available when compiled without the |+cscope|
2332 feature}
2333 {not in Vi}
2334 Specifies the command to execute cscope. See |cscopeprg|.
2335 This option cannot be set from a |modeline| or in the |sandbox|, for
2336 security reasons.
2337
2338 *'cscopequickfix'* *'csqf'*
2339'cscopequickfix' 'csqf' string (default "")
2340 global
2341 {not available when compiled without the |+cscope|
2342 or |+quickfix| features}
2343 {not in Vi}
2344 Specifies whether to use quickfix window to show cscope results.
2345 See |cscopequickfix|.
2346
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002347 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002348'cscoperelative' 'csre' boolean (default off)
2349 global
2350 {not available when compiled without the |+cscope|
2351 feature}
2352 {not in Vi}
2353 In the absence of a prefix (-P) for cscope. setting this option enables
2354 to use the basename of cscope.out path as the prefix.
2355 See |cscoperelative|.
2356
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2358'cscopetag' 'cst' boolean (default off)
2359 global
2360 {not available when compiled without the |+cscope|
2361 feature}
2362 {not in Vi}
2363 Use cscope for tag commands. See |cscope-options|.
2364 NOTE: This option is reset when 'compatible' is set.
2365
2366 *'cscopetagorder'* *'csto'*
2367'cscopetagorder' 'csto' number (default 0)
2368 global
2369 {not available when compiled without the |+cscope|
2370 feature}
2371 {not in Vi}
2372 Determines the order in which ":cstag" performs a search. See
2373 |cscopetagorder|.
2374 NOTE: This option is set to 0 when 'compatible' is set.
2375
2376 *'cscopeverbose'* *'csverb'*
2377 *'nocscopeverbose'* *'nocsverb'*
2378'cscopeverbose' 'csverb' boolean (default off)
2379 global
2380 {not available when compiled without the |+cscope|
2381 feature}
2382 {not in Vi}
2383 Give messages when adding a cscope database. See |cscopeverbose|.
2384 NOTE: This option is reset when 'compatible' is set.
2385
Bram Moolenaar860cae12010-06-05 23:22:07 +02002386 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2387'cursorbind' 'crb' boolean (default off)
2388 local to window
2389 {not in Vi}
2390 {not available when compiled without the |+cursorbind|
2391 feature}
2392 When this option is set, as the cursor in the current
2393 window moves other cursorbound windows (windows that also have
2394 this option set) move their cursors to the corresponding line and
2395 column. This option is useful for viewing the
2396 differences between two versions of a file (see 'diff'); in diff mode,
2397 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002398 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002399
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002400
2401 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2402'cursorcolumn' 'cuc' boolean (default off)
2403 local to window
2404 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002405 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002406 feature}
2407 Highlight the screen column of the cursor with CursorColumn
2408 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2409 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002410 If you only want the highlighting in the current window you can use
2411 these autocommands: >
2412 au WinLeave * set nocursorline nocursorcolumn
2413 au WinEnter * set cursorline cursorcolumn
2414<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002415
2416 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2417'cursorline' 'cul' boolean (default off)
2418 local to window
2419 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002420 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002421 feature}
2422 Highlight the screen line of the cursor with CursorLine
2423 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2424 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002425 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002426 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002427
2428
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 *'debug'*
2430'debug' string (default "")
2431 global
2432 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002433 These values can be used:
2434 msg Error messages that would otherwise be omitted will be given
2435 anyway.
2436 throw Error messages that would otherwise be omitted will be given
2437 anyway and also throw an exception and set |v:errmsg|.
2438 beep A message will be given when otherwise only a beep would be
2439 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002440 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002441 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2442 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002443
2444 *'define'* *'def'*
2445'define' 'def' string (default "^\s*#\s*define")
2446 global or local to buffer |global-local|
2447 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002448 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 pattern, just like for the "/" command. This option is used for the
2450 commands like "[i" and "[d" |include-search|. The 'isident' option is
2451 used to recognize the defined name after the match:
2452 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2453 See |option-backslash| about inserting backslashes to include a space
2454 or backslash.
2455 The default value is for C programs. For C++ this value would be
2456 useful, to include const type declarations: >
2457 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2458< When using the ":set" command, you need to double the backslashes!
2459
2460 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2461'delcombine' 'deco' boolean (default off)
2462 global
2463 {not in Vi}
2464 {only available when compiled with the |+multi_byte|
2465 feature}
2466 If editing Unicode and this option is set, backspace and Normal mode
2467 "x" delete each combining character on its own. When it is off (the
2468 default) the character along with its combining characters are
2469 deleted.
2470 Note: When 'delcombine' is set "xx" may work different from "2x"!
2471
2472 This is useful for Arabic, Hebrew and many other languages where one
2473 may have combining characters overtop of base characters, and want
2474 to remove only the combining ones.
2475
2476 *'dictionary'* *'dict'*
2477'dictionary' 'dict' string (default "")
2478 global or local to buffer |global-local|
2479 {not in Vi}
2480 List of file names, separated by commas, that are used to lookup words
2481 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2482 contain a list of words. This can be one word per line, or several
2483 words per line, separated by non-keyword characters (white space is
2484 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002485 When this option is empty, or an entry "spell" is present, spell
2486 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002487 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 after a comma are ignored, otherwise spaces are included in the file
2489 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002490 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 Where to find a list of words?
2492 - On FreeBSD, there is the file "/usr/share/dict/words".
2493 - In the Simtel archive, look in the "msdos/linguist" directory.
2494 - In "miscfiles" of the GNU collection.
2495 The use of |:set+=| and |:set-=| is preferred when adding or removing
2496 directories from the list. This avoids problems when a future version
2497 uses another default.
2498 Backticks cannot be used in this option for security reasons.
2499
2500 *'diff'* *'nodiff'*
2501'diff' boolean (default off)
2502 local to window
2503 {not in Vi}
2504 {not available when compiled without the |+diff|
2505 feature}
2506 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002507 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002508
2509 *'dex'* *'diffexpr'*
2510'diffexpr' 'dex' string (default "")
2511 global
2512 {not in Vi}
2513 {not available when compiled without the |+diff|
2514 feature}
2515 Expression which is evaluated to obtain an ed-style diff file from two
2516 versions of a file. See |diff-diffexpr|.
2517 This option cannot be set from a |modeline| or in the |sandbox|, for
2518 security reasons.
2519
2520 *'dip'* *'diffopt'*
2521'diffopt' 'dip' string (default "filler")
2522 global
2523 {not in Vi}
2524 {not available when compiled without the |+diff|
2525 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002526 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002527 All are optional. Items must be separated by a comma.
2528
2529 filler Show filler lines, to keep the text
2530 synchronized with a window that has inserted
2531 lines at the same position. Mostly useful
2532 when windows are side-by-side and 'scrollbind'
2533 is set.
2534
2535 context:{n} Use a context of {n} lines between a change
2536 and a fold that contains unchanged lines.
2537 When omitted a context of six lines is used.
2538 See |fold-diff|.
2539
2540 icase Ignore changes in case of text. "a" and "A"
2541 are considered the same. Adds the "-i" flag
2542 to the "diff" command if 'diffexpr' is empty.
2543
2544 iwhite Ignore changes in amount of white space. Adds
2545 the "-b" flag to the "diff" command if
2546 'diffexpr' is empty. Check the documentation
2547 of the "diff" command for what this does
2548 exactly. It should ignore adding trailing
2549 white space, but not leading white space.
2550
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002551 horizontal Start diff mode with horizontal splits (unless
2552 explicitly specified otherwise).
2553
2554 vertical Start diff mode with vertical splits (unless
2555 explicitly specified otherwise).
2556
2557 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2558 starting diff mode. Without this 2 is used.
2559
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 Examples: >
2561
2562 :set diffopt=filler,context:4
2563 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002564 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565<
2566 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2567'digraph' 'dg' boolean (default off)
2568 global
2569 {not in Vi}
2570 {not available when compiled without the |+digraphs|
2571 feature}
2572 Enable the entering of digraphs in Insert mode with {char1} <BS>
2573 {char2}. See |digraphs|.
2574 NOTE: This option is reset when 'compatible' is set.
2575
2576 *'directory'* *'dir'*
2577'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002578 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 for Unix: ".,~/tmp,/var/tmp,/tmp")
2580 global
2581 List of directory names for the swap file, separated with commas.
2582 - The swap file will be created in the first directory where this is
2583 possible.
2584 - Empty means that no swap file will be used (recovery is
2585 impossible!).
2586 - A directory "." means to put the swap file in the same directory as
2587 the edited file. On Unix, a dot is prepended to the file name, so
2588 it doesn't show in a directory listing. On MS-Windows the "hidden"
2589 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002590 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 put the swap file relative to where the edited file is. The leading
2592 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002593 - For Unix and Win32, if a directory ends in two path separators "//"
2594 or "\\", the swap file name will be built from the complete path to
2595 the file with all path separators substituted to percent '%' signs.
2596 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002597 On Win32, when a separating comma is following, you must use "//",
2598 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 - Spaces after the comma are ignored, other spaces are considered part
2600 of the directory name. To have a space at the start of a directory
2601 name, precede it with a backslash.
2602 - To include a comma in a directory name precede it with a backslash.
2603 - A directory name may end in an ':' or '/'.
2604 - Environment variables are expanded |:set_env|.
2605 - Careful with '\' characters, type one before a space, type two to
2606 get one in the option (see |option-backslash|), for example: >
2607 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2608< - For backwards compatibility with Vim version 3.0 a '>' at the start
2609 of the option is removed.
2610 Using "." first in the list is recommended. This means that editing
2611 the same file twice will result in a warning. Using "/tmp" on Unix is
2612 discouraged: When the system crashes you lose the swap file.
2613 "/var/tmp" is often not cleared when rebooting, thus is a better
2614 choice than "/tmp". But it can contain a lot of files, your swap
2615 files get lost in the crowd. That is why a "tmp" directory in your
2616 home directory is tried first.
2617 The use of |:set+=| and |:set-=| is preferred when adding or removing
2618 directories from the list. This avoids problems when a future version
2619 uses another default.
2620 This option cannot be set from a |modeline| or in the |sandbox|, for
2621 security reasons.
2622 {Vi: directory to put temp file in, defaults to "/tmp"}
2623
2624 *'display'* *'dy'*
2625'display' 'dy' string (default "")
2626 global
2627 {not in Vi}
2628 Change the way text is displayed. This is comma separated list of
2629 flags:
2630 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002631 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 last line that doesn't fit is replaced with "@" lines.
2633 uhex Show unprintable characters hexadecimal as <xx>
2634 instead of using ^C and ~C.
2635
2636 *'eadirection'* *'ead'*
2637'eadirection' 'ead' string (default "both")
2638 global
2639 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002640 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 feature}
2642 Tells when the 'equalalways' option applies:
2643 ver vertically, width of windows is not affected
2644 hor horizontally, height of windows is not affected
2645 both width and height of windows is affected
2646
2647 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2648'edcompatible' 'ed' boolean (default off)
2649 global
2650 Makes the 'g' and 'c' flags of the ":substitute" command to be
2651 toggled each time the flag is given. See |complex-change|. See
2652 also 'gdefault' option.
2653 Switching this option on is discouraged!
2654
2655 *'encoding'* *'enc'* *E543*
2656'encoding' 'enc' string (default: "latin1" or value from $LANG)
2657 global
2658 {only available when compiled with the |+multi_byte|
2659 feature}
2660 {not in Vi}
2661 Sets the character encoding used inside Vim. It applies to text in
2662 the buffers, registers, Strings in expressions, text stored in the
2663 viminfo file, etc. It sets the kind of characters which Vim can work
2664 with. See |encoding-names| for the possible values.
2665
2666 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002667 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002669 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670
Bram Moolenaar865242e2010-07-14 21:12:05 +02002671 This option cannot be set from a |modeline|. It would most likely
2672 corrupt the text.
2673
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2675 "utf-8". Although care has been taken to allow different values of
2676 'encoding', "utf-8" is the natural choice for the environment and
2677 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002678 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679 versions, and to avoid changing the encoding of newly created files
2680 without your knowledge (in case 'fileencodings' is empty).
2681
2682 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002683 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 iconv() or as specified with 'charconvert'.
2685
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002686 If you need to know whether 'encoding' is a multi-byte encoding, you
2687 can use: >
2688 if has("multi_byte_encoding")
2689<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 Normally 'encoding' will be equal to your current locale. This will
2691 be the default if Vim recognizes your environment settings. If
2692 'encoding' is not set to the current locale, 'termencoding' must be
2693 set to convert typed and displayed text. See |encoding-table|.
2694
2695 When you set this option, it fires the |EncodingChanged| autocommand
2696 event so that you can set up fonts if necessary.
2697
2698 When the option is set, the value is converted to lowercase. Thus
2699 you can set it with uppercase values too. Underscores are translated
2700 to '-' signs.
2701 When the encoding is recognized, it is changed to the standard name.
2702 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2703 "iso-8859-2" and "utf8" becomes "utf-8".
2704
2705 Note: "latin1" is also used when the encoding could not be detected.
2706 This only works when editing files in the same encoding! When the
2707 actual character set is not latin1, make sure 'fileencoding' and
2708 'fileencodings' are empty. When conversion is needed, switch to using
2709 utf-8.
2710
2711 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2712 You don't notice this while editing, but it does matter for the
2713 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2714 setting 'encoding' to one of these values instead of utf-8 only has
2715 effect for encoding used for files when 'fileencoding' is empty.
2716
Bram Moolenaar661b1822005-07-28 22:36:45 +00002717 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2718 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719
2720 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2721'endofline' 'eol' boolean (default on)
2722 local to buffer
2723 {not in Vi}
2724 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002725 is on, or 'fixeol' option is off, no <EOL> will be written for the
2726 last line in the file. This option is automatically set or reset when
2727 starting to edit a new file, depending on whether file has an <EOL>
2728 for the last line in the file. Normally you don't have to set or
2729 reset this option.
2730 When 'binary' is off and 'fixeol' is on the value is not used when
2731 writing the file. When 'binary' is on or 'fixeol' is off it is used
2732 to remember the presence of a <EOL> for the last line in the file, so
2733 that when you write the file the situation from the original file can
2734 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
2736 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2737'equalalways' 'ea' boolean (default on)
2738 global
2739 {not in Vi}
2740 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002741 splitting or closing a window. This also happens the moment the
2742 option is switched on. When off, splitting a window will reduce the
2743 size of the current window and leave the other windows the same. When
2744 closing a window the extra lines are given to the window next to it
2745 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 When mixing vertically and horizontally split windows, a minimal size
2747 is computed and some windows may be larger if there is room. The
2748 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002749 Changing the height and width of a window can be avoided by setting
2750 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002751 If a window size is specified when creating a new window sizes are
2752 currently not equalized (it's complicated, but may be implemented in
2753 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754
2755 *'equalprg'* *'ep'*
2756'equalprg' 'ep' string (default "")
2757 global or local to buffer |global-local|
2758 {not in Vi}
2759 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002760 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002761 or 'indentexpr'. When Vim was compiled without internal formatting,
2762 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002763 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 about including spaces and backslashes.
2765 This option cannot be set from a |modeline| or in the |sandbox|, for
2766 security reasons.
2767
2768 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2769'errorbells' 'eb' boolean (default off)
2770 global
2771 Ring the bell (beep or screen flash) for error messages. This only
2772 makes a difference for error messages, the bell will be used always
2773 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002774 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002775 screen flash or do nothing. See 'belloff' to finetune when to ring the
2776 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777
2778 *'errorfile'* *'ef'*
2779'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2780 others: "errors.err")
2781 global
2782 {not in Vi}
2783 {not available when compiled without the |+quickfix|
2784 feature}
2785 Name of the errorfile for the QuickFix mode (see |:cf|).
2786 When the "-q" command-line argument is used, 'errorfile' is set to the
2787 following argument. See |-q|.
2788 NOT used for the ":make" command. See 'makeef' for that.
2789 Environment variables are expanded |:set_env|.
2790 See |option-backslash| about including spaces and backslashes.
2791 This option cannot be set from a |modeline| or in the |sandbox|, for
2792 security reasons.
2793
2794 *'errorformat'* *'efm'*
2795'errorformat' 'efm' string (default is very long)
2796 global or local to buffer |global-local|
2797 {not in Vi}
2798 {not available when compiled without the |+quickfix|
2799 feature}
2800 Scanf-like description of the format for the lines in the error file
2801 (see |errorformat|).
2802
2803 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2804'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2805 global
2806 {not in Vi}
2807 Function keys that start with an <Esc> are recognized in Insert
2808 mode. When this option is off, the cursor and function keys cannot be
2809 used in Insert mode if they start with an <Esc>. The advantage of
2810 this is that the single <Esc> is recognized immediately, instead of
2811 after one second. Instead of resetting this option, you might want to
2812 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2813 when 'esckeys' is off, you can still map anything, but the cursor keys
2814 won't work by default.
2815 NOTE: This option is set to the Vi default value when 'compatible' is
2816 set and to the Vim default value when 'compatible' is reset.
2817
2818 *'eventignore'* *'ei'*
2819'eventignore' 'ei' string (default "")
2820 global
2821 {not in Vi}
2822 {not available when compiled without the |+autocmd|
2823 feature}
2824 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002825 When set to "all" or when "all" is one of the items, all autocommand
2826 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827 Otherwise this is a comma separated list of event names. Example: >
2828 :set ei=WinEnter,WinLeave
2829<
2830 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2831'expandtab' 'et' boolean (default off)
2832 local to buffer
2833 {not in Vi}
2834 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002835 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2837 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2838 NOTE: This option is reset when 'compatible' is set.
2839
2840 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2841'exrc' 'ex' boolean (default off)
2842 global
2843 {not in Vi}
2844 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2845 directory. If you switch this option on you should also consider
2846 setting the 'secure' option (see |initialization|). Using a local
2847 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2848 also see |.vimrc| and |gui-init|.
2849 This option cannot be set from a |modeline| or in the |sandbox|, for
2850 security reasons.
2851
2852 *'fileencoding'* *'fenc'* *E213*
2853'fileencoding' 'fenc' string (default: "")
2854 local to buffer
2855 {only available when compiled with the |+multi_byte|
2856 feature}
2857 {not in Vi}
2858 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002859
Bram Moolenaar071d4272004-06-13 20:20:40 +00002860 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002861 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 When 'fileencoding' is empty, the same value as 'encoding' will be
2863 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002864 Conversion will also be done when 'encoding' and 'fileencoding' are
2865 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2866 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002868 'encoding' is "utf-8" or another Unicode encoding, conversion
2869 is most likely done in a way that the reverse conversion
2870 results in the same text. When 'encoding' is not "utf-8" some
2871 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002872
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 See 'encoding' for the possible values. Additionally, values may be
2874 specified that can be handled by the converter, see
2875 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002876
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 When reading a file 'fileencoding' will be set from 'fileencodings'.
2878 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002879 'fileencoding', use the |++enc| argument. One exception: when
2880 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002881 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002882
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2884 When the option is set, the value is converted to lowercase. Thus
2885 you can set it with uppercase values too. '_' characters are
2886 replaced with '-'. If a name is recognized from the list for
2887 'encoding', it is replaced by the standard name. For example
2888 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002889
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 When this option is set, after starting to edit a file, the 'modified'
2891 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002892
2893 Keep in mind that changing 'fenc' from a modeline happens
2894 AFTER the text has been read, thus it applies to when the file will be
2895 written. If you do set 'fenc' in a modeline, you might want to set
2896 'nomodified' to avoid not being able to ":q".
2897
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 This option can not be changed when 'modifiable' is off.
2899
2900 *'fe'*
2901 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002902 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 old short name was 'fe', which is no longer used.
2904
2905 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002906'fileencodings' 'fencs' string (default: "ucs-bom",
2907 "ucs-bom,utf-8,default,latin1" when
2908 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 global
2910 {only available when compiled with the |+multi_byte|
2911 feature}
2912 {not in Vi}
2913 This is a list of character encodings considered when starting to edit
2914 an existing file. When a file is read, Vim tries to use the first
2915 mentioned character encoding. If an error is detected, the next one
2916 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 an empty string, which means the value of 'encoding' is used.
2919 WARNING: Conversion can cause loss of information! When
2920 'encoding' is "utf-8" (or one of the other Unicode variants)
2921 conversion is most likely done in a way that the reverse
2922 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002923 "utf-8" some non-ASCII characters may be lost! You can use
2924 the |++bad| argument to specify what is done with characters
2925 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 For an empty file or a file with only ASCII characters most encodings
2927 will work and the first entry of 'fileencodings' will be used (except
2928 "ucs-bom", which requires the BOM to be present). If you prefer
2929 another encoding use an BufReadPost autocommand event to test if your
2930 preferred encoding is to be used. Example: >
2931 au BufReadPost * if search('\S', 'w') == 0 |
2932 \ set fenc=iso-2022-jp | endif
2933< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2934 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002935 When the |++enc| argument is used then the value of 'fileencodings' is
2936 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002937 Note that 'fileencodings' is not used for a new file, the global value
2938 of 'fileencoding' is used instead. You can set it with: >
2939 :setglobal fenc=iso-8859-2
2940< This means that a non-existing file may get a different encoding than
2941 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 The special value "ucs-bom" can be used to check for a Unicode BOM
2943 (Byte Order Mark) at the start of the file. It must not be preceded
2944 by "utf-8" or another Unicode encoding for this to work properly.
2945 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2946 because Vim cannot detect an error, thus the encoding is always
2947 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002948 The special value "default" can be used for the encoding from the
2949 environment. This is the default value for 'encoding'. It is useful
2950 when 'encoding' is set to "utf-8" and your environment uses a
2951 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002952 When 'encoding' is "utf-8" and a file contains an illegal byte
2953 sequence it won't be recognized as UTF-8. You can use the |8g8|
2954 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 WRONG VALUES: WHAT'S WRONG:
2956 latin1,utf-8 "latin1" will always be used
2957 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2958 file
2959 cp1250,latin1 "cp1250" will always be used
2960 If 'fileencodings' is empty, 'fileencoding' is not modified.
2961 See 'fileencoding' for the possible values.
2962 Setting this option does not have an effect until the next time a file
2963 is read.
2964
2965 *'fileformat'* *'ff'*
2966'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2967 Unix default: "unix",
2968 Macintosh default: "mac")
2969 local to buffer
2970 {not in Vi}
2971 This gives the <EOL> of the current buffer, which is used for
2972 reading/writing the buffer from/to a file:
2973 dos <CR> <NL>
2974 unix <NL>
2975 mac <CR>
2976 When "dos" is used, CTRL-Z at the end of a file is ignored.
2977 See |file-formats| and |file-read|.
2978 For the character encoding of the file see 'fileencoding'.
2979 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02002980 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 This option is set automatically when starting to edit a file and
2982 'fileformats' is not empty and 'binary' is off.
2983 When this option is set, after starting to edit a file, the 'modified'
2984 option is set, because the file would be different when written.
2985 This option can not be changed when 'modifiable' is off.
2986 For backwards compatibility: When this option is set to "dos",
2987 'textmode' is set, otherwise 'textmode' is reset.
2988
2989 *'fileformats'* *'ffs'*
2990'fileformats' 'ffs' string (default:
2991 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2992 Vim Unix: "unix,dos",
2993 Vim Mac: "mac,unix,dos",
2994 Vi Cygwin: "unix,dos",
2995 Vi others: "")
2996 global
2997 {not in Vi}
2998 This gives the end-of-line (<EOL>) formats that will be tried when
2999 starting to edit a new buffer and when reading a file into an existing
3000 buffer:
3001 - When empty, the format defined with 'fileformat' will be used
3002 always. It is not set automatically.
3003 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003004 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 'fileformats' name will be used when a file is read into an existing
3006 buffer, no matter what 'fileformat' for that buffer is set to.
3007 - When more than one name is present, separated by commas, automatic
3008 <EOL> detection will be done when reading a file. When starting to
3009 edit a file, a check is done for the <EOL>:
3010 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3011 'fileformat' is set to "dos".
3012 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003013 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003015 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3016 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003017 This means that "mac" is only chosen when:
3018 "unix" is not present or no <NL> is found in the file, and
3019 "dos" is not present or no <CR><NL> is found in the file.
3020 Except: if "unix" was chosen, but there is a <CR> before
3021 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003022 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 4. If 'fileformat' is still not set, the first name from
3024 'fileformats' is used.
3025 When reading a file into an existing buffer, the same is done, but
3026 this happens like 'fileformat' has been set appropriately for that
3027 file only, the option is not changed.
3028 When 'binary' is set, the value of 'fileformats' is not used.
3029
Bram Moolenaar81af9252010-12-10 20:35:50 +01003030 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01003031 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003032
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3034 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3035 done:
3036 - When 'fileformats' is empty, there is no automatic detection. Dos
3037 format will be used.
3038 - When 'fileformats' is set to one or more names, automatic detection
3039 is done. This is based on the first <NL> in the file: If there is a
3040 <CR> in front of it, Dos format is used, otherwise Unix format is
3041 used.
3042 Also see |file-formats|.
3043 For backwards compatibility: When this option is set to an empty
3044 string or one format (no comma is included), 'textauto' is reset,
3045 otherwise 'textauto' is set.
3046 NOTE: This option is set to the Vi default value when 'compatible' is
3047 set and to the Vim default value when 'compatible' is reset.
3048
Bram Moolenaarbf884932013-04-05 22:26:15 +02003049 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3050'fileignorecase' 'fic' boolean (default on for systems where case in file
3051 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003052 global
3053 {not in Vi}
3054 When set case is ignored when using file names and directories.
3055 See 'wildignorecase' for only ignoring case when doing completion.
3056
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 *'filetype'* *'ft'*
3058'filetype' 'ft' string (default: "")
3059 local to buffer
3060 {not in Vi}
3061 {not available when compiled without the |+autocmd|
3062 feature}
3063 When this option is set, the FileType autocommand event is triggered.
3064 All autocommands that match with the value of this option will be
3065 executed. Thus the value of 'filetype' is used in place of the file
3066 name.
3067 Otherwise this option does not always reflect the current file type.
3068 This option is normally set when the file type is detected. To enable
3069 this use the ":filetype on" command. |:filetype|
3070 Setting this option to a different value is most useful in a modeline,
3071 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003072 Example, for in an IDL file:
3073 /* vim: set filetype=idl : */ ~
3074 |FileType| |filetypes|
3075 When a dot appears in the value then this separates two filetype
3076 names. Example:
3077 /* vim: set filetype=c.doxygen : */ ~
3078 This will use the "c" filetype first, then the "doxygen" filetype.
3079 This works both for filetype plugins and for syntax files. More than
3080 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 This option is not copied to another buffer, independent of the 's' or
3082 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003083 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084
3085 *'fillchars'* *'fcs'*
3086'fillchars' 'fcs' string (default "vert:|,fold:-")
3087 global
3088 {not in Vi}
3089 {not available when compiled without the |+windows|
3090 and |+folding| features}
3091 Characters to fill the statuslines and vertical separators.
3092 It is a comma separated list of items:
3093
3094 item default Used for ~
3095 stl:c ' ' or '^' statusline of the current window
3096 stlnc:c ' ' or '-' statusline of the non-current windows
3097 vert:c '|' vertical separators |:vsplit|
3098 fold:c '-' filling 'foldtext'
3099 diff:c '-' deleted lines of the 'diff' option
3100
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003101 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003102 "stlnc" the space will be used when there is highlighting, '^' or '-'
3103 otherwise.
3104
3105 Example: >
3106 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
3107< This is similar to the default, except that these characters will also
3108 be used when there is highlighting.
3109
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003110 for "stl" and "stlnc" only single-byte values are supported.
3111
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 The highlighting used for these items:
3113 item highlight group ~
3114 stl:c StatusLine |hl-StatusLine|
3115 stlnc:c StatusLineNC |hl-StatusLineNC|
3116 vert:c VertSplit |hl-VertSplit|
3117 fold:c Folded |hl-Folded|
3118 diff:c DiffDelete |hl-DiffDelete|
3119
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003120 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3121'fixendofline' 'fixeol' boolean (default on)
3122 local to buffer
3123 {not in Vi}
3124 When writing a file and this option is on, <EOL> at the end of file
3125 will be restored if missing. Turn this option off if you want to
3126 preserve the situation from the original file.
3127 When the 'binary' option is set the value of this option doesn't
3128 matter.
3129 See the 'endofline' option.
3130
Bram Moolenaar071d4272004-06-13 20:20:40 +00003131 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3132'fkmap' 'fk' boolean (default off) *E198*
3133 global
3134 {not in Vi}
3135 {only available when compiled with the |+rightleft|
3136 feature}
3137 When on, the keyboard is mapped for the Farsi character set.
3138 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003139 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140
3141 *'foldclose'* *'fcl'*
3142'foldclose' 'fcl' string (default "")
3143 global
3144 {not in Vi}
3145 {not available when compiled without the |+folding|
3146 feature}
3147 When set to "all", a fold is closed when the cursor isn't in it and
3148 its level is higher than 'foldlevel'. Useful if you want folds to
3149 automatically close when moving out of them.
3150
3151 *'foldcolumn'* *'fdc'*
3152'foldcolumn' 'fdc' number (default 0)
3153 local to window
3154 {not in Vi}
3155 {not available when compiled without the |+folding|
3156 feature}
3157 When non-zero, a column with the specified width is shown at the side
3158 of the window which indicates open and closed folds. The maximum
3159 value is 12.
3160 See |folding|.
3161
3162 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3163'foldenable' 'fen' boolean (default on)
3164 local to window
3165 {not in Vi}
3166 {not available when compiled without the |+folding|
3167 feature}
3168 When off, all folds are open. This option can be used to quickly
3169 switch between showing all text unfolded and viewing the text with
3170 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003171 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 'foldenable' is off.
3173 This option is set by commands that create a new fold or close a fold.
3174 See |folding|.
3175
3176 *'foldexpr'* *'fde'*
3177'foldexpr' 'fde' string (default: "0")
3178 local to window
3179 {not in Vi}
3180 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003181 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003183 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003184
Bram Moolenaar30b65812012-07-12 22:01:11 +02003185 The expression will be evaluated in the |sandbox| if set from a
3186 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003187 This option can't be set from a |modeline| when the 'diff' option is
3188 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003189
3190 It is not allowed to change text or jump to another window while
3191 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192
3193 *'foldignore'* *'fdi'*
3194'foldignore' 'fdi' string (default: "#")
3195 local to window
3196 {not in Vi}
3197 {not available when compiled without the |+folding|
3198 feature}
3199 Used only when 'foldmethod' is "indent". Lines starting with
3200 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003201 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 The default "#" works well for C programs. See |fold-indent|.
3203
3204 *'foldlevel'* *'fdl'*
3205'foldlevel' 'fdl' number (default: 0)
3206 local to window
3207 {not in Vi}
3208 {not available when compiled without the |+folding|
3209 feature}
3210 Sets the fold level: Folds with a higher level will be closed.
3211 Setting this option to zero will close all folds. Higher numbers will
3212 close fewer folds.
3213 This option is set by commands like |zm|, |zM| and |zR|.
3214 See |fold-foldlevel|.
3215
3216 *'foldlevelstart'* *'fdls'*
3217'foldlevelstart' 'fdls' number (default: -1)
3218 global
3219 {not in Vi}
3220 {not available when compiled without the |+folding|
3221 feature}
3222 Sets 'foldlevel' when starting to edit another buffer in a window.
3223 Useful to always start editing with all folds closed (value zero),
3224 some folds closed (one) or no folds closed (99).
3225 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003226 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 ignores this option and closes all folds.
3228 It is also done before BufReadPre autocommands, to allow an autocmd to
3229 overrule the 'foldlevel' value for specific files.
3230 When the value is negative, it is not used.
3231
3232 *'foldmarker'* *'fmr'* *E536*
3233'foldmarker' 'fmr' string (default: "{{{,}}}")
3234 local to window
3235 {not in Vi}
3236 {not available when compiled without the |+folding|
3237 feature}
3238 The start and end marker used when 'foldmethod' is "marker". There
3239 must be one comma, which separates the start and end marker. The
3240 marker is a literal string (a regular expression would be too slow).
3241 See |fold-marker|.
3242
3243 *'foldmethod'* *'fdm'*
3244'foldmethod' 'fdm' string (default: "manual")
3245 local to window
3246 {not in Vi}
3247 {not available when compiled without the |+folding|
3248 feature}
3249 The kind of folding used for the current window. Possible values:
3250 |fold-manual| manual Folds are created manually.
3251 |fold-indent| indent Lines with equal indent form a fold.
3252 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3253 |fold-marker| marker Markers are used to specify folds.
3254 |fold-syntax| syntax Syntax highlighting items specify folds.
3255 |fold-diff| diff Fold text that is not changed.
3256
3257 *'foldminlines'* *'fml'*
3258'foldminlines' 'fml' number (default: 1)
3259 local to window
3260 {not in Vi}
3261 {not available when compiled without the |+folding|
3262 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003263 Sets the number of screen lines above which a fold can be displayed
3264 closed. Also for manually closed folds. With the default value of
3265 one a fold can only be closed if it takes up two or more screen lines.
3266 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003267 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 "zc" to close a fold, which is displayed open because it's smaller
3269 than 'foldminlines', a following "zc" may close a containing fold.
3270
3271 *'foldnestmax'* *'fdn'*
3272'foldnestmax' 'fdn' number (default: 20)
3273 local to window
3274 {not in Vi}
3275 {not available when compiled without the |+folding|
3276 feature}
3277 Sets the maximum nesting of folds for the "indent" and "syntax"
3278 methods. This avoids that too many folds will be created. Using more
3279 than 20 doesn't work, because the internal limit is 20.
3280
3281 *'foldopen'* *'fdo'*
3282'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3283 search,tag,undo")
3284 global
3285 {not in Vi}
3286 {not available when compiled without the |+folding|
3287 feature}
3288 Specifies for which type of commands folds will be opened, if the
3289 command moves the cursor into a closed fold. It is a comma separated
3290 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003291 NOTE: When the command is part of a mapping this option is not used.
3292 Add the |zv| command to the mapping to get the same effect.
3293 (rationale: the mapping may want to control opening folds itself)
3294
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 item commands ~
3296 all any
3297 block "(", "{", "[[", "[{", etc.
3298 hor horizontal movements: "l", "w", "fx", etc.
3299 insert any command in Insert mode
3300 jump far jumps: "G", "gg", etc.
3301 mark jumping to a mark: "'m", CTRL-O, etc.
3302 percent "%"
3303 quickfix ":cn", ":crew", ":make", etc.
3304 search search for a pattern: "/", "n", "*", "gd", etc.
3305 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003306 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 tag jumping to a tag: ":ta", CTRL-T, etc.
3308 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 When a movement command is used for an operator (e.g., "dl" or "y%")
3310 this option is not used. This means the operator will include the
3311 whole closed fold.
3312 Note that vertical movements are not here, because it would make it
3313 very difficult to move onto a closed fold.
3314 In insert mode the folds containing the cursor will always be open
3315 when text is inserted.
3316 To close folds you can re-apply 'foldlevel' with the |zx| command or
3317 set the 'foldclose' option to "all".
3318
3319 *'foldtext'* *'fdt'*
3320'foldtext' 'fdt' string (default: "foldtext()")
3321 local to window
3322 {not in Vi}
3323 {not available when compiled without the |+folding|
3324 feature}
3325 An expression which is used to specify the text displayed for a closed
3326 fold. See |fold-foldtext|.
3327
Bram Moolenaar30b65812012-07-12 22:01:11 +02003328 The expression will be evaluated in the |sandbox| if set from a
3329 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003330
3331 It is not allowed to change text or jump to another window while
3332 evaluating 'foldtext' |textlock|.
3333
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334 *'formatoptions'* *'fo'*
3335'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3336 local to buffer
3337 {not in Vi}
3338 This is a sequence of letters which describes how automatic
3339 formatting is to be done. See |fo-table|. When the 'paste' option is
3340 on, no formatting is done (like 'formatoptions' is empty). Commas can
3341 be inserted for readability.
3342 To avoid problems with flags that are added in the future, use the
3343 "+=" and "-=" feature of ":set" |add-option-flags|.
3344 NOTE: This option is set to the Vi default value when 'compatible' is
3345 set and to the Vim default value when 'compatible' is reset.
3346
Bram Moolenaar86b68352004-12-27 21:59:20 +00003347 *'formatlistpat'* *'flp'*
3348'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3349 local to buffer
3350 {not in Vi}
3351 A pattern that is used to recognize a list header. This is used for
3352 the "n" flag in 'formatoptions'.
3353 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003354 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003355 while still checking more characters. There must be a character
3356 following the pattern, when it matches the whole line it is handled
3357 like there is no match.
3358 The default recognizes a number, followed by an optional punctuation
3359 character and white space.
3360
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 *'formatprg'* *'fp'*
3362'formatprg' 'fp' string (default "")
3363 global
3364 {not in Vi}
3365 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003366 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003368 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003369 If the 'formatexpr' option is not empty it will be used instead.
3370 Otherwise, if 'formatprg' option is an empty string, the internal
3371 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003372 Environment variables are expanded |:set_env|. See |option-backslash|
3373 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003374 This option cannot be set from a |modeline| or in the |sandbox|, for
3375 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003377 *'formatexpr'* *'fex'*
3378'formatexpr' 'fex' string (default "")
3379 local to buffer
3380 {not in Vi}
3381 {not available when compiled without the |+eval|
3382 feature}
3383 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003384 operator or automatic formatting (see 'formatoptions'). When this
3385 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003386
3387 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003388 The |v:count| variable holds the number of lines to be formatted.
3389 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003390 inserted if the expression is being evaluated due to
3391 automatic formatting. This can be empty. Don't insert
3392 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003393
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003394 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003395 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003396< This will invoke the mylang#Format() function in the
3397 autoload/mylang.vim file in 'runtimepath'. |autoload|
3398
3399 The expression is also evaluated when 'textwidth' is set and adding
3400 text beyond that limit. This happens under the same conditions as
3401 when internal formatting is used. Make sure the cursor is kept in the
3402 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003403 return "i" or "R" in this situation.
3404
3405 When the expression evaluates to non-zero Vim will fall back to using
3406 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003407
Bram Moolenaar30b65812012-07-12 22:01:11 +02003408 The expression will be evaluated in the |sandbox| when set from a
3409 modeline, see |sandbox-option|. That stops the option from working,
3410 since changing the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003411
3412 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003413'fsync' 'fs' boolean (default on)
3414 global
3415 {not in Vi}
3416 When on, the library function fsync() will be called after writing a
3417 file. This will flush a file to disk, ensuring that it is safely
3418 written even on filesystems which do metadata-only journaling. This
3419 will force the harddrive to spin up on Linux systems running in laptop
3420 mode, so it may be undesirable in some situations. Be warned that
3421 turning this off increases the chances of data loss after a crash. On
3422 systems without an fsync() implementation, this variable is always
3423 off.
3424 Also see 'swapsync' for controlling fsync() on swap files.
3425
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3427'gdefault' 'gd' boolean (default off)
3428 global
3429 {not in Vi}
3430 When on, the ":substitute" flag 'g' is default on. This means that
3431 all matches in a line are substituted instead of one. When a 'g' flag
3432 is given to a ":substitute" command, this will toggle the substitution
3433 of all or one match. See |complex-change|.
3434
3435 command 'gdefault' on 'gdefault' off ~
3436 :s/// subst. all subst. one
3437 :s///g subst. one subst. all
3438 :s///gg subst. all subst. one
3439
3440 NOTE: This option is reset when 'compatible' is set.
3441
3442 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003443'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 global
3445 {not in Vi}
3446 Format to recognize for the ":grep" command output.
3447 This is a scanf-like string that uses the same format as the
3448 'errorformat' option: see |errorformat|.
3449
3450 *'grepprg'* *'gp'*
3451'grepprg' 'gp' string (default "grep -n ",
3452 Unix: "grep -n $* /dev/null",
3453 Win32: "findstr /n" or "grep -n",
3454 VMS: "SEARCH/NUMBERS ")
3455 global or local to buffer |global-local|
3456 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003457 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 and '#' characters, which are expanded like when used in a command-
3459 line. The placeholder "$*" is allowed to specify where the arguments
3460 will be included. Environment variables are expanded |:set_env|. See
3461 |option-backslash| about including spaces and backslashes.
3462 When your "grep" accepts the "-H" argument, use this to make ":grep"
3463 also work well with a single file: >
3464 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003465< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003466 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3467 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003468 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 apply equally to 'grepprg'.
3470 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3471 otherwise it's "grep -n".
3472 This option cannot be set from a |modeline| or in the |sandbox|, for
3473 security reasons.
3474
3475 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3476'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3477 ve:ver35-Cursor,
3478 o:hor50-Cursor,
3479 i-ci:ver25-Cursor/lCursor,
3480 r-cr:hor20-Cursor/lCursor,
3481 sm:block-Cursor
3482 -blinkwait175-blinkoff150-blinkon175",
3483 for MS-DOS and Win32 console:
3484 "n-v-c:block,o:hor50,i-ci:hor15,
3485 r-cr:hor30,sm:block")
3486 global
3487 {not in Vi}
3488 {only available when compiled with GUI enabled, and
3489 for MS-DOS and Win32 console}
3490 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003491 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 the height of the cursor can be changed. This can be done by
3493 specifying a block cursor, or a percentage for a vertical or
3494 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003495 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3496 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003498 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 mode-list and an argument-list:
3500 mode-list:argument-list,mode-list:argument-list,..
3501 The mode-list is a dash separated list of these modes:
3502 n Normal mode
3503 v Visual mode
3504 ve Visual mode with 'selection' "exclusive" (same as 'v',
3505 if not specified)
3506 o Operator-pending mode
3507 i Insert mode
3508 r Replace mode
3509 c Command-line Normal (append) mode
3510 ci Command-line Insert mode
3511 cr Command-line Replace mode
3512 sm showmatch in Insert mode
3513 a all modes
3514 The argument-list is a dash separated list of these arguments:
3515 hor{N} horizontal bar, {N} percent of the character height
3516 ver{N} vertical bar, {N} percent of the character width
3517 block block cursor, fills the whole character
3518 [only one of the above three should be present]
3519 blinkwait{N} *cursor-blinking*
3520 blinkon{N}
3521 blinkoff{N}
3522 blink times for cursor: blinkwait is the delay before
3523 the cursor starts blinking, blinkon is the time that
3524 the cursor is shown and blinkoff is the time that the
3525 cursor is not shown. The times are in msec. When one
3526 of the numbers is zero, there is no blinking. The
3527 default is: "blinkwait700-blinkon400-blinkoff250".
3528 These numbers are used for a missing entry. This
3529 means that blinking is enabled by default. To switch
3530 blinking off you can use "blinkon0". The cursor only
3531 blinks when Vim is waiting for input, not while
3532 executing a command.
3533 To make the cursor blink in an xterm, see
3534 |xterm-blink|.
3535 {group-name}
3536 a highlight group name, that sets the color and font
3537 for the cursor
3538 {group-name}/{group-name}
3539 Two highlight group names, the first is used when
3540 no language mappings are used, the other when they
3541 are. |language-mapping|
3542
3543 Examples of parts:
3544 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3545 block cursor with colors from the "nCursor"
3546 highlight group
3547 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3548 In Insert and Command-line Insert mode, use a
3549 30% vertical bar cursor with colors from the
3550 "iCursor" highlight group. Blink a bit
3551 faster.
3552
3553 The 'a' mode is different. It will set the given argument-list for
3554 all modes. It does not reset anything to defaults. This can be used
3555 to do a common setting for all modes. For example, to switch off
3556 blinking: "a:blinkon0"
3557
3558 Examples of cursor highlighting: >
3559 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3560 :highlight Cursor gui=NONE guifg=bg guibg=fg
3561<
3562 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003563 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564'guifont' 'gfn' string (default "")
3565 global
3566 {not in Vi}
3567 {only available when compiled with GUI enabled}
3568 This is a list of fonts which will be used for the GUI version of Vim.
3569 In its simplest form the value is just one font name. When
3570 the font cannot be found you will get an error message. To try other
3571 font names a list can be specified, font names separated with commas.
3572 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003573
Bram Moolenaar05159a02005-02-26 23:04:13 +00003574 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3575 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003576
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 Spaces after a comma are ignored. To include a comma in a font name
3578 precede it with a backslash. Setting an option requires an extra
3579 backslash before a space and a backslash. See also
3580 |option-backslash|. For example: >
3581 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003582< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003584
3585 If none of the fonts can be loaded, Vim will keep the current setting.
3586 If an empty font list is given, Vim will try using other resource
3587 settings (for X, it will use the Vim.font resource), and finally it
3588 will try some builtin default which should always be there ("7x13" in
3589 the case of X). The font names given should be "normal" fonts. Vim
3590 will try to find the related bold and italic fonts.
3591
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003592 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003593 :set guifont=*
3594< will bring up a font requester, where you can pick the font you want.
3595
3596 The font name depends on the GUI used. See |setting-guifont| for a
3597 way to set 'guifont' for various systems.
3598
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 For the GTK+ 2 GUI the font name looks like this: >
3600 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003601< That's all. XLFDs are not used. For Chinese this is reported to work
3602 well: >
3603 if has("gui_gtk2")
3604 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3605 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3606 endif
3607<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003608 For Mac OSX you can use something like this: >
3609 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003610< Also see 'macatsui', it can help fix display problems.
3611 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003613 width). An exception is GTK 2: all fonts are accepted, but
3614 mono-spaced fonts look best.
3615
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616 To preview a font on X11, you might be able to use the "xfontsel"
3617 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003618
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 For the Win32 GUI *E244* *E245*
3620 - takes these options in the font name:
3621 hXX - height is XX (points, can be floating-point)
3622 wXX - width is XX (points, can be floating-point)
3623 b - bold
3624 i - italic
3625 u - underline
3626 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003627 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3629 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3630 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003631 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632
3633 Use a ':' to separate the options.
3634 - A '_' can be used in the place of a space, so you don't need to use
3635 backslashes to escape the spaces.
3636 - Examples: >
3637 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3638 :set guifont=Andale_Mono:h7.5:w4.5
3639< See also |font-sizes|.
3640
3641 *'guifontset'* *'gfs'*
3642 *E250* *E252* *E234* *E597* *E598*
3643'guifontset' 'gfs' string (default "")
3644 global
3645 {not in Vi}
3646 {only available when compiled with GUI enabled and
3647 with the |+xfontset| feature}
3648 {not available in the GTK+ 2 GUI}
3649 When not empty, specifies two (or more) fonts to be used. The first
3650 one for normal English, the second one for your special language. See
3651 |xfontset|.
3652 Setting this option also means that all font names will be handled as
3653 a fontset name. Also the ones used for the "font" argument of the
3654 |:highlight| command.
3655 The fonts must match with the current locale. If fonts for the
3656 character sets that the current locale uses are not included, setting
3657 'guifontset' will fail.
3658 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3659 the comma-separated names are alternative names, one of which will be
3660 used. In 'guifontset' the whole string is one fontset name,
3661 including the commas. It is not possible to specify alternative
3662 fontset names.
3663 This example works on many X11 systems: >
3664 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3665<
3666 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3667'guifontwide' 'gfw' string (default "")
3668 global
3669 {not in Vi}
3670 {only available when compiled with GUI enabled}
3671 When not empty, specifies a comma-separated list of fonts to be used
3672 for double-width characters. The first font that can be loaded is
3673 used.
3674 Note: The size of these fonts must be exactly twice as wide as the one
3675 specified with 'guifont' and the same height.
3676
3677 All GUI versions but GTK+ 2:
3678
3679 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3680 'guifontset' is empty or invalid.
3681 When 'guifont' is set and a valid font is found in it and
3682 'guifontwide' is empty Vim will attempt to find a matching
3683 double-width font and set 'guifontwide' to it.
3684
3685 GTK+ 2 GUI only: *guifontwide_gtk2*
3686
3687 If set and valid, 'guifontwide' is always used for double width
3688 characters, even if 'encoding' is not set to "utf-8".
3689 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003690 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 font for characters not available in 'guifont'. Thus you do not need
3692 to set 'guifontwide' at all unless you want to override the choice
3693 made by Pango/Xft.
3694
Bram Moolenaar0f272122013-01-23 18:37:40 +01003695 Windows +multibyte only: *guifontwide_win_mbyte*
3696
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003697 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003698
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 *'guiheadroom'* *'ghr'*
3700'guiheadroom' 'ghr' number (default 50)
3701 global
3702 {not in Vi} {only for GTK and X11 GUI}
3703 The number of pixels subtracted from the screen height when fitting
3704 the GUI window on the screen. Set this before the GUI is started,
3705 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003706 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707 lines will be left for window decorations and other items on the
3708 screen. Set it to a negative value to allow windows taller than the
3709 screen.
3710
3711 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003712'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3713 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 global
3715 {not in Vi}
3716 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003717 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003718 sequence of letters which describes what components and options of the
3719 GUI should be used.
3720 To avoid problems with flags that are added in the future, use the
3721 "+=" and "-=" feature of ":set" |add-option-flags|.
3722
3723 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003724 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 'a' Autoselect: If present, then whenever VISUAL mode is started,
3726 or the Visual area extended, Vim tries to become the owner of
3727 the windowing system's global selection. This means that the
3728 Visually highlighted text is available for pasting into other
3729 applications as well as into Vim itself. When the Visual mode
3730 ends, possibly due to an operation on the text, or when an
3731 application wants to paste the selection, the highlighted text
3732 is automatically yanked into the "* selection register.
3733 Thus the selection is still available for pasting into other
3734 applications after the VISUAL mode has ended.
3735 If not present, then Vim won't become the owner of the
3736 windowing system's global selection unless explicitly told to
3737 by a yank or delete operation for the "* register.
3738 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003739 *'go-P'*
3740 'P' Like autoselect but using the "+ register instead of the "*
3741 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003742 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003743 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744 applies to the modeless selection.
3745
3746 'guioptions' autoselect Visual autoselect modeless ~
3747 "" - -
3748 "a" yes yes
3749 "A" - yes
3750 "aA" yes yes
3751
Bram Moolenaar02467872007-05-06 13:22:01 +00003752 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 'c' Use console dialogs instead of popup dialogs for simple
3754 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003755 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003756 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003757 'guitablabel' can be used to change the text in the labels.
3758 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003759 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003760 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003761 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762 'f' Foreground: Don't use fork() to detach the GUI from the shell
3763 where it was started. Use this for programs that wait for the
3764 editor to finish (e.g., an e-mail program). Alternatively you
3765 can use "gvim -f" or ":gui -f" to start the GUI in the
3766 foreground. |gui-fork|
3767 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003768 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003769 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3771 corner of the window. It's black&white on non-GTK, because of
3772 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003773 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003775 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003776 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003778 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 file is sourced the system menu has already been loaded; the
3780 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003781 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 'g' Grey menu items: Make menu items that are not active grey. If
3783 'g' is not included inactive menu items are not shown at all.
3784 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003785 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 't' Include tearoff menu items. Currently only works for Win32,
3787 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003788 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003789 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003790 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003791 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003793 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'R' Right-hand scrollbar is present when there is a vertically
3795 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003796 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003798 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'L' Left-hand scrollbar is present when there is a vertically
3800 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003801 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3803 the longest visible line, or on the cursor line if the 'h'
3804 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'h' Limit horizontal scrollbar size to the length of the cursor
3807 line. Reduces computations. |gui-horiz-scroll|
3808
3809 And yes, you may even have scrollbars on the left AND the right if
3810 you really want to :-). See |gui-scrollbars| for more information.
3811
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003812 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 'v' Use a vertical button layout for dialogs. When not included,
3814 a horizontal layout is preferred, but when it doesn't fit a
3815 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003816 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 'p' Use Pointer callbacks for X11 GUI. This is required for some
3818 window managers. If the cursor is not blinking or hollow at
3819 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003820 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003822 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003823 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824
Bram Moolenaar02467872007-05-06 13:22:01 +00003825
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826 *'guipty'* *'noguipty'*
3827'guipty' boolean (default on)
3828 global
3829 {not in Vi}
3830 {only available when compiled with GUI enabled}
3831 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3832 I/O to/from shell commands. See |gui-pty|.
3833
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003834 *'guitablabel'* *'gtl'*
3835'guitablabel' 'gtl' string (default empty)
3836 global
3837 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003838 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003839 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003840 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003841 pages line. When empty and when the result is empty Vim will use a
3842 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003844 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003845 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003846
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003847 Only used when the GUI tab pages line is displayed. 'e' must be
3848 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3849 used.
3850
Bram Moolenaar57657d82006-04-21 22:12:41 +00003851 *'guitabtooltip'* *'gtt'*
3852'guitabtooltip' 'gtt' string (default empty)
3853 global
3854 {not in Vi}
3855 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003856 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003857 When nonempty describes the text to use in a tooltip for the GUI tab
3858 pages line. When empty Vim will use a default tooltip.
3859 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003860 You can include a line break. Simplest method is to use |:let|: >
3861 :let &guitabtooltip = "line one\nline two"
3862<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003863
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 *'helpfile'* *'hf'*
3865'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3866 (others) "$VIMRUNTIME/doc/help.txt")
3867 global
3868 {not in Vi}
3869 Name of the main help file. All distributed help files should be
3870 placed together in one directory. Additionally, all "doc" directories
3871 in 'runtimepath' will be used.
3872 Environment variables are expanded |:set_env|. For example:
3873 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003874 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 spaces and backslashes.
3876 This option cannot be set from a |modeline| or in the |sandbox|, for
3877 security reasons.
3878
3879 *'helpheight'* *'hh'*
3880'helpheight' 'hh' number (default 20)
3881 global
3882 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003883 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 feature}
3885 Minimal initial height of the help window when it is opened with the
3886 ":help" command. The initial height of the help window is half of the
3887 current window, or (when the 'ea' option is on) the same as other
3888 windows. When the height is less than 'helpheight', the height is
3889 set to 'helpheight'. Set to zero to disable.
3890
3891 *'helplang'* *'hlg'*
3892'helplang' 'hlg' string (default: messages language or empty)
3893 global
3894 {only available when compiled with the |+multi_lang|
3895 feature}
3896 {not in Vi}
3897 Comma separated list of languages. Vim will use the first language
3898 for which the desired help can be found. The English help will always
3899 be used as a last resort. You can add "en" to prefer English over
3900 another language, but that will only find tags that exist in that
3901 language and not in the English help.
3902 Example: >
3903 :set helplang=de,it
3904< This will first search German, then Italian and finally English help
3905 files.
3906 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3907 try to find the tag in the current language before using this option.
3908 See |help-translated|.
3909
3910 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3911'hidden' 'hid' boolean (default off)
3912 global
3913 {not in Vi}
3914 When off a buffer is unloaded when it is |abandon|ed. When on a
3915 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3916 displayed in another window, it does not become hidden, of course.
3917 The commands that move through the buffer list sometimes make a buffer
3918 hidden although the 'hidden' option is off: When the buffer is
3919 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003920 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003921 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 This option is set for one command with ":hide {command}" |:hide|.
3923 WARNING: It's easy to forget that you have changes in hidden buffers.
3924 Think twice when using ":q!" or ":qa!".
3925
3926 *'highlight'* *'hl'*
3927'highlight' 'hl' string (default (as a single string):
3928 "8:SpecialKey,@:NonText,d:Directory,
3929 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003930 M:ModeMsg,n:LineNr,N:CursorLineNr,
3931 r:Question,s:StatusLine,S:StatusLineNC,
3932 c:VertSplit, t:Title,v:Visual,
3933 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 f:Folded,F:FoldColumn,A:DiffAdd,
3935 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003936 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003937 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003938 +:Pmenu,=:PmenuSel,
3939 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 global
3941 {not in Vi}
3942 This option can be used to set highlighting mode for various
3943 occasions. It is a comma separated list of character pairs. The
3944 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003945 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3947 |hl-NonText| @ '~' and '@' at the end of the window and
3948 characters from 'showbreak'
3949 |hl-Directory| d directories in CTRL-D listing and other special
3950 things in listings
3951 |hl-ErrorMsg| e error messages
3952 h (obsolete, ignored)
3953 |hl-IncSearch| i 'incsearch' highlighting
3954 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3955 |hl-MoreMsg| m |more-prompt|
3956 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003957 |hl-LineNr| n line number for ":number" and ":#" commands, and
3958 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003959 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3960 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003961 |hl-Question| r |hit-enter| prompt and yes/no questions
3962 |hl-StatusLine| s status line of current window |status-line|
3963 |hl-StatusLineNC| S status lines of not-current windows
3964 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3965 |hl-VertSplit| c column used to separate vertically split windows
3966 |hl-Visual| v Visual mode
3967 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3968 Selection" Only X11 Gui's |gui-x11| and
3969 |xterm-clipboard|.
3970 |hl-WarningMsg| w warning messages
3971 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3972 |hl-Folded| f line used for closed folds
3973 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003974 |hl-DiffAdd| A added line in diff mode
3975 |hl-DiffChange| C changed line in diff mode
3976 |hl-DiffDelete| D deleted line in diff mode
3977 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003979 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003980 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003981 |hl-SpellRare| R rare word |spell|
3982 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003983 |hl-Conceal| - the placeholders used for concealed characters
3984 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003985 |hl-Pmenu| + popup menu normal line
3986 |hl-PmenuSel| = popup menu normal line
3987 |hl-PmenuSbar| x popup menu scrollbar
3988 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003989
3990 The display modes are:
3991 r reverse (termcap entry "mr" and "me")
3992 i italic (termcap entry "ZH" and "ZR")
3993 b bold (termcap entry "md" and "me")
3994 s standout (termcap entry "so" and "se")
3995 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003996 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003997 n no highlighting
3998 - no highlighting
3999 : use a highlight group
4000 The default is used for occasions that are not included.
4001 If you want to change what the display modes do, see |dos-colors|
4002 for an example.
4003 When using the ':' display mode, this must be followed by the name of
4004 a highlight group. A highlight group can be used to define any type
4005 of highlighting, including using color. See |:highlight| on how to
4006 define one. The default uses a different group for each occasion.
4007 See |highlight-default| for the default highlight groups.
4008
4009 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4010'hlsearch' 'hls' boolean (default off)
4011 global
4012 {not in Vi}
4013 {not available when compiled without the
4014 |+extra_search| feature}
4015 When there is a previous search pattern, highlight all its matches.
4016 The type of highlighting used can be set with the 'l' occasion in the
4017 'highlight' option. This uses the "Search" highlight group by
4018 default. Note that only the matching text is highlighted, any offsets
4019 are not applied.
4020 See also: 'incsearch' and |:match|.
4021 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004022 off with |:nohlsearch|. This does not change the option value, as
4023 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004024 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 When the search pattern can match an end-of-line, Vim will try to
4026 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004027 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004029 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01004030 You can specify whether the highlight status is restored on startup
4031 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 NOTE: This option is reset when 'compatible' is set.
4033
4034 *'history'* *'hi'*
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004035'history' 'hi' number (Vim default: 50, Vi default: 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 global
4037 {not in Vi}
4038 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004039 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004041 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 NOTE: This option is set to the Vi default value when 'compatible' is
4043 set and to the Vim default value when 'compatible' is reset.
4044
4045 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4046'hkmap' 'hk' boolean (default off)
4047 global
4048 {not in Vi}
4049 {only available when compiled with the |+rightleft|
4050 feature}
4051 When on, the keyboard is mapped for the Hebrew character set.
4052 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4053 toggle this option. See |rileft.txt|.
4054 NOTE: This option is reset when 'compatible' is set.
4055
4056 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4057'hkmapp' 'hkp' boolean (default off)
4058 global
4059 {not in Vi}
4060 {only available when compiled with the |+rightleft|
4061 feature}
4062 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4063 This is useful if you have a non-Hebrew keyboard.
4064 See |rileft.txt|.
4065 NOTE: This option is reset when 'compatible' is set.
4066
4067 *'icon'* *'noicon'*
4068'icon' boolean (default off, on when title can be restored)
4069 global
4070 {not in Vi}
4071 {not available when compiled without the |+title|
4072 feature}
4073 When on, the icon text of the window will be set to the value of
4074 'iconstring' (if it is not empty), or to the name of the file
4075 currently being edited. Only the last part of the name is used.
4076 Overridden by the 'iconstring' option.
4077 Only works if the terminal supports setting window icons (currently
4078 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4079 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4080 builtin termcap).
4081 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004082 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004084 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 *'iconstring'*
4087'iconstring' string (default "")
4088 global
4089 {not in Vi}
4090 {not available when compiled without the |+title|
4091 feature}
4092 When this option is not empty, it will be used for the icon text of
4093 the window. This happens only when the 'icon' option is on.
4094 Only works if the terminal supports setting window icon text
4095 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4096 Does not work for MS Windows.
4097 When Vim was compiled with HAVE_X11 defined, the original icon will be
4098 restored if possible |X11|.
4099 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004100 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 'titlestring' for example settings.
4102 {not available when compiled without the |+statusline| feature}
4103
4104 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4105'ignorecase' 'ic' boolean (default off)
4106 global
4107 Ignore case in search patterns. Also used when searching in the tags
4108 file.
4109 Also see 'smartcase'.
4110 Can be overruled by using "\c" or "\C" in the pattern, see
4111 |/ignorecase|.
4112
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004113 *'imactivatefunc'* *'imaf'*
4114'imactivatefunc' 'imaf' string (default "")
4115 global
4116 {not in Vi}
4117 {only available when compiled with |+xim| and
4118 |+GUI_GTK|}
4119 This option specifies a function that will be called to
4120 activate/inactivate Input Method.
4121
4122 Example: >
4123 function ImActivateFunc(active)
4124 if a:active
4125 ... do something
4126 else
4127 ... do something
4128 endif
4129 " return value is not used
4130 endfunction
4131 set imactivatefunc=ImActivateFunc
4132<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 *'imactivatekey'* *'imak'*
4134'imactivatekey' 'imak' string (default "")
4135 global
4136 {not in Vi}
4137 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004138 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004139 Specifies the key that your Input Method in X-Windows uses for
4140 activation. When this is specified correctly, vim can fully control
4141 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4142 You can't use this option to change the activation key, the option
4143 tells Vim what the key is.
4144 Format:
4145 [MODIFIER_FLAG-]KEY_STRING
4146
4147 These characters can be used for MODIFIER_FLAG (case is ignored):
4148 S Shift key
4149 L Lock key
4150 C Control key
4151 1 Mod1 key
4152 2 Mod2 key
4153 3 Mod3 key
4154 4 Mod4 key
4155 5 Mod5 key
4156 Combinations are allowed, for example "S-C-space" or "SC-space" are
4157 both shift+ctrl+space.
4158 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4159
4160 Example: >
4161 :set imactivatekey=S-space
4162< "S-space" means shift+space. This is the activation key for kinput2 +
4163 canna (Japanese), and ami (Korean).
4164
4165 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4166'imcmdline' 'imc' boolean (default off)
4167 global
4168 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004169 {only available when compiled with the |+xim|,
4170 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 When set the Input Method is always on when starting to edit a command
4172 line, unless entering a search pattern (see 'imsearch' for that).
4173 Setting this option is useful when your input method allows entering
4174 English characters directly, e.g., when it's used to type accented
4175 characters with dead keys.
4176
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004177 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4179 global
4180 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004181 {only available when compiled with the |+xim|,
4182 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 When set the Input Method is never used. This is useful to disable
4184 the IM when it doesn't work properly.
4185 Currently this option is on by default for SGI/IRIX machines. This
4186 may change in later releases.
4187
4188 *'iminsert'* *'imi'*
4189'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4190 local to buffer
4191 {not in Vi}
4192 Specifies whether :lmap or an Input Method (IM) is to be used in
4193 Insert mode. Valid values:
4194 0 :lmap is off and IM is off
4195 1 :lmap is ON and IM is off
4196 2 :lmap is off and IM is ON
4197 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4198 or |global-ime|.
4199 To always reset the option to zero when leaving Insert mode with <Esc>
4200 this can be used: >
4201 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4202< This makes :lmap and IM turn off automatically when leaving Insert
4203 mode.
4204 Note that this option changes when using CTRL-^ in Insert mode
4205 |i_CTRL-^|.
4206 The value is set to 1 when setting 'keymap' to a valid keymap name.
4207 It is also used for the argument of commands like "r" and "f".
4208 The value 0 may not work correctly with Athena and Motif with some XIM
4209 methods. Use 'imdisable' to disable XIM then.
4210
4211 *'imsearch'* *'ims'*
4212'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4213 local to buffer
4214 {not in Vi}
4215 Specifies whether :lmap or an Input Method (IM) is to be used when
4216 entering a search pattern. Valid values:
4217 -1 the value of 'iminsert' is used, makes it look like
4218 'iminsert' is also used when typing a search pattern
4219 0 :lmap is off and IM is off
4220 1 :lmap is ON and IM is off
4221 2 :lmap is off and IM is ON
4222 Note that this option changes when using CTRL-^ in Command-line mode
4223 |c_CTRL-^|.
4224 The value is set to 1 when it is not -1 and setting the 'keymap'
4225 option to a valid keymap name.
4226 The value 0 may not work correctly with Athena and Motif with some XIM
4227 methods. Use 'imdisable' to disable XIM then.
4228
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004229 *'imstatusfunc'* *'imsf'*
4230'imstatusfunc' 'imsf' string (default "")
4231 global
4232 {not in Vi}
4233 {only available when compiled with |+xim| and
4234 |+GUI_GTK|}
4235 This option specifies a function that is called to obtain the status
4236 of Input Method. It must return a positive number when IME is active.
4237
4238 Example: >
4239 function ImStatusFunc()
4240 let is_active = ...do something
4241 return is_active ? 1 : 0
4242 endfunction
4243 set imstatusfunc=ImStatusFunc
4244<
4245 NOTE: This function is invoked very often. Keep it fast.
4246
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247 *'include'* *'inc'*
4248'include' 'inc' string (default "^\s*#\s*include")
4249 global or local to buffer |global-local|
4250 {not in Vi}
4251 {not available when compiled without the
4252 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004253 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 pattern, just like for the "/" command (See |pattern|). The default
4255 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004256 "]I", "[d", etc.
4257 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004258 comes after the matched pattern. But if "\zs" appears in the pattern
4259 then the text matched from "\zs" to the end, or until "\ze" if it
4260 appears, is used as the file name. Use this to include characters
4261 that are not in 'isfname', such as a space. You can then use
4262 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004263 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264
4265 *'includeexpr'* *'inex'*
4266'includeexpr' 'inex' string (default "")
4267 local to buffer
4268 {not in Vi}
4269 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004270 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004272 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 :set includeexpr=substitute(v:fname,'\\.','/','g')
4274< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004277 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 Also used for |<cfile>|.
4279
Bram Moolenaar30b65812012-07-12 22:01:11 +02004280 The expression will be evaluated in the |sandbox| when set from a
4281 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004282
4283 It is not allowed to change text or jump to another window while
4284 evaluating 'includeexpr' |textlock|.
4285
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4287'incsearch' 'is' boolean (default off)
4288 global
4289 {not in Vi}
4290 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004291 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004292 While typing a search command, show where the pattern, as it was typed
4293 so far, matches. The matched string is highlighted. If the pattern
4294 is invalid or not found, nothing is shown. The screen will be updated
4295 often, this is only useful on fast terminals.
4296 Note that the match will be shown, but the cursor will return to its
4297 original position when no match is found and when pressing <Esc>. You
4298 still need to finish the search command with <Enter> to move the
4299 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004300 When compiled with the |+reltime| feature Vim only searches for about
4301 half a second. With a complicated pattern and/or a lot of text the
4302 match may not be found. This is to avoid that Vim hangs while you
4303 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004304 The highlighting can be set with the 'i' flag in 'highlight'.
4305 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004306 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004307 to the command line. If 'ignorecase' and 'smartcase' are set and the
4308 command line has no uppercase characters, the added character is
4309 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004310 CTRL-R CTRL-W can be used to add the word at the end of the current
4311 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 NOTE: This option is reset when 'compatible' is set.
4313
4314 *'indentexpr'* *'inde'*
4315'indentexpr' 'inde' string (default "")
4316 local to buffer
4317 {not in Vi}
4318 {not available when compiled without the |+cindent|
4319 or |+eval| features}
4320 Expression which is evaluated to obtain the proper indent for a line.
4321 It is used when a new line is created, for the |=| operator and
4322 in Insert mode as specified with the 'indentkeys' option.
4323 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004324 'smartindent' indenting. When 'lisp' is set, this option is
4325 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326 When 'paste' is set this option is not used for indenting.
4327 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004328 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 when the expression is evaluated (but it may be moved around).
4330 The expression must return the number of spaces worth of indent. It
4331 can return "-1" to keep the current indent (this means 'autoindent' is
4332 used for the indent).
4333 Functions useful for computing the indent are |indent()|, |cindent()|
4334 and |lispindent()|.
4335 The evaluation of the expression must not have side effects! It must
4336 not change the text, jump to another window, etc. Afterwards the
4337 cursor position is always restored, thus the cursor may be moved.
4338 Normally this option would be set to call a function: >
4339 :set indentexpr=GetMyIndent()
4340< Error messages will be suppressed, unless the 'debug' option contains
4341 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004342 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004343 NOTE: This option is made empty when 'compatible' is set.
4344
Bram Moolenaar30b65812012-07-12 22:01:11 +02004345 The expression will be evaluated in the |sandbox| when set from a
4346 modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004347
4348 It is not allowed to change text or jump to another window while
4349 evaluating 'indentexpr' |textlock|.
4350
4351
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 *'indentkeys'* *'indk'*
4353'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4354 local to buffer
4355 {not in Vi}
4356 {not available when compiled without the |+cindent|
4357 feature}
4358 A list of keys that, when typed in Insert mode, cause reindenting of
4359 the current line. Only happens if 'indentexpr' isn't empty.
4360 The format is identical to 'cinkeys', see |indentkeys-format|.
4361 See |C-indenting| and |indent-expression|.
4362
4363 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4364'infercase' 'inf' boolean (default off)
4365 local to buffer
4366 {not in Vi}
4367 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004368 'ignorecase' is also on, the case of the match is adjusted depending
4369 on the typed text. If the typed text contains a lowercase letter
4370 where the match has an upper case letter, the completed part is made
4371 lowercase. If the typed text has no lowercase letters and the match
4372 has a lowercase letter where the typed text has an uppercase letter,
4373 and there is a letter before it, the completed part is made uppercase.
4374 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4377'insertmode' 'im' boolean (default off)
4378 global
4379 {not in Vi}
4380 Makes Vim work in a way that Insert mode is the default mode. Useful
4381 if you want to use Vim as a modeless editor. Used for |evim|.
4382 These Insert mode commands will be useful:
4383 - Use the cursor keys to move around.
4384 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4385 this is a mapping, it is executed as if 'insertmode' was off.
4386 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004388 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4389 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390
4391 These items change when 'insertmode' is set:
4392 - when starting to edit of a file, Vim goes to Insert mode.
4393 - <Esc> in Insert mode is a no-op and beeps.
4394 - <Esc> in Normal mode makes Vim go to Insert mode.
4395 - CTRL-L in Insert mode is a command, it is not inserted.
4396 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4397 However, when <Esc> is used inside a mapping, it behaves like
4398 'insertmode' was not set. This was done to be able to use the same
4399 mappings with 'insertmode' set or not set.
4400 When executing commands with |:normal| 'insertmode' is not used.
4401
4402 NOTE: This option is reset when 'compatible' is set.
4403
4404 *'isfname'* *'isf'*
4405'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4406 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4407 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4408 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4409 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4410 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4411 global
4412 {not in Vi}
4413 The characters specified by this option are included in file names and
4414 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004415 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416 Multi-byte characters 256 and above are always included, only the
4417 characters up to 255 are specified with this option.
4418 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004419 Think twice before adding white space to this option. Although a
4420 space may appear inside a file name, the effect will be that Vim
4421 doesn't know where a file name starts or ends when doing completion.
4422 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423
4424 Note that on systems using a backslash as path separator, Vim tries to
4425 do its best to make it work as you would expect. That is a bit
4426 tricky, since Vi originally used the backslash to escape special
4427 characters. Vim will not remove a backslash in front of a normal file
4428 name character on these systems, but it will on Unix and alikes. The
4429 '&' and '^' are not included by default, because these are special for
4430 cmd.exe.
4431
4432 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004433 Each part can be a single character number or a range. A range is two
4434 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004435 decimal number between 0 and 255 or the ASCII character itself (does
4436 not work for digits). Example:
4437 "_,-,128-140,#-43" (include '_' and '-' and the range
4438 128 to 140 and '#' to 43)
4439 If a part starts with '^', the following character number or range
4440 will be excluded from the option. The option is interpreted from left
4441 to right. Put the excluded character after the range where it is
4442 included. To include '^' itself use it as the last character of the
4443 option or the end of a range. Example:
4444 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4445 If the character is '@', all characters where isalpha() returns TRUE
4446 are included. Normally these are the characters a to z and A to Z,
4447 plus accented characters. To include '@' itself use "@-@". Examples:
4448 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004449 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 "a-z,A-Z,@-@" All letters plus the '@' character.
4451 A comma can be included by using it where a character number is
4452 expected. Example:
4453 "48-57,,,_" Digits, comma and underscore.
4454 A comma can be excluded by prepending a '^'. Example:
4455 " -~,^,,9" All characters from space to '~', excluding
4456 comma, plus <Tab>.
4457 See |option-backslash| about including spaces and backslashes.
4458
4459 *'isident'* *'isi'*
4460'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4461 "@,48-57,_,128-167,224-235"
4462 otherwise: "@,48-57,_,192-255")
4463 global
4464 {not in Vi}
4465 The characters given by this option are included in identifiers.
4466 Identifiers are used in recognizing environment variables and after a
4467 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004468 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469 option.
4470 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004471 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4473
4474 *'iskeyword'* *'isk'*
4475'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4476 "@,48-57,_,128-167,224-235"
4477 otherwise: "@,48-57,_,192-255"
4478 Vi default: "@,48-57,_")
4479 local to buffer
4480 {not in Vi}
4481 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004482 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 'isfname' for a description of the format of this option. For C
4484 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4485 For a help file it is set to all non-blank printable characters except
4486 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4487 command).
4488 When the 'lisp' option is on the '-' character is always included.
4489 NOTE: This option is set to the Vi default value when 'compatible' is
4490 set and to the Vim default value when 'compatible' is reset.
4491
4492 *'isprint'* *'isp'*
4493'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4494 "@,~-255"; otherwise: "@,161-255")
4495 global
4496 {not in Vi}
4497 The characters given by this option are displayed directly on the
4498 screen. It is also used for "\p" in a |pattern|. The characters from
4499 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4500 even when they are not included in 'isprint' or excluded. See
4501 'isfname' for a description of the format of this option.
4502
4503 Non-printable characters are displayed with two characters:
4504 0 - 31 "^@" - "^_"
4505 32 - 126 always single characters
4506 127 "^?"
4507 128 - 159 "~@" - "~_"
4508 160 - 254 "| " - "|~"
4509 255 "~?"
4510 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4511 displayed as <xx>, with the hexadecimal value of the byte.
4512 When 'display' contains "uhex" all unprintable characters are
4513 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004514 The SpecialKey highlighting will be used for unprintable characters.
4515 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004516
4517 Multi-byte characters 256 and above are always included, only the
4518 characters up to 255 are specified with this option. When a character
4519 is printable but it is not available in the current font, a
4520 replacement character will be shown.
4521 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4522 There is no option to specify these characters.
4523
4524 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4525'joinspaces' 'js' boolean (default on)
4526 global
4527 {not in Vi}
4528 Insert two spaces after a '.', '?' and '!' with a join command.
4529 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4530 Otherwise only one space is inserted.
4531 NOTE: This option is set when 'compatible' is set.
4532
4533 *'key'*
4534'key' string (default "")
4535 local to buffer
4536 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004537 {only available when compiled with the |+cryptv|
4538 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004540 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 Careful: Do not set the key value by hand, someone might see the typed
4542 key. Use the |:X| command. But you can make 'key' empty: >
4543 :set key=
4544< It is not possible to get the value of this option with ":set key" or
4545 "echo &key". This is to avoid showing it to someone who shouldn't
4546 know. It also means you cannot see it yourself once you have set it,
4547 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004548 You can use "&key" in an expression to detect whether encryption is
4549 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550
4551 *'keymap'* *'kmp'* *E544*
4552'keymap' 'kmp' string (default "")
4553 local to buffer
4554 {not in Vi}
4555 {only available when compiled with the |+keymap|
4556 feature}
4557 Name of a keyboard mapping. See |mbyte-keymap|.
4558 Setting this option to a valid keymap name has the side effect of
4559 setting 'iminsert' to one, so that the keymap becomes effective.
4560 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004561 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
4563 *'keymodel'* *'km'*
4564'keymodel' 'km' string (default "")
4565 global
4566 {not in Vi}
4567 List of comma separated words, which enable special things that keys
4568 can do. These values can be used:
4569 startsel Using a shifted special key starts selection (either
4570 Select mode or Visual mode, depending on "key" being
4571 present in 'selectmode').
4572 stopsel Using a not-shifted special key stops selection.
4573 Special keys in this context are the cursor keys, <End>, <Home>,
4574 <PageUp> and <PageDown>.
4575 The 'keymodel' option is set by the |:behave| command.
4576
4577 *'keywordprg'* *'kp'*
4578'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4579 OS/2: "view /", VMS: "help")
4580 global or local to buffer |global-local|
4581 {not in Vi}
4582 Program to use for the |K| command. Environment variables are
4583 expanded |:set_env|. ":help" may be used to access the Vim internal
4584 help. (Note that previously setting the global option to the empty
4585 value did this, which is now deprecated.)
4586 When "man" is used, Vim will automatically translate a count for the
4587 "K" command to a section number. Also for "man -s", in which case the
4588 "-s" is removed when there is no count.
4589 See |option-backslash| about including spaces and backslashes.
4590 Example: >
4591 :set keywordprg=man\ -s
4592< This option cannot be set from a |modeline| or in the |sandbox|, for
4593 security reasons.
4594
4595 *'langmap'* *'lmap'* *E357* *E358*
4596'langmap' 'lmap' string (default "")
4597 global
4598 {not in Vi}
4599 {only available when compiled with the |+langmap|
4600 feature}
4601 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004602 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 inserted directly. When in command mode the 'langmap' option takes
4604 care of translating these special characters to the original meaning
4605 of the key. This means you don't have to change the keyboard mode to
4606 be able to execute Normal mode commands.
4607 This is the opposite of the 'keymap' option, where characters are
4608 mapped in Insert mode.
Bram Moolenaarc2299672014-11-13 14:25:38 +01004609 Also consider setting 'langnoremap' to avoid 'langmap' applies to
4610 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004611 This option cannot be set from a |modeline| or in the |sandbox|, for
4612 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004613
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004614 Example (for Greek, in UTF-8): *greek* >
4615 :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 +00004616< Example (exchanges meaning of z and y for commands): >
4617 :set langmap=zy,yz,ZY,YZ
4618<
4619 The 'langmap' option is a list of parts, separated with commas. Each
4620 part can be in one of two forms:
4621 1. A list of pairs. Each pair is a "from" character immediately
4622 followed by the "to" character. Examples: "aA", "aAbBcC".
4623 2. A list of "from" characters, a semi-colon and a list of "to"
4624 characters. Example: "abc;ABC"
4625 Example: "aA,fgh;FGH,cCdDeE"
4626 Special characters need to be preceded with a backslash. These are
4627 ";", ',' and backslash itself.
4628
4629 This will allow you to activate vim actions without having to switch
4630 back and forth between the languages. Your language characters will
4631 be understood as normal vim English characters (according to the
4632 langmap mappings) in the following cases:
4633 o Normal/Visual mode (commands, buffer/register names, user mappings)
4634 o Insert/Replace Mode: Register names after CTRL-R
4635 o Insert/Replace Mode: Mappings
4636 Characters entered in Command-line mode will NOT be affected by
4637 this option. Note that this option can be changed at any time
4638 allowing to switch between mappings for different languages/encodings.
4639 Use a mapping to avoid having to type it each time!
4640
4641 *'langmenu'* *'lm'*
4642'langmenu' 'lm' string (default "")
4643 global
4644 {not in Vi}
4645 {only available when compiled with the |+menu| and
4646 |+multi_lang| features}
4647 Language to use for menu translation. Tells which file is loaded
4648 from the "lang" directory in 'runtimepath': >
4649 "lang/menu_" . &langmenu . ".vim"
4650< (without the spaces). For example, to always use the Dutch menus, no
4651 matter what $LANG is set to: >
4652 :set langmenu=nl_NL.ISO_8859-1
4653< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004654 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 If your $LANG is set to a non-English language but you do want to use
4656 the English menus: >
4657 :set langmenu=none
4658< This option must be set before loading menus, switching on filetype
4659 detection or syntax highlighting. Once the menus are defined setting
4660 this option has no effect. But you could do this: >
4661 :source $VIMRUNTIME/delmenu.vim
4662 :set langmenu=de_DE.ISO_8859-1
4663 :source $VIMRUNTIME/menu.vim
4664< Warning: This deletes all menus that you defined yourself!
4665
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004666 *'langnoremap'* *'lnr'*
4667'langnoremap' 'lnr' boolean (default off)
4668 global
4669 {not in Vi}
4670 {only available when compiled with the |+langmap|
4671 feature}
4672 When on, setting 'langmap' does not apply to characters resulting from
4673 a mapping. This basically means, if you noticed that setting
4674 'langmap' disables some of your mappings, try setting this option.
4675 This option defaults to off for backwards compatibility. Set it on if
4676 that works for you to avoid mappings to break.
4677
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 *'laststatus'* *'ls'*
4679'laststatus' 'ls' number (default 1)
4680 global
4681 {not in Vi}
4682 The value of this option influences when the last window will have a
4683 status line:
4684 0: never
4685 1: only if there are at least two windows
4686 2: always
4687 The screen looks nicer with a status line if you have several
4688 windows, but it takes another screen line. |status-line|
4689
4690 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4691'lazyredraw' 'lz' boolean (default off)
4692 global
4693 {not in Vi}
4694 When this option is set, the screen will not be redrawn while
4695 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004696 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697 update use |:redraw|.
4698
4699 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4700'linebreak' 'lbr' boolean (default off)
4701 local to window
4702 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004703 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004705 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 than at the last character that fits on the screen. Unlike
4707 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004708 it only affects the way the file is displayed, not its contents.
4709 If 'breakindent' is set, line is visually indented. Then, the value
4710 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004711 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 Note that <Tab> characters after an <EOL> are mostly not displayed
4713 with the right amount of white space.
4714
4715 *'lines'* *E593*
4716'lines' number (default 24 or terminal height)
4717 global
4718 Number of lines of the Vim window.
4719 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004720 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 When Vim is running in the GUI or in a resizable window, setting this
4722 option will cause the window size to be changed. When you only want
4723 to use the size for the GUI, put the command in your |gvimrc| file.
4724 Vim limits the number of lines to what fits on the screen. You can
4725 use this command to get the tallest window possible: >
4726 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004727< Minimum value is 2, maximum value is 1000.
4728 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 When you set this option and Vim is unable to change the physical
4730 number of lines of the display, the display may be messed up.
4731
4732 *'linespace'* *'lsp'*
4733'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4734 global
4735 {not in Vi}
4736 {only in the GUI}
4737 Number of pixel lines inserted between characters. Useful if the font
4738 uses the full character cell height, making lines touch each other.
4739 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004740 With some fonts there can be too much room between lines (to have
4741 space for ascents and descents). Then it makes sense to set
4742 'linespace' to a negative value. This may cause display problems
4743 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744
4745 *'lisp'* *'nolisp'*
4746'lisp' boolean (default off)
4747 local to buffer
4748 {not available when compiled without the |+lispindent|
4749 feature}
4750 Lisp mode: When <Enter> is typed in insert mode set the indent for
4751 the next line to Lisp standards (well, sort of). Also happens with
4752 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4753 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4754 better. Also see 'lispwords'.
4755 The '-' character is included in keyword characters. Redefines the
4756 "=" operator to use this same indentation algorithm rather than
4757 calling an external program if 'equalprg' is empty.
4758 This option is not used when 'paste' is set.
4759 {Vi: Does it a little bit differently}
4760
4761 *'lispwords'* *'lw'*
4762'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004763 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004764 {not in Vi}
4765 {not available when compiled without the |+lispindent|
4766 feature}
4767 Comma separated list of words that influence the Lisp indenting.
4768 |'lisp'|
4769
4770 *'list'* *'nolist'*
4771'list' boolean (default off)
4772 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004773 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4774 line. Useful to see the difference between tabs and spaces and for
4775 trailing blanks. Further changed by the 'listchars' option.
4776
4777 The cursor is displayed at the start of the space a Tab character
4778 occupies, not at the end as usual in Normal mode. To get this cursor
4779 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004780 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004781<
4782 Note that list mode will also affect formatting (set with 'textwidth'
4783 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004784 changing the way tabs are displayed.
4785
4786 *'listchars'* *'lcs'*
4787'listchars' 'lcs' string (default "eol:$")
4788 global
4789 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004790 Strings to use in 'list' mode and for the |:list| command. It is a
4791 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004792 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793 eol:c Character to show at the end of each line. When
4794 omitted, there is no extra character at the end of the
4795 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004796 *lcs-tab*
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004797 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004799 fill the space that the tab normally occupies.
4800 "tab:>-" will show a tab that takes four spaces as
4801 ">---". When omitted, a tab is show as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004802 *lcs-space*
4803 space:c Character to show for a space. When omitted, spaces
4804 are left blank.
4805 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004806 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004807 trailing spaces are blank. Overrides the "space"
4808 setting for trailing spaces.
4809 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004810 extends:c Character to show in the last column, when 'wrap' is
4811 off and the line continues beyond the right of the
4812 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004813 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004814 precedes:c Character to show in the first column, when 'wrap'
4815 is off and there is text preceding the character
4816 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004817 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004818 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004819 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004820 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004821 nbsp:c Character to show for a non-breakable space character
4822 (0xA0 (160 decimal) and U+202F). Left blank when
4823 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004824
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004827 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828
4829 Examples: >
4830 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004831 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 :set lcs=extends:>,precedes:<
4833< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004834 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004835 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004836
4837 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4838'loadplugins' 'lpl' boolean (default on)
4839 global
4840 {not in Vi}
4841 When on the plugin scripts are loaded when starting up |load-plugins|.
4842 This option can be reset in your |vimrc| file to disable the loading
4843 of plugins.
4844 Note that using the "-u NONE" and "--noplugin" command line arguments
4845 reset this option. |-u| |--noplugin|
4846
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004847 *'macatsui'* *'nomacatsui'*
4848'macatsui' boolean (default on)
4849 global
4850 {only available in Mac GUI version}
4851 This is a workaround for when drawing doesn't work properly. When set
4852 and compiled with multi-byte support ATSUI text drawing is used. When
4853 not set ATSUI text drawing is not used. Switch this option off when
4854 you experience drawing problems. In a future version the problems may
4855 be solved and this option becomes obsolete. Therefore use this method
4856 to unset it: >
4857 if exists('&macatsui')
4858 set nomacatsui
4859 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004860< Another option to check if you have drawing problems is
4861 'termencoding'.
4862
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 *'magic'* *'nomagic'*
4864'magic' boolean (default on)
4865 global
4866 Changes the special characters that can be used in search patterns.
4867 See |pattern|.
4868 NOTE: To avoid portability problems with using patterns, always keep
4869 this option at the default "on". Only switch it off when working with
4870 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004871 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872
4873 *'makeef'* *'mef'*
4874'makeef' 'mef' string (default: "")
4875 global
4876 {not in Vi}
4877 {not available when compiled without the |+quickfix|
4878 feature}
4879 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4880 and the |:grep| command.
4881 When it is empty, an internally generated temp file will be used.
4882 When "##" is included, it is replaced by a number to make the name
4883 unique. This makes sure that the ":make" command doesn't overwrite an
4884 existing file.
4885 NOT used for the ":cf" command. See 'errorfile' for that.
4886 Environment variables are expanded |:set_env|.
4887 See |option-backslash| about including spaces and backslashes.
4888 This option cannot be set from a |modeline| or in the |sandbox|, for
4889 security reasons.
4890
4891 *'makeprg'* *'mp'*
4892'makeprg' 'mp' string (default "make", VMS: "MMS")
4893 global or local to buffer |global-local|
4894 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004895 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar26df0922014-02-23 23:39:13 +01004896 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4897 which are expanded to the current and alternate file name. Use |::S|
4898 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004899 Environment variables are expanded |:set_env|. See |option-backslash|
4900 about including spaces and backslashes.
4901 Note that a '|' must be escaped twice: once for ":set" and once for
4902 the interpretation of a command. When you use a filter called
4903 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 :set makeprg=gmake\ \\\|\ myfilter
4905< The placeholder "$*" can be given (even multiple times) to specify
4906 where the arguments will be included, for example: >
4907 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4908< This option cannot be set from a |modeline| or in the |sandbox|, for
4909 security reasons.
4910
4911 *'matchpairs'* *'mps'*
4912'matchpairs' 'mps' string (default "(:),{:},[:]")
4913 local to buffer
4914 {not in Vi}
4915 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004916 other.
4917 Only character pairs are allowed that are different, thus you cannot
4918 jump between two double quotes.
4919 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004920 The pairs must be separated by a comma. Example for including '<' and
4921 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 :set mps+=<:>
4923
4924< A more exotic example, to jump between the '=' and ';' in an
4925 assignment, useful for languages like C and Java: >
4926 :au FileType c,cpp,java set mps+==:;
4927
4928< For a more advanced way of using "%", see the matchit.vim plugin in
4929 the $VIMRUNTIME/macros directory. |add-local-help|
4930
4931 *'matchtime'* *'mat'*
4932'matchtime' 'mat' number (default 5)
4933 global
4934 {not in Vi}{in Nvi}
4935 Tenths of a second to show the matching paren, when 'showmatch' is
4936 set. Note that this is not in milliseconds, like other options that
4937 set a time. This is to be compatible with Nvi.
4938
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004939 *'maxcombine'* *'mco'*
4940'maxcombine' 'mco' number (default 2)
4941 global
4942 {not in Vi}
4943 {only available when compiled with the |+multi_byte|
4944 feature}
4945 The maximum number of combining characters supported for displaying.
4946 Only used when 'encoding' is "utf-8".
4947 The default is OK for most languages. Hebrew may require 4.
4948 Maximum value is 6.
4949 Even when this option is set to 2 you can still edit text with more
4950 combining characters, you just can't see them. Use |g8| or |ga|.
4951 See |mbyte-combining|.
4952
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953 *'maxfuncdepth'* *'mfd'*
4954'maxfuncdepth' 'mfd' number (default 100)
4955 global
4956 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004957 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004958 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 Maximum depth of function calls for user functions. This normally
4960 catches endless recursion. When using a recursive function with
4961 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4962 more memory, there is the danger of failing when memory is exhausted.
4963 See also |:function|.
4964
4965 *'maxmapdepth'* *'mmd'* *E223*
4966'maxmapdepth' 'mmd' number (default 1000)
4967 global
4968 {not in Vi}
4969 Maximum number of times a mapping is done without resulting in a
4970 character to be used. This normally catches endless mappings, like
4971 ":map x y" with ":map y x". It still does not catch ":map g wg",
4972 because the 'w' is used before the next mapping is done. See also
4973 |key-mapping|.
4974
4975 *'maxmem'* *'mm'*
4976'maxmem' 'mm' number (default between 256 to 5120 (system
4977 dependent) or half the amount of memory
4978 available)
4979 global
4980 {not in Vi}
4981 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4982 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004983 other memory to be freed. The maximum usable value is about 2000000.
4984 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004986 *'maxmempattern'* *'mmp'*
4987'maxmempattern' 'mmp' number (default 1000)
4988 global
4989 {not in Vi}
4990 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004991 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004992 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004993 When Vim runs into the limit it gives an error message and mostly
4994 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004995 Running into the limit often means that the pattern is very
4996 inefficient or too complex. This may already happen with the pattern
4997 "\(.\)*" on a very long line. ".*" works much better.
4998 Vim may run out of memory before hitting the 'maxmempattern' limit.
4999
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 *'maxmemtot'* *'mmt'*
5001'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5002 dependent) or half the amount of memory
5003 available)
5004 global
5005 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005006 Maximum amount of memory in Kbyte to use for all buffers together.
5007 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
5008 without a limit. On 64 bit machines higher values might work. But
5009 hey, do you really need more than 2 Gbyte for text editing?
5010 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011
5012 *'menuitems'* *'mis'*
5013'menuitems' 'mis' number (default 25)
5014 global
5015 {not in Vi}
5016 {not available when compiled without the |+menu|
5017 feature}
5018 Maximum number of items to use in a menu. Used for menus that are
5019 generated from a list of items, e.g., the Buffers menu. Changing this
5020 option has no direct effect, the menu must be refreshed first.
5021
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005022 *'mkspellmem'* *'msm'*
5023'mkspellmem' 'msm' string (default "460000,2000,500")
5024 global
5025 {not in Vi}
5026 {not available when compiled without the |+syntax|
5027 feature}
5028 Parameters for |:mkspell|. This tunes when to start compressing the
5029 word tree. Compression can be slow when there are many words, but
5030 it's needed to avoid running out of memory. The amount of memory used
5031 per word depends very much on how similar the words are, that's why
5032 this tuning is complicated.
5033
5034 There are three numbers, separated by commas:
5035 {start},{inc},{added}
5036
5037 For most languages the uncompressed word tree fits in memory. {start}
5038 gives the amount of memory in Kbyte that can be used before any
5039 compression is done. It should be a bit smaller than the amount of
5040 memory that is available to Vim.
5041
5042 When going over the {start} limit the {inc} number specifies the
5043 amount of memory in Kbyte that can be allocated before another
5044 compression is done. A low number means compression is done after
5045 less words are added, which is slow. A high number means more memory
5046 will be allocated.
5047
5048 After doing compression, {added} times 1024 words can be added before
5049 the {inc} limit is ignored and compression is done when any extra
5050 amount of memory is needed. A low number means there is a smaller
5051 chance of hitting the {inc} limit, less memory is used but it's
5052 slower.
5053
5054 The languages for which these numbers are important are Italian and
5055 Hungarian. The default works for when you have about 512 Mbyte. If
5056 you have 1 Gbyte you could use: >
5057 :set mkspellmem=900000,3000,800
5058< If you have less than 512 Mbyte |:mkspell| may fail for some
5059 languages, no matter what you set 'mkspellmem' to.
5060
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005062'modeline' 'ml' boolean (Vim default: on (off for root),
5063 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005064 local to buffer
5065 *'modelines'* *'mls'*
5066'modelines' 'mls' number (default 5)
5067 global
5068 {not in Vi}
5069 If 'modeline' is on 'modelines' gives the number of lines that is
5070 checked for set commands. If 'modeline' is off or 'modelines' is zero
5071 no lines are checked. See |modeline|.
5072 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5073 set and to the Vim default value when 'compatible' is reset.
5074
5075 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
5076'modifiable' 'ma' boolean (default on)
5077 local to buffer
5078 {not in Vi} *E21*
5079 When off the buffer contents cannot be changed. The 'fileformat' and
5080 'fileencoding' options also can't be changed.
5081 Can be reset with the |-M| command line argument.
5082
5083 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5084'modified' 'mod' boolean (default off)
5085 local to buffer
5086 {not in Vi}
5087 When on, the buffer is considered to be modified. This option is set
5088 when:
5089 1. A change was made to the text since it was last written. Using the
5090 |undo| command to go back to the original text will reset the
5091 option. But undoing changes that were made before writing the
5092 buffer will set the option again, since the text is different from
5093 when it was written.
5094 2. 'fileformat' or 'fileencoding' is different from its original
5095 value. The original value is set when the buffer is read or
5096 written. A ":set nomodified" command also resets the original
5097 values to the current values and the 'modified' option will be
5098 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005099 This option is not set when a change is made to the buffer as the
5100 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5101 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5102 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5104 will be ignored.
5105
5106 *'more'* *'nomore'*
5107'more' boolean (Vim default: on, Vi default: off)
5108 global
5109 {not in Vi}
5110 When on, listings pause when the whole screen is filled. You will get
5111 the |more-prompt|. When this option is off there are no pauses, the
5112 listing continues until finished.
5113 NOTE: This option is set to the Vi default value when 'compatible' is
5114 set and to the Vim default value when 'compatible' is reset.
5115
5116 *'mouse'* *E538*
5117'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
5118 global
5119 {not in Vi}
5120 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005121 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5122 sysmouse and Linux console with gpm). For using the mouse in the
5123 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 The mouse can be enabled for different modes:
5125 n Normal mode
5126 v Visual mode
5127 i Insert mode
5128 c Command-line mode
5129 h all previous modes when editing a help file
5130 a all previous modes
5131 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132 Normally you would enable the mouse in all four modes with: >
5133 :set mouse=a
5134< When the mouse is not enabled, the GUI will still use the mouse for
5135 modeless selection. This doesn't move the text cursor.
5136
5137 See |mouse-using|. Also see |'clipboard'|.
5138
5139 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005140 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 the mouse buttons can still be used by keeping the shift key pressed.
5142 Also see the 'clipboard' option.
5143
5144 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5145'mousefocus' 'mousef' boolean (default off)
5146 global
5147 {not in Vi}
5148 {only works in the GUI}
5149 The window that the mouse pointer is on is automatically activated.
5150 When changing the window layout or window focus in another way, the
5151 mouse pointer is moved to the window with keyboard focus. Off is the
5152 default because it makes using the pull down menus a little goofy, as
5153 a pointer transit may activate a window unintentionally.
5154
5155 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5156'mousehide' 'mh' boolean (default on)
5157 global
5158 {not in Vi}
5159 {only works in the GUI}
5160 When on, the mouse pointer is hidden when characters are typed.
5161 The mouse pointer is restored when the mouse is moved.
5162
5163 *'mousemodel'* *'mousem'*
5164'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5165 global
5166 {not in Vi}
5167 Sets the model to use for the mouse. The name mostly specifies what
5168 the right mouse button is used for:
5169 extend Right mouse button extends a selection. This works
5170 like in an xterm.
5171 popup Right mouse button pops up a menu. The shifted left
5172 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005173 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 popup_setpos Like "popup", but the cursor will be moved to the
5175 position where the mouse was clicked, and thus the
5176 selected operation will act upon the clicked object.
5177 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005178 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 course, that right clicking outside a selection will
5180 end Visual mode.
5181 Overview of what button does what for each model:
5182 mouse extend popup(_setpos) ~
5183 left click place cursor place cursor
5184 left drag start selection start selection
5185 shift-left search word extend selection
5186 right click extend selection popup menu (place cursor)
5187 right drag extend selection -
5188 middle click paste paste
5189
5190 In the "popup" model the right mouse button produces a pop-up menu.
5191 You need to define this first, see |popup-menu|.
5192
5193 Note that you can further refine the meaning of buttons with mappings.
5194 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5195 selection (because that's handled in the GUI code directly).
5196
5197 The 'mousemodel' option is set by the |:behave| command.
5198
5199 *'mouseshape'* *'mouses'* *E547*
5200'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005201 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 global
5203 {not in Vi}
5204 {only available when compiled with the |+mouseshape|
5205 feature}
5206 This option tells Vim what the mouse pointer should look like in
5207 different modes. The option is a comma separated list of parts, much
5208 like used for 'guicursor'. Each part consist of a mode/location-list
5209 and an argument-list:
5210 mode-list:shape,mode-list:shape,..
5211 The mode-list is a dash separated list of these modes/locations:
5212 In a normal window: ~
5213 n Normal mode
5214 v Visual mode
5215 ve Visual mode with 'selection' "exclusive" (same as 'v',
5216 if not specified)
5217 o Operator-pending mode
5218 i Insert mode
5219 r Replace mode
5220
5221 Others: ~
5222 c appending to the command-line
5223 ci inserting in the command-line
5224 cr replacing in the command-line
5225 m at the 'Hit ENTER' or 'More' prompts
5226 ml idem, but cursor in the last line
5227 e any mode, pointer below last window
5228 s any mode, pointer on a status line
5229 sd any mode, while dragging a status line
5230 vs any mode, pointer on a vertical separator line
5231 vd any mode, while dragging a vertical separator line
5232 a everywhere
5233
5234 The shape is one of the following:
5235 avail name looks like ~
5236 w x arrow Normal mouse pointer
5237 w x blank no pointer at all (use with care!)
5238 w x beam I-beam
5239 w x updown up-down sizing arrows
5240 w x leftright left-right sizing arrows
5241 w x busy The system's usual busy pointer
5242 w x no The system's usual 'no input' pointer
5243 x udsizing indicates up-down resizing
5244 x lrsizing indicates left-right resizing
5245 x crosshair like a big thin +
5246 x hand1 black hand
5247 x hand2 white hand
5248 x pencil what you write with
5249 x question big ?
5250 x rightup-arrow arrow pointing right-up
5251 w x up-arrow arrow pointing up
5252 x <number> any X11 pointer number (see X11/cursorfont.h)
5253
5254 The "avail" column contains a 'w' if the shape is available for Win32,
5255 x for X11.
5256 Any modes not specified or shapes not available use the normal mouse
5257 pointer.
5258
5259 Example: >
5260 :set mouseshape=s:udsizing,m:no
5261< will make the mouse turn to a sizing arrow over the status lines and
5262 indicate no input when the hit-enter prompt is displayed (since
5263 clicking the mouse has no effect in this state.)
5264
5265 *'mousetime'* *'mouset'*
5266'mousetime' 'mouset' number (default 500)
5267 global
5268 {not in Vi}
5269 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5270 time in msec between two mouse clicks for the second click to be
5271 recognized as a multi click.
5272
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005273 *'mzquantum'* *'mzq'*
5274'mzquantum' 'mzq' number (default 100)
5275 global
5276 {not in Vi}
5277 {not available when compiled without the |+mzscheme|
5278 feature}
5279 The number of milliseconds between polls for MzScheme threads.
5280 Negative or zero value means no thread scheduling.
5281
Bram Moolenaar071d4272004-06-13 20:20:40 +00005282 *'nrformats'* *'nf'*
5283'nrformats' 'nf' string (default "octal,hex")
5284 local to buffer
5285 {not in Vi}
5286 This defines what bases Vim will consider for numbers when using the
5287 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5288 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005289 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005290 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005291 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005292 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005294 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005295 considered to be hexadecimal. Example: Using CTRL-X on
5296 "0x100" results in "0x0ff".
5297 Numbers which simply begin with a digit in the range 1-9 are always
5298 considered decimal. This also happens for numbers that are not
5299 recognized as octal or hex.
5300
5301 *'number'* *'nu'* *'nonumber'* *'nonu'*
5302'number' 'nu' boolean (default off)
5303 local to window
5304 Print the line number in front of each line. When the 'n' option is
5305 excluded from 'cpoptions' a wrapped line will not use the column of
5306 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005307 The 'numberwidth' option can be used to set the room used for the line
5308 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 When a long, wrapped line doesn't start with the first character, '-'
5310 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005311 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5312 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005313 *number_relativenumber*
5314 The 'relativenumber' option changes the displayed number to be
5315 relative to the cursor. Together with 'number' there are these
5316 four combinations (cursor in line 3):
5317
5318 'nonu' 'nu' 'nonu' 'nu'
5319 'nornu' 'nornu' 'rnu' 'rnu'
5320
5321 |apple | 1 apple | 2 apple | 2 apple
5322 |pear | 2 pear | 1 pear | 1 pear
5323 |nobody | 3 nobody | 0 nobody |3 nobody
5324 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005326 *'numberwidth'* *'nuw'*
5327'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5328 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005329 {not in Vi}
5330 {only available when compiled with the |+linebreak|
5331 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005332 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005333 when the 'number' or 'relativenumber' option is set or printing lines
5334 with a line number. Since one space is always between the number and
5335 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005336 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005337 fit the highest line number in the buffer respectively the number of
5338 rows in the window, depending on whether 'number' or 'relativenumber'
5339 is set. Thus with the Vim default of 4 there is room for a line number
5340 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005341 The minimum value is 1, the maximum value is 10.
5342 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5343
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005344 *'omnifunc'* *'ofu'*
5345'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005346 local to buffer
5347 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005348 {not available when compiled without the |+eval|
5349 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005350 This option specifies a function to be used for Insert mode omni
5351 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005352 See |complete-functions| for an explanation of how the function is
5353 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005354 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005355 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005356 This option cannot be set from a |modeline| or in the |sandbox|, for
5357 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005358
5359
Bram Moolenaar02467872007-05-06 13:22:01 +00005360 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005361'opendevice' 'odev' boolean (default off)
5362 global
5363 {not in Vi}
5364 {only for MS-DOS, MS-Windows and OS/2}
5365 Enable reading and writing from devices. This may get Vim stuck on a
5366 device that can be opened but doesn't actually do the I/O. Therefore
5367 it is off by default.
5368 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5369 result in editing a device.
5370
5371
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005372 *'operatorfunc'* *'opfunc'*
5373'operatorfunc' 'opfunc' string (default: empty)
5374 global
5375 {not in Vi}
5376 This option specifies a function to be called by the |g@| operator.
5377 See |:map-operator| for more info and an example.
5378
5379 This option cannot be set from a |modeline| or in the |sandbox|, for
5380 security reasons.
5381
5382
Bram Moolenaar251e1912011-06-19 05:09:16 +02005383 *'osfiletype'* *'oft'*
5384'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005385 local to buffer
5386 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005387 This option was supported on RISC OS, which has been removed.
5388
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389
5390 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005391'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 global
5393 Specifies the nroff macros that separate paragraphs. These are pairs
5394 of two letters (see |object-motions|).
5395
5396 *'paste'* *'nopaste'*
5397'paste' boolean (default off)
5398 global
5399 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005400 Put Vim in Paste mode. This is useful if you want to cut or copy
5401 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 unexpected effects.
5403 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005404 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 knows about pasting and will mostly do the right thing without 'paste'
5406 being set. The same is true for a terminal where Vim handles the
5407 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005408 This option is reset when starting the GUI. Thus if you set it in
5409 your .vimrc it will work in a terminal, but not in the GUI. Setting
5410 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5411 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 When the 'paste' option is switched on (also when it was already on):
5413 - mapping in Insert mode and Command-line mode is disabled
5414 - abbreviations are disabled
5415 - 'textwidth' is set to 0
5416 - 'wrapmargin' is set to 0
5417 - 'autoindent' is reset
5418 - 'smartindent' is reset
5419 - 'softtabstop' is set to 0
5420 - 'revins' is reset
5421 - 'ruler' is reset
5422 - 'showmatch' is reset
5423 - 'formatoptions' is used like it is empty
5424 These options keep their value, but their effect is disabled:
5425 - 'lisp'
5426 - 'indentexpr'
5427 - 'cindent'
5428 NOTE: When you start editing another file while the 'paste' option is
5429 on, settings from the modelines or autocommands may change the
5430 settings again, causing trouble when pasting text. You might want to
5431 set the 'paste' option again.
5432 When the 'paste' option is reset the mentioned options are restored to
5433 the value before the moment 'paste' was switched from off to on.
5434 Resetting 'paste' before ever setting it does not have any effect.
5435 Since mapping doesn't work while 'paste' is active, you need to use
5436 the 'pastetoggle' option to toggle the 'paste' option with some key.
5437
5438 *'pastetoggle'* *'pt'*
5439'pastetoggle' 'pt' string (default "")
5440 global
5441 {not in Vi}
5442 When non-empty, specifies the key sequence that toggles the 'paste'
5443 option. This is like specifying a mapping: >
5444 :map {keys} :set invpaste<CR>
5445< Where {keys} is the value of 'pastetoggle'.
5446 The difference is that it will work even when 'paste' is set.
5447 'pastetoggle' works in Insert mode and Normal mode, but not in
5448 Command-line mode.
5449 Mappings are checked first, thus overrule 'pastetoggle'. However,
5450 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5451 this: >
5452 :map <F10> :set paste<CR>
5453 :map <F11> :set nopaste<CR>
5454 :imap <F10> <C-O>:set paste<CR>
5455 :imap <F11> <nop>
5456 :set pastetoggle=<F11>
5457< This will make <F10> start paste mode and <F11> stop paste mode.
5458 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5459 mode everything is inserted literally, except the 'pastetoggle' key
5460 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005461 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005462
5463 *'pex'* *'patchexpr'*
5464'patchexpr' 'pex' string (default "")
5465 global
5466 {not in Vi}
5467 {not available when compiled without the |+diff|
5468 feature}
5469 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005470 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471
Bram Moolenaardbc28022014-07-26 13:40:44 +02005472 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005473'patchmode' 'pm' string (default "")
5474 global
5475 {not in Vi}
5476 When non-empty the oldest version of a file is kept. This can be used
5477 to keep the original version of a file if you are changing files in a
5478 source distribution. Only the first time that a file is written a
5479 copy of the original file will be kept. The name of the copy is the
5480 name of the original file with the string in the 'patchmode' option
5481 appended. This option should start with a dot. Use a string like
5482 ".org". 'backupdir' must not be empty for this to work (Detail: The
5483 backup file is renamed to the patchmode file after the new file has
5484 been successfully written, that's why it must be possible to write a
5485 backup file). If there was no file to be backed up, an empty file is
5486 created.
5487 When the 'backupskip' pattern matches, a patchmode file is not made.
5488 Using 'patchmode' for compressed files appends the extension at the
5489 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5490 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005491 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005493 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494'path' 'pa' string (default on Unix: ".,/usr/include,,"
5495 on OS/2: ".,/emx/include,,"
5496 other systems: ".,,")
5497 global or local to buffer |global-local|
5498 {not in Vi}
5499 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005500 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5501 provided that the file being searched for has a relative path (not
5502 starting with "/", "./" or "../"). The directories in the 'path'
5503 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 - Use commas to separate directory names: >
5505 :set path=.,/usr/local/include,/usr/include
5506< - Spaces can also be used to separate directory names (for backwards
5507 compatibility with version 3.0). To have a space in a directory
5508 name, precede it with an extra backslash, and escape the space: >
5509 :set path=.,/dir/with\\\ space
5510< - To include a comma in a directory name precede it with an extra
5511 backslash: >
5512 :set path=.,/dir/with\\,comma
5513< - To search relative to the directory of the current file, use: >
5514 :set path=.
5515< - To search in the current directory use an empty string between two
5516 commas: >
5517 :set path=,,
5518< - A directory name may end in a ':' or '/'.
5519 - Environment variables are expanded |:set_env|.
5520 - When using |netrw.vim| URLs can be used. For example, adding
5521 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005522 - Search upwards and downwards in a directory tree using "*", "**" and
5523 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 {not available when compiled without the |+path_extra| feature}
5525 - Careful with '\' characters, type two to get one in the option: >
5526 :set path=.,c:\\include
5527< Or just use '/' instead: >
5528 :set path=.,c:/include
5529< Don't forget "." or files won't even be found in the same directory as
5530 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005531 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 it is something like 256 or 1024 characters.
5533 You can check if all the include files are found, using the value of
5534 'path', see |:checkpath|.
5535 The use of |:set+=| and |:set-=| is preferred when adding or removing
5536 directories from the list. This avoids problems when a future version
5537 uses another default. To remove the current directory use: >
5538 :set path-=
5539< To add the current directory use: >
5540 :set path+=
5541< To use an environment variable, you probably need to replace the
5542 separator. Here is an example to append $INCL, in which directory
5543 names are separated with a semi-colon: >
5544 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5545< Replace the ';' with a ':' or whatever separator is used. Note that
5546 this doesn't work when $INCL contains a comma or white space.
5547
5548 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5549'preserveindent' 'pi' boolean (default off)
5550 local to buffer
5551 {not in Vi}
5552 When changing the indent of the current line, preserve as much of the
5553 indent structure as possible. Normally the indent is replaced by a
5554 series of tabs followed by spaces as required (unless |'expandtab'| is
5555 enabled, in which case only spaces are used). Enabling this option
5556 means the indent will preserve as many existing characters as possible
5557 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005558 'expandtab' does not apply to the preserved white space, a Tab remains
5559 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 NOTE: When using ">>" multiple times the resulting indent is a mix of
5561 tabs and spaces. You might not like this.
5562 NOTE: 'preserveindent' is reset when 'compatible' is set.
5563 Also see 'copyindent'.
5564 Use |:retab| to clean up white space.
5565
5566 *'previewheight'* *'pvh'*
5567'previewheight' 'pvh' number (default 12)
5568 global
5569 {not in Vi}
5570 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005571 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 Default height for a preview window. Used for |:ptag| and associated
5573 commands. Used for |CTRL-W_}| when no count is given.
5574
5575 *'previewwindow'* *'nopreviewwindow'*
5576 *'pvw'* *'nopvw'* *E590*
5577'previewwindow' 'pvw' boolean (default off)
5578 local to window
5579 {not in Vi}
5580 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005581 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005582 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 set. It's normally not set directly, but by using one of the commands
5584 |:ptag|, |:pedit|, etc.
5585
5586 *'printdevice'* *'pdev'*
5587'printdevice' 'pdev' string (default empty)
5588 global
5589 {not in Vi}
5590 {only available when compiled with the |+printer|
5591 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005592 The name of the printer to be used for |:hardcopy|.
5593 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005594 This option cannot be set from a |modeline| or in the |sandbox|, for
5595 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596
Bram Moolenaar8299df92004-07-10 09:47:34 +00005597 *'printencoding'* *'penc'*
5598'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 global
5600 {not in Vi}
5601 {only available when compiled with the |+printer|
5602 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005603 Sets the character encoding used when printing.
5604 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005605
5606 *'printexpr'* *'pexpr'*
5607'printexpr' 'pexpr' String (default: see below)
5608 global
5609 {not in Vi}
5610 {only available when compiled with the |+printer|
5611 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005612 Expression used to print the PostScript produced with |:hardcopy|.
5613 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614
Bram Moolenaar8299df92004-07-10 09:47:34 +00005615 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616'printfont' 'pfn' string (default "courier")
5617 global
5618 {not in Vi}
5619 {only available when compiled with the |+printer|
5620 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005621 The name of the font that will be used for |:hardcopy|.
5622 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623
5624 *'printheader'* *'pheader'*
5625'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5626 global
5627 {not in Vi}
5628 {only available when compiled with the |+printer|
5629 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005630 The format of the header produced in |:hardcopy| output.
5631 See |pheader-option|.
5632
5633 *'printmbcharset'* *'pmbcs'*
5634'printmbcharset' 'pmbcs' string (default "")
5635 global
5636 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005637 {only available when compiled with the |+printer|,
5638 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005639 The CJK character set to be used for CJK output from |:hardcopy|.
5640 See |pmbcs-option|.
5641
5642 *'printmbfont'* *'pmbfn'*
5643'printmbfont' 'pmbfn' string (default "")
5644 global
5645 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005646 {only available when compiled with the |+printer|,
5647 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005648 List of font names to be used for CJK output from |:hardcopy|.
5649 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650
5651 *'printoptions'* *'popt'*
5652'printoptions' 'popt' string (default "")
5653 global
5654 {not in Vi}
5655 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005656 List of items that control the format of the output of |:hardcopy|.
5657 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005659 *'prompt'* *'noprompt'*
5660'prompt' boolean (default on)
5661 global
5662 When on a ":" prompt is used in Ex mode.
5663
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005664 *'pumheight'* *'ph'*
5665'pumheight' 'ph' number (default 0)
5666 global
5667 {not available when compiled without the
5668 |+insert_expand| feature}
5669 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005670 Determines the maximum number of items to show in the popup menu for
5671 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005672 |ins-completion-menu|.
5673
5674
Bram Moolenaar677ee682005-01-27 14:41:15 +00005675 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005676'quoteescape' 'qe' string (default "\")
5677 local to buffer
5678 {not in Vi}
5679 The characters that are used to escape quotes in a string. Used for
5680 objects like a', a" and a` |a'|.
5681 When one of the characters in this option is found inside a string,
5682 the following character will be skipped. The default value makes the
5683 text "foo\"bar\\" considered to be one string.
5684
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5686'readonly' 'ro' boolean (default off)
5687 local to buffer
5688 If on, writes fail unless you use a '!'. Protects you from
5689 accidentally overwriting a file. Default on when Vim is started
5690 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005691 When using ":w!" the 'readonly' option is reset for the current
5692 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005694 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005695
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005696 *'redrawtime'* *'rdt'*
5697'redrawtime' 'rdt' number (default 2000)
5698 global
5699 {not in Vi}
5700 {only available when compiled with the |+reltime|
5701 feature}
5702 The time in milliseconds for redrawing the display. This applies to
5703 searching for patterns for 'hlsearch' and |:match| highlighting.
5704 When redrawing takes more than this many milliseconds no further
5705 matches will be highlighted. This is used to avoid that Vim hangs
5706 when using a very complicated pattern.
5707
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005708 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005709'regexpengine' 're' number (default 0)
5710 global
5711 {not in Vi}
5712 This selects the default regexp engine. |two-engines|
5713 The possible values are:
5714 0 automatic selection
5715 1 old engine
5716 2 NFA engine
5717 Note that when using the NFA engine and the pattern contains something
5718 that is not supported the pattern will not match. This is only useful
5719 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005720 Using automatic selection enables Vim to switch the engine, if the
5721 default engine becomes too costly. E.g., when the NFA engine uses too
5722 many states. This should prevent Vim from hanging on a combination of
5723 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005724
Bram Moolenaar64486672010-05-16 15:46:46 +02005725 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5726'relativenumber' 'rnu' boolean (default off)
5727 local to window
5728 {not in Vi}
5729 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005730 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005731 precede some vertical motion commands (e.g. j k + -) with, without
5732 having to calculate it yourself. Especially useful in combination with
5733 other commands (e.g. y d c < > gq gw =).
5734 When the 'n' option is excluded from 'cpoptions' a wrapped
5735 line will not use the column of line numbers (this is the default when
5736 'compatible' isn't set).
5737 The 'numberwidth' option can be used to set the room used for the line
5738 number.
5739 When a long, wrapped line doesn't start with the first character, '-'
5740 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005741 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5742 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005743
5744 The number in front of the cursor line also depends on the value of
5745 'number', see |number_relativenumber| for all combinations of the two
5746 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005747
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 *'remap'* *'noremap'*
5749'remap' boolean (default on)
5750 global
5751 Allows for mappings to work recursively. If you do not want this for
5752 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005753 NOTE: To avoid portability problems with Vim scripts, always keep
5754 this option at the default "on". Only switch it off when working with
5755 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005757 *'renderoptions'* *'rop'*
5758'renderoptions' 'rop' string (default: empty)
5759 global
5760 {not in Vi}
5761 {only available when compiled with GUI and DIRECTX on
5762 MS-Windows}
5763 Select a text renderer and set its options. The options depend on the
5764 renderer.
5765
5766 Syntax: >
5767 set rop=type:{renderer}(,{name}:{value})*
5768<
5769 Currently, only one optional renderer is available.
5770
5771 render behavior ~
5772 directx Vim will draw text using DirectX (DirectWrite). It makes
5773 drawn glyphs more beautiful than default GDI.
5774 It requires 'encoding' is "utf-8", and only works on
5775 MS-Windows Vista or newer version.
5776
5777 Options:
5778 name meaning type value ~
5779 gamma gamma float 1.0 - 2.2 (maybe)
5780 contrast enhancedContrast float (unknown)
5781 level clearTypeLevel float (unknown)
5782 geom pixelGeometry int 0 - 2 (see below)
5783 renmode renderingMode int 0 - 6 (see below)
5784 taamode textAntialiasMode int 0 - 3 (see below)
5785
5786 See this URL for detail:
5787 http://msdn.microsoft.com/en-us/library/dd368190.aspx
5788
5789 For geom: structure of a device pixel.
5790 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5791 1 - DWRITE_PIXEL_GEOMETRY_RGB
5792 2 - DWRITE_PIXEL_GEOMETRY_BGR
5793
5794 See this URL for detail:
5795 http://msdn.microsoft.com/en-us/library/dd368114.aspx
5796
5797 For renmode: method of rendering glyphs.
5798 0 - DWRITE_RENDERING_MODE_DEFAULT
5799 1 - DWRITE_RENDERING_MODE_ALIASED
5800 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5801 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5802 4 - DWRITE_RENDERING_MODE_NATURAL
5803 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5804 6 - DWRITE_RENDERING_MODE_OUTLINE
5805
5806 See this URL for detail:
5807 http://msdn.microsoft.com/en-us/library/dd368118.aspx
5808
5809 For taamode: antialiasing mode used for drawing text.
5810 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5811 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5812 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5813 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5814
5815 See this URL for detail:
5816 http://msdn.microsoft.com/en-us/library/dd368170.aspx
5817
5818 Example: >
5819 set encoding=utf-8
5820 set gfn=Ricty_Diminished:h12:cSHIFTJIS
5821 set rop=type:directx
5822<
5823 If select a raster font (Courier, Terminal or FixedSys) to
5824 'guifont', it fallbacks to be drawn by GDI automatically.
5825
5826 Other render types are currently not supported.
5827
Bram Moolenaar071d4272004-06-13 20:20:40 +00005828 *'report'*
5829'report' number (default 2)
5830 global
5831 Threshold for reporting number of lines changed. When the number of
5832 changed lines is more than 'report' a message will be given for most
5833 ":" commands. If you want it always, set 'report' to 0.
5834 For the ":substitute" command the number of substitutions is used
5835 instead of the number of lines.
5836
5837 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5838'restorescreen' 'rs' boolean (default on)
5839 global
5840 {not in Vi} {only in Windows 95/NT console version}
5841 When set, the screen contents is restored when exiting Vim. This also
5842 happens when executing external commands.
5843
5844 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5845 options in your .vimrc. To disable restoring:
5846 set t_ti= t_te=
5847 To enable restoring (for an xterm):
5848 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5849 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5850
5851 *'revins'* *'ri'* *'norevins'* *'nori'*
5852'revins' 'ri' boolean (default off)
5853 global
5854 {not in Vi}
5855 {only available when compiled with the |+rightleft|
5856 feature}
5857 Inserting characters in Insert mode will work backwards. See "typing
5858 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5859 command in Insert mode, when 'allowrevins' is set.
5860 NOTE: This option is reset when 'compatible' or 'paste' is set.
5861
5862 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5863'rightleft' 'rl' boolean (default off)
5864 local to window
5865 {not in Vi}
5866 {only available when compiled with the |+rightleft|
5867 feature}
5868 When on, display orientation becomes right-to-left, i.e., characters
5869 that are stored in the file appear from the right to the left.
5870 Using this option, it is possible to edit files for languages that
5871 are written from the right to the left such as Hebrew and Arabic.
5872 This option is per window, so it is possible to edit mixed files
5873 simultaneously, or to view the same file in both ways (this is
5874 useful whenever you have a mixed text file with both right-to-left
5875 and left-to-right strings so that both sets are displayed properly
5876 in different windows). Also see |rileft.txt|.
5877
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005878 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005879'rightleftcmd' 'rlc' string (default "search")
5880 local to window
5881 {not in Vi}
5882 {only available when compiled with the |+rightleft|
5883 feature}
5884 Each word in this option enables the command line editing to work in
5885 right-to-left mode for a group of commands:
5886
5887 search "/" and "?" commands
5888
5889 This is useful for languages such as Hebrew, Arabic and Farsi.
5890 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5891
5892 *'ruler'* *'ru'* *'noruler'* *'noru'*
5893'ruler' 'ru' boolean (default off)
5894 global
5895 {not in Vi}
5896 {not available when compiled without the
5897 |+cmdline_info| feature}
5898 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005899 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 text in the file is shown on the far right:
5901 Top first line is visible
5902 Bot last line is visible
5903 All first and last line are visible
5904 45% relative position in the file
5905 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005906 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005908 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005909 this option takes precedence over 'ruler' and 'rulerformat'
5910 If the number of characters displayed is different from the number of
5911 bytes in the text (e.g., for a TAB or a multi-byte character), both
5912 the text column (byte number) and the screen column are shown,
5913 separated with a dash.
5914 For an empty line "0-1" is shown.
5915 For an empty buffer the line number will also be zero: "0,0-1".
5916 This option is reset when the 'paste' option is set.
5917 If you don't want to see the ruler all the time but want to know where
5918 you are, use "g CTRL-G" |g_CTRL-G|.
5919 NOTE: This option is reset when 'compatible' is set.
5920
5921 *'rulerformat'* *'ruf'*
5922'rulerformat' 'ruf' string (default empty)
5923 global
5924 {not in Vi}
5925 {not available when compiled without the |+statusline|
5926 feature}
5927 When this option is not empty, it determines the content of the ruler
5928 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005929 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930 The default ruler width is 17 characters. To make the ruler 15
5931 characters wide, put "%15(" at the start and "%)" at the end.
5932 Example: >
5933 :set rulerformat=%15(%c%V\ %p%%%)
5934<
5935 *'runtimepath'* *'rtp'* *vimfiles*
5936'runtimepath' 'rtp' string (default:
5937 Unix: "$HOME/.vim,
5938 $VIM/vimfiles,
5939 $VIMRUNTIME,
5940 $VIM/vimfiles/after,
5941 $HOME/.vim/after"
5942 Amiga: "home:vimfiles,
5943 $VIM/vimfiles,
5944 $VIMRUNTIME,
5945 $VIM/vimfiles/after,
5946 home:vimfiles/after"
5947 PC, OS/2: "$HOME/vimfiles,
5948 $VIM/vimfiles,
5949 $VIMRUNTIME,
5950 $VIM/vimfiles/after,
5951 $HOME/vimfiles/after"
5952 Macintosh: "$VIM:vimfiles,
5953 $VIMRUNTIME,
5954 $VIM:vimfiles:after"
5955 RISC-OS: "Choices:vimfiles,
5956 $VIMRUNTIME,
5957 Choices:vimfiles/after"
5958 VMS: "sys$login:vimfiles,
5959 $VIM/vimfiles,
5960 $VIMRUNTIME,
5961 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005962 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 global
5964 {not in Vi}
5965 This is a list of directories which will be searched for runtime
5966 files:
5967 filetype.vim filetypes by file name |new-filetype|
5968 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005969 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970 colors/ color scheme files |:colorscheme|
5971 compiler/ compiler files |:compiler|
5972 doc/ documentation |write-local-help|
5973 ftplugin/ filetype plugins |write-filetype-plugin|
5974 indent/ indent scripts |indent-expression|
5975 keymap/ key mapping files |mbyte-keymap|
5976 lang/ menu translations |:menutrans|
5977 menu.vim GUI menus |menu.vim|
5978 plugin/ plugin scripts |write-plugin|
5979 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005980 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 syntax/ syntax files |mysyntaxfile|
5982 tutor/ files for vimtutor |tutor|
5983
5984 And any other file searched for with the |:runtime| command.
5985
5986 The defaults for most systems are setup to search five locations:
5987 1. In your home directory, for your personal preferences.
5988 2. In a system-wide Vim directory, for preferences from the system
5989 administrator.
5990 3. In $VIMRUNTIME, for files distributed with Vim.
5991 *after-directory*
5992 4. In the "after" directory in the system-wide Vim directory. This is
5993 for the system administrator to overrule or add to the distributed
5994 defaults (rarely needed)
5995 5. In the "after" directory in your home directory. This is for
5996 personal preferences to overrule or add to the distributed defaults
5997 or system-wide settings (rarely needed).
5998
5999 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6000 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006001 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006002 wildcards.
6003 See |:runtime|.
6004 Example: >
6005 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6006< This will use the directory "~/vimruntime" first (containing your
6007 personal Vim runtime files), then "/mygroup/vim" (shared between a
6008 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6009 files).
6010 You probably should always include $VIMRUNTIME somewhere, to use the
6011 distributed runtime files. You can put a directory before $VIMRUNTIME
6012 to find files which replace a distributed runtime files. You can put
6013 a directory after $VIMRUNTIME to find files which add to distributed
6014 runtime files.
6015 This option cannot be set from a |modeline| or in the |sandbox|, for
6016 security reasons.
6017
6018 *'scroll'* *'scr'*
6019'scroll' 'scr' number (default: half the window height)
6020 local to window
6021 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6022 set to half the number of lines in the window when the window size
6023 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006024 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006025 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
6026 the number of screen lines instead of file lines, makes a difference
6027 when lines wrap}
6028
6029 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6030'scrollbind' 'scb' boolean (default off)
6031 local to window
6032 {not in Vi}
6033 {not available when compiled without the |+scrollbind|
6034 feature}
6035 See also |scroll-binding|. When this option is set, the current
6036 window scrolls as other scrollbind windows (windows that also have
6037 this option set) scroll. This option is useful for viewing the
6038 differences between two versions of a file, see 'diff'.
6039 See |'scrollopt'| for options that determine how this option should be
6040 interpreted.
6041 This option is mostly reset when splitting a window to edit another
6042 file. This means that ":split | edit file" results in two windows
6043 with scroll-binding, but ":split file" does not.
6044
6045 *'scrolljump'* *'sj'*
6046'scrolljump' 'sj' number (default 1)
6047 global
6048 {not in Vi}
6049 Minimal number of lines to scroll when the cursor gets off the
6050 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6051 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006052 When set to a negative number from -1 to -100 this is used as the
6053 percentage of the window height. Thus -50 scrolls half the window
6054 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006055 NOTE: This option is set to 1 when 'compatible' is set.
6056
6057 *'scrolloff'* *'so'*
6058'scrolloff' 'so' number (default 0)
6059 global
6060 {not in Vi}
6061 Minimal number of screen lines to keep above and below the cursor.
6062 This will make some context visible around where you are working. If
6063 you set it to a very large value (999) the cursor line will always be
6064 in the middle of the window (except at the start or end of the file or
6065 when long lines wrap).
6066 For scrolling horizontally see 'sidescrolloff'.
6067 NOTE: This option is set to 0 when 'compatible' is set.
6068
6069 *'scrollopt'* *'sbo'*
6070'scrollopt' 'sbo' string (default "ver,jump")
6071 global
6072 {not available when compiled without the |+scrollbind|
6073 feature}
6074 {not in Vi}
6075 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006076 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6077 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 The following words are available:
6079 ver Bind vertical scrolling for 'scrollbind' windows
6080 hor Bind horizontal scrolling for 'scrollbind' windows
6081 jump Applies to the offset between two windows for vertical
6082 scrolling. This offset is the difference in the first
6083 displayed line of the bound windows. When moving
6084 around in a window, another 'scrollbind' window may
6085 reach a position before the start or after the end of
6086 the buffer. The offset is not changed though, when
6087 moving back the 'scrollbind' window will try to scroll
6088 to the desired position when possible.
6089 When now making that window the current one, two
6090 things can be done with the relative offset:
6091 1. When "jump" is not included, the relative offset is
6092 adjusted for the scroll position in the new current
6093 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006094 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 2. When "jump" is included, the other windows are
6096 scrolled to keep the same relative offset. When
6097 going back to the other window, it still uses the
6098 same relative offset.
6099 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006100 When 'diff' mode is active there always is vertical scroll binding,
6101 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102
6103 *'sections'* *'sect'*
6104'sections' 'sect' string (default "SHNHH HUnhsh")
6105 global
6106 Specifies the nroff macros that separate sections. These are pairs of
6107 two letters (See |object-motions|). The default makes a section start
6108 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6109
6110 *'secure'* *'nosecure'* *E523*
6111'secure' boolean (default off)
6112 global
6113 {not in Vi}
6114 When on, ":autocmd", shell and write commands are not allowed in
6115 ".vimrc" and ".exrc" in the current directory and map commands are
6116 displayed. Switch it off only if you know that you will not run into
6117 problems, or when the 'exrc' option is off. On Unix this option is
6118 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006119 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 'secure' at the end of your ~/.vimrc then.
6121 This option cannot be set from a |modeline| or in the |sandbox|, for
6122 security reasons.
6123
6124 *'selection'* *'sel'*
6125'selection' 'sel' string (default "inclusive")
6126 global
6127 {not in Vi}
6128 This option defines the behavior of the selection. It is only used
6129 in Visual and Select mode.
6130 Possible values:
6131 value past line inclusive ~
6132 old no yes
6133 inclusive yes yes
6134 exclusive yes no
6135 "past line" means that the cursor is allowed to be positioned one
6136 character past the line.
6137 "inclusive" means that the last character of the selection is included
6138 in an operation. For example, when "x" is used to delete the
6139 selection.
6140 Note that when "exclusive" is used and selecting from the end
6141 backwards, you cannot include the last character of a line, when
6142 starting in Normal mode and 'virtualedit' empty.
6143
6144 The 'selection' option is set by the |:behave| command.
6145
6146 *'selectmode'* *'slm'*
6147'selectmode' 'slm' string (default "")
6148 global
6149 {not in Vi}
6150 This is a comma separated list of words, which specifies when to start
6151 Select mode instead of Visual mode, when a selection is started.
6152 Possible values:
6153 mouse when using the mouse
6154 key when using shifted special keys
6155 cmd when using "v", "V" or CTRL-V
6156 See |Select-mode|.
6157 The 'selectmode' option is set by the |:behave| command.
6158
6159 *'sessionoptions'* *'ssop'*
6160'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00006161 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006162 global
6163 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006164 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006165 feature}
6166 Changes the effect of the |:mksession| command. It is a comma
6167 separated list of words. Each word enables saving and restoring
6168 something:
6169 word save and restore ~
6170 blank empty windows
6171 buffers hidden and unloaded buffers, not just those in windows
6172 curdir the current directory
6173 folds manually created folds, opened/closed folds and local
6174 fold options
6175 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006176 and contain at least one lowercase letter. Only
6177 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 help the help window
6179 localoptions options and mappings local to a window or buffer (not
6180 global values for local options)
6181 options all options and mappings (also global values for local
6182 options)
6183 resize size of the Vim window: 'lines' and 'columns'
6184 sesdir the directory in which the session file is located
6185 will become the current directory (useful with
6186 projects accessed over a network from different
6187 systems)
6188 slash backslashes in file names replaced with forward
6189 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006190 tabpages all tab pages; without this only the current tab page
6191 is restored, so that you can make a session for each
6192 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 unix with Unix end-of-line format (single <NL>), even when
6194 on Windows or DOS
6195 winpos position of the whole Vim window
6196 winsize window sizes
6197
6198 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006199 When neither "curdir" nor "sesdir" is included, file names are stored
6200 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 "slash" and "unix" are useful on Windows when sharing session files
6202 with Unix. The Unix version of Vim cannot source dos format scripts,
6203 but the Windows version of Vim can source unix format scripts.
6204
6205 *'shell'* *'sh'* *E91*
6206'shell' 'sh' string (default $SHELL or "sh",
6207 MS-DOS and Win32: "command.com" or
6208 "cmd.exe", OS/2: "cmd")
6209 global
6210 Name of the shell to use for ! and :! commands. When changing the
6211 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6212 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006213 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 See |option-backslash| about including spaces and backslashes.
6215 Environment variables are expanded |:set_env|.
6216 If the name of the shell contains a space, you might need to enclose
6217 it in quotes. Example: >
6218 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6219< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006220 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006221 "-f" is not inside the quotes, because it is not part of the command
6222 name. And Vim automagically recognizes the backslashes that are path
6223 separators.
6224 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
6225 variable to change the way external commands are executed. See the
6226 libc.inf file of DJGPP.
6227 Under MS-Windows, when the executable ends in ".com" it must be
6228 included. Thus setting the shell to "command.com" or "4dos.com"
6229 works, but "command" and "4dos" do not work for all commands (e.g.,
6230 filtering).
6231 For unknown reasons, when using "4dos.com" the current directory is
6232 changed to "C:\". To avoid this set 'shell' like this: >
6233 :set shell=command.com\ /c\ 4dos
6234< This option cannot be set from a |modeline| or in the |sandbox|, for
6235 security reasons.
6236
6237 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006238'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006239 MS-DOS and Win32, when 'shell' does not
6240 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006241 global
6242 {not in Vi}
6243 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6244 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6245 systems, the default is set according to the value of 'shell', to
6246 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006247 OS/2 (EMX figures this out itself).
6248 On Unix it can have more than one flag. Each white space separated
6249 part is passed as an argument to the shell command.
6250 See |option-backslash| about including spaces and backslashes.
6251 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 This option cannot be set from a |modeline| or in the |sandbox|, for
6253 security reasons.
6254
6255 *'shellpipe'* *'sp'*
6256'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6257 global
6258 {not in Vi}
6259 {not available when compiled without the |+quickfix|
6260 feature}
6261 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006262 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 including spaces and backslashes.
6264 The name of the temporary file can be represented by "%s" if necessary
6265 (the file name is appended automatically if no %s appears in the value
6266 of this option).
6267 For the Amiga and MS-DOS the default is ">". The output is directly
6268 saved in a file and not echoed to the screen.
6269 For Unix the default it "| tee". The stdout of the compiler is saved
6270 in a file and echoed to the screen. If the 'shell' option is "csh" or
6271 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006272 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6273 default becomes "2>&1| tee". This means that stderr is also included.
6274 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6275 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 The initialization of this option is done after reading the ".vimrc"
6277 and the other initializations, so that when the 'shell' option is set
6278 there, the 'shellpipe' option changes automatically, unless it was
6279 explicitly set before.
6280 When 'shellpipe' is set to an empty string, no redirection of the
6281 ":make" output will be done. This is useful if you use a 'makeprg'
6282 that writes to 'makeef' by itself. If you want no piping, but do
6283 want to include the 'makeef', set 'shellpipe' to a single space.
6284 Don't forget to precede the space with a backslash: ":set sp=\ ".
6285 In the future pipes may be used for filtering and this option will
6286 become obsolete (at least for Unix).
6287 This option cannot be set from a |modeline| or in the |sandbox|, for
6288 security reasons.
6289
6290 *'shellquote'* *'shq'*
6291'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6292 contains "sh" somewhere: "\"")
6293 global
6294 {not in Vi}
6295 Quoting character(s), put around the command passed to the shell, for
6296 the "!" and ":!" commands. The redirection is kept outside of the
6297 quoting. See 'shellxquote' to include the redirection. It's
6298 probably not useful to set both options.
6299 This is an empty string by default. Only known to be useful for
6300 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6301 or bash, where it should be "\"". The default is adjusted according
6302 the value of 'shell', to reduce the need to set this option by the
6303 user. See |dos-shell|.
6304 This option cannot be set from a |modeline| or in the |sandbox|, for
6305 security reasons.
6306
6307 *'shellredir'* *'srr'*
6308'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6309 global
6310 {not in Vi}
6311 String to be used to put the output of a filter command in a temporary
6312 file. See also |:!|. See |option-backslash| about including spaces
6313 and backslashes.
6314 The name of the temporary file can be represented by "%s" if necessary
6315 (the file name is appended automatically if no %s appears in the value
6316 of this option).
6317 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6318 or "zsh" during initializations, the default becomes ">&". If the
6319 'shell' option is "sh", "ksh" or "bash" the default becomes
6320 ">%s 2>&1". This means that stderr is also included.
6321 For Win32, the Unix checks are done and additionally "cmd" is checked
6322 for, which makes the default ">%s 2>&1". Also, the same names with
6323 ".exe" appended are checked for.
6324 The initialization of this option is done after reading the ".vimrc"
6325 and the other initializations, so that when the 'shell' option is set
6326 there, the 'shellredir' option changes automatically unless it was
6327 explicitly set before.
6328 In the future pipes may be used for filtering and this option will
6329 become obsolete (at least for Unix).
6330 This option cannot be set from a |modeline| or in the |sandbox|, for
6331 security reasons.
6332
6333 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6334'shellslash' 'ssl' boolean (default off)
6335 global
6336 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6337 When set, a forward slash is used when expanding file names. This is
6338 useful when a Unix-like shell is used instead of command.com or
6339 cmd.exe. Backward slashes can still be typed, but they are changed to
6340 forward slashes by Vim.
6341 Note that setting or resetting this option has no effect for some
6342 existing file names, thus this option needs to be set before opening
6343 any file for best results. This might change in the future.
6344 'shellslash' only works when a backslash can be used as a path
6345 separator. To test if this is so use: >
6346 if exists('+shellslash')
6347<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006348 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6349'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6350 global
6351 {not in Vi}
6352 When on, use temp files for shell commands. When off use a pipe.
6353 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006354 Currently a pipe is only supported on Unix and MS-Windows 2K and
6355 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006356 :if has("filterpipe")
6357< The advantage of using a pipe is that nobody can read the temp file
6358 and the 'shell' command does not need to support redirection.
6359 The advantage of using a temp file is that the file type and encoding
6360 can be detected.
6361 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6362 |FilterWritePost| autocommands event are not triggered when
6363 'shelltemp' is off.
6364
Bram Moolenaar071d4272004-06-13 20:20:40 +00006365 *'shelltype'* *'st'*
6366'shelltype' 'st' number (default 0)
6367 global
6368 {not in Vi} {only for the Amiga}
6369 On the Amiga this option influences the way how the commands work
6370 which use a shell.
6371 0 and 1: always use the shell
6372 2 and 3: use the shell only to filter lines
6373 4 and 5: use shell only for ':sh' command
6374 When not using the shell, the command is executed directly.
6375
6376 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6377 1 and 3: use "shell cmd" to start external commands
6378
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006379 *'shellxescape'* *'sxe'*
6380'shellxescape' 'sxe' string (default: "";
6381 for MS-DOS and MS-Windows: "\"&|<>()@^")
6382 global
6383 {not in Vi}
6384 When 'shellxquote' is set to "(" then the characters listed in this
6385 option will be escaped with a '^' character. This makes it possible
6386 to execute most external commands with cmd.exe.
6387
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 *'shellxquote'* *'sxq'*
6389'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006390 for Win32, when 'shell' is cmd.exe: "("
6391 for Win32, when 'shell' contains "sh"
6392 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006393 for Unix, when using system(): "\"")
6394 global
6395 {not in Vi}
6396 Quoting character(s), put around the command passed to the shell, for
6397 the "!" and ":!" commands. Includes the redirection. See
6398 'shellquote' to exclude the redirection. It's probably not useful
6399 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006400 When the value is '(' then ')' is appended. When the value is '"('
6401 then ')"' is appended.
6402 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006403 This is an empty string by default on most systems, but is known to be
6404 useful for on Win32 version, either for cmd.exe which automatically
6405 strips off the first and last quote on a command, or 3rd-party shells
6406 such as the MKS Korn Shell or bash, where it should be "\"". The
6407 default is adjusted according the value of 'shell', to reduce the need
6408 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 This option cannot be set from a |modeline| or in the |sandbox|, for
6410 security reasons.
6411
6412 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6413'shiftround' 'sr' boolean (default off)
6414 global
6415 {not in Vi}
6416 Round indent to multiple of 'shiftwidth'. Applies to > and <
6417 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6418 a multiple of 'shiftwidth' (this is Vi compatible).
6419 NOTE: This option is reset when 'compatible' is set.
6420
6421 *'shiftwidth'* *'sw'*
6422'shiftwidth' 'sw' number (default 8)
6423 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006424 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006426 When zero the 'ts' value will be used. Use the |shiftwidth()|
6427 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428
6429 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006430'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6431 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 global
6433 {not in Vi}
6434 This option helps to avoid all the |hit-enter| prompts caused by file
6435 messages, for example with CTRL-G, and to avoid some other messages.
6436 It is a list of flags:
6437 flag meaning when present ~
6438 f use "(3 of 5)" instead of "(file 3 of 5)"
6439 i use "[noeol]" instead of "[Incomplete last line]"
6440 l use "999L, 888C" instead of "999 lines, 888 characters"
6441 m use "[+]" instead of "[Modified]"
6442 n use "[New]" instead of "[New File]"
6443 r use "[RO]" instead of "[readonly]"
6444 w use "[w]" instead of "written" for file write message
6445 and "[a]" instead of "appended" for ':w >> file' command
6446 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6447 "[unix format]" and "[mac]" instead of "[mac format]".
6448 a all of the above abbreviations
6449
6450 o overwrite message for writing a file with subsequent message
6451 for reading a file (useful for ":wn" or when 'autowrite' on)
6452 O message for reading a file overwrites any previous message.
6453 Also for quickfix message (e.g., ":cn").
6454 s don't give "search hit BOTTOM, continuing at TOP" or "search
6455 hit TOP, continuing at BOTTOM" messages
6456 t truncate file message at the start if it is too long to fit
6457 on the command-line, "<" will appear in the left most column.
6458 Ignored in Ex mode.
6459 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006460 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 Ignored in Ex mode.
6462 W don't give "written" or "[w]" when writing a file
6463 A don't give the "ATTENTION" message when an existing swap file
6464 is found.
6465 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006466 c don't give |ins-completion-menu| messages. For example,
6467 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6468 "Pattern not found", "Back at original", etc.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469
6470 This gives you the opportunity to avoid that a change between buffers
6471 requires you to hit <Enter>, but still gives as useful a message as
6472 possible for the space available. To get the whole message that you
6473 would have got with 'shm' empty, use ":file!"
6474 Useful values:
6475 shm= No abbreviation of message.
6476 shm=a Abbreviation, but no loss of information.
6477 shm=at Abbreviation, and truncate message when necessary.
6478
6479 NOTE: This option is set to the Vi default value when 'compatible' is
6480 set and to the Vim default value when 'compatible' is reset.
6481
6482 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6483'shortname' 'sn' boolean (default off)
6484 local to buffer
6485 {not in Vi, not in MS-DOS versions}
6486 Filenames are assumed to be 8 characters plus one extension of 3
6487 characters. Multiple dots in file names are not allowed. When this
6488 option is on, dots in file names are replaced with underscores when
6489 adding an extension (".~" or ".swp"). This option is not available
6490 for MS-DOS, because then it would always be on. This option is useful
6491 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6492 or crossdos. When running the Win32 GUI version under Win32s, this
6493 option is always on by default.
6494
6495 *'showbreak'* *'sbr'* *E595*
6496'showbreak' 'sbr' string (default "")
6497 global
6498 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006499 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 feature}
6501 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006502 values are "> " or "+++ ": >
6503 :set showbreak=>\
6504< Note the backslash to escape the trailing space. It's easier like
6505 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006506 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006507< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 comma (in a future version the comma might be used to separate the
6509 part that is shown at the end and at the start of a line).
6510 The characters are highlighted according to the '@' flag in
6511 'highlight'.
6512 Note that tabs after the showbreak will be displayed differently.
6513 If you want the 'showbreak' to appear in between line numbers, add the
6514 "n" flag to 'cpoptions'.
6515
6516 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6517'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6518 off)
6519 global
6520 {not in Vi}
6521 {not available when compiled without the
6522 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006523 Show (partial) command in the last line of the screen. Set this
6524 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006525 In Visual mode the size of the selected area is shown:
6526 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006527 If the number of bytes is different it is also displayed: "2-6"
6528 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006530 - When selecting a block, the size in screen characters:
6531 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 NOTE: This option is set to the Vi default value when 'compatible' is
6533 set and to the Vim default value when 'compatible' is reset.
6534
6535 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6536'showfulltag' 'sft' boolean (default off)
6537 global
6538 {not in Vi}
6539 When completing a word in insert mode (see |ins-completion|) from the
6540 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006541 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 matched a C function, you can see a template for what arguments are
6543 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006544 Note that this doesn't work well together with having "longest" in
6545 'completeopt', because the completion from the search pattern may not
6546 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547
6548 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6549'showmatch' 'sm' boolean (default off)
6550 global
6551 When a bracket is inserted, briefly jump to the matching one. The
6552 jump is only done if the match can be seen on the screen. The time to
6553 show the match can be set with 'matchtime'.
6554 A Beep is given if there is no match (no matter if the match can be
6555 seen or not). This option is reset when the 'paste' option is set.
6556 When the 'm' flag is not included in 'cpoptions', typing a character
6557 will immediately move the cursor back to where it belongs.
6558 See the "sm" field in 'guicursor' for setting the cursor shape and
6559 blinking when showing the match.
6560 The 'matchpairs' option can be used to specify the characters to show
6561 matches for. 'rightleft' and 'revins' are used to look for opposite
6562 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006563 Also see the matchparen plugin for highlighting the match when moving
6564 around |pi_paren.txt|.
6565 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566
6567 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6568'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6569 global
6570 If in Insert, Replace or Visual mode put a message on the last line.
6571 Use the 'M' flag in 'highlight' to set the type of highlighting for
6572 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006573 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006574 doesn't mean XIM is really active, especially when 'imactivatekey' is
6575 not set.
6576 NOTE: This option is set to the Vi default value when 'compatible' is
6577 set and to the Vim default value when 'compatible' is reset.
6578
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006579 *'showtabline'* *'stal'*
6580'showtabline' 'stal' number (default 1)
6581 global
6582 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006583 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006584 feature}
6585 The value of this option specifies when the line with tab page labels
6586 will be displayed:
6587 0: never
6588 1: only if there are at least two tab pages
6589 2: always
6590 This is both for the GUI and non-GUI implementation of the tab pages
6591 line.
6592 See |tab-page| for more information about tab pages.
6593
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 *'sidescroll'* *'ss'*
6595'sidescroll' 'ss' number (default 0)
6596 global
6597 {not in Vi}
6598 The minimal number of columns to scroll horizontally. Used only when
6599 the 'wrap' option is off and the cursor is moved off of the screen.
6600 When it is zero the cursor will be put in the middle of the screen.
6601 When using a slow terminal set it to a large number or 0. When using
6602 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6603 commands.
6604
6605 *'sidescrolloff'* *'siso'*
6606'sidescrolloff' 'siso' number (default 0)
6607 global
6608 {not in Vi}
6609 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006610 right of the cursor if 'nowrap' is set. Setting this option to a
6611 value greater than 0 while having |'sidescroll'| also at a non-zero
6612 value makes some context visible in the line you are scrolling in
6613 horizontally (except at beginning of the line). Setting this option
6614 to a large value (like 999) has the effect of keeping the cursor
6615 horizontally centered in the window, as long as one does not come too
6616 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 NOTE: This option is set to 0 when 'compatible' is set.
6618
6619 Example: Try this together with 'sidescroll' and 'listchars' as
6620 in the following example to never allow the cursor to move
6621 onto the "extends" character:
6622
6623 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6624 :set sidescrolloff=1
6625
6626
6627 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6628'smartcase' 'scs' boolean (default off)
6629 global
6630 {not in Vi}
6631 Override the 'ignorecase' option if the search pattern contains upper
6632 case characters. Only used when the search pattern is typed and
6633 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006634 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006635 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6636 recalling the search pattern from history and hitting <Enter>.
6637 NOTE: This option is reset when 'compatible' is set.
6638
6639 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6640'smartindent' 'si' boolean (default off)
6641 local to buffer
6642 {not in Vi}
6643 {not available when compiled without the
6644 |+smartindent| feature}
6645 Do smart autoindenting when starting a new line. Works for C-like
6646 programs, but can also be used for other languages. 'cindent' does
6647 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006648 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006649 setting 'si' has no effect. 'indentexpr' is a more advanced
6650 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651 Normally 'autoindent' should also be on when using 'smartindent'.
6652 An indent is automatically inserted:
6653 - After a line ending in '{'.
6654 - After a line starting with a keyword from 'cinwords'.
6655 - Before a line starting with '}' (only with the "O" command).
6656 When typing '}' as the first character in a new line, that line is
6657 given the same indent as the matching '{'.
6658 When typing '#' as the first character in a new line, the indent for
6659 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006660 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006661 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6662 When using the ">>" command, lines starting with '#' are not shifted
6663 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006664 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006665 is set smart indenting is disabled.
6666
6667 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6668'smarttab' 'sta' boolean (default off)
6669 global
6670 {not in Vi}
6671 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006672 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6673 <BS> will delete a 'shiftwidth' worth of space at the start of the
6674 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006675 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006676 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6677 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006678 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006680 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681 NOTE: This option is reset when 'compatible' is set.
6682
6683 *'softtabstop'* *'sts'*
6684'softtabstop' 'sts' number (default 0)
6685 local to buffer
6686 {not in Vi}
6687 Number of spaces that a <Tab> counts for while performing editing
6688 operations, like inserting a <Tab> or using <BS>. It "feels" like
6689 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6690 used. This is useful to keep the 'ts' setting at its standard value
6691 of 8, while being able to edit like it is set to 'sts'. However,
6692 commands like "x" still work on the actual characters.
6693 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006694 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006695 'softtabstop' is set to 0 when the 'paste' option is set.
6696 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6697 spaces is minimized by using <Tab>s.
6698 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6699 set.
6700 NOTE: This option is set to 0 when 'compatible' is set.
6701
Bram Moolenaar217ad922005-03-20 22:37:15 +00006702 *'spell'* *'nospell'*
6703'spell' boolean (default off)
6704 local to window
6705 {not in Vi}
6706 {not available when compiled without the |+syntax|
6707 feature}
6708 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006709 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006710
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006711 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006712'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006713 local to buffer
6714 {not in Vi}
6715 {not available when compiled without the |+syntax|
6716 feature}
6717 Pattern to locate the end of a sentence. The following word will be
6718 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006719 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006720 When this check is not wanted make this option empty.
6721 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006722 Be careful with special characters, see |option-backslash| about
6723 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006724 To set this option automatically depending on the language, see
6725 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006726
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006727 *'spellfile'* *'spf'*
6728'spellfile' 'spf' string (default empty)
6729 local to buffer
6730 {not in Vi}
6731 {not available when compiled without the |+syntax|
6732 feature}
6733 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006734 commands. It must end in ".{encoding}.add". You need to include the
6735 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006736 *E765*
6737 It may also be a comma separated list of names. A count before the
6738 |zg| and |zw| commands can be used to access each. This allows using
6739 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006740 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006741 you: Using the first directory in 'runtimepath' that is writable. If
6742 there is no "spell" directory yet it will be created. For the file
6743 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006744 ignoring the region.
6745 The resulting ".spl" file will be used for spell checking, it does not
6746 have to appear in 'spelllang'.
6747 Normally one file is used for all regions, but you can add the region
6748 name if you want to. However, it will then only be used when
6749 'spellfile' is set to it, for entries in 'spelllang' only files
6750 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006751 This option cannot be set from a |modeline| or in the |sandbox|, for
6752 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006753
Bram Moolenaar217ad922005-03-20 22:37:15 +00006754 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006755'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006756 local to buffer
6757 {not in Vi}
6758 {not available when compiled without the |+syntax|
6759 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006760 A comma separated list of word list names. When the 'spell' option is
6761 on spellchecking will be done for these languages. Example: >
6762 set spelllang=en_us,nl,medical
6763< This means US English, Dutch and medical words are recognized. Words
6764 that are not recognized will be highlighted.
6765 The word list name must not include a comma or dot. Using a dash is
6766 recommended to separate the two letter language name from a
6767 specification. Thus "en-rare" is used for rare English words.
6768 A region name must come last and have the form "_xx", where "xx" is
6769 the two-letter, lower case region name. You can use more than one
6770 region by listing them: "en_us,en_ca" supports both US and Canadian
6771 English, but not words specific for Australia, New Zealand or Great
6772 Britain.
Bram Moolenaarcc63c642013-11-12 04:44:01 +01006773 If the name "cjk" is included East Asian characters are excluded from
6774 spell checking. This is useful when editing text that also has Asian
6775 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006776 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006777 As a special case the name of a .spl file can be given as-is. The
6778 first "_xx" in the name is removed and used as the region name
6779 (_xx is an underscore, two letters and followed by a non-letter).
6780 This is mainly for testing purposes. You must make sure the correct
6781 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006782 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006783 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6784 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006785 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006786
Bram Moolenaar98692072006-02-04 00:57:42 +00006787 If the |spellfile.vim| plugin is active and you use a language name
6788 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6789 will ask you if you want to download the file.
6790
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006791 After this option has been set successfully, Vim will source the files
6792 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006793 up to the first comma, dot or underscore.
6794 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006795
6796
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006797 *'spellsuggest'* *'sps'*
6798'spellsuggest' 'sps' string (default "best")
6799 global
6800 {not in Vi}
6801 {not available when compiled without the |+syntax|
6802 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006803 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006804 the |spellsuggest()| function. This is a comma-separated list of
6805 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006806
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006807 best Internal method that works best for English. Finds
6808 changes like "fast" and uses a bit of sound-a-like
6809 scoring to improve the ordering.
6810
6811 double Internal method that uses two methods and mixes the
6812 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006813 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006814 word. That only works when the language specifies
6815 sound folding. Can be slow and doesn't always give
6816 better results.
6817
6818 fast Internal method that only checks for simple changes:
6819 character inserts/deletes/swaps. Works well for
6820 simple typing mistakes.
6821
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006822 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006823 Not used for |spellsuggest()|. The number of
6824 suggestions is never more than the value of 'lines'
6825 minus two.
6826
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006827 file:{filename} Read file {filename}, which must have two columns,
6828 separated by a slash. The first column contains the
6829 bad word, the second column the suggested good word.
6830 Example:
6831 theribal/terrible ~
6832 Use this for common mistakes that do not appear at the
6833 top of the suggestion list with the internal methods.
6834 Lines without a slash are ignored, use this for
6835 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02006836 The word in the second column must be correct,
6837 otherwise it will not be used. Add the word to an
6838 ".add" file if it is currently flagged as a spelling
6839 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006840 The file is used for all languages.
6841
6842 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6843 trouble with spaces. |v:val| holds the badly spelled
6844 word. The expression must evaluate to a List of
6845 Lists, each with a suggestion and a score.
6846 Example:
6847 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006848 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006849 internal methods use. A lower score is better.
6850 This may invoke |spellsuggest()| if you temporarily
6851 set 'spellsuggest' to exclude the "expr:" part.
6852 Errors are silently ignored, unless you set the
6853 'verbose' option to a non-zero value.
6854
6855 Only one of "best", "double" or "fast" may be used. The others may
6856 appear several times in any order. Example: >
6857 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6858<
6859 This option cannot be set from a |modeline| or in the |sandbox|, for
6860 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006861
6862
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6864'splitbelow' 'sb' boolean (default off)
6865 global
6866 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006867 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 feature}
6869 When on, splitting a window will put the new window below the current
6870 one. |:split|
6871
6872 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6873'splitright' 'spr' boolean (default off)
6874 global
6875 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006876 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 feature}
6878 When on, splitting a window will put the new window right of the
6879 current one. |:vsplit|
6880
6881 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6882'startofline' 'sol' boolean (default on)
6883 global
6884 {not in Vi}
6885 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006886 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006887 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006888 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006889 with a linewise operator, with "%" with a count and to buffer changing
6890 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6891 only has a line number, e.g., ":25" or ":+".
6892 In case of buffer changing commands the cursor is placed at the column
6893 where it was the last time the buffer was edited.
6894 NOTE: This option is set when 'compatible' is set.
6895
Bram Moolenaar00654022011-02-25 14:42:19 +01006896 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006898 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 {not in Vi}
6900 {not available when compiled without the |+statusline|
6901 feature}
6902 When nonempty, this option determines the content of the status line.
6903 Also see |status-line|.
6904
6905 The option consists of printf style '%' items interspersed with
6906 normal text. Each status line item is of the form:
6907 %-0{minwid}.{maxwid}{item}
6908 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006909 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910
Bram Moolenaar238a5642006-02-21 22:12:05 +00006911 When the option starts with "%!" then it is used as an expression,
6912 evaluated and the result is used as the option value. Example: >
6913 :set statusline=%!MyStatusLine()
6914< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006915 Note that the "%!" expression is evaluated in the context of the
6916 current window and buffer, while %{} items are evaluated in the
6917 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006918
6919 When there is error while evaluating the option then it will be made
6920 empty to avoid further errors. Otherwise screen updating would loop.
6921
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 Note that the only effect of 'ruler' when this option is set (and
6923 'laststatus' is 2) is controlling the output of |CTRL-G|.
6924
6925 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006926 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006928 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006929 minwid Minimum width of the item, padding as set by '-' & '0'.
6930 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006931 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 on the left for text items. Numeric items will be
6933 shifted down to maxwid-2 digits followed by '>'number
6934 where number is the amount of missing digits, much like
6935 an exponential notation.
6936 item A one letter code as described below.
6937
6938 Following is a description of the possible statusline items. The
6939 second character in "item" is the type:
6940 N for number
6941 S for string
6942 F for flags as described below
6943 - not applicable
6944
6945 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006946 f S Path to the file in the buffer, as typed or relative to current
6947 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006948 F S Full path to the file in the buffer.
6949 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006950 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006951 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006952 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006954 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006956 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006958 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6960 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006961 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6963 being used: "<keymap>"
6964 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006965 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006966 B N As above, in hexadecimal.
6967 o N Byte number in file of byte under cursor, first byte is 1.
6968 Mnemonic: Offset from start of file (with one added)
6969 {not available when compiled without |+byte_offset| feature}
6970 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006971 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 l N Line number.
6973 L N Number of lines in buffer.
6974 c N Column number.
6975 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006976 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006977 p N Percentage through file in lines as in |CTRL-G|.
6978 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02006979 percentage described for 'ruler'. Always 3 in length, unless
6980 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006981 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006982 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006983 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006984 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006985 ( - Start of item group. Can be used for setting the width and
6986 alignment of a section. Must be followed by %) somewhere.
6987 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006988 T N For 'tabline': start of tab page N label. Use %T after the last
6989 label. This information is used for mouse clicks.
6990 X N For 'tabline': start of close tab N label. Use %X after the
6991 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6992 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006993 < - Where to truncate line if too long. Default is at the start.
6994 No width fields allowed.
6995 = - Separation point between left and right aligned items.
6996 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006997 # - Set highlight group. The name must follow and then a # again.
6998 Thus use %#HLname# for highlight group HLname. The same
6999 highlighting is used, also for the statusline of non-current
7000 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007001 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007002 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007003 The difference between User{N} and StatusLine will be applied
7004 to StatusLineNC for the statusline of non-current windows.
7005 The number N must be between 1 and 9. See |hl-User1..9|
7006
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007007 When displaying a flag, Vim removes the leading comma, if any, when
7008 that flag comes right after plaintext. This will make a nice display
7009 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007010
Bram Moolenaar582fd852005-03-28 20:58:01 +00007011 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007012 not set) and a minwid is not set for the group, the whole group will
7013 become empty. This will make a group like the following disappear
7014 completely from the statusline when none of the flags are set. >
7015 :set statusline=...%(\ [%M%R%H]%)...
7016<
7017 Beware that an expression is evaluated each and every time the status
7018 line is displayed. The current buffer and current window will be set
7019 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007020 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007021 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007022 real current buffer.
7023
Bram Moolenaar30b65812012-07-12 22:01:11 +02007024 The 'statusline' option will be evaluated in the |sandbox| if set from
7025 a modeline, see |sandbox-option|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007026
7027 It is not allowed to change text or jump to another window while
7028 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029
7030 If the statusline is not updated when you want it (e.g., after setting
7031 a variable that's used in an expression), you can force an update by
7032 setting an option without changing its value. Example: >
7033 :let &ro = &ro
7034
7035< A result of all digits is regarded a number for display purposes.
7036 Otherwise the result is taken as flag text and applied to the rules
7037 described above.
7038
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007039 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
7041 edit your .vimrc or whatever with "vim -u NONE" to get it right.
7042
7043 Examples:
7044 Emulate standard status line with 'ruler' set >
7045 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7046< Similar, but add ASCII value of char under the cursor (like "ga") >
7047 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7048< Display byte count and byte value, modified flag in red. >
7049 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7050 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7051< Display a ,GZ flag if a compressed file is loaded >
7052 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7053< In the |:autocmd|'s: >
7054 :let b:gzflag = 1
7055< And: >
7056 :unlet b:gzflag
7057< And define this function: >
7058 :function VarExists(var, val)
7059 : if exists(a:var) | return a:val | else | return '' | endif
7060 :endfunction
7061<
7062 *'suffixes'* *'su'*
7063'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7064 global
7065 {not in Vi}
7066 Files with these suffixes get a lower priority when multiple files
7067 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007068 suffixes. Spaces after the comma are ignored. A dot is also seen as
7069 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007070 separator, precede it with a backslash (see |option-backslash| about
7071 including spaces and backslashes).
7072 See 'wildignore' for completely ignoring files.
7073 The use of |:set+=| and |:set-=| is preferred when adding or removing
7074 suffixes from the list. This avoids problems when a future version
7075 uses another default.
7076
7077 *'suffixesadd'* *'sua'*
7078'suffixesadd' 'sua' string (default "")
7079 local to buffer
7080 {not in Vi}
7081 {not available when compiled without the
7082 |+file_in_path| feature}
7083 Comma separated list of suffixes, which are used when searching for a
7084 file for the "gf", "[I", etc. commands. Example: >
7085 :set suffixesadd=.java
7086<
7087 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7088'swapfile' 'swf' boolean (default on)
7089 local to buffer
7090 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007091 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 swapfile is not wanted for a specific buffer. For example, with
7093 confidential information that even root must not be able to access.
7094 Careful: All text will be in memory:
7095 - Don't use this for big files.
7096 - Recovery will be impossible!
7097 A swapfile will only be present when |'updatecount'| is non-zero and
7098 'swapfile' is set.
7099 When 'swapfile' is reset, the swap file for the current buffer is
7100 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7101 non-zero, a swap file is immediately created.
7102 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007103 If you want to open a new buffer without creating a swap file for it,
7104 use the |:noswapfile| modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105
7106 This option is used together with 'bufhidden' and 'buftype' to
7107 specify special kinds of buffers. See |special-buffers|.
7108
7109 *'swapsync'* *'sws'*
7110'swapsync' 'sws' string (default "fsync")
7111 global
7112 {not in Vi}
7113 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007114 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 When this option is empty parts of the swap file may be in memory and
7116 not written to disk. When the system crashes you may lose more work.
7117 On Unix the system does a sync now and then without Vim asking for it,
7118 so the disadvantage of setting this option off is small. On some
7119 systems the swap file will not be written at all. For a unix system
7120 setting it to "sync" will use the sync() call instead of the default
7121 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007122 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007123
7124 *'switchbuf'* *'swb'*
7125'switchbuf' 'swb' string (default "")
7126 global
7127 {not in Vi}
7128 This option controls the behavior when switching between buffers.
7129 Possible values (comma separated list):
7130 useopen If included, jump to the first open window that
7131 contains the specified buffer (if there is one).
7132 Otherwise: Do not examine other windows.
7133 This setting is checked with |quickfix| commands, when
7134 jumping to errors (":cc", ":cn", "cp", etc.). It is
7135 also used in all buffer related split commands, for
7136 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007137 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007138 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007140 a buffer for a |quickfix| command that display errors.
7141 Otherwise: do not split, use current window.
Bram Moolenaara594d772015-06-19 14:41:49 +02007142 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007143 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007144 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007146 *'synmaxcol'* *'smc'*
7147'synmaxcol' 'smc' number (default 3000)
7148 local to buffer
7149 {not in Vi}
7150 {not available when compiled without the |+syntax|
7151 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007152 Maximum column in which to search for syntax items. In long lines the
7153 text after this column is not highlighted and following lines may not
7154 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007155 This helps to avoid very slow redrawing for an XML file that is one
7156 long line.
7157 Set to zero to remove the limit.
7158
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 *'syntax'* *'syn'*
7160'syntax' 'syn' string (default empty)
7161 local to buffer
7162 {not in Vi}
7163 {not available when compiled without the |+syntax|
7164 feature}
7165 When this option is set, the syntax with this name is loaded, unless
7166 syntax highlighting has been switched off with ":syntax off".
7167 Otherwise this option does not always reflect the current syntax (the
7168 b:current_syntax variable does).
7169 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007170 not automatically recognized. Example, in an IDL file:
7171 /* vim: set syntax=idl : */ ~
7172 When a dot appears in the value then this separates two filetype
7173 names. Example:
7174 /* vim: set syntax=c.doxygen : */ ~
7175 This will use the "c" syntax first, then the "doxygen" syntax.
7176 Note that the second one must be prepared to be loaded as an addition,
7177 otherwise it will be skipped. More than one dot may appear.
7178 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 :set syntax=OFF
7180< To switch syntax highlighting on according to the current value of the
7181 'filetype' option: >
7182 :set syntax=ON
7183< What actually happens when setting the 'syntax' option is that the
7184 Syntax autocommand event is triggered with the value as argument.
7185 This option is not copied to another buffer, independent of the 's' or
7186 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007187 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007189 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007190'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007191 global
7192 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007193 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007194 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007195 When nonempty, this option determines the content of the tab pages
7196 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007197 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007198
7199 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007200 option and only when there is no GUI tab line. When 'e' is in
7201 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007202 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007203
7204 The value is evaluated like with 'statusline'. You can use
7205 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007206 the text to be displayed. Use "%1T" for the first label, "%2T" for
7207 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007208
7209 Keep in mind that only one of the tab pages is the current one, others
7210 are invisible and you can't jump to their windows.
7211
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007212
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007213 *'tabpagemax'* *'tpm'*
7214'tabpagemax' 'tpm' number (default 10)
7215 global
7216 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007217 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007218 feature}
7219 Maximum number of tab pages to be opened by the |-p| command line
7220 argument or the ":tab all" command. |tabpage|
7221
7222
7223 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224'tabstop' 'ts' number (default 8)
7225 local to buffer
7226 Number of spaces that a <Tab> in the file counts for. Also see
7227 |:retab| command, and 'softtabstop' option.
7228
7229 Note: Setting 'tabstop' to any other value than 8 can make your file
7230 appear wrong in many places (e.g., when printing it).
7231
7232 There are four main ways to use tabs in Vim:
7233 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7234 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007235 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 behave like a tab appears every 4 (or 3) characters.
7237 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7238 'expandtab'. This way you will always insert spaces. The
7239 formatting will never be messed up when 'tabstop' is changed.
7240 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007241 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 works when using Vim to edit the file.
7243 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7244 'noexpandtab'. This should then work (for initial indents only)
7245 for any tabstop setting that people use. It might be nice to have
7246 tabs after the first non-blank inserted as spaces if you do this
7247 though. Otherwise aligned comments will be wrong when 'tabstop' is
7248 changed.
7249
7250 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7251'tagbsearch' 'tbs' boolean (default on)
7252 global
7253 {not in Vi}
7254 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007255 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007256 searching makes searching for a tag a LOT faster, but a linear search
7257 will find more tags if the tags file wasn't properly sorted.
7258 Vim normally assumes that your tags files are sorted, or indicate that
7259 they are not sorted. Only when this is not the case does the
7260 'tagbsearch' option need to be switched off.
7261
7262 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007263 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 certain files, or retry all files with a linear search. When
7265 'tagbsearch' is off, only a linear search is done.
7266
7267 Linear searching is done anyway, for one file, when Vim finds a line
7268 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007269 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270< [The whitespace before and after the '0' must be a single <Tab>]
7271
7272 When a binary search was done and no match was found in any of the
7273 files listed in 'tags', and 'ignorecase' is set or a pattern is used
7274 instead of a normal tag name, a retry is done with a linear search.
7275 Tags in unsorted tags files, and matches with different case will only
7276 be found in the retry.
7277
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007278 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279 linear search can be avoided for the 'ignorecase' case. Use a value
7280 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
7281 case-fold sorted with the -f switch to "sort" in most unices, as in
7282 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007283 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
7284 for this as well. Note that case must be folded to uppercase for this
7285 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286
7287 When 'tagbsearch' is off, tags searching is slower when a full match
7288 exists, but faster when no full match exists. Tags in unsorted tags
7289 files may only be found with 'tagbsearch' off.
7290 When the tags file is not sorted, or sorted in a wrong way (not on
7291 ASCII byte value), 'tagbsearch' should be off, or the line given above
7292 must be included in the tags file.
7293 This option doesn't affect commands that find all matching tags (e.g.,
7294 command-line completion and ":help").
7295 {Vi: always uses binary search in some versions}
7296
7297 *'taglength'* *'tl'*
7298'taglength' 'tl' number (default 0)
7299 global
7300 If non-zero, tags are significant up to this number of characters.
7301
7302 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7303'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7304 global
7305 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007306 If on and using a tags file in another directory, file names in that
7307 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308 NOTE: This option is set to the Vi default value when 'compatible' is
7309 set and to the Vim default value when 'compatible' is reset.
7310
7311 *'tags'* *'tag'* *E433*
7312'tags' 'tag' string (default "./tags,tags", when compiled with
7313 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7314 global or local to buffer |global-local|
7315 Filenames for the tag command, separated by spaces or commas. To
7316 include a space or comma in a file name, precede it with a backslash
7317 (see |option-backslash| about including spaces and backslashes).
7318 When a file name starts with "./", the '.' is replaced with the path
7319 of the current file. But only when the 'd' flag is not included in
7320 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7321 |tags-option|.
7322 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007323 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7324 find all files named "tags" below "/lib". The filename itself cannot
7325 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7326 files called "tags?". {not available when compiled without the
7327 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007328 The |tagfiles()| function can be used to get a list of the file names
7329 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7331 files are also supported. They are automatically recognized. The
7332 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7333 differences are ignored (MS-Windows). |emacs-tags|
7334 The use of |:set+=| and |:set-=| is preferred when adding or removing
7335 file names from the list. This avoids problems when a future version
7336 uses another default.
7337 {Vi: default is "tags /usr/lib/tags"}
7338
7339 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7340'tagstack' 'tgst' boolean (default on)
7341 global
7342 {not in all versions of Vi}
7343 When on, the |tagstack| is used normally. When off, a ":tag" or
7344 ":tselect" command with an argument will not push the tag onto the
7345 tagstack. A following ":tag" without an argument, a ":pop" command or
7346 any other command that uses the tagstack will use the unmodified
7347 tagstack, but does change the pointer to the active entry.
7348 Resetting this option is useful when using a ":tag" command in a
7349 mapping which should not change the tagstack.
7350
7351 *'term'* *E529* *E530* *E531*
7352'term' string (default is $TERM, if that fails:
7353 in the GUI: "builtin_gui"
7354 on Amiga: "amiga"
7355 on BeOS: "beos-ansi"
7356 on Mac: "mac-ansi"
7357 on MiNT: "vt52"
7358 on MS-DOS: "pcterm"
7359 on OS/2: "os2ansi"
7360 on Unix: "ansi"
7361 on VMS: "ansi"
7362 on Win 32: "win32")
7363 global
7364 Name of the terminal. Used for choosing the terminal control
7365 characters. Environment variables are expanded |:set_env|.
7366 For example: >
7367 :set term=$TERM
7368< See |termcap|.
7369
7370 *'termbidi'* *'tbidi'*
7371 *'notermbidi'* *'notbidi'*
7372'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7373 global
7374 {not in Vi}
7375 {only available when compiled with the |+arabic|
7376 feature}
7377 The terminal is in charge of Bi-directionality of text (as specified
7378 by Unicode). The terminal is also expected to do the required shaping
7379 that some languages (such as Arabic) require.
7380 Setting this option implies that 'rightleft' will not be set when
7381 'arabic' is set and the value of 'arabicshape' will be ignored.
7382 Note that setting 'termbidi' has the immediate effect that
7383 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7384 This option is reset when the GUI is started.
7385 For further details see |arabic.txt|.
7386
7387 *'termencoding'* *'tenc'*
7388'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7389 Macintosh GUI: "macroman")
7390 global
7391 {only available when compiled with the |+multi_byte|
7392 feature}
7393 {not in Vi}
7394 Encoding used for the terminal. This specifies what character
7395 encoding the keyboard produces and the display will understand. For
Bram Moolenaar34700a62013-03-07 13:20:54 +01007396 the GUI it only applies to the keyboard ( 'encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007397 display). Except for the Mac when 'macatsui' is off, then
7398 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 In the Win32 console version the default value is the console codepage
7400 when it differs from the ANSI codepage.
7401 *E617*
7402 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7403 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7404 Any attempts to set a different value will be rejected, and an error
7405 message is shown.
7406 For the Win32 GUI 'termencoding' is not used for typed characters,
7407 because the Win32 system always passes Unicode characters.
7408 When empty, the same encoding is used as for the 'encoding' option.
7409 This is the normal value.
7410 Not all combinations for 'termencoding' and 'encoding' are valid. See
7411 |encoding-table|.
7412 The value for this option must be supported by internal conversions or
7413 iconv(). When this is not possible no conversion will be done and you
7414 will probably experience problems with non-ASCII characters.
7415 Example: You are working with the locale set to euc-jp (Japanese) and
7416 want to edit a UTF-8 file: >
7417 :let &termencoding = &encoding
7418 :set encoding=utf-8
7419< You need to do this when your system has no locale support for UTF-8.
7420
7421 *'terse'* *'noterse'*
7422'terse' boolean (default off)
7423 global
7424 When set: Add 's' flag to 'shortmess' option (this makes the message
7425 for a search that hits the start or end of the file not being
7426 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7427 shortens a lot of messages}
7428
7429 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7430'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7431 global
7432 {not in Vi}
7433 This option is obsolete. Use 'fileformats'.
7434 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7435 set to the default value for the current system. When 'textauto' is
7436 reset, 'fileformats' is made empty.
7437 NOTE: This option is set to the Vi default value when 'compatible' is
7438 set and to the Vim default value when 'compatible' is reset.
7439
7440 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7441'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7442 others: default off)
7443 local to buffer
7444 {not in Vi}
7445 This option is obsolete. Use 'fileformat'.
7446 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7447 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7448 "unix".
7449
7450 *'textwidth'* *'tw'*
7451'textwidth' 'tw' number (default 0)
7452 local to buffer
7453 {not in Vi}
7454 Maximum width of text that is being inserted. A longer line will be
7455 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007456 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7457 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007458 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007459 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 NOTE: This option is set to 0 when 'compatible' is set.
7461
7462 *'thesaurus'* *'tsr'*
7463'thesaurus' 'tsr' string (default "")
7464 global or local to buffer |global-local|
7465 {not in Vi}
7466 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007467 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007468 the file should contain words with similar meaning, separated by
7469 non-keyword characters (white space is preferred). Maximum line
7470 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007471 To obtain a file to be used here, check out this ftp site:
7472 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007473 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 after a comma are ignored, otherwise spaces are included in the file
7475 name. See |option-backslash| about using backslashes.
7476 The use of |:set+=| and |:set-=| is preferred when adding or removing
7477 directories from the list. This avoids problems when a future version
7478 uses another default.
7479 Backticks cannot be used in this option for security reasons.
7480
7481 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7482'tildeop' 'top' boolean (default off)
7483 global
7484 {not in Vi}
7485 When on: The tilde command "~" behaves like an operator.
7486 NOTE: This option is reset when 'compatible' is set.
7487
7488 *'timeout'* *'to'* *'notimeout'* *'noto'*
7489'timeout' 'to' boolean (default on)
7490 global
7491 *'ttimeout'* *'nottimeout'*
7492'ttimeout' boolean (default off)
7493 global
7494 {not in Vi}
7495 These two options together determine the behavior when part of a
7496 mapped key sequence or keyboard code has been received:
7497
7498 'timeout' 'ttimeout' action ~
7499 off off do not time out
7500 on on or off time out on :mappings and key codes
7501 off on time out on key codes
7502
7503 If both options are off, Vim will wait until either the complete
7504 mapping or key sequence has been received, or it is clear that there
7505 is no mapping or key sequence for the received characters. For
7506 example: if you have mapped "vl" and Vim has received 'v', the next
7507 character is needed to see if the 'v' is followed by an 'l'.
7508 When one of the options is on, Vim will wait for about 1 second for
7509 the next character to arrive. After that the already received
7510 characters are interpreted as single characters. The waiting time can
7511 be changed with the 'timeoutlen' option.
7512 On slow terminals or very busy systems timing out may cause
7513 malfunctioning cursor keys. If both options are off, Vim waits
7514 forever after an entered <Esc> if there are key codes that start
7515 with <Esc>. You will have to type <Esc> twice. If you do not have
7516 problems with key codes, but would like to have :mapped key
7517 sequences not timing out in 1 second, set the 'ttimeout' option and
7518 reset the 'timeout' option.
7519
7520 NOTE: 'ttimeout' is reset when 'compatible' is set.
7521
7522 *'timeoutlen'* *'tm'*
7523'timeoutlen' 'tm' number (default 1000)
7524 global
7525 {not in all versions of Vi}
7526 *'ttimeoutlen'* *'ttm'*
7527'ttimeoutlen' 'ttm' number (default -1)
7528 global
7529 {not in Vi}
7530 The time in milliseconds that is waited for a key code or mapped key
7531 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7532 when part of a command has been typed.
7533 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7534 different timeout value for key codes is desired set 'ttimeoutlen' to
7535 a non-negative number.
7536
7537 ttimeoutlen mapping delay key code delay ~
7538 < 0 'timeoutlen' 'timeoutlen'
7539 >= 0 'timeoutlen' 'ttimeoutlen'
7540
7541 The timeout only happens when the 'timeout' and 'ttimeout' options
7542 tell so. A useful setting would be >
7543 :set timeout timeoutlen=3000 ttimeoutlen=100
7544< (time out on mapping after three seconds, time out on key codes after
7545 a tenth of a second).
7546
7547 *'title'* *'notitle'*
7548'title' boolean (default off, on when title can be restored)
7549 global
7550 {not in Vi}
7551 {not available when compiled without the |+title|
7552 feature}
7553 When on, the title of the window will be set to the value of
7554 'titlestring' (if it is not empty), or to:
7555 filename [+=-] (path) - VIM
7556 Where:
7557 filename the name of the file being edited
7558 - indicates the file cannot be modified, 'ma' off
7559 + indicates the file was modified
7560 = indicates the file is read-only
7561 =+ indicates the file is read-only and modified
7562 (path) is the path of the file being edited
7563 - VIM the server name |v:servername| or "VIM"
7564 Only works if the terminal supports setting window titles
7565 (currently Amiga console, Win32 console, all GUI versions and
7566 terminals with a non- empty 't_ts' option - these are Unix xterm and
7567 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7568 *X11*
7569 When Vim was compiled with HAVE_X11 defined, the original title will
7570 be restored if possible. The output of ":version" will include "+X11"
7571 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7572 works for the icon name |'icon'|.
7573 But: When Vim was started with the |-X| argument, restoring the title
7574 will not work (except in the GUI).
7575 If the title cannot be restored, it is set to the value of 'titleold'.
7576 You might want to restore the title outside of Vim then.
7577 When using an xterm from a remote machine you can use this command:
7578 rsh machine_name xterm -display $DISPLAY &
7579 then the WINDOWID environment variable should be inherited and the
7580 title of the window should change back to what it should be after
7581 exiting Vim.
7582
7583 *'titlelen'*
7584'titlelen' number (default 85)
7585 global
7586 {not in Vi}
7587 {not available when compiled without the |+title|
7588 feature}
7589 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007590 title. When the title is longer, only the end of the path name is
7591 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007592 Using a percentage makes this adapt to the width of the window. But
7593 it won't work perfectly, because the actual number of characters
7594 available also depends on the font used and other things in the title
7595 bar. When 'titlelen' is zero the full path is used. Otherwise,
7596 values from 1 to 30000 percent can be used.
7597 'titlelen' is also used for the 'titlestring' option.
7598
7599 *'titleold'*
7600'titleold' string (default "Thanks for flying Vim")
7601 global
7602 {not in Vi}
7603 {only available when compiled with the |+title|
7604 feature}
7605 This option will be used for the window title when exiting Vim if the
7606 original title cannot be restored. Only happens if 'title' is on or
7607 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007608 This option cannot be set from a |modeline| or in the |sandbox|, for
7609 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610 *'titlestring'*
7611'titlestring' string (default "")
7612 global
7613 {not in Vi}
7614 {not available when compiled without the |+title|
7615 feature}
7616 When this option is not empty, it will be used for the title of the
7617 window. This happens only when the 'title' option is on.
7618 Only works if the terminal supports setting window titles (currently
7619 Amiga console, Win32 console, all GUI versions and terminals with a
7620 non-empty 't_ts' option).
7621 When Vim was compiled with HAVE_X11 defined, the original title will
7622 be restored if possible |X11|.
7623 When this option contains printf-style '%' items, they will be
7624 expanded according to the rules used for 'statusline'.
7625 Example: >
7626 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7627 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7628< The value of 'titlelen' is used to align items in the middle or right
7629 of the available space.
7630 Some people prefer to have the file name first: >
7631 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7632< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007633 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 separating space only when needed.
7635 NOTE: Use of special characters in 'titlestring' may cause the display
7636 to be garbled (e.g., when it contains a CR or NL character).
7637 {not available when compiled without the |+statusline| feature}
7638
7639 *'toolbar'* *'tb'*
7640'toolbar' 'tb' string (default "icons,tooltips")
7641 global
7642 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7643 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007644 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 possible values are:
7646 icons Toolbar buttons are shown with icons.
7647 text Toolbar buttons shown with text.
7648 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007649 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007650 tooltips Tooltips are active for toolbar buttons.
7651 Tooltips refer to the popup help text which appears after the mouse
7652 cursor is placed over a toolbar button for a brief moment.
7653
7654 If you want the toolbar to be shown with icons as well as text, do the
7655 following: >
7656 :set tb=icons,text
7657< Motif and Athena cannot display icons and text at the same time. They
7658 will show icons if both are requested.
7659
7660 If none of the strings specified in 'toolbar' are valid or if
7661 'toolbar' is empty, this option is ignored. If you want to disable
7662 the toolbar, you need to set the 'guioptions' option. For example: >
7663 :set guioptions-=T
7664< Also see |gui-toolbar|.
7665
7666 *'toolbariconsize'* *'tbis'*
7667'toolbariconsize' 'tbis' string (default "small")
7668 global
7669 {not in Vi}
7670 {only in the GTK+ 2 GUI}
7671 Controls the size of toolbar icons. The possible values are:
7672 tiny Use tiny toolbar icons.
7673 small Use small toolbar icons (default).
7674 medium Use medium-sized toolbar icons.
7675 large Use large toolbar icons.
7676 The exact dimensions in pixels of the various icon sizes depend on
7677 the current theme. Common dimensions are large=32x32, medium=24x24,
7678 small=20x20 and tiny=16x16.
7679
7680 If 'toolbariconsize' is empty, the global default size as determined
7681 by user preferences or the current theme is used.
7682
7683 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7684'ttybuiltin' 'tbi' boolean (default on)
7685 global
7686 {not in Vi}
7687 When on, the builtin termcaps are searched before the external ones.
7688 When off the builtin termcaps are searched after the external ones.
7689 When this option is changed, you should set the 'term' option next for
7690 the change to take effect, for example: >
7691 :set notbi term=$TERM
7692< See also |termcap|.
7693 Rationale: The default for this option is "on", because the builtin
7694 termcap entries are generally better (many systems contain faulty
7695 xterm entries...).
7696
7697 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7698'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7699 sun-cmd, screen, rxvt, dtterm or
7700 iris-ansi; also on when running Vim in
7701 a DOS console)
7702 global
7703 {not in Vi}
7704 Indicates a fast terminal connection. More characters will be sent to
7705 the screen for redrawing, instead of using insert/delete line
7706 commands. Improves smoothness of redrawing when there are multiple
7707 windows and the terminal does not support a scrolling region.
7708 Also enables the extra writing of characters at the end of each screen
7709 line for lines that wrap. This helps when using copy/paste with the
7710 mouse in an xterm and other terminals.
7711
7712 *'ttymouse'* *'ttym'*
7713'ttymouse' 'ttym' string (default depends on 'term')
7714 global
7715 {not in Vi}
7716 {only in Unix and VMS, doesn't work in the GUI; not
7717 available when compiled without |+mouse|}
7718 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007719 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 *xterm-mouse*
7721 xterm xterm-like mouse handling. The mouse generates
7722 "<Esc>[Mscr", where "scr" is three bytes:
7723 "s" = button state
7724 "c" = column plus 33
7725 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02007726 This only works up to 223 columns! See "dec",
7727 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007728 xterm2 Works like "xterm", but with the xterm reporting the
7729 mouse position while the mouse is dragged. This works
7730 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007731 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 work. See below for how Vim detects this
7733 automatically.
7734 *netterm-mouse*
7735 netterm NetTerm mouse handling. The mouse generates
7736 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7737 for the row and column.
7738 *dec-mouse*
7739 dec DEC terminal mouse handling. The mouse generates a
7740 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007741 This is also available for an Xterm, if it was
7742 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007743 *jsbterm-mouse*
7744 jsbterm JSB term mouse handling.
7745 *pterm-mouse*
7746 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007747 *urxvt-mouse*
7748 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02007749 The mouse works only if the terminal supports this
7750 encoding style, but it does not have 223 columns limit
7751 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02007752 *sgr-mouse*
7753 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02007754 mouse reporting. The mouse works even in columns
7755 beyond 223. This option is backward compatible with
7756 "xterm2" because it can also decode "xterm2" style
7757 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758
7759 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02007760 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
7761 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007762 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7763 recognized, if enabled at compile time. DEC terminal mouse codes
7764 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02007765 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
7766 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00007767 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaare968e362014-05-13 20:23:24 +02007768 set to a name that starts with "xterm", "mlterm", or "screen", and
7769 'ttymouse' is not set already.
7770 Additionally, if vim is compiled with the |+termresponse| feature and
7771 |t_RV| is set to the escape sequence to request the xterm version
7772 number, more intelligent detection process runs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaare968e362014-05-13 20:23:24 +02007774 from 95 to 276. The "sgr" value will be set if the xterm version is
7775 277 or highter.
7776 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
7777 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007778 :set t_RV=
7779<
7780 *'ttyscroll'* *'tsl'*
7781'ttyscroll' 'tsl' number (default 999)
7782 global
7783 Maximum number of lines to scroll the screen. If there are more lines
7784 to scroll the window is redrawn. For terminals where scrolling is
7785 very slow and redrawing is not slow this can be set to a small number,
7786 e.g., 3, to speed up displaying.
7787
7788 *'ttytype'* *'tty'*
7789'ttytype' 'tty' string (default from $TERM)
7790 global
7791 Alias for 'term', see above.
7792
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007793 *'undodir'* *'udir'*
7794'undodir' 'udir' string (default ".")
7795 global
7796 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007797 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007798 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007799 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007800 "." means using the directory of the file. The undo file name for
7801 "file.txt" is ".file.txt.un~".
7802 For other directories the file name is the full path of the edited
7803 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007804 When writing: The first directory that exists is used. "." always
7805 works, no directories after "." will be used for writing.
7806 When reading all entries are tried to find an undo file. The first
7807 undo file that exists is used. When it cannot be read an error is
7808 given, no further entry is used.
7809 See |undo-persistence|.
7810
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02007811 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007812'undofile' 'udf' boolean (default off)
7813 local to buffer
7814 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007815 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007816 When on, Vim automatically saves undo history to an undo file when
7817 writing a buffer to a file, and restores undo history from the same
7818 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007819 The directory where the undo file is stored is specified by 'undodir'.
7820 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007821 The undo file is not read when 'undoreload' causes the buffer from
7822 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01007823 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007824
Bram Moolenaar071d4272004-06-13 20:20:40 +00007825 *'undolevels'* *'ul'*
7826'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7827 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007828 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 {not in Vi}
7830 Maximum number of changes that can be undone. Since undo information
7831 is kept in memory, higher numbers will cause more memory to be used
7832 (nevertheless, a single change can use an unlimited amount of memory).
7833 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7834 itself: >
7835 set ul=0
7836< But you can also get Vi compatibility by including the 'u' flag in
7837 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007838 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01007839 Set to -1 for no undo at all. You might want to do this only for the
7840 current buffer: >
7841 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00007842< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01007843
7844 The local value is set to -123456 when the global value is to be used.
7845
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007846 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007848 *'undoreload'* *'ur'*
7849'undoreload' 'ur' number (default 10000)
7850 global
7851 {not in Vi}
7852 Save the whole buffer for undo when reloading it. This applies to the
7853 ":e!" command and reloading for when the buffer changed outside of
7854 Vim. |FileChangedShell|
7855 The save only happens when this options is negative or when the number
7856 of lines is smaller than the value of this option.
7857 Set this option to zero to disable undo for a reload.
7858
7859 When saving undo for a reload, any undo file is not read.
7860
7861 Note that this causes the whole buffer to be stored in memory. Set
7862 this option to a lower value if you run out of memory.
7863
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *'updatecount'* *'uc'*
7865'updatecount' 'uc' number (default: 200)
7866 global
7867 {not in Vi}
7868 After typing this many characters the swap file will be written to
7869 disk. When zero, no swap file will be created at all (see chapter on
7870 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7871 Vim with the "-n" option, see |startup|. When editing in readonly
7872 mode this option will be initialized to 10000.
7873 The swapfile can be disabled per buffer with |'swapfile'|.
7874 When 'updatecount' is set from zero to non-zero, swap files are
7875 created for all buffers that have 'swapfile' set. When 'updatecount'
7876 is set to zero, existing swap files are not deleted.
7877 Also see |'swapsync'|.
7878 This option has no meaning in buffers where |'buftype'| is "nofile"
7879 or "nowrite".
7880
7881 *'updatetime'* *'ut'*
7882'updatetime' 'ut' number (default 4000)
7883 global
7884 {not in Vi}
7885 If this many milliseconds nothing is typed the swap file will be
7886 written to disk (see |crash-recovery|). Also used for the
7887 |CursorHold| autocommand event.
7888
7889 *'verbose'* *'vbs'*
7890'verbose' 'vbs' number (default 0)
7891 global
7892 {not in Vi, although some versions have a boolean
7893 verbose option}
7894 When bigger than zero, Vim will give messages about what it is doing.
7895 Currently, these messages are given:
7896 >= 1 When the viminfo file is read or written.
7897 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007898 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 >= 8 Files for which a group of autocommands is executed.
7900 >= 9 Every executed autocommand.
7901 >= 12 Every executed function.
7902 >= 13 When an exception is thrown, caught, finished, or discarded.
7903 >= 14 Anything pending in a ":finally" clause.
7904 >= 15 Every executed Ex command (truncated at 200 characters).
7905
7906 This option can also be set with the "-V" argument. See |-V|.
7907 This option is also set by the |:verbose| command.
7908
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007909 When the 'verbosefile' option is set then the verbose messages are not
7910 displayed.
7911
7912 *'verbosefile'* *'vfile'*
7913'verbosefile' 'vfile' string (default empty)
7914 global
7915 {not in Vi}
7916 When not empty all messages are written in a file with this name.
7917 When the file exists messages are appended.
7918 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007919 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007920 Setting 'verbosefile' to a new value is like making it empty first.
7921 The difference with |:redir| is that verbose messages are not
7922 displayed when 'verbosefile' is set.
7923
Bram Moolenaar071d4272004-06-13 20:20:40 +00007924 *'viewdir'* *'vdir'*
7925'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7926 "$VIM/vimfiles/view",
7927 for Unix: "~/.vim/view",
7928 for Macintosh: "$VIM:vimfiles:view"
7929 for VMS: "sys$login:vimfiles/view"
7930 for RiscOS: "Choices:vimfiles/view")
7931 global
7932 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007933 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 feature}
7935 Name of the directory where to store files for |:mkview|.
7936 This option cannot be set from a |modeline| or in the |sandbox|, for
7937 security reasons.
7938
7939 *'viewoptions'* *'vop'*
7940'viewoptions' 'vop' string (default: "folds,options,cursor")
7941 global
7942 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007943 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 feature}
7945 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007946 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 word save and restore ~
7948 cursor cursor position in file and in window
7949 folds manually created folds, opened/closed folds and local
7950 fold options
7951 options options and mappings local to a window or buffer (not
7952 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02007953 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007954 slash backslashes in file names replaced with forward
7955 slashes
7956 unix with Unix end-of-line format (single <NL>), even when
7957 on Windows or DOS
7958
7959 "slash" and "unix" are useful on Windows when sharing view files
7960 with Unix. The Unix version of Vim cannot source dos format scripts,
7961 but the Windows version of Vim can source unix format scripts.
7962
7963 *'viminfo'* *'vi'* *E526* *E527* *E528*
7964'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007965 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7966 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7967 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007968 global
7969 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007970 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 feature}
7972 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007973 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007974 separated list of parameters, each consisting of a single character
7975 identifying the particular parameter, followed by a number or string
7976 which specifies the value of that parameter. If a particular
7977 character is left out, then the default value is used for that
7978 parameter. The following is a list of the identifying characters and
7979 the effect of their value.
7980 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007981 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 ! When included, save and restore global variables that start
7983 with an uppercase letter, and don't contain a lowercase
7984 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007985 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007986 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007987 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007988 " Maximum number of lines saved for each register. Old name of
7989 the '<' item, with the disadvantage that you need to put a
7990 backslash before the ", otherwise it will be recognized as the
7991 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007992 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 % When included, save and restore the buffer list. If Vim is
7994 started with a file name argument, the buffer list is not
7995 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007996 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 without a file name and buffers for help files are not written
7998 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007999 When followed by a number, the number specifies the maximum
8000 number of buffers that are stored. Without a number all
8001 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008002 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008003 ' Maximum number of previously edited files for which the marks
8004 are remembered. This parameter must always be included when
8005 'viminfo' is non-empty.
8006 Including this item also means that the |jumplist| and the
8007 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008008 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008009 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008010 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 patterns are also saved. When not included, the value of
8012 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008013 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008015 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008016 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008017 < Maximum number of lines saved for each register. If zero then
8018 registers are not saved. When not included, all lines are
8019 saved. '"' is the old name for this item.
8020 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008021 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008023 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008024 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 c When included, convert the text in the viminfo file from the
8026 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008027 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008028 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 f Whether file marks need to be stored. If zero, file marks ('0
8030 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008031 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008033 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008034 h Disable the effect of 'hlsearch' when loading the viminfo
8035 file. When not included, it depends on whether ":nohlsearch"
8036 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008037 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038 n Name of the viminfo file. The name must immediately follow
8039 the 'n'. Must be the last one! If the "-i" argument was
8040 given when starting Vim, that file name overrides the one
8041 given here with 'viminfo'. Environment variables are expanded
8042 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008043 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 r Removable media. The argument is a string (up to the next
8045 ','). This parameter can be given several times. Each
8046 specifies the start of a path for which no marks will be
8047 stored. This is to avoid removable media. For MS-DOS you
8048 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8049 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8050 ignored. Maximum length of each 'r' argument is 50
8051 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008052 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008053 s Maximum size of an item in Kbyte. If zero then registers are
8054 not saved. Currently only applies to registers. The default
8055 "s10" will exclude registers with more than 10 Kbyte of text.
8056 Also see the '<' item above: line count limit.
8057
8058 Example: >
8059 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8060<
8061 '50 Marks will be remembered for the last 50 files you
8062 edited.
8063 <1000 Contents of registers (up to 1000 lines each) will be
8064 remembered.
8065 s100 Registers with more than 100 Kbyte text are skipped.
8066 :0 Command-line history will not be saved.
8067 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8068 no / Since '/' is not specified, the default will be used,
8069 that is, save all of the search history, and also the
8070 previous search and substitute patterns.
8071 no % The buffer list will not be saved nor read back.
8072 no h 'hlsearch' highlighting will be restored.
8073
8074 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8075 load the contents of the file, this is not done automatically.
8076
8077 This option cannot be set from a |modeline| or in the |sandbox|, for
8078 security reasons.
8079
8080 *'virtualedit'* *'ve'*
8081'virtualedit' 've' string (default "")
8082 global
8083 {not in Vi}
8084 {not available when compiled without the
8085 |+virtualedit| feature}
8086 A comma separated list of these words:
8087 block Allow virtual editing in Visual block mode.
8088 insert Allow virtual editing in Insert mode.
8089 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008090 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008091
Bram Moolenaar071d4272004-06-13 20:20:40 +00008092 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008093 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 of the line. Useful for selecting a rectangle in Visual mode and
8095 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008096 "onemore" is not the same, it will only allow moving the cursor just
8097 after the last character of the line. This makes some commands more
8098 consistent. Previously the cursor was always past the end of the line
8099 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008100 break some plugins or Vim scripts. For example because |l| can move
8101 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008102 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008103 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008104 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008105 It doesn't make sense to combine "all" with "onemore", but you will
8106 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107
8108 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8109'visualbell' 'vb' boolean (default off)
8110 global
8111 {not in Vi}
8112 Use visual bell instead of beeping. The terminal code to display the
8113 visual bell is given with 't_vb'. When no beep or flash is wanted,
8114 use ":set vb t_vb=".
8115 Note: When the GUI starts, 't_vb' is reset to its default value. You
8116 might want to set it again in your |gvimrc|.
8117 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8118 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8119 where 40 is the time in msec.
8120 Does not work on the Amiga, you always get a screen flash.
8121 Also see 'errorbells'.
8122
8123 *'warn'* *'nowarn'*
8124'warn' boolean (default on)
8125 global
8126 Give a warning message when a shell command is used while the buffer
8127 has been changed.
8128
8129 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8130'weirdinvert' 'wiv' boolean (default off)
8131 global
8132 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008133 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008134 It is provided for backwards compatibility with version 4.x.
8135 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8136 vice versa. Has no effect when the GUI is running.
8137
8138 *'whichwrap'* *'ww'*
8139'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8140 global
8141 {not in Vi}
8142 Allow specified keys that move the cursor left/right to move to the
8143 previous/next line when the cursor is on the first/last character in
8144 the line. Concatenate characters to allow this for these keys:
8145 char key mode ~
8146 b <BS> Normal and Visual
8147 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008148 h "h" Normal and Visual (not recommended)
8149 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008150 < <Left> Normal and Visual
8151 > <Right> Normal and Visual
8152 ~ "~" Normal
8153 [ <Left> Insert and Replace
8154 ] <Right> Insert and Replace
8155 For example: >
8156 :set ww=<,>,[,]
8157< allows wrap only when cursor keys are used.
8158 When the movement keys are used in combination with a delete or change
8159 operator, the <EOL> also counts for a character. This makes "3h"
8160 different from "3dh" when the cursor crosses the end of a line. This
8161 is also true for "x" and "X", because they do the same as "dl" and
8162 "dh". If you use this, you may also want to use the mapping
8163 ":map <BS> X" to make backspace delete the character in front of the
8164 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008165 When 'l' is included and it is used after an operator at the end of a
8166 line then it will not move to the next line. This makes "dl", "cl",
8167 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008168 NOTE: This option is set to the Vi default value when 'compatible' is
8169 set and to the Vim default value when 'compatible' is reset.
8170
8171 *'wildchar'* *'wc'*
8172'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8173 global
8174 {not in Vi}
8175 Character you have to type to start wildcard expansion in the
8176 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008177 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008178 The character is not recognized when used inside a macro. See
8179 'wildcharm' for that.
8180 Although 'wc' is a number option, you can set it to a special key: >
8181 :set wc=<Esc>
8182< NOTE: This option is set to the Vi default value when 'compatible' is
8183 set and to the Vim default value when 'compatible' is reset.
8184
8185 *'wildcharm'* *'wcm'*
8186'wildcharm' 'wcm' number (default: none (0))
8187 global
8188 {not in Vi}
8189 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008190 recognized when used inside a macro. You can find "spare" command-line
8191 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008192 you'll never actually type 'wildcharm', just use it in mappings that
8193 automatically invoke completion mode, e.g.: >
8194 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008195 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196< Then after typing :ss you can use CTRL-P & CTRL-N.
8197
8198 *'wildignore'* *'wig'*
8199'wildignore' 'wig' string (default "")
8200 global
8201 {not in Vi}
8202 {not available when compiled without the |+wildignore|
8203 feature}
8204 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008205 patterns is ignored when expanding |wildcards|, completing file or
8206 directory names, and influences the result of |expand()|, |glob()| and
8207 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008208 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8209 Also see 'suffixes'.
8210 Example: >
8211 :set wildignore=*.o,*.obj
8212< The use of |:set+=| and |:set-=| is preferred when adding or removing
8213 a pattern from the list. This avoids problems when a future version
8214 uses another default.
8215
Bram Moolenaar94950a92010-12-02 16:01:29 +01008216
Bram Moolenaar81af9252010-12-10 20:35:50 +01008217 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008218'wildignorecase' 'wic' boolean (default off)
8219 global
8220 {not in Vi}
8221 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008222 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008223 Does not apply when the shell is used to expand wildcards, which
8224 happens when there are special characters.
8225
8226
Bram Moolenaar071d4272004-06-13 20:20:40 +00008227 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
8228'wildmenu' 'wmnu' boolean (default off)
8229 global
8230 {not in Vi}
8231 {not available if compiled without the |+wildmenu|
8232 feature}
8233 When 'wildmenu' is on, command-line completion operates in an enhanced
8234 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8235 the possible matches are shown just above the command line, with the
8236 first match highlighted (overwriting the status line, if there is
8237 one). Keys that show the previous/next match, such as <Tab> or
8238 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8239 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8240 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008241 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008242 If there are more matches than can fit in the line, a ">" is shown on
8243 the right and/or a "<" is shown on the left. The status line scrolls
8244 as needed.
8245 The "wildmenu" mode is abandoned when a key is hit that is not used
8246 for selecting a completion.
8247 While the "wildmenu" is active the following keys have special
8248 meanings:
8249
8250 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8251 <Down> - in filename/menu name completion: move into a
8252 subdirectory or submenu.
8253 <CR> - in menu completion, when the cursor is just after a
8254 dot: move into a submenu.
8255 <Up> - in filename/menu name completion: move up into
8256 parent directory or parent menu.
8257
8258 This makes the menus accessible from the console |console-menus|.
8259
8260 If you prefer the <Left> and <Right> keys to move the cursor instead
8261 of selecting a different match, use this: >
8262 :cnoremap <Left> <Space><BS><Left>
8263 :cnoremap <Right> <Space><BS><Right>
8264<
8265 The "WildMenu" highlighting is used for displaying the current match
8266 |hl-WildMenu|.
8267
8268 *'wildmode'* *'wim'*
8269'wildmode' 'wim' string (Vim default: "full")
8270 global
8271 {not in Vi}
8272 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008273 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008274 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 first part specifies the behavior for the first use of 'wildchar',
8276 The second part for the second use, etc.
8277 These are the possible values for each part:
8278 "" Complete only the first match.
8279 "full" Complete the next full match. After the last match,
8280 the original string is used and then the first match
8281 again.
8282 "longest" Complete till longest common string. If this doesn't
8283 result in a longer string, use the next part.
8284 "longest:full" Like "longest", but also start 'wildmenu' if it is
8285 enabled.
8286 "list" When more than one match, list all matches.
8287 "list:full" When more than one match, list all matches and
8288 complete first match.
8289 "list:longest" When more than one match, list all matches and
8290 complete till longest common string.
8291 When there is only a single match, it is fully completed in all cases.
8292
8293 Examples: >
8294 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008295< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008296 :set wildmode=longest,full
8297< Complete longest common string, then each full match >
8298 :set wildmode=list:full
8299< List all matches and complete each full match >
8300 :set wildmode=list,full
8301< List all matches without completing, then each full match >
8302 :set wildmode=longest,list
8303< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008304 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008305
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008306 *'wildoptions'* *'wop'*
8307'wildoptions' 'wop' string (default "")
8308 global
8309 {not in Vi}
8310 {not available when compiled without the |+wildignore|
8311 feature}
8312 A list of words that change how command line completion is done.
8313 Currently only one word is allowed:
8314 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008315 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008316 is displayed per line. Often used tag kinds are:
8317 d #define
8318 f function
8319 Also see |cmdline-completion|.
8320
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 *'winaltkeys'* *'wak'*
8322'winaltkeys' 'wak' string (default "menu")
8323 global
8324 {not in Vi}
8325 {only used in Win32, Motif, GTK and Photon GUI}
8326 Some GUI versions allow the access to menu entries by using the ALT
8327 key in combination with a character that appears underlined in the
8328 menu. This conflicts with the use of the ALT key for mappings and
8329 entering special characters. This option tells what to do:
8330 no Don't use ALT keys for menus. ALT key combinations can be
8331 mapped, but there is no automatic handling. This can then be
8332 done with the |:simalt| command.
8333 yes ALT key handling is done by the windowing system. ALT key
8334 combinations cannot be mapped.
8335 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008336 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008337 keys can be mapped.
8338 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8339 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008340 This option is not used for <F10>; on Win32 and with GTK <F10> will
8341 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008342
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008343 *'window'* *'wi'*
8344'window' 'wi' number (default screen height - 1)
8345 global
8346 Window height. Do not confuse this with the height of the Vim window,
8347 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008348 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8349 value is smaller than 'lines' minus one. The screen will scroll
8350 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008351 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8352 in a much smarter way, taking care of wrapping lines.
8353 When resizing the Vim window, the value is smaller than 1 or more than
8354 or equal to 'lines' it will be set to 'lines' minus 1.
8355 {Vi also uses the option to specify the number of displayed lines}
8356
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 *'winheight'* *'wh'* *E591*
8358'winheight' 'wh' number (default 1)
8359 global
8360 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008361 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 feature}
8363 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008364 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008365 focus goes to a window that is smaller, its size is increased, at the
8366 cost of the height of other windows.
8367 Set 'winheight' to a small number for normal editing.
8368 Set it to 999 to make the current window fill most of the screen.
8369 Other windows will be only 'winminheight' high. This has the drawback
8370 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8371 to create only two windows, set the option after startup is done,
8372 using the |VimEnter| event: >
8373 au VimEnter * set winheight=999
8374< Minimum value is 1.
8375 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008376 height of the current window.
8377 'winheight' applies to the current window. Use 'winminheight' to set
8378 the minimal height for other windows.
8379
8380 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8381'winfixheight' 'wfh' boolean (default off)
8382 local to window
8383 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008384 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 feature}
8386 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008387 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8388 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 The height may be changed anyway when running out of room.
8390
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008391 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8392'winfixwidth' 'wfw' boolean (default off)
8393 local to window
8394 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008395 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008396 feature}
8397 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008398 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008399 The width may be changed anyway when running out of room.
8400
Bram Moolenaar071d4272004-06-13 20:20:40 +00008401 *'winminheight'* *'wmh'*
8402'winminheight' 'wmh' number (default 1)
8403 global
8404 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008405 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008406 feature}
8407 The minimal height of a window, when it's not the current window.
8408 This is a hard minimum, windows will never become smaller.
8409 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8410 status bar) if necessary. They will return to at least one line when
8411 they become active (since the cursor has to have somewhere to go.)
8412 Use 'winheight' to set the minimal height of the current window.
8413 This option is only checked when making a window smaller. Don't use a
8414 large number, it will cause errors when opening more than a few
8415 windows. A value of 0 to 3 is reasonable.
8416
8417 *'winminwidth'* *'wmw'*
8418'winminwidth' 'wmw' number (default 1)
8419 global
8420 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008421 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 feature}
8423 The minimal width of a window, when it's not the current window.
8424 This is a hard minimum, windows will never become smaller.
8425 When set to zero, windows may be "squashed" to zero columns (i.e. just
8426 a vertical separator) if necessary. They will return to at least one
8427 line when they become active (since the cursor has to have somewhere
8428 to go.)
8429 Use 'winwidth' to set the minimal width of the current window.
8430 This option is only checked when making a window smaller. Don't use a
8431 large number, it will cause errors when opening more than a few
8432 windows. A value of 0 to 12 is reasonable.
8433
8434 *'winwidth'* *'wiw'* *E592*
8435'winwidth' 'wiw' number (default 20)
8436 global
8437 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008438 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008439 feature}
8440 Minimal number of columns for the current window. This is not a hard
8441 minimum, Vim will use fewer columns if there is not enough room. If
8442 the current window is smaller, its size is increased, at the cost of
8443 the width of other windows. Set it to 999 to make the current window
8444 always fill the screen. Set it to a small number for normal editing.
8445 The width is not adjusted after one of the commands to change the
8446 width of the current window.
8447 'winwidth' applies to the current window. Use 'winminwidth' to set
8448 the minimal width for other windows.
8449
8450 *'wrap'* *'nowrap'*
8451'wrap' boolean (default on)
8452 local to window
8453 {not in Vi}
8454 This option changes how text is displayed. It doesn't change the text
8455 in the buffer, see 'textwidth' for that.
8456 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008457 displaying continues on the next line. When off lines will not wrap
8458 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 moved to a part that is not shown, the screen will scroll
8460 horizontally.
8461 The line will be broken in the middle of a word if necessary. See
8462 'linebreak' to get the break at a word boundary.
8463 To make scrolling horizontally a bit more useful, try this: >
8464 :set sidescroll=5
8465 :set listchars+=precedes:<,extends:>
8466< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008467 This option can't be set from a |modeline| when the 'diff' option is
8468 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469
8470 *'wrapmargin'* *'wm'*
8471'wrapmargin' 'wm' number (default 0)
8472 local to buffer
8473 Number of characters from the right window border where wrapping
8474 starts. When typing text beyond this limit, an <EOL> will be inserted
8475 and inserting continues on the next line.
8476 Options that add a margin, such as 'number' and 'foldcolumn', cause
8477 the text width to be further reduced. This is Vi compatible.
8478 When 'textwidth' is non-zero, this option is not used.
8479 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8480 and less usefully}
8481
8482 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8483'wrapscan' 'ws' boolean (default on) *E384* *E385*
8484 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008485 Searches wrap around the end of the file. Also applies to |]s| and
8486 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487
8488 *'write'* *'nowrite'*
8489'write' boolean (default on)
8490 global
8491 {not in Vi}
8492 Allows writing files. When not set, writing a file is not allowed.
8493 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008494 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008495 argument. Filtering text is still possible, even though this requires
8496 writing a temporary file.
8497
8498 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8499'writeany' 'wa' boolean (default off)
8500 global
8501 Allows writing to any file with no need for "!" override.
8502
8503 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8504'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8505 otherwise)
8506 global
8507 {not in Vi}
8508 Make a backup before overwriting a file. The backup is removed after
8509 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008510 also on.
8511 WARNING: Switching this option off means that when Vim fails to write
8512 your buffer correctly and then, for whatever reason, Vim exits, you
8513 lose both the original file and what you were writing. Only reset
8514 this option if your file system is almost full and it makes the write
8515 fail (and make sure not to exit Vim until the write was successful).
8516 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 When the 'backupskip' pattern matches, a backup is not made anyway.
8518 NOTE: This option is set to the default value when 'compatible' is
8519 set.
8520
8521 *'writedelay'* *'wd'*
8522'writedelay' 'wd' number (default 0)
8523 global
8524 {not in Vi}
8525 The number of microseconds to wait for each character sent to the
8526 screen. When non-zero, characters are sent to the terminal one by
8527 one. For MS-DOS pcterm this does not work. For debugging purposes.
8528
8529 vim:tw=78:ts=8:ft=help:norl: