blob: f1920bfd1fdb17f12b2de2f5f035b7098686a632 [file] [log] [blame]
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001*options.txt* For Vim version 7.3. Last change: 2012 May 16
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100153You can define any key codes, e.g.: >
154 :set t_xy=^[foo;
155There is no warning for using a name that isn't recognized. You can map these
156codes as you like: >
157 :map <t_xy> something
158< *E846*
159When a key code is not set, it's like it does not exist. Trying to get its
160value will result in an error: >
161 :set t_kb=
162 :set t_kb
163 E846: Key code not set: t_kb
164
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000165The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
166security reasons.
167
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000169at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170"set all" probably does not fit on the screen, causing Vim to give the
171|more-prompt|.
172
173 *option-backslash*
174To include white space in a string option value it has to be preceded with a
175backslash. To include a backslash you have to use two. Effectively this
176means that the number of backslashes in an option value is halved (rounded
177down).
178A few examples: >
179 :set tags=tags\ /usr/tags results in "tags /usr/tags"
180 :set tags=tags\\,file results in "tags\,file"
181 :set tags=tags\\\ file results in "tags\ file"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183The "|" character separates a ":set" command from a following command. To
184include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000185'titlestring' option to "hi|there": >
186 :set titlestring=hi\|there
187This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
188 :set titlestring=hi|set iconstring=there
189
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000190Similarly, the double quote character starts a comment. To include the '"' in
191the option value, use '\"' instead. This example sets the 'titlestring'
192option to 'hi "there"': >
193 :set titlestring=hi\ \"there\"
194
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000195For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000196precise: For options that expect a file name (those where environment
197variables are expanded) a backslash before a normal file name character is not
198removed. But a backslash before a special character (space, backslash, comma,
199etc.) is used like explained above.
200There is one special situation, when the value starts with "\\": >
201 :set dir=\\machine\path results in "\\machine\path"
202 :set dir=\\\\machine\\path results in "\\machine\path"
203 :set dir=\\path\\file results in "\\path\file" (wrong!)
204For the first one the start is kept, but for the second one the backslashes
205are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000206halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000207result which is probably not what you want. Avoid it.
208
209 *add-option-flags* *remove-option-flags*
210 *E539* *E550* *E551* *E552*
211Some options are a list of flags. When you want to add a flag to such an
212option, without changing the existing ones, you can do it like this: >
213 :set guioptions+=a
214Remove a flag from an option like this: >
215 :set guioptions-=a
216This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000217Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000218the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
219doesn't appear.
220
221 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000222Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000223environment variable exists the '$' and the following environment variable
224name is replaced with its value. If it does not exist the '$' and the name
225are not modified. Any non-id character (not a letter, digit or '_') may
226follow the environment variable name. That character and what follows is
227appended to the value of the environment variable. Examples: >
228 :set term=$TERM.new
229 :set path=/usr/$INCLUDE,$HOME/include,.
230When adding or removing a string from an option with ":set opt-=val" or ":set
231opt+=val" the expansion is done before the adding or removing.
232
233
234Handling of local options *local-options*
235
236Some of the options only apply to a window or buffer. Each window or buffer
237has its own copy of this option, thus can each have their own value. This
238allows you to set 'list' in one window but not in another. And set
239'shiftwidth' to 3 in one buffer and 4 in another.
240
241The following explains what happens to these local options in specific
242situations. You don't really need to know all of this, since Vim mostly uses
243the option values you would expect. Unfortunately, doing what the user
244expects is a bit complicated...
245
246When splitting a window, the local options are copied to the new window. Thus
247right after the split the contents of the two windows look the same.
248
249When editing a new buffer, its local option values must be initialized. Since
250the local options of the current buffer might be specifically for that buffer,
251these are not used. Instead, for each buffer-local option there also is a
252global value, which is used for new buffers. With ":set" both the local and
253global value is changed. With "setlocal" only the local value is changed,
254thus this value is not used when editing a new buffer.
255
256When editing a buffer that has been edited before, the last used window
257options are used again. If this buffer has been edited in this window, the
258values from back then are used. Otherwise the values from the window where
259the buffer was edited last are used.
260
261It's possible to set a local window option specifically for a type of buffer.
262When you edit another buffer in the same window, you don't want to keep
263using these local window options. Therefore Vim keeps a global value of the
264local window options, which is used when editing another buffer. Each window
265has its own copy of these values. Thus these are local to the window, but
266global to all buffers in the window. With this you can do: >
267 :e one
268 :set list
269 :e two
270Now the 'list' option will also be set in "two", since with the ":set list"
271command you have also set the global value. >
272 :set nolist
273 :e one
274 :setlocal list
275 :e two
276Now the 'list' option is not set, because ":set nolist" resets the global
277value, ":setlocal list" only changes the local value and ":e two" gets the
278global value. Note that if you do this next: >
279 :e one
280You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000281"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000282
283 *:setl* *:setlocal*
284:setl[ocal] ... Like ":set" but set only the value local to the
285 current buffer or window. Not all options have a
286 local value. If the option does not have a local
287 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200288 With the "all" argument: display local values for all
289 local options.
290 Without argument: Display local values for all local
291 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000292 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000293 local value. For a global/local boolean option, when
294 the global value is being used, "--" is displayed
295 before the option name.
296 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 shown (but that might change in the future).
298 {not in Vi}
299
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000300:setl[ocal] {option}< Set the local value of {option} to its global value by
301 copying the value.
302 {not in Vi}
303
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100304:se[t] {option}< For |global-local| options: Remove the local value of
305 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000306 {not in Vi}
307
308 *:setg* *:setglobal*
309:setg[lobal] ... Like ":set" but set only the global value for a local
310 option without changing the local value.
311 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200312 With the "all" argument: display global values for all
313 local options.
314 Without argument: display global values for all local
315 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 {not in Vi}
317
318For buffer-local and window-local options:
319 Command global value local value ~
320 :set option=value set set
321 :setlocal option=value - set
322:setglobal option=value set -
323 :set option? - display
324 :setlocal option? - display
325:setglobal option? display -
326
327
328Global options with a local value *global-local*
329
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000330Options are global when you mostly use one value for all buffers and windows.
331For some global options it's useful to sometimes have a different local value.
332You can set the local value with ":setlocal". That buffer or window will then
333use the local value, while other buffers and windows continue using the global
334value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000335
336For example, you have two windows, both on C source code. They use the global
337'makeprg' option. If you do this in one of the two windows: >
338 :set makeprg=gmake
339then the other window will switch to the same value. There is no need to set
340the 'makeprg' option in the other C source window too.
341However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000342another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000343files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000344 :setlocal makeprg=perlmake
345You can switch back to using the global value by making the local value empty: >
346 :setlocal makeprg=
347This only works for a string option. For a boolean option you need to use the
348"<" flag, like this: >
349 :setlocal autoread<
350Note that for non-boolean options using "<" copies the global value to the
351local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000352when the global value changes later). You can also use: >
353 :set path<
354This will make the local value of 'path' empty, so that the global value is
355used. Thus it does the same as: >
356 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000357Note: In the future more global options can be made global-local. Using
358":setlocal" on a global option might work differently then.
359
360
361Setting the filetype
362
363:setf[iletype] {filetype} *:setf* *:setfiletype*
364 Set the 'filetype' option to {filetype}, but only if
365 not done yet in a sequence of (nested) autocommands.
366 This is short for: >
367 :if !did_filetype()
368 : setlocal filetype={filetype}
369 :endif
370< This command is used in a filetype.vim file to avoid
371 setting the 'filetype' option twice, causing different
372 settings and syntax files to be loaded.
373 {not in Vi}
374
Bram Moolenaard58e9292011-02-09 17:07:58 +0100375 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000376:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
377:opt[ions] Open a window for viewing and setting all options.
378 Options are grouped by function.
379 Offers short help for each option. Hit <CR> on the
380 short help to open a help window with more help for
381 the option.
382 Modify the value of the option and hit <CR> on the
383 "set" line to set the new value. For window and
384 buffer specific options, the last accessed window is
385 used to set the option value in, unless this is a help
386 window, in which case the window below help window is
387 used (skipping the option-window).
388 {not available when compiled without the |+eval| or
389 |+autocmd| features}
390
391 *$HOME*
392Using "~" is like using "$HOME", but it is only recognized at the start of an
393option and after a space or comma.
394
395On Unix systems "~user" can be used too. It is replaced by the home directory
396of user "user". Example: >
397 :set path=~mool/include,/usr/include,.
398
399On Unix systems the form "${HOME}" can be used too. The name between {} can
400contain non-id characters then. Note that if you want to use this for the
401"gf" command, you need to add the '{' and '}' characters to 'isfname'.
402
Bram Moolenaarf1568ec2011-12-14 21:17:39 +0100403On MS-Windows, if $HOME is not defined as an environment variable, then
404at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
405
Bram Moolenaar071d4272004-06-13 20:20:40 +0000406NOTE: expanding environment variables and "~/" is only done with the ":set"
407command, not when assigning a value to an option with ":let".
408
409
410Note the maximum length of an expanded option is limited. How much depends on
411the system, mostly it is something like 256 or 1024 characters.
412
413 *:fix* *:fixdel*
414:fix[del] Set the value of 't_kD':
415 't_kb' is 't_kD' becomes ~
416 CTRL-? CTRL-H
417 not CTRL-? CTRL-?
418
419 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
420
421 If your delete key terminal code is wrong, but the
422 code for backspace is alright, you can put this in
423 your .vimrc: >
424 :fixdel
425< This works no matter what the actual code for
426 backspace is.
427
428 If the backspace key terminal code is wrong you can
429 use this: >
430 :if &term == "termname"
431 : set t_kb=^V<BS>
432 : fixdel
433 :endif
434< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000435 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000436 with your terminal name.
437
438 If your <Delete> key sends a strange key sequence (not
439 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
440 :if &term == "termname"
441 : set t_kD=^V<Delete>
442 :endif
443< Where "^V" is CTRL-V and "<Delete>" is the delete key
444 (don't type eight characters!). Replace "termname"
445 with your terminal name.
446
447 *Linux-backspace*
448 Note about Linux: By default the backspace key
449 produces CTRL-?, which is wrong. You can fix it by
450 putting this line in your rc.local: >
451 echo "keycode 14 = BackSpace" | loadkeys
452<
453 *NetBSD-backspace*
454 Note about NetBSD: If your backspace doesn't produce
455 the right code, try this: >
456 xmodmap -e "keycode 22 = BackSpace"
457< If this works, add this in your .Xmodmap file: >
458 keysym 22 = BackSpace
459< You need to restart for this to take effect.
460
461==============================================================================
4622. Automatically setting options *auto-setting*
463
464Besides changing options with the ":set" command, there are three alternatives
465to set options automatically for one or more files:
466
4671. When starting Vim initializations are read from various places. See
468 |initialization|. Most of them are performed for all editing sessions,
469 and some of them depend on the directory where Vim is started.
470 You can create an initialization file with |:mkvimrc|, |:mkview| and
471 |:mksession|.
4722. If you start editing a new file, the automatic commands are executed.
473 This can be used to set options for files matching a particular pattern and
474 many other things. See |autocommand|.
4753. If you start editing a new file, and the 'modeline' option is on, a
476 number of lines at the beginning and end of the file are checked for
477 modelines. This is explained here.
478
479 *modeline* *vim:* *vi:* *ex:* *E520*
480There are two forms of modelines. The first form:
481 [text]{white}{vi:|vim:|ex:}[white]{options}
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487{options} a list of option settings, separated with white space or ':',
488 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000489 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000490
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000491Example:
492 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493
494The second form (this is compatible with some versions of Vi):
495
496 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
497
498[text] any text or empty
499{white} at least one blank character (<Space> or <Tab>)
500{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
501[white] optional white space
502se[t] the string "set " or "se " (note the space)
503{options} a list of options, separated with white space, which is the
504 argument for a ":set" command
505: a colon
506[text] any text or empty
507
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000508Example:
509 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510
511The white space before {vi:|vim:|ex:} is required. This minimizes the chance
512that a normal word like "lex:" is caught. There is one exception: "vi:" and
513"vim:" can also be at the start of the line (for compatibility with version
5143.0). Using "ex:" at the start of the line will be ignored (this could be
515short for "example:").
516
517 *modeline-local*
518The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000519buffer and window that contain the file. Although it's possible to set global
520options from a modeline, this is unusual. If you have two windows open and
521the files in it set the same global option to a different value, the result
522depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000524When editing a file that was already loaded, only the window-local options
525from the modeline are used. Thus if you manually changed a buffer-local
526option after opening the file, it won't be changed if you edit the same buffer
527in another window. But window-local options will be set.
528
Bram Moolenaar071d4272004-06-13 20:20:40 +0000529 *modeline-version*
530If the modeline is only to be used for some versions of Vim, the version
531number can be specified where "vim:" is used:
532 vim{vers}: version {vers} or later
533 vim<{vers}: version before {vers}
534 vim={vers}: version {vers}
535 vim>{vers}: version after {vers}
536{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000537For example, to use a modeline only for Vim 6.0 and later:
538 /* vim600: set foldmethod=marker: */ ~
539To use a modeline for Vim before version 5.7:
540 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541There can be no blanks between "vim" and the ":".
542
543
544The number of lines that are checked can be set with the 'modelines' option.
545If 'modeline' is off or 'modelines' is 0 no lines are checked.
546
547Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000548like:
549 /* vi:ts=4: */ ~
550will give an error message for the trailing "*/". This line is OK:
551 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553If an error is detected the rest of the line is skipped.
554
555If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000556backslash in front of the ':' will be removed. Example:
557 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000558This sets the 'dir' option to "c:\tmp". Only a single backslash before the
559':' is removed. Thus to include "\:" you have to specify "\\:".
560
561No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000562might create a Trojan horse text file with modelines). And not all options
563can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000564|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000565causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
566are wrapped unexpectedly. So disable modelines before editing untrusted text.
567The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568
569Hint: If you would like to do something else than setting an option, you could
570define an autocommand that checks the file for a specific string. For
571example: >
572 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
573And define a function SetVar() that does something with the line containing
574"VAR".
575
576==============================================================================
5773. Options summary *option-summary*
578
579In the list below all the options are mentioned with their full name and with
580an abbreviation if there is one. Both forms may be used.
581
582In this document when a boolean option is "set" that means that ":set option"
583is entered. When an option is "reset", ":set nooption" is used.
584
585For some options there are two default values: The "Vim default", which is
586used when 'compatible' is not set, and the "Vi default", which is used when
587'compatible' is set.
588
589Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000590are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591different value in each window. For example the 'list' option can be set in
592one window and reset in another for the same text, giving both types of view
593at the same time. There are a few options that are specific to a certain
594file. These can have a different value for each file or buffer. For example
595the 'textwidth' option can be 78 for a normal text file and 0 for a C
596program.
597
598 global one option for all buffers and windows
599 local to window each window has its own copy of this option
600 local to buffer each buffer has its own copy of this option
601
602When creating a new window the option values from the currently active window
603are used as a default value for the window-specific options. For the
604buffer-specific options this depends on the 's' and 'S' flags in the
605'cpoptions' option. If 's' is included (which is the default) the values for
606buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000607first entered. If 'S' is present the options are copied each time the buffer
608is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609present, the options are copied from the currently active buffer when the
610buffer is created.
611
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000612Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000614Not all options are supported in all versions. This depends on the supported
615features and sometimes on the system. A remark about this is in curly braces
616below. When an option is not supported it may still be set without getting an
617error, this is called a hidden option. You can't get the value of a hidden
618option though, it is not stored.
619
620To test if option "foo" can be used with ":set" use something like this: >
621 if exists('&foo')
622This also returns true for a hidden option. To test if option "foo" is really
623supported use something like this: >
624 if exists('+foo')
625<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 *E355*
627A jump table for the options with a short description can be found at |Q_op|.
628
629 *'aleph'* *'al'* *aleph* *Aleph*
630'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
631 global
632 {not in Vi}
633 {only available when compiled with the |+rightleft|
634 feature}
635 The ASCII code for the first letter of the Hebrew alphabet. The
636 routine that maps the keyboard in Hebrew mode, both in Insert mode
637 (when hkmap is set) and on the command-line (when hitting CTRL-_)
638 outputs the Hebrew characters in the range [aleph..aleph+26].
639 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
640 See |rileft.txt|.
641
642 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
643'allowrevins' 'ari' boolean (default off)
644 global
645 {not in Vi}
646 {only available when compiled with the |+rightleft|
647 feature}
648 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
649 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
650 into reverse Insert mode, and don't know how to get out. See
651 'revins'.
652 NOTE: This option is reset when 'compatible' is set.
653
654 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
655'altkeymap' 'akm' boolean (default off)
656 global
657 {not in Vi}
658 {only available when compiled with the |+farsi|
659 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000660 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 the keyboard map between Farsi and English, when 'allowrevins' set.
662
Bram Moolenaar582fd852005-03-28 20:58:01 +0000663 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 is useful to start the Vim in native mode i.e. English (left-to-right
665 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000666 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000667
668 *'ambiwidth'* *'ambw'*
669'ambiwidth' 'ambw' string (default: "single")
670 global
671 {not in Vi}
672 {only available when compiled with the |+multi_byte|
673 feature}
674 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
675 Tells Vim what to do with characters with East Asian Width Class
676 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
677 letters, Cyrillic letters).
678
679 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000680 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 expected by most users.
682 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200683 *E834* *E835*
684 The value "double" cannot be used if 'listchars' or 'fillchars'
685 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000686
687 There are a number of CJK fonts for which the width of glyphs for
688 those characters are solely based on how many octets they take in
689 legacy/traditional CJK encodings. In those encodings, Euro,
690 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000691 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 Vim is running inside a terminal (emulators) that uses a CJK font
695 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
696 this option should be set to "double" to match the width perceived
697 by Vim with the width of glyphs in the font. Perhaps it also has
698 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
699 when the system locale is set to one of CJK locales. See Unicode
700 Standard Annex #11 (http://www.unicode.org/reports/tr11).
701
702 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
703'antialias' 'anti' boolean (default: off)
704 global
705 {not in Vi}
706 {only available when compiled with GUI enabled
707 on Mac OS X}
708 This option only has an effect in the GUI version of Vim on Mac OS X
709 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
710 which can be easier to read at certain sizes on certain displays.
711 Setting this option can sometimes cause problems if 'guifont' is set
712 to its default (empty string).
713
714 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
715'autochdir' 'acd' boolean (default off)
716 global
717 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200718 {only available when compiled with it, use
719 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000720 When on, Vim will change the current working directory whenever you
721 open a file, switch buffers, delete a buffer or open/close a window.
722 It will change to the directory containing the file which was opened
723 or selected.
724 This option is provided for backward compatibility with the Vim
725 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000726 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727
728 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
729'arabic' 'arab' boolean (default off)
730 local to window
731 {not in Vi}
732 {only available when compiled with the |+arabic|
733 feature}
734 This option can be set to start editing Arabic text.
735 Setting this option will:
736 - Set the 'rightleft' option, unless 'termbidi' is set.
737 - Set the 'arabicshape' option, unless 'termbidi' is set.
738 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
739 between typing English and Arabic key mapping.
740 - Set the 'delcombine' option
741 Note that 'encoding' must be "utf-8" for working with Arabic text.
742
743 Resetting this option will:
744 - Reset the 'rightleft' option.
745 - Disable the use of 'keymap' (without changing its value).
746 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200747 option).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 Also see |arabic.txt|.
749
750 *'arabicshape'* *'arshape'*
751 *'noarabicshape'* *'noarshape'*
752'arabicshape' 'arshape' boolean (default on)
753 global
754 {not in Vi}
755 {only available when compiled with the |+arabic|
756 feature}
757 When on and 'termbidi' is off, the required visual character
758 corrections that need to take place for displaying the Arabic language
759 take affect. Shaping, in essence, gets enabled; the term is a broad
760 one which encompasses:
761 a) the changing/morphing of characters based on their location
762 within a word (initial, medial, final and stand-alone).
763 b) the enabling of the ability to compose characters
764 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100765 When disabled the display shows each character's true stand-alone
766 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 Arabic is a complex language which requires other settings, for
768 further details see |arabic.txt|.
769
770 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
771'autoindent' 'ai' boolean (default off)
772 local to buffer
773 Copy indent from current line when starting a new line (typing <CR>
774 in Insert mode or when using the "o" or "O" command). If you do not
775 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000776 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
777 to another line has the same effect, unless the 'I' flag is included
778 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000779 When autoindent is on, formatting (with the "gq" command or when you
780 reach 'textwidth' in Insert mode) uses the indentation of the first
781 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 When 'smartindent' or 'cindent' is on the indent is changed in
783 a different way.
784 The 'autoindent' option is reset when the 'paste' option is set.
785 {small difference from Vi: After the indent is deleted when typing
786 <Esc> or <CR>, the cursor position when moving up or down is after the
787 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
788
789 *'autoread'* *'ar'* *'noautoread'* *'noar'*
790'autoread' 'ar' boolean (default off)
791 global or local to buffer |global-local|
792 {not in Vi}
793 When a file has been detected to have been changed outside of Vim and
794 it has not been changed inside of Vim, automatically read it again.
795 When the file has been deleted this is not done. |timestamp|
796 If this option has a local value, use this command to switch back to
797 using the global value: >
798 :set autoread<
799<
800 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
801'autowrite' 'aw' boolean (default off)
802 global
803 Write the contents of the file, if it has been modified, on each
804 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000805 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
807 Note that for some commands the 'autowrite' option is not used, see
808 'autowriteall' for that.
809
810 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
811'autowriteall' 'awa' boolean (default off)
812 global
813 {not in Vi}
814 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
815 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
816 Setting this option also implies that Vim behaves like 'autowrite' has
817 been set.
818
819 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200820'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 global
822 {not in Vi}
823 When set to "dark", Vim will try to use colors that look good on a
824 dark background. When set to "light", Vim will try to use colors that
825 look good on a light background. Any other value is illegal.
826 Vim tries to set the default value according to the terminal used.
827 This will not always be correct.
828 Setting this option does not change the background color, it tells Vim
829 what the background color looks like. For changing the background
830 color, see |:hi-normal|.
831
832 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000833 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000834 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100835 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 setting 'background' will cause the color scheme to be reloaded. If
837 the color scheme adjusts to the value of 'background' this will work.
838 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100839 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000840
841 When setting 'background' to the default value with: >
842 :set background&
843< Vim will guess the value. In the GUI this should work correctly,
844 in other cases Vim might not be able to guess the right value.
845
846 When starting the GUI, the default value for 'background' will be
847 "light". When the value is not set in the .gvimrc, and Vim detects
848 that the background is actually quite dark, 'background' is set to
849 "dark". But this happens only AFTER the .gvimrc file has been read
850 (because the window needs to be opened to find the actual background
851 color). To get around this, force the GUI window to be opened by
852 putting a ":gui" command in the .gvimrc file, before where the value
853 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200854
855 For MS-DOS, Windows and OS/2 the default is "dark".
856 For other systems "dark" is used when 'term' is "linux",
857 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
858 background. Otherwise the default is "light".
859
Bram Moolenaar071d4272004-06-13 20:20:40 +0000860 Normally this option would be set in the .vimrc file. Possibly
861 depending on the terminal name. Example: >
862 :if &term == "pcterm"
863 : set background=dark
864 :endif
865< When this option is set, the default settings for the highlight groups
866 will change. To use other settings, place ":highlight" commands AFTER
867 the setting of the 'background' option.
868 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
869 to select the colors for syntax highlighting. After changing this
870 option, you must load syntax.vim again to see the result. This can be
871 done with ":syntax on".
872
873 *'backspace'* *'bs'*
874'backspace' 'bs' string (default "")
875 global
876 {not in Vi}
877 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
878 mode. This is a list of items, separated by commas. Each item allows
879 a way to backspace over something:
880 value effect ~
881 indent allow backspacing over autoindent
882 eol allow backspacing over line breaks (join lines)
883 start allow backspacing over the start of insert; CTRL-W and CTRL-U
884 stop once at the start of insert.
885
886 When the value is empty, Vi compatible backspacing is used.
887
888 For backwards compatibility with version 5.4 and earlier:
889 value effect ~
890 0 same as ":set backspace=" (Vi compatible)
891 1 same as ":set backspace=indent,eol"
892 2 same as ":set backspace=indent,eol,start"
893
894 See |:fixdel| if your <BS> or <Del> key does not do what you want.
895 NOTE: This option is set to "" when 'compatible' is set.
896
897 *'backup'* *'bk'* *'nobackup'* *'nobk'*
898'backup' 'bk' boolean (default off)
899 global
900 {not in Vi}
901 Make a backup before overwriting a file. Leave it around after the
902 file has been successfully written. If you do not want to keep the
903 backup file, but you do want a backup while the file is being
904 written, reset this option and set the 'writebackup' option (this is
905 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000906 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 |backup-table| for more explanations.
908 When the 'backupskip' pattern matches, a backup is not made anyway.
909 When 'patchmode' is set, the backup may be renamed to become the
910 oldest version of a file.
911 NOTE: This option is reset when 'compatible' is set.
912
913 *'backupcopy'* *'bkc'*
914'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
915 global
916 {not in Vi}
917 When writing a file and a backup is made, this option tells how it's
918 done. This is a comma separated list of words.
919
920 The main values are:
921 "yes" make a copy of the file and overwrite the original one
922 "no" rename the file and write a new one
923 "auto" one of the previous, what works best
924
925 Extra values that can be combined with the ones above are:
926 "breaksymlink" always break symlinks when writing
927 "breakhardlink" always break hardlinks when writing
928
929 Making a copy and overwriting the original file:
930 - Takes extra time to copy the file.
931 + When the file has special attributes, is a (hard/symbolic) link or
932 has a resource fork, all this is preserved.
933 - When the file is a link the backup will have the name of the link,
934 not of the real file.
935
936 Renaming the file and writing a new one:
937 + It's fast.
938 - Sometimes not all attributes of the file can be copied to the new
939 file.
940 - When the file is a link the new file will not be a link.
941
942 The "auto" value is the middle way: When Vim sees that renaming file
943 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000944 the file is not a link) that is used. When problems are expected, a
945 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000946
947 The "breaksymlink" and "breakhardlink" values can be used in
948 combination with any of "yes", "no" and "auto". When included, they
949 force Vim to always break either symbolic or hard links by doing
950 exactly what the "no" option does, renaming the original file to
951 become the backup and writing a new file in its place. This can be
952 useful for example in source trees where all the files are symbolic or
953 hard links and any changes should stay in the local source tree, not
954 be propagated back to the original source.
955 *crontab*
956 One situation where "no" and "auto" will cause problems: A program
957 that opens a file, invokes Vim to edit that file, and then tests if
958 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000959 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960 example.
961
962 When a copy is made, the original file is truncated and then filled
963 with the new text. This means that protection bits, owner and
964 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000965 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 group of the backup is set to the group of the original file. If this
967 fails, the protection bits for the group are made the same as for
968 others.
969
970 When the file is renamed this is the other way around: The backup has
971 the same attributes of the original file, and the newly written file
972 is owned by the current user. When the file was a (hard/symbolic)
973 link, the new file will not! That's why the "auto" value doesn't
974 rename when the file is a link. The owner and group of the newly
975 written file will be set to the same ones as the original file, but
976 the system may refuse to do this. In that case the "auto" value will
977 again not rename the file.
978
979 *'backupdir'* *'bdir'*
980'backupdir' 'bdir' string (default for Amiga: ".,t:",
981 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
982 for Unix: ".,~/tmp,~/")
983 global
984 {not in Vi}
985 List of directories for the backup file, separated with commas.
986 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100987 where this is possible. The directory must exist, Vim will not
988 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 - Empty means that no backup file will be created ('patchmode' is
990 impossible!). Writing may fail because of this.
991 - A directory "." means to put the backup file in the same directory
992 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000993 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994 put the backup file relative to where the edited file is. The
995 leading "." is replaced with the path name of the edited file.
996 ("." inside a directory name has no special meaning).
997 - Spaces after the comma are ignored, other spaces are considered part
998 of the directory name. To have a space at the start of a directory
999 name, precede it with a backslash.
1000 - To include a comma in a directory name precede it with a backslash.
1001 - A directory name may end in an '/'.
1002 - Environment variables are expanded |:set_env|.
1003 - Careful with '\' characters, type one before a space, type two to
1004 get one in the option (see |option-backslash|), for example: >
1005 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1006< - For backwards compatibility with Vim version 3.0 a '>' at the start
1007 of the option is removed.
1008 See also 'backup' and 'writebackup' options.
1009 If you want to hide your backup files on Unix, consider this value: >
1010 :set backupdir=./.backup,~/.backup,.,/tmp
1011< You must create a ".backup" directory in each directory and in your
1012 home directory for this to work properly.
1013 The use of |:set+=| and |:set-=| is preferred when adding or removing
1014 directories from the list. This avoids problems when a future version
1015 uses another default.
1016 This option cannot be set from a |modeline| or in the |sandbox|, for
1017 security reasons.
1018
1019 *'backupext'* *'bex'* *E589*
1020'backupext' 'bex' string (default "~", for VMS: "_")
1021 global
1022 {not in Vi}
1023 String which is appended to a file name to make the name of the
1024 backup file. The default is quite unusual, because this avoids
1025 accidentally overwriting existing files with a backup file. You might
1026 prefer using ".bak", but make sure that you don't have files with
1027 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001028 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001030 If you like to keep a lot of backups, you could use a BufWritePre
1031 autocommand to change 'backupext' just before writing the file to
1032 include a timestamp. >
1033 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1034< Use 'backupdir' to put the backup in a different directory.
1035
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 *'backupskip'* *'bsk'*
1037'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1038 global
1039 {not in Vi}
1040 {not available when compiled without the |+wildignore|
1041 feature}
1042 A list of file patterns. When one of the patterns matches with the
1043 name of the file which is written, no backup file is created. Both
1044 the specified file name and the full path name of the file are used.
1045 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1046 Watch out for special characters, see |option-backslash|.
1047 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001048 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001049
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001050 WARNING: Not having a backup file means that when Vim fails to write
1051 your buffer correctly and then, for whatever reason, Vim exits, you
1052 lose both the original file and what you were writing. Only disable
1053 backups if you don't care about losing the file.
1054
Bram Moolenaar02467872007-05-06 13:22:01 +00001055 Note that environment variables are not expanded. If you want to use
1056 $HOME you must expand it explicitly, e.g.: >
1057 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1058
1059< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001060 backup would be made by renaming the original file crontab won't see
1061 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062
1063 *'balloondelay'* *'bdlay'*
1064'balloondelay' 'bdlay' number (default: 600)
1065 global
1066 {not in Vi}
1067 {only available when compiled with the |+balloon_eval|
1068 feature}
1069 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1070
1071 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1072'ballooneval' 'beval' boolean (default off)
1073 global
1074 {not in Vi}
1075 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001076 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 Switch on the |balloon-eval| functionality.
1078
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001079 *'balloonexpr'* *'bexpr'*
1080'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001081 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001082 {not in Vi}
1083 {only available when compiled with the |+balloon_eval|
1084 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001085 Expression for text to show in evaluation balloon. It is only used
1086 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001087
1088 v:beval_bufnr number of the buffer in which balloon is going to show
1089 v:beval_winnr number of the window
1090 v:beval_lnum line number
1091 v:beval_col column number (byte index)
1092 v:beval_text word under or after the mouse pointer
1093
1094 The evaluation of the expression must not have side effects!
1095 Example: >
1096 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001097 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001098 \', column ' . v:beval_col .
1099 \ ' of file ' . bufname(v:beval_bufnr) .
1100 \ ' on word "' . v:beval_text . '"'
1101 endfunction
1102 set bexpr=MyBalloonExpr()
1103 set ballooneval
1104<
1105 NOTE: The balloon is displayed only if the cursor is on a text
1106 character. If the result of evaluating 'balloonexpr' is not empty,
1107 Vim does not try to send a message to an external debugger (Netbeans
1108 or Sun Workshop).
1109
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001110 The expression may be evaluated in the |sandbox|, see
1111 |sandbox-option|.
1112
1113 It is not allowed to change text or jump to another window while
1114 evaluating 'balloonexpr' |textlock|.
1115
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001116 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001117 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001118< When they are supported "\n" characters will start a new line. If the
1119 expression evaluates to a |List| this is equal to using each List item
1120 as a string and putting "\n" in between them.
1121
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1123'binary' 'bin' boolean (default off)
1124 local to buffer
1125 {not in Vi}
1126 This option should be set before editing a binary file. You can also
1127 use the |-b| Vim argument. When this option is switched on a few
1128 options will be changed (also when it already was on):
1129 'textwidth' will be set to 0
1130 'wrapmargin' will be set to 0
1131 'modeline' will be off
1132 'expandtab' will be off
1133 Also, 'fileformat' and 'fileformats' options will not be used, the
1134 file is read and written like 'fileformat' was "unix" (a single <NL>
1135 separates lines).
1136 The 'fileencoding' and 'fileencodings' options will not be used, the
1137 file is read without conversion.
1138 NOTE: When you start editing a(nother) file while the 'bin' option is
1139 on, settings from autocommands may change the settings again (e.g.,
1140 'textwidth'), causing trouble when editing. You might want to set
1141 'bin' again when the file has been loaded.
1142 The previous values of these options are remembered and restored when
1143 'bin' is switched from on to off. Each buffer has its own set of
1144 saved option values.
1145 To edit a file with 'binary' set you can use the |++bin| argument.
1146 This avoids you have to do ":set bin", which would have effect for all
1147 files you edit.
1148 When writing a file the <EOL> for the last line is only written if
1149 there was one in the original file (normally Vim appends an <EOL> to
1150 the last line if there is none; this would make the file longer). See
1151 the 'endofline' option.
1152
1153 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1154'bioskey' 'biosk' boolean (default on)
1155 global
1156 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001157 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 better to detect CTRL-C, but only works for the console. When using a
1159 terminal over a serial port reset this option.
1160 Also see |'conskey'|.
1161
1162 *'bomb'* *'nobomb'*
1163'bomb' boolean (default off)
1164 local to buffer
1165 {not in Vi}
1166 {only available when compiled with the |+multi_byte|
1167 feature}
1168 When writing a file and the following conditions are met, a BOM (Byte
1169 Order Mark) is prepended to the file:
1170 - this option is on
1171 - the 'binary' option is off
1172 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1173 endian variants.
1174 Some applications use the BOM to recognize the encoding of the file.
1175 Often used for UCS-2 files on MS-Windows. For other applications it
1176 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001177 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001178 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1179 check for the presence of the BOM is done and 'bomb' set accordingly.
1180 Unless 'binary' is set, it is removed from the first line, so that you
1181 don't see it when editing. When you don't change the options, the BOM
1182 will be restored when writing the file.
1183
1184 *'breakat'* *'brk'*
1185'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1186 global
1187 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001188 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001189 feature}
1190 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001191 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1192 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193
1194 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001195'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001196 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001197 {not in Vi} {only for Motif, Athena, GTK, Mac and
1198 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001200 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001201 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 buffer Use the directory of the related buffer.
1203 current Use the current directory.
1204 {path} Use the specified directory
1205
1206 *'bufhidden'* *'bh'*
1207'bufhidden' 'bh' string (default: "")
1208 local to buffer
1209 {not in Vi}
1210 {not available when compiled without the |+quickfix|
1211 feature}
1212 This option specifies what happens when a buffer is no longer
1213 displayed in a window:
1214 <empty> follow the global 'hidden' option
1215 hide hide the buffer (don't unload it), also when 'hidden'
1216 is not set
1217 unload unload the buffer, also when 'hidden' is set or using
1218 |:hide|
1219 delete delete the buffer from the buffer list, also when
1220 'hidden' is set or using |:hide|, like using
1221 |:bdelete|
1222 wipe wipe out the buffer from the buffer list, also when
1223 'hidden' is set or using |:hide|, like using
1224 |:bwipeout|
1225
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001226 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001227 are lost without a warning. Also, these values may break autocommands
1228 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 This option is used together with 'buftype' and 'swapfile' to specify
1230 special kinds of buffers. See |special-buffers|.
1231
1232 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1233'buflisted' 'bl' boolean (default: on)
1234 local to buffer
1235 {not in Vi}
1236 When this option is set, the buffer shows up in the buffer list. If
1237 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1238 This option is reset by Vim for buffers that are only used to remember
1239 a file name or marks. Vim sets it when starting to edit a buffer.
1240 But not when moving to a buffer with ":buffer".
1241
1242 *'buftype'* *'bt'* *E382*
1243'buftype' 'bt' string (default: "")
1244 local to buffer
1245 {not in Vi}
1246 {not available when compiled without the |+quickfix|
1247 feature}
1248 The value of this option specifies the type of a buffer:
1249 <empty> normal buffer
1250 nofile buffer which is not related to a file and will not be
1251 written
1252 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001253 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001254 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001255 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001257 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 help help buffer (you are not supposed to set this
1259 manually)
1260
1261 This option is used together with 'bufhidden' and 'swapfile' to
1262 specify special kinds of buffers. See |special-buffers|.
1263
1264 Be careful with changing this option, it can have many side effects!
1265
Bram Moolenaar280f1262006-01-30 00:14:18 +00001266 A "quickfix" buffer is only used for the error list and the location
1267 list. This value is set by the |:cwindow| and |:lwindow| commands and
1268 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269
1270 "nofile" and "nowrite" buffers are similar:
1271 both: The buffer is not to be written to disk, ":w" doesn't
1272 work (":w filename" does work though).
1273 both: The buffer is never considered to be |'modified'|.
1274 There is no warning when the changes will be lost, for
1275 example when you quit Vim.
1276 both: A swap file is only created when using too much memory
1277 (when 'swapfile' has been reset there is never a swap
1278 file).
1279 nofile only: The buffer name is fixed, it is not handled like a
1280 file name. It is not modified in response to a |:cd|
1281 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001282 *E676*
1283 "acwrite" implies that the buffer name is not related to a file, like
1284 "nofile", but it will be written. Thus, in contrast to "nofile" and
1285 "nowrite", ":w" does work and a modified buffer can't be abandoned
1286 without saving. For writing there must be matching |BufWriteCmd|,
1287 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288
1289 *'casemap'* *'cmp'*
1290'casemap' 'cmp' string (default: "internal,keepascii")
1291 global
1292 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001293 {only available when compiled with the |+multi_byte|
1294 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001295 Specifies details about changing the case of letters. It may contain
1296 these words, separated by a comma:
1297 internal Use internal case mapping functions, the current
1298 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001299 matters when 'encoding' is a Unicode encoding,
1300 "latin1" or "iso-8859-15". When "internal" is
1301 omitted, the towupper() and towlower() system library
1302 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1304 case mapping, the current locale is not effective.
1305 This probably only matters for Turkish.
1306
1307 *'cdpath'* *'cd'* *E344* *E346*
1308'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1309 global
1310 {not in Vi}
1311 {not available when compiled without the
1312 |+file_in_path| feature}
1313 This is a list of directories which will be searched when using the
1314 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001315 for has a relative path, not an absolute part starting with "/", "./"
1316 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 The 'cdpath' option's value has the same form and semantics as
1318 |'path'|. Also see |file-searching|.
1319 The default value is taken from $CDPATH, with a "," prepended to look
1320 in the current directory first.
1321 If the default value taken from $CDPATH is not what you want, include
1322 a modified version of the following command in your vimrc file to
1323 override it: >
1324 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1325< This option cannot be set from a |modeline| or in the |sandbox|, for
1326 security reasons.
1327 (parts of 'cdpath' can be passed to the shell to expand file names).
1328
1329 *'cedit'*
1330'cedit' string (Vi default: "", Vim default: CTRL-F)
1331 global
1332 {not in Vi}
1333 {not available when compiled without the |+vertsplit|
1334 feature}
1335 The key used in Command-line Mode to open the command-line window.
1336 The default is CTRL-F when 'compatible' is off.
1337 Only non-printable keys are allowed.
1338 The key can be specified as a single character, but it is difficult to
1339 type. The preferred way is to use the <> notation. Examples: >
1340 :set cedit=<C-Y>
1341 :set cedit=<Esc>
1342< |Nvi| also has this option, but it only uses the first character.
1343 See |cmdwin|.
1344
1345 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1346'charconvert' 'ccv' string (default "")
1347 global
1348 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001349 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 {not in Vi}
1351 An expression that is used for character encoding conversion. It is
1352 evaluated when a file that is to be read or has been written has a
1353 different encoding from what is desired.
1354 'charconvert' is not used when the internal iconv() function is
1355 supported and is able to do the conversion. Using iconv() is
1356 preferred, because it is much faster.
1357 'charconvert' is not used when reading stdin |--|, because there is no
1358 file to convert from. You will have to save the text in a file first.
1359 The expression must return zero or an empty string for success,
1360 non-zero for failure.
1361 The possible encoding names encountered are in 'encoding'.
1362 Additionally, names given in 'fileencodings' and 'fileencoding' are
1363 used.
1364 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1365 is done internally by Vim, 'charconvert' is not used for this.
1366 'charconvert' is also used to convert the viminfo file, if the 'c'
1367 flag is present in 'viminfo'. Also used for Unicode conversion.
1368 Example: >
1369 set charconvert=CharConvert()
1370 fun CharConvert()
1371 system("recode "
1372 \ . v:charconvert_from . ".." . v:charconvert_to
1373 \ . " <" . v:fname_in . " >" v:fname_out)
1374 return v:shell_error
1375 endfun
1376< The related Vim variables are:
1377 v:charconvert_from name of the current encoding
1378 v:charconvert_to name of the desired encoding
1379 v:fname_in name of the input file
1380 v:fname_out name of the output file
1381 Note that v:fname_in and v:fname_out will never be the same.
1382 Note that v:charconvert_from and v:charconvert_to may be different
1383 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1384 Encryption is not done by Vim when using 'charconvert'. If you want
1385 to encrypt the file after conversion, 'charconvert' should take care
1386 of this.
1387 This option cannot be set from a |modeline| or in the |sandbox|, for
1388 security reasons.
1389
1390 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1391'cindent' 'cin' boolean (default off)
1392 local to buffer
1393 {not in Vi}
1394 {not available when compiled without the |+cindent|
1395 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001396 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 that trigger reindenting in insert mode and 'cinoptions' to set your
1398 preferred indent style.
1399 If 'indentexpr' is not empty, it overrules 'cindent'.
1400 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1401 the "=" operator indents using this algorithm rather than calling an
1402 external program.
1403 See |C-indenting|.
1404 When you don't like the way 'cindent' works, try the 'smartindent'
1405 option or 'indentexpr'.
1406 This option is not used when 'paste' is set.
1407 NOTE: This option is reset when 'compatible' is set.
1408
1409 *'cinkeys'* *'cink'*
1410'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1411 local to buffer
1412 {not in Vi}
1413 {not available when compiled without the |+cindent|
1414 feature}
1415 A list of keys that, when typed in Insert mode, cause reindenting of
1416 the current line. Only used if 'cindent' is on and 'indentexpr' is
1417 empty.
1418 For the format of this option see |cinkeys-format|.
1419 See |C-indenting|.
1420
1421 *'cinoptions'* *'cino'*
1422'cinoptions' 'cino' string (default "")
1423 local to buffer
1424 {not in Vi}
1425 {not available when compiled without the |+cindent|
1426 feature}
1427 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1428 program. See |cinoptions-values| for the values of this option, and
1429 |C-indenting| for info on C indenting in general.
1430
1431
1432 *'cinwords'* *'cinw'*
1433'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1434 local to buffer
1435 {not in Vi}
1436 {not available when compiled without both the
1437 |+cindent| and the |+smartindent| features}
1438 These keywords start an extra indent in the next line when
1439 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1440 an appropriate place (inside {}).
1441 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1442 matter, include the keyword both the uppercase and lowercase:
1443 "if,If,IF".
1444
1445 *'clipboard'* *'cb'*
1446'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1447 for X-windows, "" otherwise)
1448 global
1449 {not in Vi}
1450 {only in GUI versions or when the |+xterm_clipboard|
1451 feature is included}
1452 This option is a list of comma separated names.
1453 These names are recognized:
1454
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001455 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 unnamed When included, Vim will use the clipboard register '*'
1457 for all yank, delete, change and put operations which
1458 would normally go to the unnamed register. When a
1459 register is explicitly specified, it will always be
1460 used regardless of whether "unnamed" is in 'clipboard'
1461 or not. The clipboard register can always be
1462 explicitly accessed using the "* notation. Also see
1463 |gui-clipboard|.
1464
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001465 unnamedplus A variant of "unnamed" flag which uses the clipboard
1466 register '+' (|quoteplus|) instead of register '*' for
1467 all operations except yank. Yank shall copy the text
1468 into register '+' and also into '*' when "unnamed" is
1469 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001470 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001471 Availability can be checked with: >
1472 if has('unnamedplus')
1473<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 autoselect Works like the 'a' flag in 'guioptions': If present,
1475 then whenever Visual mode is started, or the Visual
1476 area extended, Vim tries to become the owner of the
1477 windowing system's global selection or put the
1478 selected text on the clipboard used by the selection
1479 register "*. See |guioptions_a| and |quotestar| for
1480 details. When the GUI is active, the 'a' flag in
1481 'guioptions' is used, when the GUI is not active, this
1482 "autoselect" flag is used.
1483 Also applies to the modeless selection.
1484
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001485 *clipboard-autoselectplus*
1486 autoselectplus Like "autoselect" but using the + register instead of
1487 the * register. Compare to the 'P' flag in
1488 'guioptions'.
1489
1490 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001491 autoselectml Like "autoselect", but for the modeless selection
1492 only. Compare to the 'A' flag in 'guioptions'.
1493
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001494 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001495 html When the clipboard contains HTML, use this when
1496 pasting. When putting text on the clipboard, mark it
1497 as HTML. This works to copy rendered HTML from
1498 Firefox, paste it as raw HTML in Vim, select the HTML
1499 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001500 You probably want to add this only temporarily,
1501 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001502 Only supported for GTK version 2 and later.
1503 Only available with the |+multi_byte| feature.
1504
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001505 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 exclude:{pattern}
1507 Defines a pattern that is matched against the name of
1508 the terminal 'term'. If there is a match, no
1509 connection will be made to the X server. This is
1510 useful in this situation:
1511 - Running Vim in a console.
1512 - $DISPLAY is set to start applications on another
1513 display.
1514 - You do not want to connect to the X server in the
1515 console, but do want this in a terminal emulator.
1516 To never connect to the X server use: >
1517 exclude:.*
1518< This has the same effect as using the |-X| argument.
1519 Note that when there is no connection to the X server
1520 the window title won't be restored and the clipboard
1521 cannot be accessed.
1522 The value of 'magic' is ignored, {pattern} is
1523 interpreted as if 'magic' was on.
1524 The rest of the option value will be used for
1525 {pattern}, this must be the last entry.
1526
1527 *'cmdheight'* *'ch'*
1528'cmdheight' 'ch' number (default 1)
1529 global
1530 {not in Vi}
1531 Number of screen lines to use for the command-line. Helps avoiding
1532 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001533 The value of this option is stored with the tab page, so that each tab
1534 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535
1536 *'cmdwinheight'* *'cwh'*
1537'cmdwinheight' 'cwh' number (default 7)
1538 global
1539 {not in Vi}
1540 {not available when compiled without the |+vertsplit|
1541 feature}
1542 Number of screen lines to use for the command-line window. |cmdwin|
1543
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001544 *'colorcolumn'* *'cc'*
1545'colorcolumn' 'cc' string (default "")
1546 local to window
1547 {not in Vi}
1548 {not available when compiled without the |+syntax|
1549 feature}
1550 'colorcolumn' is a comma separated list of screen columns that are
1551 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1552 text. Will make screen redrawing slower.
1553 The screen column can be an absolute number, or a number preceded with
1554 '+' or '-', which is added to or subtracted from 'textwidth'. >
1555
1556 :set cc=+1 " highlight column after 'textwidth'
1557 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1558 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1559<
1560 When 'textwidth' is zero then the items with '-' and '+' are not used.
1561 A maximum of 256 columns are highlighted.
1562
Bram Moolenaar071d4272004-06-13 20:20:40 +00001563 *'columns'* *'co'* *E594*
1564'columns' 'co' number (default 80 or terminal width)
1565 global
1566 {not in Vi}
1567 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001568 initialization and does not have to be set by hand. Also see
1569 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 When Vim is running in the GUI or in a resizable window, setting this
1571 option will cause the window size to be changed. When you only want
1572 to use the size for the GUI, put the command in your |gvimrc| file.
1573 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001574 number of columns of the display, the display may be messed up. For
1575 the GUI it is always possible and Vim limits the number of columns to
1576 what fits on the screen. You can use this command to get the widest
1577 window possible: >
1578 :set columns=9999
1579< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580
1581 *'comments'* *'com'* *E524* *E525*
1582'comments' 'com' string (default
1583 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1584 local to buffer
1585 {not in Vi}
1586 {not available when compiled without the |+comments|
1587 feature}
1588 A comma separated list of strings that can start a comment line. See
1589 |format-comments|. See |option-backslash| about using backslashes to
1590 insert a space.
1591
1592 *'commentstring'* *'cms'* *E537*
1593'commentstring' 'cms' string (default "/*%s*/")
1594 local to buffer
1595 {not in Vi}
1596 {not available when compiled without the |+folding|
1597 feature}
1598 A template for a comment. The "%s" in the value is replaced with the
1599 comment text. Currently only used to add markers for folding, see
1600 |fold-marker|.
1601
1602 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001603'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1604 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 global
1606 {not in Vi}
1607 This option has the effect of making Vim either more Vi-compatible, or
1608 make Vim behave in a more useful way.
1609 This is a special kind of option, because when it's set or reset,
1610 other options are also changed as a side effect. CAREFUL: Setting or
1611 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001612 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 set this option in your vimrc file, you should probably put it at the
1614 very start.
1615 By default this option is on and the Vi defaults are used for the
1616 options. This default was chosen for those people who want to use Vim
1617 just like Vi, and don't even (want to) know about the 'compatible'
1618 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001619 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001620 this option is switched off, and all options that have not been
1621 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001622 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001623 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001624 happen for the system-wide vimrc or gvimrc file, nor for a file given
1625 with the |-u| argument). Also see |compatible-default| and
1626 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 You can also set this option with the "-C" argument, and reset it with
1628 "-N". See |-C| and |-N|.
1629 Switching this option off makes the Vim defaults be used for options
1630 that have a different Vi and Vim default value. See the options
1631 marked with a '+' below. Other options are not modified.
1632 At the moment this option is set, several other options will be set
1633 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001634 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 editing.
1636 See also 'cpoptions'.
1637
1638 option + set value effect ~
1639
1640 'allowrevins' off no CTRL-_ command
1641 'backupcopy' Unix: "yes" backup file is a copy
1642 others: "auto" copy or rename backup file
1643 'backspace' "" normal backspace
1644 'backup' off no backup file
1645 'cindent' off no C code indentation
1646 'cedit' + "" no key to open the |cmdwin|
1647 'cpoptions' + (all flags) Vi-compatible flags
1648 'cscopetag' off don't use cscope for ":tag"
1649 'cscopetagorder' 0 see |cscopetagorder|
1650 'cscopeverbose' off see |cscopeverbose|
1651 'digraph' off no digraphs
1652 'esckeys' + off no <Esc>-keys in Insert mode
1653 'expandtab' off tabs not expanded to spaces
1654 'fileformats' + "" no automatic file format detection,
1655 "dos,unix" except for DOS, Windows and OS/2
1656 'formatoptions' + "vt" Vi compatible formatting
1657 'gdefault' off no default 'g' flag for ":s"
1658 'history' + 0 no commandline history
1659 'hkmap' off no Hebrew keyboard mapping
1660 'hkmapp' off no phonetic Hebrew keyboard mapping
1661 'hlsearch' off no highlighting of search matches
1662 'incsearch' off no incremental searching
1663 'indentexpr' "" no indenting by expression
1664 'insertmode' off do not start in Insert mode
1665 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1666 characters and '_'
1667 'joinspaces' on insert 2 spaces after period
1668 'modeline' + off no modelines
1669 'more' + off no pauses in listings
1670 'revins' off no reverse insert
1671 'ruler' off no ruler
1672 'scrolljump' 1 no jump scroll
1673 'scrolloff' 0 no scroll offset
1674 'shiftround' off indent not rounded to shiftwidth
1675 'shortmess' + "" no shortening of messages
1676 'showcmd' + off command characters not shown
1677 'showmode' + off current mode not shown
1678 'smartcase' off no automatic ignore case switch
1679 'smartindent' off no smart indentation
1680 'smarttab' off no smart tab size
1681 'softtabstop' 0 tabs are always 'tabstop' positions
1682 'startofline' on goto startofline with some commands
1683 'tagrelative' + off tag file names are not relative
1684 'textauto' + off no automatic textmode detection
1685 'textwidth' 0 no automatic line wrap
1686 'tildeop' off tilde is not an operator
1687 'ttimeout' off no terminal timeout
1688 'whichwrap' + "" left-right movements don't wrap
1689 'wildchar' + CTRL-E only when the current value is <Tab>
1690 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001691 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692
1693 *'complete'* *'cpt'* *E535*
1694'complete' 'cpt' string (default: ".,w,b,u,t,i")
1695 local to buffer
1696 {not in Vi}
1697 This option specifies how keyword completion |ins-completion| works
1698 when CTRL-P or CTRL-N are used. It is also used for whole-line
1699 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1700 and the places to scan. It is a comma separated list of flags:
1701 . scan the current buffer ('wrapscan' is ignored)
1702 w scan buffers from other windows
1703 b scan other loaded buffers that are in the buffer list
1704 u scan the unloaded buffers that are in the buffer list
1705 U scan the buffers that are not in the buffer list
1706 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001707 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 k{dict} scan the file {dict}. Several "k" flags can be given,
1709 patterns are valid too. For example: >
1710 :set cpt=k/usr/dict/*,k~/spanish
1711< s scan the files given with the 'thesaurus' option
1712 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1713 are valid too.
1714 i scan current and included files
1715 d scan current and included files for defined name or macro
1716 |i_CTRL-X_CTRL-D|
1717 ] tag completion
1718 t same as "]"
1719
1720 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1721 not executed, this may lead to unexpected completions from some files
1722 (gzipped files for example). Unloaded buffers are not scanned for
1723 whole-line completion.
1724
1725 The default is ".,w,b,u,t,i", which means to scan:
1726 1. the current buffer
1727 2. buffers in other windows
1728 3. other loaded buffers
1729 4. unloaded buffers
1730 5. tags
1731 6. included files
1732
1733 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001734 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1735 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001737 *'completefunc'* *'cfu'*
1738'completefunc' 'cfu' string (default: empty)
1739 local to buffer
1740 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001741 {not available when compiled without the |+eval|
1742 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001743 This option specifies a function to be used for Insert mode completion
1744 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001745 See |complete-functions| for an explanation of how the function is
1746 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001747 This option cannot be set from a |modeline| or in the |sandbox|, for
1748 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001749
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001750 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001751'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001752 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001753 {not available when compiled without the
1754 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001755 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001756 A comma separated list of options for Insert mode completion
1757 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001758
1759 menu Use a popup menu to show the possible completions. The
1760 menu is only shown when there is more than one match and
1761 sufficient colors are available. |ins-completion-menu|
1762
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001763 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001764 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001765 match, e.g., what file it comes from.
1766
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001767 longest Only insert the longest common text of the matches. If
1768 the menu is displayed you can use CTRL-L to add more
1769 characters. Whether case is ignored depends on the kind
1770 of completion. For buffer text the 'ignorecase' option is
1771 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001772
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001773 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001774 completion in the preview window. Only works in
1775 combination with "menu" or "menuone".
1776
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001777
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001778 *'concealcursor'* *'cocu'*
1779'concealcursor' 'cocu' string (default: "")
1780 local to window
1781 {not in Vi}
1782 {not available when compiled without the |+conceal|
1783 feature}
1784 Sets the modes in which text in the cursor line can also be concealed.
1785 When the current mode is listed then concealing happens just like in
1786 other lines.
1787 n Normal mode
1788 v Visual mode
1789 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001790 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001791
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001792 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001793 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001794 are moving around text is concealed, but when starting to insert text
1795 or selecting a Visual area the concealed text is displayed, so that
1796 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001797 Keep in mind that the cursor position is not always where it's
1798 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001799
1800
1801'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001802 number (default 0)
1803 local to window
1804 {not in Vi}
1805 {not available when compiled without the |+conceal|
1806 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001807 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1808 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001809
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001810 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001811 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001812 1 Each block of concealed text is replaced with one
1813 character. If the syntax item does not have a custom
1814 replacement character defined (see |:syn-cchar|) the
1815 character defined in 'listchars' is used (default is a
1816 space).
1817 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001818 2 Concealed text is completely hidden unless it has a
1819 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001820 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001821 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001822
Bram Moolenaara7781e02010-07-19 20:13:22 +02001823 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001824 edit and copy the text. This can be changed with the 'concealcursor'
1825 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001826
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1828'confirm' 'cf' boolean (default off)
1829 global
1830 {not in Vi}
1831 When 'confirm' is on, certain operations that would normally
1832 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1833 instead raise a |dialog| asking if you wish to save the current
1834 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1835 If 'confirm' is off you can still activate confirmation for one
1836 command only (this is most useful in mappings) with the |:confirm|
1837 command.
1838 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1839
1840 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1841'conskey' 'consk' boolean (default off)
1842 global
1843 {not in Vi} {only for MS-DOS}
1844 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001845 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 three methods of console input are available:
1847 'conskey' 'bioskey' action ~
1848 on on or off direct console input
1849 off on BIOS
1850 off off STDIN
1851
1852 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1853'copyindent' 'ci' boolean (default off)
1854 local to buffer
1855 {not in Vi}
1856 Copy the structure of the existing lines indent when autoindenting a
1857 new line. Normally the new indent is reconstructed by a series of
1858 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1859 in which case only spaces are used). Enabling this option makes the
1860 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001861 existing line. 'expandtab' has no effect on these characters, a Tab
1862 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863 line, the remaining space is filled in the normal manner.
1864 NOTE: 'copyindent' is reset when 'compatible' is set.
1865 Also see 'preserveindent'.
1866
1867 *'cpoptions'* *'cpo'*
1868'cpoptions' 'cpo' string (Vim default: "aABceFs",
1869 Vi default: all flags)
1870 global
1871 {not in Vi}
1872 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001873 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 not being vi-compatible is mostly or sometimes preferred.
1875 'cpoptions' stands for "compatible-options".
1876 Commas can be added for readability.
1877 To avoid problems with flags that are added in the future, use the
1878 "+=" and "-=" feature of ":set" |add-option-flags|.
1879 NOTE: This option is set to the Vi default value when 'compatible' is
1880 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001881 NOTE: This option is set to the POSIX default value at startup when
1882 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001883 variable exists |posix|. This means Vim tries to behave like the
1884 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885
1886 contains behavior ~
1887 *cpo-a*
1888 a When included, a ":read" command with a file name
1889 argument will set the alternate file name for the
1890 current window.
1891 *cpo-A*
1892 A When included, a ":write" command with a file name
1893 argument will set the alternate file name for the
1894 current window.
1895 *cpo-b*
1896 b "\|" in a ":map" command is recognized as the end of
1897 the map command. The '\' is included in the mapping,
1898 the text after the '|' is interpreted as the next
1899 command. Use a CTRL-V instead of a backslash to
1900 include the '|' in the mapping. Applies to all
1901 mapping, abbreviation, menu and autocmd commands.
1902 See also |map_bar|.
1903 *cpo-B*
1904 B A backslash has no special meaning in mappings,
1905 abbreviations and the "to" part of the menu commands.
1906 Remove this flag to be able to use a backslash like a
1907 CTRL-V. For example, the command ":map X \<Esc>"
1908 results in X being mapped to:
1909 'B' included: "\^[" (^[ is a real <Esc>)
1910 'B' excluded: "<Esc>" (5 characters)
1911 ('<' excluded in both cases)
1912 *cpo-c*
1913 c Searching continues at the end of any match at the
1914 cursor position, but not further than the start of the
1915 next line. When not present searching continues
1916 one character from the cursor position. With 'c'
1917 "abababababab" only gets three matches when repeating
1918 "/abab", without 'c' there are five matches.
1919 *cpo-C*
1920 C Do not concatenate sourced lines that start with a
1921 backslash. See |line-continuation|.
1922 *cpo-d*
1923 d Using "./" in the 'tags' option doesn't mean to use
1924 the tags file relative to the current file, but the
1925 tags file in the current directory.
1926 *cpo-D*
1927 D Can't use CTRL-K to enter a digraph after Normal mode
1928 commands with a character argument, like |r|, |f| and
1929 |t|.
1930 *cpo-e*
1931 e When executing a register with ":@r", always add a
1932 <CR> to the last line, also when the register is not
1933 linewise. If this flag is not present, the register
1934 is not linewise and the last line does not end in a
1935 <CR>, then the last line is put on the command-line
1936 and can be edited before hitting <CR>.
1937 *cpo-E*
1938 E It is an error when using "y", "d", "c", "g~", "gu" or
1939 "gU" on an Empty region. The operators only work when
1940 at least one character is to be operate on. Example:
1941 This makes "y0" fail in the first column.
1942 *cpo-f*
1943 f When included, a ":read" command with a file name
1944 argument will set the file name for the current buffer,
1945 if the current buffer doesn't have a file name yet.
1946 *cpo-F*
1947 F When included, a ":write" command with a file name
1948 argument will set the file name for the current
1949 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001950 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001951 *cpo-g*
1952 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001953 *cpo-H*
1954 H When using "I" on a line with only blanks, insert
1955 before the last blank. Without this flag insert after
1956 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 *cpo-i*
1958 i When included, interrupting the reading of a file will
1959 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001960 *cpo-I*
1961 I When moving the cursor up or down just after inserting
1962 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 *cpo-j*
1964 j When joining lines, only add two spaces after a '.',
1965 not after '!' or '?'. Also see 'joinspaces'.
1966 *cpo-J*
1967 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001968 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969 white space.
1970 *cpo-k*
1971 k Disable the recognition of raw key codes in
1972 mappings, abbreviations, and the "to" part of menu
1973 commands. For example, if <Key> sends ^[OA (where ^[
1974 is <Esc>), the command ":map X ^[OA" results in X
1975 being mapped to:
1976 'k' included: "^[OA" (3 characters)
1977 'k' excluded: "<Key>" (one key code)
1978 Also see the '<' flag below.
1979 *cpo-K*
1980 K Don't wait for a key code to complete when it is
1981 halfway a mapping. This breaks mapping <F1><F1> when
1982 only part of the second <F1> has been read. It
1983 enables cancelling the mapping by typing <F1><Esc>.
1984 *cpo-l*
1985 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001986 literally, only "\]", "\^", "\-" and "\\" are special.
1987 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1989 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001990 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 *cpo-L*
1992 L When the 'list' option is set, 'wrapmargin',
1993 'textwidth', 'softtabstop' and Virtual Replace mode
1994 (see |gR|) count a <Tab> as two characters, instead of
1995 the normal behavior of a <Tab>.
1996 *cpo-m*
1997 m When included, a showmatch will always wait half a
1998 second. When not included, a showmatch will wait half
1999 a second or until a character is typed. |'showmatch'|
2000 *cpo-M*
2001 M When excluded, "%" matching will take backslashes into
2002 account. Thus in "( \( )" and "\( ( \)" the outer
2003 parenthesis match. When included "%" ignores
2004 backslashes, which is Vi compatible.
2005 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002006 n When included, the column used for 'number' and
2007 'relativenumber' will also be used for text of wrapped
2008 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 *cpo-o*
2010 o Line offset to search command is not remembered for
2011 next search.
2012 *cpo-O*
2013 O Don't complain if a file is being overwritten, even
2014 when it didn't exist when editing it. This is a
2015 protection against a file unexpectedly created by
2016 someone else. Vi didn't complain about this.
2017 *cpo-p*
2018 p Vi compatible Lisp indenting. When not present, a
2019 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002020 *cpo-P*
2021 P When included, a ":write" command that appends to a
2022 file will set the file name for the current buffer, if
2023 the current buffer doesn't have a file name yet and
2024 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002025 *cpo-q*
2026 q When joining multiple lines leave the cursor at the
2027 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028 *cpo-r*
2029 r Redo ("." command) uses "/" to repeat a search
2030 command, instead of the actually used search string.
2031 *cpo-R*
2032 R Remove marks from filtered lines. Without this flag
2033 marks are kept like |:keepmarks| was used.
2034 *cpo-s*
2035 s Set buffer options when entering the buffer for the
2036 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002037 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002038 set when the buffer is created.
2039 *cpo-S*
2040 S Set buffer options always when entering a buffer
2041 (except 'readonly', 'fileformat', 'filetype' and
2042 'syntax'). This is the (most) Vi compatible setting.
2043 The options are set to the values in the current
2044 buffer. When you change an option and go to another
2045 buffer, the value is copied. Effectively makes the
2046 buffer options global to all buffers.
2047
2048 's' 'S' copy buffer options
2049 no no when buffer created
2050 yes no when buffer first entered (default)
2051 X yes each time when buffer entered (vi comp.)
2052 *cpo-t*
2053 t Search pattern for the tag command is remembered for
2054 "n" command. Otherwise Vim only puts the pattern in
2055 the history for search pattern, but doesn't change the
2056 last used search pattern.
2057 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002058 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059 *cpo-v*
2060 v Backspaced characters remain visible on the screen in
2061 Insert mode. Without this flag the characters are
2062 erased from the screen right away. With this flag the
2063 screen newly typed text overwrites backspaced
2064 characters.
2065 *cpo-w*
2066 w When using "cw" on a blank character, only change one
2067 character and not all blanks until the start of the
2068 next word.
2069 *cpo-W*
2070 W Don't overwrite a readonly file. When omitted, ":w!"
2071 overwrites a readonly file, if possible.
2072 *cpo-x*
2073 x <Esc> on the command-line executes the command-line.
2074 The default in Vim is to abandon the command-line,
2075 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002076 *cpo-X*
2077 X When using a count with "R" the replaced text is
2078 deleted only once. Also when repeating "R" with "."
2079 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 *cpo-y*
2081 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002082 *cpo-Z*
2083 Z When using "w!" while the 'readonly' option is set,
2084 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 *cpo-!*
2086 ! When redoing a filter command, use the last used
2087 external command, whatever it was. Otherwise the last
2088 used -filter- command is used.
2089 *cpo-$*
2090 $ When making a change to one line, don't redisplay the
2091 line, but put a '$' at the end of the changed text.
2092 The changed text will be overwritten when you type the
2093 new text. The line is redisplayed if you type any
2094 command that moves the cursor from the insertion
2095 point.
2096 *cpo-%*
2097 % Vi-compatible matching is done for the "%" command.
2098 Does not recognize "#if", "#endif", etc.
2099 Does not recognize "/*" and "*/".
2100 Parens inside single and double quotes are also
2101 counted, causing a string that contains a paren to
2102 disturb the matching. For example, in a line like
2103 "if (strcmp("foo(", s))" the first paren does not
2104 match the last one. When this flag is not included,
2105 parens inside single and double quotes are treated
2106 specially. When matching a paren outside of quotes,
2107 everything inside quotes is ignored. When matching a
2108 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002109 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002110 This flag is also used for other features, such as
2111 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002112 *cpo--*
2113 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002114 it would go above the first line or below the last
2115 line. Without it the cursor moves to the first or
2116 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002117 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002118 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002119 *cpo-+*
2120 + When included, a ":write file" command will reset the
2121 'modified' flag of the buffer, even though the buffer
2122 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002123 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124 * Use ":*" in the same way as ":@". When not included,
2125 ":*" is an alias for ":'<,'>", select the Visual area.
2126 *cpo-<*
2127 < Disable the recognition of special key codes in |<>|
2128 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002129 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 ":map X <Tab>" results in X being mapped to:
2131 '<' included: "<Tab>" (5 characters)
2132 '<' excluded: "^I" (^I is a real <Tab>)
2133 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002134 *cpo->*
2135 > When appending to a register, put a line break before
2136 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002137 *cpo-;*
2138 ; When using |,| or |;| to repeat the last |t| search
2139 and the cursor is right in front of the searched
2140 character, the cursor won't move. When not included,
2141 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002142 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002143
2144 POSIX flags. These are not included in the Vi default value, except
2145 when $VIM_POSIX was set on startup. |posix|
2146
2147 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002148 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002149 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002150 *cpo-&*
2151 & When ":preserve" was used keep the swap file when
2152 exiting normally while this buffer is still loaded.
2153 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002154 *cpo-\*
2155 \ Backslash in a [] range in a search pattern is taken
2156 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002157 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2158 '\' excluded: "/[ \-]" finds <Space> and '-'
2159 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002160 *cpo-/*
2161 / When "%" is used as the replacement string in a |:s|
2162 command, use the previous replacement string. |:s%|
2163 *cpo-{*
2164 { The |{| and |}| commands also stop at a "{" character
2165 at the start of a line.
2166 *cpo-.*
2167 . The ":chdir" and ":cd" commands fail if the current
2168 buffer is modified, unless ! is used. Vim doesn't
2169 need this, since it remembers the full path of an
2170 opened file.
2171 *cpo-bar*
2172 | The value of the $LINES and $COLUMNS environment
2173 variables overrule the terminal size values obtained
2174 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002175
Bram Moolenaar071d4272004-06-13 20:20:40 +00002176
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002177 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002178'cryptmethod' string (default "zip")
2179 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002180 {not in Vi}
2181 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002182 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002183 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002184 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002185 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002186 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002187 or later, files can NOT be read by Vim 7.2 and older.
2188 This adds a "seed" to the file, every time you write
2189 the file the encrypted bytes will be different.
2190
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002191 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002192 to the detected method of the file being read. Thus if you write it
2193 without changing 'cryptmethod' the same method will be used.
2194 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002195 explicitly write it, you don't get a warning unless there are other
2196 modifications. Also see |:X|.
2197
2198 When setting the global value to an empty string, it will end up with
2199 the value "zip". When setting the local value to an empty string the
2200 buffer will use the global value.
2201
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002202 When a new encryption method is added in a later version of Vim, and
2203 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002204 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002205
2206
Bram Moolenaar071d4272004-06-13 20:20:40 +00002207 *'cscopepathcomp'* *'cspc'*
2208'cscopepathcomp' 'cspc' number (default 0)
2209 global
2210 {not available when compiled without the |+cscope|
2211 feature}
2212 {not in Vi}
2213 Determines how many components of the path to show in a list of tags.
2214 See |cscopepathcomp|.
2215
2216 *'cscopeprg'* *'csprg'*
2217'cscopeprg' 'csprg' string (default "cscope")
2218 global
2219 {not available when compiled without the |+cscope|
2220 feature}
2221 {not in Vi}
2222 Specifies the command to execute cscope. See |cscopeprg|.
2223 This option cannot be set from a |modeline| or in the |sandbox|, for
2224 security reasons.
2225
2226 *'cscopequickfix'* *'csqf'*
2227'cscopequickfix' 'csqf' string (default "")
2228 global
2229 {not available when compiled without the |+cscope|
2230 or |+quickfix| features}
2231 {not in Vi}
2232 Specifies whether to use quickfix window to show cscope results.
2233 See |cscopequickfix|.
2234
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002235 *'cscoperelative'* *'csre'*
2236'cscoperelative' 'csre' boolean (default off)
2237 global
2238 {not available when compiled without the |+cscope|
2239 feature}
2240 {not in Vi}
2241 In the absence of a prefix (-P) for cscope. setting this option enables
2242 to use the basename of cscope.out path as the prefix.
2243 See |cscoperelative|.
2244
Bram Moolenaar071d4272004-06-13 20:20:40 +00002245 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2246'cscopetag' 'cst' boolean (default off)
2247 global
2248 {not available when compiled without the |+cscope|
2249 feature}
2250 {not in Vi}
2251 Use cscope for tag commands. See |cscope-options|.
2252 NOTE: This option is reset when 'compatible' is set.
2253
2254 *'cscopetagorder'* *'csto'*
2255'cscopetagorder' 'csto' number (default 0)
2256 global
2257 {not available when compiled without the |+cscope|
2258 feature}
2259 {not in Vi}
2260 Determines the order in which ":cstag" performs a search. See
2261 |cscopetagorder|.
2262 NOTE: This option is set to 0 when 'compatible' is set.
2263
2264 *'cscopeverbose'* *'csverb'*
2265 *'nocscopeverbose'* *'nocsverb'*
2266'cscopeverbose' 'csverb' boolean (default off)
2267 global
2268 {not available when compiled without the |+cscope|
2269 feature}
2270 {not in Vi}
2271 Give messages when adding a cscope database. See |cscopeverbose|.
2272 NOTE: This option is reset when 'compatible' is set.
2273
Bram Moolenaar860cae12010-06-05 23:22:07 +02002274 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2275'cursorbind' 'crb' boolean (default off)
2276 local to window
2277 {not in Vi}
2278 {not available when compiled without the |+cursorbind|
2279 feature}
2280 When this option is set, as the cursor in the current
2281 window moves other cursorbound windows (windows that also have
2282 this option set) move their cursors to the corresponding line and
2283 column. This option is useful for viewing the
2284 differences between two versions of a file (see 'diff'); in diff mode,
2285 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002286 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002287
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002288
2289 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2290'cursorcolumn' 'cuc' boolean (default off)
2291 local to window
2292 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002293 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002294 feature}
2295 Highlight the screen column of the cursor with CursorColumn
2296 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2297 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002298 If you only want the highlighting in the current window you can use
2299 these autocommands: >
2300 au WinLeave * set nocursorline nocursorcolumn
2301 au WinEnter * set cursorline cursorcolumn
2302<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002303
2304 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2305'cursorline' 'cul' boolean (default off)
2306 local to window
2307 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002308 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002309 feature}
2310 Highlight the screen line of the cursor with CursorLine
2311 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2312 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002313 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002314 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002315
2316
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 *'debug'*
2318'debug' string (default "")
2319 global
2320 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002321 These values can be used:
2322 msg Error messages that would otherwise be omitted will be given
2323 anyway.
2324 throw Error messages that would otherwise be omitted will be given
2325 anyway and also throw an exception and set |v:errmsg|.
2326 beep A message will be given when otherwise only a beep would be
2327 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002328 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002329 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2330 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331
2332 *'define'* *'def'*
2333'define' 'def' string (default "^\s*#\s*define")
2334 global or local to buffer |global-local|
2335 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002336 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 pattern, just like for the "/" command. This option is used for the
2338 commands like "[i" and "[d" |include-search|. The 'isident' option is
2339 used to recognize the defined name after the match:
2340 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2341 See |option-backslash| about inserting backslashes to include a space
2342 or backslash.
2343 The default value is for C programs. For C++ this value would be
2344 useful, to include const type declarations: >
2345 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2346< When using the ":set" command, you need to double the backslashes!
2347
2348 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2349'delcombine' 'deco' boolean (default off)
2350 global
2351 {not in Vi}
2352 {only available when compiled with the |+multi_byte|
2353 feature}
2354 If editing Unicode and this option is set, backspace and Normal mode
2355 "x" delete each combining character on its own. When it is off (the
2356 default) the character along with its combining characters are
2357 deleted.
2358 Note: When 'delcombine' is set "xx" may work different from "2x"!
2359
2360 This is useful for Arabic, Hebrew and many other languages where one
2361 may have combining characters overtop of base characters, and want
2362 to remove only the combining ones.
2363
2364 *'dictionary'* *'dict'*
2365'dictionary' 'dict' string (default "")
2366 global or local to buffer |global-local|
2367 {not in Vi}
2368 List of file names, separated by commas, that are used to lookup words
2369 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2370 contain a list of words. This can be one word per line, or several
2371 words per line, separated by non-keyword characters (white space is
2372 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002373 When this option is empty, or an entry "spell" is present, spell
2374 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002375 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 after a comma are ignored, otherwise spaces are included in the file
2377 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002378 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 Where to find a list of words?
2380 - On FreeBSD, there is the file "/usr/share/dict/words".
2381 - In the Simtel archive, look in the "msdos/linguist" directory.
2382 - In "miscfiles" of the GNU collection.
2383 The use of |:set+=| and |:set-=| is preferred when adding or removing
2384 directories from the list. This avoids problems when a future version
2385 uses another default.
2386 Backticks cannot be used in this option for security reasons.
2387
2388 *'diff'* *'nodiff'*
2389'diff' boolean (default off)
2390 local to window
2391 {not in Vi}
2392 {not available when compiled without the |+diff|
2393 feature}
2394 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002395 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396
2397 *'dex'* *'diffexpr'*
2398'diffexpr' 'dex' string (default "")
2399 global
2400 {not in Vi}
2401 {not available when compiled without the |+diff|
2402 feature}
2403 Expression which is evaluated to obtain an ed-style diff file from two
2404 versions of a file. See |diff-diffexpr|.
2405 This option cannot be set from a |modeline| or in the |sandbox|, for
2406 security reasons.
2407
2408 *'dip'* *'diffopt'*
2409'diffopt' 'dip' string (default "filler")
2410 global
2411 {not in Vi}
2412 {not available when compiled without the |+diff|
2413 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002414 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 All are optional. Items must be separated by a comma.
2416
2417 filler Show filler lines, to keep the text
2418 synchronized with a window that has inserted
2419 lines at the same position. Mostly useful
2420 when windows are side-by-side and 'scrollbind'
2421 is set.
2422
2423 context:{n} Use a context of {n} lines between a change
2424 and a fold that contains unchanged lines.
2425 When omitted a context of six lines is used.
2426 See |fold-diff|.
2427
2428 icase Ignore changes in case of text. "a" and "A"
2429 are considered the same. Adds the "-i" flag
2430 to the "diff" command if 'diffexpr' is empty.
2431
2432 iwhite Ignore changes in amount of white space. Adds
2433 the "-b" flag to the "diff" command if
2434 'diffexpr' is empty. Check the documentation
2435 of the "diff" command for what this does
2436 exactly. It should ignore adding trailing
2437 white space, but not leading white space.
2438
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002439 horizontal Start diff mode with horizontal splits (unless
2440 explicitly specified otherwise).
2441
2442 vertical Start diff mode with vertical splits (unless
2443 explicitly specified otherwise).
2444
2445 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2446 starting diff mode. Without this 2 is used.
2447
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 Examples: >
2449
2450 :set diffopt=filler,context:4
2451 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002452 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002453<
2454 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2455'digraph' 'dg' boolean (default off)
2456 global
2457 {not in Vi}
2458 {not available when compiled without the |+digraphs|
2459 feature}
2460 Enable the entering of digraphs in Insert mode with {char1} <BS>
2461 {char2}. See |digraphs|.
2462 NOTE: This option is reset when 'compatible' is set.
2463
2464 *'directory'* *'dir'*
2465'directory' 'dir' string (default for Amiga: ".,t:",
2466 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2467 for Unix: ".,~/tmp,/var/tmp,/tmp")
2468 global
2469 List of directory names for the swap file, separated with commas.
2470 - The swap file will be created in the first directory where this is
2471 possible.
2472 - Empty means that no swap file will be used (recovery is
2473 impossible!).
2474 - A directory "." means to put the swap file in the same directory as
2475 the edited file. On Unix, a dot is prepended to the file name, so
2476 it doesn't show in a directory listing. On MS-Windows the "hidden"
2477 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002478 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 put the swap file relative to where the edited file is. The leading
2480 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002481 - For Unix and Win32, if a directory ends in two path separators "//"
2482 or "\\", the swap file name will be built from the complete path to
2483 the file with all path separators substituted to percent '%' signs.
2484 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002485 On Win32, when a separating comma is following, you must use "//",
2486 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 - Spaces after the comma are ignored, other spaces are considered part
2488 of the directory name. To have a space at the start of a directory
2489 name, precede it with a backslash.
2490 - To include a comma in a directory name precede it with a backslash.
2491 - A directory name may end in an ':' or '/'.
2492 - Environment variables are expanded |:set_env|.
2493 - Careful with '\' characters, type one before a space, type two to
2494 get one in the option (see |option-backslash|), for example: >
2495 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2496< - For backwards compatibility with Vim version 3.0 a '>' at the start
2497 of the option is removed.
2498 Using "." first in the list is recommended. This means that editing
2499 the same file twice will result in a warning. Using "/tmp" on Unix is
2500 discouraged: When the system crashes you lose the swap file.
2501 "/var/tmp" is often not cleared when rebooting, thus is a better
2502 choice than "/tmp". But it can contain a lot of files, your swap
2503 files get lost in the crowd. That is why a "tmp" directory in your
2504 home directory is tried first.
2505 The use of |:set+=| and |:set-=| is preferred when adding or removing
2506 directories from the list. This avoids problems when a future version
2507 uses another default.
2508 This option cannot be set from a |modeline| or in the |sandbox|, for
2509 security reasons.
2510 {Vi: directory to put temp file in, defaults to "/tmp"}
2511
2512 *'display'* *'dy'*
2513'display' 'dy' string (default "")
2514 global
2515 {not in Vi}
2516 Change the way text is displayed. This is comma separated list of
2517 flags:
2518 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002519 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 last line that doesn't fit is replaced with "@" lines.
2521 uhex Show unprintable characters hexadecimal as <xx>
2522 instead of using ^C and ~C.
2523
2524 *'eadirection'* *'ead'*
2525'eadirection' 'ead' string (default "both")
2526 global
2527 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002528 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 feature}
2530 Tells when the 'equalalways' option applies:
2531 ver vertically, width of windows is not affected
2532 hor horizontally, height of windows is not affected
2533 both width and height of windows is affected
2534
2535 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2536'edcompatible' 'ed' boolean (default off)
2537 global
2538 Makes the 'g' and 'c' flags of the ":substitute" command to be
2539 toggled each time the flag is given. See |complex-change|. See
2540 also 'gdefault' option.
2541 Switching this option on is discouraged!
2542
2543 *'encoding'* *'enc'* *E543*
2544'encoding' 'enc' string (default: "latin1" or value from $LANG)
2545 global
2546 {only available when compiled with the |+multi_byte|
2547 feature}
2548 {not in Vi}
2549 Sets the character encoding used inside Vim. It applies to text in
2550 the buffers, registers, Strings in expressions, text stored in the
2551 viminfo file, etc. It sets the kind of characters which Vim can work
2552 with. See |encoding-names| for the possible values.
2553
2554 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002555 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002557 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558
Bram Moolenaar865242e2010-07-14 21:12:05 +02002559 This option cannot be set from a |modeline|. It would most likely
2560 corrupt the text.
2561
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2563 "utf-8". Although care has been taken to allow different values of
2564 'encoding', "utf-8" is the natural choice for the environment and
2565 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002566 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 versions, and to avoid changing the encoding of newly created files
2568 without your knowledge (in case 'fileencodings' is empty).
2569
2570 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002571 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 iconv() or as specified with 'charconvert'.
2573
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002574 If you need to know whether 'encoding' is a multi-byte encoding, you
2575 can use: >
2576 if has("multi_byte_encoding")
2577<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 Normally 'encoding' will be equal to your current locale. This will
2579 be the default if Vim recognizes your environment settings. If
2580 'encoding' is not set to the current locale, 'termencoding' must be
2581 set to convert typed and displayed text. See |encoding-table|.
2582
2583 When you set this option, it fires the |EncodingChanged| autocommand
2584 event so that you can set up fonts if necessary.
2585
2586 When the option is set, the value is converted to lowercase. Thus
2587 you can set it with uppercase values too. Underscores are translated
2588 to '-' signs.
2589 When the encoding is recognized, it is changed to the standard name.
2590 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2591 "iso-8859-2" and "utf8" becomes "utf-8".
2592
2593 Note: "latin1" is also used when the encoding could not be detected.
2594 This only works when editing files in the same encoding! When the
2595 actual character set is not latin1, make sure 'fileencoding' and
2596 'fileencodings' are empty. When conversion is needed, switch to using
2597 utf-8.
2598
2599 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2600 You don't notice this while editing, but it does matter for the
2601 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2602 setting 'encoding' to one of these values instead of utf-8 only has
2603 effect for encoding used for files when 'fileencoding' is empty.
2604
Bram Moolenaar661b1822005-07-28 22:36:45 +00002605 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2606 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002607
2608 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2609'endofline' 'eol' boolean (default on)
2610 local to buffer
2611 {not in Vi}
2612 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002613 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 option is automatically set when starting to edit a new file, unless
2615 the file does not have an <EOL> for the last line in the file, in
2616 which case it is reset. Normally you don't have to set or reset this
2617 option. When 'binary' is off the value is not used when writing the
2618 file. When 'binary' is on it is used to remember the presence of a
2619 <EOL> for the last line in the file, so that when you write the file
2620 the situation from the original file can be kept. But you can change
2621 it if you want to.
2622
2623 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2624'equalalways' 'ea' boolean (default on)
2625 global
2626 {not in Vi}
2627 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002628 splitting or closing a window. This also happens the moment the
2629 option is switched on. When off, splitting a window will reduce the
2630 size of the current window and leave the other windows the same. When
2631 closing a window the extra lines are given to the window next to it
2632 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 When mixing vertically and horizontally split windows, a minimal size
2634 is computed and some windows may be larger if there is room. The
2635 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002636 Changing the height and width of a window can be avoided by setting
2637 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002638 If a window size is specified when creating a new window sizes are
2639 currently not equalized (it's complicated, but may be implemented in
2640 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641
2642 *'equalprg'* *'ep'*
2643'equalprg' 'ep' string (default "")
2644 global or local to buffer |global-local|
2645 {not in Vi}
2646 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002647 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002648 or 'indentexpr'. When Vim was compiled without internal formatting,
2649 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002650 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 about including spaces and backslashes.
2652 This option cannot be set from a |modeline| or in the |sandbox|, for
2653 security reasons.
2654
2655 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2656'errorbells' 'eb' boolean (default off)
2657 global
2658 Ring the bell (beep or screen flash) for error messages. This only
2659 makes a difference for error messages, the bell will be used always
2660 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002661 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002662 screen flash or do nothing.
2663
2664 *'errorfile'* *'ef'*
2665'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2666 others: "errors.err")
2667 global
2668 {not in Vi}
2669 {not available when compiled without the |+quickfix|
2670 feature}
2671 Name of the errorfile for the QuickFix mode (see |:cf|).
2672 When the "-q" command-line argument is used, 'errorfile' is set to the
2673 following argument. See |-q|.
2674 NOT used for the ":make" command. See 'makeef' for that.
2675 Environment variables are expanded |:set_env|.
2676 See |option-backslash| about including spaces and backslashes.
2677 This option cannot be set from a |modeline| or in the |sandbox|, for
2678 security reasons.
2679
2680 *'errorformat'* *'efm'*
2681'errorformat' 'efm' string (default is very long)
2682 global or local to buffer |global-local|
2683 {not in Vi}
2684 {not available when compiled without the |+quickfix|
2685 feature}
2686 Scanf-like description of the format for the lines in the error file
2687 (see |errorformat|).
2688
2689 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2690'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2691 global
2692 {not in Vi}
2693 Function keys that start with an <Esc> are recognized in Insert
2694 mode. When this option is off, the cursor and function keys cannot be
2695 used in Insert mode if they start with an <Esc>. The advantage of
2696 this is that the single <Esc> is recognized immediately, instead of
2697 after one second. Instead of resetting this option, you might want to
2698 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2699 when 'esckeys' is off, you can still map anything, but the cursor keys
2700 won't work by default.
2701 NOTE: This option is set to the Vi default value when 'compatible' is
2702 set and to the Vim default value when 'compatible' is reset.
2703
2704 *'eventignore'* *'ei'*
2705'eventignore' 'ei' string (default "")
2706 global
2707 {not in Vi}
2708 {not available when compiled without the |+autocmd|
2709 feature}
2710 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002711 When set to "all" or when "all" is one of the items, all autocommand
2712 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 Otherwise this is a comma separated list of event names. Example: >
2714 :set ei=WinEnter,WinLeave
2715<
2716 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2717'expandtab' 'et' boolean (default off)
2718 local to buffer
2719 {not in Vi}
2720 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002721 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2723 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2724 NOTE: This option is reset when 'compatible' is set.
2725
2726 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2727'exrc' 'ex' boolean (default off)
2728 global
2729 {not in Vi}
2730 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2731 directory. If you switch this option on you should also consider
2732 setting the 'secure' option (see |initialization|). Using a local
2733 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2734 also see |.vimrc| and |gui-init|.
2735 This option cannot be set from a |modeline| or in the |sandbox|, for
2736 security reasons.
2737
2738 *'fileencoding'* *'fenc'* *E213*
2739'fileencoding' 'fenc' string (default: "")
2740 local to buffer
2741 {only available when compiled with the |+multi_byte|
2742 feature}
2743 {not in Vi}
2744 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002745
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002747 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 When 'fileencoding' is empty, the same value as 'encoding' will be
2749 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002750 Conversion will also be done when 'encoding' and 'fileencoding' are
2751 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2752 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002754 'encoding' is "utf-8" or another Unicode encoding, conversion
2755 is most likely done in a way that the reverse conversion
2756 results in the same text. When 'encoding' is not "utf-8" some
2757 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002758
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759 See 'encoding' for the possible values. Additionally, values may be
2760 specified that can be handled by the converter, see
2761 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002762
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 When reading a file 'fileencoding' will be set from 'fileencodings'.
2764 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002765 'fileencoding', use the |++enc| argument. One exception: when
2766 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002767 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002768
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2770 When the option is set, the value is converted to lowercase. Thus
2771 you can set it with uppercase values too. '_' characters are
2772 replaced with '-'. If a name is recognized from the list for
2773 'encoding', it is replaced by the standard name. For example
2774 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002775
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 When this option is set, after starting to edit a file, the 'modified'
2777 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002778
2779 Keep in mind that changing 'fenc' from a modeline happens
2780 AFTER the text has been read, thus it applies to when the file will be
2781 written. If you do set 'fenc' in a modeline, you might want to set
2782 'nomodified' to avoid not being able to ":q".
2783
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 This option can not be changed when 'modifiable' is off.
2785
2786 *'fe'*
2787 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002788 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 old short name was 'fe', which is no longer used.
2790
2791 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002792'fileencodings' 'fencs' string (default: "ucs-bom",
2793 "ucs-bom,utf-8,default,latin1" when
2794 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 global
2796 {only available when compiled with the |+multi_byte|
2797 feature}
2798 {not in Vi}
2799 This is a list of character encodings considered when starting to edit
2800 an existing file. When a file is read, Vim tries to use the first
2801 mentioned character encoding. If an error is detected, the next one
2802 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002803 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 an empty string, which means the value of 'encoding' is used.
2805 WARNING: Conversion can cause loss of information! When
2806 'encoding' is "utf-8" (or one of the other Unicode variants)
2807 conversion is most likely done in a way that the reverse
2808 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002809 "utf-8" some non-ASCII characters may be lost! You can use
2810 the |++bad| argument to specify what is done with characters
2811 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812 For an empty file or a file with only ASCII characters most encodings
2813 will work and the first entry of 'fileencodings' will be used (except
2814 "ucs-bom", which requires the BOM to be present). If you prefer
2815 another encoding use an BufReadPost autocommand event to test if your
2816 preferred encoding is to be used. Example: >
2817 au BufReadPost * if search('\S', 'w') == 0 |
2818 \ set fenc=iso-2022-jp | endif
2819< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2820 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002821 When the |++enc| argument is used then the value of 'fileencodings' is
2822 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002823 Note that 'fileencodings' is not used for a new file, the global value
2824 of 'fileencoding' is used instead. You can set it with: >
2825 :setglobal fenc=iso-8859-2
2826< This means that a non-existing file may get a different encoding than
2827 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 The special value "ucs-bom" can be used to check for a Unicode BOM
2829 (Byte Order Mark) at the start of the file. It must not be preceded
2830 by "utf-8" or another Unicode encoding for this to work properly.
2831 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2832 because Vim cannot detect an error, thus the encoding is always
2833 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002834 The special value "default" can be used for the encoding from the
2835 environment. This is the default value for 'encoding'. It is useful
2836 when 'encoding' is set to "utf-8" and your environment uses a
2837 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002838 When 'encoding' is "utf-8" and a file contains an illegal byte
2839 sequence it won't be recognized as UTF-8. You can use the |8g8|
2840 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841 WRONG VALUES: WHAT'S WRONG:
2842 latin1,utf-8 "latin1" will always be used
2843 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2844 file
2845 cp1250,latin1 "cp1250" will always be used
2846 If 'fileencodings' is empty, 'fileencoding' is not modified.
2847 See 'fileencoding' for the possible values.
2848 Setting this option does not have an effect until the next time a file
2849 is read.
2850
2851 *'fileformat'* *'ff'*
2852'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2853 Unix default: "unix",
2854 Macintosh default: "mac")
2855 local to buffer
2856 {not in Vi}
2857 This gives the <EOL> of the current buffer, which is used for
2858 reading/writing the buffer from/to a file:
2859 dos <CR> <NL>
2860 unix <NL>
2861 mac <CR>
2862 When "dos" is used, CTRL-Z at the end of a file is ignored.
2863 See |file-formats| and |file-read|.
2864 For the character encoding of the file see 'fileencoding'.
2865 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2866 works like it was set to "unix'.
2867 This option is set automatically when starting to edit a file and
2868 'fileformats' is not empty and 'binary' is off.
2869 When this option is set, after starting to edit a file, the 'modified'
2870 option is set, because the file would be different when written.
2871 This option can not be changed when 'modifiable' is off.
2872 For backwards compatibility: When this option is set to "dos",
2873 'textmode' is set, otherwise 'textmode' is reset.
2874
2875 *'fileformats'* *'ffs'*
2876'fileformats' 'ffs' string (default:
2877 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2878 Vim Unix: "unix,dos",
2879 Vim Mac: "mac,unix,dos",
2880 Vi Cygwin: "unix,dos",
2881 Vi others: "")
2882 global
2883 {not in Vi}
2884 This gives the end-of-line (<EOL>) formats that will be tried when
2885 starting to edit a new buffer and when reading a file into an existing
2886 buffer:
2887 - When empty, the format defined with 'fileformat' will be used
2888 always. It is not set automatically.
2889 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 'fileformats' name will be used when a file is read into an existing
2892 buffer, no matter what 'fileformat' for that buffer is set to.
2893 - When more than one name is present, separated by commas, automatic
2894 <EOL> detection will be done when reading a file. When starting to
2895 edit a file, a check is done for the <EOL>:
2896 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2897 'fileformat' is set to "dos".
2898 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002899 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002901 3. If 'fileformat' has not yet been set, and if 'fileformats'
2902 includes "mac", 'fileformat' is set to "mac".
2903 This means that "mac" is only chosen when:
2904 "unix" is not present or no <NL> is found in the file, and
2905 "dos" is not present or no <CR><NL> is found in the file.
2906 Except: if "unix" was chosen, but there is a <CR> before
2907 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002908 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002909 4. If 'fileformat' is still not set, the first name from
2910 'fileformats' is used.
2911 When reading a file into an existing buffer, the same is done, but
2912 this happens like 'fileformat' has been set appropriately for that
2913 file only, the option is not changed.
2914 When 'binary' is set, the value of 'fileformats' is not used.
2915
Bram Moolenaar81af9252010-12-10 20:35:50 +01002916 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002917 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002918
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2920 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2921 done:
2922 - When 'fileformats' is empty, there is no automatic detection. Dos
2923 format will be used.
2924 - When 'fileformats' is set to one or more names, automatic detection
2925 is done. This is based on the first <NL> in the file: If there is a
2926 <CR> in front of it, Dos format is used, otherwise Unix format is
2927 used.
2928 Also see |file-formats|.
2929 For backwards compatibility: When this option is set to an empty
2930 string or one format (no comma is included), 'textauto' is reset,
2931 otherwise 'textauto' is set.
2932 NOTE: This option is set to the Vi default value when 'compatible' is
2933 set and to the Vim default value when 'compatible' is reset.
2934
2935 *'filetype'* *'ft'*
2936'filetype' 'ft' string (default: "")
2937 local to buffer
2938 {not in Vi}
2939 {not available when compiled without the |+autocmd|
2940 feature}
2941 When this option is set, the FileType autocommand event is triggered.
2942 All autocommands that match with the value of this option will be
2943 executed. Thus the value of 'filetype' is used in place of the file
2944 name.
2945 Otherwise this option does not always reflect the current file type.
2946 This option is normally set when the file type is detected. To enable
2947 this use the ":filetype on" command. |:filetype|
2948 Setting this option to a different value is most useful in a modeline,
2949 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002950 Example, for in an IDL file:
2951 /* vim: set filetype=idl : */ ~
2952 |FileType| |filetypes|
2953 When a dot appears in the value then this separates two filetype
2954 names. Example:
2955 /* vim: set filetype=c.doxygen : */ ~
2956 This will use the "c" filetype first, then the "doxygen" filetype.
2957 This works both for filetype plugins and for syntax files. More than
2958 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 This option is not copied to another buffer, independent of the 's' or
2960 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002961 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002962
2963 *'fillchars'* *'fcs'*
2964'fillchars' 'fcs' string (default "vert:|,fold:-")
2965 global
2966 {not in Vi}
2967 {not available when compiled without the |+windows|
2968 and |+folding| features}
2969 Characters to fill the statuslines and vertical separators.
2970 It is a comma separated list of items:
2971
2972 item default Used for ~
2973 stl:c ' ' or '^' statusline of the current window
2974 stlnc:c ' ' or '-' statusline of the non-current windows
2975 vert:c '|' vertical separators |:vsplit|
2976 fold:c '-' filling 'foldtext'
2977 diff:c '-' deleted lines of the 'diff' option
2978
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002979 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 "stlnc" the space will be used when there is highlighting, '^' or '-'
2981 otherwise.
2982
2983 Example: >
2984 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2985< This is similar to the default, except that these characters will also
2986 be used when there is highlighting.
2987
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002988 for "stl" and "stlnc" only single-byte values are supported.
2989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 The highlighting used for these items:
2991 item highlight group ~
2992 stl:c StatusLine |hl-StatusLine|
2993 stlnc:c StatusLineNC |hl-StatusLineNC|
2994 vert:c VertSplit |hl-VertSplit|
2995 fold:c Folded |hl-Folded|
2996 diff:c DiffDelete |hl-DiffDelete|
2997
2998 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2999'fkmap' 'fk' boolean (default off) *E198*
3000 global
3001 {not in Vi}
3002 {only available when compiled with the |+rightleft|
3003 feature}
3004 When on, the keyboard is mapped for the Farsi character set.
3005 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003006 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007
3008 *'foldclose'* *'fcl'*
3009'foldclose' 'fcl' string (default "")
3010 global
3011 {not in Vi}
3012 {not available when compiled without the |+folding|
3013 feature}
3014 When set to "all", a fold is closed when the cursor isn't in it and
3015 its level is higher than 'foldlevel'. Useful if you want folds to
3016 automatically close when moving out of them.
3017
3018 *'foldcolumn'* *'fdc'*
3019'foldcolumn' 'fdc' number (default 0)
3020 local to window
3021 {not in Vi}
3022 {not available when compiled without the |+folding|
3023 feature}
3024 When non-zero, a column with the specified width is shown at the side
3025 of the window which indicates open and closed folds. The maximum
3026 value is 12.
3027 See |folding|.
3028
3029 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3030'foldenable' 'fen' boolean (default on)
3031 local to window
3032 {not in Vi}
3033 {not available when compiled without the |+folding|
3034 feature}
3035 When off, all folds are open. This option can be used to quickly
3036 switch between showing all text unfolded and viewing the text with
3037 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003038 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 'foldenable' is off.
3040 This option is set by commands that create a new fold or close a fold.
3041 See |folding|.
3042
3043 *'foldexpr'* *'fde'*
3044'foldexpr' 'fde' string (default: "0")
3045 local to window
3046 {not in Vi}
3047 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003048 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003049 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003050 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003051
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003052 The expression may be evaluated in the |sandbox|, see
3053 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003054 This option can't be set from a |modeline| when the 'diff' option is
3055 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003056
3057 It is not allowed to change text or jump to another window while
3058 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
3060 *'foldignore'* *'fdi'*
3061'foldignore' 'fdi' string (default: "#")
3062 local to window
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
3065 feature}
3066 Used only when 'foldmethod' is "indent". Lines starting with
3067 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003068 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069 The default "#" works well for C programs. See |fold-indent|.
3070
3071 *'foldlevel'* *'fdl'*
3072'foldlevel' 'fdl' number (default: 0)
3073 local to window
3074 {not in Vi}
3075 {not available when compiled without the |+folding|
3076 feature}
3077 Sets the fold level: Folds with a higher level will be closed.
3078 Setting this option to zero will close all folds. Higher numbers will
3079 close fewer folds.
3080 This option is set by commands like |zm|, |zM| and |zR|.
3081 See |fold-foldlevel|.
3082
3083 *'foldlevelstart'* *'fdls'*
3084'foldlevelstart' 'fdls' number (default: -1)
3085 global
3086 {not in Vi}
3087 {not available when compiled without the |+folding|
3088 feature}
3089 Sets 'foldlevel' when starting to edit another buffer in a window.
3090 Useful to always start editing with all folds closed (value zero),
3091 some folds closed (one) or no folds closed (99).
3092 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003093 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 ignores this option and closes all folds.
3095 It is also done before BufReadPre autocommands, to allow an autocmd to
3096 overrule the 'foldlevel' value for specific files.
3097 When the value is negative, it is not used.
3098
3099 *'foldmarker'* *'fmr'* *E536*
3100'foldmarker' 'fmr' string (default: "{{{,}}}")
3101 local to window
3102 {not in Vi}
3103 {not available when compiled without the |+folding|
3104 feature}
3105 The start and end marker used when 'foldmethod' is "marker". There
3106 must be one comma, which separates the start and end marker. The
3107 marker is a literal string (a regular expression would be too slow).
3108 See |fold-marker|.
3109
3110 *'foldmethod'* *'fdm'*
3111'foldmethod' 'fdm' string (default: "manual")
3112 local to window
3113 {not in Vi}
3114 {not available when compiled without the |+folding|
3115 feature}
3116 The kind of folding used for the current window. Possible values:
3117 |fold-manual| manual Folds are created manually.
3118 |fold-indent| indent Lines with equal indent form a fold.
3119 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3120 |fold-marker| marker Markers are used to specify folds.
3121 |fold-syntax| syntax Syntax highlighting items specify folds.
3122 |fold-diff| diff Fold text that is not changed.
3123
3124 *'foldminlines'* *'fml'*
3125'foldminlines' 'fml' number (default: 1)
3126 local to window
3127 {not in Vi}
3128 {not available when compiled without the |+folding|
3129 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003130 Sets the number of screen lines above which a fold can be displayed
3131 closed. Also for manually closed folds. With the default value of
3132 one a fold can only be closed if it takes up two or more screen lines.
3133 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003134 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 "zc" to close a fold, which is displayed open because it's smaller
3136 than 'foldminlines', a following "zc" may close a containing fold.
3137
3138 *'foldnestmax'* *'fdn'*
3139'foldnestmax' 'fdn' number (default: 20)
3140 local to window
3141 {not in Vi}
3142 {not available when compiled without the |+folding|
3143 feature}
3144 Sets the maximum nesting of folds for the "indent" and "syntax"
3145 methods. This avoids that too many folds will be created. Using more
3146 than 20 doesn't work, because the internal limit is 20.
3147
3148 *'foldopen'* *'fdo'*
3149'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3150 search,tag,undo")
3151 global
3152 {not in Vi}
3153 {not available when compiled without the |+folding|
3154 feature}
3155 Specifies for which type of commands folds will be opened, if the
3156 command moves the cursor into a closed fold. It is a comma separated
3157 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003158 NOTE: When the command is part of a mapping this option is not used.
3159 Add the |zv| command to the mapping to get the same effect.
3160 (rationale: the mapping may want to control opening folds itself)
3161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 item commands ~
3163 all any
3164 block "(", "{", "[[", "[{", etc.
3165 hor horizontal movements: "l", "w", "fx", etc.
3166 insert any command in Insert mode
3167 jump far jumps: "G", "gg", etc.
3168 mark jumping to a mark: "'m", CTRL-O, etc.
3169 percent "%"
3170 quickfix ":cn", ":crew", ":make", etc.
3171 search search for a pattern: "/", "n", "*", "gd", etc.
3172 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003173 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 tag jumping to a tag: ":ta", CTRL-T, etc.
3175 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 When a movement command is used for an operator (e.g., "dl" or "y%")
3177 this option is not used. This means the operator will include the
3178 whole closed fold.
3179 Note that vertical movements are not here, because it would make it
3180 very difficult to move onto a closed fold.
3181 In insert mode the folds containing the cursor will always be open
3182 when text is inserted.
3183 To close folds you can re-apply 'foldlevel' with the |zx| command or
3184 set the 'foldclose' option to "all".
3185
3186 *'foldtext'* *'fdt'*
3187'foldtext' 'fdt' string (default: "foldtext()")
3188 local to window
3189 {not in Vi}
3190 {not available when compiled without the |+folding|
3191 feature}
3192 An expression which is used to specify the text displayed for a closed
3193 fold. See |fold-foldtext|.
3194
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003195 The expression may be evaluated in the |sandbox|, see
3196 |sandbox-option|.
3197
3198 It is not allowed to change text or jump to another window while
3199 evaluating 'foldtext' |textlock|.
3200
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 *'formatoptions'* *'fo'*
3202'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3203 local to buffer
3204 {not in Vi}
3205 This is a sequence of letters which describes how automatic
3206 formatting is to be done. See |fo-table|. When the 'paste' option is
3207 on, no formatting is done (like 'formatoptions' is empty). Commas can
3208 be inserted for readability.
3209 To avoid problems with flags that are added in the future, use the
3210 "+=" and "-=" feature of ":set" |add-option-flags|.
3211 NOTE: This option is set to the Vi default value when 'compatible' is
3212 set and to the Vim default value when 'compatible' is reset.
3213
Bram Moolenaar86b68352004-12-27 21:59:20 +00003214 *'formatlistpat'* *'flp'*
3215'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3216 local to buffer
3217 {not in Vi}
3218 A pattern that is used to recognize a list header. This is used for
3219 the "n" flag in 'formatoptions'.
3220 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003221 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003222 while still checking more characters. There must be a character
3223 following the pattern, when it matches the whole line it is handled
3224 like there is no match.
3225 The default recognizes a number, followed by an optional punctuation
3226 character and white space.
3227
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 *'formatprg'* *'fp'*
3229'formatprg' 'fp' string (default "")
3230 global
3231 {not in Vi}
3232 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003233 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003235 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003236 If the 'formatexpr' option is not empty it will be used instead.
3237 Otherwise, if 'formatprg' option is an empty string, the internal
3238 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003239 Environment variables are expanded |:set_env|. See |option-backslash|
3240 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003241 The expression may be evaluated in the |sandbox|, see
3242 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003244 *'formatexpr'* *'fex'*
3245'formatexpr' 'fex' string (default "")
3246 local to buffer
3247 {not in Vi}
3248 {not available when compiled without the |+eval|
3249 feature}
3250 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003251 operator or automatic formatting (see 'formatoptions'). When this
3252 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003253
3254 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003255 The |v:count| variable holds the number of lines to be formatted.
3256 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003257 inserted if the expression is being evaluated due to
3258 automatic formatting. This can be empty. Don't insert
3259 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003260
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003261 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003262 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003263< This will invoke the mylang#Format() function in the
3264 autoload/mylang.vim file in 'runtimepath'. |autoload|
3265
3266 The expression is also evaluated when 'textwidth' is set and adding
3267 text beyond that limit. This happens under the same conditions as
3268 when internal formatting is used. Make sure the cursor is kept in the
3269 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003270 return "i" or "R" in this situation.
3271
3272 When the expression evaluates to non-zero Vim will fall back to using
3273 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003274
3275 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003276 |sandbox-option|. That stops the option from working, since changing
3277 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003278
3279 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003280'fsync' 'fs' boolean (default on)
3281 global
3282 {not in Vi}
3283 When on, the library function fsync() will be called after writing a
3284 file. This will flush a file to disk, ensuring that it is safely
3285 written even on filesystems which do metadata-only journaling. This
3286 will force the harddrive to spin up on Linux systems running in laptop
3287 mode, so it may be undesirable in some situations. Be warned that
3288 turning this off increases the chances of data loss after a crash. On
3289 systems without an fsync() implementation, this variable is always
3290 off.
3291 Also see 'swapsync' for controlling fsync() on swap files.
3292
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3294'gdefault' 'gd' boolean (default off)
3295 global
3296 {not in Vi}
3297 When on, the ":substitute" flag 'g' is default on. This means that
3298 all matches in a line are substituted instead of one. When a 'g' flag
3299 is given to a ":substitute" command, this will toggle the substitution
3300 of all or one match. See |complex-change|.
3301
3302 command 'gdefault' on 'gdefault' off ~
3303 :s/// subst. all subst. one
3304 :s///g subst. one subst. all
3305 :s///gg subst. all subst. one
3306
3307 NOTE: This option is reset when 'compatible' is set.
3308
3309 *'grepformat'* *'gfm'*
3310'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3311 global
3312 {not in Vi}
3313 Format to recognize for the ":grep" command output.
3314 This is a scanf-like string that uses the same format as the
3315 'errorformat' option: see |errorformat|.
3316
3317 *'grepprg'* *'gp'*
3318'grepprg' 'gp' string (default "grep -n ",
3319 Unix: "grep -n $* /dev/null",
3320 Win32: "findstr /n" or "grep -n",
3321 VMS: "SEARCH/NUMBERS ")
3322 global or local to buffer |global-local|
3323 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003324 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003325 and '#' characters, which are expanded like when used in a command-
3326 line. The placeholder "$*" is allowed to specify where the arguments
3327 will be included. Environment variables are expanded |:set_env|. See
3328 |option-backslash| about including spaces and backslashes.
3329 When your "grep" accepts the "-H" argument, use this to make ":grep"
3330 also work well with a single file: >
3331 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003332< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003333 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3334 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003335 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 apply equally to 'grepprg'.
3337 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3338 otherwise it's "grep -n".
3339 This option cannot be set from a |modeline| or in the |sandbox|, for
3340 security reasons.
3341
3342 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3343'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3344 ve:ver35-Cursor,
3345 o:hor50-Cursor,
3346 i-ci:ver25-Cursor/lCursor,
3347 r-cr:hor20-Cursor/lCursor,
3348 sm:block-Cursor
3349 -blinkwait175-blinkoff150-blinkon175",
3350 for MS-DOS and Win32 console:
3351 "n-v-c:block,o:hor50,i-ci:hor15,
3352 r-cr:hor30,sm:block")
3353 global
3354 {not in Vi}
3355 {only available when compiled with GUI enabled, and
3356 for MS-DOS and Win32 console}
3357 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003358 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 the height of the cursor can be changed. This can be done by
3360 specifying a block cursor, or a percentage for a vertical or
3361 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003362 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003364 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 mode-list and an argument-list:
3366 mode-list:argument-list,mode-list:argument-list,..
3367 The mode-list is a dash separated list of these modes:
3368 n Normal mode
3369 v Visual mode
3370 ve Visual mode with 'selection' "exclusive" (same as 'v',
3371 if not specified)
3372 o Operator-pending mode
3373 i Insert mode
3374 r Replace mode
3375 c Command-line Normal (append) mode
3376 ci Command-line Insert mode
3377 cr Command-line Replace mode
3378 sm showmatch in Insert mode
3379 a all modes
3380 The argument-list is a dash separated list of these arguments:
3381 hor{N} horizontal bar, {N} percent of the character height
3382 ver{N} vertical bar, {N} percent of the character width
3383 block block cursor, fills the whole character
3384 [only one of the above three should be present]
3385 blinkwait{N} *cursor-blinking*
3386 blinkon{N}
3387 blinkoff{N}
3388 blink times for cursor: blinkwait is the delay before
3389 the cursor starts blinking, blinkon is the time that
3390 the cursor is shown and blinkoff is the time that the
3391 cursor is not shown. The times are in msec. When one
3392 of the numbers is zero, there is no blinking. The
3393 default is: "blinkwait700-blinkon400-blinkoff250".
3394 These numbers are used for a missing entry. This
3395 means that blinking is enabled by default. To switch
3396 blinking off you can use "blinkon0". The cursor only
3397 blinks when Vim is waiting for input, not while
3398 executing a command.
3399 To make the cursor blink in an xterm, see
3400 |xterm-blink|.
3401 {group-name}
3402 a highlight group name, that sets the color and font
3403 for the cursor
3404 {group-name}/{group-name}
3405 Two highlight group names, the first is used when
3406 no language mappings are used, the other when they
3407 are. |language-mapping|
3408
3409 Examples of parts:
3410 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3411 block cursor with colors from the "nCursor"
3412 highlight group
3413 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3414 In Insert and Command-line Insert mode, use a
3415 30% vertical bar cursor with colors from the
3416 "iCursor" highlight group. Blink a bit
3417 faster.
3418
3419 The 'a' mode is different. It will set the given argument-list for
3420 all modes. It does not reset anything to defaults. This can be used
3421 to do a common setting for all modes. For example, to switch off
3422 blinking: "a:blinkon0"
3423
3424 Examples of cursor highlighting: >
3425 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3426 :highlight Cursor gui=NONE guifg=bg guibg=fg
3427<
3428 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003429 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430'guifont' 'gfn' string (default "")
3431 global
3432 {not in Vi}
3433 {only available when compiled with GUI enabled}
3434 This is a list of fonts which will be used for the GUI version of Vim.
3435 In its simplest form the value is just one font name. When
3436 the font cannot be found you will get an error message. To try other
3437 font names a list can be specified, font names separated with commas.
3438 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003439
Bram Moolenaar05159a02005-02-26 23:04:13 +00003440 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3441 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003442
Bram Moolenaar071d4272004-06-13 20:20:40 +00003443 Spaces after a comma are ignored. To include a comma in a font name
3444 precede it with a backslash. Setting an option requires an extra
3445 backslash before a space and a backslash. See also
3446 |option-backslash|. For example: >
3447 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003448< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003450
3451 If none of the fonts can be loaded, Vim will keep the current setting.
3452 If an empty font list is given, Vim will try using other resource
3453 settings (for X, it will use the Vim.font resource), and finally it
3454 will try some builtin default which should always be there ("7x13" in
3455 the case of X). The font names given should be "normal" fonts. Vim
3456 will try to find the related bold and italic fonts.
3457
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003458 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003459 :set guifont=*
3460< will bring up a font requester, where you can pick the font you want.
3461
3462 The font name depends on the GUI used. See |setting-guifont| for a
3463 way to set 'guifont' for various systems.
3464
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 For the GTK+ 2 GUI the font name looks like this: >
3466 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003467< That's all. XLFDs are not used. For Chinese this is reported to work
3468 well: >
3469 if has("gui_gtk2")
3470 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3471 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3472 endif
3473<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003474 For Mac OSX you can use something like this: >
3475 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003476< Also see 'macatsui', it can help fix display problems.
3477 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003479 width). An exception is GTK 2: all fonts are accepted, but
3480 mono-spaced fonts look best.
3481
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 To preview a font on X11, you might be able to use the "xfontsel"
3483 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003484
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 For the Win32 GUI *E244* *E245*
3486 - takes these options in the font name:
3487 hXX - height is XX (points, can be floating-point)
3488 wXX - width is XX (points, can be floating-point)
3489 b - bold
3490 i - italic
3491 u - underline
3492 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003493 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3495 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3496 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003497 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498
3499 Use a ':' to separate the options.
3500 - A '_' can be used in the place of a space, so you don't need to use
3501 backslashes to escape the spaces.
3502 - Examples: >
3503 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3504 :set guifont=Andale_Mono:h7.5:w4.5
3505< See also |font-sizes|.
3506
3507 *'guifontset'* *'gfs'*
3508 *E250* *E252* *E234* *E597* *E598*
3509'guifontset' 'gfs' string (default "")
3510 global
3511 {not in Vi}
3512 {only available when compiled with GUI enabled and
3513 with the |+xfontset| feature}
3514 {not available in the GTK+ 2 GUI}
3515 When not empty, specifies two (or more) fonts to be used. The first
3516 one for normal English, the second one for your special language. See
3517 |xfontset|.
3518 Setting this option also means that all font names will be handled as
3519 a fontset name. Also the ones used for the "font" argument of the
3520 |:highlight| command.
3521 The fonts must match with the current locale. If fonts for the
3522 character sets that the current locale uses are not included, setting
3523 'guifontset' will fail.
3524 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3525 the comma-separated names are alternative names, one of which will be
3526 used. In 'guifontset' the whole string is one fontset name,
3527 including the commas. It is not possible to specify alternative
3528 fontset names.
3529 This example works on many X11 systems: >
3530 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3531<
3532 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3533'guifontwide' 'gfw' string (default "")
3534 global
3535 {not in Vi}
3536 {only available when compiled with GUI enabled}
3537 When not empty, specifies a comma-separated list of fonts to be used
3538 for double-width characters. The first font that can be loaded is
3539 used.
3540 Note: The size of these fonts must be exactly twice as wide as the one
3541 specified with 'guifont' and the same height.
3542
3543 All GUI versions but GTK+ 2:
3544
3545 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3546 'guifontset' is empty or invalid.
3547 When 'guifont' is set and a valid font is found in it and
3548 'guifontwide' is empty Vim will attempt to find a matching
3549 double-width font and set 'guifontwide' to it.
3550
3551 GTK+ 2 GUI only: *guifontwide_gtk2*
3552
3553 If set and valid, 'guifontwide' is always used for double width
3554 characters, even if 'encoding' is not set to "utf-8".
3555 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003556 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557 font for characters not available in 'guifont'. Thus you do not need
3558 to set 'guifontwide' at all unless you want to override the choice
3559 made by Pango/Xft.
3560
3561 *'guiheadroom'* *'ghr'*
3562'guiheadroom' 'ghr' number (default 50)
3563 global
3564 {not in Vi} {only for GTK and X11 GUI}
3565 The number of pixels subtracted from the screen height when fitting
3566 the GUI window on the screen. Set this before the GUI is started,
3567 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003568 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 lines will be left for window decorations and other items on the
3570 screen. Set it to a negative value to allow windows taller than the
3571 screen.
3572
3573 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003574'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3575 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 global
3577 {not in Vi}
3578 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003579 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 sequence of letters which describes what components and options of the
3581 GUI should be used.
3582 To avoid problems with flags that are added in the future, use the
3583 "+=" and "-=" feature of ":set" |add-option-flags|.
3584
3585 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003586 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 'a' Autoselect: If present, then whenever VISUAL mode is started,
3588 or the Visual area extended, Vim tries to become the owner of
3589 the windowing system's global selection. This means that the
3590 Visually highlighted text is available for pasting into other
3591 applications as well as into Vim itself. When the Visual mode
3592 ends, possibly due to an operation on the text, or when an
3593 application wants to paste the selection, the highlighted text
3594 is automatically yanked into the "* selection register.
3595 Thus the selection is still available for pasting into other
3596 applications after the VISUAL mode has ended.
3597 If not present, then Vim won't become the owner of the
3598 windowing system's global selection unless explicitly told to
3599 by a yank or delete operation for the "* register.
3600 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003601 *'go-P'*
3602 'P' Like autoselect but using the "+ register instead of the "*
3603 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003604 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003605 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 applies to the modeless selection.
3607
3608 'guioptions' autoselect Visual autoselect modeless ~
3609 "" - -
3610 "a" yes yes
3611 "A" - yes
3612 "aA" yes yes
3613
Bram Moolenaar02467872007-05-06 13:22:01 +00003614 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 'c' Use console dialogs instead of popup dialogs for simple
3616 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003617 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003618 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003619 'guitablabel' can be used to change the text in the labels.
3620 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003621 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003622 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003623 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'f' Foreground: Don't use fork() to detach the GUI from the shell
3625 where it was started. Use this for programs that wait for the
3626 editor to finish (e.g., an e-mail program). Alternatively you
3627 can use "gvim -f" or ":gui -f" to start the GUI in the
3628 foreground. |gui-fork|
3629 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003630 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003631 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3633 corner of the window. It's black&white on non-GTK, because of
3634 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003635 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003637 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003638 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003639 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003640 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003641 file is sourced the system menu has already been loaded; the
3642 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003643 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 'g' Grey menu items: Make menu items that are not active grey. If
3645 'g' is not included inactive menu items are not shown at all.
3646 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003647 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 't' Include tearoff menu items. Currently only works for Win32,
3649 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003650 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003651 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003652 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003653 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003654 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003655 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 'R' Right-hand scrollbar is present when there is a vertically
3657 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003658 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003660 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 'L' Left-hand scrollbar is present when there is a vertically
3662 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003663 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3665 the longest visible line, or on the cursor line if the 'h'
3666 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003667 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668 'h' Limit horizontal scrollbar size to the length of the cursor
3669 line. Reduces computations. |gui-horiz-scroll|
3670
3671 And yes, you may even have scrollbars on the left AND the right if
3672 you really want to :-). See |gui-scrollbars| for more information.
3673
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003674 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675 'v' Use a vertical button layout for dialogs. When not included,
3676 a horizontal layout is preferred, but when it doesn't fit a
3677 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003678 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 'p' Use Pointer callbacks for X11 GUI. This is required for some
3680 window managers. If the cursor is not blinking or hollow at
3681 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003682 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003684 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003685 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686
Bram Moolenaar02467872007-05-06 13:22:01 +00003687
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 *'guipty'* *'noguipty'*
3689'guipty' boolean (default on)
3690 global
3691 {not in Vi}
3692 {only available when compiled with GUI enabled}
3693 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3694 I/O to/from shell commands. See |gui-pty|.
3695
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003696 *'guitablabel'* *'gtl'*
3697'guitablabel' 'gtl' string (default empty)
3698 global
3699 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003700 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003701 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003702 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003703 pages line. When empty and when the result is empty Vim will use a
3704 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003705
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003706 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003707 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003708
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003709 Only used when the GUI tab pages line is displayed. 'e' must be
3710 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3711 used.
3712
Bram Moolenaar57657d82006-04-21 22:12:41 +00003713 *'guitabtooltip'* *'gtt'*
3714'guitabtooltip' 'gtt' string (default empty)
3715 global
3716 {not in Vi}
3717 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003718 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003719 When nonempty describes the text to use in a tooltip for the GUI tab
3720 pages line. When empty Vim will use a default tooltip.
3721 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003722 You can include a line break. Simplest method is to use |:let|: >
3723 :let &guitabtooltip = "line one\nline two"
3724<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003725
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 *'helpfile'* *'hf'*
3727'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3728 (others) "$VIMRUNTIME/doc/help.txt")
3729 global
3730 {not in Vi}
3731 Name of the main help file. All distributed help files should be
3732 placed together in one directory. Additionally, all "doc" directories
3733 in 'runtimepath' will be used.
3734 Environment variables are expanded |:set_env|. For example:
3735 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003736 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 spaces and backslashes.
3738 This option cannot be set from a |modeline| or in the |sandbox|, for
3739 security reasons.
3740
3741 *'helpheight'* *'hh'*
3742'helpheight' 'hh' number (default 20)
3743 global
3744 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003745 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 feature}
3747 Minimal initial height of the help window when it is opened with the
3748 ":help" command. The initial height of the help window is half of the
3749 current window, or (when the 'ea' option is on) the same as other
3750 windows. When the height is less than 'helpheight', the height is
3751 set to 'helpheight'. Set to zero to disable.
3752
3753 *'helplang'* *'hlg'*
3754'helplang' 'hlg' string (default: messages language or empty)
3755 global
3756 {only available when compiled with the |+multi_lang|
3757 feature}
3758 {not in Vi}
3759 Comma separated list of languages. Vim will use the first language
3760 for which the desired help can be found. The English help will always
3761 be used as a last resort. You can add "en" to prefer English over
3762 another language, but that will only find tags that exist in that
3763 language and not in the English help.
3764 Example: >
3765 :set helplang=de,it
3766< This will first search German, then Italian and finally English help
3767 files.
3768 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3769 try to find the tag in the current language before using this option.
3770 See |help-translated|.
3771
3772 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3773'hidden' 'hid' boolean (default off)
3774 global
3775 {not in Vi}
3776 When off a buffer is unloaded when it is |abandon|ed. When on a
3777 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3778 displayed in another window, it does not become hidden, of course.
3779 The commands that move through the buffer list sometimes make a buffer
3780 hidden although the 'hidden' option is off: When the buffer is
3781 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003782 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003783 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 This option is set for one command with ":hide {command}" |:hide|.
3785 WARNING: It's easy to forget that you have changes in hidden buffers.
3786 Think twice when using ":q!" or ":qa!".
3787
3788 *'highlight'* *'hl'*
3789'highlight' 'hl' string (default (as a single string):
3790 "8:SpecialKey,@:NonText,d:Directory,
3791 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003792 M:ModeMsg,n:LineNr,N:CursorLineNr,
3793 r:Question,s:StatusLine,S:StatusLineNC,
3794 c:VertSplit, t:Title,v:Visual,
3795 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 f:Folded,F:FoldColumn,A:DiffAdd,
3797 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003798 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003799 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003800 +:Pmenu,=:PmenuSel,
3801 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 global
3803 {not in Vi}
3804 This option can be used to set highlighting mode for various
3805 occasions. It is a comma separated list of character pairs. The
3806 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003807 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3809 |hl-NonText| @ '~' and '@' at the end of the window and
3810 characters from 'showbreak'
3811 |hl-Directory| d directories in CTRL-D listing and other special
3812 things in listings
3813 |hl-ErrorMsg| e error messages
3814 h (obsolete, ignored)
3815 |hl-IncSearch| i 'incsearch' highlighting
3816 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3817 |hl-MoreMsg| m |more-prompt|
3818 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003819 |hl-LineNr| n line number for ":number" and ":#" commands, and
3820 when 'number' or 'relativenumber' option is set.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003821 |hl-CursorLineNr| N like n for when 'cursorline' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003822 |hl-Question| r |hit-enter| prompt and yes/no questions
3823 |hl-StatusLine| s status line of current window |status-line|
3824 |hl-StatusLineNC| S status lines of not-current windows
3825 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3826 |hl-VertSplit| c column used to separate vertically split windows
3827 |hl-Visual| v Visual mode
3828 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3829 Selection" Only X11 Gui's |gui-x11| and
3830 |xterm-clipboard|.
3831 |hl-WarningMsg| w warning messages
3832 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3833 |hl-Folded| f line used for closed folds
3834 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003835 |hl-DiffAdd| A added line in diff mode
3836 |hl-DiffChange| C changed line in diff mode
3837 |hl-DiffDelete| D deleted line in diff mode
3838 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003840 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003841 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003842 |hl-SpellRare| R rare word |spell|
3843 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003844 |hl-Conceal| - the placeholders used for concealed characters
3845 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003846 |hl-Pmenu| + popup menu normal line
3847 |hl-PmenuSel| = popup menu normal line
3848 |hl-PmenuSbar| x popup menu scrollbar
3849 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850
3851 The display modes are:
3852 r reverse (termcap entry "mr" and "me")
3853 i italic (termcap entry "ZH" and "ZR")
3854 b bold (termcap entry "md" and "me")
3855 s standout (termcap entry "so" and "se")
3856 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003857 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858 n no highlighting
3859 - no highlighting
3860 : use a highlight group
3861 The default is used for occasions that are not included.
3862 If you want to change what the display modes do, see |dos-colors|
3863 for an example.
3864 When using the ':' display mode, this must be followed by the name of
3865 a highlight group. A highlight group can be used to define any type
3866 of highlighting, including using color. See |:highlight| on how to
3867 define one. The default uses a different group for each occasion.
3868 See |highlight-default| for the default highlight groups.
3869
3870 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3871'hlsearch' 'hls' boolean (default off)
3872 global
3873 {not in Vi}
3874 {not available when compiled without the
3875 |+extra_search| feature}
3876 When there is a previous search pattern, highlight all its matches.
3877 The type of highlighting used can be set with the 'l' occasion in the
3878 'highlight' option. This uses the "Search" highlight group by
3879 default. Note that only the matching text is highlighted, any offsets
3880 are not applied.
3881 See also: 'incsearch' and |:match|.
3882 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003883 off with |:nohlsearch|. This does not change the option value, as
3884 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003885 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 When the search pattern can match an end-of-line, Vim will try to
3887 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003888 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003890 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003891 You can specify whether the highlight status is restored on startup
3892 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 NOTE: This option is reset when 'compatible' is set.
3894
3895 *'history'* *'hi'*
3896'history' 'hi' number (Vim default: 20, Vi default: 0)
3897 global
3898 {not in Vi}
3899 A history of ":" commands, and a history of previous search patterns
3900 are remembered. This option decides how many entries may be stored in
3901 each of these histories (see |cmdline-editing|).
3902 NOTE: This option is set to the Vi default value when 'compatible' is
3903 set and to the Vim default value when 'compatible' is reset.
3904
3905 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3906'hkmap' 'hk' boolean (default off)
3907 global
3908 {not in Vi}
3909 {only available when compiled with the |+rightleft|
3910 feature}
3911 When on, the keyboard is mapped for the Hebrew character set.
3912 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3913 toggle this option. See |rileft.txt|.
3914 NOTE: This option is reset when 'compatible' is set.
3915
3916 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3917'hkmapp' 'hkp' boolean (default off)
3918 global
3919 {not in Vi}
3920 {only available when compiled with the |+rightleft|
3921 feature}
3922 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3923 This is useful if you have a non-Hebrew keyboard.
3924 See |rileft.txt|.
3925 NOTE: This option is reset when 'compatible' is set.
3926
3927 *'icon'* *'noicon'*
3928'icon' boolean (default off, on when title can be restored)
3929 global
3930 {not in Vi}
3931 {not available when compiled without the |+title|
3932 feature}
3933 When on, the icon text of the window will be set to the value of
3934 'iconstring' (if it is not empty), or to the name of the file
3935 currently being edited. Only the last part of the name is used.
3936 Overridden by the 'iconstring' option.
3937 Only works if the terminal supports setting window icons (currently
3938 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3939 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3940 builtin termcap).
3941 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003942 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 X11.
3944
3945 *'iconstring'*
3946'iconstring' string (default "")
3947 global
3948 {not in Vi}
3949 {not available when compiled without the |+title|
3950 feature}
3951 When this option is not empty, it will be used for the icon text of
3952 the window. This happens only when the 'icon' option is on.
3953 Only works if the terminal supports setting window icon text
3954 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3955 Does not work for MS Windows.
3956 When Vim was compiled with HAVE_X11 defined, the original icon will be
3957 restored if possible |X11|.
3958 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003959 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 'titlestring' for example settings.
3961 {not available when compiled without the |+statusline| feature}
3962
3963 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3964'ignorecase' 'ic' boolean (default off)
3965 global
3966 Ignore case in search patterns. Also used when searching in the tags
3967 file.
3968 Also see 'smartcase'.
3969 Can be overruled by using "\c" or "\C" in the pattern, see
3970 |/ignorecase|.
3971
3972 *'imactivatekey'* *'imak'*
3973'imactivatekey' 'imak' string (default "")
3974 global
3975 {not in Vi}
3976 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003977 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 Specifies the key that your Input Method in X-Windows uses for
3979 activation. When this is specified correctly, vim can fully control
3980 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3981 You can't use this option to change the activation key, the option
3982 tells Vim what the key is.
3983 Format:
3984 [MODIFIER_FLAG-]KEY_STRING
3985
3986 These characters can be used for MODIFIER_FLAG (case is ignored):
3987 S Shift key
3988 L Lock key
3989 C Control key
3990 1 Mod1 key
3991 2 Mod2 key
3992 3 Mod3 key
3993 4 Mod4 key
3994 5 Mod5 key
3995 Combinations are allowed, for example "S-C-space" or "SC-space" are
3996 both shift+ctrl+space.
3997 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3998
3999 Example: >
4000 :set imactivatekey=S-space
4001< "S-space" means shift+space. This is the activation key for kinput2 +
4002 canna (Japanese), and ami (Korean).
4003
4004 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4005'imcmdline' 'imc' boolean (default off)
4006 global
4007 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004008 {only available when compiled with the |+xim|,
4009 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 When set the Input Method is always on when starting to edit a command
4011 line, unless entering a search pattern (see 'imsearch' for that).
4012 Setting this option is useful when your input method allows entering
4013 English characters directly, e.g., when it's used to type accented
4014 characters with dead keys.
4015
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004016 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004017'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4018 global
4019 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004020 {only available when compiled with the |+xim|,
4021 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 When set the Input Method is never used. This is useful to disable
4023 the IM when it doesn't work properly.
4024 Currently this option is on by default for SGI/IRIX machines. This
4025 may change in later releases.
4026
4027 *'iminsert'* *'imi'*
4028'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4029 local to buffer
4030 {not in Vi}
4031 Specifies whether :lmap or an Input Method (IM) is to be used in
4032 Insert mode. Valid values:
4033 0 :lmap is off and IM is off
4034 1 :lmap is ON and IM is off
4035 2 :lmap is off and IM is ON
4036 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4037 or |global-ime|.
4038 To always reset the option to zero when leaving Insert mode with <Esc>
4039 this can be used: >
4040 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4041< This makes :lmap and IM turn off automatically when leaving Insert
4042 mode.
4043 Note that this option changes when using CTRL-^ in Insert mode
4044 |i_CTRL-^|.
4045 The value is set to 1 when setting 'keymap' to a valid keymap name.
4046 It is also used for the argument of commands like "r" and "f".
4047 The value 0 may not work correctly with Athena and Motif with some XIM
4048 methods. Use 'imdisable' to disable XIM then.
4049
4050 *'imsearch'* *'ims'*
4051'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4052 local to buffer
4053 {not in Vi}
4054 Specifies whether :lmap or an Input Method (IM) is to be used when
4055 entering a search pattern. Valid values:
4056 -1 the value of 'iminsert' is used, makes it look like
4057 'iminsert' is also used when typing a search pattern
4058 0 :lmap is off and IM is off
4059 1 :lmap is ON and IM is off
4060 2 :lmap is off and IM is ON
4061 Note that this option changes when using CTRL-^ in Command-line mode
4062 |c_CTRL-^|.
4063 The value is set to 1 when it is not -1 and setting the 'keymap'
4064 option to a valid keymap name.
4065 The value 0 may not work correctly with Athena and Motif with some XIM
4066 methods. Use 'imdisable' to disable XIM then.
4067
4068 *'include'* *'inc'*
4069'include' 'inc' string (default "^\s*#\s*include")
4070 global or local to buffer |global-local|
4071 {not in Vi}
4072 {not available when compiled without the
4073 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004074 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 pattern, just like for the "/" command (See |pattern|). The default
4076 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004077 "]I", "[d", etc.
4078 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004079 comes after the matched pattern. But if "\zs" appears in the pattern
4080 then the text matched from "\zs" to the end, or until "\ze" if it
4081 appears, is used as the file name. Use this to include characters
4082 that are not in 'isfname', such as a space. You can then use
4083 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004084 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085
4086 *'includeexpr'* *'inex'*
4087'includeexpr' 'inex' string (default "")
4088 local to buffer
4089 {not in Vi}
4090 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004091 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004093 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094 :set includeexpr=substitute(v:fname,'\\.','/','g')
4095< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004096
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004098 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 Also used for |<cfile>|.
4100
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004101 The expression may be evaluated in the |sandbox|, see
4102 |sandbox-option|.
4103
4104 It is not allowed to change text or jump to another window while
4105 evaluating 'includeexpr' |textlock|.
4106
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4108'incsearch' 'is' boolean (default off)
4109 global
4110 {not in Vi}
4111 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004112 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004113 While typing a search command, show where the pattern, as it was typed
4114 so far, matches. The matched string is highlighted. If the pattern
4115 is invalid or not found, nothing is shown. The screen will be updated
4116 often, this is only useful on fast terminals.
4117 Note that the match will be shown, but the cursor will return to its
4118 original position when no match is found and when pressing <Esc>. You
4119 still need to finish the search command with <Enter> to move the
4120 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004121 When compiled with the |+reltime| feature Vim only searches for about
4122 half a second. With a complicated pattern and/or a lot of text the
4123 match may not be found. This is to avoid that Vim hangs while you
4124 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004125 The highlighting can be set with the 'i' flag in 'highlight'.
4126 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004127 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004128 to the command line. If 'ignorecase' and 'smartcase' are set and the
4129 command line has no uppercase characters, the added character is
4130 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004131 CTRL-R CTRL-W can be used to add the word at the end of the current
4132 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 NOTE: This option is reset when 'compatible' is set.
4134
4135 *'indentexpr'* *'inde'*
4136'indentexpr' 'inde' string (default "")
4137 local to buffer
4138 {not in Vi}
4139 {not available when compiled without the |+cindent|
4140 or |+eval| features}
4141 Expression which is evaluated to obtain the proper indent for a line.
4142 It is used when a new line is created, for the |=| operator and
4143 in Insert mode as specified with the 'indentkeys' option.
4144 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004145 'smartindent' indenting. When 'lisp' is set, this option is
4146 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 When 'paste' is set this option is not used for indenting.
4148 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004149 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 when the expression is evaluated (but it may be moved around).
4151 The expression must return the number of spaces worth of indent. It
4152 can return "-1" to keep the current indent (this means 'autoindent' is
4153 used for the indent).
4154 Functions useful for computing the indent are |indent()|, |cindent()|
4155 and |lispindent()|.
4156 The evaluation of the expression must not have side effects! It must
4157 not change the text, jump to another window, etc. Afterwards the
4158 cursor position is always restored, thus the cursor may be moved.
4159 Normally this option would be set to call a function: >
4160 :set indentexpr=GetMyIndent()
4161< Error messages will be suppressed, unless the 'debug' option contains
4162 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004163 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 NOTE: This option is made empty when 'compatible' is set.
4165
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004166 The expression may be evaluated in the |sandbox|, see
4167 |sandbox-option|.
4168
4169 It is not allowed to change text or jump to another window while
4170 evaluating 'indentexpr' |textlock|.
4171
4172
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 *'indentkeys'* *'indk'*
4174'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4175 local to buffer
4176 {not in Vi}
4177 {not available when compiled without the |+cindent|
4178 feature}
4179 A list of keys that, when typed in Insert mode, cause reindenting of
4180 the current line. Only happens if 'indentexpr' isn't empty.
4181 The format is identical to 'cinkeys', see |indentkeys-format|.
4182 See |C-indenting| and |indent-expression|.
4183
4184 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4185'infercase' 'inf' boolean (default off)
4186 local to buffer
4187 {not in Vi}
4188 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004189 'ignorecase' is also on, the case of the match is adjusted depending
4190 on the typed text. If the typed text contains a lowercase letter
4191 where the match has an upper case letter, the completed part is made
4192 lowercase. If the typed text has no lowercase letters and the match
4193 has a lowercase letter where the typed text has an uppercase letter,
4194 and there is a letter before it, the completed part is made uppercase.
4195 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196
4197 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4198'insertmode' 'im' boolean (default off)
4199 global
4200 {not in Vi}
4201 Makes Vim work in a way that Insert mode is the default mode. Useful
4202 if you want to use Vim as a modeless editor. Used for |evim|.
4203 These Insert mode commands will be useful:
4204 - Use the cursor keys to move around.
4205 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4206 this is a mapping, it is executed as if 'insertmode' was off.
4207 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004209 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4210 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211
4212 These items change when 'insertmode' is set:
4213 - when starting to edit of a file, Vim goes to Insert mode.
4214 - <Esc> in Insert mode is a no-op and beeps.
4215 - <Esc> in Normal mode makes Vim go to Insert mode.
4216 - CTRL-L in Insert mode is a command, it is not inserted.
4217 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4218 However, when <Esc> is used inside a mapping, it behaves like
4219 'insertmode' was not set. This was done to be able to use the same
4220 mappings with 'insertmode' set or not set.
4221 When executing commands with |:normal| 'insertmode' is not used.
4222
4223 NOTE: This option is reset when 'compatible' is set.
4224
4225 *'isfname'* *'isf'*
4226'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4227 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4228 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4229 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4230 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4231 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4232 global
4233 {not in Vi}
4234 The characters specified by this option are included in file names and
4235 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004236 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 Multi-byte characters 256 and above are always included, only the
4238 characters up to 255 are specified with this option.
4239 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004240 Think twice before adding white space to this option. Although a
4241 space may appear inside a file name, the effect will be that Vim
4242 doesn't know where a file name starts or ends when doing completion.
4243 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244
4245 Note that on systems using a backslash as path separator, Vim tries to
4246 do its best to make it work as you would expect. That is a bit
4247 tricky, since Vi originally used the backslash to escape special
4248 characters. Vim will not remove a backslash in front of a normal file
4249 name character on these systems, but it will on Unix and alikes. The
4250 '&' and '^' are not included by default, because these are special for
4251 cmd.exe.
4252
4253 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004254 Each part can be a single character number or a range. A range is two
4255 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 decimal number between 0 and 255 or the ASCII character itself (does
4257 not work for digits). Example:
4258 "_,-,128-140,#-43" (include '_' and '-' and the range
4259 128 to 140 and '#' to 43)
4260 If a part starts with '^', the following character number or range
4261 will be excluded from the option. The option is interpreted from left
4262 to right. Put the excluded character after the range where it is
4263 included. To include '^' itself use it as the last character of the
4264 option or the end of a range. Example:
4265 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4266 If the character is '@', all characters where isalpha() returns TRUE
4267 are included. Normally these are the characters a to z and A to Z,
4268 plus accented characters. To include '@' itself use "@-@". Examples:
4269 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004270 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 "a-z,A-Z,@-@" All letters plus the '@' character.
4272 A comma can be included by using it where a character number is
4273 expected. Example:
4274 "48-57,,,_" Digits, comma and underscore.
4275 A comma can be excluded by prepending a '^'. Example:
4276 " -~,^,,9" All characters from space to '~', excluding
4277 comma, plus <Tab>.
4278 See |option-backslash| about including spaces and backslashes.
4279
4280 *'isident'* *'isi'*
4281'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4282 "@,48-57,_,128-167,224-235"
4283 otherwise: "@,48-57,_,192-255")
4284 global
4285 {not in Vi}
4286 The characters given by this option are included in identifiers.
4287 Identifiers are used in recognizing environment variables and after a
4288 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004289 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 option.
4291 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004292 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4294
4295 *'iskeyword'* *'isk'*
4296'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4297 "@,48-57,_,128-167,224-235"
4298 otherwise: "@,48-57,_,192-255"
4299 Vi default: "@,48-57,_")
4300 local to buffer
4301 {not in Vi}
4302 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004303 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 'isfname' for a description of the format of this option. For C
4305 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4306 For a help file it is set to all non-blank printable characters except
4307 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4308 command).
4309 When the 'lisp' option is on the '-' character is always included.
4310 NOTE: This option is set to the Vi default value when 'compatible' is
4311 set and to the Vim default value when 'compatible' is reset.
4312
4313 *'isprint'* *'isp'*
4314'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4315 "@,~-255"; otherwise: "@,161-255")
4316 global
4317 {not in Vi}
4318 The characters given by this option are displayed directly on the
4319 screen. It is also used for "\p" in a |pattern|. The characters from
4320 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4321 even when they are not included in 'isprint' or excluded. See
4322 'isfname' for a description of the format of this option.
4323
4324 Non-printable characters are displayed with two characters:
4325 0 - 31 "^@" - "^_"
4326 32 - 126 always single characters
4327 127 "^?"
4328 128 - 159 "~@" - "~_"
4329 160 - 254 "| " - "|~"
4330 255 "~?"
4331 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4332 displayed as <xx>, with the hexadecimal value of the byte.
4333 When 'display' contains "uhex" all unprintable characters are
4334 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004335 The SpecialKey highlighting will be used for unprintable characters.
4336 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337
4338 Multi-byte characters 256 and above are always included, only the
4339 characters up to 255 are specified with this option. When a character
4340 is printable but it is not available in the current font, a
4341 replacement character will be shown.
4342 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4343 There is no option to specify these characters.
4344
4345 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4346'joinspaces' 'js' boolean (default on)
4347 global
4348 {not in Vi}
4349 Insert two spaces after a '.', '?' and '!' with a join command.
4350 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4351 Otherwise only one space is inserted.
4352 NOTE: This option is set when 'compatible' is set.
4353
4354 *'key'*
4355'key' string (default "")
4356 local to buffer
4357 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004358 {only available when compiled with the |+cryptv|
4359 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004361 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 Careful: Do not set the key value by hand, someone might see the typed
4363 key. Use the |:X| command. But you can make 'key' empty: >
4364 :set key=
4365< It is not possible to get the value of this option with ":set key" or
4366 "echo &key". This is to avoid showing it to someone who shouldn't
4367 know. It also means you cannot see it yourself once you have set it,
4368 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004369 You can use "&key" in an expression to detect whether encryption is
4370 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371
4372 *'keymap'* *'kmp'* *E544*
4373'keymap' 'kmp' string (default "")
4374 local to buffer
4375 {not in Vi}
4376 {only available when compiled with the |+keymap|
4377 feature}
4378 Name of a keyboard mapping. See |mbyte-keymap|.
4379 Setting this option to a valid keymap name has the side effect of
4380 setting 'iminsert' to one, so that the keymap becomes effective.
4381 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004382 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383
4384 *'keymodel'* *'km'*
4385'keymodel' 'km' string (default "")
4386 global
4387 {not in Vi}
4388 List of comma separated words, which enable special things that keys
4389 can do. These values can be used:
4390 startsel Using a shifted special key starts selection (either
4391 Select mode or Visual mode, depending on "key" being
4392 present in 'selectmode').
4393 stopsel Using a not-shifted special key stops selection.
4394 Special keys in this context are the cursor keys, <End>, <Home>,
4395 <PageUp> and <PageDown>.
4396 The 'keymodel' option is set by the |:behave| command.
4397
4398 *'keywordprg'* *'kp'*
4399'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4400 OS/2: "view /", VMS: "help")
4401 global or local to buffer |global-local|
4402 {not in Vi}
4403 Program to use for the |K| command. Environment variables are
4404 expanded |:set_env|. ":help" may be used to access the Vim internal
4405 help. (Note that previously setting the global option to the empty
4406 value did this, which is now deprecated.)
4407 When "man" is used, Vim will automatically translate a count for the
4408 "K" command to a section number. Also for "man -s", in which case the
4409 "-s" is removed when there is no count.
4410 See |option-backslash| about including spaces and backslashes.
4411 Example: >
4412 :set keywordprg=man\ -s
4413< This option cannot be set from a |modeline| or in the |sandbox|, for
4414 security reasons.
4415
4416 *'langmap'* *'lmap'* *E357* *E358*
4417'langmap' 'lmap' string (default "")
4418 global
4419 {not in Vi}
4420 {only available when compiled with the |+langmap|
4421 feature}
4422 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004423 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 inserted directly. When in command mode the 'langmap' option takes
4425 care of translating these special characters to the original meaning
4426 of the key. This means you don't have to change the keyboard mode to
4427 be able to execute Normal mode commands.
4428 This is the opposite of the 'keymap' option, where characters are
4429 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004431 Example (for Greek, in UTF-8): *greek* >
4432 :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 +00004433< Example (exchanges meaning of z and y for commands): >
4434 :set langmap=zy,yz,ZY,YZ
4435<
4436 The 'langmap' option is a list of parts, separated with commas. Each
4437 part can be in one of two forms:
4438 1. A list of pairs. Each pair is a "from" character immediately
4439 followed by the "to" character. Examples: "aA", "aAbBcC".
4440 2. A list of "from" characters, a semi-colon and a list of "to"
4441 characters. Example: "abc;ABC"
4442 Example: "aA,fgh;FGH,cCdDeE"
4443 Special characters need to be preceded with a backslash. These are
4444 ";", ',' and backslash itself.
4445
4446 This will allow you to activate vim actions without having to switch
4447 back and forth between the languages. Your language characters will
4448 be understood as normal vim English characters (according to the
4449 langmap mappings) in the following cases:
4450 o Normal/Visual mode (commands, buffer/register names, user mappings)
4451 o Insert/Replace Mode: Register names after CTRL-R
4452 o Insert/Replace Mode: Mappings
4453 Characters entered in Command-line mode will NOT be affected by
4454 this option. Note that this option can be changed at any time
4455 allowing to switch between mappings for different languages/encodings.
4456 Use a mapping to avoid having to type it each time!
4457
4458 *'langmenu'* *'lm'*
4459'langmenu' 'lm' string (default "")
4460 global
4461 {not in Vi}
4462 {only available when compiled with the |+menu| and
4463 |+multi_lang| features}
4464 Language to use for menu translation. Tells which file is loaded
4465 from the "lang" directory in 'runtimepath': >
4466 "lang/menu_" . &langmenu . ".vim"
4467< (without the spaces). For example, to always use the Dutch menus, no
4468 matter what $LANG is set to: >
4469 :set langmenu=nl_NL.ISO_8859-1
4470< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004471 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 If your $LANG is set to a non-English language but you do want to use
4473 the English menus: >
4474 :set langmenu=none
4475< This option must be set before loading menus, switching on filetype
4476 detection or syntax highlighting. Once the menus are defined setting
4477 this option has no effect. But you could do this: >
4478 :source $VIMRUNTIME/delmenu.vim
4479 :set langmenu=de_DE.ISO_8859-1
4480 :source $VIMRUNTIME/menu.vim
4481< Warning: This deletes all menus that you defined yourself!
4482
4483 *'laststatus'* *'ls'*
4484'laststatus' 'ls' number (default 1)
4485 global
4486 {not in Vi}
4487 The value of this option influences when the last window will have a
4488 status line:
4489 0: never
4490 1: only if there are at least two windows
4491 2: always
4492 The screen looks nicer with a status line if you have several
4493 windows, but it takes another screen line. |status-line|
4494
4495 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4496'lazyredraw' 'lz' boolean (default off)
4497 global
4498 {not in Vi}
4499 When this option is set, the screen will not be redrawn while
4500 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004501 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 update use |:redraw|.
4503
4504 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4505'linebreak' 'lbr' boolean (default off)
4506 local to window
4507 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004508 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 feature}
4510 If on Vim will wrap long lines at a character in 'breakat' rather
4511 than at the last character that fits on the screen. Unlike
4512 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4513 it only affects the way the file is displayed, not its contents. The
4514 value of 'showbreak' is used to put in front of wrapped lines.
4515 This option is not used when the 'wrap' option is off or 'list' is on.
4516 Note that <Tab> characters after an <EOL> are mostly not displayed
4517 with the right amount of white space.
4518
4519 *'lines'* *E593*
4520'lines' number (default 24 or terminal height)
4521 global
4522 Number of lines of the Vim window.
4523 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004524 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 When Vim is running in the GUI or in a resizable window, setting this
4526 option will cause the window size to be changed. When you only want
4527 to use the size for the GUI, put the command in your |gvimrc| file.
4528 Vim limits the number of lines to what fits on the screen. You can
4529 use this command to get the tallest window possible: >
4530 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004531< Minimum value is 2, maximum value is 1000.
4532 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004533 When you set this option and Vim is unable to change the physical
4534 number of lines of the display, the display may be messed up.
4535
4536 *'linespace'* *'lsp'*
4537'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4538 global
4539 {not in Vi}
4540 {only in the GUI}
4541 Number of pixel lines inserted between characters. Useful if the font
4542 uses the full character cell height, making lines touch each other.
4543 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004544 With some fonts there can be too much room between lines (to have
4545 space for ascents and descents). Then it makes sense to set
4546 'linespace' to a negative value. This may cause display problems
4547 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
4549 *'lisp'* *'nolisp'*
4550'lisp' boolean (default off)
4551 local to buffer
4552 {not available when compiled without the |+lispindent|
4553 feature}
4554 Lisp mode: When <Enter> is typed in insert mode set the indent for
4555 the next line to Lisp standards (well, sort of). Also happens with
4556 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4557 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4558 better. Also see 'lispwords'.
4559 The '-' character is included in keyword characters. Redefines the
4560 "=" operator to use this same indentation algorithm rather than
4561 calling an external program if 'equalprg' is empty.
4562 This option is not used when 'paste' is set.
4563 {Vi: Does it a little bit differently}
4564
4565 *'lispwords'* *'lw'*
4566'lispwords' 'lw' string (default is very long)
4567 global
4568 {not in Vi}
4569 {not available when compiled without the |+lispindent|
4570 feature}
4571 Comma separated list of words that influence the Lisp indenting.
4572 |'lisp'|
4573
4574 *'list'* *'nolist'*
4575'list' boolean (default off)
4576 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004577 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4578 line. Useful to see the difference between tabs and spaces and for
4579 trailing blanks. Further changed by the 'listchars' option.
4580
4581 The cursor is displayed at the start of the space a Tab character
4582 occupies, not at the end as usual in Normal mode. To get this cursor
4583 position while displaying Tabs with spaces, use: >
4584 :set list lcs=tab\ \
4585<
4586 Note that list mode will also affect formatting (set with 'textwidth'
4587 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 changing the way tabs are displayed.
4589
4590 *'listchars'* *'lcs'*
4591'listchars' 'lcs' string (default "eol:$")
4592 global
4593 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004594 Strings to use in 'list' mode and for the |:list| command. It is a
4595 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 eol:c Character to show at the end of each line. When
4597 omitted, there is no extra character at the end of the
4598 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004599 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004601 fill the space that the tab normally occupies.
4602 "tab:>-" will show a tab that takes four spaces as
4603 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004604 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004605 trailing spaces are blank.
4606 extends:c Character to show in the last column, when 'wrap' is
4607 off and the line continues beyond the right of the
4608 screen.
4609 precedes:c Character to show in the first column, when 'wrap'
4610 is off and there is text preceding the character
4611 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004612 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004613 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004614 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004615 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004617 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004619 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620
4621 Examples: >
4622 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004623 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 :set lcs=extends:>,precedes:<
4625< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004626 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004627 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628
4629 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4630'loadplugins' 'lpl' boolean (default on)
4631 global
4632 {not in Vi}
4633 When on the plugin scripts are loaded when starting up |load-plugins|.
4634 This option can be reset in your |vimrc| file to disable the loading
4635 of plugins.
4636 Note that using the "-u NONE" and "--noplugin" command line arguments
4637 reset this option. |-u| |--noplugin|
4638
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004639 *'macatsui'* *'nomacatsui'*
4640'macatsui' boolean (default on)
4641 global
4642 {only available in Mac GUI version}
4643 This is a workaround for when drawing doesn't work properly. When set
4644 and compiled with multi-byte support ATSUI text drawing is used. When
4645 not set ATSUI text drawing is not used. Switch this option off when
4646 you experience drawing problems. In a future version the problems may
4647 be solved and this option becomes obsolete. Therefore use this method
4648 to unset it: >
4649 if exists('&macatsui')
4650 set nomacatsui
4651 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004652< Another option to check if you have drawing problems is
4653 'termencoding'.
4654
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655 *'magic'* *'nomagic'*
4656'magic' boolean (default on)
4657 global
4658 Changes the special characters that can be used in search patterns.
4659 See |pattern|.
4660 NOTE: To avoid portability problems with using patterns, always keep
4661 this option at the default "on". Only switch it off when working with
4662 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004663 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664
4665 *'makeef'* *'mef'*
4666'makeef' 'mef' string (default: "")
4667 global
4668 {not in Vi}
4669 {not available when compiled without the |+quickfix|
4670 feature}
4671 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4672 and the |:grep| command.
4673 When it is empty, an internally generated temp file will be used.
4674 When "##" is included, it is replaced by a number to make the name
4675 unique. This makes sure that the ":make" command doesn't overwrite an
4676 existing file.
4677 NOT used for the ":cf" command. See 'errorfile' for that.
4678 Environment variables are expanded |:set_env|.
4679 See |option-backslash| about including spaces and backslashes.
4680 This option cannot be set from a |modeline| or in the |sandbox|, for
4681 security reasons.
4682
4683 *'makeprg'* *'mp'*
4684'makeprg' 'mp' string (default "make", VMS: "MMS")
4685 global or local to buffer |global-local|
4686 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004687 Program to use for the ":make" command. See |:make_makeprg|.
4688 This option may contain '%' and '#' characters, which are expanded to
4689 the current and alternate file name. |:_%| |:_#|
4690 Environment variables are expanded |:set_env|. See |option-backslash|
4691 about including spaces and backslashes.
4692 Note that a '|' must be escaped twice: once for ":set" and once for
4693 the interpretation of a command. When you use a filter called
4694 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 :set makeprg=gmake\ \\\|\ myfilter
4696< The placeholder "$*" can be given (even multiple times) to specify
4697 where the arguments will be included, for example: >
4698 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4699< This option cannot be set from a |modeline| or in the |sandbox|, for
4700 security reasons.
4701
4702 *'matchpairs'* *'mps'*
4703'matchpairs' 'mps' string (default "(:),{:},[:]")
4704 local to buffer
4705 {not in Vi}
4706 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004707 other. Currently only single byte character pairs are allowed, and
4708 they must be different. The characters must be separated by a colon.
4709 The pairs must be separated by a comma. Example for including '<' and
4710 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711 :set mps+=<:>
4712
4713< A more exotic example, to jump between the '=' and ';' in an
4714 assignment, useful for languages like C and Java: >
4715 :au FileType c,cpp,java set mps+==:;
4716
4717< For a more advanced way of using "%", see the matchit.vim plugin in
4718 the $VIMRUNTIME/macros directory. |add-local-help|
4719
4720 *'matchtime'* *'mat'*
4721'matchtime' 'mat' number (default 5)
4722 global
4723 {not in Vi}{in Nvi}
4724 Tenths of a second to show the matching paren, when 'showmatch' is
4725 set. Note that this is not in milliseconds, like other options that
4726 set a time. This is to be compatible with Nvi.
4727
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004728 *'maxcombine'* *'mco'*
4729'maxcombine' 'mco' number (default 2)
4730 global
4731 {not in Vi}
4732 {only available when compiled with the |+multi_byte|
4733 feature}
4734 The maximum number of combining characters supported for displaying.
4735 Only used when 'encoding' is "utf-8".
4736 The default is OK for most languages. Hebrew may require 4.
4737 Maximum value is 6.
4738 Even when this option is set to 2 you can still edit text with more
4739 combining characters, you just can't see them. Use |g8| or |ga|.
4740 See |mbyte-combining|.
4741
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 *'maxfuncdepth'* *'mfd'*
4743'maxfuncdepth' 'mfd' number (default 100)
4744 global
4745 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004746 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004747 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 Maximum depth of function calls for user functions. This normally
4749 catches endless recursion. When using a recursive function with
4750 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4751 more memory, there is the danger of failing when memory is exhausted.
4752 See also |:function|.
4753
4754 *'maxmapdepth'* *'mmd'* *E223*
4755'maxmapdepth' 'mmd' number (default 1000)
4756 global
4757 {not in Vi}
4758 Maximum number of times a mapping is done without resulting in a
4759 character to be used. This normally catches endless mappings, like
4760 ":map x y" with ":map y x". It still does not catch ":map g wg",
4761 because the 'w' is used before the next mapping is done. See also
4762 |key-mapping|.
4763
4764 *'maxmem'* *'mm'*
4765'maxmem' 'mm' number (default between 256 to 5120 (system
4766 dependent) or half the amount of memory
4767 available)
4768 global
4769 {not in Vi}
4770 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4771 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004772 other memory to be freed. The maximum usable value is about 2000000.
4773 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004775 *'maxmempattern'* *'mmp'*
4776'maxmempattern' 'mmp' number (default 1000)
4777 global
4778 {not in Vi}
4779 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004780 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004781 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004782 When Vim runs into the limit it gives an error message and mostly
4783 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004784 Running into the limit often means that the pattern is very
4785 inefficient or too complex. This may already happen with the pattern
4786 "\(.\)*" on a very long line. ".*" works much better.
4787 Vim may run out of memory before hitting the 'maxmempattern' limit.
4788
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 *'maxmemtot'* *'mmt'*
4790'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4791 dependent) or half the amount of memory
4792 available)
4793 global
4794 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004795 Maximum amount of memory in Kbyte to use for all buffers together.
4796 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4797 without a limit. On 64 bit machines higher values might work. But
4798 hey, do you really need more than 2 Gbyte for text editing?
4799 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800
4801 *'menuitems'* *'mis'*
4802'menuitems' 'mis' number (default 25)
4803 global
4804 {not in Vi}
4805 {not available when compiled without the |+menu|
4806 feature}
4807 Maximum number of items to use in a menu. Used for menus that are
4808 generated from a list of items, e.g., the Buffers menu. Changing this
4809 option has no direct effect, the menu must be refreshed first.
4810
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004811 *'mkspellmem'* *'msm'*
4812'mkspellmem' 'msm' string (default "460000,2000,500")
4813 global
4814 {not in Vi}
4815 {not available when compiled without the |+syntax|
4816 feature}
4817 Parameters for |:mkspell|. This tunes when to start compressing the
4818 word tree. Compression can be slow when there are many words, but
4819 it's needed to avoid running out of memory. The amount of memory used
4820 per word depends very much on how similar the words are, that's why
4821 this tuning is complicated.
4822
4823 There are three numbers, separated by commas:
4824 {start},{inc},{added}
4825
4826 For most languages the uncompressed word tree fits in memory. {start}
4827 gives the amount of memory in Kbyte that can be used before any
4828 compression is done. It should be a bit smaller than the amount of
4829 memory that is available to Vim.
4830
4831 When going over the {start} limit the {inc} number specifies the
4832 amount of memory in Kbyte that can be allocated before another
4833 compression is done. A low number means compression is done after
4834 less words are added, which is slow. A high number means more memory
4835 will be allocated.
4836
4837 After doing compression, {added} times 1024 words can be added before
4838 the {inc} limit is ignored and compression is done when any extra
4839 amount of memory is needed. A low number means there is a smaller
4840 chance of hitting the {inc} limit, less memory is used but it's
4841 slower.
4842
4843 The languages for which these numbers are important are Italian and
4844 Hungarian. The default works for when you have about 512 Mbyte. If
4845 you have 1 Gbyte you could use: >
4846 :set mkspellmem=900000,3000,800
4847< If you have less than 512 Mbyte |:mkspell| may fail for some
4848 languages, no matter what you set 'mkspellmem' to.
4849
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004851'modeline' 'ml' boolean (Vim default: on (off for root),
4852 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004853 local to buffer
4854 *'modelines'* *'mls'*
4855'modelines' 'mls' number (default 5)
4856 global
4857 {not in Vi}
4858 If 'modeline' is on 'modelines' gives the number of lines that is
4859 checked for set commands. If 'modeline' is off or 'modelines' is zero
4860 no lines are checked. See |modeline|.
4861 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4862 set and to the Vim default value when 'compatible' is reset.
4863
4864 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4865'modifiable' 'ma' boolean (default on)
4866 local to buffer
4867 {not in Vi} *E21*
4868 When off the buffer contents cannot be changed. The 'fileformat' and
4869 'fileencoding' options also can't be changed.
4870 Can be reset with the |-M| command line argument.
4871
4872 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4873'modified' 'mod' boolean (default off)
4874 local to buffer
4875 {not in Vi}
4876 When on, the buffer is considered to be modified. This option is set
4877 when:
4878 1. A change was made to the text since it was last written. Using the
4879 |undo| command to go back to the original text will reset the
4880 option. But undoing changes that were made before writing the
4881 buffer will set the option again, since the text is different from
4882 when it was written.
4883 2. 'fileformat' or 'fileencoding' is different from its original
4884 value. The original value is set when the buffer is read or
4885 written. A ":set nomodified" command also resets the original
4886 values to the current values and the 'modified' option will be
4887 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004888 This option is not set when a change is made to the buffer as the
4889 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4890 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4891 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4893 will be ignored.
4894
4895 *'more'* *'nomore'*
4896'more' boolean (Vim default: on, Vi default: off)
4897 global
4898 {not in Vi}
4899 When on, listings pause when the whole screen is filled. You will get
4900 the |more-prompt|. When this option is off there are no pauses, the
4901 listing continues until finished.
4902 NOTE: This option is set to the Vi default value when 'compatible' is
4903 set and to the Vim default value when 'compatible' is reset.
4904
4905 *'mouse'* *E538*
4906'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4907 global
4908 {not in Vi}
4909 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004910 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4911 sysmouse and Linux console with gpm). For using the mouse in the
4912 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004913 The mouse can be enabled for different modes:
4914 n Normal mode
4915 v Visual mode
4916 i Insert mode
4917 c Command-line mode
4918 h all previous modes when editing a help file
4919 a all previous modes
4920 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921 Normally you would enable the mouse in all four modes with: >
4922 :set mouse=a
4923< When the mouse is not enabled, the GUI will still use the mouse for
4924 modeless selection. This doesn't move the text cursor.
4925
4926 See |mouse-using|. Also see |'clipboard'|.
4927
4928 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004929 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004930 the mouse buttons can still be used by keeping the shift key pressed.
4931 Also see the 'clipboard' option.
4932
4933 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4934'mousefocus' 'mousef' boolean (default off)
4935 global
4936 {not in Vi}
4937 {only works in the GUI}
4938 The window that the mouse pointer is on is automatically activated.
4939 When changing the window layout or window focus in another way, the
4940 mouse pointer is moved to the window with keyboard focus. Off is the
4941 default because it makes using the pull down menus a little goofy, as
4942 a pointer transit may activate a window unintentionally.
4943
4944 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4945'mousehide' 'mh' boolean (default on)
4946 global
4947 {not in Vi}
4948 {only works in the GUI}
4949 When on, the mouse pointer is hidden when characters are typed.
4950 The mouse pointer is restored when the mouse is moved.
4951
4952 *'mousemodel'* *'mousem'*
4953'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4954 global
4955 {not in Vi}
4956 Sets the model to use for the mouse. The name mostly specifies what
4957 the right mouse button is used for:
4958 extend Right mouse button extends a selection. This works
4959 like in an xterm.
4960 popup Right mouse button pops up a menu. The shifted left
4961 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004962 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 popup_setpos Like "popup", but the cursor will be moved to the
4964 position where the mouse was clicked, and thus the
4965 selected operation will act upon the clicked object.
4966 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004967 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 course, that right clicking outside a selection will
4969 end Visual mode.
4970 Overview of what button does what for each model:
4971 mouse extend popup(_setpos) ~
4972 left click place cursor place cursor
4973 left drag start selection start selection
4974 shift-left search word extend selection
4975 right click extend selection popup menu (place cursor)
4976 right drag extend selection -
4977 middle click paste paste
4978
4979 In the "popup" model the right mouse button produces a pop-up menu.
4980 You need to define this first, see |popup-menu|.
4981
4982 Note that you can further refine the meaning of buttons with mappings.
4983 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4984 selection (because that's handled in the GUI code directly).
4985
4986 The 'mousemodel' option is set by the |:behave| command.
4987
4988 *'mouseshape'* *'mouses'* *E547*
4989'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004990 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 global
4992 {not in Vi}
4993 {only available when compiled with the |+mouseshape|
4994 feature}
4995 This option tells Vim what the mouse pointer should look like in
4996 different modes. The option is a comma separated list of parts, much
4997 like used for 'guicursor'. Each part consist of a mode/location-list
4998 and an argument-list:
4999 mode-list:shape,mode-list:shape,..
5000 The mode-list is a dash separated list of these modes/locations:
5001 In a normal window: ~
5002 n Normal mode
5003 v Visual mode
5004 ve Visual mode with 'selection' "exclusive" (same as 'v',
5005 if not specified)
5006 o Operator-pending mode
5007 i Insert mode
5008 r Replace mode
5009
5010 Others: ~
5011 c appending to the command-line
5012 ci inserting in the command-line
5013 cr replacing in the command-line
5014 m at the 'Hit ENTER' or 'More' prompts
5015 ml idem, but cursor in the last line
5016 e any mode, pointer below last window
5017 s any mode, pointer on a status line
5018 sd any mode, while dragging a status line
5019 vs any mode, pointer on a vertical separator line
5020 vd any mode, while dragging a vertical separator line
5021 a everywhere
5022
5023 The shape is one of the following:
5024 avail name looks like ~
5025 w x arrow Normal mouse pointer
5026 w x blank no pointer at all (use with care!)
5027 w x beam I-beam
5028 w x updown up-down sizing arrows
5029 w x leftright left-right sizing arrows
5030 w x busy The system's usual busy pointer
5031 w x no The system's usual 'no input' pointer
5032 x udsizing indicates up-down resizing
5033 x lrsizing indicates left-right resizing
5034 x crosshair like a big thin +
5035 x hand1 black hand
5036 x hand2 white hand
5037 x pencil what you write with
5038 x question big ?
5039 x rightup-arrow arrow pointing right-up
5040 w x up-arrow arrow pointing up
5041 x <number> any X11 pointer number (see X11/cursorfont.h)
5042
5043 The "avail" column contains a 'w' if the shape is available for Win32,
5044 x for X11.
5045 Any modes not specified or shapes not available use the normal mouse
5046 pointer.
5047
5048 Example: >
5049 :set mouseshape=s:udsizing,m:no
5050< will make the mouse turn to a sizing arrow over the status lines and
5051 indicate no input when the hit-enter prompt is displayed (since
5052 clicking the mouse has no effect in this state.)
5053
5054 *'mousetime'* *'mouset'*
5055'mousetime' 'mouset' number (default 500)
5056 global
5057 {not in Vi}
5058 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5059 time in msec between two mouse clicks for the second click to be
5060 recognized as a multi click.
5061
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005062 *'mzquantum'* *'mzq'*
5063'mzquantum' 'mzq' number (default 100)
5064 global
5065 {not in Vi}
5066 {not available when compiled without the |+mzscheme|
5067 feature}
5068 The number of milliseconds between polls for MzScheme threads.
5069 Negative or zero value means no thread scheduling.
5070
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 *'nrformats'* *'nf'*
5072'nrformats' 'nf' string (default "octal,hex")
5073 local to buffer
5074 {not in Vi}
5075 This defines what bases Vim will consider for numbers when using the
5076 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5077 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005078 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005080 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005081 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005083 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 considered to be hexadecimal. Example: Using CTRL-X on
5085 "0x100" results in "0x0ff".
5086 Numbers which simply begin with a digit in the range 1-9 are always
5087 considered decimal. This also happens for numbers that are not
5088 recognized as octal or hex.
5089
5090 *'number'* *'nu'* *'nonumber'* *'nonu'*
5091'number' 'nu' boolean (default off)
5092 local to window
5093 Print the line number in front of each line. When the 'n' option is
5094 excluded from 'cpoptions' a wrapped line will not use the column of
5095 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005096 The 'numberwidth' option can be used to set the room used for the line
5097 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098 When a long, wrapped line doesn't start with the first character, '-'
5099 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005100 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5101 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005102 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005103
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005104 *'numberwidth'* *'nuw'*
5105'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5106 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005107 {not in Vi}
5108 {only available when compiled with the |+linebreak|
5109 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005110 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005111 when the 'number' or 'relativenumber' option is set or printing lines
5112 with a line number. Since one space is always between the number and
5113 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005114 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005115 fit the highest line number in the buffer respectively the number of
5116 rows in the window, depending on whether 'number' or 'relativenumber'
5117 is set. Thus with the Vim default of 4 there is room for a line number
5118 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005119 The minimum value is 1, the maximum value is 10.
5120 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5121
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005122 *'omnifunc'* *'ofu'*
5123'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005124 local to buffer
5125 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005126 {not available when compiled without the |+eval|
5127 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005128 This option specifies a function to be used for Insert mode omni
5129 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005130 See |complete-functions| for an explanation of how the function is
5131 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005132 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005133 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005134
5135
Bram Moolenaar02467872007-05-06 13:22:01 +00005136 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005137'opendevice' 'odev' boolean (default off)
5138 global
5139 {not in Vi}
5140 {only for MS-DOS, MS-Windows and OS/2}
5141 Enable reading and writing from devices. This may get Vim stuck on a
5142 device that can be opened but doesn't actually do the I/O. Therefore
5143 it is off by default.
5144 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5145 result in editing a device.
5146
5147
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005148 *'operatorfunc'* *'opfunc'*
5149'operatorfunc' 'opfunc' string (default: empty)
5150 global
5151 {not in Vi}
5152 This option specifies a function to be called by the |g@| operator.
5153 See |:map-operator| for more info and an example.
5154
5155 This option cannot be set from a |modeline| or in the |sandbox|, for
5156 security reasons.
5157
5158
Bram Moolenaar251e1912011-06-19 05:09:16 +02005159 *'osfiletype'* *'oft'*
5160'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 local to buffer
5162 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005163 This option was supported on RISC OS, which has been removed.
5164
Bram Moolenaar071d4272004-06-13 20:20:40 +00005165
5166 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005167'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 global
5169 Specifies the nroff macros that separate paragraphs. These are pairs
5170 of two letters (see |object-motions|).
5171
5172 *'paste'* *'nopaste'*
5173'paste' boolean (default off)
5174 global
5175 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005176 Put Vim in Paste mode. This is useful if you want to cut or copy
5177 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 unexpected effects.
5179 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005180 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181 knows about pasting and will mostly do the right thing without 'paste'
5182 being set. The same is true for a terminal where Vim handles the
5183 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005184 This option is reset when starting the GUI. Thus if you set it in
5185 your .vimrc it will work in a terminal, but not in the GUI. Setting
5186 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5187 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188 When the 'paste' option is switched on (also when it was already on):
5189 - mapping in Insert mode and Command-line mode is disabled
5190 - abbreviations are disabled
5191 - 'textwidth' is set to 0
5192 - 'wrapmargin' is set to 0
5193 - 'autoindent' is reset
5194 - 'smartindent' is reset
5195 - 'softtabstop' is set to 0
5196 - 'revins' is reset
5197 - 'ruler' is reset
5198 - 'showmatch' is reset
5199 - 'formatoptions' is used like it is empty
5200 These options keep their value, but their effect is disabled:
5201 - 'lisp'
5202 - 'indentexpr'
5203 - 'cindent'
5204 NOTE: When you start editing another file while the 'paste' option is
5205 on, settings from the modelines or autocommands may change the
5206 settings again, causing trouble when pasting text. You might want to
5207 set the 'paste' option again.
5208 When the 'paste' option is reset the mentioned options are restored to
5209 the value before the moment 'paste' was switched from off to on.
5210 Resetting 'paste' before ever setting it does not have any effect.
5211 Since mapping doesn't work while 'paste' is active, you need to use
5212 the 'pastetoggle' option to toggle the 'paste' option with some key.
5213
5214 *'pastetoggle'* *'pt'*
5215'pastetoggle' 'pt' string (default "")
5216 global
5217 {not in Vi}
5218 When non-empty, specifies the key sequence that toggles the 'paste'
5219 option. This is like specifying a mapping: >
5220 :map {keys} :set invpaste<CR>
5221< Where {keys} is the value of 'pastetoggle'.
5222 The difference is that it will work even when 'paste' is set.
5223 'pastetoggle' works in Insert mode and Normal mode, but not in
5224 Command-line mode.
5225 Mappings are checked first, thus overrule 'pastetoggle'. However,
5226 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5227 this: >
5228 :map <F10> :set paste<CR>
5229 :map <F11> :set nopaste<CR>
5230 :imap <F10> <C-O>:set paste<CR>
5231 :imap <F11> <nop>
5232 :set pastetoggle=<F11>
5233< This will make <F10> start paste mode and <F11> stop paste mode.
5234 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5235 mode everything is inserted literally, except the 'pastetoggle' key
5236 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005237 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238
5239 *'pex'* *'patchexpr'*
5240'patchexpr' 'pex' string (default "")
5241 global
5242 {not in Vi}
5243 {not available when compiled without the |+diff|
5244 feature}
5245 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005246 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247
5248 *'patchmode'* *'pm'* *E206*
5249'patchmode' 'pm' string (default "")
5250 global
5251 {not in Vi}
5252 When non-empty the oldest version of a file is kept. This can be used
5253 to keep the original version of a file if you are changing files in a
5254 source distribution. Only the first time that a file is written a
5255 copy of the original file will be kept. The name of the copy is the
5256 name of the original file with the string in the 'patchmode' option
5257 appended. This option should start with a dot. Use a string like
5258 ".org". 'backupdir' must not be empty for this to work (Detail: The
5259 backup file is renamed to the patchmode file after the new file has
5260 been successfully written, that's why it must be possible to write a
5261 backup file). If there was no file to be backed up, an empty file is
5262 created.
5263 When the 'backupskip' pattern matches, a patchmode file is not made.
5264 Using 'patchmode' for compressed files appends the extension at the
5265 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5266 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005267 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005269 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005270'path' 'pa' string (default on Unix: ".,/usr/include,,"
5271 on OS/2: ".,/emx/include,,"
5272 other systems: ".,,")
5273 global or local to buffer |global-local|
5274 {not in Vi}
5275 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005276 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5277 provided that the file being searched for has a relative path (not
5278 starting with "/", "./" or "../"). The directories in the 'path'
5279 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005280 - Use commas to separate directory names: >
5281 :set path=.,/usr/local/include,/usr/include
5282< - Spaces can also be used to separate directory names (for backwards
5283 compatibility with version 3.0). To have a space in a directory
5284 name, precede it with an extra backslash, and escape the space: >
5285 :set path=.,/dir/with\\\ space
5286< - To include a comma in a directory name precede it with an extra
5287 backslash: >
5288 :set path=.,/dir/with\\,comma
5289< - To search relative to the directory of the current file, use: >
5290 :set path=.
5291< - To search in the current directory use an empty string between two
5292 commas: >
5293 :set path=,,
5294< - A directory name may end in a ':' or '/'.
5295 - Environment variables are expanded |:set_env|.
5296 - When using |netrw.vim| URLs can be used. For example, adding
5297 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005298 - Search upwards and downwards in a directory tree using "*", "**" and
5299 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 {not available when compiled without the |+path_extra| feature}
5301 - Careful with '\' characters, type two to get one in the option: >
5302 :set path=.,c:\\include
5303< Or just use '/' instead: >
5304 :set path=.,c:/include
5305< Don't forget "." or files won't even be found in the same directory as
5306 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005307 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308 it is something like 256 or 1024 characters.
5309 You can check if all the include files are found, using the value of
5310 'path', see |:checkpath|.
5311 The use of |:set+=| and |:set-=| is preferred when adding or removing
5312 directories from the list. This avoids problems when a future version
5313 uses another default. To remove the current directory use: >
5314 :set path-=
5315< To add the current directory use: >
5316 :set path+=
5317< To use an environment variable, you probably need to replace the
5318 separator. Here is an example to append $INCL, in which directory
5319 names are separated with a semi-colon: >
5320 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5321< Replace the ';' with a ':' or whatever separator is used. Note that
5322 this doesn't work when $INCL contains a comma or white space.
5323
5324 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5325'preserveindent' 'pi' boolean (default off)
5326 local to buffer
5327 {not in Vi}
5328 When changing the indent of the current line, preserve as much of the
5329 indent structure as possible. Normally the indent is replaced by a
5330 series of tabs followed by spaces as required (unless |'expandtab'| is
5331 enabled, in which case only spaces are used). Enabling this option
5332 means the indent will preserve as many existing characters as possible
5333 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005334 'expandtab' does not apply to the preserved white space, a Tab remains
5335 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 NOTE: When using ">>" multiple times the resulting indent is a mix of
5337 tabs and spaces. You might not like this.
5338 NOTE: 'preserveindent' is reset when 'compatible' is set.
5339 Also see 'copyindent'.
5340 Use |:retab| to clean up white space.
5341
5342 *'previewheight'* *'pvh'*
5343'previewheight' 'pvh' number (default 12)
5344 global
5345 {not in Vi}
5346 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005347 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005348 Default height for a preview window. Used for |:ptag| and associated
5349 commands. Used for |CTRL-W_}| when no count is given.
5350
5351 *'previewwindow'* *'nopreviewwindow'*
5352 *'pvw'* *'nopvw'* *E590*
5353'previewwindow' 'pvw' boolean (default off)
5354 local to window
5355 {not in Vi}
5356 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005357 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005358 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 set. It's normally not set directly, but by using one of the commands
5360 |:ptag|, |:pedit|, etc.
5361
5362 *'printdevice'* *'pdev'*
5363'printdevice' 'pdev' string (default empty)
5364 global
5365 {not in Vi}
5366 {only available when compiled with the |+printer|
5367 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005368 The name of the printer to be used for |:hardcopy|.
5369 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005370 This option cannot be set from a |modeline| or in the |sandbox|, for
5371 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372
Bram Moolenaar8299df92004-07-10 09:47:34 +00005373 *'printencoding'* *'penc'*
5374'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 global
5376 {not in Vi}
5377 {only available when compiled with the |+printer|
5378 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005379 Sets the character encoding used when printing.
5380 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381
5382 *'printexpr'* *'pexpr'*
5383'printexpr' 'pexpr' String (default: see below)
5384 global
5385 {not in Vi}
5386 {only available when compiled with the |+printer|
5387 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005388 Expression used to print the PostScript produced with |:hardcopy|.
5389 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005390
Bram Moolenaar8299df92004-07-10 09:47:34 +00005391 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392'printfont' 'pfn' string (default "courier")
5393 global
5394 {not in Vi}
5395 {only available when compiled with the |+printer|
5396 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005397 The name of the font that will be used for |:hardcopy|.
5398 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
5400 *'printheader'* *'pheader'*
5401'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5402 global
5403 {not in Vi}
5404 {only available when compiled with the |+printer|
5405 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005406 The format of the header produced in |:hardcopy| output.
5407 See |pheader-option|.
5408
5409 *'printmbcharset'* *'pmbcs'*
5410'printmbcharset' 'pmbcs' string (default "")
5411 global
5412 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005413 {only available when compiled with the |+printer|,
5414 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005415 The CJK character set to be used for CJK output from |:hardcopy|.
5416 See |pmbcs-option|.
5417
5418 *'printmbfont'* *'pmbfn'*
5419'printmbfont' 'pmbfn' string (default "")
5420 global
5421 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005422 {only available when compiled with the |+printer|,
5423 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005424 List of font names to be used for CJK output from |:hardcopy|.
5425 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426
5427 *'printoptions'* *'popt'*
5428'printoptions' 'popt' string (default "")
5429 global
5430 {not in Vi}
5431 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005432 List of items that control the format of the output of |:hardcopy|.
5433 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005435 *'prompt'* *'noprompt'*
5436'prompt' boolean (default on)
5437 global
5438 When on a ":" prompt is used in Ex mode.
5439
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005440 *'pumheight'* *'ph'*
5441'pumheight' 'ph' number (default 0)
5442 global
5443 {not available when compiled without the
5444 |+insert_expand| feature}
5445 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005446 Determines the maximum number of items to show in the popup menu for
5447 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005448 |ins-completion-menu|.
5449
5450
Bram Moolenaar677ee682005-01-27 14:41:15 +00005451 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005452'quoteescape' 'qe' string (default "\")
5453 local to buffer
5454 {not in Vi}
5455 The characters that are used to escape quotes in a string. Used for
5456 objects like a', a" and a` |a'|.
5457 When one of the characters in this option is found inside a string,
5458 the following character will be skipped. The default value makes the
5459 text "foo\"bar\\" considered to be one string.
5460
Bram Moolenaar071d4272004-06-13 20:20:40 +00005461 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5462'readonly' 'ro' boolean (default off)
5463 local to buffer
5464 If on, writes fail unless you use a '!'. Protects you from
5465 accidentally overwriting a file. Default on when Vim is started
5466 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005467 When using ":w!" the 'readonly' option is reset for the current
5468 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005469 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005470 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005472 *'redrawtime'* *'rdt'*
5473'redrawtime' 'rdt' number (default 2000)
5474 global
5475 {not in Vi}
5476 {only available when compiled with the |+reltime|
5477 feature}
5478 The time in milliseconds for redrawing the display. This applies to
5479 searching for patterns for 'hlsearch' and |:match| highlighting.
5480 When redrawing takes more than this many milliseconds no further
5481 matches will be highlighted. This is used to avoid that Vim hangs
5482 when using a very complicated pattern.
5483
Bram Moolenaar64486672010-05-16 15:46:46 +02005484 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5485'relativenumber' 'rnu' boolean (default off)
5486 local to window
5487 {not in Vi}
5488 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005489 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005490 precede some vertical motion commands (e.g. j k + -) with, without
5491 having to calculate it yourself. Especially useful in combination with
5492 other commands (e.g. y d c < > gq gw =).
5493 When the 'n' option is excluded from 'cpoptions' a wrapped
5494 line will not use the column of line numbers (this is the default when
5495 'compatible' isn't set).
5496 The 'numberwidth' option can be used to set the room used for the line
5497 number.
5498 When a long, wrapped line doesn't start with the first character, '-'
5499 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005500 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5501 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005502 When setting this option, 'number' is reset.
5503
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 *'remap'* *'noremap'*
5505'remap' boolean (default on)
5506 global
5507 Allows for mappings to work recursively. If you do not want this for
5508 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005509 NOTE: To avoid portability problems with Vim scripts, always keep
5510 this option at the default "on". Only switch it off when working with
5511 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512
5513 *'report'*
5514'report' number (default 2)
5515 global
5516 Threshold for reporting number of lines changed. When the number of
5517 changed lines is more than 'report' a message will be given for most
5518 ":" commands. If you want it always, set 'report' to 0.
5519 For the ":substitute" command the number of substitutions is used
5520 instead of the number of lines.
5521
5522 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5523'restorescreen' 'rs' boolean (default on)
5524 global
5525 {not in Vi} {only in Windows 95/NT console version}
5526 When set, the screen contents is restored when exiting Vim. This also
5527 happens when executing external commands.
5528
5529 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5530 options in your .vimrc. To disable restoring:
5531 set t_ti= t_te=
5532 To enable restoring (for an xterm):
5533 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5534 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5535
5536 *'revins'* *'ri'* *'norevins'* *'nori'*
5537'revins' 'ri' boolean (default off)
5538 global
5539 {not in Vi}
5540 {only available when compiled with the |+rightleft|
5541 feature}
5542 Inserting characters in Insert mode will work backwards. See "typing
5543 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5544 command in Insert mode, when 'allowrevins' is set.
5545 NOTE: This option is reset when 'compatible' or 'paste' is set.
5546
5547 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5548'rightleft' 'rl' boolean (default off)
5549 local to window
5550 {not in Vi}
5551 {only available when compiled with the |+rightleft|
5552 feature}
5553 When on, display orientation becomes right-to-left, i.e., characters
5554 that are stored in the file appear from the right to the left.
5555 Using this option, it is possible to edit files for languages that
5556 are written from the right to the left such as Hebrew and Arabic.
5557 This option is per window, so it is possible to edit mixed files
5558 simultaneously, or to view the same file in both ways (this is
5559 useful whenever you have a mixed text file with both right-to-left
5560 and left-to-right strings so that both sets are displayed properly
5561 in different windows). Also see |rileft.txt|.
5562
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005563 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564'rightleftcmd' 'rlc' string (default "search")
5565 local to window
5566 {not in Vi}
5567 {only available when compiled with the |+rightleft|
5568 feature}
5569 Each word in this option enables the command line editing to work in
5570 right-to-left mode for a group of commands:
5571
5572 search "/" and "?" commands
5573
5574 This is useful for languages such as Hebrew, Arabic and Farsi.
5575 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5576
5577 *'ruler'* *'ru'* *'noruler'* *'noru'*
5578'ruler' 'ru' boolean (default off)
5579 global
5580 {not in Vi}
5581 {not available when compiled without the
5582 |+cmdline_info| feature}
5583 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005584 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585 text in the file is shown on the far right:
5586 Top first line is visible
5587 Bot last line is visible
5588 All first and last line are visible
5589 45% relative position in the file
5590 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005591 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005593 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 this option takes precedence over 'ruler' and 'rulerformat'
5595 If the number of characters displayed is different from the number of
5596 bytes in the text (e.g., for a TAB or a multi-byte character), both
5597 the text column (byte number) and the screen column are shown,
5598 separated with a dash.
5599 For an empty line "0-1" is shown.
5600 For an empty buffer the line number will also be zero: "0,0-1".
5601 This option is reset when the 'paste' option is set.
5602 If you don't want to see the ruler all the time but want to know where
5603 you are, use "g CTRL-G" |g_CTRL-G|.
5604 NOTE: This option is reset when 'compatible' is set.
5605
5606 *'rulerformat'* *'ruf'*
5607'rulerformat' 'ruf' string (default empty)
5608 global
5609 {not in Vi}
5610 {not available when compiled without the |+statusline|
5611 feature}
5612 When this option is not empty, it determines the content of the ruler
5613 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005614 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 The default ruler width is 17 characters. To make the ruler 15
5616 characters wide, put "%15(" at the start and "%)" at the end.
5617 Example: >
5618 :set rulerformat=%15(%c%V\ %p%%%)
5619<
5620 *'runtimepath'* *'rtp'* *vimfiles*
5621'runtimepath' 'rtp' string (default:
5622 Unix: "$HOME/.vim,
5623 $VIM/vimfiles,
5624 $VIMRUNTIME,
5625 $VIM/vimfiles/after,
5626 $HOME/.vim/after"
5627 Amiga: "home:vimfiles,
5628 $VIM/vimfiles,
5629 $VIMRUNTIME,
5630 $VIM/vimfiles/after,
5631 home:vimfiles/after"
5632 PC, OS/2: "$HOME/vimfiles,
5633 $VIM/vimfiles,
5634 $VIMRUNTIME,
5635 $VIM/vimfiles/after,
5636 $HOME/vimfiles/after"
5637 Macintosh: "$VIM:vimfiles,
5638 $VIMRUNTIME,
5639 $VIM:vimfiles:after"
5640 RISC-OS: "Choices:vimfiles,
5641 $VIMRUNTIME,
5642 Choices:vimfiles/after"
5643 VMS: "sys$login:vimfiles,
5644 $VIM/vimfiles,
5645 $VIMRUNTIME,
5646 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005647 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005648 global
5649 {not in Vi}
5650 This is a list of directories which will be searched for runtime
5651 files:
5652 filetype.vim filetypes by file name |new-filetype|
5653 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005654 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 colors/ color scheme files |:colorscheme|
5656 compiler/ compiler files |:compiler|
5657 doc/ documentation |write-local-help|
5658 ftplugin/ filetype plugins |write-filetype-plugin|
5659 indent/ indent scripts |indent-expression|
5660 keymap/ key mapping files |mbyte-keymap|
5661 lang/ menu translations |:menutrans|
5662 menu.vim GUI menus |menu.vim|
5663 plugin/ plugin scripts |write-plugin|
5664 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005665 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005666 syntax/ syntax files |mysyntaxfile|
5667 tutor/ files for vimtutor |tutor|
5668
5669 And any other file searched for with the |:runtime| command.
5670
5671 The defaults for most systems are setup to search five locations:
5672 1. In your home directory, for your personal preferences.
5673 2. In a system-wide Vim directory, for preferences from the system
5674 administrator.
5675 3. In $VIMRUNTIME, for files distributed with Vim.
5676 *after-directory*
5677 4. In the "after" directory in the system-wide Vim directory. This is
5678 for the system administrator to overrule or add to the distributed
5679 defaults (rarely needed)
5680 5. In the "after" directory in your home directory. This is for
5681 personal preferences to overrule or add to the distributed defaults
5682 or system-wide settings (rarely needed).
5683
5684 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5685 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 wildcards.
5688 See |:runtime|.
5689 Example: >
5690 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5691< This will use the directory "~/vimruntime" first (containing your
5692 personal Vim runtime files), then "/mygroup/vim" (shared between a
5693 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5694 files).
5695 You probably should always include $VIMRUNTIME somewhere, to use the
5696 distributed runtime files. You can put a directory before $VIMRUNTIME
5697 to find files which replace a distributed runtime files. You can put
5698 a directory after $VIMRUNTIME to find files which add to distributed
5699 runtime files.
5700 This option cannot be set from a |modeline| or in the |sandbox|, for
5701 security reasons.
5702
5703 *'scroll'* *'scr'*
5704'scroll' 'scr' number (default: half the window height)
5705 local to window
5706 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5707 set to half the number of lines in the window when the window size
5708 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005709 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005710 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5711 the number of screen lines instead of file lines, makes a difference
5712 when lines wrap}
5713
5714 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5715'scrollbind' 'scb' boolean (default off)
5716 local to window
5717 {not in Vi}
5718 {not available when compiled without the |+scrollbind|
5719 feature}
5720 See also |scroll-binding|. When this option is set, the current
5721 window scrolls as other scrollbind windows (windows that also have
5722 this option set) scroll. This option is useful for viewing the
5723 differences between two versions of a file, see 'diff'.
5724 See |'scrollopt'| for options that determine how this option should be
5725 interpreted.
5726 This option is mostly reset when splitting a window to edit another
5727 file. This means that ":split | edit file" results in two windows
5728 with scroll-binding, but ":split file" does not.
5729
5730 *'scrolljump'* *'sj'*
5731'scrolljump' 'sj' number (default 1)
5732 global
5733 {not in Vi}
5734 Minimal number of lines to scroll when the cursor gets off the
5735 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5736 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005737 When set to a negative number from -1 to -100 this is used as the
5738 percentage of the window height. Thus -50 scrolls half the window
5739 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 NOTE: This option is set to 1 when 'compatible' is set.
5741
5742 *'scrolloff'* *'so'*
5743'scrolloff' 'so' number (default 0)
5744 global
5745 {not in Vi}
5746 Minimal number of screen lines to keep above and below the cursor.
5747 This will make some context visible around where you are working. If
5748 you set it to a very large value (999) the cursor line will always be
5749 in the middle of the window (except at the start or end of the file or
5750 when long lines wrap).
5751 For scrolling horizontally see 'sidescrolloff'.
5752 NOTE: This option is set to 0 when 'compatible' is set.
5753
5754 *'scrollopt'* *'sbo'*
5755'scrollopt' 'sbo' string (default "ver,jump")
5756 global
5757 {not available when compiled without the |+scrollbind|
5758 feature}
5759 {not in Vi}
5760 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005761 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5762 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 The following words are available:
5764 ver Bind vertical scrolling for 'scrollbind' windows
5765 hor Bind horizontal scrolling for 'scrollbind' windows
5766 jump Applies to the offset between two windows for vertical
5767 scrolling. This offset is the difference in the first
5768 displayed line of the bound windows. When moving
5769 around in a window, another 'scrollbind' window may
5770 reach a position before the start or after the end of
5771 the buffer. The offset is not changed though, when
5772 moving back the 'scrollbind' window will try to scroll
5773 to the desired position when possible.
5774 When now making that window the current one, two
5775 things can be done with the relative offset:
5776 1. When "jump" is not included, the relative offset is
5777 adjusted for the scroll position in the new current
5778 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005779 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005780 2. When "jump" is included, the other windows are
5781 scrolled to keep the same relative offset. When
5782 going back to the other window, it still uses the
5783 same relative offset.
5784 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005785 When 'diff' mode is active there always is vertical scroll binding,
5786 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787
5788 *'sections'* *'sect'*
5789'sections' 'sect' string (default "SHNHH HUnhsh")
5790 global
5791 Specifies the nroff macros that separate sections. These are pairs of
5792 two letters (See |object-motions|). The default makes a section start
5793 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5794
5795 *'secure'* *'nosecure'* *E523*
5796'secure' boolean (default off)
5797 global
5798 {not in Vi}
5799 When on, ":autocmd", shell and write commands are not allowed in
5800 ".vimrc" and ".exrc" in the current directory and map commands are
5801 displayed. Switch it off only if you know that you will not run into
5802 problems, or when the 'exrc' option is off. On Unix this option is
5803 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005804 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 'secure' at the end of your ~/.vimrc then.
5806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
5808
5809 *'selection'* *'sel'*
5810'selection' 'sel' string (default "inclusive")
5811 global
5812 {not in Vi}
5813 This option defines the behavior of the selection. It is only used
5814 in Visual and Select mode.
5815 Possible values:
5816 value past line inclusive ~
5817 old no yes
5818 inclusive yes yes
5819 exclusive yes no
5820 "past line" means that the cursor is allowed to be positioned one
5821 character past the line.
5822 "inclusive" means that the last character of the selection is included
5823 in an operation. For example, when "x" is used to delete the
5824 selection.
5825 Note that when "exclusive" is used and selecting from the end
5826 backwards, you cannot include the last character of a line, when
5827 starting in Normal mode and 'virtualedit' empty.
5828
5829 The 'selection' option is set by the |:behave| command.
5830
5831 *'selectmode'* *'slm'*
5832'selectmode' 'slm' string (default "")
5833 global
5834 {not in Vi}
5835 This is a comma separated list of words, which specifies when to start
5836 Select mode instead of Visual mode, when a selection is started.
5837 Possible values:
5838 mouse when using the mouse
5839 key when using shifted special keys
5840 cmd when using "v", "V" or CTRL-V
5841 See |Select-mode|.
5842 The 'selectmode' option is set by the |:behave| command.
5843
5844 *'sessionoptions'* *'ssop'*
5845'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005846 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005847 global
5848 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005849 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005850 feature}
5851 Changes the effect of the |:mksession| command. It is a comma
5852 separated list of words. Each word enables saving and restoring
5853 something:
5854 word save and restore ~
5855 blank empty windows
5856 buffers hidden and unloaded buffers, not just those in windows
5857 curdir the current directory
5858 folds manually created folds, opened/closed folds and local
5859 fold options
5860 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005861 and contain at least one lowercase letter. Only
5862 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005863 help the help window
5864 localoptions options and mappings local to a window or buffer (not
5865 global values for local options)
5866 options all options and mappings (also global values for local
5867 options)
5868 resize size of the Vim window: 'lines' and 'columns'
5869 sesdir the directory in which the session file is located
5870 will become the current directory (useful with
5871 projects accessed over a network from different
5872 systems)
5873 slash backslashes in file names replaced with forward
5874 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005875 tabpages all tab pages; without this only the current tab page
5876 is restored, so that you can make a session for each
5877 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 unix with Unix end-of-line format (single <NL>), even when
5879 on Windows or DOS
5880 winpos position of the whole Vim window
5881 winsize window sizes
5882
5883 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005884 When neither "curdir" nor "sesdir" is included, file names are stored
5885 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005886 "slash" and "unix" are useful on Windows when sharing session files
5887 with Unix. The Unix version of Vim cannot source dos format scripts,
5888 but the Windows version of Vim can source unix format scripts.
5889
5890 *'shell'* *'sh'* *E91*
5891'shell' 'sh' string (default $SHELL or "sh",
5892 MS-DOS and Win32: "command.com" or
5893 "cmd.exe", OS/2: "cmd")
5894 global
5895 Name of the shell to use for ! and :! commands. When changing the
5896 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5897 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005898 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899 See |option-backslash| about including spaces and backslashes.
5900 Environment variables are expanded |:set_env|.
5901 If the name of the shell contains a space, you might need to enclose
5902 it in quotes. Example: >
5903 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5904< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005905 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005906 "-f" is not inside the quotes, because it is not part of the command
5907 name. And Vim automagically recognizes the backslashes that are path
5908 separators.
5909 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5910 variable to change the way external commands are executed. See the
5911 libc.inf file of DJGPP.
5912 Under MS-Windows, when the executable ends in ".com" it must be
5913 included. Thus setting the shell to "command.com" or "4dos.com"
5914 works, but "command" and "4dos" do not work for all commands (e.g.,
5915 filtering).
5916 For unknown reasons, when using "4dos.com" the current directory is
5917 changed to "C:\". To avoid this set 'shell' like this: >
5918 :set shell=command.com\ /c\ 4dos
5919< This option cannot be set from a |modeline| or in the |sandbox|, for
5920 security reasons.
5921
5922 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005923'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005924 MS-DOS and Win32, when 'shell' does not
5925 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005926 global
5927 {not in Vi}
5928 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5929 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5930 systems, the default is set according to the value of 'shell', to
5931 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005932 OS/2 (EMX figures this out itself).
5933 On Unix it can have more than one flag. Each white space separated
5934 part is passed as an argument to the shell command.
5935 See |option-backslash| about including spaces and backslashes.
5936 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
5940 *'shellpipe'* *'sp'*
5941'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5942 global
5943 {not in Vi}
5944 {not available when compiled without the |+quickfix|
5945 feature}
5946 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005947 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005948 including spaces and backslashes.
5949 The name of the temporary file can be represented by "%s" if necessary
5950 (the file name is appended automatically if no %s appears in the value
5951 of this option).
5952 For the Amiga and MS-DOS the default is ">". The output is directly
5953 saved in a file and not echoed to the screen.
5954 For Unix the default it "| tee". The stdout of the compiler is saved
5955 in a file and echoed to the screen. If the 'shell' option is "csh" or
5956 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005957 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5958 default becomes "2>&1| tee". This means that stderr is also included.
5959 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5960 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005961 The initialization of this option is done after reading the ".vimrc"
5962 and the other initializations, so that when the 'shell' option is set
5963 there, the 'shellpipe' option changes automatically, unless it was
5964 explicitly set before.
5965 When 'shellpipe' is set to an empty string, no redirection of the
5966 ":make" output will be done. This is useful if you use a 'makeprg'
5967 that writes to 'makeef' by itself. If you want no piping, but do
5968 want to include the 'makeef', set 'shellpipe' to a single space.
5969 Don't forget to precede the space with a backslash: ":set sp=\ ".
5970 In the future pipes may be used for filtering and this option will
5971 become obsolete (at least for Unix).
5972 This option cannot be set from a |modeline| or in the |sandbox|, for
5973 security reasons.
5974
5975 *'shellquote'* *'shq'*
5976'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5977 contains "sh" somewhere: "\"")
5978 global
5979 {not in Vi}
5980 Quoting character(s), put around the command passed to the shell, for
5981 the "!" and ":!" commands. The redirection is kept outside of the
5982 quoting. See 'shellxquote' to include the redirection. It's
5983 probably not useful to set both options.
5984 This is an empty string by default. Only known to be useful for
5985 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5986 or bash, where it should be "\"". The default is adjusted according
5987 the value of 'shell', to reduce the need to set this option by the
5988 user. See |dos-shell|.
5989 This option cannot be set from a |modeline| or in the |sandbox|, for
5990 security reasons.
5991
5992 *'shellredir'* *'srr'*
5993'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5994 global
5995 {not in Vi}
5996 String to be used to put the output of a filter command in a temporary
5997 file. See also |:!|. See |option-backslash| about including spaces
5998 and backslashes.
5999 The name of the temporary file can be represented by "%s" if necessary
6000 (the file name is appended automatically if no %s appears in the value
6001 of this option).
6002 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6003 or "zsh" during initializations, the default becomes ">&". If the
6004 'shell' option is "sh", "ksh" or "bash" the default becomes
6005 ">%s 2>&1". This means that stderr is also included.
6006 For Win32, the Unix checks are done and additionally "cmd" is checked
6007 for, which makes the default ">%s 2>&1". Also, the same names with
6008 ".exe" appended are checked for.
6009 The initialization of this option is done after reading the ".vimrc"
6010 and the other initializations, so that when the 'shell' option is set
6011 there, the 'shellredir' option changes automatically unless it was
6012 explicitly set before.
6013 In the future pipes may be used for filtering and this option will
6014 become obsolete (at least for Unix).
6015 This option cannot be set from a |modeline| or in the |sandbox|, for
6016 security reasons.
6017
6018 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6019'shellslash' 'ssl' boolean (default off)
6020 global
6021 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6022 When set, a forward slash is used when expanding file names. This is
6023 useful when a Unix-like shell is used instead of command.com or
6024 cmd.exe. Backward slashes can still be typed, but they are changed to
6025 forward slashes by Vim.
6026 Note that setting or resetting this option has no effect for some
6027 existing file names, thus this option needs to be set before opening
6028 any file for best results. This might change in the future.
6029 'shellslash' only works when a backslash can be used as a path
6030 separator. To test if this is so use: >
6031 if exists('+shellslash')
6032<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006033 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6034'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6035 global
6036 {not in Vi}
6037 When on, use temp files for shell commands. When off use a pipe.
6038 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006039 Currently a pipe is only supported on Unix and MS-Windows 2K and
6040 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006041 :if has("filterpipe")
6042< The advantage of using a pipe is that nobody can read the temp file
6043 and the 'shell' command does not need to support redirection.
6044 The advantage of using a temp file is that the file type and encoding
6045 can be detected.
6046 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6047 |FilterWritePost| autocommands event are not triggered when
6048 'shelltemp' is off.
6049
Bram Moolenaar071d4272004-06-13 20:20:40 +00006050 *'shelltype'* *'st'*
6051'shelltype' 'st' number (default 0)
6052 global
6053 {not in Vi} {only for the Amiga}
6054 On the Amiga this option influences the way how the commands work
6055 which use a shell.
6056 0 and 1: always use the shell
6057 2 and 3: use the shell only to filter lines
6058 4 and 5: use shell only for ':sh' command
6059 When not using the shell, the command is executed directly.
6060
6061 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6062 1 and 3: use "shell cmd" to start external commands
6063
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006064 *'shellxescape'* *'sxe'*
6065'shellxescape' 'sxe' string (default: "";
6066 for MS-DOS and MS-Windows: "\"&|<>()@^")
6067 global
6068 {not in Vi}
6069 When 'shellxquote' is set to "(" then the characters listed in this
6070 option will be escaped with a '^' character. This makes it possible
6071 to execute most external commands with cmd.exe.
6072
Bram Moolenaar071d4272004-06-13 20:20:40 +00006073 *'shellxquote'* *'sxq'*
6074'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006075 for Win32, when 'shell' is cmd.exe: "("
6076 for Win32, when 'shell' contains "sh"
6077 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 for Unix, when using system(): "\"")
6079 global
6080 {not in Vi}
6081 Quoting character(s), put around the command passed to the shell, for
6082 the "!" and ":!" commands. Includes the redirection. See
6083 'shellquote' to exclude the redirection. It's probably not useful
6084 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006085 When the value is '(' then ')' is appended. When the value is '"('
6086 then ')"' is appended.
6087 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006088 This is an empty string by default on most systems, but is known to be
6089 useful for on Win32 version, either for cmd.exe which automatically
6090 strips off the first and last quote on a command, or 3rd-party shells
6091 such as the MKS Korn Shell or bash, where it should be "\"". The
6092 default is adjusted according the value of 'shell', to reduce the need
6093 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 This option cannot be set from a |modeline| or in the |sandbox|, for
6095 security reasons.
6096
6097 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6098'shiftround' 'sr' boolean (default off)
6099 global
6100 {not in Vi}
6101 Round indent to multiple of 'shiftwidth'. Applies to > and <
6102 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6103 a multiple of 'shiftwidth' (this is Vi compatible).
6104 NOTE: This option is reset when 'compatible' is set.
6105
6106 *'shiftwidth'* *'sw'*
6107'shiftwidth' 'sw' number (default 8)
6108 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006109 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 |'cindent'|, |>>|, |<<|, etc.
6111
6112 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006113'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6114 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006115 global
6116 {not in Vi}
6117 This option helps to avoid all the |hit-enter| prompts caused by file
6118 messages, for example with CTRL-G, and to avoid some other messages.
6119 It is a list of flags:
6120 flag meaning when present ~
6121 f use "(3 of 5)" instead of "(file 3 of 5)"
6122 i use "[noeol]" instead of "[Incomplete last line]"
6123 l use "999L, 888C" instead of "999 lines, 888 characters"
6124 m use "[+]" instead of "[Modified]"
6125 n use "[New]" instead of "[New File]"
6126 r use "[RO]" instead of "[readonly]"
6127 w use "[w]" instead of "written" for file write message
6128 and "[a]" instead of "appended" for ':w >> file' command
6129 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6130 "[unix format]" and "[mac]" instead of "[mac format]".
6131 a all of the above abbreviations
6132
6133 o overwrite message for writing a file with subsequent message
6134 for reading a file (useful for ":wn" or when 'autowrite' on)
6135 O message for reading a file overwrites any previous message.
6136 Also for quickfix message (e.g., ":cn").
6137 s don't give "search hit BOTTOM, continuing at TOP" or "search
6138 hit TOP, continuing at BOTTOM" messages
6139 t truncate file message at the start if it is too long to fit
6140 on the command-line, "<" will appear in the left most column.
6141 Ignored in Ex mode.
6142 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006143 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 Ignored in Ex mode.
6145 W don't give "written" or "[w]" when writing a file
6146 A don't give the "ATTENTION" message when an existing swap file
6147 is found.
6148 I don't give the intro message when starting Vim |:intro|.
6149
6150 This gives you the opportunity to avoid that a change between buffers
6151 requires you to hit <Enter>, but still gives as useful a message as
6152 possible for the space available. To get the whole message that you
6153 would have got with 'shm' empty, use ":file!"
6154 Useful values:
6155 shm= No abbreviation of message.
6156 shm=a Abbreviation, but no loss of information.
6157 shm=at Abbreviation, and truncate message when necessary.
6158
6159 NOTE: This option is set to the Vi default value when 'compatible' is
6160 set and to the Vim default value when 'compatible' is reset.
6161
6162 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6163'shortname' 'sn' boolean (default off)
6164 local to buffer
6165 {not in Vi, not in MS-DOS versions}
6166 Filenames are assumed to be 8 characters plus one extension of 3
6167 characters. Multiple dots in file names are not allowed. When this
6168 option is on, dots in file names are replaced with underscores when
6169 adding an extension (".~" or ".swp"). This option is not available
6170 for MS-DOS, because then it would always be on. This option is useful
6171 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6172 or crossdos. When running the Win32 GUI version under Win32s, this
6173 option is always on by default.
6174
6175 *'showbreak'* *'sbr'* *E595*
6176'showbreak' 'sbr' string (default "")
6177 global
6178 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006179 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 feature}
6181 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006182 values are "> " or "+++ ": >
6183 :set showbreak=>\
6184< Note the backslash to escape the trailing space. It's easier like
6185 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006186 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006187< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006188 comma (in a future version the comma might be used to separate the
6189 part that is shown at the end and at the start of a line).
6190 The characters are highlighted according to the '@' flag in
6191 'highlight'.
6192 Note that tabs after the showbreak will be displayed differently.
6193 If you want the 'showbreak' to appear in between line numbers, add the
6194 "n" flag to 'cpoptions'.
6195
6196 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6197'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6198 off)
6199 global
6200 {not in Vi}
6201 {not available when compiled without the
6202 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006203 Show (partial) command in the last line of the screen. Set this
6204 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 In Visual mode the size of the selected area is shown:
6206 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006207 If the number of bytes is different it is also displayed: "2-6"
6208 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006209 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006210 - When selecting a block, the size in screen characters:
6211 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 NOTE: This option is set to the Vi default value when 'compatible' is
6213 set and to the Vim default value when 'compatible' is reset.
6214
6215 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6216'showfulltag' 'sft' boolean (default off)
6217 global
6218 {not in Vi}
6219 When completing a word in insert mode (see |ins-completion|) from the
6220 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006221 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 matched a C function, you can see a template for what arguments are
6223 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006224 Note that this doesn't work well together with having "longest" in
6225 'completeopt', because the completion from the search pattern may not
6226 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006227
6228 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6229'showmatch' 'sm' boolean (default off)
6230 global
6231 When a bracket is inserted, briefly jump to the matching one. The
6232 jump is only done if the match can be seen on the screen. The time to
6233 show the match can be set with 'matchtime'.
6234 A Beep is given if there is no match (no matter if the match can be
6235 seen or not). This option is reset when the 'paste' option is set.
6236 When the 'm' flag is not included in 'cpoptions', typing a character
6237 will immediately move the cursor back to where it belongs.
6238 See the "sm" field in 'guicursor' for setting the cursor shape and
6239 blinking when showing the match.
6240 The 'matchpairs' option can be used to specify the characters to show
6241 matches for. 'rightleft' and 'revins' are used to look for opposite
6242 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006243 Also see the matchparen plugin for highlighting the match when moving
6244 around |pi_paren.txt|.
6245 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006246
6247 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6248'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6249 global
6250 If in Insert, Replace or Visual mode put a message on the last line.
6251 Use the 'M' flag in 'highlight' to set the type of highlighting for
6252 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006253 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 doesn't mean XIM is really active, especially when 'imactivatekey' is
6255 not set.
6256 NOTE: This option is set to the Vi default value when 'compatible' is
6257 set and to the Vim default value when 'compatible' is reset.
6258
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006259 *'showtabline'* *'stal'*
6260'showtabline' 'stal' number (default 1)
6261 global
6262 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006263 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006264 feature}
6265 The value of this option specifies when the line with tab page labels
6266 will be displayed:
6267 0: never
6268 1: only if there are at least two tab pages
6269 2: always
6270 This is both for the GUI and non-GUI implementation of the tab pages
6271 line.
6272 See |tab-page| for more information about tab pages.
6273
Bram Moolenaar071d4272004-06-13 20:20:40 +00006274 *'sidescroll'* *'ss'*
6275'sidescroll' 'ss' number (default 0)
6276 global
6277 {not in Vi}
6278 The minimal number of columns to scroll horizontally. Used only when
6279 the 'wrap' option is off and the cursor is moved off of the screen.
6280 When it is zero the cursor will be put in the middle of the screen.
6281 When using a slow terminal set it to a large number or 0. When using
6282 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6283 commands.
6284
6285 *'sidescrolloff'* *'siso'*
6286'sidescrolloff' 'siso' number (default 0)
6287 global
6288 {not in Vi}
6289 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006290 right of the cursor if 'nowrap' is set. Setting this option to a
6291 value greater than 0 while having |'sidescroll'| also at a non-zero
6292 value makes some context visible in the line you are scrolling in
6293 horizontally (except at beginning of the line). Setting this option
6294 to a large value (like 999) has the effect of keeping the cursor
6295 horizontally centered in the window, as long as one does not come too
6296 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 NOTE: This option is set to 0 when 'compatible' is set.
6298
6299 Example: Try this together with 'sidescroll' and 'listchars' as
6300 in the following example to never allow the cursor to move
6301 onto the "extends" character:
6302
6303 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6304 :set sidescrolloff=1
6305
6306
6307 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6308'smartcase' 'scs' boolean (default off)
6309 global
6310 {not in Vi}
6311 Override the 'ignorecase' option if the search pattern contains upper
6312 case characters. Only used when the search pattern is typed and
6313 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006314 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6316 recalling the search pattern from history and hitting <Enter>.
6317 NOTE: This option is reset when 'compatible' is set.
6318
6319 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6320'smartindent' 'si' boolean (default off)
6321 local to buffer
6322 {not in Vi}
6323 {not available when compiled without the
6324 |+smartindent| feature}
6325 Do smart autoindenting when starting a new line. Works for C-like
6326 programs, but can also be used for other languages. 'cindent' does
6327 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006328 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006329 setting 'si' has no effect. 'indentexpr' is a more advanced
6330 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006331 Normally 'autoindent' should also be on when using 'smartindent'.
6332 An indent is automatically inserted:
6333 - After a line ending in '{'.
6334 - After a line starting with a keyword from 'cinwords'.
6335 - Before a line starting with '}' (only with the "O" command).
6336 When typing '}' as the first character in a new line, that line is
6337 given the same indent as the matching '{'.
6338 When typing '#' as the first character in a new line, the indent for
6339 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006340 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006341 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6342 When using the ">>" command, lines starting with '#' are not shifted
6343 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006344 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 is set smart indenting is disabled.
6346
6347 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6348'smarttab' 'sta' boolean (default off)
6349 global
6350 {not in Vi}
6351 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006352 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6353 <BS> will delete a 'shiftwidth' worth of space at the start of the
6354 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006355 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006356 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6357 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006358 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006360 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006361 NOTE: This option is reset when 'compatible' is set.
6362
6363 *'softtabstop'* *'sts'*
6364'softtabstop' 'sts' number (default 0)
6365 local to buffer
6366 {not in Vi}
6367 Number of spaces that a <Tab> counts for while performing editing
6368 operations, like inserting a <Tab> or using <BS>. It "feels" like
6369 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6370 used. This is useful to keep the 'ts' setting at its standard value
6371 of 8, while being able to edit like it is set to 'sts'. However,
6372 commands like "x" still work on the actual characters.
6373 When 'sts' is zero, this feature is off.
6374 'softtabstop' is set to 0 when the 'paste' option is set.
6375 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6376 spaces is minimized by using <Tab>s.
6377 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6378 set.
6379 NOTE: This option is set to 0 when 'compatible' is set.
6380
Bram Moolenaar217ad922005-03-20 22:37:15 +00006381 *'spell'* *'nospell'*
6382'spell' boolean (default off)
6383 local to window
6384 {not in Vi}
6385 {not available when compiled without the |+syntax|
6386 feature}
6387 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006388 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006389
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006390 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006391'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006392 local to buffer
6393 {not in Vi}
6394 {not available when compiled without the |+syntax|
6395 feature}
6396 Pattern to locate the end of a sentence. The following word will be
6397 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006398 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006399 When this check is not wanted make this option empty.
6400 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006401 Be careful with special characters, see |option-backslash| about
6402 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006403 To set this option automatically depending on the language, see
6404 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006405
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006406 *'spellfile'* *'spf'*
6407'spellfile' 'spf' string (default empty)
6408 local to buffer
6409 {not in Vi}
6410 {not available when compiled without the |+syntax|
6411 feature}
6412 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006413 commands. It must end in ".{encoding}.add". You need to include the
6414 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006415 *E765*
6416 It may also be a comma separated list of names. A count before the
6417 |zg| and |zw| commands can be used to access each. This allows using
6418 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006419 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006420 you: Using the first directory in 'runtimepath' that is writable. If
6421 there is no "spell" directory yet it will be created. For the file
6422 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006423 ignoring the region.
6424 The resulting ".spl" file will be used for spell checking, it does not
6425 have to appear in 'spelllang'.
6426 Normally one file is used for all regions, but you can add the region
6427 name if you want to. However, it will then only be used when
6428 'spellfile' is set to it, for entries in 'spelllang' only files
6429 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006430 This option cannot be set from a |modeline| or in the |sandbox|, for
6431 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006432
Bram Moolenaar217ad922005-03-20 22:37:15 +00006433 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006434'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006435 local to buffer
6436 {not in Vi}
6437 {not available when compiled without the |+syntax|
6438 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006439 A comma separated list of word list names. When the 'spell' option is
6440 on spellchecking will be done for these languages. Example: >
6441 set spelllang=en_us,nl,medical
6442< This means US English, Dutch and medical words are recognized. Words
6443 that are not recognized will be highlighted.
6444 The word list name must not include a comma or dot. Using a dash is
6445 recommended to separate the two letter language name from a
6446 specification. Thus "en-rare" is used for rare English words.
6447 A region name must come last and have the form "_xx", where "xx" is
6448 the two-letter, lower case region name. You can use more than one
6449 region by listing them: "en_us,en_ca" supports both US and Canadian
6450 English, but not words specific for Australia, New Zealand or Great
6451 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006452 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006453 As a special case the name of a .spl file can be given as-is. The
6454 first "_xx" in the name is removed and used as the region name
6455 (_xx is an underscore, two letters and followed by a non-letter).
6456 This is mainly for testing purposes. You must make sure the correct
6457 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006458 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006459 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6460 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006461 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006462
Bram Moolenaar98692072006-02-04 00:57:42 +00006463 If the |spellfile.vim| plugin is active and you use a language name
6464 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6465 will ask you if you want to download the file.
6466
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006467 After this option has been set successfully, Vim will source the files
6468 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006469 up to the first comma, dot or underscore.
6470 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006471
6472
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006473 *'spellsuggest'* *'sps'*
6474'spellsuggest' 'sps' string (default "best")
6475 global
6476 {not in Vi}
6477 {not available when compiled without the |+syntax|
6478 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006479 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006480 the |spellsuggest()| function. This is a comma-separated list of
6481 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006482
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006483 best Internal method that works best for English. Finds
6484 changes like "fast" and uses a bit of sound-a-like
6485 scoring to improve the ordering.
6486
6487 double Internal method that uses two methods and mixes the
6488 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006489 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006490 word. That only works when the language specifies
6491 sound folding. Can be slow and doesn't always give
6492 better results.
6493
6494 fast Internal method that only checks for simple changes:
6495 character inserts/deletes/swaps. Works well for
6496 simple typing mistakes.
6497
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006498 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006499 Not used for |spellsuggest()|. The number of
6500 suggestions is never more than the value of 'lines'
6501 minus two.
6502
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006503 file:{filename} Read file {filename}, which must have two columns,
6504 separated by a slash. The first column contains the
6505 bad word, the second column the suggested good word.
6506 Example:
6507 theribal/terrible ~
6508 Use this for common mistakes that do not appear at the
6509 top of the suggestion list with the internal methods.
6510 Lines without a slash are ignored, use this for
6511 comments.
6512 The file is used for all languages.
6513
6514 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6515 trouble with spaces. |v:val| holds the badly spelled
6516 word. The expression must evaluate to a List of
6517 Lists, each with a suggestion and a score.
6518 Example:
6519 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006520 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006521 internal methods use. A lower score is better.
6522 This may invoke |spellsuggest()| if you temporarily
6523 set 'spellsuggest' to exclude the "expr:" part.
6524 Errors are silently ignored, unless you set the
6525 'verbose' option to a non-zero value.
6526
6527 Only one of "best", "double" or "fast" may be used. The others may
6528 appear several times in any order. Example: >
6529 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6530<
6531 This option cannot be set from a |modeline| or in the |sandbox|, for
6532 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006533
6534
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6536'splitbelow' 'sb' boolean (default off)
6537 global
6538 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006539 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 feature}
6541 When on, splitting a window will put the new window below the current
6542 one. |:split|
6543
6544 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6545'splitright' 'spr' boolean (default off)
6546 global
6547 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006548 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 feature}
6550 When on, splitting a window will put the new window right of the
6551 current one. |:vsplit|
6552
6553 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6554'startofline' 'sol' boolean (default on)
6555 global
6556 {not in Vi}
6557 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006558 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006559 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006560 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 with a linewise operator, with "%" with a count and to buffer changing
6562 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6563 only has a line number, e.g., ":25" or ":+".
6564 In case of buffer changing commands the cursor is placed at the column
6565 where it was the last time the buffer was edited.
6566 NOTE: This option is set when 'compatible' is set.
6567
Bram Moolenaar00654022011-02-25 14:42:19 +01006568 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006569'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006570 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006571 {not in Vi}
6572 {not available when compiled without the |+statusline|
6573 feature}
6574 When nonempty, this option determines the content of the status line.
6575 Also see |status-line|.
6576
6577 The option consists of printf style '%' items interspersed with
6578 normal text. Each status line item is of the form:
6579 %-0{minwid}.{maxwid}{item}
6580 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006581 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582
Bram Moolenaar238a5642006-02-21 22:12:05 +00006583 When the option starts with "%!" then it is used as an expression,
6584 evaluated and the result is used as the option value. Example: >
6585 :set statusline=%!MyStatusLine()
6586< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006587 Note that the "%!" expression is evaluated in the context of the
6588 current window and buffer, while %{} items are evaluated in the
6589 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006590
6591 When there is error while evaluating the option then it will be made
6592 empty to avoid further errors. Otherwise screen updating would loop.
6593
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 Note that the only effect of 'ruler' when this option is set (and
6595 'laststatus' is 2) is controlling the output of |CTRL-G|.
6596
6597 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006598 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006600 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 minwid Minimum width of the item, padding as set by '-' & '0'.
6602 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006603 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 on the left for text items. Numeric items will be
6605 shifted down to maxwid-2 digits followed by '>'number
6606 where number is the amount of missing digits, much like
6607 an exponential notation.
6608 item A one letter code as described below.
6609
6610 Following is a description of the possible statusline items. The
6611 second character in "item" is the type:
6612 N for number
6613 S for string
6614 F for flags as described below
6615 - not applicable
6616
6617 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006618 f S Path to the file in the buffer, as typed or relative to current
6619 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 F S Full path to the file in the buffer.
6621 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006622 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006623 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006624 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006625 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006626 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006628 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006629 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006630 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006631 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6632 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006633 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006634 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6635 being used: "<keymap>"
6636 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006637 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638 B N As above, in hexadecimal.
6639 o N Byte number in file of byte under cursor, first byte is 1.
6640 Mnemonic: Offset from start of file (with one added)
6641 {not available when compiled without |+byte_offset| feature}
6642 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006643 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 l N Line number.
6645 L N Number of lines in buffer.
6646 c N Column number.
6647 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006648 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006649 p N Percentage through file in lines as in |CTRL-G|.
6650 P S Percentage through file of displayed window. This is like the
6651 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006652 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006654 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006655 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 ( - Start of item group. Can be used for setting the width and
6657 alignment of a section. Must be followed by %) somewhere.
6658 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006659 T N For 'tabline': start of tab page N label. Use %T after the last
6660 label. This information is used for mouse clicks.
6661 X N For 'tabline': start of close tab N label. Use %X after the
6662 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6663 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 < - Where to truncate line if too long. Default is at the start.
6665 No width fields allowed.
6666 = - Separation point between left and right aligned items.
6667 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006668 # - Set highlight group. The name must follow and then a # again.
6669 Thus use %#HLname# for highlight group HLname. The same
6670 highlighting is used, also for the statusline of non-current
6671 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006673 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 The difference between User{N} and StatusLine will be applied
6675 to StatusLineNC for the statusline of non-current windows.
6676 The number N must be between 1 and 9. See |hl-User1..9|
6677
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006678 When displaying a flag, Vim removes the leading comma, if any, when
6679 that flag comes right after plaintext. This will make a nice display
6680 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006681
Bram Moolenaar582fd852005-03-28 20:58:01 +00006682 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 not set) and a minwid is not set for the group, the whole group will
6684 become empty. This will make a group like the following disappear
6685 completely from the statusline when none of the flags are set. >
6686 :set statusline=...%(\ [%M%R%H]%)...
6687<
6688 Beware that an expression is evaluated each and every time the status
6689 line is displayed. The current buffer and current window will be set
6690 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006691 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006693 real current buffer.
6694
6695 The 'statusline' option may be evaluated in the |sandbox|, see
6696 |sandbox-option|.
6697
6698 It is not allowed to change text or jump to another window while
6699 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006700
6701 If the statusline is not updated when you want it (e.g., after setting
6702 a variable that's used in an expression), you can force an update by
6703 setting an option without changing its value. Example: >
6704 :let &ro = &ro
6705
6706< A result of all digits is regarded a number for display purposes.
6707 Otherwise the result is taken as flag text and applied to the rules
6708 described above.
6709
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006710 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6712 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6713
6714 Examples:
6715 Emulate standard status line with 'ruler' set >
6716 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6717< Similar, but add ASCII value of char under the cursor (like "ga") >
6718 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6719< Display byte count and byte value, modified flag in red. >
6720 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6721 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6722< Display a ,GZ flag if a compressed file is loaded >
6723 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6724< In the |:autocmd|'s: >
6725 :let b:gzflag = 1
6726< And: >
6727 :unlet b:gzflag
6728< And define this function: >
6729 :function VarExists(var, val)
6730 : if exists(a:var) | return a:val | else | return '' | endif
6731 :endfunction
6732<
6733 *'suffixes'* *'su'*
6734'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6735 global
6736 {not in Vi}
6737 Files with these suffixes get a lower priority when multiple files
6738 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 suffixes. Spaces after the comma are ignored. A dot is also seen as
6740 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 separator, precede it with a backslash (see |option-backslash| about
6742 including spaces and backslashes).
6743 See 'wildignore' for completely ignoring files.
6744 The use of |:set+=| and |:set-=| is preferred when adding or removing
6745 suffixes from the list. This avoids problems when a future version
6746 uses another default.
6747
6748 *'suffixesadd'* *'sua'*
6749'suffixesadd' 'sua' string (default "")
6750 local to buffer
6751 {not in Vi}
6752 {not available when compiled without the
6753 |+file_in_path| feature}
6754 Comma separated list of suffixes, which are used when searching for a
6755 file for the "gf", "[I", etc. commands. Example: >
6756 :set suffixesadd=.java
6757<
6758 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6759'swapfile' 'swf' boolean (default on)
6760 local to buffer
6761 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006762 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 swapfile is not wanted for a specific buffer. For example, with
6764 confidential information that even root must not be able to access.
6765 Careful: All text will be in memory:
6766 - Don't use this for big files.
6767 - Recovery will be impossible!
6768 A swapfile will only be present when |'updatecount'| is non-zero and
6769 'swapfile' is set.
6770 When 'swapfile' is reset, the swap file for the current buffer is
6771 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6772 non-zero, a swap file is immediately created.
6773 Also see |swap-file| and |'swapsync'|.
6774
6775 This option is used together with 'bufhidden' and 'buftype' to
6776 specify special kinds of buffers. See |special-buffers|.
6777
6778 *'swapsync'* *'sws'*
6779'swapsync' 'sws' string (default "fsync")
6780 global
6781 {not in Vi}
6782 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006783 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 When this option is empty parts of the swap file may be in memory and
6785 not written to disk. When the system crashes you may lose more work.
6786 On Unix the system does a sync now and then without Vim asking for it,
6787 so the disadvantage of setting this option off is small. On some
6788 systems the swap file will not be written at all. For a unix system
6789 setting it to "sync" will use the sync() call instead of the default
6790 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006791 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006792
6793 *'switchbuf'* *'swb'*
6794'switchbuf' 'swb' string (default "")
6795 global
6796 {not in Vi}
6797 This option controls the behavior when switching between buffers.
6798 Possible values (comma separated list):
6799 useopen If included, jump to the first open window that
6800 contains the specified buffer (if there is one).
6801 Otherwise: Do not examine other windows.
6802 This setting is checked with |quickfix| commands, when
6803 jumping to errors (":cc", ":cn", "cp", etc.). It is
6804 also used in all buffer related split commands, for
6805 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006806 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006807 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006809 a buffer for a |quickfix| command that display errors.
6810 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006811 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006812 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006813
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006814 *'synmaxcol'* *'smc'*
6815'synmaxcol' 'smc' number (default 3000)
6816 local to buffer
6817 {not in Vi}
6818 {not available when compiled without the |+syntax|
6819 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006820 Maximum column in which to search for syntax items. In long lines the
6821 text after this column is not highlighted and following lines may not
6822 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006823 This helps to avoid very slow redrawing for an XML file that is one
6824 long line.
6825 Set to zero to remove the limit.
6826
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 *'syntax'* *'syn'*
6828'syntax' 'syn' string (default empty)
6829 local to buffer
6830 {not in Vi}
6831 {not available when compiled without the |+syntax|
6832 feature}
6833 When this option is set, the syntax with this name is loaded, unless
6834 syntax highlighting has been switched off with ":syntax off".
6835 Otherwise this option does not always reflect the current syntax (the
6836 b:current_syntax variable does).
6837 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006838 not automatically recognized. Example, in an IDL file:
6839 /* vim: set syntax=idl : */ ~
6840 When a dot appears in the value then this separates two filetype
6841 names. Example:
6842 /* vim: set syntax=c.doxygen : */ ~
6843 This will use the "c" syntax first, then the "doxygen" syntax.
6844 Note that the second one must be prepared to be loaded as an addition,
6845 otherwise it will be skipped. More than one dot may appear.
6846 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006847 :set syntax=OFF
6848< To switch syntax highlighting on according to the current value of the
6849 'filetype' option: >
6850 :set syntax=ON
6851< What actually happens when setting the 'syntax' option is that the
6852 Syntax autocommand event is triggered with the value as argument.
6853 This option is not copied to another buffer, independent of the 's' or
6854 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006855 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006857 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006858'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006859 global
6860 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006861 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006862 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006863 When nonempty, this option determines the content of the tab pages
6864 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006865 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006866
6867 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006868 option and only when there is no GUI tab line. When 'e' is in
6869 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006870 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006871
6872 The value is evaluated like with 'statusline'. You can use
6873 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006874 the text to be displayed. Use "%1T" for the first label, "%2T" for
6875 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006876
6877 Keep in mind that only one of the tab pages is the current one, others
6878 are invisible and you can't jump to their windows.
6879
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006880
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006881 *'tabpagemax'* *'tpm'*
6882'tabpagemax' 'tpm' number (default 10)
6883 global
6884 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006885 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006886 feature}
6887 Maximum number of tab pages to be opened by the |-p| command line
6888 argument or the ":tab all" command. |tabpage|
6889
6890
6891 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892'tabstop' 'ts' number (default 8)
6893 local to buffer
6894 Number of spaces that a <Tab> in the file counts for. Also see
6895 |:retab| command, and 'softtabstop' option.
6896
6897 Note: Setting 'tabstop' to any other value than 8 can make your file
6898 appear wrong in many places (e.g., when printing it).
6899
6900 There are four main ways to use tabs in Vim:
6901 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6902 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006903 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006904 behave like a tab appears every 4 (or 3) characters.
6905 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6906 'expandtab'. This way you will always insert spaces. The
6907 formatting will never be messed up when 'tabstop' is changed.
6908 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006909 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 works when using Vim to edit the file.
6911 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6912 'noexpandtab'. This should then work (for initial indents only)
6913 for any tabstop setting that people use. It might be nice to have
6914 tabs after the first non-blank inserted as spaces if you do this
6915 though. Otherwise aligned comments will be wrong when 'tabstop' is
6916 changed.
6917
6918 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6919'tagbsearch' 'tbs' boolean (default on)
6920 global
6921 {not in Vi}
6922 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006923 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 searching makes searching for a tag a LOT faster, but a linear search
6925 will find more tags if the tags file wasn't properly sorted.
6926 Vim normally assumes that your tags files are sorted, or indicate that
6927 they are not sorted. Only when this is not the case does the
6928 'tagbsearch' option need to be switched off.
6929
6930 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006931 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006932 certain files, or retry all files with a linear search. When
6933 'tagbsearch' is off, only a linear search is done.
6934
6935 Linear searching is done anyway, for one file, when Vim finds a line
6936 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006937 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938< [The whitespace before and after the '0' must be a single <Tab>]
6939
6940 When a binary search was done and no match was found in any of the
6941 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6942 instead of a normal tag name, a retry is done with a linear search.
6943 Tags in unsorted tags files, and matches with different case will only
6944 be found in the retry.
6945
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006946 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 linear search can be avoided for the 'ignorecase' case. Use a value
6948 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6949 case-fold sorted with the -f switch to "sort" in most unices, as in
6950 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006951 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6952 for this as well. Note that case must be folded to uppercase for this
6953 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006954
6955 When 'tagbsearch' is off, tags searching is slower when a full match
6956 exists, but faster when no full match exists. Tags in unsorted tags
6957 files may only be found with 'tagbsearch' off.
6958 When the tags file is not sorted, or sorted in a wrong way (not on
6959 ASCII byte value), 'tagbsearch' should be off, or the line given above
6960 must be included in the tags file.
6961 This option doesn't affect commands that find all matching tags (e.g.,
6962 command-line completion and ":help").
6963 {Vi: always uses binary search in some versions}
6964
6965 *'taglength'* *'tl'*
6966'taglength' 'tl' number (default 0)
6967 global
6968 If non-zero, tags are significant up to this number of characters.
6969
6970 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6971'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6972 global
6973 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006974 If on and using a tags file in another directory, file names in that
6975 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006976 NOTE: This option is set to the Vi default value when 'compatible' is
6977 set and to the Vim default value when 'compatible' is reset.
6978
6979 *'tags'* *'tag'* *E433*
6980'tags' 'tag' string (default "./tags,tags", when compiled with
6981 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6982 global or local to buffer |global-local|
6983 Filenames for the tag command, separated by spaces or commas. To
6984 include a space or comma in a file name, precede it with a backslash
6985 (see |option-backslash| about including spaces and backslashes).
6986 When a file name starts with "./", the '.' is replaced with the path
6987 of the current file. But only when the 'd' flag is not included in
6988 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6989 |tags-option|.
6990 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006991 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6992 find all files named "tags" below "/lib". The filename itself cannot
6993 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6994 files called "tags?". {not available when compiled without the
6995 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006996 The |tagfiles()| function can be used to get a list of the file names
6997 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6999 files are also supported. They are automatically recognized. The
7000 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7001 differences are ignored (MS-Windows). |emacs-tags|
7002 The use of |:set+=| and |:set-=| is preferred when adding or removing
7003 file names from the list. This avoids problems when a future version
7004 uses another default.
7005 {Vi: default is "tags /usr/lib/tags"}
7006
7007 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7008'tagstack' 'tgst' boolean (default on)
7009 global
7010 {not in all versions of Vi}
7011 When on, the |tagstack| is used normally. When off, a ":tag" or
7012 ":tselect" command with an argument will not push the tag onto the
7013 tagstack. A following ":tag" without an argument, a ":pop" command or
7014 any other command that uses the tagstack will use the unmodified
7015 tagstack, but does change the pointer to the active entry.
7016 Resetting this option is useful when using a ":tag" command in a
7017 mapping which should not change the tagstack.
7018
7019 *'term'* *E529* *E530* *E531*
7020'term' string (default is $TERM, if that fails:
7021 in the GUI: "builtin_gui"
7022 on Amiga: "amiga"
7023 on BeOS: "beos-ansi"
7024 on Mac: "mac-ansi"
7025 on MiNT: "vt52"
7026 on MS-DOS: "pcterm"
7027 on OS/2: "os2ansi"
7028 on Unix: "ansi"
7029 on VMS: "ansi"
7030 on Win 32: "win32")
7031 global
7032 Name of the terminal. Used for choosing the terminal control
7033 characters. Environment variables are expanded |:set_env|.
7034 For example: >
7035 :set term=$TERM
7036< See |termcap|.
7037
7038 *'termbidi'* *'tbidi'*
7039 *'notermbidi'* *'notbidi'*
7040'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7041 global
7042 {not in Vi}
7043 {only available when compiled with the |+arabic|
7044 feature}
7045 The terminal is in charge of Bi-directionality of text (as specified
7046 by Unicode). The terminal is also expected to do the required shaping
7047 that some languages (such as Arabic) require.
7048 Setting this option implies that 'rightleft' will not be set when
7049 'arabic' is set and the value of 'arabicshape' will be ignored.
7050 Note that setting 'termbidi' has the immediate effect that
7051 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7052 This option is reset when the GUI is started.
7053 For further details see |arabic.txt|.
7054
7055 *'termencoding'* *'tenc'*
7056'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7057 Macintosh GUI: "macroman")
7058 global
7059 {only available when compiled with the |+multi_byte|
7060 feature}
7061 {not in Vi}
7062 Encoding used for the terminal. This specifies what character
7063 encoding the keyboard produces and the display will understand. For
7064 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007065 display). Except for the Mac when 'macatsui' is off, then
7066 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007067 In the Win32 console version the default value is the console codepage
7068 when it differs from the ANSI codepage.
7069 *E617*
7070 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7071 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7072 Any attempts to set a different value will be rejected, and an error
7073 message is shown.
7074 For the Win32 GUI 'termencoding' is not used for typed characters,
7075 because the Win32 system always passes Unicode characters.
7076 When empty, the same encoding is used as for the 'encoding' option.
7077 This is the normal value.
7078 Not all combinations for 'termencoding' and 'encoding' are valid. See
7079 |encoding-table|.
7080 The value for this option must be supported by internal conversions or
7081 iconv(). When this is not possible no conversion will be done and you
7082 will probably experience problems with non-ASCII characters.
7083 Example: You are working with the locale set to euc-jp (Japanese) and
7084 want to edit a UTF-8 file: >
7085 :let &termencoding = &encoding
7086 :set encoding=utf-8
7087< You need to do this when your system has no locale support for UTF-8.
7088
7089 *'terse'* *'noterse'*
7090'terse' boolean (default off)
7091 global
7092 When set: Add 's' flag to 'shortmess' option (this makes the message
7093 for a search that hits the start or end of the file not being
7094 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7095 shortens a lot of messages}
7096
7097 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7098'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7099 global
7100 {not in Vi}
7101 This option is obsolete. Use 'fileformats'.
7102 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7103 set to the default value for the current system. When 'textauto' is
7104 reset, 'fileformats' is made empty.
7105 NOTE: This option is set to the Vi default value when 'compatible' is
7106 set and to the Vim default value when 'compatible' is reset.
7107
7108 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7109'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7110 others: default off)
7111 local to buffer
7112 {not in Vi}
7113 This option is obsolete. Use 'fileformat'.
7114 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7115 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7116 "unix".
7117
7118 *'textwidth'* *'tw'*
7119'textwidth' 'tw' number (default 0)
7120 local to buffer
7121 {not in Vi}
7122 Maximum width of text that is being inserted. A longer line will be
7123 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007124 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7125 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007126 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007127 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007128 NOTE: This option is set to 0 when 'compatible' is set.
7129
7130 *'thesaurus'* *'tsr'*
7131'thesaurus' 'tsr' string (default "")
7132 global or local to buffer |global-local|
7133 {not in Vi}
7134 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007135 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007136 the file should contain words with similar meaning, separated by
7137 non-keyword characters (white space is preferred). Maximum line
7138 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007139 To obtain a file to be used here, check out this ftp site:
7140 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007141 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 after a comma are ignored, otherwise spaces are included in the file
7143 name. See |option-backslash| about using backslashes.
7144 The use of |:set+=| and |:set-=| is preferred when adding or removing
7145 directories from the list. This avoids problems when a future version
7146 uses another default.
7147 Backticks cannot be used in this option for security reasons.
7148
7149 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7150'tildeop' 'top' boolean (default off)
7151 global
7152 {not in Vi}
7153 When on: The tilde command "~" behaves like an operator.
7154 NOTE: This option is reset when 'compatible' is set.
7155
7156 *'timeout'* *'to'* *'notimeout'* *'noto'*
7157'timeout' 'to' boolean (default on)
7158 global
7159 *'ttimeout'* *'nottimeout'*
7160'ttimeout' boolean (default off)
7161 global
7162 {not in Vi}
7163 These two options together determine the behavior when part of a
7164 mapped key sequence or keyboard code has been received:
7165
7166 'timeout' 'ttimeout' action ~
7167 off off do not time out
7168 on on or off time out on :mappings and key codes
7169 off on time out on key codes
7170
7171 If both options are off, Vim will wait until either the complete
7172 mapping or key sequence has been received, or it is clear that there
7173 is no mapping or key sequence for the received characters. For
7174 example: if you have mapped "vl" and Vim has received 'v', the next
7175 character is needed to see if the 'v' is followed by an 'l'.
7176 When one of the options is on, Vim will wait for about 1 second for
7177 the next character to arrive. After that the already received
7178 characters are interpreted as single characters. The waiting time can
7179 be changed with the 'timeoutlen' option.
7180 On slow terminals or very busy systems timing out may cause
7181 malfunctioning cursor keys. If both options are off, Vim waits
7182 forever after an entered <Esc> if there are key codes that start
7183 with <Esc>. You will have to type <Esc> twice. If you do not have
7184 problems with key codes, but would like to have :mapped key
7185 sequences not timing out in 1 second, set the 'ttimeout' option and
7186 reset the 'timeout' option.
7187
7188 NOTE: 'ttimeout' is reset when 'compatible' is set.
7189
7190 *'timeoutlen'* *'tm'*
7191'timeoutlen' 'tm' number (default 1000)
7192 global
7193 {not in all versions of Vi}
7194 *'ttimeoutlen'* *'ttm'*
7195'ttimeoutlen' 'ttm' number (default -1)
7196 global
7197 {not in Vi}
7198 The time in milliseconds that is waited for a key code or mapped key
7199 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7200 when part of a command has been typed.
7201 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7202 different timeout value for key codes is desired set 'ttimeoutlen' to
7203 a non-negative number.
7204
7205 ttimeoutlen mapping delay key code delay ~
7206 < 0 'timeoutlen' 'timeoutlen'
7207 >= 0 'timeoutlen' 'ttimeoutlen'
7208
7209 The timeout only happens when the 'timeout' and 'ttimeout' options
7210 tell so. A useful setting would be >
7211 :set timeout timeoutlen=3000 ttimeoutlen=100
7212< (time out on mapping after three seconds, time out on key codes after
7213 a tenth of a second).
7214
7215 *'title'* *'notitle'*
7216'title' boolean (default off, on when title can be restored)
7217 global
7218 {not in Vi}
7219 {not available when compiled without the |+title|
7220 feature}
7221 When on, the title of the window will be set to the value of
7222 'titlestring' (if it is not empty), or to:
7223 filename [+=-] (path) - VIM
7224 Where:
7225 filename the name of the file being edited
7226 - indicates the file cannot be modified, 'ma' off
7227 + indicates the file was modified
7228 = indicates the file is read-only
7229 =+ indicates the file is read-only and modified
7230 (path) is the path of the file being edited
7231 - VIM the server name |v:servername| or "VIM"
7232 Only works if the terminal supports setting window titles
7233 (currently Amiga console, Win32 console, all GUI versions and
7234 terminals with a non- empty 't_ts' option - these are Unix xterm and
7235 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7236 *X11*
7237 When Vim was compiled with HAVE_X11 defined, the original title will
7238 be restored if possible. The output of ":version" will include "+X11"
7239 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7240 works for the icon name |'icon'|.
7241 But: When Vim was started with the |-X| argument, restoring the title
7242 will not work (except in the GUI).
7243 If the title cannot be restored, it is set to the value of 'titleold'.
7244 You might want to restore the title outside of Vim then.
7245 When using an xterm from a remote machine you can use this command:
7246 rsh machine_name xterm -display $DISPLAY &
7247 then the WINDOWID environment variable should be inherited and the
7248 title of the window should change back to what it should be after
7249 exiting Vim.
7250
7251 *'titlelen'*
7252'titlelen' number (default 85)
7253 global
7254 {not in Vi}
7255 {not available when compiled without the |+title|
7256 feature}
7257 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007258 title. When the title is longer, only the end of the path name is
7259 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007260 Using a percentage makes this adapt to the width of the window. But
7261 it won't work perfectly, because the actual number of characters
7262 available also depends on the font used and other things in the title
7263 bar. When 'titlelen' is zero the full path is used. Otherwise,
7264 values from 1 to 30000 percent can be used.
7265 'titlelen' is also used for the 'titlestring' option.
7266
7267 *'titleold'*
7268'titleold' string (default "Thanks for flying Vim")
7269 global
7270 {not in Vi}
7271 {only available when compiled with the |+title|
7272 feature}
7273 This option will be used for the window title when exiting Vim if the
7274 original title cannot be restored. Only happens if 'title' is on or
7275 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007276 This option cannot be set from a |modeline| or in the |sandbox|, for
7277 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007278 *'titlestring'*
7279'titlestring' string (default "")
7280 global
7281 {not in Vi}
7282 {not available when compiled without the |+title|
7283 feature}
7284 When this option is not empty, it will be used for the title of the
7285 window. This happens only when the 'title' option is on.
7286 Only works if the terminal supports setting window titles (currently
7287 Amiga console, Win32 console, all GUI versions and terminals with a
7288 non-empty 't_ts' option).
7289 When Vim was compiled with HAVE_X11 defined, the original title will
7290 be restored if possible |X11|.
7291 When this option contains printf-style '%' items, they will be
7292 expanded according to the rules used for 'statusline'.
7293 Example: >
7294 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7295 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7296< The value of 'titlelen' is used to align items in the middle or right
7297 of the available space.
7298 Some people prefer to have the file name first: >
7299 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7300< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007301 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 separating space only when needed.
7303 NOTE: Use of special characters in 'titlestring' may cause the display
7304 to be garbled (e.g., when it contains a CR or NL character).
7305 {not available when compiled without the |+statusline| feature}
7306
7307 *'toolbar'* *'tb'*
7308'toolbar' 'tb' string (default "icons,tooltips")
7309 global
7310 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7311 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007312 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 possible values are:
7314 icons Toolbar buttons are shown with icons.
7315 text Toolbar buttons shown with text.
7316 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007317 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007318 tooltips Tooltips are active for toolbar buttons.
7319 Tooltips refer to the popup help text which appears after the mouse
7320 cursor is placed over a toolbar button for a brief moment.
7321
7322 If you want the toolbar to be shown with icons as well as text, do the
7323 following: >
7324 :set tb=icons,text
7325< Motif and Athena cannot display icons and text at the same time. They
7326 will show icons if both are requested.
7327
7328 If none of the strings specified in 'toolbar' are valid or if
7329 'toolbar' is empty, this option is ignored. If you want to disable
7330 the toolbar, you need to set the 'guioptions' option. For example: >
7331 :set guioptions-=T
7332< Also see |gui-toolbar|.
7333
7334 *'toolbariconsize'* *'tbis'*
7335'toolbariconsize' 'tbis' string (default "small")
7336 global
7337 {not in Vi}
7338 {only in the GTK+ 2 GUI}
7339 Controls the size of toolbar icons. The possible values are:
7340 tiny Use tiny toolbar icons.
7341 small Use small toolbar icons (default).
7342 medium Use medium-sized toolbar icons.
7343 large Use large toolbar icons.
7344 The exact dimensions in pixels of the various icon sizes depend on
7345 the current theme. Common dimensions are large=32x32, medium=24x24,
7346 small=20x20 and tiny=16x16.
7347
7348 If 'toolbariconsize' is empty, the global default size as determined
7349 by user preferences or the current theme is used.
7350
7351 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7352'ttybuiltin' 'tbi' boolean (default on)
7353 global
7354 {not in Vi}
7355 When on, the builtin termcaps are searched before the external ones.
7356 When off the builtin termcaps are searched after the external ones.
7357 When this option is changed, you should set the 'term' option next for
7358 the change to take effect, for example: >
7359 :set notbi term=$TERM
7360< See also |termcap|.
7361 Rationale: The default for this option is "on", because the builtin
7362 termcap entries are generally better (many systems contain faulty
7363 xterm entries...).
7364
7365 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7366'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7367 sun-cmd, screen, rxvt, dtterm or
7368 iris-ansi; also on when running Vim in
7369 a DOS console)
7370 global
7371 {not in Vi}
7372 Indicates a fast terminal connection. More characters will be sent to
7373 the screen for redrawing, instead of using insert/delete line
7374 commands. Improves smoothness of redrawing when there are multiple
7375 windows and the terminal does not support a scrolling region.
7376 Also enables the extra writing of characters at the end of each screen
7377 line for lines that wrap. This helps when using copy/paste with the
7378 mouse in an xterm and other terminals.
7379
7380 *'ttymouse'* *'ttym'*
7381'ttymouse' 'ttym' string (default depends on 'term')
7382 global
7383 {not in Vi}
7384 {only in Unix and VMS, doesn't work in the GUI; not
7385 available when compiled without |+mouse|}
7386 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007387 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 *xterm-mouse*
7389 xterm xterm-like mouse handling. The mouse generates
7390 "<Esc>[Mscr", where "scr" is three bytes:
7391 "s" = button state
7392 "c" = column plus 33
7393 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007394 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007395 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 xterm2 Works like "xterm", but with the xterm reporting the
7397 mouse position while the mouse is dragged. This works
7398 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007399 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 work. See below for how Vim detects this
7401 automatically.
7402 *netterm-mouse*
7403 netterm NetTerm mouse handling. The mouse generates
7404 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7405 for the row and column.
7406 *dec-mouse*
7407 dec DEC terminal mouse handling. The mouse generates a
7408 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007409 This is also available for an Xterm, if it was
7410 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 *jsbterm-mouse*
7412 jsbterm JSB term mouse handling.
7413 *pterm-mouse*
7414 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007415 *urxvt-mouse*
7416 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007417
7418 The mouse handling must be enabled at compile time |+mouse_xterm|
7419 |+mouse_dec| |+mouse_netterm|.
7420 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7421 recognized, if enabled at compile time. DEC terminal mouse codes
7422 are recognized if enabled at compile time, and 'ttymouse' is not
7423 "xterm" (because the xterm and dec mouse codes conflict).
7424 This option is automatically set to "xterm", when the 'term' option is
7425 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7426 or "xterm2" already. The main use of this option is to set it to
7427 "xterm", when the terminal name doesn't start with "xterm", but it can
7428 handle xterm mouse codes.
7429 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007430 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 feature and if |t_RV| is set to the escape sequence to request the
7432 xterm version number. Otherwise "xterm2" must be set explicitly.
7433 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7434 t_RV to an empty string: >
7435 :set t_RV=
7436<
7437 *'ttyscroll'* *'tsl'*
7438'ttyscroll' 'tsl' number (default 999)
7439 global
7440 Maximum number of lines to scroll the screen. If there are more lines
7441 to scroll the window is redrawn. For terminals where scrolling is
7442 very slow and redrawing is not slow this can be set to a small number,
7443 e.g., 3, to speed up displaying.
7444
7445 *'ttytype'* *'tty'*
7446'ttytype' 'tty' string (default from $TERM)
7447 global
7448 Alias for 'term', see above.
7449
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007450 *'undodir'* *'udir'*
7451'undodir' 'udir' string (default ".")
7452 global
7453 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007454 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007455 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007456 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007457 "." means using the directory of the file. The undo file name for
7458 "file.txt" is ".file.txt.un~".
7459 For other directories the file name is the full path of the edited
7460 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007461 When writing: The first directory that exists is used. "." always
7462 works, no directories after "." will be used for writing.
7463 When reading all entries are tried to find an undo file. The first
7464 undo file that exists is used. When it cannot be read an error is
7465 given, no further entry is used.
7466 See |undo-persistence|.
7467
7468 *'undofile'* *'udf'*
7469'undofile' 'udf' boolean (default off)
7470 local to buffer
7471 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007472 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007473 When on, Vim automatically saves undo history to an undo file when
7474 writing a buffer to a file, and restores undo history from the same
7475 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007476 The directory where the undo file is stored is specified by 'undodir'.
7477 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007478 The undo file is not read when 'undoreload' causes the buffer from
7479 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007480 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007481
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 *'undolevels'* *'ul'*
7483'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7484 Win32 and OS/2)
7485 global
7486 {not in Vi}
7487 Maximum number of changes that can be undone. Since undo information
7488 is kept in memory, higher numbers will cause more memory to be used
7489 (nevertheless, a single change can use an unlimited amount of memory).
7490 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7491 itself: >
7492 set ul=0
7493< But you can also get Vi compatibility by including the 'u' flag in
7494 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007495 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 Set to a negative number for no undo at all: >
7497 set ul=-1
7498< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007499 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007500
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007501 *'undoreload'* *'ur'*
7502'undoreload' 'ur' number (default 10000)
7503 global
7504 {not in Vi}
7505 Save the whole buffer for undo when reloading it. This applies to the
7506 ":e!" command and reloading for when the buffer changed outside of
7507 Vim. |FileChangedShell|
7508 The save only happens when this options is negative or when the number
7509 of lines is smaller than the value of this option.
7510 Set this option to zero to disable undo for a reload.
7511
7512 When saving undo for a reload, any undo file is not read.
7513
7514 Note that this causes the whole buffer to be stored in memory. Set
7515 this option to a lower value if you run out of memory.
7516
Bram Moolenaar071d4272004-06-13 20:20:40 +00007517 *'updatecount'* *'uc'*
7518'updatecount' 'uc' number (default: 200)
7519 global
7520 {not in Vi}
7521 After typing this many characters the swap file will be written to
7522 disk. When zero, no swap file will be created at all (see chapter on
7523 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7524 Vim with the "-n" option, see |startup|. When editing in readonly
7525 mode this option will be initialized to 10000.
7526 The swapfile can be disabled per buffer with |'swapfile'|.
7527 When 'updatecount' is set from zero to non-zero, swap files are
7528 created for all buffers that have 'swapfile' set. When 'updatecount'
7529 is set to zero, existing swap files are not deleted.
7530 Also see |'swapsync'|.
7531 This option has no meaning in buffers where |'buftype'| is "nofile"
7532 or "nowrite".
7533
7534 *'updatetime'* *'ut'*
7535'updatetime' 'ut' number (default 4000)
7536 global
7537 {not in Vi}
7538 If this many milliseconds nothing is typed the swap file will be
7539 written to disk (see |crash-recovery|). Also used for the
7540 |CursorHold| autocommand event.
7541
7542 *'verbose'* *'vbs'*
7543'verbose' 'vbs' number (default 0)
7544 global
7545 {not in Vi, although some versions have a boolean
7546 verbose option}
7547 When bigger than zero, Vim will give messages about what it is doing.
7548 Currently, these messages are given:
7549 >= 1 When the viminfo file is read or written.
7550 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007551 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007552 >= 8 Files for which a group of autocommands is executed.
7553 >= 9 Every executed autocommand.
7554 >= 12 Every executed function.
7555 >= 13 When an exception is thrown, caught, finished, or discarded.
7556 >= 14 Anything pending in a ":finally" clause.
7557 >= 15 Every executed Ex command (truncated at 200 characters).
7558
7559 This option can also be set with the "-V" argument. See |-V|.
7560 This option is also set by the |:verbose| command.
7561
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007562 When the 'verbosefile' option is set then the verbose messages are not
7563 displayed.
7564
7565 *'verbosefile'* *'vfile'*
7566'verbosefile' 'vfile' string (default empty)
7567 global
7568 {not in Vi}
7569 When not empty all messages are written in a file with this name.
7570 When the file exists messages are appended.
7571 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007572 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007573 Setting 'verbosefile' to a new value is like making it empty first.
7574 The difference with |:redir| is that verbose messages are not
7575 displayed when 'verbosefile' is set.
7576
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 *'viewdir'* *'vdir'*
7578'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7579 "$VIM/vimfiles/view",
7580 for Unix: "~/.vim/view",
7581 for Macintosh: "$VIM:vimfiles:view"
7582 for VMS: "sys$login:vimfiles/view"
7583 for RiscOS: "Choices:vimfiles/view")
7584 global
7585 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007586 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007587 feature}
7588 Name of the directory where to store files for |:mkview|.
7589 This option cannot be set from a |modeline| or in the |sandbox|, for
7590 security reasons.
7591
7592 *'viewoptions'* *'vop'*
7593'viewoptions' 'vop' string (default: "folds,options,cursor")
7594 global
7595 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007596 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 feature}
7598 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007599 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 word save and restore ~
7601 cursor cursor position in file and in window
7602 folds manually created folds, opened/closed folds and local
7603 fold options
7604 options options and mappings local to a window or buffer (not
7605 global values for local options)
7606 slash backslashes in file names replaced with forward
7607 slashes
7608 unix with Unix end-of-line format (single <NL>), even when
7609 on Windows or DOS
7610
7611 "slash" and "unix" are useful on Windows when sharing view files
7612 with Unix. The Unix version of Vim cannot source dos format scripts,
7613 but the Windows version of Vim can source unix format scripts.
7614
7615 *'viminfo'* *'vi'* *E526* *E527* *E528*
7616'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007617 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7618 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7619 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007620 global
7621 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007622 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007623 feature}
7624 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007625 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007626 separated list of parameters, each consisting of a single character
7627 identifying the particular parameter, followed by a number or string
7628 which specifies the value of that parameter. If a particular
7629 character is left out, then the default value is used for that
7630 parameter. The following is a list of the identifying characters and
7631 the effect of their value.
7632 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007633 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 ! When included, save and restore global variables that start
7635 with an uppercase letter, and don't contain a lowercase
7636 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007637 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007638 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007639 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 " Maximum number of lines saved for each register. Old name of
7641 the '<' item, with the disadvantage that you need to put a
7642 backslash before the ", otherwise it will be recognized as the
7643 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007644 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 % When included, save and restore the buffer list. If Vim is
7646 started with a file name argument, the buffer list is not
7647 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007648 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 without a file name and buffers for help files are not written
7650 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007651 When followed by a number, the number specifies the maximum
7652 number of buffers that are stored. Without a number all
7653 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007654 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 ' Maximum number of previously edited files for which the marks
7656 are remembered. This parameter must always be included when
7657 'viminfo' is non-empty.
7658 Including this item also means that the |jumplist| and the
7659 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007660 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007661 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007662 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 patterns are also saved. When not included, the value of
7664 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007665 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007667 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007668 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 < Maximum number of lines saved for each register. If zero then
7670 registers are not saved. When not included, all lines are
7671 saved. '"' is the old name for this item.
7672 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007673 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007675 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007676 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007677 c When included, convert the text in the viminfo file from the
7678 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007679 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007680 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007681 f Whether file marks need to be stored. If zero, file marks ('0
7682 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007683 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007685 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 h Disable the effect of 'hlsearch' when loading the viminfo
7687 file. When not included, it depends on whether ":nohlsearch"
7688 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007689 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007690 n Name of the viminfo file. The name must immediately follow
7691 the 'n'. Must be the last one! If the "-i" argument was
7692 given when starting Vim, that file name overrides the one
7693 given here with 'viminfo'. Environment variables are expanded
7694 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007695 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 r Removable media. The argument is a string (up to the next
7697 ','). This parameter can be given several times. Each
7698 specifies the start of a path for which no marks will be
7699 stored. This is to avoid removable media. For MS-DOS you
7700 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7701 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7702 ignored. Maximum length of each 'r' argument is 50
7703 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007704 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 s Maximum size of an item in Kbyte. If zero then registers are
7706 not saved. Currently only applies to registers. The default
7707 "s10" will exclude registers with more than 10 Kbyte of text.
7708 Also see the '<' item above: line count limit.
7709
7710 Example: >
7711 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7712<
7713 '50 Marks will be remembered for the last 50 files you
7714 edited.
7715 <1000 Contents of registers (up to 1000 lines each) will be
7716 remembered.
7717 s100 Registers with more than 100 Kbyte text are skipped.
7718 :0 Command-line history will not be saved.
7719 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7720 no / Since '/' is not specified, the default will be used,
7721 that is, save all of the search history, and also the
7722 previous search and substitute patterns.
7723 no % The buffer list will not be saved nor read back.
7724 no h 'hlsearch' highlighting will be restored.
7725
7726 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7727 load the contents of the file, this is not done automatically.
7728
7729 This option cannot be set from a |modeline| or in the |sandbox|, for
7730 security reasons.
7731
7732 *'virtualedit'* *'ve'*
7733'virtualedit' 've' string (default "")
7734 global
7735 {not in Vi}
7736 {not available when compiled without the
7737 |+virtualedit| feature}
7738 A comma separated list of these words:
7739 block Allow virtual editing in Visual block mode.
7740 insert Allow virtual editing in Insert mode.
7741 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007742 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007743
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007745 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746 of the line. Useful for selecting a rectangle in Visual mode and
7747 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007748 "onemore" is not the same, it will only allow moving the cursor just
7749 after the last character of the line. This makes some commands more
7750 consistent. Previously the cursor was always past the end of the line
7751 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007752 break some plugins or Vim scripts. For example because |l| can move
7753 the cursor after the last character. Use with care!
7754 Using the |$| command will move to the last character in the line, not
7755 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007756 It doesn't make sense to combine "all" with "onemore", but you will
7757 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007758
7759 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7760'visualbell' 'vb' boolean (default off)
7761 global
7762 {not in Vi}
7763 Use visual bell instead of beeping. The terminal code to display the
7764 visual bell is given with 't_vb'. When no beep or flash is wanted,
7765 use ":set vb t_vb=".
7766 Note: When the GUI starts, 't_vb' is reset to its default value. You
7767 might want to set it again in your |gvimrc|.
7768 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7769 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7770 where 40 is the time in msec.
7771 Does not work on the Amiga, you always get a screen flash.
7772 Also see 'errorbells'.
7773
7774 *'warn'* *'nowarn'*
7775'warn' boolean (default on)
7776 global
7777 Give a warning message when a shell command is used while the buffer
7778 has been changed.
7779
7780 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7781'weirdinvert' 'wiv' boolean (default off)
7782 global
7783 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007784 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007785 It is provided for backwards compatibility with version 4.x.
7786 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7787 vice versa. Has no effect when the GUI is running.
7788
7789 *'whichwrap'* *'ww'*
7790'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7791 global
7792 {not in Vi}
7793 Allow specified keys that move the cursor left/right to move to the
7794 previous/next line when the cursor is on the first/last character in
7795 the line. Concatenate characters to allow this for these keys:
7796 char key mode ~
7797 b <BS> Normal and Visual
7798 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007799 h "h" Normal and Visual (not recommended)
7800 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007801 < <Left> Normal and Visual
7802 > <Right> Normal and Visual
7803 ~ "~" Normal
7804 [ <Left> Insert and Replace
7805 ] <Right> Insert and Replace
7806 For example: >
7807 :set ww=<,>,[,]
7808< allows wrap only when cursor keys are used.
7809 When the movement keys are used in combination with a delete or change
7810 operator, the <EOL> also counts for a character. This makes "3h"
7811 different from "3dh" when the cursor crosses the end of a line. This
7812 is also true for "x" and "X", because they do the same as "dl" and
7813 "dh". If you use this, you may also want to use the mapping
7814 ":map <BS> X" to make backspace delete the character in front of the
7815 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007816 When 'l' is included and it is used after an operator at the end of a
7817 line then it will not move to the next line. This makes "dl", "cl",
7818 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007819 NOTE: This option is set to the Vi default value when 'compatible' is
7820 set and to the Vim default value when 'compatible' is reset.
7821
7822 *'wildchar'* *'wc'*
7823'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7824 global
7825 {not in Vi}
7826 Character you have to type to start wildcard expansion in the
7827 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007828 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 The character is not recognized when used inside a macro. See
7830 'wildcharm' for that.
7831 Although 'wc' is a number option, you can set it to a special key: >
7832 :set wc=<Esc>
7833< NOTE: This option is set to the Vi default value when 'compatible' is
7834 set and to the Vim default value when 'compatible' is reset.
7835
7836 *'wildcharm'* *'wcm'*
7837'wildcharm' 'wcm' number (default: none (0))
7838 global
7839 {not in Vi}
7840 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007841 recognized when used inside a macro. You can find "spare" command-line
7842 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 you'll never actually type 'wildcharm', just use it in mappings that
7844 automatically invoke completion mode, e.g.: >
7845 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007846 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847< Then after typing :ss you can use CTRL-P & CTRL-N.
7848
7849 *'wildignore'* *'wig'*
7850'wildignore' 'wig' string (default "")
7851 global
7852 {not in Vi}
7853 {not available when compiled without the |+wildignore|
7854 feature}
7855 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007856 patterns is ignored when completing file or directory names, and
7857 influences the result of |expand()|, |glob()| and |globpath()| unless
7858 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007859 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7860 Also see 'suffixes'.
7861 Example: >
7862 :set wildignore=*.o,*.obj
7863< The use of |:set+=| and |:set-=| is preferred when adding or removing
7864 a pattern from the list. This avoids problems when a future version
7865 uses another default.
7866
Bram Moolenaar94950a92010-12-02 16:01:29 +01007867
Bram Moolenaar81af9252010-12-10 20:35:50 +01007868 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007869'wildignorecase' 'wic' boolean (default off)
7870 global
7871 {not in Vi}
7872 When set case is ignored when completing file names and directories.
7873 Has no effect on systems where file name case is generally ignored.
7874 Does not apply when the shell is used to expand wildcards, which
7875 happens when there are special characters.
7876
7877
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7879'wildmenu' 'wmnu' boolean (default off)
7880 global
7881 {not in Vi}
7882 {not available if compiled without the |+wildmenu|
7883 feature}
7884 When 'wildmenu' is on, command-line completion operates in an enhanced
7885 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7886 the possible matches are shown just above the command line, with the
7887 first match highlighted (overwriting the status line, if there is
7888 one). Keys that show the previous/next match, such as <Tab> or
7889 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7890 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7891 specified. "longest" and "list" do not start "wildmenu" mode.
7892 If there are more matches than can fit in the line, a ">" is shown on
7893 the right and/or a "<" is shown on the left. The status line scrolls
7894 as needed.
7895 The "wildmenu" mode is abandoned when a key is hit that is not used
7896 for selecting a completion.
7897 While the "wildmenu" is active the following keys have special
7898 meanings:
7899
7900 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7901 <Down> - in filename/menu name completion: move into a
7902 subdirectory or submenu.
7903 <CR> - in menu completion, when the cursor is just after a
7904 dot: move into a submenu.
7905 <Up> - in filename/menu name completion: move up into
7906 parent directory or parent menu.
7907
7908 This makes the menus accessible from the console |console-menus|.
7909
7910 If you prefer the <Left> and <Right> keys to move the cursor instead
7911 of selecting a different match, use this: >
7912 :cnoremap <Left> <Space><BS><Left>
7913 :cnoremap <Right> <Space><BS><Right>
7914<
7915 The "WildMenu" highlighting is used for displaying the current match
7916 |hl-WildMenu|.
7917
7918 *'wildmode'* *'wim'*
7919'wildmode' 'wim' string (Vim default: "full")
7920 global
7921 {not in Vi}
7922 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007923 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007924 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007925 first part specifies the behavior for the first use of 'wildchar',
7926 The second part for the second use, etc.
7927 These are the possible values for each part:
7928 "" Complete only the first match.
7929 "full" Complete the next full match. After the last match,
7930 the original string is used and then the first match
7931 again.
7932 "longest" Complete till longest common string. If this doesn't
7933 result in a longer string, use the next part.
7934 "longest:full" Like "longest", but also start 'wildmenu' if it is
7935 enabled.
7936 "list" When more than one match, list all matches.
7937 "list:full" When more than one match, list all matches and
7938 complete first match.
7939 "list:longest" When more than one match, list all matches and
7940 complete till longest common string.
7941 When there is only a single match, it is fully completed in all cases.
7942
7943 Examples: >
7944 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007945< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007946 :set wildmode=longest,full
7947< Complete longest common string, then each full match >
7948 :set wildmode=list:full
7949< List all matches and complete each full match >
7950 :set wildmode=list,full
7951< List all matches without completing, then each full match >
7952 :set wildmode=longest,list
7953< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007954 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007955
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007956 *'wildoptions'* *'wop'*
7957'wildoptions' 'wop' string (default "")
7958 global
7959 {not in Vi}
7960 {not available when compiled without the |+wildignore|
7961 feature}
7962 A list of words that change how command line completion is done.
7963 Currently only one word is allowed:
7964 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007965 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007966 is displayed per line. Often used tag kinds are:
7967 d #define
7968 f function
7969 Also see |cmdline-completion|.
7970
Bram Moolenaar071d4272004-06-13 20:20:40 +00007971 *'winaltkeys'* *'wak'*
7972'winaltkeys' 'wak' string (default "menu")
7973 global
7974 {not in Vi}
7975 {only used in Win32, Motif, GTK and Photon GUI}
7976 Some GUI versions allow the access to menu entries by using the ALT
7977 key in combination with a character that appears underlined in the
7978 menu. This conflicts with the use of the ALT key for mappings and
7979 entering special characters. This option tells what to do:
7980 no Don't use ALT keys for menus. ALT key combinations can be
7981 mapped, but there is no automatic handling. This can then be
7982 done with the |:simalt| command.
7983 yes ALT key handling is done by the windowing system. ALT key
7984 combinations cannot be mapped.
7985 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007986 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 keys can be mapped.
7988 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7989 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007990 This option is not used for <F10>; on Win32 and with GTK <F10> will
7991 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007992
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007993 *'window'* *'wi'*
7994'window' 'wi' number (default screen height - 1)
7995 global
7996 Window height. Do not confuse this with the height of the Vim window,
7997 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007998 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7999 value is smaller than 'lines' minus one. The screen will scroll
8000 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008001 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8002 in a much smarter way, taking care of wrapping lines.
8003 When resizing the Vim window, the value is smaller than 1 or more than
8004 or equal to 'lines' it will be set to 'lines' minus 1.
8005 {Vi also uses the option to specify the number of displayed lines}
8006
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 *'winheight'* *'wh'* *E591*
8008'winheight' 'wh' number (default 1)
8009 global
8010 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008011 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012 feature}
8013 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008014 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008015 focus goes to a window that is smaller, its size is increased, at the
8016 cost of the height of other windows.
8017 Set 'winheight' to a small number for normal editing.
8018 Set it to 999 to make the current window fill most of the screen.
8019 Other windows will be only 'winminheight' high. This has the drawback
8020 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8021 to create only two windows, set the option after startup is done,
8022 using the |VimEnter| event: >
8023 au VimEnter * set winheight=999
8024< Minimum value is 1.
8025 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008026 height of the current window.
8027 'winheight' applies to the current window. Use 'winminheight' to set
8028 the minimal height for other windows.
8029
8030 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8031'winfixheight' 'wfh' boolean (default off)
8032 local to window
8033 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008034 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 feature}
8036 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008037 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8038 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 The height may be changed anyway when running out of room.
8040
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008041 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8042'winfixwidth' 'wfw' boolean (default off)
8043 local to window
8044 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008045 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008046 feature}
8047 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008048 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008049 The width may be changed anyway when running out of room.
8050
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 *'winminheight'* *'wmh'*
8052'winminheight' 'wmh' number (default 1)
8053 global
8054 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008055 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 feature}
8057 The minimal height of a window, when it's not the current window.
8058 This is a hard minimum, windows will never become smaller.
8059 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8060 status bar) if necessary. They will return to at least one line when
8061 they become active (since the cursor has to have somewhere to go.)
8062 Use 'winheight' to set the minimal height of the current window.
8063 This option is only checked when making a window smaller. Don't use a
8064 large number, it will cause errors when opening more than a few
8065 windows. A value of 0 to 3 is reasonable.
8066
8067 *'winminwidth'* *'wmw'*
8068'winminwidth' 'wmw' number (default 1)
8069 global
8070 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008071 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008072 feature}
8073 The minimal width of a window, when it's not the current window.
8074 This is a hard minimum, windows will never become smaller.
8075 When set to zero, windows may be "squashed" to zero columns (i.e. just
8076 a vertical separator) if necessary. They will return to at least one
8077 line when they become active (since the cursor has to have somewhere
8078 to go.)
8079 Use 'winwidth' to set the minimal width of the current window.
8080 This option is only checked when making a window smaller. Don't use a
8081 large number, it will cause errors when opening more than a few
8082 windows. A value of 0 to 12 is reasonable.
8083
8084 *'winwidth'* *'wiw'* *E592*
8085'winwidth' 'wiw' number (default 20)
8086 global
8087 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008088 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 feature}
8090 Minimal number of columns for the current window. This is not a hard
8091 minimum, Vim will use fewer columns if there is not enough room. If
8092 the current window is smaller, its size is increased, at the cost of
8093 the width of other windows. Set it to 999 to make the current window
8094 always fill the screen. Set it to a small number for normal editing.
8095 The width is not adjusted after one of the commands to change the
8096 width of the current window.
8097 'winwidth' applies to the current window. Use 'winminwidth' to set
8098 the minimal width for other windows.
8099
8100 *'wrap'* *'nowrap'*
8101'wrap' boolean (default on)
8102 local to window
8103 {not in Vi}
8104 This option changes how text is displayed. It doesn't change the text
8105 in the buffer, see 'textwidth' for that.
8106 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008107 displaying continues on the next line. When off lines will not wrap
8108 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 moved to a part that is not shown, the screen will scroll
8110 horizontally.
8111 The line will be broken in the middle of a word if necessary. See
8112 'linebreak' to get the break at a word boundary.
8113 To make scrolling horizontally a bit more useful, try this: >
8114 :set sidescroll=5
8115 :set listchars+=precedes:<,extends:>
8116< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008117 This option can't be set from a |modeline| when the 'diff' option is
8118 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008119
8120 *'wrapmargin'* *'wm'*
8121'wrapmargin' 'wm' number (default 0)
8122 local to buffer
8123 Number of characters from the right window border where wrapping
8124 starts. When typing text beyond this limit, an <EOL> will be inserted
8125 and inserting continues on the next line.
8126 Options that add a margin, such as 'number' and 'foldcolumn', cause
8127 the text width to be further reduced. This is Vi compatible.
8128 When 'textwidth' is non-zero, this option is not used.
8129 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8130 and less usefully}
8131
8132 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8133'wrapscan' 'ws' boolean (default on) *E384* *E385*
8134 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008135 Searches wrap around the end of the file. Also applies to |]s| and
8136 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008137
8138 *'write'* *'nowrite'*
8139'write' boolean (default on)
8140 global
8141 {not in Vi}
8142 Allows writing files. When not set, writing a file is not allowed.
8143 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008144 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008145 argument. Filtering text is still possible, even though this requires
8146 writing a temporary file.
8147
8148 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8149'writeany' 'wa' boolean (default off)
8150 global
8151 Allows writing to any file with no need for "!" override.
8152
8153 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8154'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8155 otherwise)
8156 global
8157 {not in Vi}
8158 Make a backup before overwriting a file. The backup is removed after
8159 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008160 also on.
8161 WARNING: Switching this option off means that when Vim fails to write
8162 your buffer correctly and then, for whatever reason, Vim exits, you
8163 lose both the original file and what you were writing. Only reset
8164 this option if your file system is almost full and it makes the write
8165 fail (and make sure not to exit Vim until the write was successful).
8166 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 When the 'backupskip' pattern matches, a backup is not made anyway.
8168 NOTE: This option is set to the default value when 'compatible' is
8169 set.
8170
8171 *'writedelay'* *'wd'*
8172'writedelay' 'wd' number (default 0)
8173 global
8174 {not in Vi}
8175 The number of microseconds to wait for each character sent to the
8176 screen. When non-zero, characters are sent to the terminal one by
8177 one. For MS-DOS pcterm this does not work. For debugging purposes.
8178
8179 vim:tw=78:ts=8:ft=help:norl: