blob: fcecab080bd7857ec6a9f52d6fd085a057246f13 [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
747 option.
748 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
1455 unnamed When included, Vim will use the clipboard register '*'
1456 for all yank, delete, change and put operations which
1457 would normally go to the unnamed register. When a
1458 register is explicitly specified, it will always be
1459 used regardless of whether "unnamed" is in 'clipboard'
1460 or not. The clipboard register can always be
1461 explicitly accessed using the "* notation. Also see
1462 |gui-clipboard|.
1463
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001464 unnamedplus A variant of "unnamed" flag which uses the clipboard
1465 register '+' (|quoteplus|) instead of register '*' for
1466 all operations except yank. Yank shall copy the text
1467 into register '+' and also into '*' when "unnamed" is
1468 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001469 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001470 Availability can be checked with: >
1471 if has('unnamedplus')
1472<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 autoselect Works like the 'a' flag in 'guioptions': If present,
1474 then whenever Visual mode is started, or the Visual
1475 area extended, Vim tries to become the owner of the
1476 windowing system's global selection or put the
1477 selected text on the clipboard used by the selection
1478 register "*. See |guioptions_a| and |quotestar| for
1479 details. When the GUI is active, the 'a' flag in
1480 'guioptions' is used, when the GUI is not active, this
1481 "autoselect" flag is used.
1482 Also applies to the modeless selection.
1483
1484 autoselectml Like "autoselect", but for the modeless selection
1485 only. Compare to the 'A' flag in 'guioptions'.
1486
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001487 html When the clipboard contains HTML, use this when
1488 pasting. When putting text on the clipboard, mark it
1489 as HTML. This works to copy rendered HTML from
1490 Firefox, paste it as raw HTML in Vim, select the HTML
1491 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001492 You probably want to add this only temporarily,
1493 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001494 Only supported for GTK version 2 and later.
1495 Only available with the |+multi_byte| feature.
1496
Bram Moolenaar071d4272004-06-13 20:20:40 +00001497 exclude:{pattern}
1498 Defines a pattern that is matched against the name of
1499 the terminal 'term'. If there is a match, no
1500 connection will be made to the X server. This is
1501 useful in this situation:
1502 - Running Vim in a console.
1503 - $DISPLAY is set to start applications on another
1504 display.
1505 - You do not want to connect to the X server in the
1506 console, but do want this in a terminal emulator.
1507 To never connect to the X server use: >
1508 exclude:.*
1509< This has the same effect as using the |-X| argument.
1510 Note that when there is no connection to the X server
1511 the window title won't be restored and the clipboard
1512 cannot be accessed.
1513 The value of 'magic' is ignored, {pattern} is
1514 interpreted as if 'magic' was on.
1515 The rest of the option value will be used for
1516 {pattern}, this must be the last entry.
1517
1518 *'cmdheight'* *'ch'*
1519'cmdheight' 'ch' number (default 1)
1520 global
1521 {not in Vi}
1522 Number of screen lines to use for the command-line. Helps avoiding
1523 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001524 The value of this option is stored with the tab page, so that each tab
1525 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526
1527 *'cmdwinheight'* *'cwh'*
1528'cmdwinheight' 'cwh' number (default 7)
1529 global
1530 {not in Vi}
1531 {not available when compiled without the |+vertsplit|
1532 feature}
1533 Number of screen lines to use for the command-line window. |cmdwin|
1534
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001535 *'colorcolumn'* *'cc'*
1536'colorcolumn' 'cc' string (default "")
1537 local to window
1538 {not in Vi}
1539 {not available when compiled without the |+syntax|
1540 feature}
1541 'colorcolumn' is a comma separated list of screen columns that are
1542 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1543 text. Will make screen redrawing slower.
1544 The screen column can be an absolute number, or a number preceded with
1545 '+' or '-', which is added to or subtracted from 'textwidth'. >
1546
1547 :set cc=+1 " highlight column after 'textwidth'
1548 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1549 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1550<
1551 When 'textwidth' is zero then the items with '-' and '+' are not used.
1552 A maximum of 256 columns are highlighted.
1553
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 *'columns'* *'co'* *E594*
1555'columns' 'co' number (default 80 or terminal width)
1556 global
1557 {not in Vi}
1558 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001559 initialization and does not have to be set by hand. Also see
1560 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 When Vim is running in the GUI or in a resizable window, setting this
1562 option will cause the window size to be changed. When you only want
1563 to use the size for the GUI, put the command in your |gvimrc| file.
1564 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001565 number of columns of the display, the display may be messed up. For
1566 the GUI it is always possible and Vim limits the number of columns to
1567 what fits on the screen. You can use this command to get the widest
1568 window possible: >
1569 :set columns=9999
1570< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571
1572 *'comments'* *'com'* *E524* *E525*
1573'comments' 'com' string (default
1574 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1575 local to buffer
1576 {not in Vi}
1577 {not available when compiled without the |+comments|
1578 feature}
1579 A comma separated list of strings that can start a comment line. See
1580 |format-comments|. See |option-backslash| about using backslashes to
1581 insert a space.
1582
1583 *'commentstring'* *'cms'* *E537*
1584'commentstring' 'cms' string (default "/*%s*/")
1585 local to buffer
1586 {not in Vi}
1587 {not available when compiled without the |+folding|
1588 feature}
1589 A template for a comment. The "%s" in the value is replaced with the
1590 comment text. Currently only used to add markers for folding, see
1591 |fold-marker|.
1592
1593 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001594'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1595 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 global
1597 {not in Vi}
1598 This option has the effect of making Vim either more Vi-compatible, or
1599 make Vim behave in a more useful way.
1600 This is a special kind of option, because when it's set or reset,
1601 other options are also changed as a side effect. CAREFUL: Setting or
1602 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001603 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001604 set this option in your vimrc file, you should probably put it at the
1605 very start.
1606 By default this option is on and the Vi defaults are used for the
1607 options. This default was chosen for those people who want to use Vim
1608 just like Vi, and don't even (want to) know about the 'compatible'
1609 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001610 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001611 this option is switched off, and all options that have not been
1612 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001613 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001614 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001615 happen for the system-wide vimrc or gvimrc file, nor for a file given
1616 with the |-u| argument). Also see |compatible-default| and
1617 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001618 You can also set this option with the "-C" argument, and reset it with
1619 "-N". See |-C| and |-N|.
1620 Switching this option off makes the Vim defaults be used for options
1621 that have a different Vi and Vim default value. See the options
1622 marked with a '+' below. Other options are not modified.
1623 At the moment this option is set, several other options will be set
1624 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001625 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 editing.
1627 See also 'cpoptions'.
1628
1629 option + set value effect ~
1630
1631 'allowrevins' off no CTRL-_ command
1632 'backupcopy' Unix: "yes" backup file is a copy
1633 others: "auto" copy or rename backup file
1634 'backspace' "" normal backspace
1635 'backup' off no backup file
1636 'cindent' off no C code indentation
1637 'cedit' + "" no key to open the |cmdwin|
1638 'cpoptions' + (all flags) Vi-compatible flags
1639 'cscopetag' off don't use cscope for ":tag"
1640 'cscopetagorder' 0 see |cscopetagorder|
1641 'cscopeverbose' off see |cscopeverbose|
1642 'digraph' off no digraphs
1643 'esckeys' + off no <Esc>-keys in Insert mode
1644 'expandtab' off tabs not expanded to spaces
1645 'fileformats' + "" no automatic file format detection,
1646 "dos,unix" except for DOS, Windows and OS/2
1647 'formatoptions' + "vt" Vi compatible formatting
1648 'gdefault' off no default 'g' flag for ":s"
1649 'history' + 0 no commandline history
1650 'hkmap' off no Hebrew keyboard mapping
1651 'hkmapp' off no phonetic Hebrew keyboard mapping
1652 'hlsearch' off no highlighting of search matches
1653 'incsearch' off no incremental searching
1654 'indentexpr' "" no indenting by expression
1655 'insertmode' off do not start in Insert mode
1656 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1657 characters and '_'
1658 'joinspaces' on insert 2 spaces after period
1659 'modeline' + off no modelines
1660 'more' + off no pauses in listings
1661 'revins' off no reverse insert
1662 'ruler' off no ruler
1663 'scrolljump' 1 no jump scroll
1664 'scrolloff' 0 no scroll offset
1665 'shiftround' off indent not rounded to shiftwidth
1666 'shortmess' + "" no shortening of messages
1667 'showcmd' + off command characters not shown
1668 'showmode' + off current mode not shown
1669 'smartcase' off no automatic ignore case switch
1670 'smartindent' off no smart indentation
1671 'smarttab' off no smart tab size
1672 'softtabstop' 0 tabs are always 'tabstop' positions
1673 'startofline' on goto startofline with some commands
1674 'tagrelative' + off tag file names are not relative
1675 'textauto' + off no automatic textmode detection
1676 'textwidth' 0 no automatic line wrap
1677 'tildeop' off tilde is not an operator
1678 'ttimeout' off no terminal timeout
1679 'whichwrap' + "" left-right movements don't wrap
1680 'wildchar' + CTRL-E only when the current value is <Tab>
1681 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001682 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683
1684 *'complete'* *'cpt'* *E535*
1685'complete' 'cpt' string (default: ".,w,b,u,t,i")
1686 local to buffer
1687 {not in Vi}
1688 This option specifies how keyword completion |ins-completion| works
1689 when CTRL-P or CTRL-N are used. It is also used for whole-line
1690 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1691 and the places to scan. It is a comma separated list of flags:
1692 . scan the current buffer ('wrapscan' is ignored)
1693 w scan buffers from other windows
1694 b scan other loaded buffers that are in the buffer list
1695 u scan the unloaded buffers that are in the buffer list
1696 U scan the buffers that are not in the buffer list
1697 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001698 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 k{dict} scan the file {dict}. Several "k" flags can be given,
1700 patterns are valid too. For example: >
1701 :set cpt=k/usr/dict/*,k~/spanish
1702< s scan the files given with the 'thesaurus' option
1703 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1704 are valid too.
1705 i scan current and included files
1706 d scan current and included files for defined name or macro
1707 |i_CTRL-X_CTRL-D|
1708 ] tag completion
1709 t same as "]"
1710
1711 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1712 not executed, this may lead to unexpected completions from some files
1713 (gzipped files for example). Unloaded buffers are not scanned for
1714 whole-line completion.
1715
1716 The default is ".,w,b,u,t,i", which means to scan:
1717 1. the current buffer
1718 2. buffers in other windows
1719 3. other loaded buffers
1720 4. unloaded buffers
1721 5. tags
1722 6. included files
1723
1724 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001725 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1726 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001728 *'completefunc'* *'cfu'*
1729'completefunc' 'cfu' string (default: empty)
1730 local to buffer
1731 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001732 {not available when compiled without the |+eval|
1733 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001734 This option specifies a function to be used for Insert mode completion
1735 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001736 See |complete-functions| for an explanation of how the function is
1737 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001738 This option cannot be set from a |modeline| or in the |sandbox|, for
1739 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001740
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001741 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001742'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001743 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001744 {not available when compiled without the
1745 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001746 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001747 A comma separated list of options for Insert mode completion
1748 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001749
1750 menu Use a popup menu to show the possible completions. The
1751 menu is only shown when there is more than one match and
1752 sufficient colors are available. |ins-completion-menu|
1753
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001754 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001755 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001756 match, e.g., what file it comes from.
1757
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001758 longest Only insert the longest common text of the matches. If
1759 the menu is displayed you can use CTRL-L to add more
1760 characters. Whether case is ignored depends on the kind
1761 of completion. For buffer text the 'ignorecase' option is
1762 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001763
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001764 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001765 completion in the preview window. Only works in
1766 combination with "menu" or "menuone".
1767
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001768
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001769 *'concealcursor'* *'cocu'*
1770'concealcursor' 'cocu' string (default: "")
1771 local to window
1772 {not in Vi}
1773 {not available when compiled without the |+conceal|
1774 feature}
1775 Sets the modes in which text in the cursor line can also be concealed.
1776 When the current mode is listed then concealing happens just like in
1777 other lines.
1778 n Normal mode
1779 v Visual mode
1780 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001781 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001782
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001783 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001784 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001785 are moving around text is concealed, but when starting to insert text
1786 or selecting a Visual area the concealed text is displayed, so that
1787 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001788 Keep in mind that the cursor position is not always where it's
1789 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001790
1791
1792'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001793 number (default 0)
1794 local to window
1795 {not in Vi}
1796 {not available when compiled without the |+conceal|
1797 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001798 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1799 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001800
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001801 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001802 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001803 1 Each block of concealed text is replaced with one
1804 character. If the syntax item does not have a custom
1805 replacement character defined (see |:syn-cchar|) the
1806 character defined in 'listchars' is used (default is a
1807 space).
1808 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001809 2 Concealed text is completely hidden unless it has a
1810 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001811 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001812 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001813
Bram Moolenaara7781e02010-07-19 20:13:22 +02001814 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001815 edit and copy the text. This can be changed with the 'concealcursor'
1816 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001817
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1819'confirm' 'cf' boolean (default off)
1820 global
1821 {not in Vi}
1822 When 'confirm' is on, certain operations that would normally
1823 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1824 instead raise a |dialog| asking if you wish to save the current
1825 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1826 If 'confirm' is off you can still activate confirmation for one
1827 command only (this is most useful in mappings) with the |:confirm|
1828 command.
1829 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1830
1831 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1832'conskey' 'consk' boolean (default off)
1833 global
1834 {not in Vi} {only for MS-DOS}
1835 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001836 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 three methods of console input are available:
1838 'conskey' 'bioskey' action ~
1839 on on or off direct console input
1840 off on BIOS
1841 off off STDIN
1842
1843 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1844'copyindent' 'ci' boolean (default off)
1845 local to buffer
1846 {not in Vi}
1847 Copy the structure of the existing lines indent when autoindenting a
1848 new line. Normally the new indent is reconstructed by a series of
1849 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1850 in which case only spaces are used). Enabling this option makes the
1851 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001852 existing line. 'expandtab' has no effect on these characters, a Tab
1853 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854 line, the remaining space is filled in the normal manner.
1855 NOTE: 'copyindent' is reset when 'compatible' is set.
1856 Also see 'preserveindent'.
1857
1858 *'cpoptions'* *'cpo'*
1859'cpoptions' 'cpo' string (Vim default: "aABceFs",
1860 Vi default: all flags)
1861 global
1862 {not in Vi}
1863 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001864 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865 not being vi-compatible is mostly or sometimes preferred.
1866 'cpoptions' stands for "compatible-options".
1867 Commas can be added for readability.
1868 To avoid problems with flags that are added in the future, use the
1869 "+=" and "-=" feature of ":set" |add-option-flags|.
1870 NOTE: This option is set to the Vi default value when 'compatible' is
1871 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001872 NOTE: This option is set to the POSIX default value at startup when
1873 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001874 variable exists |posix|. This means Vim tries to behave like the
1875 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876
1877 contains behavior ~
1878 *cpo-a*
1879 a When included, a ":read" command with a file name
1880 argument will set the alternate file name for the
1881 current window.
1882 *cpo-A*
1883 A When included, a ":write" command with a file name
1884 argument will set the alternate file name for the
1885 current window.
1886 *cpo-b*
1887 b "\|" in a ":map" command is recognized as the end of
1888 the map command. The '\' is included in the mapping,
1889 the text after the '|' is interpreted as the next
1890 command. Use a CTRL-V instead of a backslash to
1891 include the '|' in the mapping. Applies to all
1892 mapping, abbreviation, menu and autocmd commands.
1893 See also |map_bar|.
1894 *cpo-B*
1895 B A backslash has no special meaning in mappings,
1896 abbreviations and the "to" part of the menu commands.
1897 Remove this flag to be able to use a backslash like a
1898 CTRL-V. For example, the command ":map X \<Esc>"
1899 results in X being mapped to:
1900 'B' included: "\^[" (^[ is a real <Esc>)
1901 'B' excluded: "<Esc>" (5 characters)
1902 ('<' excluded in both cases)
1903 *cpo-c*
1904 c Searching continues at the end of any match at the
1905 cursor position, but not further than the start of the
1906 next line. When not present searching continues
1907 one character from the cursor position. With 'c'
1908 "abababababab" only gets three matches when repeating
1909 "/abab", without 'c' there are five matches.
1910 *cpo-C*
1911 C Do not concatenate sourced lines that start with a
1912 backslash. See |line-continuation|.
1913 *cpo-d*
1914 d Using "./" in the 'tags' option doesn't mean to use
1915 the tags file relative to the current file, but the
1916 tags file in the current directory.
1917 *cpo-D*
1918 D Can't use CTRL-K to enter a digraph after Normal mode
1919 commands with a character argument, like |r|, |f| and
1920 |t|.
1921 *cpo-e*
1922 e When executing a register with ":@r", always add a
1923 <CR> to the last line, also when the register is not
1924 linewise. If this flag is not present, the register
1925 is not linewise and the last line does not end in a
1926 <CR>, then the last line is put on the command-line
1927 and can be edited before hitting <CR>.
1928 *cpo-E*
1929 E It is an error when using "y", "d", "c", "g~", "gu" or
1930 "gU" on an Empty region. The operators only work when
1931 at least one character is to be operate on. Example:
1932 This makes "y0" fail in the first column.
1933 *cpo-f*
1934 f When included, a ":read" command with a file name
1935 argument will set the file name for the current buffer,
1936 if the current buffer doesn't have a file name yet.
1937 *cpo-F*
1938 F When included, a ":write" command with a file name
1939 argument will set the file name for the current
1940 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001941 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 *cpo-g*
1943 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001944 *cpo-H*
1945 H When using "I" on a line with only blanks, insert
1946 before the last blank. Without this flag insert after
1947 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 *cpo-i*
1949 i When included, interrupting the reading of a file will
1950 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001951 *cpo-I*
1952 I When moving the cursor up or down just after inserting
1953 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 *cpo-j*
1955 j When joining lines, only add two spaces after a '.',
1956 not after '!' or '?'. Also see 'joinspaces'.
1957 *cpo-J*
1958 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001959 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 white space.
1961 *cpo-k*
1962 k Disable the recognition of raw key codes in
1963 mappings, abbreviations, and the "to" part of menu
1964 commands. For example, if <Key> sends ^[OA (where ^[
1965 is <Esc>), the command ":map X ^[OA" results in X
1966 being mapped to:
1967 'k' included: "^[OA" (3 characters)
1968 'k' excluded: "<Key>" (one key code)
1969 Also see the '<' flag below.
1970 *cpo-K*
1971 K Don't wait for a key code to complete when it is
1972 halfway a mapping. This breaks mapping <F1><F1> when
1973 only part of the second <F1> has been read. It
1974 enables cancelling the mapping by typing <F1><Esc>.
1975 *cpo-l*
1976 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001977 literally, only "\]", "\^", "\-" and "\\" are special.
1978 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1980 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001981 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 *cpo-L*
1983 L When the 'list' option is set, 'wrapmargin',
1984 'textwidth', 'softtabstop' and Virtual Replace mode
1985 (see |gR|) count a <Tab> as two characters, instead of
1986 the normal behavior of a <Tab>.
1987 *cpo-m*
1988 m When included, a showmatch will always wait half a
1989 second. When not included, a showmatch will wait half
1990 a second or until a character is typed. |'showmatch'|
1991 *cpo-M*
1992 M When excluded, "%" matching will take backslashes into
1993 account. Thus in "( \( )" and "\( ( \)" the outer
1994 parenthesis match. When included "%" ignores
1995 backslashes, which is Vi compatible.
1996 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001997 n When included, the column used for 'number' and
1998 'relativenumber' will also be used for text of wrapped
1999 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 *cpo-o*
2001 o Line offset to search command is not remembered for
2002 next search.
2003 *cpo-O*
2004 O Don't complain if a file is being overwritten, even
2005 when it didn't exist when editing it. This is a
2006 protection against a file unexpectedly created by
2007 someone else. Vi didn't complain about this.
2008 *cpo-p*
2009 p Vi compatible Lisp indenting. When not present, a
2010 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002011 *cpo-P*
2012 P When included, a ":write" command that appends to a
2013 file will set the file name for the current buffer, if
2014 the current buffer doesn't have a file name yet and
2015 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002016 *cpo-q*
2017 q When joining multiple lines leave the cursor at the
2018 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 *cpo-r*
2020 r Redo ("." command) uses "/" to repeat a search
2021 command, instead of the actually used search string.
2022 *cpo-R*
2023 R Remove marks from filtered lines. Without this flag
2024 marks are kept like |:keepmarks| was used.
2025 *cpo-s*
2026 s Set buffer options when entering the buffer for the
2027 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002028 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 set when the buffer is created.
2030 *cpo-S*
2031 S Set buffer options always when entering a buffer
2032 (except 'readonly', 'fileformat', 'filetype' and
2033 'syntax'). This is the (most) Vi compatible setting.
2034 The options are set to the values in the current
2035 buffer. When you change an option and go to another
2036 buffer, the value is copied. Effectively makes the
2037 buffer options global to all buffers.
2038
2039 's' 'S' copy buffer options
2040 no no when buffer created
2041 yes no when buffer first entered (default)
2042 X yes each time when buffer entered (vi comp.)
2043 *cpo-t*
2044 t Search pattern for the tag command is remembered for
2045 "n" command. Otherwise Vim only puts the pattern in
2046 the history for search pattern, but doesn't change the
2047 last used search pattern.
2048 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002049 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002050 *cpo-v*
2051 v Backspaced characters remain visible on the screen in
2052 Insert mode. Without this flag the characters are
2053 erased from the screen right away. With this flag the
2054 screen newly typed text overwrites backspaced
2055 characters.
2056 *cpo-w*
2057 w When using "cw" on a blank character, only change one
2058 character and not all blanks until the start of the
2059 next word.
2060 *cpo-W*
2061 W Don't overwrite a readonly file. When omitted, ":w!"
2062 overwrites a readonly file, if possible.
2063 *cpo-x*
2064 x <Esc> on the command-line executes the command-line.
2065 The default in Vim is to abandon the command-line,
2066 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002067 *cpo-X*
2068 X When using a count with "R" the replaced text is
2069 deleted only once. Also when repeating "R" with "."
2070 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 *cpo-y*
2072 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002073 *cpo-Z*
2074 Z When using "w!" while the 'readonly' option is set,
2075 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 *cpo-!*
2077 ! When redoing a filter command, use the last used
2078 external command, whatever it was. Otherwise the last
2079 used -filter- command is used.
2080 *cpo-$*
2081 $ When making a change to one line, don't redisplay the
2082 line, but put a '$' at the end of the changed text.
2083 The changed text will be overwritten when you type the
2084 new text. The line is redisplayed if you type any
2085 command that moves the cursor from the insertion
2086 point.
2087 *cpo-%*
2088 % Vi-compatible matching is done for the "%" command.
2089 Does not recognize "#if", "#endif", etc.
2090 Does not recognize "/*" and "*/".
2091 Parens inside single and double quotes are also
2092 counted, causing a string that contains a paren to
2093 disturb the matching. For example, in a line like
2094 "if (strcmp("foo(", s))" the first paren does not
2095 match the last one. When this flag is not included,
2096 parens inside single and double quotes are treated
2097 specially. When matching a paren outside of quotes,
2098 everything inside quotes is ignored. When matching a
2099 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002100 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002101 This flag is also used for other features, such as
2102 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002103 *cpo--*
2104 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002105 it would go above the first line or below the last
2106 line. Without it the cursor moves to the first or
2107 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002108 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002109 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002110 *cpo-+*
2111 + When included, a ":write file" command will reset the
2112 'modified' flag of the buffer, even though the buffer
2113 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002114 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 * Use ":*" in the same way as ":@". When not included,
2116 ":*" is an alias for ":'<,'>", select the Visual area.
2117 *cpo-<*
2118 < Disable the recognition of special key codes in |<>|
2119 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002120 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 ":map X <Tab>" results in X being mapped to:
2122 '<' included: "<Tab>" (5 characters)
2123 '<' excluded: "^I" (^I is a real <Tab>)
2124 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002125 *cpo->*
2126 > When appending to a register, put a line break before
2127 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002128 *cpo-;*
2129 ; When using |,| or |;| to repeat the last |t| search
2130 and the cursor is right in front of the searched
2131 character, the cursor won't move. When not included,
2132 the cursor would skip over it and jump to the
2133 following occurence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002134
2135 POSIX flags. These are not included in the Vi default value, except
2136 when $VIM_POSIX was set on startup. |posix|
2137
2138 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002139 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002140 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002141 *cpo-&*
2142 & When ":preserve" was used keep the swap file when
2143 exiting normally while this buffer is still loaded.
2144 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002145 *cpo-\*
2146 \ Backslash in a [] range in a search pattern is taken
2147 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002148 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2149 '\' excluded: "/[ \-]" finds <Space> and '-'
2150 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002151 *cpo-/*
2152 / When "%" is used as the replacement string in a |:s|
2153 command, use the previous replacement string. |:s%|
2154 *cpo-{*
2155 { The |{| and |}| commands also stop at a "{" character
2156 at the start of a line.
2157 *cpo-.*
2158 . The ":chdir" and ":cd" commands fail if the current
2159 buffer is modified, unless ! is used. Vim doesn't
2160 need this, since it remembers the full path of an
2161 opened file.
2162 *cpo-bar*
2163 | The value of the $LINES and $COLUMNS environment
2164 variables overrule the terminal size values obtained
2165 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002166
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002168 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002169'cryptmethod' string (default "zip")
2170 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002171 {not in Vi}
2172 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002173 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002174 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002175 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002176 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002177 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002178 or later, files can NOT be read by Vim 7.2 and older.
2179 This adds a "seed" to the file, every time you write
2180 the file the encrypted bytes will be different.
2181
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002182 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002183 to the detected method of the file being read. Thus if you write it
2184 without changing 'cryptmethod' the same method will be used.
2185 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002186 explicitly write it, you don't get a warning unless there are other
2187 modifications. Also see |:X|.
2188
2189 When setting the global value to an empty string, it will end up with
2190 the value "zip". When setting the local value to an empty string the
2191 buffer will use the global value.
2192
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002193 When a new encryption method is added in a later version of Vim, and
2194 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002195 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002196
2197
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 *'cscopepathcomp'* *'cspc'*
2199'cscopepathcomp' 'cspc' number (default 0)
2200 global
2201 {not available when compiled without the |+cscope|
2202 feature}
2203 {not in Vi}
2204 Determines how many components of the path to show in a list of tags.
2205 See |cscopepathcomp|.
2206
2207 *'cscopeprg'* *'csprg'*
2208'cscopeprg' 'csprg' string (default "cscope")
2209 global
2210 {not available when compiled without the |+cscope|
2211 feature}
2212 {not in Vi}
2213 Specifies the command to execute cscope. See |cscopeprg|.
2214 This option cannot be set from a |modeline| or in the |sandbox|, for
2215 security reasons.
2216
2217 *'cscopequickfix'* *'csqf'*
2218'cscopequickfix' 'csqf' string (default "")
2219 global
2220 {not available when compiled without the |+cscope|
2221 or |+quickfix| features}
2222 {not in Vi}
2223 Specifies whether to use quickfix window to show cscope results.
2224 See |cscopequickfix|.
2225
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002226 *'cscoperelative'* *'csre'*
2227'cscoperelative' 'csre' boolean (default off)
2228 global
2229 {not available when compiled without the |+cscope|
2230 feature}
2231 {not in Vi}
2232 In the absence of a prefix (-P) for cscope. setting this option enables
2233 to use the basename of cscope.out path as the prefix.
2234 See |cscoperelative|.
2235
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2237'cscopetag' 'cst' boolean (default off)
2238 global
2239 {not available when compiled without the |+cscope|
2240 feature}
2241 {not in Vi}
2242 Use cscope for tag commands. See |cscope-options|.
2243 NOTE: This option is reset when 'compatible' is set.
2244
2245 *'cscopetagorder'* *'csto'*
2246'cscopetagorder' 'csto' number (default 0)
2247 global
2248 {not available when compiled without the |+cscope|
2249 feature}
2250 {not in Vi}
2251 Determines the order in which ":cstag" performs a search. See
2252 |cscopetagorder|.
2253 NOTE: This option is set to 0 when 'compatible' is set.
2254
2255 *'cscopeverbose'* *'csverb'*
2256 *'nocscopeverbose'* *'nocsverb'*
2257'cscopeverbose' 'csverb' boolean (default off)
2258 global
2259 {not available when compiled without the |+cscope|
2260 feature}
2261 {not in Vi}
2262 Give messages when adding a cscope database. See |cscopeverbose|.
2263 NOTE: This option is reset when 'compatible' is set.
2264
Bram Moolenaar860cae12010-06-05 23:22:07 +02002265 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2266'cursorbind' 'crb' boolean (default off)
2267 local to window
2268 {not in Vi}
2269 {not available when compiled without the |+cursorbind|
2270 feature}
2271 When this option is set, as the cursor in the current
2272 window moves other cursorbound windows (windows that also have
2273 this option set) move their cursors to the corresponding line and
2274 column. This option is useful for viewing the
2275 differences between two versions of a file (see 'diff'); in diff mode,
2276 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002277 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002278
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002279
2280 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2281'cursorcolumn' 'cuc' boolean (default off)
2282 local to window
2283 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002284 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002285 feature}
2286 Highlight the screen column of the cursor with CursorColumn
2287 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2288 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002289 If you only want the highlighting in the current window you can use
2290 these autocommands: >
2291 au WinLeave * set nocursorline nocursorcolumn
2292 au WinEnter * set cursorline cursorcolumn
2293<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002294
2295 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2296'cursorline' 'cul' boolean (default off)
2297 local to window
2298 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002299 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002300 feature}
2301 Highlight the screen line of the cursor with CursorLine
2302 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2303 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002304 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002305 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002306
2307
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 *'debug'*
2309'debug' string (default "")
2310 global
2311 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002312 These values can be used:
2313 msg Error messages that would otherwise be omitted will be given
2314 anyway.
2315 throw Error messages that would otherwise be omitted will be given
2316 anyway and also throw an exception and set |v:errmsg|.
2317 beep A message will be given when otherwise only a beep would be
2318 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002319 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002320 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2321 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322
2323 *'define'* *'def'*
2324'define' 'def' string (default "^\s*#\s*define")
2325 global or local to buffer |global-local|
2326 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002327 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 pattern, just like for the "/" command. This option is used for the
2329 commands like "[i" and "[d" |include-search|. The 'isident' option is
2330 used to recognize the defined name after the match:
2331 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2332 See |option-backslash| about inserting backslashes to include a space
2333 or backslash.
2334 The default value is for C programs. For C++ this value would be
2335 useful, to include const type declarations: >
2336 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2337< When using the ":set" command, you need to double the backslashes!
2338
2339 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2340'delcombine' 'deco' boolean (default off)
2341 global
2342 {not in Vi}
2343 {only available when compiled with the |+multi_byte|
2344 feature}
2345 If editing Unicode and this option is set, backspace and Normal mode
2346 "x" delete each combining character on its own. When it is off (the
2347 default) the character along with its combining characters are
2348 deleted.
2349 Note: When 'delcombine' is set "xx" may work different from "2x"!
2350
2351 This is useful for Arabic, Hebrew and many other languages where one
2352 may have combining characters overtop of base characters, and want
2353 to remove only the combining ones.
2354
2355 *'dictionary'* *'dict'*
2356'dictionary' 'dict' string (default "")
2357 global or local to buffer |global-local|
2358 {not in Vi}
2359 List of file names, separated by commas, that are used to lookup words
2360 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2361 contain a list of words. This can be one word per line, or several
2362 words per line, separated by non-keyword characters (white space is
2363 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002364 When this option is empty, or an entry "spell" is present, spell
2365 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002366 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 after a comma are ignored, otherwise spaces are included in the file
2368 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002369 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002370 Where to find a list of words?
2371 - On FreeBSD, there is the file "/usr/share/dict/words".
2372 - In the Simtel archive, look in the "msdos/linguist" directory.
2373 - In "miscfiles" of the GNU collection.
2374 The use of |:set+=| and |:set-=| is preferred when adding or removing
2375 directories from the list. This avoids problems when a future version
2376 uses another default.
2377 Backticks cannot be used in this option for security reasons.
2378
2379 *'diff'* *'nodiff'*
2380'diff' boolean (default off)
2381 local to window
2382 {not in Vi}
2383 {not available when compiled without the |+diff|
2384 feature}
2385 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002386 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387
2388 *'dex'* *'diffexpr'*
2389'diffexpr' 'dex' string (default "")
2390 global
2391 {not in Vi}
2392 {not available when compiled without the |+diff|
2393 feature}
2394 Expression which is evaluated to obtain an ed-style diff file from two
2395 versions of a file. See |diff-diffexpr|.
2396 This option cannot be set from a |modeline| or in the |sandbox|, for
2397 security reasons.
2398
2399 *'dip'* *'diffopt'*
2400'diffopt' 'dip' string (default "filler")
2401 global
2402 {not in Vi}
2403 {not available when compiled without the |+diff|
2404 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002405 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 All are optional. Items must be separated by a comma.
2407
2408 filler Show filler lines, to keep the text
2409 synchronized with a window that has inserted
2410 lines at the same position. Mostly useful
2411 when windows are side-by-side and 'scrollbind'
2412 is set.
2413
2414 context:{n} Use a context of {n} lines between a change
2415 and a fold that contains unchanged lines.
2416 When omitted a context of six lines is used.
2417 See |fold-diff|.
2418
2419 icase Ignore changes in case of text. "a" and "A"
2420 are considered the same. Adds the "-i" flag
2421 to the "diff" command if 'diffexpr' is empty.
2422
2423 iwhite Ignore changes in amount of white space. Adds
2424 the "-b" flag to the "diff" command if
2425 'diffexpr' is empty. Check the documentation
2426 of the "diff" command for what this does
2427 exactly. It should ignore adding trailing
2428 white space, but not leading white space.
2429
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002430 horizontal Start diff mode with horizontal splits (unless
2431 explicitly specified otherwise).
2432
2433 vertical Start diff mode with vertical splits (unless
2434 explicitly specified otherwise).
2435
2436 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2437 starting diff mode. Without this 2 is used.
2438
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 Examples: >
2440
2441 :set diffopt=filler,context:4
2442 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002443 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444<
2445 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2446'digraph' 'dg' boolean (default off)
2447 global
2448 {not in Vi}
2449 {not available when compiled without the |+digraphs|
2450 feature}
2451 Enable the entering of digraphs in Insert mode with {char1} <BS>
2452 {char2}. See |digraphs|.
2453 NOTE: This option is reset when 'compatible' is set.
2454
2455 *'directory'* *'dir'*
2456'directory' 'dir' string (default for Amiga: ".,t:",
2457 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2458 for Unix: ".,~/tmp,/var/tmp,/tmp")
2459 global
2460 List of directory names for the swap file, separated with commas.
2461 - The swap file will be created in the first directory where this is
2462 possible.
2463 - Empty means that no swap file will be used (recovery is
2464 impossible!).
2465 - A directory "." means to put the swap file in the same directory as
2466 the edited file. On Unix, a dot is prepended to the file name, so
2467 it doesn't show in a directory listing. On MS-Windows the "hidden"
2468 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002469 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 put the swap file relative to where the edited file is. The leading
2471 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002472 - For Unix and Win32, if a directory ends in two path separators "//"
2473 or "\\", the swap file name will be built from the complete path to
2474 the file with all path separators substituted to percent '%' signs.
2475 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002476 On Win32, when a separating comma is following, you must use "//",
2477 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 - Spaces after the comma are ignored, other spaces are considered part
2479 of the directory name. To have a space at the start of a directory
2480 name, precede it with a backslash.
2481 - To include a comma in a directory name precede it with a backslash.
2482 - A directory name may end in an ':' or '/'.
2483 - Environment variables are expanded |:set_env|.
2484 - Careful with '\' characters, type one before a space, type two to
2485 get one in the option (see |option-backslash|), for example: >
2486 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2487< - For backwards compatibility with Vim version 3.0 a '>' at the start
2488 of the option is removed.
2489 Using "." first in the list is recommended. This means that editing
2490 the same file twice will result in a warning. Using "/tmp" on Unix is
2491 discouraged: When the system crashes you lose the swap file.
2492 "/var/tmp" is often not cleared when rebooting, thus is a better
2493 choice than "/tmp". But it can contain a lot of files, your swap
2494 files get lost in the crowd. That is why a "tmp" directory in your
2495 home directory is tried first.
2496 The use of |:set+=| and |:set-=| is preferred when adding or removing
2497 directories from the list. This avoids problems when a future version
2498 uses another default.
2499 This option cannot be set from a |modeline| or in the |sandbox|, for
2500 security reasons.
2501 {Vi: directory to put temp file in, defaults to "/tmp"}
2502
2503 *'display'* *'dy'*
2504'display' 'dy' string (default "")
2505 global
2506 {not in Vi}
2507 Change the way text is displayed. This is comma separated list of
2508 flags:
2509 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002510 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 last line that doesn't fit is replaced with "@" lines.
2512 uhex Show unprintable characters hexadecimal as <xx>
2513 instead of using ^C and ~C.
2514
2515 *'eadirection'* *'ead'*
2516'eadirection' 'ead' string (default "both")
2517 global
2518 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002519 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 feature}
2521 Tells when the 'equalalways' option applies:
2522 ver vertically, width of windows is not affected
2523 hor horizontally, height of windows is not affected
2524 both width and height of windows is affected
2525
2526 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2527'edcompatible' 'ed' boolean (default off)
2528 global
2529 Makes the 'g' and 'c' flags of the ":substitute" command to be
2530 toggled each time the flag is given. See |complex-change|. See
2531 also 'gdefault' option.
2532 Switching this option on is discouraged!
2533
2534 *'encoding'* *'enc'* *E543*
2535'encoding' 'enc' string (default: "latin1" or value from $LANG)
2536 global
2537 {only available when compiled with the |+multi_byte|
2538 feature}
2539 {not in Vi}
2540 Sets the character encoding used inside Vim. It applies to text in
2541 the buffers, registers, Strings in expressions, text stored in the
2542 viminfo file, etc. It sets the kind of characters which Vim can work
2543 with. See |encoding-names| for the possible values.
2544
2545 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002546 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002548 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549
Bram Moolenaar865242e2010-07-14 21:12:05 +02002550 This option cannot be set from a |modeline|. It would most likely
2551 corrupt the text.
2552
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2554 "utf-8". Although care has been taken to allow different values of
2555 'encoding', "utf-8" is the natural choice for the environment and
2556 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002557 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 versions, and to avoid changing the encoding of newly created files
2559 without your knowledge (in case 'fileencodings' is empty).
2560
2561 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 iconv() or as specified with 'charconvert'.
2564
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002565 If you need to know whether 'encoding' is a multi-byte encoding, you
2566 can use: >
2567 if has("multi_byte_encoding")
2568<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 Normally 'encoding' will be equal to your current locale. This will
2570 be the default if Vim recognizes your environment settings. If
2571 'encoding' is not set to the current locale, 'termencoding' must be
2572 set to convert typed and displayed text. See |encoding-table|.
2573
2574 When you set this option, it fires the |EncodingChanged| autocommand
2575 event so that you can set up fonts if necessary.
2576
2577 When the option is set, the value is converted to lowercase. Thus
2578 you can set it with uppercase values too. Underscores are translated
2579 to '-' signs.
2580 When the encoding is recognized, it is changed to the standard name.
2581 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2582 "iso-8859-2" and "utf8" becomes "utf-8".
2583
2584 Note: "latin1" is also used when the encoding could not be detected.
2585 This only works when editing files in the same encoding! When the
2586 actual character set is not latin1, make sure 'fileencoding' and
2587 'fileencodings' are empty. When conversion is needed, switch to using
2588 utf-8.
2589
2590 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2591 You don't notice this while editing, but it does matter for the
2592 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2593 setting 'encoding' to one of these values instead of utf-8 only has
2594 effect for encoding used for files when 'fileencoding' is empty.
2595
Bram Moolenaar661b1822005-07-28 22:36:45 +00002596 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2597 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598
2599 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2600'endofline' 'eol' boolean (default on)
2601 local to buffer
2602 {not in Vi}
2603 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002604 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002605 option is automatically set when starting to edit a new file, unless
2606 the file does not have an <EOL> for the last line in the file, in
2607 which case it is reset. Normally you don't have to set or reset this
2608 option. When 'binary' is off the value is not used when writing the
2609 file. When 'binary' is on it is used to remember the presence of a
2610 <EOL> for the last line in the file, so that when you write the file
2611 the situation from the original file can be kept. But you can change
2612 it if you want to.
2613
2614 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2615'equalalways' 'ea' boolean (default on)
2616 global
2617 {not in Vi}
2618 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002619 splitting or closing a window. This also happens the moment the
2620 option is switched on. When off, splitting a window will reduce the
2621 size of the current window and leave the other windows the same. When
2622 closing a window the extra lines are given to the window next to it
2623 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 When mixing vertically and horizontally split windows, a minimal size
2625 is computed and some windows may be larger if there is room. The
2626 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002627 Changing the height and width of a window can be avoided by setting
2628 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002629 If a window size is specified when creating a new window sizes are
2630 currently not equalized (it's complicated, but may be implemented in
2631 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632
2633 *'equalprg'* *'ep'*
2634'equalprg' 'ep' string (default "")
2635 global or local to buffer |global-local|
2636 {not in Vi}
2637 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002638 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002639 or 'indentexpr'. When Vim was compiled without internal formatting,
2640 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002641 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 about including spaces and backslashes.
2643 This option cannot be set from a |modeline| or in the |sandbox|, for
2644 security reasons.
2645
2646 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2647'errorbells' 'eb' boolean (default off)
2648 global
2649 Ring the bell (beep or screen flash) for error messages. This only
2650 makes a difference for error messages, the bell will be used always
2651 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002652 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002653 screen flash or do nothing.
2654
2655 *'errorfile'* *'ef'*
2656'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2657 others: "errors.err")
2658 global
2659 {not in Vi}
2660 {not available when compiled without the |+quickfix|
2661 feature}
2662 Name of the errorfile for the QuickFix mode (see |:cf|).
2663 When the "-q" command-line argument is used, 'errorfile' is set to the
2664 following argument. See |-q|.
2665 NOT used for the ":make" command. See 'makeef' for that.
2666 Environment variables are expanded |:set_env|.
2667 See |option-backslash| about including spaces and backslashes.
2668 This option cannot be set from a |modeline| or in the |sandbox|, for
2669 security reasons.
2670
2671 *'errorformat'* *'efm'*
2672'errorformat' 'efm' string (default is very long)
2673 global or local to buffer |global-local|
2674 {not in Vi}
2675 {not available when compiled without the |+quickfix|
2676 feature}
2677 Scanf-like description of the format for the lines in the error file
2678 (see |errorformat|).
2679
2680 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2681'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2682 global
2683 {not in Vi}
2684 Function keys that start with an <Esc> are recognized in Insert
2685 mode. When this option is off, the cursor and function keys cannot be
2686 used in Insert mode if they start with an <Esc>. The advantage of
2687 this is that the single <Esc> is recognized immediately, instead of
2688 after one second. Instead of resetting this option, you might want to
2689 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2690 when 'esckeys' is off, you can still map anything, but the cursor keys
2691 won't work by default.
2692 NOTE: This option is set to the Vi default value when 'compatible' is
2693 set and to the Vim default value when 'compatible' is reset.
2694
2695 *'eventignore'* *'ei'*
2696'eventignore' 'ei' string (default "")
2697 global
2698 {not in Vi}
2699 {not available when compiled without the |+autocmd|
2700 feature}
2701 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002702 When set to "all" or when "all" is one of the items, all autocommand
2703 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 Otherwise this is a comma separated list of event names. Example: >
2705 :set ei=WinEnter,WinLeave
2706<
2707 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2708'expandtab' 'et' boolean (default off)
2709 local to buffer
2710 {not in Vi}
2711 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002712 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2714 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2715 NOTE: This option is reset when 'compatible' is set.
2716
2717 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2718'exrc' 'ex' boolean (default off)
2719 global
2720 {not in Vi}
2721 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2722 directory. If you switch this option on you should also consider
2723 setting the 'secure' option (see |initialization|). Using a local
2724 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2725 also see |.vimrc| and |gui-init|.
2726 This option cannot be set from a |modeline| or in the |sandbox|, for
2727 security reasons.
2728
2729 *'fileencoding'* *'fenc'* *E213*
2730'fileencoding' 'fenc' string (default: "")
2731 local to buffer
2732 {only available when compiled with the |+multi_byte|
2733 feature}
2734 {not in Vi}
2735 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002736
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002738 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739 When 'fileencoding' is empty, the same value as 'encoding' will be
2740 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002741 Conversion will also be done when 'encoding' and 'fileencoding' are
2742 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2743 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002744 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002745 'encoding' is "utf-8" or another Unicode encoding, conversion
2746 is most likely done in a way that the reverse conversion
2747 results in the same text. When 'encoding' is not "utf-8" some
2748 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002749
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 See 'encoding' for the possible values. Additionally, values may be
2751 specified that can be handled by the converter, see
2752 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002753
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 When reading a file 'fileencoding' will be set from 'fileencodings'.
2755 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002756 'fileencoding', use the |++enc| argument. One exception: when
2757 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002758 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002759
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2761 When the option is set, the value is converted to lowercase. Thus
2762 you can set it with uppercase values too. '_' characters are
2763 replaced with '-'. If a name is recognized from the list for
2764 'encoding', it is replaced by the standard name. For example
2765 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002766
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 When this option is set, after starting to edit a file, the 'modified'
2768 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002769
2770 Keep in mind that changing 'fenc' from a modeline happens
2771 AFTER the text has been read, thus it applies to when the file will be
2772 written. If you do set 'fenc' in a modeline, you might want to set
2773 'nomodified' to avoid not being able to ":q".
2774
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 This option can not be changed when 'modifiable' is off.
2776
2777 *'fe'*
2778 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002779 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 old short name was 'fe', which is no longer used.
2781
2782 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002783'fileencodings' 'fencs' string (default: "ucs-bom",
2784 "ucs-bom,utf-8,default,latin1" when
2785 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 global
2787 {only available when compiled with the |+multi_byte|
2788 feature}
2789 {not in Vi}
2790 This is a list of character encodings considered when starting to edit
2791 an existing file. When a file is read, Vim tries to use the first
2792 mentioned character encoding. If an error is detected, the next one
2793 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002794 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 an empty string, which means the value of 'encoding' is used.
2796 WARNING: Conversion can cause loss of information! When
2797 'encoding' is "utf-8" (or one of the other Unicode variants)
2798 conversion is most likely done in a way that the reverse
2799 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002800 "utf-8" some non-ASCII characters may be lost! You can use
2801 the |++bad| argument to specify what is done with characters
2802 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803 For an empty file or a file with only ASCII characters most encodings
2804 will work and the first entry of 'fileencodings' will be used (except
2805 "ucs-bom", which requires the BOM to be present). If you prefer
2806 another encoding use an BufReadPost autocommand event to test if your
2807 preferred encoding is to be used. Example: >
2808 au BufReadPost * if search('\S', 'w') == 0 |
2809 \ set fenc=iso-2022-jp | endif
2810< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2811 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002812 When the |++enc| argument is used then the value of 'fileencodings' is
2813 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002814 Note that 'fileencodings' is not used for a new file, the global value
2815 of 'fileencoding' is used instead. You can set it with: >
2816 :setglobal fenc=iso-8859-2
2817< This means that a non-existing file may get a different encoding than
2818 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 The special value "ucs-bom" can be used to check for a Unicode BOM
2820 (Byte Order Mark) at the start of the file. It must not be preceded
2821 by "utf-8" or another Unicode encoding for this to work properly.
2822 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2823 because Vim cannot detect an error, thus the encoding is always
2824 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002825 The special value "default" can be used for the encoding from the
2826 environment. This is the default value for 'encoding'. It is useful
2827 when 'encoding' is set to "utf-8" and your environment uses a
2828 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002829 When 'encoding' is "utf-8" and a file contains an illegal byte
2830 sequence it won't be recognized as UTF-8. You can use the |8g8|
2831 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832 WRONG VALUES: WHAT'S WRONG:
2833 latin1,utf-8 "latin1" will always be used
2834 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2835 file
2836 cp1250,latin1 "cp1250" will always be used
2837 If 'fileencodings' is empty, 'fileencoding' is not modified.
2838 See 'fileencoding' for the possible values.
2839 Setting this option does not have an effect until the next time a file
2840 is read.
2841
2842 *'fileformat'* *'ff'*
2843'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2844 Unix default: "unix",
2845 Macintosh default: "mac")
2846 local to buffer
2847 {not in Vi}
2848 This gives the <EOL> of the current buffer, which is used for
2849 reading/writing the buffer from/to a file:
2850 dos <CR> <NL>
2851 unix <NL>
2852 mac <CR>
2853 When "dos" is used, CTRL-Z at the end of a file is ignored.
2854 See |file-formats| and |file-read|.
2855 For the character encoding of the file see 'fileencoding'.
2856 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2857 works like it was set to "unix'.
2858 This option is set automatically when starting to edit a file and
2859 'fileformats' is not empty and 'binary' is off.
2860 When this option is set, after starting to edit a file, the 'modified'
2861 option is set, because the file would be different when written.
2862 This option can not be changed when 'modifiable' is off.
2863 For backwards compatibility: When this option is set to "dos",
2864 'textmode' is set, otherwise 'textmode' is reset.
2865
2866 *'fileformats'* *'ffs'*
2867'fileformats' 'ffs' string (default:
2868 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2869 Vim Unix: "unix,dos",
2870 Vim Mac: "mac,unix,dos",
2871 Vi Cygwin: "unix,dos",
2872 Vi others: "")
2873 global
2874 {not in Vi}
2875 This gives the end-of-line (<EOL>) formats that will be tried when
2876 starting to edit a new buffer and when reading a file into an existing
2877 buffer:
2878 - When empty, the format defined with 'fileformat' will be used
2879 always. It is not set automatically.
2880 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 'fileformats' name will be used when a file is read into an existing
2883 buffer, no matter what 'fileformat' for that buffer is set to.
2884 - When more than one name is present, separated by commas, automatic
2885 <EOL> detection will be done when reading a file. When starting to
2886 edit a file, a check is done for the <EOL>:
2887 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2888 'fileformat' is set to "dos".
2889 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002890 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002892 3. If 'fileformat' has not yet been set, and if 'fileformats'
2893 includes "mac", 'fileformat' is set to "mac".
2894 This means that "mac" is only chosen when:
2895 "unix" is not present or no <NL> is found in the file, and
2896 "dos" is not present or no <CR><NL> is found in the file.
2897 Except: if "unix" was chosen, but there is a <CR> before
2898 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002899 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 4. If 'fileformat' is still not set, the first name from
2901 'fileformats' is used.
2902 When reading a file into an existing buffer, the same is done, but
2903 this happens like 'fileformat' has been set appropriately for that
2904 file only, the option is not changed.
2905 When 'binary' is set, the value of 'fileformats' is not used.
2906
Bram Moolenaar81af9252010-12-10 20:35:50 +01002907 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002908 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002909
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2911 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2912 done:
2913 - When 'fileformats' is empty, there is no automatic detection. Dos
2914 format will be used.
2915 - When 'fileformats' is set to one or more names, automatic detection
2916 is done. This is based on the first <NL> in the file: If there is a
2917 <CR> in front of it, Dos format is used, otherwise Unix format is
2918 used.
2919 Also see |file-formats|.
2920 For backwards compatibility: When this option is set to an empty
2921 string or one format (no comma is included), 'textauto' is reset,
2922 otherwise 'textauto' is set.
2923 NOTE: This option is set to the Vi default value when 'compatible' is
2924 set and to the Vim default value when 'compatible' is reset.
2925
2926 *'filetype'* *'ft'*
2927'filetype' 'ft' string (default: "")
2928 local to buffer
2929 {not in Vi}
2930 {not available when compiled without the |+autocmd|
2931 feature}
2932 When this option is set, the FileType autocommand event is triggered.
2933 All autocommands that match with the value of this option will be
2934 executed. Thus the value of 'filetype' is used in place of the file
2935 name.
2936 Otherwise this option does not always reflect the current file type.
2937 This option is normally set when the file type is detected. To enable
2938 this use the ":filetype on" command. |:filetype|
2939 Setting this option to a different value is most useful in a modeline,
2940 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002941 Example, for in an IDL file:
2942 /* vim: set filetype=idl : */ ~
2943 |FileType| |filetypes|
2944 When a dot appears in the value then this separates two filetype
2945 names. Example:
2946 /* vim: set filetype=c.doxygen : */ ~
2947 This will use the "c" filetype first, then the "doxygen" filetype.
2948 This works both for filetype plugins and for syntax files. More than
2949 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 This option is not copied to another buffer, independent of the 's' or
2951 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002952 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953
2954 *'fillchars'* *'fcs'*
2955'fillchars' 'fcs' string (default "vert:|,fold:-")
2956 global
2957 {not in Vi}
2958 {not available when compiled without the |+windows|
2959 and |+folding| features}
2960 Characters to fill the statuslines and vertical separators.
2961 It is a comma separated list of items:
2962
2963 item default Used for ~
2964 stl:c ' ' or '^' statusline of the current window
2965 stlnc:c ' ' or '-' statusline of the non-current windows
2966 vert:c '|' vertical separators |:vsplit|
2967 fold:c '-' filling 'foldtext'
2968 diff:c '-' deleted lines of the 'diff' option
2969
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002970 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 "stlnc" the space will be used when there is highlighting, '^' or '-'
2972 otherwise.
2973
2974 Example: >
2975 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2976< This is similar to the default, except that these characters will also
2977 be used when there is highlighting.
2978
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002979 for "stl" and "stlnc" only single-byte values are supported.
2980
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 The highlighting used for these items:
2982 item highlight group ~
2983 stl:c StatusLine |hl-StatusLine|
2984 stlnc:c StatusLineNC |hl-StatusLineNC|
2985 vert:c VertSplit |hl-VertSplit|
2986 fold:c Folded |hl-Folded|
2987 diff:c DiffDelete |hl-DiffDelete|
2988
2989 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2990'fkmap' 'fk' boolean (default off) *E198*
2991 global
2992 {not in Vi}
2993 {only available when compiled with the |+rightleft|
2994 feature}
2995 When on, the keyboard is mapped for the Farsi character set.
2996 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002997 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998
2999 *'foldclose'* *'fcl'*
3000'foldclose' 'fcl' string (default "")
3001 global
3002 {not in Vi}
3003 {not available when compiled without the |+folding|
3004 feature}
3005 When set to "all", a fold is closed when the cursor isn't in it and
3006 its level is higher than 'foldlevel'. Useful if you want folds to
3007 automatically close when moving out of them.
3008
3009 *'foldcolumn'* *'fdc'*
3010'foldcolumn' 'fdc' number (default 0)
3011 local to window
3012 {not in Vi}
3013 {not available when compiled without the |+folding|
3014 feature}
3015 When non-zero, a column with the specified width is shown at the side
3016 of the window which indicates open and closed folds. The maximum
3017 value is 12.
3018 See |folding|.
3019
3020 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3021'foldenable' 'fen' boolean (default on)
3022 local to window
3023 {not in Vi}
3024 {not available when compiled without the |+folding|
3025 feature}
3026 When off, all folds are open. This option can be used to quickly
3027 switch between showing all text unfolded and viewing the text with
3028 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003029 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 'foldenable' is off.
3031 This option is set by commands that create a new fold or close a fold.
3032 See |folding|.
3033
3034 *'foldexpr'* *'fde'*
3035'foldexpr' 'fde' string (default: "0")
3036 local to window
3037 {not in Vi}
3038 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003039 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003041 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003042
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003043 The expression may be evaluated in the |sandbox|, see
3044 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003045 This option can't be set from a |modeline| when the 'diff' option is
3046 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003047
3048 It is not allowed to change text or jump to another window while
3049 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050
3051 *'foldignore'* *'fdi'*
3052'foldignore' 'fdi' string (default: "#")
3053 local to window
3054 {not in Vi}
3055 {not available when compiled without the |+folding|
3056 feature}
3057 Used only when 'foldmethod' is "indent". Lines starting with
3058 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003059 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 The default "#" works well for C programs. See |fold-indent|.
3061
3062 *'foldlevel'* *'fdl'*
3063'foldlevel' 'fdl' number (default: 0)
3064 local to window
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
3067 feature}
3068 Sets the fold level: Folds with a higher level will be closed.
3069 Setting this option to zero will close all folds. Higher numbers will
3070 close fewer folds.
3071 This option is set by commands like |zm|, |zM| and |zR|.
3072 See |fold-foldlevel|.
3073
3074 *'foldlevelstart'* *'fdls'*
3075'foldlevelstart' 'fdls' number (default: -1)
3076 global
3077 {not in Vi}
3078 {not available when compiled without the |+folding|
3079 feature}
3080 Sets 'foldlevel' when starting to edit another buffer in a window.
3081 Useful to always start editing with all folds closed (value zero),
3082 some folds closed (one) or no folds closed (99).
3083 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003084 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 ignores this option and closes all folds.
3086 It is also done before BufReadPre autocommands, to allow an autocmd to
3087 overrule the 'foldlevel' value for specific files.
3088 When the value is negative, it is not used.
3089
3090 *'foldmarker'* *'fmr'* *E536*
3091'foldmarker' 'fmr' string (default: "{{{,}}}")
3092 local to window
3093 {not in Vi}
3094 {not available when compiled without the |+folding|
3095 feature}
3096 The start and end marker used when 'foldmethod' is "marker". There
3097 must be one comma, which separates the start and end marker. The
3098 marker is a literal string (a regular expression would be too slow).
3099 See |fold-marker|.
3100
3101 *'foldmethod'* *'fdm'*
3102'foldmethod' 'fdm' string (default: "manual")
3103 local to window
3104 {not in Vi}
3105 {not available when compiled without the |+folding|
3106 feature}
3107 The kind of folding used for the current window. Possible values:
3108 |fold-manual| manual Folds are created manually.
3109 |fold-indent| indent Lines with equal indent form a fold.
3110 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3111 |fold-marker| marker Markers are used to specify folds.
3112 |fold-syntax| syntax Syntax highlighting items specify folds.
3113 |fold-diff| diff Fold text that is not changed.
3114
3115 *'foldminlines'* *'fml'*
3116'foldminlines' 'fml' number (default: 1)
3117 local to window
3118 {not in Vi}
3119 {not available when compiled without the |+folding|
3120 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003121 Sets the number of screen lines above which a fold can be displayed
3122 closed. Also for manually closed folds. With the default value of
3123 one a fold can only be closed if it takes up two or more screen lines.
3124 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003125 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126 "zc" to close a fold, which is displayed open because it's smaller
3127 than 'foldminlines', a following "zc" may close a containing fold.
3128
3129 *'foldnestmax'* *'fdn'*
3130'foldnestmax' 'fdn' number (default: 20)
3131 local to window
3132 {not in Vi}
3133 {not available when compiled without the |+folding|
3134 feature}
3135 Sets the maximum nesting of folds for the "indent" and "syntax"
3136 methods. This avoids that too many folds will be created. Using more
3137 than 20 doesn't work, because the internal limit is 20.
3138
3139 *'foldopen'* *'fdo'*
3140'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3141 search,tag,undo")
3142 global
3143 {not in Vi}
3144 {not available when compiled without the |+folding|
3145 feature}
3146 Specifies for which type of commands folds will be opened, if the
3147 command moves the cursor into a closed fold. It is a comma separated
3148 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003149 NOTE: When the command is part of a mapping this option is not used.
3150 Add the |zv| command to the mapping to get the same effect.
3151 (rationale: the mapping may want to control opening folds itself)
3152
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 item commands ~
3154 all any
3155 block "(", "{", "[[", "[{", etc.
3156 hor horizontal movements: "l", "w", "fx", etc.
3157 insert any command in Insert mode
3158 jump far jumps: "G", "gg", etc.
3159 mark jumping to a mark: "'m", CTRL-O, etc.
3160 percent "%"
3161 quickfix ":cn", ":crew", ":make", etc.
3162 search search for a pattern: "/", "n", "*", "gd", etc.
3163 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003164 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003165 tag jumping to a tag: ":ta", CTRL-T, etc.
3166 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 When a movement command is used for an operator (e.g., "dl" or "y%")
3168 this option is not used. This means the operator will include the
3169 whole closed fold.
3170 Note that vertical movements are not here, because it would make it
3171 very difficult to move onto a closed fold.
3172 In insert mode the folds containing the cursor will always be open
3173 when text is inserted.
3174 To close folds you can re-apply 'foldlevel' with the |zx| command or
3175 set the 'foldclose' option to "all".
3176
3177 *'foldtext'* *'fdt'*
3178'foldtext' 'fdt' string (default: "foldtext()")
3179 local to window
3180 {not in Vi}
3181 {not available when compiled without the |+folding|
3182 feature}
3183 An expression which is used to specify the text displayed for a closed
3184 fold. See |fold-foldtext|.
3185
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003186 The expression may be evaluated in the |sandbox|, see
3187 |sandbox-option|.
3188
3189 It is not allowed to change text or jump to another window while
3190 evaluating 'foldtext' |textlock|.
3191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 *'formatoptions'* *'fo'*
3193'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3194 local to buffer
3195 {not in Vi}
3196 This is a sequence of letters which describes how automatic
3197 formatting is to be done. See |fo-table|. When the 'paste' option is
3198 on, no formatting is done (like 'formatoptions' is empty). Commas can
3199 be inserted for readability.
3200 To avoid problems with flags that are added in the future, use the
3201 "+=" and "-=" feature of ":set" |add-option-flags|.
3202 NOTE: This option is set to the Vi default value when 'compatible' is
3203 set and to the Vim default value when 'compatible' is reset.
3204
Bram Moolenaar86b68352004-12-27 21:59:20 +00003205 *'formatlistpat'* *'flp'*
3206'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3207 local to buffer
3208 {not in Vi}
3209 A pattern that is used to recognize a list header. This is used for
3210 the "n" flag in 'formatoptions'.
3211 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003212 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003213 while still checking more characters. There must be a character
3214 following the pattern, when it matches the whole line it is handled
3215 like there is no match.
3216 The default recognizes a number, followed by an optional punctuation
3217 character and white space.
3218
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 *'formatprg'* *'fp'*
3220'formatprg' 'fp' string (default "")
3221 global
3222 {not in Vi}
3223 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003224 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003226 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003227 If the 'formatexpr' option is not empty it will be used instead.
3228 Otherwise, if 'formatprg' option is an empty string, the internal
3229 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003230 Environment variables are expanded |:set_env|. See |option-backslash|
3231 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003232 The expression may be evaluated in the |sandbox|, see
3233 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003235 *'formatexpr'* *'fex'*
3236'formatexpr' 'fex' string (default "")
3237 local to buffer
3238 {not in Vi}
3239 {not available when compiled without the |+eval|
3240 feature}
3241 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003242 operator or automatic formatting (see 'formatoptions'). When this
3243 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003244
3245 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003246 The |v:count| variable holds the number of lines to be formatted.
3247 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003248 inserted if the expression is being evaluated due to
3249 automatic formatting. This can be empty. Don't insert
3250 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003251
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003252 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003253 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003254< This will invoke the mylang#Format() function in the
3255 autoload/mylang.vim file in 'runtimepath'. |autoload|
3256
3257 The expression is also evaluated when 'textwidth' is set and adding
3258 text beyond that limit. This happens under the same conditions as
3259 when internal formatting is used. Make sure the cursor is kept in the
3260 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003261 return "i" or "R" in this situation.
3262
3263 When the expression evaluates to non-zero Vim will fall back to using
3264 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003265
3266 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003267 |sandbox-option|. That stops the option from working, since changing
3268 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003269
3270 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003271'fsync' 'fs' boolean (default on)
3272 global
3273 {not in Vi}
3274 When on, the library function fsync() will be called after writing a
3275 file. This will flush a file to disk, ensuring that it is safely
3276 written even on filesystems which do metadata-only journaling. This
3277 will force the harddrive to spin up on Linux systems running in laptop
3278 mode, so it may be undesirable in some situations. Be warned that
3279 turning this off increases the chances of data loss after a crash. On
3280 systems without an fsync() implementation, this variable is always
3281 off.
3282 Also see 'swapsync' for controlling fsync() on swap files.
3283
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3285'gdefault' 'gd' boolean (default off)
3286 global
3287 {not in Vi}
3288 When on, the ":substitute" flag 'g' is default on. This means that
3289 all matches in a line are substituted instead of one. When a 'g' flag
3290 is given to a ":substitute" command, this will toggle the substitution
3291 of all or one match. See |complex-change|.
3292
3293 command 'gdefault' on 'gdefault' off ~
3294 :s/// subst. all subst. one
3295 :s///g subst. one subst. all
3296 :s///gg subst. all subst. one
3297
3298 NOTE: This option is reset when 'compatible' is set.
3299
3300 *'grepformat'* *'gfm'*
3301'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3302 global
3303 {not in Vi}
3304 Format to recognize for the ":grep" command output.
3305 This is a scanf-like string that uses the same format as the
3306 'errorformat' option: see |errorformat|.
3307
3308 *'grepprg'* *'gp'*
3309'grepprg' 'gp' string (default "grep -n ",
3310 Unix: "grep -n $* /dev/null",
3311 Win32: "findstr /n" or "grep -n",
3312 VMS: "SEARCH/NUMBERS ")
3313 global or local to buffer |global-local|
3314 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003315 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 and '#' characters, which are expanded like when used in a command-
3317 line. The placeholder "$*" is allowed to specify where the arguments
3318 will be included. Environment variables are expanded |:set_env|. See
3319 |option-backslash| about including spaces and backslashes.
3320 When your "grep" accepts the "-H" argument, use this to make ":grep"
3321 also work well with a single file: >
3322 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003323< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003324 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3325 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003326 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 apply equally to 'grepprg'.
3328 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3329 otherwise it's "grep -n".
3330 This option cannot be set from a |modeline| or in the |sandbox|, for
3331 security reasons.
3332
3333 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3334'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3335 ve:ver35-Cursor,
3336 o:hor50-Cursor,
3337 i-ci:ver25-Cursor/lCursor,
3338 r-cr:hor20-Cursor/lCursor,
3339 sm:block-Cursor
3340 -blinkwait175-blinkoff150-blinkon175",
3341 for MS-DOS and Win32 console:
3342 "n-v-c:block,o:hor50,i-ci:hor15,
3343 r-cr:hor30,sm:block")
3344 global
3345 {not in Vi}
3346 {only available when compiled with GUI enabled, and
3347 for MS-DOS and Win32 console}
3348 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003349 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003350 the height of the cursor can be changed. This can be done by
3351 specifying a block cursor, or a percentage for a vertical or
3352 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003353 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003355 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 mode-list and an argument-list:
3357 mode-list:argument-list,mode-list:argument-list,..
3358 The mode-list is a dash separated list of these modes:
3359 n Normal mode
3360 v Visual mode
3361 ve Visual mode with 'selection' "exclusive" (same as 'v',
3362 if not specified)
3363 o Operator-pending mode
3364 i Insert mode
3365 r Replace mode
3366 c Command-line Normal (append) mode
3367 ci Command-line Insert mode
3368 cr Command-line Replace mode
3369 sm showmatch in Insert mode
3370 a all modes
3371 The argument-list is a dash separated list of these arguments:
3372 hor{N} horizontal bar, {N} percent of the character height
3373 ver{N} vertical bar, {N} percent of the character width
3374 block block cursor, fills the whole character
3375 [only one of the above three should be present]
3376 blinkwait{N} *cursor-blinking*
3377 blinkon{N}
3378 blinkoff{N}
3379 blink times for cursor: blinkwait is the delay before
3380 the cursor starts blinking, blinkon is the time that
3381 the cursor is shown and blinkoff is the time that the
3382 cursor is not shown. The times are in msec. When one
3383 of the numbers is zero, there is no blinking. The
3384 default is: "blinkwait700-blinkon400-blinkoff250".
3385 These numbers are used for a missing entry. This
3386 means that blinking is enabled by default. To switch
3387 blinking off you can use "blinkon0". The cursor only
3388 blinks when Vim is waiting for input, not while
3389 executing a command.
3390 To make the cursor blink in an xterm, see
3391 |xterm-blink|.
3392 {group-name}
3393 a highlight group name, that sets the color and font
3394 for the cursor
3395 {group-name}/{group-name}
3396 Two highlight group names, the first is used when
3397 no language mappings are used, the other when they
3398 are. |language-mapping|
3399
3400 Examples of parts:
3401 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3402 block cursor with colors from the "nCursor"
3403 highlight group
3404 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3405 In Insert and Command-line Insert mode, use a
3406 30% vertical bar cursor with colors from the
3407 "iCursor" highlight group. Blink a bit
3408 faster.
3409
3410 The 'a' mode is different. It will set the given argument-list for
3411 all modes. It does not reset anything to defaults. This can be used
3412 to do a common setting for all modes. For example, to switch off
3413 blinking: "a:blinkon0"
3414
3415 Examples of cursor highlighting: >
3416 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3417 :highlight Cursor gui=NONE guifg=bg guibg=fg
3418<
3419 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003420 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421'guifont' 'gfn' string (default "")
3422 global
3423 {not in Vi}
3424 {only available when compiled with GUI enabled}
3425 This is a list of fonts which will be used for the GUI version of Vim.
3426 In its simplest form the value is just one font name. When
3427 the font cannot be found you will get an error message. To try other
3428 font names a list can be specified, font names separated with commas.
3429 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003430
Bram Moolenaar05159a02005-02-26 23:04:13 +00003431 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3432 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003433
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434 Spaces after a comma are ignored. To include a comma in a font name
3435 precede it with a backslash. Setting an option requires an extra
3436 backslash before a space and a backslash. See also
3437 |option-backslash|. For example: >
3438 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003439< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003441
3442 If none of the fonts can be loaded, Vim will keep the current setting.
3443 If an empty font list is given, Vim will try using other resource
3444 settings (for X, it will use the Vim.font resource), and finally it
3445 will try some builtin default which should always be there ("7x13" in
3446 the case of X). The font names given should be "normal" fonts. Vim
3447 will try to find the related bold and italic fonts.
3448
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003449 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003450 :set guifont=*
3451< will bring up a font requester, where you can pick the font you want.
3452
3453 The font name depends on the GUI used. See |setting-guifont| for a
3454 way to set 'guifont' for various systems.
3455
Bram Moolenaar071d4272004-06-13 20:20:40 +00003456 For the GTK+ 2 GUI the font name looks like this: >
3457 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003458< That's all. XLFDs are not used. For Chinese this is reported to work
3459 well: >
3460 if has("gui_gtk2")
3461 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3462 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3463 endif
3464<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003465 For Mac OSX you can use something like this: >
3466 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003467< Also see 'macatsui', it can help fix display problems.
3468 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003470 width). An exception is GTK 2: all fonts are accepted, but
3471 mono-spaced fonts look best.
3472
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 To preview a font on X11, you might be able to use the "xfontsel"
3474 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003475
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 For the Win32 GUI *E244* *E245*
3477 - takes these options in the font name:
3478 hXX - height is XX (points, can be floating-point)
3479 wXX - width is XX (points, can be floating-point)
3480 b - bold
3481 i - italic
3482 u - underline
3483 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003484 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3486 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3487 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003488 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489
3490 Use a ':' to separate the options.
3491 - A '_' can be used in the place of a space, so you don't need to use
3492 backslashes to escape the spaces.
3493 - Examples: >
3494 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3495 :set guifont=Andale_Mono:h7.5:w4.5
3496< See also |font-sizes|.
3497
3498 *'guifontset'* *'gfs'*
3499 *E250* *E252* *E234* *E597* *E598*
3500'guifontset' 'gfs' string (default "")
3501 global
3502 {not in Vi}
3503 {only available when compiled with GUI enabled and
3504 with the |+xfontset| feature}
3505 {not available in the GTK+ 2 GUI}
3506 When not empty, specifies two (or more) fonts to be used. The first
3507 one for normal English, the second one for your special language. See
3508 |xfontset|.
3509 Setting this option also means that all font names will be handled as
3510 a fontset name. Also the ones used for the "font" argument of the
3511 |:highlight| command.
3512 The fonts must match with the current locale. If fonts for the
3513 character sets that the current locale uses are not included, setting
3514 'guifontset' will fail.
3515 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3516 the comma-separated names are alternative names, one of which will be
3517 used. In 'guifontset' the whole string is one fontset name,
3518 including the commas. It is not possible to specify alternative
3519 fontset names.
3520 This example works on many X11 systems: >
3521 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3522<
3523 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3524'guifontwide' 'gfw' string (default "")
3525 global
3526 {not in Vi}
3527 {only available when compiled with GUI enabled}
3528 When not empty, specifies a comma-separated list of fonts to be used
3529 for double-width characters. The first font that can be loaded is
3530 used.
3531 Note: The size of these fonts must be exactly twice as wide as the one
3532 specified with 'guifont' and the same height.
3533
3534 All GUI versions but GTK+ 2:
3535
3536 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3537 'guifontset' is empty or invalid.
3538 When 'guifont' is set and a valid font is found in it and
3539 'guifontwide' is empty Vim will attempt to find a matching
3540 double-width font and set 'guifontwide' to it.
3541
3542 GTK+ 2 GUI only: *guifontwide_gtk2*
3543
3544 If set and valid, 'guifontwide' is always used for double width
3545 characters, even if 'encoding' is not set to "utf-8".
3546 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 font for characters not available in 'guifont'. Thus you do not need
3549 to set 'guifontwide' at all unless you want to override the choice
3550 made by Pango/Xft.
3551
3552 *'guiheadroom'* *'ghr'*
3553'guiheadroom' 'ghr' number (default 50)
3554 global
3555 {not in Vi} {only for GTK and X11 GUI}
3556 The number of pixels subtracted from the screen height when fitting
3557 the GUI window on the screen. Set this before the GUI is started,
3558 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003559 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 lines will be left for window decorations and other items on the
3561 screen. Set it to a negative value to allow windows taller than the
3562 screen.
3563
3564 *'guioptions'* *'go'*
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003565'guioptions' 'go' string (default "egmrLtT" (MS-Windows),
3566 "aegimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003567 global
3568 {not in Vi}
3569 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003570 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 sequence of letters which describes what components and options of the
3572 GUI should be used.
3573 To avoid problems with flags that are added in the future, use the
3574 "+=" and "-=" feature of ":set" |add-option-flags|.
3575
3576 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003577 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 'a' Autoselect: If present, then whenever VISUAL mode is started,
3579 or the Visual area extended, Vim tries to become the owner of
3580 the windowing system's global selection. This means that the
3581 Visually highlighted text is available for pasting into other
3582 applications as well as into Vim itself. When the Visual mode
3583 ends, possibly due to an operation on the text, or when an
3584 application wants to paste the selection, the highlighted text
3585 is automatically yanked into the "* selection register.
3586 Thus the selection is still available for pasting into other
3587 applications after the VISUAL mode has ended.
3588 If not present, then Vim won't become the owner of the
3589 windowing system's global selection unless explicitly told to
3590 by a yank or delete operation for the "* register.
3591 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003592 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003593 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 applies to the modeless selection.
3595
3596 'guioptions' autoselect Visual autoselect modeless ~
3597 "" - -
3598 "a" yes yes
3599 "A" - yes
3600 "aA" yes yes
3601
Bram Moolenaar02467872007-05-06 13:22:01 +00003602 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 'c' Use console dialogs instead of popup dialogs for simple
3604 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003605 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003606 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003607 'guitablabel' can be used to change the text in the labels.
3608 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003609 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003610 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003611 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 'f' Foreground: Don't use fork() to detach the GUI from the shell
3613 where it was started. Use this for programs that wait for the
3614 editor to finish (e.g., an e-mail program). Alternatively you
3615 can use "gvim -f" or ":gui -f" to start the GUI in the
3616 foreground. |gui-fork|
3617 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003618 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003619 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3621 corner of the window. It's black&white on non-GTK, because of
3622 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003623 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003625 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003626 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003627 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003628 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003629 file is sourced the system menu has already been loaded; the
3630 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003631 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632 'g' Grey menu items: Make menu items that are not active grey. If
3633 'g' is not included inactive menu items are not shown at all.
3634 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003635 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003636 't' Include tearoff menu items. Currently only works for Win32,
3637 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003638 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003639 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003640 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003641 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003642 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003643 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644 'R' Right-hand scrollbar is present when there is a vertically
3645 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003646 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003647 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003648 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003649 'L' Left-hand scrollbar is present when there is a vertically
3650 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003651 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3653 the longest visible line, or on the cursor line if the 'h'
3654 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003655 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 'h' Limit horizontal scrollbar size to the length of the cursor
3657 line. Reduces computations. |gui-horiz-scroll|
3658
3659 And yes, you may even have scrollbars on the left AND the right if
3660 you really want to :-). See |gui-scrollbars| for more information.
3661
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003662 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663 'v' Use a vertical button layout for dialogs. When not included,
3664 a horizontal layout is preferred, but when it doesn't fit a
3665 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003666 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 'p' Use Pointer callbacks for X11 GUI. This is required for some
3668 window managers. If the cursor is not blinking or hollow at
3669 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003670 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003672 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003673 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674
Bram Moolenaar02467872007-05-06 13:22:01 +00003675
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 *'guipty'* *'noguipty'*
3677'guipty' boolean (default on)
3678 global
3679 {not in Vi}
3680 {only available when compiled with GUI enabled}
3681 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3682 I/O to/from shell commands. See |gui-pty|.
3683
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003684 *'guitablabel'* *'gtl'*
3685'guitablabel' 'gtl' string (default empty)
3686 global
3687 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003688 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003689 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003690 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003691 pages line. When empty and when the result is empty Vim will use a
3692 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003693
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003694 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003695 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003696
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003697 Only used when the GUI tab pages line is displayed. 'e' must be
3698 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3699 used.
3700
Bram Moolenaar57657d82006-04-21 22:12:41 +00003701 *'guitabtooltip'* *'gtt'*
3702'guitabtooltip' 'gtt' string (default empty)
3703 global
3704 {not in Vi}
3705 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003706 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003707 When nonempty describes the text to use in a tooltip for the GUI tab
3708 pages line. When empty Vim will use a default tooltip.
3709 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003710 You can include a line break. Simplest method is to use |:let|: >
3711 :let &guitabtooltip = "line one\nline two"
3712<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003713
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 *'helpfile'* *'hf'*
3715'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3716 (others) "$VIMRUNTIME/doc/help.txt")
3717 global
3718 {not in Vi}
3719 Name of the main help file. All distributed help files should be
3720 placed together in one directory. Additionally, all "doc" directories
3721 in 'runtimepath' will be used.
3722 Environment variables are expanded |:set_env|. For example:
3723 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003724 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 spaces and backslashes.
3726 This option cannot be set from a |modeline| or in the |sandbox|, for
3727 security reasons.
3728
3729 *'helpheight'* *'hh'*
3730'helpheight' 'hh' number (default 20)
3731 global
3732 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003733 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 feature}
3735 Minimal initial height of the help window when it is opened with the
3736 ":help" command. The initial height of the help window is half of the
3737 current window, or (when the 'ea' option is on) the same as other
3738 windows. When the height is less than 'helpheight', the height is
3739 set to 'helpheight'. Set to zero to disable.
3740
3741 *'helplang'* *'hlg'*
3742'helplang' 'hlg' string (default: messages language or empty)
3743 global
3744 {only available when compiled with the |+multi_lang|
3745 feature}
3746 {not in Vi}
3747 Comma separated list of languages. Vim will use the first language
3748 for which the desired help can be found. The English help will always
3749 be used as a last resort. You can add "en" to prefer English over
3750 another language, but that will only find tags that exist in that
3751 language and not in the English help.
3752 Example: >
3753 :set helplang=de,it
3754< This will first search German, then Italian and finally English help
3755 files.
3756 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3757 try to find the tag in the current language before using this option.
3758 See |help-translated|.
3759
3760 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3761'hidden' 'hid' boolean (default off)
3762 global
3763 {not in Vi}
3764 When off a buffer is unloaded when it is |abandon|ed. When on a
3765 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3766 displayed in another window, it does not become hidden, of course.
3767 The commands that move through the buffer list sometimes make a buffer
3768 hidden although the 'hidden' option is off: When the buffer is
3769 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003770 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003771 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 This option is set for one command with ":hide {command}" |:hide|.
3773 WARNING: It's easy to forget that you have changes in hidden buffers.
3774 Think twice when using ":q!" or ":qa!".
3775
3776 *'highlight'* *'hl'*
3777'highlight' 'hl' string (default (as a single string):
3778 "8:SpecialKey,@:NonText,d:Directory,
3779 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003780 M:ModeMsg,n:LineNr,N:CursorLineNr,
3781 r:Question,s:StatusLine,S:StatusLineNC,
3782 c:VertSplit, t:Title,v:Visual,
3783 w:WarningMsg,W:WildMenu,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 f:Folded,F:FoldColumn,A:DiffAdd,
3785 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003786 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003787 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003788 +:Pmenu,=:PmenuSel,
3789 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 global
3791 {not in Vi}
3792 This option can be used to set highlighting mode for various
3793 occasions. It is a comma separated list of character pairs. The
3794 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003795 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3797 |hl-NonText| @ '~' and '@' at the end of the window and
3798 characters from 'showbreak'
3799 |hl-Directory| d directories in CTRL-D listing and other special
3800 things in listings
3801 |hl-ErrorMsg| e error messages
3802 h (obsolete, ignored)
3803 |hl-IncSearch| i 'incsearch' highlighting
3804 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3805 |hl-MoreMsg| m |more-prompt|
3806 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003807 |hl-LineNr| n line number for ":number" and ":#" commands, and
3808 when 'number' or 'relativenumber' option is set.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02003809 |hl-CursorLineNr| N like n for when 'cursorline' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 |hl-Question| r |hit-enter| prompt and yes/no questions
3811 |hl-StatusLine| s status line of current window |status-line|
3812 |hl-StatusLineNC| S status lines of not-current windows
3813 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3814 |hl-VertSplit| c column used to separate vertically split windows
3815 |hl-Visual| v Visual mode
3816 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3817 Selection" Only X11 Gui's |gui-x11| and
3818 |xterm-clipboard|.
3819 |hl-WarningMsg| w warning messages
3820 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3821 |hl-Folded| f line used for closed folds
3822 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003823 |hl-DiffAdd| A added line in diff mode
3824 |hl-DiffChange| C changed line in diff mode
3825 |hl-DiffDelete| D deleted line in diff mode
3826 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003828 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003829 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003830 |hl-SpellRare| R rare word |spell|
3831 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003832 |hl-Conceal| - the placeholders used for concealed characters
3833 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003834 |hl-Pmenu| + popup menu normal line
3835 |hl-PmenuSel| = popup menu normal line
3836 |hl-PmenuSbar| x popup menu scrollbar
3837 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838
3839 The display modes are:
3840 r reverse (termcap entry "mr" and "me")
3841 i italic (termcap entry "ZH" and "ZR")
3842 b bold (termcap entry "md" and "me")
3843 s standout (termcap entry "so" and "se")
3844 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003845 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 n no highlighting
3847 - no highlighting
3848 : use a highlight group
3849 The default is used for occasions that are not included.
3850 If you want to change what the display modes do, see |dos-colors|
3851 for an example.
3852 When using the ':' display mode, this must be followed by the name of
3853 a highlight group. A highlight group can be used to define any type
3854 of highlighting, including using color. See |:highlight| on how to
3855 define one. The default uses a different group for each occasion.
3856 See |highlight-default| for the default highlight groups.
3857
3858 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3859'hlsearch' 'hls' boolean (default off)
3860 global
3861 {not in Vi}
3862 {not available when compiled without the
3863 |+extra_search| feature}
3864 When there is a previous search pattern, highlight all its matches.
3865 The type of highlighting used can be set with the 'l' occasion in the
3866 'highlight' option. This uses the "Search" highlight group by
3867 default. Note that only the matching text is highlighted, any offsets
3868 are not applied.
3869 See also: 'incsearch' and |:match|.
3870 When you get bored looking at the highlighted matches, you can turn it
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003871 off with |:nohlsearch|. This does not change the option value, as
3872 soon as you use a search command, the highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003873 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 When the search pattern can match an end-of-line, Vim will try to
3875 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003876 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003878 drawn may not continue in a newly drawn line.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01003879 You can specify whether the highlight status is restored on startup
3880 with the 'h' flag in 'viminfo' |viminfo-h|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003881 NOTE: This option is reset when 'compatible' is set.
3882
3883 *'history'* *'hi'*
3884'history' 'hi' number (Vim default: 20, Vi default: 0)
3885 global
3886 {not in Vi}
3887 A history of ":" commands, and a history of previous search patterns
3888 are remembered. This option decides how many entries may be stored in
3889 each of these histories (see |cmdline-editing|).
3890 NOTE: This option is set to the Vi default value when 'compatible' is
3891 set and to the Vim default value when 'compatible' is reset.
3892
3893 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3894'hkmap' 'hk' boolean (default off)
3895 global
3896 {not in Vi}
3897 {only available when compiled with the |+rightleft|
3898 feature}
3899 When on, the keyboard is mapped for the Hebrew character set.
3900 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3901 toggle this option. See |rileft.txt|.
3902 NOTE: This option is reset when 'compatible' is set.
3903
3904 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3905'hkmapp' 'hkp' boolean (default off)
3906 global
3907 {not in Vi}
3908 {only available when compiled with the |+rightleft|
3909 feature}
3910 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3911 This is useful if you have a non-Hebrew keyboard.
3912 See |rileft.txt|.
3913 NOTE: This option is reset when 'compatible' is set.
3914
3915 *'icon'* *'noicon'*
3916'icon' boolean (default off, on when title can be restored)
3917 global
3918 {not in Vi}
3919 {not available when compiled without the |+title|
3920 feature}
3921 When on, the icon text of the window will be set to the value of
3922 'iconstring' (if it is not empty), or to the name of the file
3923 currently being edited. Only the last part of the name is used.
3924 Overridden by the 'iconstring' option.
3925 Only works if the terminal supports setting window icons (currently
3926 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3927 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3928 builtin termcap).
3929 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003930 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003931 X11.
3932
3933 *'iconstring'*
3934'iconstring' string (default "")
3935 global
3936 {not in Vi}
3937 {not available when compiled without the |+title|
3938 feature}
3939 When this option is not empty, it will be used for the icon text of
3940 the window. This happens only when the 'icon' option is on.
3941 Only works if the terminal supports setting window icon text
3942 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3943 Does not work for MS Windows.
3944 When Vim was compiled with HAVE_X11 defined, the original icon will be
3945 restored if possible |X11|.
3946 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003947 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 'titlestring' for example settings.
3949 {not available when compiled without the |+statusline| feature}
3950
3951 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3952'ignorecase' 'ic' boolean (default off)
3953 global
3954 Ignore case in search patterns. Also used when searching in the tags
3955 file.
3956 Also see 'smartcase'.
3957 Can be overruled by using "\c" or "\C" in the pattern, see
3958 |/ignorecase|.
3959
3960 *'imactivatekey'* *'imak'*
3961'imactivatekey' 'imak' string (default "")
3962 global
3963 {not in Vi}
3964 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003965 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003966 Specifies the key that your Input Method in X-Windows uses for
3967 activation. When this is specified correctly, vim can fully control
3968 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3969 You can't use this option to change the activation key, the option
3970 tells Vim what the key is.
3971 Format:
3972 [MODIFIER_FLAG-]KEY_STRING
3973
3974 These characters can be used for MODIFIER_FLAG (case is ignored):
3975 S Shift key
3976 L Lock key
3977 C Control key
3978 1 Mod1 key
3979 2 Mod2 key
3980 3 Mod3 key
3981 4 Mod4 key
3982 5 Mod5 key
3983 Combinations are allowed, for example "S-C-space" or "SC-space" are
3984 both shift+ctrl+space.
3985 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3986
3987 Example: >
3988 :set imactivatekey=S-space
3989< "S-space" means shift+space. This is the activation key for kinput2 +
3990 canna (Japanese), and ami (Korean).
3991
3992 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3993'imcmdline' 'imc' boolean (default off)
3994 global
3995 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003996 {only available when compiled with the |+xim|,
3997 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 When set the Input Method is always on when starting to edit a command
3999 line, unless entering a search pattern (see 'imsearch' for that).
4000 Setting this option is useful when your input method allows entering
4001 English characters directly, e.g., when it's used to type accented
4002 characters with dead keys.
4003
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004004 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005'imdisable' 'imd' boolean (default off, on for some systems (SGI))
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 never used. This is useful to disable
4011 the IM when it doesn't work properly.
4012 Currently this option is on by default for SGI/IRIX machines. This
4013 may change in later releases.
4014
4015 *'iminsert'* *'imi'*
4016'iminsert' 'imi' number (default 0, 2 when an input method is supported)
4017 local to buffer
4018 {not in Vi}
4019 Specifies whether :lmap or an Input Method (IM) is to be used in
4020 Insert mode. Valid values:
4021 0 :lmap is off and IM is off
4022 1 :lmap is ON and IM is off
4023 2 :lmap is off and IM is ON
4024 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
4025 or |global-ime|.
4026 To always reset the option to zero when leaving Insert mode with <Esc>
4027 this can be used: >
4028 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4029< This makes :lmap and IM turn off automatically when leaving Insert
4030 mode.
4031 Note that this option changes when using CTRL-^ in Insert mode
4032 |i_CTRL-^|.
4033 The value is set to 1 when setting 'keymap' to a valid keymap name.
4034 It is also used for the argument of commands like "r" and "f".
4035 The value 0 may not work correctly with Athena and Motif with some XIM
4036 methods. Use 'imdisable' to disable XIM then.
4037
4038 *'imsearch'* *'ims'*
4039'imsearch' 'ims' number (default 0, 2 when an input method is supported)
4040 local to buffer
4041 {not in Vi}
4042 Specifies whether :lmap or an Input Method (IM) is to be used when
4043 entering a search pattern. Valid values:
4044 -1 the value of 'iminsert' is used, makes it look like
4045 'iminsert' is also used when typing a search pattern
4046 0 :lmap is off and IM is off
4047 1 :lmap is ON and IM is off
4048 2 :lmap is off and IM is ON
4049 Note that this option changes when using CTRL-^ in Command-line mode
4050 |c_CTRL-^|.
4051 The value is set to 1 when it is not -1 and setting the 'keymap'
4052 option to a valid keymap name.
4053 The value 0 may not work correctly with Athena and Motif with some XIM
4054 methods. Use 'imdisable' to disable XIM then.
4055
4056 *'include'* *'inc'*
4057'include' 'inc' string (default "^\s*#\s*include")
4058 global or local to buffer |global-local|
4059 {not in Vi}
4060 {not available when compiled without the
4061 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004062 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 pattern, just like for the "/" command (See |pattern|). The default
4064 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004065 "]I", "[d", etc.
4066 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004067 comes after the matched pattern. But if "\zs" appears in the pattern
4068 then the text matched from "\zs" to the end, or until "\ze" if it
4069 appears, is used as the file name. Use this to include characters
4070 that are not in 'isfname', such as a space. You can then use
4071 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004072 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004073
4074 *'includeexpr'* *'inex'*
4075'includeexpr' 'inex' string (default "")
4076 local to buffer
4077 {not in Vi}
4078 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004079 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004081 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004082 :set includeexpr=substitute(v:fname,'\\.','/','g')
4083< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004084
Bram Moolenaar071d4272004-06-13 20:20:40 +00004085 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004086 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004087 Also used for |<cfile>|.
4088
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004089 The expression may be evaluated in the |sandbox|, see
4090 |sandbox-option|.
4091
4092 It is not allowed to change text or jump to another window while
4093 evaluating 'includeexpr' |textlock|.
4094
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4096'incsearch' 'is' boolean (default off)
4097 global
4098 {not in Vi}
4099 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004100 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004101 While typing a search command, show where the pattern, as it was typed
4102 so far, matches. The matched string is highlighted. If the pattern
4103 is invalid or not found, nothing is shown. The screen will be updated
4104 often, this is only useful on fast terminals.
4105 Note that the match will be shown, but the cursor will return to its
4106 original position when no match is found and when pressing <Esc>. You
4107 still need to finish the search command with <Enter> to move the
4108 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004109 When compiled with the |+reltime| feature Vim only searches for about
4110 half a second. With a complicated pattern and/or a lot of text the
4111 match may not be found. This is to avoid that Vim hangs while you
4112 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004113 The highlighting can be set with the 'i' flag in 'highlight'.
4114 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004115 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004116 to the command line. If 'ignorecase' and 'smartcase' are set and the
4117 command line has no uppercase characters, the added character is
4118 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004119 CTRL-R CTRL-W can be used to add the word at the end of the current
4120 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121 NOTE: This option is reset when 'compatible' is set.
4122
4123 *'indentexpr'* *'inde'*
4124'indentexpr' 'inde' string (default "")
4125 local to buffer
4126 {not in Vi}
4127 {not available when compiled without the |+cindent|
4128 or |+eval| features}
4129 Expression which is evaluated to obtain the proper indent for a line.
4130 It is used when a new line is created, for the |=| operator and
4131 in Insert mode as specified with the 'indentkeys' option.
4132 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004133 'smartindent' indenting. When 'lisp' is set, this option is
4134 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 When 'paste' is set this option is not used for indenting.
4136 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004137 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 when the expression is evaluated (but it may be moved around).
4139 The expression must return the number of spaces worth of indent. It
4140 can return "-1" to keep the current indent (this means 'autoindent' is
4141 used for the indent).
4142 Functions useful for computing the indent are |indent()|, |cindent()|
4143 and |lispindent()|.
4144 The evaluation of the expression must not have side effects! It must
4145 not change the text, jump to another window, etc. Afterwards the
4146 cursor position is always restored, thus the cursor may be moved.
4147 Normally this option would be set to call a function: >
4148 :set indentexpr=GetMyIndent()
4149< Error messages will be suppressed, unless the 'debug' option contains
4150 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004151 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152 NOTE: This option is made empty when 'compatible' is set.
4153
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004154 The expression may be evaluated in the |sandbox|, see
4155 |sandbox-option|.
4156
4157 It is not allowed to change text or jump to another window while
4158 evaluating 'indentexpr' |textlock|.
4159
4160
Bram Moolenaar071d4272004-06-13 20:20:40 +00004161 *'indentkeys'* *'indk'*
4162'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4163 local to buffer
4164 {not in Vi}
4165 {not available when compiled without the |+cindent|
4166 feature}
4167 A list of keys that, when typed in Insert mode, cause reindenting of
4168 the current line. Only happens if 'indentexpr' isn't empty.
4169 The format is identical to 'cinkeys', see |indentkeys-format|.
4170 See |C-indenting| and |indent-expression|.
4171
4172 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4173'infercase' 'inf' boolean (default off)
4174 local to buffer
4175 {not in Vi}
4176 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004177 'ignorecase' is also on, the case of the match is adjusted depending
4178 on the typed text. If the typed text contains a lowercase letter
4179 where the match has an upper case letter, the completed part is made
4180 lowercase. If the typed text has no lowercase letters and the match
4181 has a lowercase letter where the typed text has an uppercase letter,
4182 and there is a letter before it, the completed part is made uppercase.
4183 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184
4185 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4186'insertmode' 'im' boolean (default off)
4187 global
4188 {not in Vi}
4189 Makes Vim work in a way that Insert mode is the default mode. Useful
4190 if you want to use Vim as a modeless editor. Used for |evim|.
4191 These Insert mode commands will be useful:
4192 - Use the cursor keys to move around.
4193 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4194 this is a mapping, it is executed as if 'insertmode' was off.
4195 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004197 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4198 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199
4200 These items change when 'insertmode' is set:
4201 - when starting to edit of a file, Vim goes to Insert mode.
4202 - <Esc> in Insert mode is a no-op and beeps.
4203 - <Esc> in Normal mode makes Vim go to Insert mode.
4204 - CTRL-L in Insert mode is a command, it is not inserted.
4205 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4206 However, when <Esc> is used inside a mapping, it behaves like
4207 'insertmode' was not set. This was done to be able to use the same
4208 mappings with 'insertmode' set or not set.
4209 When executing commands with |:normal| 'insertmode' is not used.
4210
4211 NOTE: This option is reset when 'compatible' is set.
4212
4213 *'isfname'* *'isf'*
4214'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4215 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4216 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4217 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4218 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4219 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4220 global
4221 {not in Vi}
4222 The characters specified by this option are included in file names and
4223 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004224 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225 Multi-byte characters 256 and above are always included, only the
4226 characters up to 255 are specified with this option.
4227 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004228 Think twice before adding white space to this option. Although a
4229 space may appear inside a file name, the effect will be that Vim
4230 doesn't know where a file name starts or ends when doing completion.
4231 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232
4233 Note that on systems using a backslash as path separator, Vim tries to
4234 do its best to make it work as you would expect. That is a bit
4235 tricky, since Vi originally used the backslash to escape special
4236 characters. Vim will not remove a backslash in front of a normal file
4237 name character on these systems, but it will on Unix and alikes. The
4238 '&' and '^' are not included by default, because these are special for
4239 cmd.exe.
4240
4241 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004242 Each part can be a single character number or a range. A range is two
4243 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 decimal number between 0 and 255 or the ASCII character itself (does
4245 not work for digits). Example:
4246 "_,-,128-140,#-43" (include '_' and '-' and the range
4247 128 to 140 and '#' to 43)
4248 If a part starts with '^', the following character number or range
4249 will be excluded from the option. The option is interpreted from left
4250 to right. Put the excluded character after the range where it is
4251 included. To include '^' itself use it as the last character of the
4252 option or the end of a range. Example:
4253 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4254 If the character is '@', all characters where isalpha() returns TRUE
4255 are included. Normally these are the characters a to z and A to Z,
4256 plus accented characters. To include '@' itself use "@-@". Examples:
4257 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004258 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 "a-z,A-Z,@-@" All letters plus the '@' character.
4260 A comma can be included by using it where a character number is
4261 expected. Example:
4262 "48-57,,,_" Digits, comma and underscore.
4263 A comma can be excluded by prepending a '^'. Example:
4264 " -~,^,,9" All characters from space to '~', excluding
4265 comma, plus <Tab>.
4266 See |option-backslash| about including spaces and backslashes.
4267
4268 *'isident'* *'isi'*
4269'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4270 "@,48-57,_,128-167,224-235"
4271 otherwise: "@,48-57,_,192-255")
4272 global
4273 {not in Vi}
4274 The characters given by this option are included in identifiers.
4275 Identifiers are used in recognizing environment variables and after a
4276 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004277 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 option.
4279 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004280 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4282
4283 *'iskeyword'* *'isk'*
4284'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4285 "@,48-57,_,128-167,224-235"
4286 otherwise: "@,48-57,_,192-255"
4287 Vi default: "@,48-57,_")
4288 local to buffer
4289 {not in Vi}
4290 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004291 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 'isfname' for a description of the format of this option. For C
4293 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4294 For a help file it is set to all non-blank printable characters except
4295 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4296 command).
4297 When the 'lisp' option is on the '-' character is always included.
4298 NOTE: This option is set to the Vi default value when 'compatible' is
4299 set and to the Vim default value when 'compatible' is reset.
4300
4301 *'isprint'* *'isp'*
4302'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4303 "@,~-255"; otherwise: "@,161-255")
4304 global
4305 {not in Vi}
4306 The characters given by this option are displayed directly on the
4307 screen. It is also used for "\p" in a |pattern|. The characters from
4308 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4309 even when they are not included in 'isprint' or excluded. See
4310 'isfname' for a description of the format of this option.
4311
4312 Non-printable characters are displayed with two characters:
4313 0 - 31 "^@" - "^_"
4314 32 - 126 always single characters
4315 127 "^?"
4316 128 - 159 "~@" - "~_"
4317 160 - 254 "| " - "|~"
4318 255 "~?"
4319 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4320 displayed as <xx>, with the hexadecimal value of the byte.
4321 When 'display' contains "uhex" all unprintable characters are
4322 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004323 The SpecialKey highlighting will be used for unprintable characters.
4324 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325
4326 Multi-byte characters 256 and above are always included, only the
4327 characters up to 255 are specified with this option. When a character
4328 is printable but it is not available in the current font, a
4329 replacement character will be shown.
4330 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4331 There is no option to specify these characters.
4332
4333 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4334'joinspaces' 'js' boolean (default on)
4335 global
4336 {not in Vi}
4337 Insert two spaces after a '.', '?' and '!' with a join command.
4338 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4339 Otherwise only one space is inserted.
4340 NOTE: This option is set when 'compatible' is set.
4341
4342 *'key'*
4343'key' string (default "")
4344 local to buffer
4345 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004346 {only available when compiled with the |+cryptv|
4347 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004348 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004349 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 Careful: Do not set the key value by hand, someone might see the typed
4351 key. Use the |:X| command. But you can make 'key' empty: >
4352 :set key=
4353< It is not possible to get the value of this option with ":set key" or
4354 "echo &key". This is to avoid showing it to someone who shouldn't
4355 know. It also means you cannot see it yourself once you have set it,
4356 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004357 You can use "&key" in an expression to detect whether encryption is
4358 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
4360 *'keymap'* *'kmp'* *E544*
4361'keymap' 'kmp' string (default "")
4362 local to buffer
4363 {not in Vi}
4364 {only available when compiled with the |+keymap|
4365 feature}
4366 Name of a keyboard mapping. See |mbyte-keymap|.
4367 Setting this option to a valid keymap name has the side effect of
4368 setting 'iminsert' to one, so that the keymap becomes effective.
4369 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004370 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371
4372 *'keymodel'* *'km'*
4373'keymodel' 'km' string (default "")
4374 global
4375 {not in Vi}
4376 List of comma separated words, which enable special things that keys
4377 can do. These values can be used:
4378 startsel Using a shifted special key starts selection (either
4379 Select mode or Visual mode, depending on "key" being
4380 present in 'selectmode').
4381 stopsel Using a not-shifted special key stops selection.
4382 Special keys in this context are the cursor keys, <End>, <Home>,
4383 <PageUp> and <PageDown>.
4384 The 'keymodel' option is set by the |:behave| command.
4385
4386 *'keywordprg'* *'kp'*
4387'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4388 OS/2: "view /", VMS: "help")
4389 global or local to buffer |global-local|
4390 {not in Vi}
4391 Program to use for the |K| command. Environment variables are
4392 expanded |:set_env|. ":help" may be used to access the Vim internal
4393 help. (Note that previously setting the global option to the empty
4394 value did this, which is now deprecated.)
4395 When "man" is used, Vim will automatically translate a count for the
4396 "K" command to a section number. Also for "man -s", in which case the
4397 "-s" is removed when there is no count.
4398 See |option-backslash| about including spaces and backslashes.
4399 Example: >
4400 :set keywordprg=man\ -s
4401< This option cannot be set from a |modeline| or in the |sandbox|, for
4402 security reasons.
4403
4404 *'langmap'* *'lmap'* *E357* *E358*
4405'langmap' 'lmap' string (default "")
4406 global
4407 {not in Vi}
4408 {only available when compiled with the |+langmap|
4409 feature}
4410 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004411 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 inserted directly. When in command mode the 'langmap' option takes
4413 care of translating these special characters to the original meaning
4414 of the key. This means you don't have to change the keyboard mode to
4415 be able to execute Normal mode commands.
4416 This is the opposite of the 'keymap' option, where characters are
4417 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004418
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004419 Example (for Greek, in UTF-8): *greek* >
4420 :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 +00004421< Example (exchanges meaning of z and y for commands): >
4422 :set langmap=zy,yz,ZY,YZ
4423<
4424 The 'langmap' option is a list of parts, separated with commas. Each
4425 part can be in one of two forms:
4426 1. A list of pairs. Each pair is a "from" character immediately
4427 followed by the "to" character. Examples: "aA", "aAbBcC".
4428 2. A list of "from" characters, a semi-colon and a list of "to"
4429 characters. Example: "abc;ABC"
4430 Example: "aA,fgh;FGH,cCdDeE"
4431 Special characters need to be preceded with a backslash. These are
4432 ";", ',' and backslash itself.
4433
4434 This will allow you to activate vim actions without having to switch
4435 back and forth between the languages. Your language characters will
4436 be understood as normal vim English characters (according to the
4437 langmap mappings) in the following cases:
4438 o Normal/Visual mode (commands, buffer/register names, user mappings)
4439 o Insert/Replace Mode: Register names after CTRL-R
4440 o Insert/Replace Mode: Mappings
4441 Characters entered in Command-line mode will NOT be affected by
4442 this option. Note that this option can be changed at any time
4443 allowing to switch between mappings for different languages/encodings.
4444 Use a mapping to avoid having to type it each time!
4445
4446 *'langmenu'* *'lm'*
4447'langmenu' 'lm' string (default "")
4448 global
4449 {not in Vi}
4450 {only available when compiled with the |+menu| and
4451 |+multi_lang| features}
4452 Language to use for menu translation. Tells which file is loaded
4453 from the "lang" directory in 'runtimepath': >
4454 "lang/menu_" . &langmenu . ".vim"
4455< (without the spaces). For example, to always use the Dutch menus, no
4456 matter what $LANG is set to: >
4457 :set langmenu=nl_NL.ISO_8859-1
4458< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004459 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 If your $LANG is set to a non-English language but you do want to use
4461 the English menus: >
4462 :set langmenu=none
4463< This option must be set before loading menus, switching on filetype
4464 detection or syntax highlighting. Once the menus are defined setting
4465 this option has no effect. But you could do this: >
4466 :source $VIMRUNTIME/delmenu.vim
4467 :set langmenu=de_DE.ISO_8859-1
4468 :source $VIMRUNTIME/menu.vim
4469< Warning: This deletes all menus that you defined yourself!
4470
4471 *'laststatus'* *'ls'*
4472'laststatus' 'ls' number (default 1)
4473 global
4474 {not in Vi}
4475 The value of this option influences when the last window will have a
4476 status line:
4477 0: never
4478 1: only if there are at least two windows
4479 2: always
4480 The screen looks nicer with a status line if you have several
4481 windows, but it takes another screen line. |status-line|
4482
4483 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4484'lazyredraw' 'lz' boolean (default off)
4485 global
4486 {not in Vi}
4487 When this option is set, the screen will not be redrawn while
4488 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004489 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 update use |:redraw|.
4491
4492 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4493'linebreak' 'lbr' boolean (default off)
4494 local to window
4495 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004496 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004497 feature}
4498 If on Vim will wrap long lines at a character in 'breakat' rather
4499 than at the last character that fits on the screen. Unlike
4500 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4501 it only affects the way the file is displayed, not its contents. The
4502 value of 'showbreak' is used to put in front of wrapped lines.
4503 This option is not used when the 'wrap' option is off or 'list' is on.
4504 Note that <Tab> characters after an <EOL> are mostly not displayed
4505 with the right amount of white space.
4506
4507 *'lines'* *E593*
4508'lines' number (default 24 or terminal height)
4509 global
4510 Number of lines of the Vim window.
4511 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004512 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 When Vim is running in the GUI or in a resizable window, setting this
4514 option will cause the window size to be changed. When you only want
4515 to use the size for the GUI, put the command in your |gvimrc| file.
4516 Vim limits the number of lines to what fits on the screen. You can
4517 use this command to get the tallest window possible: >
4518 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004519< Minimum value is 2, maximum value is 1000.
4520 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 When you set this option and Vim is unable to change the physical
4522 number of lines of the display, the display may be messed up.
4523
4524 *'linespace'* *'lsp'*
4525'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4526 global
4527 {not in Vi}
4528 {only in the GUI}
4529 Number of pixel lines inserted between characters. Useful if the font
4530 uses the full character cell height, making lines touch each other.
4531 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004532 With some fonts there can be too much room between lines (to have
4533 space for ascents and descents). Then it makes sense to set
4534 'linespace' to a negative value. This may cause display problems
4535 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536
4537 *'lisp'* *'nolisp'*
4538'lisp' boolean (default off)
4539 local to buffer
4540 {not available when compiled without the |+lispindent|
4541 feature}
4542 Lisp mode: When <Enter> is typed in insert mode set the indent for
4543 the next line to Lisp standards (well, sort of). Also happens with
4544 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4545 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4546 better. Also see 'lispwords'.
4547 The '-' character is included in keyword characters. Redefines the
4548 "=" operator to use this same indentation algorithm rather than
4549 calling an external program if 'equalprg' is empty.
4550 This option is not used when 'paste' is set.
4551 {Vi: Does it a little bit differently}
4552
4553 *'lispwords'* *'lw'*
4554'lispwords' 'lw' string (default is very long)
4555 global
4556 {not in Vi}
4557 {not available when compiled without the |+lispindent|
4558 feature}
4559 Comma separated list of words that influence the Lisp indenting.
4560 |'lisp'|
4561
4562 *'list'* *'nolist'*
4563'list' boolean (default off)
4564 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004565 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4566 line. Useful to see the difference between tabs and spaces and for
4567 trailing blanks. Further changed by the 'listchars' option.
4568
4569 The cursor is displayed at the start of the space a Tab character
4570 occupies, not at the end as usual in Normal mode. To get this cursor
4571 position while displaying Tabs with spaces, use: >
4572 :set list lcs=tab\ \
4573<
4574 Note that list mode will also affect formatting (set with 'textwidth'
4575 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 changing the way tabs are displayed.
4577
4578 *'listchars'* *'lcs'*
4579'listchars' 'lcs' string (default "eol:$")
4580 global
4581 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004582 Strings to use in 'list' mode and for the |:list| command. It is a
4583 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 eol:c Character to show at the end of each line. When
4585 omitted, there is no extra character at the end of the
4586 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004587 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004589 fill the space that the tab normally occupies.
4590 "tab:>-" will show a tab that takes four spaces as
4591 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004592 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 trailing spaces are blank.
4594 extends:c Character to show in the last column, when 'wrap' is
4595 off and the line continues beyond the right of the
4596 screen.
4597 precedes:c Character to show in the first column, when 'wrap'
4598 is off and there is text preceding the character
4599 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004600 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004601 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004602 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004603 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004605 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004607 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608
4609 Examples: >
4610 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004611 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612 :set lcs=extends:>,precedes:<
4613< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004614 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004615 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616
4617 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4618'loadplugins' 'lpl' boolean (default on)
4619 global
4620 {not in Vi}
4621 When on the plugin scripts are loaded when starting up |load-plugins|.
4622 This option can be reset in your |vimrc| file to disable the loading
4623 of plugins.
4624 Note that using the "-u NONE" and "--noplugin" command line arguments
4625 reset this option. |-u| |--noplugin|
4626
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004627 *'macatsui'* *'nomacatsui'*
4628'macatsui' boolean (default on)
4629 global
4630 {only available in Mac GUI version}
4631 This is a workaround for when drawing doesn't work properly. When set
4632 and compiled with multi-byte support ATSUI text drawing is used. When
4633 not set ATSUI text drawing is not used. Switch this option off when
4634 you experience drawing problems. In a future version the problems may
4635 be solved and this option becomes obsolete. Therefore use this method
4636 to unset it: >
4637 if exists('&macatsui')
4638 set nomacatsui
4639 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004640< Another option to check if you have drawing problems is
4641 'termencoding'.
4642
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643 *'magic'* *'nomagic'*
4644'magic' boolean (default on)
4645 global
4646 Changes the special characters that can be used in search patterns.
4647 See |pattern|.
4648 NOTE: To avoid portability problems with using patterns, always keep
4649 this option at the default "on". Only switch it off when working with
4650 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004651 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652
4653 *'makeef'* *'mef'*
4654'makeef' 'mef' string (default: "")
4655 global
4656 {not in Vi}
4657 {not available when compiled without the |+quickfix|
4658 feature}
4659 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4660 and the |:grep| command.
4661 When it is empty, an internally generated temp file will be used.
4662 When "##" is included, it is replaced by a number to make the name
4663 unique. This makes sure that the ":make" command doesn't overwrite an
4664 existing file.
4665 NOT used for the ":cf" command. See 'errorfile' for that.
4666 Environment variables are expanded |:set_env|.
4667 See |option-backslash| about including spaces and backslashes.
4668 This option cannot be set from a |modeline| or in the |sandbox|, for
4669 security reasons.
4670
4671 *'makeprg'* *'mp'*
4672'makeprg' 'mp' string (default "make", VMS: "MMS")
4673 global or local to buffer |global-local|
4674 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004675 Program to use for the ":make" command. See |:make_makeprg|.
4676 This option may contain '%' and '#' characters, which are expanded to
4677 the current and alternate file name. |:_%| |:_#|
4678 Environment variables are expanded |:set_env|. See |option-backslash|
4679 about including spaces and backslashes.
4680 Note that a '|' must be escaped twice: once for ":set" and once for
4681 the interpretation of a command. When you use a filter called
4682 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683 :set makeprg=gmake\ \\\|\ myfilter
4684< The placeholder "$*" can be given (even multiple times) to specify
4685 where the arguments will be included, for example: >
4686 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4687< This option cannot be set from a |modeline| or in the |sandbox|, for
4688 security reasons.
4689
4690 *'matchpairs'* *'mps'*
4691'matchpairs' 'mps' string (default "(:),{:},[:]")
4692 local to buffer
4693 {not in Vi}
4694 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004695 other. Currently only single byte character pairs are allowed, and
4696 they must be different. The characters must be separated by a colon.
4697 The pairs must be separated by a comma. Example for including '<' and
4698 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699 :set mps+=<:>
4700
4701< A more exotic example, to jump between the '=' and ';' in an
4702 assignment, useful for languages like C and Java: >
4703 :au FileType c,cpp,java set mps+==:;
4704
4705< For a more advanced way of using "%", see the matchit.vim plugin in
4706 the $VIMRUNTIME/macros directory. |add-local-help|
4707
4708 *'matchtime'* *'mat'*
4709'matchtime' 'mat' number (default 5)
4710 global
4711 {not in Vi}{in Nvi}
4712 Tenths of a second to show the matching paren, when 'showmatch' is
4713 set. Note that this is not in milliseconds, like other options that
4714 set a time. This is to be compatible with Nvi.
4715
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004716 *'maxcombine'* *'mco'*
4717'maxcombine' 'mco' number (default 2)
4718 global
4719 {not in Vi}
4720 {only available when compiled with the |+multi_byte|
4721 feature}
4722 The maximum number of combining characters supported for displaying.
4723 Only used when 'encoding' is "utf-8".
4724 The default is OK for most languages. Hebrew may require 4.
4725 Maximum value is 6.
4726 Even when this option is set to 2 you can still edit text with more
4727 combining characters, you just can't see them. Use |g8| or |ga|.
4728 See |mbyte-combining|.
4729
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 *'maxfuncdepth'* *'mfd'*
4731'maxfuncdepth' 'mfd' number (default 100)
4732 global
4733 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004734 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004735 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 Maximum depth of function calls for user functions. This normally
4737 catches endless recursion. When using a recursive function with
4738 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4739 more memory, there is the danger of failing when memory is exhausted.
4740 See also |:function|.
4741
4742 *'maxmapdepth'* *'mmd'* *E223*
4743'maxmapdepth' 'mmd' number (default 1000)
4744 global
4745 {not in Vi}
4746 Maximum number of times a mapping is done without resulting in a
4747 character to be used. This normally catches endless mappings, like
4748 ":map x y" with ":map y x". It still does not catch ":map g wg",
4749 because the 'w' is used before the next mapping is done. See also
4750 |key-mapping|.
4751
4752 *'maxmem'* *'mm'*
4753'maxmem' 'mm' number (default between 256 to 5120 (system
4754 dependent) or half the amount of memory
4755 available)
4756 global
4757 {not in Vi}
4758 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4759 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004760 other memory to be freed. The maximum usable value is about 2000000.
4761 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004763 *'maxmempattern'* *'mmp'*
4764'maxmempattern' 'mmp' number (default 1000)
4765 global
4766 {not in Vi}
4767 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004768 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004769 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004770 When Vim runs into the limit it gives an error message and mostly
4771 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004772 Running into the limit often means that the pattern is very
4773 inefficient or too complex. This may already happen with the pattern
4774 "\(.\)*" on a very long line. ".*" works much better.
4775 Vim may run out of memory before hitting the 'maxmempattern' limit.
4776
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777 *'maxmemtot'* *'mmt'*
4778'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4779 dependent) or half the amount of memory
4780 available)
4781 global
4782 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004783 Maximum amount of memory in Kbyte to use for all buffers together.
4784 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4785 without a limit. On 64 bit machines higher values might work. But
4786 hey, do you really need more than 2 Gbyte for text editing?
4787 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
4789 *'menuitems'* *'mis'*
4790'menuitems' 'mis' number (default 25)
4791 global
4792 {not in Vi}
4793 {not available when compiled without the |+menu|
4794 feature}
4795 Maximum number of items to use in a menu. Used for menus that are
4796 generated from a list of items, e.g., the Buffers menu. Changing this
4797 option has no direct effect, the menu must be refreshed first.
4798
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004799 *'mkspellmem'* *'msm'*
4800'mkspellmem' 'msm' string (default "460000,2000,500")
4801 global
4802 {not in Vi}
4803 {not available when compiled without the |+syntax|
4804 feature}
4805 Parameters for |:mkspell|. This tunes when to start compressing the
4806 word tree. Compression can be slow when there are many words, but
4807 it's needed to avoid running out of memory. The amount of memory used
4808 per word depends very much on how similar the words are, that's why
4809 this tuning is complicated.
4810
4811 There are three numbers, separated by commas:
4812 {start},{inc},{added}
4813
4814 For most languages the uncompressed word tree fits in memory. {start}
4815 gives the amount of memory in Kbyte that can be used before any
4816 compression is done. It should be a bit smaller than the amount of
4817 memory that is available to Vim.
4818
4819 When going over the {start} limit the {inc} number specifies the
4820 amount of memory in Kbyte that can be allocated before another
4821 compression is done. A low number means compression is done after
4822 less words are added, which is slow. A high number means more memory
4823 will be allocated.
4824
4825 After doing compression, {added} times 1024 words can be added before
4826 the {inc} limit is ignored and compression is done when any extra
4827 amount of memory is needed. A low number means there is a smaller
4828 chance of hitting the {inc} limit, less memory is used but it's
4829 slower.
4830
4831 The languages for which these numbers are important are Italian and
4832 Hungarian. The default works for when you have about 512 Mbyte. If
4833 you have 1 Gbyte you could use: >
4834 :set mkspellmem=900000,3000,800
4835< If you have less than 512 Mbyte |:mkspell| may fail for some
4836 languages, no matter what you set 'mkspellmem' to.
4837
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004839'modeline' 'ml' boolean (Vim default: on (off for root),
4840 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 local to buffer
4842 *'modelines'* *'mls'*
4843'modelines' 'mls' number (default 5)
4844 global
4845 {not in Vi}
4846 If 'modeline' is on 'modelines' gives the number of lines that is
4847 checked for set commands. If 'modeline' is off or 'modelines' is zero
4848 no lines are checked. See |modeline|.
4849 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4850 set and to the Vim default value when 'compatible' is reset.
4851
4852 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4853'modifiable' 'ma' boolean (default on)
4854 local to buffer
4855 {not in Vi} *E21*
4856 When off the buffer contents cannot be changed. The 'fileformat' and
4857 'fileencoding' options also can't be changed.
4858 Can be reset with the |-M| command line argument.
4859
4860 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4861'modified' 'mod' boolean (default off)
4862 local to buffer
4863 {not in Vi}
4864 When on, the buffer is considered to be modified. This option is set
4865 when:
4866 1. A change was made to the text since it was last written. Using the
4867 |undo| command to go back to the original text will reset the
4868 option. But undoing changes that were made before writing the
4869 buffer will set the option again, since the text is different from
4870 when it was written.
4871 2. 'fileformat' or 'fileencoding' is different from its original
4872 value. The original value is set when the buffer is read or
4873 written. A ":set nomodified" command also resets the original
4874 values to the current values and the 'modified' option will be
4875 reset.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02004876 This option is not set when a change is made to the buffer as the
4877 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
4878 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
4879 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4881 will be ignored.
4882
4883 *'more'* *'nomore'*
4884'more' boolean (Vim default: on, Vi default: off)
4885 global
4886 {not in Vi}
4887 When on, listings pause when the whole screen is filled. You will get
4888 the |more-prompt|. When this option is off there are no pauses, the
4889 listing continues until finished.
4890 NOTE: This option is set to the Vi default value when 'compatible' is
4891 set and to the Vim default value when 'compatible' is reset.
4892
4893 *'mouse'* *E538*
4894'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4895 global
4896 {not in Vi}
4897 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004898 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4899 sysmouse and Linux console with gpm). For using the mouse in the
4900 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 The mouse can be enabled for different modes:
4902 n Normal mode
4903 v Visual mode
4904 i Insert mode
4905 c Command-line mode
4906 h all previous modes when editing a help file
4907 a all previous modes
4908 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 Normally you would enable the mouse in all four modes with: >
4910 :set mouse=a
4911< When the mouse is not enabled, the GUI will still use the mouse for
4912 modeless selection. This doesn't move the text cursor.
4913
4914 See |mouse-using|. Also see |'clipboard'|.
4915
4916 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004917 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 the mouse buttons can still be used by keeping the shift key pressed.
4919 Also see the 'clipboard' option.
4920
4921 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4922'mousefocus' 'mousef' boolean (default off)
4923 global
4924 {not in Vi}
4925 {only works in the GUI}
4926 The window that the mouse pointer is on is automatically activated.
4927 When changing the window layout or window focus in another way, the
4928 mouse pointer is moved to the window with keyboard focus. Off is the
4929 default because it makes using the pull down menus a little goofy, as
4930 a pointer transit may activate a window unintentionally.
4931
4932 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4933'mousehide' 'mh' boolean (default on)
4934 global
4935 {not in Vi}
4936 {only works in the GUI}
4937 When on, the mouse pointer is hidden when characters are typed.
4938 The mouse pointer is restored when the mouse is moved.
4939
4940 *'mousemodel'* *'mousem'*
4941'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4942 global
4943 {not in Vi}
4944 Sets the model to use for the mouse. The name mostly specifies what
4945 the right mouse button is used for:
4946 extend Right mouse button extends a selection. This works
4947 like in an xterm.
4948 popup Right mouse button pops up a menu. The shifted left
4949 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004950 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 popup_setpos Like "popup", but the cursor will be moved to the
4952 position where the mouse was clicked, and thus the
4953 selected operation will act upon the clicked object.
4954 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004955 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004956 course, that right clicking outside a selection will
4957 end Visual mode.
4958 Overview of what button does what for each model:
4959 mouse extend popup(_setpos) ~
4960 left click place cursor place cursor
4961 left drag start selection start selection
4962 shift-left search word extend selection
4963 right click extend selection popup menu (place cursor)
4964 right drag extend selection -
4965 middle click paste paste
4966
4967 In the "popup" model the right mouse button produces a pop-up menu.
4968 You need to define this first, see |popup-menu|.
4969
4970 Note that you can further refine the meaning of buttons with mappings.
4971 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4972 selection (because that's handled in the GUI code directly).
4973
4974 The 'mousemodel' option is set by the |:behave| command.
4975
4976 *'mouseshape'* *'mouses'* *E547*
4977'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004978 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 global
4980 {not in Vi}
4981 {only available when compiled with the |+mouseshape|
4982 feature}
4983 This option tells Vim what the mouse pointer should look like in
4984 different modes. The option is a comma separated list of parts, much
4985 like used for 'guicursor'. Each part consist of a mode/location-list
4986 and an argument-list:
4987 mode-list:shape,mode-list:shape,..
4988 The mode-list is a dash separated list of these modes/locations:
4989 In a normal window: ~
4990 n Normal mode
4991 v Visual mode
4992 ve Visual mode with 'selection' "exclusive" (same as 'v',
4993 if not specified)
4994 o Operator-pending mode
4995 i Insert mode
4996 r Replace mode
4997
4998 Others: ~
4999 c appending to the command-line
5000 ci inserting in the command-line
5001 cr replacing in the command-line
5002 m at the 'Hit ENTER' or 'More' prompts
5003 ml idem, but cursor in the last line
5004 e any mode, pointer below last window
5005 s any mode, pointer on a status line
5006 sd any mode, while dragging a status line
5007 vs any mode, pointer on a vertical separator line
5008 vd any mode, while dragging a vertical separator line
5009 a everywhere
5010
5011 The shape is one of the following:
5012 avail name looks like ~
5013 w x arrow Normal mouse pointer
5014 w x blank no pointer at all (use with care!)
5015 w x beam I-beam
5016 w x updown up-down sizing arrows
5017 w x leftright left-right sizing arrows
5018 w x busy The system's usual busy pointer
5019 w x no The system's usual 'no input' pointer
5020 x udsizing indicates up-down resizing
5021 x lrsizing indicates left-right resizing
5022 x crosshair like a big thin +
5023 x hand1 black hand
5024 x hand2 white hand
5025 x pencil what you write with
5026 x question big ?
5027 x rightup-arrow arrow pointing right-up
5028 w x up-arrow arrow pointing up
5029 x <number> any X11 pointer number (see X11/cursorfont.h)
5030
5031 The "avail" column contains a 'w' if the shape is available for Win32,
5032 x for X11.
5033 Any modes not specified or shapes not available use the normal mouse
5034 pointer.
5035
5036 Example: >
5037 :set mouseshape=s:udsizing,m:no
5038< will make the mouse turn to a sizing arrow over the status lines and
5039 indicate no input when the hit-enter prompt is displayed (since
5040 clicking the mouse has no effect in this state.)
5041
5042 *'mousetime'* *'mouset'*
5043'mousetime' 'mouset' number (default 500)
5044 global
5045 {not in Vi}
5046 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5047 time in msec between two mouse clicks for the second click to be
5048 recognized as a multi click.
5049
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005050 *'mzquantum'* *'mzq'*
5051'mzquantum' 'mzq' number (default 100)
5052 global
5053 {not in Vi}
5054 {not available when compiled without the |+mzscheme|
5055 feature}
5056 The number of milliseconds between polls for MzScheme threads.
5057 Negative or zero value means no thread scheduling.
5058
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 *'nrformats'* *'nf'*
5060'nrformats' 'nf' string (default "octal,hex")
5061 local to buffer
5062 {not in Vi}
5063 This defines what bases Vim will consider for numbers when using the
5064 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5065 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005066 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 incremented or decremented. This is useful for a list with a
Bram Moolenaarb6b046b2011-12-30 13:11:27 +01005068 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005069 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005071 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005072 considered to be hexadecimal. Example: Using CTRL-X on
5073 "0x100" results in "0x0ff".
5074 Numbers which simply begin with a digit in the range 1-9 are always
5075 considered decimal. This also happens for numbers that are not
5076 recognized as octal or hex.
5077
5078 *'number'* *'nu'* *'nonumber'* *'nonu'*
5079'number' 'nu' boolean (default off)
5080 local to window
5081 Print the line number in front of each line. When the 'n' option is
5082 excluded from 'cpoptions' a wrapped line will not use the column of
5083 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005084 The 'numberwidth' option can be used to set the room used for the line
5085 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005086 When a long, wrapped line doesn't start with the first character, '-'
5087 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005088 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5089 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005090 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005092 *'numberwidth'* *'nuw'*
5093'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5094 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005095 {not in Vi}
5096 {only available when compiled with the |+linebreak|
5097 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005098 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005099 when the 'number' or 'relativenumber' option is set or printing lines
5100 with a line number. Since one space is always between the number and
5101 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005102 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005103 fit the highest line number in the buffer respectively the number of
5104 rows in the window, depending on whether 'number' or 'relativenumber'
5105 is set. Thus with the Vim default of 4 there is room for a line number
5106 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005107 The minimum value is 1, the maximum value is 10.
5108 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5109
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005110 *'omnifunc'* *'ofu'*
5111'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005112 local to buffer
5113 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005114 {not available when compiled without the |+eval|
5115 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005116 This option specifies a function to be used for Insert mode omni
5117 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005118 See |complete-functions| for an explanation of how the function is
5119 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005120 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005121 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005122
5123
Bram Moolenaar02467872007-05-06 13:22:01 +00005124 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005125'opendevice' 'odev' boolean (default off)
5126 global
5127 {not in Vi}
5128 {only for MS-DOS, MS-Windows and OS/2}
5129 Enable reading and writing from devices. This may get Vim stuck on a
5130 device that can be opened but doesn't actually do the I/O. Therefore
5131 it is off by default.
5132 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5133 result in editing a device.
5134
5135
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005136 *'operatorfunc'* *'opfunc'*
5137'operatorfunc' 'opfunc' string (default: empty)
5138 global
5139 {not in Vi}
5140 This option specifies a function to be called by the |g@| operator.
5141 See |:map-operator| for more info and an example.
5142
5143 This option cannot be set from a |modeline| or in the |sandbox|, for
5144 security reasons.
5145
5146
Bram Moolenaar251e1912011-06-19 05:09:16 +02005147 *'osfiletype'* *'oft'*
5148'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005149 local to buffer
5150 {not in Vi}
Bram Moolenaar251e1912011-06-19 05:09:16 +02005151 This option was supported on RISC OS, which has been removed.
5152
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
5154 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005155'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 global
5157 Specifies the nroff macros that separate paragraphs. These are pairs
5158 of two letters (see |object-motions|).
5159
5160 *'paste'* *'nopaste'*
5161'paste' boolean (default off)
5162 global
5163 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005164 Put Vim in Paste mode. This is useful if you want to cut or copy
5165 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166 unexpected effects.
5167 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005168 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 knows about pasting and will mostly do the right thing without 'paste'
5170 being set. The same is true for a terminal where Vim handles the
5171 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005172 This option is reset when starting the GUI. Thus if you set it in
5173 your .vimrc it will work in a terminal, but not in the GUI. Setting
5174 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5175 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 When the 'paste' option is switched on (also when it was already on):
5177 - mapping in Insert mode and Command-line mode is disabled
5178 - abbreviations are disabled
5179 - 'textwidth' is set to 0
5180 - 'wrapmargin' is set to 0
5181 - 'autoindent' is reset
5182 - 'smartindent' is reset
5183 - 'softtabstop' is set to 0
5184 - 'revins' is reset
5185 - 'ruler' is reset
5186 - 'showmatch' is reset
5187 - 'formatoptions' is used like it is empty
5188 These options keep their value, but their effect is disabled:
5189 - 'lisp'
5190 - 'indentexpr'
5191 - 'cindent'
5192 NOTE: When you start editing another file while the 'paste' option is
5193 on, settings from the modelines or autocommands may change the
5194 settings again, causing trouble when pasting text. You might want to
5195 set the 'paste' option again.
5196 When the 'paste' option is reset the mentioned options are restored to
5197 the value before the moment 'paste' was switched from off to on.
5198 Resetting 'paste' before ever setting it does not have any effect.
5199 Since mapping doesn't work while 'paste' is active, you need to use
5200 the 'pastetoggle' option to toggle the 'paste' option with some key.
5201
5202 *'pastetoggle'* *'pt'*
5203'pastetoggle' 'pt' string (default "")
5204 global
5205 {not in Vi}
5206 When non-empty, specifies the key sequence that toggles the 'paste'
5207 option. This is like specifying a mapping: >
5208 :map {keys} :set invpaste<CR>
5209< Where {keys} is the value of 'pastetoggle'.
5210 The difference is that it will work even when 'paste' is set.
5211 'pastetoggle' works in Insert mode and Normal mode, but not in
5212 Command-line mode.
5213 Mappings are checked first, thus overrule 'pastetoggle'. However,
5214 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5215 this: >
5216 :map <F10> :set paste<CR>
5217 :map <F11> :set nopaste<CR>
5218 :imap <F10> <C-O>:set paste<CR>
5219 :imap <F11> <nop>
5220 :set pastetoggle=<F11>
5221< This will make <F10> start paste mode and <F11> stop paste mode.
5222 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5223 mode everything is inserted literally, except the 'pastetoggle' key
5224 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005225 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
5227 *'pex'* *'patchexpr'*
5228'patchexpr' 'pex' string (default "")
5229 global
5230 {not in Vi}
5231 {not available when compiled without the |+diff|
5232 feature}
5233 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005234 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235
5236 *'patchmode'* *'pm'* *E206*
5237'patchmode' 'pm' string (default "")
5238 global
5239 {not in Vi}
5240 When non-empty the oldest version of a file is kept. This can be used
5241 to keep the original version of a file if you are changing files in a
5242 source distribution. Only the first time that a file is written a
5243 copy of the original file will be kept. The name of the copy is the
5244 name of the original file with the string in the 'patchmode' option
5245 appended. This option should start with a dot. Use a string like
5246 ".org". 'backupdir' must not be empty for this to work (Detail: The
5247 backup file is renamed to the patchmode file after the new file has
5248 been successfully written, that's why it must be possible to write a
5249 backup file). If there was no file to be backed up, an empty file is
5250 created.
5251 When the 'backupskip' pattern matches, a patchmode file is not made.
5252 Using 'patchmode' for compressed files appends the extension at the
5253 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5254 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005255 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005256
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005257 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005258'path' 'pa' string (default on Unix: ".,/usr/include,,"
5259 on OS/2: ".,/emx/include,,"
5260 other systems: ".,,")
5261 global or local to buffer |global-local|
5262 {not in Vi}
5263 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005264 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5265 provided that the file being searched for has a relative path (not
5266 starting with "/", "./" or "../"). The directories in the 'path'
5267 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 - Use commas to separate directory names: >
5269 :set path=.,/usr/local/include,/usr/include
5270< - Spaces can also be used to separate directory names (for backwards
5271 compatibility with version 3.0). To have a space in a directory
5272 name, precede it with an extra backslash, and escape the space: >
5273 :set path=.,/dir/with\\\ space
5274< - To include a comma in a directory name precede it with an extra
5275 backslash: >
5276 :set path=.,/dir/with\\,comma
5277< - To search relative to the directory of the current file, use: >
5278 :set path=.
5279< - To search in the current directory use an empty string between two
5280 commas: >
5281 :set path=,,
5282< - A directory name may end in a ':' or '/'.
5283 - Environment variables are expanded |:set_env|.
5284 - When using |netrw.vim| URLs can be used. For example, adding
5285 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005286 - Search upwards and downwards in a directory tree using "*", "**" and
5287 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 {not available when compiled without the |+path_extra| feature}
5289 - Careful with '\' characters, type two to get one in the option: >
5290 :set path=.,c:\\include
5291< Or just use '/' instead: >
5292 :set path=.,c:/include
5293< Don't forget "." or files won't even be found in the same directory as
5294 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005295 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005296 it is something like 256 or 1024 characters.
5297 You can check if all the include files are found, using the value of
5298 'path', see |:checkpath|.
5299 The use of |:set+=| and |:set-=| is preferred when adding or removing
5300 directories from the list. This avoids problems when a future version
5301 uses another default. To remove the current directory use: >
5302 :set path-=
5303< To add the current directory use: >
5304 :set path+=
5305< To use an environment variable, you probably need to replace the
5306 separator. Here is an example to append $INCL, in which directory
5307 names are separated with a semi-colon: >
5308 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5309< Replace the ';' with a ':' or whatever separator is used. Note that
5310 this doesn't work when $INCL contains a comma or white space.
5311
5312 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5313'preserveindent' 'pi' boolean (default off)
5314 local to buffer
5315 {not in Vi}
5316 When changing the indent of the current line, preserve as much of the
5317 indent structure as possible. Normally the indent is replaced by a
5318 series of tabs followed by spaces as required (unless |'expandtab'| is
5319 enabled, in which case only spaces are used). Enabling this option
5320 means the indent will preserve as many existing characters as possible
5321 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005322 'expandtab' does not apply to the preserved white space, a Tab remains
5323 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324 NOTE: When using ">>" multiple times the resulting indent is a mix of
5325 tabs and spaces. You might not like this.
5326 NOTE: 'preserveindent' is reset when 'compatible' is set.
5327 Also see 'copyindent'.
5328 Use |:retab| to clean up white space.
5329
5330 *'previewheight'* *'pvh'*
5331'previewheight' 'pvh' number (default 12)
5332 global
5333 {not in Vi}
5334 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005335 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005336 Default height for a preview window. Used for |:ptag| and associated
5337 commands. Used for |CTRL-W_}| when no count is given.
5338
5339 *'previewwindow'* *'nopreviewwindow'*
5340 *'pvw'* *'nopvw'* *E590*
5341'previewwindow' 'pvw' boolean (default off)
5342 local to window
5343 {not in Vi}
5344 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005345 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005346 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347 set. It's normally not set directly, but by using one of the commands
5348 |:ptag|, |:pedit|, etc.
5349
5350 *'printdevice'* *'pdev'*
5351'printdevice' 'pdev' string (default empty)
5352 global
5353 {not in Vi}
5354 {only available when compiled with the |+printer|
5355 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005356 The name of the printer to be used for |:hardcopy|.
5357 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005358 This option cannot be set from a |modeline| or in the |sandbox|, for
5359 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360
Bram Moolenaar8299df92004-07-10 09:47:34 +00005361 *'printencoding'* *'penc'*
5362'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363 global
5364 {not in Vi}
5365 {only available when compiled with the |+printer|
5366 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005367 Sets the character encoding used when printing.
5368 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005369
5370 *'printexpr'* *'pexpr'*
5371'printexpr' 'pexpr' String (default: see below)
5372 global
5373 {not in Vi}
5374 {only available when compiled with the |+printer|
5375 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005376 Expression used to print the PostScript produced with |:hardcopy|.
5377 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378
Bram Moolenaar8299df92004-07-10 09:47:34 +00005379 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380'printfont' 'pfn' string (default "courier")
5381 global
5382 {not in Vi}
5383 {only available when compiled with the |+printer|
5384 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005385 The name of the font that will be used for |:hardcopy|.
5386 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387
5388 *'printheader'* *'pheader'*
5389'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5390 global
5391 {not in Vi}
5392 {only available when compiled with the |+printer|
5393 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005394 The format of the header produced in |:hardcopy| output.
5395 See |pheader-option|.
5396
5397 *'printmbcharset'* *'pmbcs'*
5398'printmbcharset' 'pmbcs' string (default "")
5399 global
5400 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005401 {only available when compiled with the |+printer|,
5402 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005403 The CJK character set to be used for CJK output from |:hardcopy|.
5404 See |pmbcs-option|.
5405
5406 *'printmbfont'* *'pmbfn'*
5407'printmbfont' 'pmbfn' string (default "")
5408 global
5409 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005410 {only available when compiled with the |+printer|,
5411 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005412 List of font names to be used for CJK output from |:hardcopy|.
5413 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414
5415 *'printoptions'* *'popt'*
5416'printoptions' 'popt' string (default "")
5417 global
5418 {not in Vi}
5419 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005420 List of items that control the format of the output of |:hardcopy|.
5421 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005423 *'prompt'* *'noprompt'*
5424'prompt' boolean (default on)
5425 global
5426 When on a ":" prompt is used in Ex mode.
5427
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005428 *'pumheight'* *'ph'*
5429'pumheight' 'ph' number (default 0)
5430 global
5431 {not available when compiled without the
5432 |+insert_expand| feature}
5433 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005434 Determines the maximum number of items to show in the popup menu for
5435 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005436 |ins-completion-menu|.
5437
5438
Bram Moolenaar677ee682005-01-27 14:41:15 +00005439 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005440'quoteescape' 'qe' string (default "\")
5441 local to buffer
5442 {not in Vi}
5443 The characters that are used to escape quotes in a string. Used for
5444 objects like a', a" and a` |a'|.
5445 When one of the characters in this option is found inside a string,
5446 the following character will be skipped. The default value makes the
5447 text "foo\"bar\\" considered to be one string.
5448
Bram Moolenaar071d4272004-06-13 20:20:40 +00005449 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5450'readonly' 'ro' boolean (default off)
5451 local to buffer
5452 If on, writes fail unless you use a '!'. Protects you from
5453 accidentally overwriting a file. Default on when Vim is started
5454 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005455 When using ":w!" the 'readonly' option is reset for the current
5456 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005458 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005459
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005460 *'redrawtime'* *'rdt'*
5461'redrawtime' 'rdt' number (default 2000)
5462 global
5463 {not in Vi}
5464 {only available when compiled with the |+reltime|
5465 feature}
5466 The time in milliseconds for redrawing the display. This applies to
5467 searching for patterns for 'hlsearch' and |:match| highlighting.
5468 When redrawing takes more than this many milliseconds no further
5469 matches will be highlighted. This is used to avoid that Vim hangs
5470 when using a very complicated pattern.
5471
Bram Moolenaar64486672010-05-16 15:46:46 +02005472 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5473'relativenumber' 'rnu' boolean (default off)
5474 local to window
5475 {not in Vi}
5476 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005477 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005478 precede some vertical motion commands (e.g. j k + -) with, without
5479 having to calculate it yourself. Especially useful in combination with
5480 other commands (e.g. y d c < > gq gw =).
5481 When the 'n' option is excluded from 'cpoptions' a wrapped
5482 line will not use the column of line numbers (this is the default when
5483 'compatible' isn't set).
5484 The 'numberwidth' option can be used to set the room used for the line
5485 number.
5486 When a long, wrapped line doesn't start with the first character, '-'
5487 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005488 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5489 the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005490 When setting this option, 'number' is reset.
5491
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 *'remap'* *'noremap'*
5493'remap' boolean (default on)
5494 global
5495 Allows for mappings to work recursively. If you do not want this for
5496 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005497 NOTE: To avoid portability problems with Vim scripts, always keep
5498 this option at the default "on". Only switch it off when working with
5499 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500
5501 *'report'*
5502'report' number (default 2)
5503 global
5504 Threshold for reporting number of lines changed. When the number of
5505 changed lines is more than 'report' a message will be given for most
5506 ":" commands. If you want it always, set 'report' to 0.
5507 For the ":substitute" command the number of substitutions is used
5508 instead of the number of lines.
5509
5510 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5511'restorescreen' 'rs' boolean (default on)
5512 global
5513 {not in Vi} {only in Windows 95/NT console version}
5514 When set, the screen contents is restored when exiting Vim. This also
5515 happens when executing external commands.
5516
5517 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5518 options in your .vimrc. To disable restoring:
5519 set t_ti= t_te=
5520 To enable restoring (for an xterm):
5521 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5522 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5523
5524 *'revins'* *'ri'* *'norevins'* *'nori'*
5525'revins' 'ri' boolean (default off)
5526 global
5527 {not in Vi}
5528 {only available when compiled with the |+rightleft|
5529 feature}
5530 Inserting characters in Insert mode will work backwards. See "typing
5531 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5532 command in Insert mode, when 'allowrevins' is set.
5533 NOTE: This option is reset when 'compatible' or 'paste' is set.
5534
5535 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5536'rightleft' 'rl' boolean (default off)
5537 local to window
5538 {not in Vi}
5539 {only available when compiled with the |+rightleft|
5540 feature}
5541 When on, display orientation becomes right-to-left, i.e., characters
5542 that are stored in the file appear from the right to the left.
5543 Using this option, it is possible to edit files for languages that
5544 are written from the right to the left such as Hebrew and Arabic.
5545 This option is per window, so it is possible to edit mixed files
5546 simultaneously, or to view the same file in both ways (this is
5547 useful whenever you have a mixed text file with both right-to-left
5548 and left-to-right strings so that both sets are displayed properly
5549 in different windows). Also see |rileft.txt|.
5550
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005551 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552'rightleftcmd' 'rlc' string (default "search")
5553 local to window
5554 {not in Vi}
5555 {only available when compiled with the |+rightleft|
5556 feature}
5557 Each word in this option enables the command line editing to work in
5558 right-to-left mode for a group of commands:
5559
5560 search "/" and "?" commands
5561
5562 This is useful for languages such as Hebrew, Arabic and Farsi.
5563 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5564
5565 *'ruler'* *'ru'* *'noruler'* *'noru'*
5566'ruler' 'ru' boolean (default off)
5567 global
5568 {not in Vi}
5569 {not available when compiled without the
5570 |+cmdline_info| feature}
5571 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005572 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 text in the file is shown on the far right:
5574 Top first line is visible
5575 Bot last line is visible
5576 All first and last line are visible
5577 45% relative position in the file
5578 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005579 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005581 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 this option takes precedence over 'ruler' and 'rulerformat'
5583 If the number of characters displayed is different from the number of
5584 bytes in the text (e.g., for a TAB or a multi-byte character), both
5585 the text column (byte number) and the screen column are shown,
5586 separated with a dash.
5587 For an empty line "0-1" is shown.
5588 For an empty buffer the line number will also be zero: "0,0-1".
5589 This option is reset when the 'paste' option is set.
5590 If you don't want to see the ruler all the time but want to know where
5591 you are, use "g CTRL-G" |g_CTRL-G|.
5592 NOTE: This option is reset when 'compatible' is set.
5593
5594 *'rulerformat'* *'ruf'*
5595'rulerformat' 'ruf' string (default empty)
5596 global
5597 {not in Vi}
5598 {not available when compiled without the |+statusline|
5599 feature}
5600 When this option is not empty, it determines the content of the ruler
5601 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005602 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 The default ruler width is 17 characters. To make the ruler 15
5604 characters wide, put "%15(" at the start and "%)" at the end.
5605 Example: >
5606 :set rulerformat=%15(%c%V\ %p%%%)
5607<
5608 *'runtimepath'* *'rtp'* *vimfiles*
5609'runtimepath' 'rtp' string (default:
5610 Unix: "$HOME/.vim,
5611 $VIM/vimfiles,
5612 $VIMRUNTIME,
5613 $VIM/vimfiles/after,
5614 $HOME/.vim/after"
5615 Amiga: "home:vimfiles,
5616 $VIM/vimfiles,
5617 $VIMRUNTIME,
5618 $VIM/vimfiles/after,
5619 home:vimfiles/after"
5620 PC, OS/2: "$HOME/vimfiles,
5621 $VIM/vimfiles,
5622 $VIMRUNTIME,
5623 $VIM/vimfiles/after,
5624 $HOME/vimfiles/after"
5625 Macintosh: "$VIM:vimfiles,
5626 $VIMRUNTIME,
5627 $VIM:vimfiles:after"
5628 RISC-OS: "Choices:vimfiles,
5629 $VIMRUNTIME,
5630 Choices:vimfiles/after"
5631 VMS: "sys$login:vimfiles,
5632 $VIM/vimfiles,
5633 $VIMRUNTIME,
5634 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005635 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636 global
5637 {not in Vi}
5638 This is a list of directories which will be searched for runtime
5639 files:
5640 filetype.vim filetypes by file name |new-filetype|
5641 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005642 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643 colors/ color scheme files |:colorscheme|
5644 compiler/ compiler files |:compiler|
5645 doc/ documentation |write-local-help|
5646 ftplugin/ filetype plugins |write-filetype-plugin|
5647 indent/ indent scripts |indent-expression|
5648 keymap/ key mapping files |mbyte-keymap|
5649 lang/ menu translations |:menutrans|
5650 menu.vim GUI menus |menu.vim|
5651 plugin/ plugin scripts |write-plugin|
5652 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005653 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 syntax/ syntax files |mysyntaxfile|
5655 tutor/ files for vimtutor |tutor|
5656
5657 And any other file searched for with the |:runtime| command.
5658
5659 The defaults for most systems are setup to search five locations:
5660 1. In your home directory, for your personal preferences.
5661 2. In a system-wide Vim directory, for preferences from the system
5662 administrator.
5663 3. In $VIMRUNTIME, for files distributed with Vim.
5664 *after-directory*
5665 4. In the "after" directory in the system-wide Vim directory. This is
5666 for the system administrator to overrule or add to the distributed
5667 defaults (rarely needed)
5668 5. In the "after" directory in your home directory. This is for
5669 personal preferences to overrule or add to the distributed defaults
5670 or system-wide settings (rarely needed).
5671
5672 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5673 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005674 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005675 wildcards.
5676 See |:runtime|.
5677 Example: >
5678 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5679< This will use the directory "~/vimruntime" first (containing your
5680 personal Vim runtime files), then "/mygroup/vim" (shared between a
5681 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5682 files).
5683 You probably should always include $VIMRUNTIME somewhere, to use the
5684 distributed runtime files. You can put a directory before $VIMRUNTIME
5685 to find files which replace a distributed runtime files. You can put
5686 a directory after $VIMRUNTIME to find files which add to distributed
5687 runtime files.
5688 This option cannot be set from a |modeline| or in the |sandbox|, for
5689 security reasons.
5690
5691 *'scroll'* *'scr'*
5692'scroll' 'scr' number (default: half the window height)
5693 local to window
5694 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5695 set to half the number of lines in the window when the window size
5696 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005697 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005698 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5699 the number of screen lines instead of file lines, makes a difference
5700 when lines wrap}
5701
5702 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5703'scrollbind' 'scb' boolean (default off)
5704 local to window
5705 {not in Vi}
5706 {not available when compiled without the |+scrollbind|
5707 feature}
5708 See also |scroll-binding|. When this option is set, the current
5709 window scrolls as other scrollbind windows (windows that also have
5710 this option set) scroll. This option is useful for viewing the
5711 differences between two versions of a file, see 'diff'.
5712 See |'scrollopt'| for options that determine how this option should be
5713 interpreted.
5714 This option is mostly reset when splitting a window to edit another
5715 file. This means that ":split | edit file" results in two windows
5716 with scroll-binding, but ":split file" does not.
5717
5718 *'scrolljump'* *'sj'*
5719'scrolljump' 'sj' number (default 1)
5720 global
5721 {not in Vi}
5722 Minimal number of lines to scroll when the cursor gets off the
5723 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5724 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005725 When set to a negative number from -1 to -100 this is used as the
5726 percentage of the window height. Thus -50 scrolls half the window
5727 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 NOTE: This option is set to 1 when 'compatible' is set.
5729
5730 *'scrolloff'* *'so'*
5731'scrolloff' 'so' number (default 0)
5732 global
5733 {not in Vi}
5734 Minimal number of screen lines to keep above and below the cursor.
5735 This will make some context visible around where you are working. If
5736 you set it to a very large value (999) the cursor line will always be
5737 in the middle of the window (except at the start or end of the file or
5738 when long lines wrap).
5739 For scrolling horizontally see 'sidescrolloff'.
5740 NOTE: This option is set to 0 when 'compatible' is set.
5741
5742 *'scrollopt'* *'sbo'*
5743'scrollopt' 'sbo' string (default "ver,jump")
5744 global
5745 {not available when compiled without the |+scrollbind|
5746 feature}
5747 {not in Vi}
5748 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005749 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5750 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 The following words are available:
5752 ver Bind vertical scrolling for 'scrollbind' windows
5753 hor Bind horizontal scrolling for 'scrollbind' windows
5754 jump Applies to the offset between two windows for vertical
5755 scrolling. This offset is the difference in the first
5756 displayed line of the bound windows. When moving
5757 around in a window, another 'scrollbind' window may
5758 reach a position before the start or after the end of
5759 the buffer. The offset is not changed though, when
5760 moving back the 'scrollbind' window will try to scroll
5761 to the desired position when possible.
5762 When now making that window the current one, two
5763 things can be done with the relative offset:
5764 1. When "jump" is not included, the relative offset is
5765 adjusted for the scroll position in the new current
5766 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005767 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005768 2. When "jump" is included, the other windows are
5769 scrolled to keep the same relative offset. When
5770 going back to the other window, it still uses the
5771 same relative offset.
5772 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005773 When 'diff' mode is active there always is vertical scroll binding,
5774 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775
5776 *'sections'* *'sect'*
5777'sections' 'sect' string (default "SHNHH HUnhsh")
5778 global
5779 Specifies the nroff macros that separate sections. These are pairs of
5780 two letters (See |object-motions|). The default makes a section start
5781 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5782
5783 *'secure'* *'nosecure'* *E523*
5784'secure' boolean (default off)
5785 global
5786 {not in Vi}
5787 When on, ":autocmd", shell and write commands are not allowed in
5788 ".vimrc" and ".exrc" in the current directory and map commands are
5789 displayed. Switch it off only if you know that you will not run into
5790 problems, or when the 'exrc' option is off. On Unix this option is
5791 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005792 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005793 'secure' at the end of your ~/.vimrc then.
5794 This option cannot be set from a |modeline| or in the |sandbox|, for
5795 security reasons.
5796
5797 *'selection'* *'sel'*
5798'selection' 'sel' string (default "inclusive")
5799 global
5800 {not in Vi}
5801 This option defines the behavior of the selection. It is only used
5802 in Visual and Select mode.
5803 Possible values:
5804 value past line inclusive ~
5805 old no yes
5806 inclusive yes yes
5807 exclusive yes no
5808 "past line" means that the cursor is allowed to be positioned one
5809 character past the line.
5810 "inclusive" means that the last character of the selection is included
5811 in an operation. For example, when "x" is used to delete the
5812 selection.
5813 Note that when "exclusive" is used and selecting from the end
5814 backwards, you cannot include the last character of a line, when
5815 starting in Normal mode and 'virtualedit' empty.
5816
5817 The 'selection' option is set by the |:behave| command.
5818
5819 *'selectmode'* *'slm'*
5820'selectmode' 'slm' string (default "")
5821 global
5822 {not in Vi}
5823 This is a comma separated list of words, which specifies when to start
5824 Select mode instead of Visual mode, when a selection is started.
5825 Possible values:
5826 mouse when using the mouse
5827 key when using shifted special keys
5828 cmd when using "v", "V" or CTRL-V
5829 See |Select-mode|.
5830 The 'selectmode' option is set by the |:behave| command.
5831
5832 *'sessionoptions'* *'ssop'*
5833'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005834 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005835 global
5836 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005837 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005838 feature}
5839 Changes the effect of the |:mksession| command. It is a comma
5840 separated list of words. Each word enables saving and restoring
5841 something:
5842 word save and restore ~
5843 blank empty windows
5844 buffers hidden and unloaded buffers, not just those in windows
5845 curdir the current directory
5846 folds manually created folds, opened/closed folds and local
5847 fold options
5848 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005849 and contain at least one lowercase letter. Only
5850 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 help the help window
5852 localoptions options and mappings local to a window or buffer (not
5853 global values for local options)
5854 options all options and mappings (also global values for local
5855 options)
5856 resize size of the Vim window: 'lines' and 'columns'
5857 sesdir the directory in which the session file is located
5858 will become the current directory (useful with
5859 projects accessed over a network from different
5860 systems)
5861 slash backslashes in file names replaced with forward
5862 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005863 tabpages all tab pages; without this only the current tab page
5864 is restored, so that you can make a session for each
5865 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005866 unix with Unix end-of-line format (single <NL>), even when
5867 on Windows or DOS
5868 winpos position of the whole Vim window
5869 winsize window sizes
5870
5871 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005872 When neither "curdir" nor "sesdir" is included, file names are stored
5873 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005874 "slash" and "unix" are useful on Windows when sharing session files
5875 with Unix. The Unix version of Vim cannot source dos format scripts,
5876 but the Windows version of Vim can source unix format scripts.
5877
5878 *'shell'* *'sh'* *E91*
5879'shell' 'sh' string (default $SHELL or "sh",
5880 MS-DOS and Win32: "command.com" or
5881 "cmd.exe", OS/2: "cmd")
5882 global
5883 Name of the shell to use for ! and :! commands. When changing the
5884 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5885 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005886 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005887 See |option-backslash| about including spaces and backslashes.
5888 Environment variables are expanded |:set_env|.
5889 If the name of the shell contains a space, you might need to enclose
5890 it in quotes. Example: >
5891 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5892< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005893 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 "-f" is not inside the quotes, because it is not part of the command
5895 name. And Vim automagically recognizes the backslashes that are path
5896 separators.
5897 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5898 variable to change the way external commands are executed. See the
5899 libc.inf file of DJGPP.
5900 Under MS-Windows, when the executable ends in ".com" it must be
5901 included. Thus setting the shell to "command.com" or "4dos.com"
5902 works, but "command" and "4dos" do not work for all commands (e.g.,
5903 filtering).
5904 For unknown reasons, when using "4dos.com" the current directory is
5905 changed to "C:\". To avoid this set 'shell' like this: >
5906 :set shell=command.com\ /c\ 4dos
5907< This option cannot be set from a |modeline| or in the |sandbox|, for
5908 security reasons.
5909
5910 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01005911'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01005912 MS-DOS and Win32, when 'shell' does not
5913 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005914 global
5915 {not in Vi}
5916 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5917 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5918 systems, the default is set according to the value of 'shell', to
5919 reduce the need to set this option by the user. It's not used for
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005920 OS/2 (EMX figures this out itself).
5921 On Unix it can have more than one flag. Each white space separated
5922 part is passed as an argument to the shell command.
5923 See |option-backslash| about including spaces and backslashes.
5924 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005925 This option cannot be set from a |modeline| or in the |sandbox|, for
5926 security reasons.
5927
5928 *'shellpipe'* *'sp'*
5929'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5930 global
5931 {not in Vi}
5932 {not available when compiled without the |+quickfix|
5933 feature}
5934 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005935 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005936 including spaces and backslashes.
5937 The name of the temporary file can be represented by "%s" if necessary
5938 (the file name is appended automatically if no %s appears in the value
5939 of this option).
5940 For the Amiga and MS-DOS the default is ">". The output is directly
5941 saved in a file and not echoed to the screen.
5942 For Unix the default it "| tee". The stdout of the compiler is saved
5943 in a file and echoed to the screen. If the 'shell' option is "csh" or
5944 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02005945 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
5946 default becomes "2>&1| tee". This means that stderr is also included.
5947 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
5948 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 The initialization of this option is done after reading the ".vimrc"
5950 and the other initializations, so that when the 'shell' option is set
5951 there, the 'shellpipe' option changes automatically, unless it was
5952 explicitly set before.
5953 When 'shellpipe' is set to an empty string, no redirection of the
5954 ":make" output will be done. This is useful if you use a 'makeprg'
5955 that writes to 'makeef' by itself. If you want no piping, but do
5956 want to include the 'makeef', set 'shellpipe' to a single space.
5957 Don't forget to precede the space with a backslash: ":set sp=\ ".
5958 In the future pipes may be used for filtering and this option will
5959 become obsolete (at least for Unix).
5960 This option cannot be set from a |modeline| or in the |sandbox|, for
5961 security reasons.
5962
5963 *'shellquote'* *'shq'*
5964'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5965 contains "sh" somewhere: "\"")
5966 global
5967 {not in Vi}
5968 Quoting character(s), put around the command passed to the shell, for
5969 the "!" and ":!" commands. The redirection is kept outside of the
5970 quoting. See 'shellxquote' to include the redirection. It's
5971 probably not useful to set both options.
5972 This is an empty string by default. Only known to be useful for
5973 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5974 or bash, where it should be "\"". The default is adjusted according
5975 the value of 'shell', to reduce the need to set this option by the
5976 user. See |dos-shell|.
5977 This option cannot be set from a |modeline| or in the |sandbox|, for
5978 security reasons.
5979
5980 *'shellredir'* *'srr'*
5981'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5982 global
5983 {not in Vi}
5984 String to be used to put the output of a filter command in a temporary
5985 file. See also |:!|. See |option-backslash| about including spaces
5986 and backslashes.
5987 The name of the temporary file can be represented by "%s" if necessary
5988 (the file name is appended automatically if no %s appears in the value
5989 of this option).
5990 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5991 or "zsh" during initializations, the default becomes ">&". If the
5992 'shell' option is "sh", "ksh" or "bash" the default becomes
5993 ">%s 2>&1". This means that stderr is also included.
5994 For Win32, the Unix checks are done and additionally "cmd" is checked
5995 for, which makes the default ">%s 2>&1". Also, the same names with
5996 ".exe" appended are checked for.
5997 The initialization of this option is done after reading the ".vimrc"
5998 and the other initializations, so that when the 'shell' option is set
5999 there, the 'shellredir' option changes automatically unless it was
6000 explicitly set before.
6001 In the future pipes may be used for filtering and this option will
6002 become obsolete (at least for Unix).
6003 This option cannot be set from a |modeline| or in the |sandbox|, for
6004 security reasons.
6005
6006 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6007'shellslash' 'ssl' boolean (default off)
6008 global
6009 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
6010 When set, a forward slash is used when expanding file names. This is
6011 useful when a Unix-like shell is used instead of command.com or
6012 cmd.exe. Backward slashes can still be typed, but they are changed to
6013 forward slashes by Vim.
6014 Note that setting or resetting this option has no effect for some
6015 existing file names, thus this option needs to be set before opening
6016 any file for best results. This might change in the future.
6017 'shellslash' only works when a backslash can be used as a path
6018 separator. To test if this is so use: >
6019 if exists('+shellslash')
6020<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006021 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6022'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6023 global
6024 {not in Vi}
6025 When on, use temp files for shell commands. When off use a pipe.
6026 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006027 Currently a pipe is only supported on Unix and MS-Windows 2K and
6028 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006029 :if has("filterpipe")
6030< The advantage of using a pipe is that nobody can read the temp file
6031 and the 'shell' command does not need to support redirection.
6032 The advantage of using a temp file is that the file type and encoding
6033 can be detected.
6034 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6035 |FilterWritePost| autocommands event are not triggered when
6036 'shelltemp' is off.
6037
Bram Moolenaar071d4272004-06-13 20:20:40 +00006038 *'shelltype'* *'st'*
6039'shelltype' 'st' number (default 0)
6040 global
6041 {not in Vi} {only for the Amiga}
6042 On the Amiga this option influences the way how the commands work
6043 which use a shell.
6044 0 and 1: always use the shell
6045 2 and 3: use the shell only to filter lines
6046 4 and 5: use shell only for ':sh' command
6047 When not using the shell, the command is executed directly.
6048
6049 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6050 1 and 3: use "shell cmd" to start external commands
6051
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006052 *'shellxescape'* *'sxe'*
6053'shellxescape' 'sxe' string (default: "";
6054 for MS-DOS and MS-Windows: "\"&|<>()@^")
6055 global
6056 {not in Vi}
6057 When 'shellxquote' is set to "(" then the characters listed in this
6058 option will be escaped with a '^' character. This makes it possible
6059 to execute most external commands with cmd.exe.
6060
Bram Moolenaar071d4272004-06-13 20:20:40 +00006061 *'shellxquote'* *'sxq'*
6062'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006063 for Win32, when 'shell' is cmd.exe: "("
6064 for Win32, when 'shell' contains "sh"
6065 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 for Unix, when using system(): "\"")
6067 global
6068 {not in Vi}
6069 Quoting character(s), put around the command passed to the shell, for
6070 the "!" and ":!" commands. Includes the redirection. See
6071 'shellquote' to exclude the redirection. It's probably not useful
6072 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006073 When the value is '(' then ')' is appended. When the value is '"('
6074 then ')"' is appended.
6075 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006076 This is an empty string by default on most systems, but is known to be
6077 useful for on Win32 version, either for cmd.exe which automatically
6078 strips off the first and last quote on a command, or 3rd-party shells
6079 such as the MKS Korn Shell or bash, where it should be "\"". The
6080 default is adjusted according the value of 'shell', to reduce the need
6081 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 This option cannot be set from a |modeline| or in the |sandbox|, for
6083 security reasons.
6084
6085 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6086'shiftround' 'sr' boolean (default off)
6087 global
6088 {not in Vi}
6089 Round indent to multiple of 'shiftwidth'. Applies to > and <
6090 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6091 a multiple of 'shiftwidth' (this is Vi compatible).
6092 NOTE: This option is reset when 'compatible' is set.
6093
6094 *'shiftwidth'* *'sw'*
6095'shiftwidth' 'sw' number (default 8)
6096 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006097 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006098 |'cindent'|, |>>|, |<<|, etc.
6099
6100 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006101'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6102 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 global
6104 {not in Vi}
6105 This option helps to avoid all the |hit-enter| prompts caused by file
6106 messages, for example with CTRL-G, and to avoid some other messages.
6107 It is a list of flags:
6108 flag meaning when present ~
6109 f use "(3 of 5)" instead of "(file 3 of 5)"
6110 i use "[noeol]" instead of "[Incomplete last line]"
6111 l use "999L, 888C" instead of "999 lines, 888 characters"
6112 m use "[+]" instead of "[Modified]"
6113 n use "[New]" instead of "[New File]"
6114 r use "[RO]" instead of "[readonly]"
6115 w use "[w]" instead of "written" for file write message
6116 and "[a]" instead of "appended" for ':w >> file' command
6117 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6118 "[unix format]" and "[mac]" instead of "[mac format]".
6119 a all of the above abbreviations
6120
6121 o overwrite message for writing a file with subsequent message
6122 for reading a file (useful for ":wn" or when 'autowrite' on)
6123 O message for reading a file overwrites any previous message.
6124 Also for quickfix message (e.g., ":cn").
6125 s don't give "search hit BOTTOM, continuing at TOP" or "search
6126 hit TOP, continuing at BOTTOM" messages
6127 t truncate file message at the start if it is too long to fit
6128 on the command-line, "<" will appear in the left most column.
6129 Ignored in Ex mode.
6130 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006131 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 Ignored in Ex mode.
6133 W don't give "written" or "[w]" when writing a file
6134 A don't give the "ATTENTION" message when an existing swap file
6135 is found.
6136 I don't give the intro message when starting Vim |:intro|.
6137
6138 This gives you the opportunity to avoid that a change between buffers
6139 requires you to hit <Enter>, but still gives as useful a message as
6140 possible for the space available. To get the whole message that you
6141 would have got with 'shm' empty, use ":file!"
6142 Useful values:
6143 shm= No abbreviation of message.
6144 shm=a Abbreviation, but no loss of information.
6145 shm=at Abbreviation, and truncate message when necessary.
6146
6147 NOTE: This option is set to the Vi default value when 'compatible' is
6148 set and to the Vim default value when 'compatible' is reset.
6149
6150 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6151'shortname' 'sn' boolean (default off)
6152 local to buffer
6153 {not in Vi, not in MS-DOS versions}
6154 Filenames are assumed to be 8 characters plus one extension of 3
6155 characters. Multiple dots in file names are not allowed. When this
6156 option is on, dots in file names are replaced with underscores when
6157 adding an extension (".~" or ".swp"). This option is not available
6158 for MS-DOS, because then it would always be on. This option is useful
6159 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6160 or crossdos. When running the Win32 GUI version under Win32s, this
6161 option is always on by default.
6162
6163 *'showbreak'* *'sbr'* *E595*
6164'showbreak' 'sbr' string (default "")
6165 global
6166 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006167 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006168 feature}
6169 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006170 values are "> " or "+++ ": >
6171 :set showbreak=>\
6172< Note the backslash to escape the trailing space. It's easier like
6173 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006174 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006175< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006176 comma (in a future version the comma might be used to separate the
6177 part that is shown at the end and at the start of a line).
6178 The characters are highlighted according to the '@' flag in
6179 'highlight'.
6180 Note that tabs after the showbreak will be displayed differently.
6181 If you want the 'showbreak' to appear in between line numbers, add the
6182 "n" flag to 'cpoptions'.
6183
6184 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6185'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6186 off)
6187 global
6188 {not in Vi}
6189 {not available when compiled without the
6190 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006191 Show (partial) command in the last line of the screen. Set this
6192 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 In Visual mode the size of the selected area is shown:
6194 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006195 If the number of bytes is different it is also displayed: "2-6"
6196 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006197 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006198 - When selecting a block, the size in screen characters:
6199 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006200 NOTE: This option is set to the Vi default value when 'compatible' is
6201 set and to the Vim default value when 'compatible' is reset.
6202
6203 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6204'showfulltag' 'sft' boolean (default off)
6205 global
6206 {not in Vi}
6207 When completing a word in insert mode (see |ins-completion|) from the
6208 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006209 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006210 matched a C function, you can see a template for what arguments are
6211 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006212 Note that this doesn't work well together with having "longest" in
6213 'completeopt', because the completion from the search pattern may not
6214 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215
6216 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6217'showmatch' 'sm' boolean (default off)
6218 global
6219 When a bracket is inserted, briefly jump to the matching one. The
6220 jump is only done if the match can be seen on the screen. The time to
6221 show the match can be set with 'matchtime'.
6222 A Beep is given if there is no match (no matter if the match can be
6223 seen or not). This option is reset when the 'paste' option is set.
6224 When the 'm' flag is not included in 'cpoptions', typing a character
6225 will immediately move the cursor back to where it belongs.
6226 See the "sm" field in 'guicursor' for setting the cursor shape and
6227 blinking when showing the match.
6228 The 'matchpairs' option can be used to specify the characters to show
6229 matches for. 'rightleft' and 'revins' are used to look for opposite
6230 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006231 Also see the matchparen plugin for highlighting the match when moving
6232 around |pi_paren.txt|.
6233 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234
6235 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6236'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6237 global
6238 If in Insert, Replace or Visual mode put a message on the last line.
6239 Use the 'M' flag in 'highlight' to set the type of highlighting for
6240 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006241 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006242 doesn't mean XIM is really active, especially when 'imactivatekey' is
6243 not set.
6244 NOTE: This option is set to the Vi default value when 'compatible' is
6245 set and to the Vim default value when 'compatible' is reset.
6246
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006247 *'showtabline'* *'stal'*
6248'showtabline' 'stal' number (default 1)
6249 global
6250 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006251 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006252 feature}
6253 The value of this option specifies when the line with tab page labels
6254 will be displayed:
6255 0: never
6256 1: only if there are at least two tab pages
6257 2: always
6258 This is both for the GUI and non-GUI implementation of the tab pages
6259 line.
6260 See |tab-page| for more information about tab pages.
6261
Bram Moolenaar071d4272004-06-13 20:20:40 +00006262 *'sidescroll'* *'ss'*
6263'sidescroll' 'ss' number (default 0)
6264 global
6265 {not in Vi}
6266 The minimal number of columns to scroll horizontally. Used only when
6267 the 'wrap' option is off and the cursor is moved off of the screen.
6268 When it is zero the cursor will be put in the middle of the screen.
6269 When using a slow terminal set it to a large number or 0. When using
6270 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6271 commands.
6272
6273 *'sidescrolloff'* *'siso'*
6274'sidescrolloff' 'siso' number (default 0)
6275 global
6276 {not in Vi}
6277 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006278 right of the cursor if 'nowrap' is set. Setting this option to a
6279 value greater than 0 while having |'sidescroll'| also at a non-zero
6280 value makes some context visible in the line you are scrolling in
6281 horizontally (except at beginning of the line). Setting this option
6282 to a large value (like 999) has the effect of keeping the cursor
6283 horizontally centered in the window, as long as one does not come too
6284 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006285 NOTE: This option is set to 0 when 'compatible' is set.
6286
6287 Example: Try this together with 'sidescroll' and 'listchars' as
6288 in the following example to never allow the cursor to move
6289 onto the "extends" character:
6290
6291 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6292 :set sidescrolloff=1
6293
6294
6295 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6296'smartcase' 'scs' boolean (default off)
6297 global
6298 {not in Vi}
6299 Override the 'ignorecase' option if the search pattern contains upper
6300 case characters. Only used when the search pattern is typed and
6301 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006302 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6304 recalling the search pattern from history and hitting <Enter>.
6305 NOTE: This option is reset when 'compatible' is set.
6306
6307 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6308'smartindent' 'si' boolean (default off)
6309 local to buffer
6310 {not in Vi}
6311 {not available when compiled without the
6312 |+smartindent| feature}
6313 Do smart autoindenting when starting a new line. Works for C-like
6314 programs, but can also be used for other languages. 'cindent' does
6315 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006316 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006317 setting 'si' has no effect. 'indentexpr' is a more advanced
6318 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 Normally 'autoindent' should also be on when using 'smartindent'.
6320 An indent is automatically inserted:
6321 - After a line ending in '{'.
6322 - After a line starting with a keyword from 'cinwords'.
6323 - Before a line starting with '}' (only with the "O" command).
6324 When typing '}' as the first character in a new line, that line is
6325 given the same indent as the matching '{'.
6326 When typing '#' as the first character in a new line, the indent for
6327 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6330 When using the ">>" command, lines starting with '#' are not shifted
6331 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006332 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 is set smart indenting is disabled.
6334
6335 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6336'smarttab' 'sta' boolean (default off)
6337 global
6338 {not in Vi}
6339 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006340 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6341 <BS> will delete a 'shiftwidth' worth of space at the start of the
6342 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006343 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006344 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6345 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006346 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006347 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006348 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 NOTE: This option is reset when 'compatible' is set.
6350
6351 *'softtabstop'* *'sts'*
6352'softtabstop' 'sts' number (default 0)
6353 local to buffer
6354 {not in Vi}
6355 Number of spaces that a <Tab> counts for while performing editing
6356 operations, like inserting a <Tab> or using <BS>. It "feels" like
6357 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6358 used. This is useful to keep the 'ts' setting at its standard value
6359 of 8, while being able to edit like it is set to 'sts'. However,
6360 commands like "x" still work on the actual characters.
6361 When 'sts' is zero, this feature is off.
6362 'softtabstop' is set to 0 when the 'paste' option is set.
6363 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6364 spaces is minimized by using <Tab>s.
6365 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6366 set.
6367 NOTE: This option is set to 0 when 'compatible' is set.
6368
Bram Moolenaar217ad922005-03-20 22:37:15 +00006369 *'spell'* *'nospell'*
6370'spell' boolean (default off)
6371 local to window
6372 {not in Vi}
6373 {not available when compiled without the |+syntax|
6374 feature}
6375 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006376 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006377
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006378 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006379'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006380 local to buffer
6381 {not in Vi}
6382 {not available when compiled without the |+syntax|
6383 feature}
6384 Pattern to locate the end of a sentence. The following word will be
6385 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006386 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006387 When this check is not wanted make this option empty.
6388 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006389 Be careful with special characters, see |option-backslash| about
6390 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006391 To set this option automatically depending on the language, see
6392 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006393
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006394 *'spellfile'* *'spf'*
6395'spellfile' 'spf' string (default empty)
6396 local to buffer
6397 {not in Vi}
6398 {not available when compiled without the |+syntax|
6399 feature}
6400 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006401 commands. It must end in ".{encoding}.add". You need to include the
6402 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006403 *E765*
6404 It may also be a comma separated list of names. A count before the
6405 |zg| and |zw| commands can be used to access each. This allows using
6406 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006407 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006408 you: Using the first directory in 'runtimepath' that is writable. If
6409 there is no "spell" directory yet it will be created. For the file
6410 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006411 ignoring the region.
6412 The resulting ".spl" file will be used for spell checking, it does not
6413 have to appear in 'spelllang'.
6414 Normally one file is used for all regions, but you can add the region
6415 name if you want to. However, it will then only be used when
6416 'spellfile' is set to it, for entries in 'spelllang' only files
6417 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006418 This option cannot be set from a |modeline| or in the |sandbox|, for
6419 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006420
Bram Moolenaar217ad922005-03-20 22:37:15 +00006421 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006422'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006423 local to buffer
6424 {not in Vi}
6425 {not available when compiled without the |+syntax|
6426 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006427 A comma separated list of word list names. When the 'spell' option is
6428 on spellchecking will be done for these languages. Example: >
6429 set spelllang=en_us,nl,medical
6430< This means US English, Dutch and medical words are recognized. Words
6431 that are not recognized will be highlighted.
6432 The word list name must not include a comma or dot. Using a dash is
6433 recommended to separate the two letter language name from a
6434 specification. Thus "en-rare" is used for rare English words.
6435 A region name must come last and have the form "_xx", where "xx" is
6436 the two-letter, lower case region name. You can use more than one
6437 region by listing them: "en_us,en_ca" supports both US and Canadian
6438 English, but not words specific for Australia, New Zealand or Great
6439 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006440 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006441 As a special case the name of a .spl file can be given as-is. The
6442 first "_xx" in the name is removed and used as the region name
6443 (_xx is an underscore, two letters and followed by a non-letter).
6444 This is mainly for testing purposes. You must make sure the correct
6445 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006446 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006447 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6448 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006449 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006450
Bram Moolenaar98692072006-02-04 00:57:42 +00006451 If the |spellfile.vim| plugin is active and you use a language name
6452 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6453 will ask you if you want to download the file.
6454
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006455 After this option has been set successfully, Vim will source the files
6456 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006457 up to the first comma, dot or underscore.
6458 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006459
6460
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006461 *'spellsuggest'* *'sps'*
6462'spellsuggest' 'sps' string (default "best")
6463 global
6464 {not in Vi}
6465 {not available when compiled without the |+syntax|
6466 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006467 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006468 the |spellsuggest()| function. This is a comma-separated list of
6469 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006470
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006471 best Internal method that works best for English. Finds
6472 changes like "fast" and uses a bit of sound-a-like
6473 scoring to improve the ordering.
6474
6475 double Internal method that uses two methods and mixes the
6476 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006477 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006478 word. That only works when the language specifies
6479 sound folding. Can be slow and doesn't always give
6480 better results.
6481
6482 fast Internal method that only checks for simple changes:
6483 character inserts/deletes/swaps. Works well for
6484 simple typing mistakes.
6485
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006486 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006487 Not used for |spellsuggest()|. The number of
6488 suggestions is never more than the value of 'lines'
6489 minus two.
6490
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006491 file:{filename} Read file {filename}, which must have two columns,
6492 separated by a slash. The first column contains the
6493 bad word, the second column the suggested good word.
6494 Example:
6495 theribal/terrible ~
6496 Use this for common mistakes that do not appear at the
6497 top of the suggestion list with the internal methods.
6498 Lines without a slash are ignored, use this for
6499 comments.
6500 The file is used for all languages.
6501
6502 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6503 trouble with spaces. |v:val| holds the badly spelled
6504 word. The expression must evaluate to a List of
6505 Lists, each with a suggestion and a score.
6506 Example:
6507 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006508 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006509 internal methods use. A lower score is better.
6510 This may invoke |spellsuggest()| if you temporarily
6511 set 'spellsuggest' to exclude the "expr:" part.
6512 Errors are silently ignored, unless you set the
6513 'verbose' option to a non-zero value.
6514
6515 Only one of "best", "double" or "fast" may be used. The others may
6516 appear several times in any order. Example: >
6517 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6518<
6519 This option cannot be set from a |modeline| or in the |sandbox|, for
6520 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006521
6522
Bram Moolenaar071d4272004-06-13 20:20:40 +00006523 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6524'splitbelow' 'sb' boolean (default off)
6525 global
6526 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006527 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 feature}
6529 When on, splitting a window will put the new window below the current
6530 one. |:split|
6531
6532 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6533'splitright' 'spr' boolean (default off)
6534 global
6535 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006536 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 feature}
6538 When on, splitting a window will put the new window right of the
6539 current one. |:vsplit|
6540
6541 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6542'startofline' 'sol' boolean (default on)
6543 global
6544 {not in Vi}
6545 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006546 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006547 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006548 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006549 with a linewise operator, with "%" with a count and to buffer changing
6550 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6551 only has a line number, e.g., ":25" or ":+".
6552 In case of buffer changing commands the cursor is placed at the column
6553 where it was the last time the buffer was edited.
6554 NOTE: This option is set when 'compatible' is set.
6555
Bram Moolenaar00654022011-02-25 14:42:19 +01006556 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006558 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 {not in Vi}
6560 {not available when compiled without the |+statusline|
6561 feature}
6562 When nonempty, this option determines the content of the status line.
6563 Also see |status-line|.
6564
6565 The option consists of printf style '%' items interspersed with
6566 normal text. Each status line item is of the form:
6567 %-0{minwid}.{maxwid}{item}
6568 All fields except the {item} is optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01006569 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570
Bram Moolenaar238a5642006-02-21 22:12:05 +00006571 When the option starts with "%!" then it is used as an expression,
6572 evaluated and the result is used as the option value. Example: >
6573 :set statusline=%!MyStatusLine()
6574< The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02006575 Note that the "%!" expression is evaluated in the context of the
6576 current window and buffer, while %{} items are evaluated in the
6577 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006578
6579 When there is error while evaluating the option then it will be made
6580 empty to avoid further errors. Otherwise screen updating would loop.
6581
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582 Note that the only effect of 'ruler' when this option is set (and
6583 'laststatus' is 2) is controlling the output of |CTRL-G|.
6584
6585 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006586 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006588 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 minwid Minimum width of the item, padding as set by '-' & '0'.
6590 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006591 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592 on the left for text items. Numeric items will be
6593 shifted down to maxwid-2 digits followed by '>'number
6594 where number is the amount of missing digits, much like
6595 an exponential notation.
6596 item A one letter code as described below.
6597
6598 Following is a description of the possible statusline items. The
6599 second character in "item" is the type:
6600 N for number
6601 S for string
6602 F for flags as described below
6603 - not applicable
6604
6605 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006606 f S Path to the file in the buffer, as typed or relative to current
6607 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 F S Full path to the file in the buffer.
6609 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006610 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006611 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006612 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006614 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006616 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006618 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006619 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6620 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006621 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6623 being used: "<keymap>"
6624 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01006625 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 B N As above, in hexadecimal.
6627 o N Byte number in file of byte under cursor, first byte is 1.
6628 Mnemonic: Offset from start of file (with one added)
6629 {not available when compiled without |+byte_offset| feature}
6630 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006631 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 l N Line number.
6633 L N Number of lines in buffer.
6634 c N Column number.
6635 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006636 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 p N Percentage through file in lines as in |CTRL-G|.
6638 P S Percentage through file of displayed window. This is like the
6639 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006640 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006641 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006642 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006643 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 ( - Start of item group. Can be used for setting the width and
6645 alignment of a section. Must be followed by %) somewhere.
6646 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006647 T N For 'tabline': start of tab page N label. Use %T after the last
6648 label. This information is used for mouse clicks.
6649 X N For 'tabline': start of close tab N label. Use %X after the
6650 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6651 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 < - Where to truncate line if too long. Default is at the start.
6653 No width fields allowed.
6654 = - Separation point between left and right aligned items.
6655 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006656 # - Set highlight group. The name must follow and then a # again.
6657 Thus use %#HLname# for highlight group HLname. The same
6658 highlighting is used, also for the statusline of non-current
6659 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006661 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006662 The difference between User{N} and StatusLine will be applied
6663 to StatusLineNC for the statusline of non-current windows.
6664 The number N must be between 1 and 9. See |hl-User1..9|
6665
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006666 When displaying a flag, Vim removes the leading comma, if any, when
6667 that flag comes right after plaintext. This will make a nice display
6668 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006669
Bram Moolenaar582fd852005-03-28 20:58:01 +00006670 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006671 not set) and a minwid is not set for the group, the whole group will
6672 become empty. This will make a group like the following disappear
6673 completely from the statusline when none of the flags are set. >
6674 :set statusline=...%(\ [%M%R%H]%)...
6675<
6676 Beware that an expression is evaluated each and every time the status
6677 line is displayed. The current buffer and current window will be set
6678 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006679 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006681 real current buffer.
6682
6683 The 'statusline' option may be evaluated in the |sandbox|, see
6684 |sandbox-option|.
6685
6686 It is not allowed to change text or jump to another window while
6687 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688
6689 If the statusline is not updated when you want it (e.g., after setting
6690 a variable that's used in an expression), you can force an update by
6691 setting an option without changing its value. Example: >
6692 :let &ro = &ro
6693
6694< A result of all digits is regarded a number for display purposes.
6695 Otherwise the result is taken as flag text and applied to the rules
6696 described above.
6697
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006698 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006699 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6700 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6701
6702 Examples:
6703 Emulate standard status line with 'ruler' set >
6704 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6705< Similar, but add ASCII value of char under the cursor (like "ga") >
6706 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6707< Display byte count and byte value, modified flag in red. >
6708 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6709 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6710< Display a ,GZ flag if a compressed file is loaded >
6711 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6712< In the |:autocmd|'s: >
6713 :let b:gzflag = 1
6714< And: >
6715 :unlet b:gzflag
6716< And define this function: >
6717 :function VarExists(var, val)
6718 : if exists(a:var) | return a:val | else | return '' | endif
6719 :endfunction
6720<
6721 *'suffixes'* *'su'*
6722'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6723 global
6724 {not in Vi}
6725 Files with these suffixes get a lower priority when multiple files
6726 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006727 suffixes. Spaces after the comma are ignored. A dot is also seen as
6728 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006729 separator, precede it with a backslash (see |option-backslash| about
6730 including spaces and backslashes).
6731 See 'wildignore' for completely ignoring files.
6732 The use of |:set+=| and |:set-=| is preferred when adding or removing
6733 suffixes from the list. This avoids problems when a future version
6734 uses another default.
6735
6736 *'suffixesadd'* *'sua'*
6737'suffixesadd' 'sua' string (default "")
6738 local to buffer
6739 {not in Vi}
6740 {not available when compiled without the
6741 |+file_in_path| feature}
6742 Comma separated list of suffixes, which are used when searching for a
6743 file for the "gf", "[I", etc. commands. Example: >
6744 :set suffixesadd=.java
6745<
6746 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6747'swapfile' 'swf' boolean (default on)
6748 local to buffer
6749 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006750 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 swapfile is not wanted for a specific buffer. For example, with
6752 confidential information that even root must not be able to access.
6753 Careful: All text will be in memory:
6754 - Don't use this for big files.
6755 - Recovery will be impossible!
6756 A swapfile will only be present when |'updatecount'| is non-zero and
6757 'swapfile' is set.
6758 When 'swapfile' is reset, the swap file for the current buffer is
6759 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6760 non-zero, a swap file is immediately created.
6761 Also see |swap-file| and |'swapsync'|.
6762
6763 This option is used together with 'bufhidden' and 'buftype' to
6764 specify special kinds of buffers. See |special-buffers|.
6765
6766 *'swapsync'* *'sws'*
6767'swapsync' 'sws' string (default "fsync")
6768 global
6769 {not in Vi}
6770 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 When this option is empty parts of the swap file may be in memory and
6773 not written to disk. When the system crashes you may lose more work.
6774 On Unix the system does a sync now and then without Vim asking for it,
6775 so the disadvantage of setting this option off is small. On some
6776 systems the swap file will not be written at all. For a unix system
6777 setting it to "sync" will use the sync() call instead of the default
6778 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006779 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006780
6781 *'switchbuf'* *'swb'*
6782'switchbuf' 'swb' string (default "")
6783 global
6784 {not in Vi}
6785 This option controls the behavior when switching between buffers.
6786 Possible values (comma separated list):
6787 useopen If included, jump to the first open window that
6788 contains the specified buffer (if there is one).
6789 Otherwise: Do not examine other windows.
6790 This setting is checked with |quickfix| commands, when
6791 jumping to errors (":cc", ":cn", "cp", etc.). It is
6792 also used in all buffer related split commands, for
6793 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006794 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006795 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02006797 a buffer for a |quickfix| command that display errors.
6798 Otherwise: do not split, use current window.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006799 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006800 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006802 *'synmaxcol'* *'smc'*
6803'synmaxcol' 'smc' number (default 3000)
6804 local to buffer
6805 {not in Vi}
6806 {not available when compiled without the |+syntax|
6807 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006808 Maximum column in which to search for syntax items. In long lines the
6809 text after this column is not highlighted and following lines may not
6810 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006811 This helps to avoid very slow redrawing for an XML file that is one
6812 long line.
6813 Set to zero to remove the limit.
6814
Bram Moolenaar071d4272004-06-13 20:20:40 +00006815 *'syntax'* *'syn'*
6816'syntax' 'syn' string (default empty)
6817 local to buffer
6818 {not in Vi}
6819 {not available when compiled without the |+syntax|
6820 feature}
6821 When this option is set, the syntax with this name is loaded, unless
6822 syntax highlighting has been switched off with ":syntax off".
6823 Otherwise this option does not always reflect the current syntax (the
6824 b:current_syntax variable does).
6825 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006826 not automatically recognized. Example, in an IDL file:
6827 /* vim: set syntax=idl : */ ~
6828 When a dot appears in the value then this separates two filetype
6829 names. Example:
6830 /* vim: set syntax=c.doxygen : */ ~
6831 This will use the "c" syntax first, then the "doxygen" syntax.
6832 Note that the second one must be prepared to be loaded as an addition,
6833 otherwise it will be skipped. More than one dot may appear.
6834 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 :set syntax=OFF
6836< To switch syntax highlighting on according to the current value of the
6837 'filetype' option: >
6838 :set syntax=ON
6839< What actually happens when setting the 'syntax' option is that the
6840 Syntax autocommand event is triggered with the value as argument.
6841 This option is not copied to another buffer, independent of the 's' or
6842 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006843 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006845 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006846'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006847 global
6848 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006849 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006850 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006851 When nonempty, this option determines the content of the tab pages
6852 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006853 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006854
6855 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006856 option and only when there is no GUI tab line. When 'e' is in
6857 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006858 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006859
6860 The value is evaluated like with 'statusline'. You can use
6861 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006862 the text to be displayed. Use "%1T" for the first label, "%2T" for
6863 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006864
6865 Keep in mind that only one of the tab pages is the current one, others
6866 are invisible and you can't jump to their windows.
6867
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006868
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006869 *'tabpagemax'* *'tpm'*
6870'tabpagemax' 'tpm' number (default 10)
6871 global
6872 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006873 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006874 feature}
6875 Maximum number of tab pages to be opened by the |-p| command line
6876 argument or the ":tab all" command. |tabpage|
6877
6878
6879 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880'tabstop' 'ts' number (default 8)
6881 local to buffer
6882 Number of spaces that a <Tab> in the file counts for. Also see
6883 |:retab| command, and 'softtabstop' option.
6884
6885 Note: Setting 'tabstop' to any other value than 8 can make your file
6886 appear wrong in many places (e.g., when printing it).
6887
6888 There are four main ways to use tabs in Vim:
6889 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6890 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006891 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006892 behave like a tab appears every 4 (or 3) characters.
6893 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6894 'expandtab'. This way you will always insert spaces. The
6895 formatting will never be messed up when 'tabstop' is changed.
6896 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006897 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006898 works when using Vim to edit the file.
6899 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6900 'noexpandtab'. This should then work (for initial indents only)
6901 for any tabstop setting that people use. It might be nice to have
6902 tabs after the first non-blank inserted as spaces if you do this
6903 though. Otherwise aligned comments will be wrong when 'tabstop' is
6904 changed.
6905
6906 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6907'tagbsearch' 'tbs' boolean (default on)
6908 global
6909 {not in Vi}
6910 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006911 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 searching makes searching for a tag a LOT faster, but a linear search
6913 will find more tags if the tags file wasn't properly sorted.
6914 Vim normally assumes that your tags files are sorted, or indicate that
6915 they are not sorted. Only when this is not the case does the
6916 'tagbsearch' option need to be switched off.
6917
6918 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006919 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006920 certain files, or retry all files with a linear search. When
6921 'tagbsearch' is off, only a linear search is done.
6922
6923 Linear searching is done anyway, for one file, when Vim finds a line
6924 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006925 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006926< [The whitespace before and after the '0' must be a single <Tab>]
6927
6928 When a binary search was done and no match was found in any of the
6929 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6930 instead of a normal tag name, a retry is done with a linear search.
6931 Tags in unsorted tags files, and matches with different case will only
6932 be found in the retry.
6933
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006934 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 linear search can be avoided for the 'ignorecase' case. Use a value
6936 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6937 case-fold sorted with the -f switch to "sort" in most unices, as in
6938 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006939 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6940 for this as well. Note that case must be folded to uppercase for this
6941 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006942
6943 When 'tagbsearch' is off, tags searching is slower when a full match
6944 exists, but faster when no full match exists. Tags in unsorted tags
6945 files may only be found with 'tagbsearch' off.
6946 When the tags file is not sorted, or sorted in a wrong way (not on
6947 ASCII byte value), 'tagbsearch' should be off, or the line given above
6948 must be included in the tags file.
6949 This option doesn't affect commands that find all matching tags (e.g.,
6950 command-line completion and ":help").
6951 {Vi: always uses binary search in some versions}
6952
6953 *'taglength'* *'tl'*
6954'taglength' 'tl' number (default 0)
6955 global
6956 If non-zero, tags are significant up to this number of characters.
6957
6958 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6959'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6960 global
6961 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006962 If on and using a tags file in another directory, file names in that
6963 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 NOTE: This option is set to the Vi default value when 'compatible' is
6965 set and to the Vim default value when 'compatible' is reset.
6966
6967 *'tags'* *'tag'* *E433*
6968'tags' 'tag' string (default "./tags,tags", when compiled with
6969 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6970 global or local to buffer |global-local|
6971 Filenames for the tag command, separated by spaces or commas. To
6972 include a space or comma in a file name, precede it with a backslash
6973 (see |option-backslash| about including spaces and backslashes).
6974 When a file name starts with "./", the '.' is replaced with the path
6975 of the current file. But only when the 'd' flag is not included in
6976 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6977 |tags-option|.
6978 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006979 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6980 find all files named "tags" below "/lib". The filename itself cannot
6981 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6982 files called "tags?". {not available when compiled without the
6983 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006984 The |tagfiles()| function can be used to get a list of the file names
6985 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006986 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6987 files are also supported. They are automatically recognized. The
6988 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6989 differences are ignored (MS-Windows). |emacs-tags|
6990 The use of |:set+=| and |:set-=| is preferred when adding or removing
6991 file names from the list. This avoids problems when a future version
6992 uses another default.
6993 {Vi: default is "tags /usr/lib/tags"}
6994
6995 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6996'tagstack' 'tgst' boolean (default on)
6997 global
6998 {not in all versions of Vi}
6999 When on, the |tagstack| is used normally. When off, a ":tag" or
7000 ":tselect" command with an argument will not push the tag onto the
7001 tagstack. A following ":tag" without an argument, a ":pop" command or
7002 any other command that uses the tagstack will use the unmodified
7003 tagstack, but does change the pointer to the active entry.
7004 Resetting this option is useful when using a ":tag" command in a
7005 mapping which should not change the tagstack.
7006
7007 *'term'* *E529* *E530* *E531*
7008'term' string (default is $TERM, if that fails:
7009 in the GUI: "builtin_gui"
7010 on Amiga: "amiga"
7011 on BeOS: "beos-ansi"
7012 on Mac: "mac-ansi"
7013 on MiNT: "vt52"
7014 on MS-DOS: "pcterm"
7015 on OS/2: "os2ansi"
7016 on Unix: "ansi"
7017 on VMS: "ansi"
7018 on Win 32: "win32")
7019 global
7020 Name of the terminal. Used for choosing the terminal control
7021 characters. Environment variables are expanded |:set_env|.
7022 For example: >
7023 :set term=$TERM
7024< See |termcap|.
7025
7026 *'termbidi'* *'tbidi'*
7027 *'notermbidi'* *'notbidi'*
7028'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7029 global
7030 {not in Vi}
7031 {only available when compiled with the |+arabic|
7032 feature}
7033 The terminal is in charge of Bi-directionality of text (as specified
7034 by Unicode). The terminal is also expected to do the required shaping
7035 that some languages (such as Arabic) require.
7036 Setting this option implies that 'rightleft' will not be set when
7037 'arabic' is set and the value of 'arabicshape' will be ignored.
7038 Note that setting 'termbidi' has the immediate effect that
7039 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7040 This option is reset when the GUI is started.
7041 For further details see |arabic.txt|.
7042
7043 *'termencoding'* *'tenc'*
7044'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
7045 Macintosh GUI: "macroman")
7046 global
7047 {only available when compiled with the |+multi_byte|
7048 feature}
7049 {not in Vi}
7050 Encoding used for the terminal. This specifies what character
7051 encoding the keyboard produces and the display will understand. For
7052 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007053 display). Except for the Mac when 'macatsui' is off, then
7054 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007055 In the Win32 console version the default value is the console codepage
7056 when it differs from the ANSI codepage.
7057 *E617*
7058 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
7059 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7060 Any attempts to set a different value will be rejected, and an error
7061 message is shown.
7062 For the Win32 GUI 'termencoding' is not used for typed characters,
7063 because the Win32 system always passes Unicode characters.
7064 When empty, the same encoding is used as for the 'encoding' option.
7065 This is the normal value.
7066 Not all combinations for 'termencoding' and 'encoding' are valid. See
7067 |encoding-table|.
7068 The value for this option must be supported by internal conversions or
7069 iconv(). When this is not possible no conversion will be done and you
7070 will probably experience problems with non-ASCII characters.
7071 Example: You are working with the locale set to euc-jp (Japanese) and
7072 want to edit a UTF-8 file: >
7073 :let &termencoding = &encoding
7074 :set encoding=utf-8
7075< You need to do this when your system has no locale support for UTF-8.
7076
7077 *'terse'* *'noterse'*
7078'terse' boolean (default off)
7079 global
7080 When set: Add 's' flag to 'shortmess' option (this makes the message
7081 for a search that hits the start or end of the file not being
7082 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7083 shortens a lot of messages}
7084
7085 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7086'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7087 global
7088 {not in Vi}
7089 This option is obsolete. Use 'fileformats'.
7090 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7091 set to the default value for the current system. When 'textauto' is
7092 reset, 'fileformats' is made empty.
7093 NOTE: This option is set to the Vi default value when 'compatible' is
7094 set and to the Vim default value when 'compatible' is reset.
7095
7096 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7097'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7098 others: default off)
7099 local to buffer
7100 {not in Vi}
7101 This option is obsolete. Use 'fileformat'.
7102 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7103 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7104 "unix".
7105
7106 *'textwidth'* *'tw'*
7107'textwidth' 'tw' number (default 0)
7108 local to buffer
7109 {not in Vi}
7110 Maximum width of text that is being inserted. A longer line will be
7111 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007112 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7113 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007114 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007115 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 NOTE: This option is set to 0 when 'compatible' is set.
7117
7118 *'thesaurus'* *'tsr'*
7119'thesaurus' 'tsr' string (default "")
7120 global or local to buffer |global-local|
7121 {not in Vi}
7122 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007124 the file should contain words with similar meaning, separated by
7125 non-keyword characters (white space is preferred). Maximum line
7126 length is 510 bytes.
Bram Moolenaar9a7224b2012-04-30 15:56:52 +02007127 To obtain a file to be used here, check out this ftp site:
7128 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007129 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007130 after a comma are ignored, otherwise spaces are included in the file
7131 name. See |option-backslash| about using backslashes.
7132 The use of |:set+=| and |:set-=| is preferred when adding or removing
7133 directories from the list. This avoids problems when a future version
7134 uses another default.
7135 Backticks cannot be used in this option for security reasons.
7136
7137 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7138'tildeop' 'top' boolean (default off)
7139 global
7140 {not in Vi}
7141 When on: The tilde command "~" behaves like an operator.
7142 NOTE: This option is reset when 'compatible' is set.
7143
7144 *'timeout'* *'to'* *'notimeout'* *'noto'*
7145'timeout' 'to' boolean (default on)
7146 global
7147 *'ttimeout'* *'nottimeout'*
7148'ttimeout' boolean (default off)
7149 global
7150 {not in Vi}
7151 These two options together determine the behavior when part of a
7152 mapped key sequence or keyboard code has been received:
7153
7154 'timeout' 'ttimeout' action ~
7155 off off do not time out
7156 on on or off time out on :mappings and key codes
7157 off on time out on key codes
7158
7159 If both options are off, Vim will wait until either the complete
7160 mapping or key sequence has been received, or it is clear that there
7161 is no mapping or key sequence for the received characters. For
7162 example: if you have mapped "vl" and Vim has received 'v', the next
7163 character is needed to see if the 'v' is followed by an 'l'.
7164 When one of the options is on, Vim will wait for about 1 second for
7165 the next character to arrive. After that the already received
7166 characters are interpreted as single characters. The waiting time can
7167 be changed with the 'timeoutlen' option.
7168 On slow terminals or very busy systems timing out may cause
7169 malfunctioning cursor keys. If both options are off, Vim waits
7170 forever after an entered <Esc> if there are key codes that start
7171 with <Esc>. You will have to type <Esc> twice. If you do not have
7172 problems with key codes, but would like to have :mapped key
7173 sequences not timing out in 1 second, set the 'ttimeout' option and
7174 reset the 'timeout' option.
7175
7176 NOTE: 'ttimeout' is reset when 'compatible' is set.
7177
7178 *'timeoutlen'* *'tm'*
7179'timeoutlen' 'tm' number (default 1000)
7180 global
7181 {not in all versions of Vi}
7182 *'ttimeoutlen'* *'ttm'*
7183'ttimeoutlen' 'ttm' number (default -1)
7184 global
7185 {not in Vi}
7186 The time in milliseconds that is waited for a key code or mapped key
7187 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7188 when part of a command has been typed.
7189 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7190 different timeout value for key codes is desired set 'ttimeoutlen' to
7191 a non-negative number.
7192
7193 ttimeoutlen mapping delay key code delay ~
7194 < 0 'timeoutlen' 'timeoutlen'
7195 >= 0 'timeoutlen' 'ttimeoutlen'
7196
7197 The timeout only happens when the 'timeout' and 'ttimeout' options
7198 tell so. A useful setting would be >
7199 :set timeout timeoutlen=3000 ttimeoutlen=100
7200< (time out on mapping after three seconds, time out on key codes after
7201 a tenth of a second).
7202
7203 *'title'* *'notitle'*
7204'title' boolean (default off, on when title can be restored)
7205 global
7206 {not in Vi}
7207 {not available when compiled without the |+title|
7208 feature}
7209 When on, the title of the window will be set to the value of
7210 'titlestring' (if it is not empty), or to:
7211 filename [+=-] (path) - VIM
7212 Where:
7213 filename the name of the file being edited
7214 - indicates the file cannot be modified, 'ma' off
7215 + indicates the file was modified
7216 = indicates the file is read-only
7217 =+ indicates the file is read-only and modified
7218 (path) is the path of the file being edited
7219 - VIM the server name |v:servername| or "VIM"
7220 Only works if the terminal supports setting window titles
7221 (currently Amiga console, Win32 console, all GUI versions and
7222 terminals with a non- empty 't_ts' option - these are Unix xterm and
7223 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7224 *X11*
7225 When Vim was compiled with HAVE_X11 defined, the original title will
7226 be restored if possible. The output of ":version" will include "+X11"
7227 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7228 works for the icon name |'icon'|.
7229 But: When Vim was started with the |-X| argument, restoring the title
7230 will not work (except in the GUI).
7231 If the title cannot be restored, it is set to the value of 'titleold'.
7232 You might want to restore the title outside of Vim then.
7233 When using an xterm from a remote machine you can use this command:
7234 rsh machine_name xterm -display $DISPLAY &
7235 then the WINDOWID environment variable should be inherited and the
7236 title of the window should change back to what it should be after
7237 exiting Vim.
7238
7239 *'titlelen'*
7240'titlelen' number (default 85)
7241 global
7242 {not in Vi}
7243 {not available when compiled without the |+title|
7244 feature}
7245 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 title. When the title is longer, only the end of the path name is
7247 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248 Using a percentage makes this adapt to the width of the window. But
7249 it won't work perfectly, because the actual number of characters
7250 available also depends on the font used and other things in the title
7251 bar. When 'titlelen' is zero the full path is used. Otherwise,
7252 values from 1 to 30000 percent can be used.
7253 'titlelen' is also used for the 'titlestring' option.
7254
7255 *'titleold'*
7256'titleold' string (default "Thanks for flying Vim")
7257 global
7258 {not in Vi}
7259 {only available when compiled with the |+title|
7260 feature}
7261 This option will be used for the window title when exiting Vim if the
7262 original title cannot be restored. Only happens if 'title' is on or
7263 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007264 This option cannot be set from a |modeline| or in the |sandbox|, for
7265 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266 *'titlestring'*
7267'titlestring' string (default "")
7268 global
7269 {not in Vi}
7270 {not available when compiled without the |+title|
7271 feature}
7272 When this option is not empty, it will be used for the title of the
7273 window. This happens only when the 'title' option is on.
7274 Only works if the terminal supports setting window titles (currently
7275 Amiga console, Win32 console, all GUI versions and terminals with a
7276 non-empty 't_ts' option).
7277 When Vim was compiled with HAVE_X11 defined, the original title will
7278 be restored if possible |X11|.
7279 When this option contains printf-style '%' items, they will be
7280 expanded according to the rules used for 'statusline'.
7281 Example: >
7282 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7283 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7284< The value of 'titlelen' is used to align items in the middle or right
7285 of the available space.
7286 Some people prefer to have the file name first: >
7287 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7288< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007289 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 separating space only when needed.
7291 NOTE: Use of special characters in 'titlestring' may cause the display
7292 to be garbled (e.g., when it contains a CR or NL character).
7293 {not available when compiled without the |+statusline| feature}
7294
7295 *'toolbar'* *'tb'*
7296'toolbar' 'tb' string (default "icons,tooltips")
7297 global
7298 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7299 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007300 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 possible values are:
7302 icons Toolbar buttons are shown with icons.
7303 text Toolbar buttons shown with text.
7304 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007305 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 tooltips Tooltips are active for toolbar buttons.
7307 Tooltips refer to the popup help text which appears after the mouse
7308 cursor is placed over a toolbar button for a brief moment.
7309
7310 If you want the toolbar to be shown with icons as well as text, do the
7311 following: >
7312 :set tb=icons,text
7313< Motif and Athena cannot display icons and text at the same time. They
7314 will show icons if both are requested.
7315
7316 If none of the strings specified in 'toolbar' are valid or if
7317 'toolbar' is empty, this option is ignored. If you want to disable
7318 the toolbar, you need to set the 'guioptions' option. For example: >
7319 :set guioptions-=T
7320< Also see |gui-toolbar|.
7321
7322 *'toolbariconsize'* *'tbis'*
7323'toolbariconsize' 'tbis' string (default "small")
7324 global
7325 {not in Vi}
7326 {only in the GTK+ 2 GUI}
7327 Controls the size of toolbar icons. The possible values are:
7328 tiny Use tiny toolbar icons.
7329 small Use small toolbar icons (default).
7330 medium Use medium-sized toolbar icons.
7331 large Use large toolbar icons.
7332 The exact dimensions in pixels of the various icon sizes depend on
7333 the current theme. Common dimensions are large=32x32, medium=24x24,
7334 small=20x20 and tiny=16x16.
7335
7336 If 'toolbariconsize' is empty, the global default size as determined
7337 by user preferences or the current theme is used.
7338
7339 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7340'ttybuiltin' 'tbi' boolean (default on)
7341 global
7342 {not in Vi}
7343 When on, the builtin termcaps are searched before the external ones.
7344 When off the builtin termcaps are searched after the external ones.
7345 When this option is changed, you should set the 'term' option next for
7346 the change to take effect, for example: >
7347 :set notbi term=$TERM
7348< See also |termcap|.
7349 Rationale: The default for this option is "on", because the builtin
7350 termcap entries are generally better (many systems contain faulty
7351 xterm entries...).
7352
7353 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7354'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7355 sun-cmd, screen, rxvt, dtterm or
7356 iris-ansi; also on when running Vim in
7357 a DOS console)
7358 global
7359 {not in Vi}
7360 Indicates a fast terminal connection. More characters will be sent to
7361 the screen for redrawing, instead of using insert/delete line
7362 commands. Improves smoothness of redrawing when there are multiple
7363 windows and the terminal does not support a scrolling region.
7364 Also enables the extra writing of characters at the end of each screen
7365 line for lines that wrap. This helps when using copy/paste with the
7366 mouse in an xterm and other terminals.
7367
7368 *'ttymouse'* *'ttym'*
7369'ttymouse' 'ttym' string (default depends on 'term')
7370 global
7371 {not in Vi}
7372 {only in Unix and VMS, doesn't work in the GUI; not
7373 available when compiled without |+mouse|}
7374 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007375 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 *xterm-mouse*
7377 xterm xterm-like mouse handling. The mouse generates
7378 "<Esc>[Mscr", where "scr" is three bytes:
7379 "s" = button state
7380 "c" = column plus 33
7381 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007382 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007383 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 xterm2 Works like "xterm", but with the xterm reporting the
7385 mouse position while the mouse is dragged. This works
7386 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007387 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007388 work. See below for how Vim detects this
7389 automatically.
7390 *netterm-mouse*
7391 netterm NetTerm mouse handling. The mouse generates
7392 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7393 for the row and column.
7394 *dec-mouse*
7395 dec DEC terminal mouse handling. The mouse generates a
7396 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007397 This is also available for an Xterm, if it was
7398 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 *jsbterm-mouse*
7400 jsbterm JSB term mouse handling.
7401 *pterm-mouse*
7402 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007403 *urxvt-mouse*
7404 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007405
7406 The mouse handling must be enabled at compile time |+mouse_xterm|
7407 |+mouse_dec| |+mouse_netterm|.
7408 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7409 recognized, if enabled at compile time. DEC terminal mouse codes
7410 are recognized if enabled at compile time, and 'ttymouse' is not
7411 "xterm" (because the xterm and dec mouse codes conflict).
7412 This option is automatically set to "xterm", when the 'term' option is
7413 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7414 or "xterm2" already. The main use of this option is to set it to
7415 "xterm", when the terminal name doesn't start with "xterm", but it can
7416 handle xterm mouse codes.
7417 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007418 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 feature and if |t_RV| is set to the escape sequence to request the
7420 xterm version number. Otherwise "xterm2" must be set explicitly.
7421 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7422 t_RV to an empty string: >
7423 :set t_RV=
7424<
7425 *'ttyscroll'* *'tsl'*
7426'ttyscroll' 'tsl' number (default 999)
7427 global
7428 Maximum number of lines to scroll the screen. If there are more lines
7429 to scroll the window is redrawn. For terminals where scrolling is
7430 very slow and redrawing is not slow this can be set to a small number,
7431 e.g., 3, to speed up displaying.
7432
7433 *'ttytype'* *'tty'*
7434'ttytype' 'tty' string (default from $TERM)
7435 global
7436 Alias for 'term', see above.
7437
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007438 *'undodir'* *'udir'*
7439'undodir' 'udir' string (default ".")
7440 global
7441 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007442 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007443 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007444 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007445 "." means using the directory of the file. The undo file name for
7446 "file.txt" is ".file.txt.un~".
7447 For other directories the file name is the full path of the edited
7448 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007449 When writing: The first directory that exists is used. "." always
7450 works, no directories after "." will be used for writing.
7451 When reading all entries are tried to find an undo file. The first
7452 undo file that exists is used. When it cannot be read an error is
7453 given, no further entry is used.
7454 See |undo-persistence|.
7455
7456 *'undofile'* *'udf'*
7457'undofile' 'udf' boolean (default off)
7458 local to buffer
7459 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007460 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007461 When on, Vim automatically saves undo history to an undo file when
7462 writing a buffer to a file, and restores undo history from the same
7463 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007464 The directory where the undo file is stored is specified by 'undodir'.
7465 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007466 The undo file is not read when 'undoreload' causes the buffer from
7467 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007468 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007469
Bram Moolenaar071d4272004-06-13 20:20:40 +00007470 *'undolevels'* *'ul'*
7471'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7472 Win32 and OS/2)
7473 global
7474 {not in Vi}
7475 Maximum number of changes that can be undone. Since undo information
7476 is kept in memory, higher numbers will cause more memory to be used
7477 (nevertheless, a single change can use an unlimited amount of memory).
7478 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7479 itself: >
7480 set ul=0
7481< But you can also get Vi compatibility by including the 'u' flag in
7482 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007483 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007484 Set to a negative number for no undo at all: >
7485 set ul=-1
7486< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007487 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007489 *'undoreload'* *'ur'*
7490'undoreload' 'ur' number (default 10000)
7491 global
7492 {not in Vi}
7493 Save the whole buffer for undo when reloading it. This applies to the
7494 ":e!" command and reloading for when the buffer changed outside of
7495 Vim. |FileChangedShell|
7496 The save only happens when this options is negative or when the number
7497 of lines is smaller than the value of this option.
7498 Set this option to zero to disable undo for a reload.
7499
7500 When saving undo for a reload, any undo file is not read.
7501
7502 Note that this causes the whole buffer to be stored in memory. Set
7503 this option to a lower value if you run out of memory.
7504
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 *'updatecount'* *'uc'*
7506'updatecount' 'uc' number (default: 200)
7507 global
7508 {not in Vi}
7509 After typing this many characters the swap file will be written to
7510 disk. When zero, no swap file will be created at all (see chapter on
7511 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7512 Vim with the "-n" option, see |startup|. When editing in readonly
7513 mode this option will be initialized to 10000.
7514 The swapfile can be disabled per buffer with |'swapfile'|.
7515 When 'updatecount' is set from zero to non-zero, swap files are
7516 created for all buffers that have 'swapfile' set. When 'updatecount'
7517 is set to zero, existing swap files are not deleted.
7518 Also see |'swapsync'|.
7519 This option has no meaning in buffers where |'buftype'| is "nofile"
7520 or "nowrite".
7521
7522 *'updatetime'* *'ut'*
7523'updatetime' 'ut' number (default 4000)
7524 global
7525 {not in Vi}
7526 If this many milliseconds nothing is typed the swap file will be
7527 written to disk (see |crash-recovery|). Also used for the
7528 |CursorHold| autocommand event.
7529
7530 *'verbose'* *'vbs'*
7531'verbose' 'vbs' number (default 0)
7532 global
7533 {not in Vi, although some versions have a boolean
7534 verbose option}
7535 When bigger than zero, Vim will give messages about what it is doing.
7536 Currently, these messages are given:
7537 >= 1 When the viminfo file is read or written.
7538 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007539 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 >= 8 Files for which a group of autocommands is executed.
7541 >= 9 Every executed autocommand.
7542 >= 12 Every executed function.
7543 >= 13 When an exception is thrown, caught, finished, or discarded.
7544 >= 14 Anything pending in a ":finally" clause.
7545 >= 15 Every executed Ex command (truncated at 200 characters).
7546
7547 This option can also be set with the "-V" argument. See |-V|.
7548 This option is also set by the |:verbose| command.
7549
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007550 When the 'verbosefile' option is set then the verbose messages are not
7551 displayed.
7552
7553 *'verbosefile'* *'vfile'*
7554'verbosefile' 'vfile' string (default empty)
7555 global
7556 {not in Vi}
7557 When not empty all messages are written in a file with this name.
7558 When the file exists messages are appended.
7559 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007560 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007561 Setting 'verbosefile' to a new value is like making it empty first.
7562 The difference with |:redir| is that verbose messages are not
7563 displayed when 'verbosefile' is set.
7564
Bram Moolenaar071d4272004-06-13 20:20:40 +00007565 *'viewdir'* *'vdir'*
7566'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7567 "$VIM/vimfiles/view",
7568 for Unix: "~/.vim/view",
7569 for Macintosh: "$VIM:vimfiles:view"
7570 for VMS: "sys$login:vimfiles/view"
7571 for RiscOS: "Choices:vimfiles/view")
7572 global
7573 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007574 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007575 feature}
7576 Name of the directory where to store files for |:mkview|.
7577 This option cannot be set from a |modeline| or in the |sandbox|, for
7578 security reasons.
7579
7580 *'viewoptions'* *'vop'*
7581'viewoptions' 'vop' string (default: "folds,options,cursor")
7582 global
7583 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007584 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007585 feature}
7586 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007587 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007588 word save and restore ~
7589 cursor cursor position in file and in window
7590 folds manually created folds, opened/closed folds and local
7591 fold options
7592 options options and mappings local to a window or buffer (not
7593 global values for local options)
7594 slash backslashes in file names replaced with forward
7595 slashes
7596 unix with Unix end-of-line format (single <NL>), even when
7597 on Windows or DOS
7598
7599 "slash" and "unix" are useful on Windows when sharing view files
7600 with Unix. The Unix version of Vim cannot source dos format scripts,
7601 but the Windows version of Vim can source unix format scripts.
7602
7603 *'viminfo'* *'vi'* *E526* *E527* *E528*
7604'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007605 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7606 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7607 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007608 global
7609 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007610 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 feature}
7612 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007613 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 separated list of parameters, each consisting of a single character
7615 identifying the particular parameter, followed by a number or string
7616 which specifies the value of that parameter. If a particular
7617 character is left out, then the default value is used for that
7618 parameter. The following is a list of the identifying characters and
7619 the effect of their value.
7620 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007621 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007622 ! When included, save and restore global variables that start
7623 with an uppercase letter, and don't contain a lowercase
7624 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007625 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007626 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007627 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007628 " Maximum number of lines saved for each register. Old name of
7629 the '<' item, with the disadvantage that you need to put a
7630 backslash before the ", otherwise it will be recognized as the
7631 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007632 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 % When included, save and restore the buffer list. If Vim is
7634 started with a file name argument, the buffer list is not
7635 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007636 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007637 without a file name and buffers for help files are not written
7638 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007639 When followed by a number, the number specifies the maximum
7640 number of buffers that are stored. Without a number all
7641 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007642 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007643 ' Maximum number of previously edited files for which the marks
7644 are remembered. This parameter must always be included when
7645 'viminfo' is non-empty.
7646 Including this item also means that the |jumplist| and the
7647 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007648 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007649 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007650 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007651 patterns are also saved. When not included, the value of
7652 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007653 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007654 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007655 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007656 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 < Maximum number of lines saved for each register. If zero then
7658 registers are not saved. When not included, all lines are
7659 saved. '"' is the old name for this item.
7660 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007661 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007663 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007664 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 c When included, convert the text in the viminfo file from the
7666 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007667 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007668 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 f Whether file marks need to be stored. If zero, file marks ('0
7670 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007671 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007673 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 h Disable the effect of 'hlsearch' when loading the viminfo
7675 file. When not included, it depends on whether ":nohlsearch"
7676 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007677 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007678 n Name of the viminfo file. The name must immediately follow
7679 the 'n'. Must be the last one! If the "-i" argument was
7680 given when starting Vim, that file name overrides the one
7681 given here with 'viminfo'. Environment variables are expanded
7682 when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007683 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007684 r Removable media. The argument is a string (up to the next
7685 ','). This parameter can be given several times. Each
7686 specifies the start of a path for which no marks will be
7687 stored. This is to avoid removable media. For MS-DOS you
7688 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7689 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7690 ignored. Maximum length of each 'r' argument is 50
7691 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01007692 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007693 s Maximum size of an item in Kbyte. If zero then registers are
7694 not saved. Currently only applies to registers. The default
7695 "s10" will exclude registers with more than 10 Kbyte of text.
7696 Also see the '<' item above: line count limit.
7697
7698 Example: >
7699 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7700<
7701 '50 Marks will be remembered for the last 50 files you
7702 edited.
7703 <1000 Contents of registers (up to 1000 lines each) will be
7704 remembered.
7705 s100 Registers with more than 100 Kbyte text are skipped.
7706 :0 Command-line history will not be saved.
7707 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7708 no / Since '/' is not specified, the default will be used,
7709 that is, save all of the search history, and also the
7710 previous search and substitute patterns.
7711 no % The buffer list will not be saved nor read back.
7712 no h 'hlsearch' highlighting will be restored.
7713
7714 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7715 load the contents of the file, this is not done automatically.
7716
7717 This option cannot be set from a |modeline| or in the |sandbox|, for
7718 security reasons.
7719
7720 *'virtualedit'* *'ve'*
7721'virtualedit' 've' string (default "")
7722 global
7723 {not in Vi}
7724 {not available when compiled without the
7725 |+virtualedit| feature}
7726 A comma separated list of these words:
7727 block Allow virtual editing in Visual block mode.
7728 insert Allow virtual editing in Insert mode.
7729 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007730 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007731
Bram Moolenaar071d4272004-06-13 20:20:40 +00007732 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007733 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007734 of the line. Useful for selecting a rectangle in Visual mode and
7735 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007736 "onemore" is not the same, it will only allow moving the cursor just
7737 after the last character of the line. This makes some commands more
7738 consistent. Previously the cursor was always past the end of the line
7739 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007740 break some plugins or Vim scripts. For example because |l| can move
7741 the cursor after the last character. Use with care!
7742 Using the |$| command will move to the last character in the line, not
7743 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007744 It doesn't make sense to combine "all" with "onemore", but you will
7745 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007746
7747 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7748'visualbell' 'vb' boolean (default off)
7749 global
7750 {not in Vi}
7751 Use visual bell instead of beeping. The terminal code to display the
7752 visual bell is given with 't_vb'. When no beep or flash is wanted,
7753 use ":set vb t_vb=".
7754 Note: When the GUI starts, 't_vb' is reset to its default value. You
7755 might want to set it again in your |gvimrc|.
7756 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7757 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7758 where 40 is the time in msec.
7759 Does not work on the Amiga, you always get a screen flash.
7760 Also see 'errorbells'.
7761
7762 *'warn'* *'nowarn'*
7763'warn' boolean (default on)
7764 global
7765 Give a warning message when a shell command is used while the buffer
7766 has been changed.
7767
7768 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7769'weirdinvert' 'wiv' boolean (default off)
7770 global
7771 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007772 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 It is provided for backwards compatibility with version 4.x.
7774 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7775 vice versa. Has no effect when the GUI is running.
7776
7777 *'whichwrap'* *'ww'*
7778'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7779 global
7780 {not in Vi}
7781 Allow specified keys that move the cursor left/right to move to the
7782 previous/next line when the cursor is on the first/last character in
7783 the line. Concatenate characters to allow this for these keys:
7784 char key mode ~
7785 b <BS> Normal and Visual
7786 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007787 h "h" Normal and Visual (not recommended)
7788 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007789 < <Left> Normal and Visual
7790 > <Right> Normal and Visual
7791 ~ "~" Normal
7792 [ <Left> Insert and Replace
7793 ] <Right> Insert and Replace
7794 For example: >
7795 :set ww=<,>,[,]
7796< allows wrap only when cursor keys are used.
7797 When the movement keys are used in combination with a delete or change
7798 operator, the <EOL> also counts for a character. This makes "3h"
7799 different from "3dh" when the cursor crosses the end of a line. This
7800 is also true for "x" and "X", because they do the same as "dl" and
7801 "dh". If you use this, you may also want to use the mapping
7802 ":map <BS> X" to make backspace delete the character in front of the
7803 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007804 When 'l' is included and it is used after an operator at the end of a
7805 line then it will not move to the next line. This makes "dl", "cl",
7806 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 NOTE: This option is set to the Vi default value when 'compatible' is
7808 set and to the Vim default value when 'compatible' is reset.
7809
7810 *'wildchar'* *'wc'*
7811'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7812 global
7813 {not in Vi}
7814 Character you have to type to start wildcard expansion in the
7815 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007816 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007817 The character is not recognized when used inside a macro. See
7818 'wildcharm' for that.
7819 Although 'wc' is a number option, you can set it to a special key: >
7820 :set wc=<Esc>
7821< NOTE: This option is set to the Vi default value when 'compatible' is
7822 set and to the Vim default value when 'compatible' is reset.
7823
7824 *'wildcharm'* *'wcm'*
7825'wildcharm' 'wcm' number (default: none (0))
7826 global
7827 {not in Vi}
7828 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007829 recognized when used inside a macro. You can find "spare" command-line
7830 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007831 you'll never actually type 'wildcharm', just use it in mappings that
7832 automatically invoke completion mode, e.g.: >
7833 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007834 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007835< Then after typing :ss you can use CTRL-P & CTRL-N.
7836
7837 *'wildignore'* *'wig'*
7838'wildignore' 'wig' string (default "")
7839 global
7840 {not in Vi}
7841 {not available when compiled without the |+wildignore|
7842 feature}
7843 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007844 patterns is ignored when completing file or directory names, and
7845 influences the result of |expand()|, |glob()| and |globpath()| unless
7846 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7848 Also see 'suffixes'.
7849 Example: >
7850 :set wildignore=*.o,*.obj
7851< The use of |:set+=| and |:set-=| is preferred when adding or removing
7852 a pattern from the list. This avoids problems when a future version
7853 uses another default.
7854
Bram Moolenaar94950a92010-12-02 16:01:29 +01007855
Bram Moolenaar81af9252010-12-10 20:35:50 +01007856 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007857'wildignorecase' 'wic' boolean (default off)
7858 global
7859 {not in Vi}
7860 When set case is ignored when completing file names and directories.
7861 Has no effect on systems where file name case is generally ignored.
7862 Does not apply when the shell is used to expand wildcards, which
7863 happens when there are special characters.
7864
7865
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7867'wildmenu' 'wmnu' boolean (default off)
7868 global
7869 {not in Vi}
7870 {not available if compiled without the |+wildmenu|
7871 feature}
7872 When 'wildmenu' is on, command-line completion operates in an enhanced
7873 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7874 the possible matches are shown just above the command line, with the
7875 first match highlighted (overwriting the status line, if there is
7876 one). Keys that show the previous/next match, such as <Tab> or
7877 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7878 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7879 specified. "longest" and "list" do not start "wildmenu" mode.
7880 If there are more matches than can fit in the line, a ">" is shown on
7881 the right and/or a "<" is shown on the left. The status line scrolls
7882 as needed.
7883 The "wildmenu" mode is abandoned when a key is hit that is not used
7884 for selecting a completion.
7885 While the "wildmenu" is active the following keys have special
7886 meanings:
7887
7888 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7889 <Down> - in filename/menu name completion: move into a
7890 subdirectory or submenu.
7891 <CR> - in menu completion, when the cursor is just after a
7892 dot: move into a submenu.
7893 <Up> - in filename/menu name completion: move up into
7894 parent directory or parent menu.
7895
7896 This makes the menus accessible from the console |console-menus|.
7897
7898 If you prefer the <Left> and <Right> keys to move the cursor instead
7899 of selecting a different match, use this: >
7900 :cnoremap <Left> <Space><BS><Left>
7901 :cnoremap <Right> <Space><BS><Right>
7902<
7903 The "WildMenu" highlighting is used for displaying the current match
7904 |hl-WildMenu|.
7905
7906 *'wildmode'* *'wim'*
7907'wildmode' 'wim' string (Vim default: "full")
7908 global
7909 {not in Vi}
7910 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007911 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007912 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 first part specifies the behavior for the first use of 'wildchar',
7914 The second part for the second use, etc.
7915 These are the possible values for each part:
7916 "" Complete only the first match.
7917 "full" Complete the next full match. After the last match,
7918 the original string is used and then the first match
7919 again.
7920 "longest" Complete till longest common string. If this doesn't
7921 result in a longer string, use the next part.
7922 "longest:full" Like "longest", but also start 'wildmenu' if it is
7923 enabled.
7924 "list" When more than one match, list all matches.
7925 "list:full" When more than one match, list all matches and
7926 complete first match.
7927 "list:longest" When more than one match, list all matches and
7928 complete till longest common string.
7929 When there is only a single match, it is fully completed in all cases.
7930
7931 Examples: >
7932 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007933< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 :set wildmode=longest,full
7935< Complete longest common string, then each full match >
7936 :set wildmode=list:full
7937< List all matches and complete each full match >
7938 :set wildmode=list,full
7939< List all matches without completing, then each full match >
7940 :set wildmode=longest,list
7941< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007942 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007944 *'wildoptions'* *'wop'*
7945'wildoptions' 'wop' string (default "")
7946 global
7947 {not in Vi}
7948 {not available when compiled without the |+wildignore|
7949 feature}
7950 A list of words that change how command line completion is done.
7951 Currently only one word is allowed:
7952 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007953 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007954 is displayed per line. Often used tag kinds are:
7955 d #define
7956 f function
7957 Also see |cmdline-completion|.
7958
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 *'winaltkeys'* *'wak'*
7960'winaltkeys' 'wak' string (default "menu")
7961 global
7962 {not in Vi}
7963 {only used in Win32, Motif, GTK and Photon GUI}
7964 Some GUI versions allow the access to menu entries by using the ALT
7965 key in combination with a character that appears underlined in the
7966 menu. This conflicts with the use of the ALT key for mappings and
7967 entering special characters. This option tells what to do:
7968 no Don't use ALT keys for menus. ALT key combinations can be
7969 mapped, but there is no automatic handling. This can then be
7970 done with the |:simalt| command.
7971 yes ALT key handling is done by the windowing system. ALT key
7972 combinations cannot be mapped.
7973 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007974 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007975 keys can be mapped.
7976 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7977 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007978 This option is not used for <F10>; on Win32 and with GTK <F10> will
7979 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007980
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007981 *'window'* *'wi'*
7982'window' 'wi' number (default screen height - 1)
7983 global
7984 Window height. Do not confuse this with the height of the Vim window,
7985 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007986 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7987 value is smaller than 'lines' minus one. The screen will scroll
7988 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007989 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7990 in a much smarter way, taking care of wrapping lines.
7991 When resizing the Vim window, the value is smaller than 1 or more than
7992 or equal to 'lines' it will be set to 'lines' minus 1.
7993 {Vi also uses the option to specify the number of displayed lines}
7994
Bram Moolenaar071d4272004-06-13 20:20:40 +00007995 *'winheight'* *'wh'* *E591*
7996'winheight' 'wh' number (default 1)
7997 global
7998 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007999 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008000 feature}
8001 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008002 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008003 focus goes to a window that is smaller, its size is increased, at the
8004 cost of the height of other windows.
8005 Set 'winheight' to a small number for normal editing.
8006 Set it to 999 to make the current window fill most of the screen.
8007 Other windows will be only 'winminheight' high. This has the drawback
8008 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8009 to create only two windows, set the option after startup is done,
8010 using the |VimEnter| event: >
8011 au VimEnter * set winheight=999
8012< Minimum value is 1.
8013 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014 height of the current window.
8015 'winheight' applies to the current window. Use 'winminheight' to set
8016 the minimal height for other windows.
8017
8018 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8019'winfixheight' 'wfh' boolean (default off)
8020 local to window
8021 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008022 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 feature}
8024 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008025 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8026 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008027 The height may be changed anyway when running out of room.
8028
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008029 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8030'winfixwidth' 'wfw' boolean (default off)
8031 local to window
8032 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008033 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008034 feature}
8035 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008036 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008037 The width may be changed anyway when running out of room.
8038
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 *'winminheight'* *'wmh'*
8040'winminheight' 'wmh' number (default 1)
8041 global
8042 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008043 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008044 feature}
8045 The minimal height of a window, when it's not the current window.
8046 This is a hard minimum, windows will never become smaller.
8047 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8048 status bar) if necessary. They will return to at least one line when
8049 they become active (since the cursor has to have somewhere to go.)
8050 Use 'winheight' to set the minimal height of the current window.
8051 This option is only checked when making a window smaller. Don't use a
8052 large number, it will cause errors when opening more than a few
8053 windows. A value of 0 to 3 is reasonable.
8054
8055 *'winminwidth'* *'wmw'*
8056'winminwidth' 'wmw' number (default 1)
8057 global
8058 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008059 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 feature}
8061 The minimal width of a window, when it's not the current window.
8062 This is a hard minimum, windows will never become smaller.
8063 When set to zero, windows may be "squashed" to zero columns (i.e. just
8064 a vertical separator) if necessary. They will return to at least one
8065 line when they become active (since the cursor has to have somewhere
8066 to go.)
8067 Use 'winwidth' to set the minimal width of the current window.
8068 This option is only checked when making a window smaller. Don't use a
8069 large number, it will cause errors when opening more than a few
8070 windows. A value of 0 to 12 is reasonable.
8071
8072 *'winwidth'* *'wiw'* *E592*
8073'winwidth' 'wiw' number (default 20)
8074 global
8075 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02008076 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 feature}
8078 Minimal number of columns for the current window. This is not a hard
8079 minimum, Vim will use fewer columns if there is not enough room. If
8080 the current window is smaller, its size is increased, at the cost of
8081 the width of other windows. Set it to 999 to make the current window
8082 always fill the screen. Set it to a small number for normal editing.
8083 The width is not adjusted after one of the commands to change the
8084 width of the current window.
8085 'winwidth' applies to the current window. Use 'winminwidth' to set
8086 the minimal width for other windows.
8087
8088 *'wrap'* *'nowrap'*
8089'wrap' boolean (default on)
8090 local to window
8091 {not in Vi}
8092 This option changes how text is displayed. It doesn't change the text
8093 in the buffer, see 'textwidth' for that.
8094 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008095 displaying continues on the next line. When off lines will not wrap
8096 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 moved to a part that is not shown, the screen will scroll
8098 horizontally.
8099 The line will be broken in the middle of a word if necessary. See
8100 'linebreak' to get the break at a word boundary.
8101 To make scrolling horizontally a bit more useful, try this: >
8102 :set sidescroll=5
8103 :set listchars+=precedes:<,extends:>
8104< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008105 This option can't be set from a |modeline| when the 'diff' option is
8106 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008107
8108 *'wrapmargin'* *'wm'*
8109'wrapmargin' 'wm' number (default 0)
8110 local to buffer
8111 Number of characters from the right window border where wrapping
8112 starts. When typing text beyond this limit, an <EOL> will be inserted
8113 and inserting continues on the next line.
8114 Options that add a margin, such as 'number' and 'foldcolumn', cause
8115 the text width to be further reduced. This is Vi compatible.
8116 When 'textwidth' is non-zero, this option is not used.
8117 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8118 and less usefully}
8119
8120 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8121'wrapscan' 'ws' boolean (default on) *E384* *E385*
8122 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008123 Searches wrap around the end of the file. Also applies to |]s| and
8124 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125
8126 *'write'* *'nowrite'*
8127'write' boolean (default on)
8128 global
8129 {not in Vi}
8130 Allows writing files. When not set, writing a file is not allowed.
8131 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008132 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008133 argument. Filtering text is still possible, even though this requires
8134 writing a temporary file.
8135
8136 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8137'writeany' 'wa' boolean (default off)
8138 global
8139 Allows writing to any file with no need for "!" override.
8140
8141 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8142'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8143 otherwise)
8144 global
8145 {not in Vi}
8146 Make a backup before overwriting a file. The backup is removed after
8147 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008148 also on.
8149 WARNING: Switching this option off means that when Vim fails to write
8150 your buffer correctly and then, for whatever reason, Vim exits, you
8151 lose both the original file and what you were writing. Only reset
8152 this option if your file system is almost full and it makes the write
8153 fail (and make sure not to exit Vim until the write was successful).
8154 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008155 When the 'backupskip' pattern matches, a backup is not made anyway.
8156 NOTE: This option is set to the default value when 'compatible' is
8157 set.
8158
8159 *'writedelay'* *'wd'*
8160'writedelay' 'wd' number (default 0)
8161 global
8162 {not in Vi}
8163 The number of microseconds to wait for each character sent to the
8164 screen. When non-zero, characters are sent to the terminal one by
8165 one. For MS-DOS pcterm this does not work. For debugging purposes.
8166
8167 vim:tw=78:ts=8:ft=help:norl: