1*options.txt* For Vim version 7.0aa. Last change: 2004 Jul 15 2 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============================================================================== 221. Setting options *set-option* 23 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 43:se[t] {option}! or 44:se[t] inv{option} Toggle option: Invert value. {not in Vi} 45 46 *:set-default* *:set-&* *:set-&vi* *:set-&vim* 47:se[t] {option}& Reset option to its default value. May depend on the 48 current value of 'compatible'. {not in Vi} 49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi} 50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi} 51 52:se[t] all& Set all options, except terminal options, to their 53 default value. The values of 'term', 'lines' and 54 'columns' are not changed. {not in Vi} 55 56 *:set-args* *E487* *E521* 57:se[t] {option}={value} or 58:se[t] {option}:{value} 59 Set string or number option to {value}. 60 For numeric options the value can be given in decimal, 61 hex (preceded with 0x) or octal (preceded with '0') 62 (hex and octal are only available for machines which 63 have the strtol() function). 64 The old value can be inserted by typing 'wildchar' (by 65 default this is a <Tab> or CTRL-E if 'compatible' is 66 set). See |cmdline-completion|. 67 White space between {option} and '=' is allowed and 68 will be ignored. White space between '=' and {value} 69 is not allowed. 70 See |option-backslash| for using white space and 71 backslashes in {value}. 72 73:se[t] {option}+={value} *:set+=* 74 Add the {value} to a number option, or append the 75 {value} to a string option. When the option is a 76 comma separated list, a comma is added, unless the 77 value was empty. 78 If the option is a list of flags, superfluous flags 79 are removed. Otherwise there is no check for doubled 80 values. You can avoid this by removing a value first. 81 Example: > 82 :set guioptions-=T guioptions+=T 83< Also see |:set-args| above. 84 {not in Vi} 85 86:se[t] {option}^={value} *:set^=* 87 Multiply the {value} to a number option, or prepend 88 the {value} to a string option. When the option is a 89 comma separated list, a comma is added, unless the 90 value was empty. 91 Also see |:set-args| above. 92 {not in Vi} 93 94:se[t] {option}-={value} *:set-=* 95 Subtract the {value} from a number option, or remove 96 the {value} from a string option, if it is there. 97 If the {value} is not found in a string option, there 98 is no error or warning. When the option is a comma 99 separated list, a comma is deleted, unless the option 100 becomes empty. 101 When the option is a list of flags, {value} must be 102 exactly as they appear in the option. Remove flags 103 one by one to avoid problems. 104 Also see |:set-args| above. 105 {not in Vi} 106 107The {option} arguments to ":set" may be repeated. For example: > 108 :set ai nosi sw=3 ts=3 109If you make an error in one of the arguments, an error message will be given 110and the following arguments will be ignored. 111 112 *:set-verbose* 113When 'verbose' is non-zero, displaying an option value will also tell where it 114was last set. Example: > 115 :verbose set shiftwidth cindent? 116 shiftwidth=4 117 Last set from modeline 118 cindent 119 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim 120This is only done when specific option values are requested, not for ":set 121all" or ":set" without an argument. 122When the option was set by hand there is no "Last set" message. There is only 123one value for all local options with the same name. Thus the message applies 124to the option name, not necessarily its value. 125When the option was set while executing a function, user command or 126autocommand, the script in which it was defined is reported. 127Note that an option may also have been set as a side effect of setting 128'compatible'. 129{not available when compiled without the +eval feature} 130 131 *:set-termcap* *E522* 132For {option} the form "t_xx" may be used to set a termcap option. This will 133override the value from the termcap. You can then use it in a mapping. If 134the "xx" part contains special characters, use the <t_xx> form: > 135 :set <t_#4>=^[Ot 136This can also be used to translate a special code for a normal key. For 137example, if Alt-b produces <Esc>b, use this: > 138 :set <M-b>=^[b 139(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) 140The advantage over a mapping is that it works in all situations. 141 142The listing from ":set" looks different from Vi. Long string options are put 143at the end of the list. The number of options is quite large. The output of 144"set all" probably does not fit on the screen, causing Vim to give the 145|more-prompt|. 146 147 *option-backslash* 148To include white space in a string option value it has to be preceded with a 149backslash. To include a backslash you have to use two. Effectively this 150means that the number of backslashes in an option value is halved (rounded 151down). 152A few examples: > 153 :set tags=tags\ /usr/tags results in "tags /usr/tags" 154 :set tags=tags\\,file results in "tags\,file" 155 :set tags=tags\\\ file results in "tags\ file" 156 157The "|" character separates a ":set" command from a following command. To 158include the "|" in the option value, use "\|" instead. This example sets the 159'titlestring' option to "hi|there": > 160 :set titlestring=hi\|there 161This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > 162 :set titlestring=hi|set iconstring=there 163 164For MS-DOS and WIN32 backslashes in file names are mostly not removed. More 165precise: For options that expect a file name (those where environment 166variables are expanded) a backslash before a normal file name character is not 167removed. But a backslash before a special character (space, backslash, comma, 168etc.) is used like explained above. 169There is one special situation, when the value starts with "\\": > 170 :set dir=\\machine\path results in "\\machine\path" 171 :set dir=\\\\machine\\path results in "\\machine\path" 172 :set dir=\\path\\file results in "\\path\file" (wrong!) 173For the first one the start is kept, but for the second one the backslashes 174are halved. This makes sure it works both when you expect backslashes to be 175halved and when you expect the backslashes to be kept. The third gives a 176result which is probably not what you want. Avoid it. 177 178 *add-option-flags* *remove-option-flags* 179 *E539* *E550* *E551* *E552* 180Some options are a list of flags. When you want to add a flag to such an 181option, without changing the existing ones, you can do it like this: > 182 :set guioptions+=a 183Remove a flag from an option like this: > 184 :set guioptions-=a 185This removes the 'a' flag from 'guioptions'. 186Note that you should add or remove one flag at a time. If 'guioptions' has 187the value "ab", using "set guioptions-=ba" won't work, because the string "ba" 188doesn't appear. 189 190 *:set_env* *expand-env* *expand-environment-var* 191Environment variables in most string options will be expanded. If the 192environment variable exists the '$' and the following environment variable 193name is replaced with its value. If it does not exist the '$' and the name 194are not modified. Any non-id character (not a letter, digit or '_') may 195follow the environment variable name. That character and what follows is 196appended to the value of the environment variable. Examples: > 197 :set term=$TERM.new 198 :set path=/usr/$INCLUDE,$HOME/include,. 199When adding or removing a string from an option with ":set opt-=val" or ":set 200opt+=val" the expansion is done before the adding or removing. 201 202 203Handling of local options *local-options* 204 205Some of the options only apply to a window or buffer. Each window or buffer 206has its own copy of this option, thus can each have their own value. This 207allows you to set 'list' in one window but not in another. And set 208'shiftwidth' to 3 in one buffer and 4 in another. 209 210The following explains what happens to these local options in specific 211situations. You don't really need to know all of this, since Vim mostly uses 212the option values you would expect. Unfortunately, doing what the user 213expects is a bit complicated... 214 215When splitting a window, the local options are copied to the new window. Thus 216right after the split the contents of the two windows look the same. 217 218When editing a new buffer, its local option values must be initialized. Since 219the local options of the current buffer might be specifically for that buffer, 220these are not used. Instead, for each buffer-local option there also is a 221global value, which is used for new buffers. With ":set" both the local and 222global value is changed. With "setlocal" only the local value is changed, 223thus this value is not used when editing a new buffer. 224 225When editing a buffer that has been edited before, the last used window 226options are used again. If this buffer has been edited in this window, the 227values from back then are used. Otherwise the values from the window where 228the buffer was edited last are used. 229 230It's possible to set a local window option specifically for a type of buffer. 231When you edit another buffer in the same window, you don't want to keep 232using these local window options. Therefore Vim keeps a global value of the 233local window options, which is used when editing another buffer. Each window 234has its own copy of these values. Thus these are local to the window, but 235global to all buffers in the window. With this you can do: > 236 :e one 237 :set list 238 :e two 239Now the 'list' option will also be set in "two", since with the ":set list" 240command you have also set the global value. > 241 :set nolist 242 :e one 243 :setlocal list 244 :e two 245Now the 'list' option is not set, because ":set nolist" resets the global 246value, ":setlocal list" only changes the local value and ":e two" gets the 247global value. Note that if you do this next: > 248 :e one 249You will not get back the 'list' value as it was the last time you edited 250"one". The options local to a window are not remembered for each buffer. 251 252 *:setl* *:setlocal* 253:setl[ocal] ... Like ":set" but set only the value local to the 254 current buffer or window. Not all options have a 255 local value. If the option does not have a local 256 value the global value is set. 257 With the "all" argument: display all local option's 258 local values. 259 Without argument: Display all local option's local 260 values which are different from the default. 261 When displaying a specific local option, show the 262 local value. For a global option the global value is 263 shown (but that might change in the future). 264 {not in Vi} 265 266:setl[ocal] {option}< Set the local value of {option} to its global value. 267 {not in Vi} 268 269 *:setg* *:setglobal* 270:setg[lobal] ... Like ":set" but set only the global value for a local 271 option without changing the local value. 272 When displaying an option, the global value is shown. 273 With the "all" argument: display all local option's 274 global values. 275 Without argument: display all local option's global 276 values which are different from the default. 277 {not in Vi} 278 279For buffer-local and window-local options: 280 Command global value local value ~ 281 :set option=value set set 282 :setlocal option=value - set 283:setglobal option=value set - 284 :set option? - display 285 :setlocal option? - display 286:setglobal option? display - 287 288 289Global options with a local value *global-local* 290 291Options are global when you mostly use one value for all buffers. For some 292global options it's useful to sometimes have a different local value. You can 293set the local value with ":setlocal". That buffer will then use the local 294value, while other buffers continue using the global value. 295 296For example, you have two windows, both on C source code. They use the global 297'makeprg' option. If you do this in one of the two windows: > 298 :set makeprg=gmake 299then the other window will switch to the same value. There is no need to set 300the 'makeprg' option in the other C source window too. 301However, if you start editing a Perl file in a new window, you want to use 302another 'makeprog' for it, without changing the value used for the C source 303files. You use this command: > 304 :setlocal makeprg=perlmake 305You can switch back to using the global value by making the local value empty: > 306 :setlocal makeprg= 307This only works for a string option. For a boolean option you need to use the 308"<" flag, like this: > 309 :setlocal autoread< 310Note that for non-boolean options using "<" copies the global value to the 311local value, it doesn't switch back to using the global value (that matters 312when changing the global value later). 313Note: In the future more global options can be made global-local. Using 314":setlocal" on a global option might work differently then. 315 316 317Setting the filetype 318 319:setf[iletype] {filetype} *:setf* *:setfiletype* 320 Set the 'filetype' option to {filetype}, but only if 321 not done yet in a sequence of (nested) autocommands. 322 This is short for: > 323 :if !did_filetype() 324 : setlocal filetype={filetype} 325 :endif 326< This command is used in a filetype.vim file to avoid 327 setting the 'filetype' option twice, causing different 328 settings and syntax files to be loaded. 329 {not in Vi} 330 331:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* 332:opt[ions] Open a window for viewing and setting all options. 333 Options are grouped by function. 334 Offers short help for each option. Hit <CR> on the 335 short help to open a help window with more help for 336 the option. 337 Modify the value of the option and hit <CR> on the 338 "set" line to set the new value. For window and 339 buffer specific options, the last accessed window is 340 used to set the option value in, unless this is a help 341 window, in which case the window below help window is 342 used (skipping the option-window). 343 {not available when compiled without the |+eval| or 344 |+autocmd| features} 345 346 *$HOME* 347Using "~" is like using "$HOME", but it is only recognized at the start of an 348option and after a space or comma. 349 350On Unix systems "~user" can be used too. It is replaced by the home directory 351of user "user". Example: > 352 :set path=~mool/include,/usr/include,. 353 354On Unix systems the form "${HOME}" can be used too. The name between {} can 355contain non-id characters then. Note that if you want to use this for the 356"gf" command, you need to add the '{' and '}' characters to 'isfname'. 357 358NOTE: expanding environment variables and "~/" is only done with the ":set" 359command, not when assigning a value to an option with ":let". 360 361 362Note the maximum length of an expanded option is limited. How much depends on 363the system, mostly it is something like 256 or 1024 characters. 364 365 *:fix* *:fixdel* 366:fix[del] Set the value of 't_kD': 367 't_kb' is 't_kD' becomes ~ 368 CTRL-? CTRL-H 369 not CTRL-? CTRL-? 370 371 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} 372 373 If your delete key terminal code is wrong, but the 374 code for backspace is alright, you can put this in 375 your .vimrc: > 376 :fixdel 377< This works no matter what the actual code for 378 backspace is. 379 380 If the backspace key terminal code is wrong you can 381 use this: > 382 :if &term == "termname" 383 : set t_kb=^V<BS> 384 : fixdel 385 :endif 386< Where "^V" is CTRL-V and "<BS>" is the backspace key 387 (don't type four characters!). Replace "termname" 388 with your terminal name. 389 390 If your <Delete> key sends a strange key sequence (not 391 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > 392 :if &term == "termname" 393 : set t_kD=^V<Delete> 394 :endif 395< Where "^V" is CTRL-V and "<Delete>" is the delete key 396 (don't type eight characters!). Replace "termname" 397 with your terminal name. 398 399 *Linux-backspace* 400 Note about Linux: By default the backspace key 401 produces CTRL-?, which is wrong. You can fix it by 402 putting this line in your rc.local: > 403 echo "keycode 14 = BackSpace" | loadkeys 404< 405 *NetBSD-backspace* 406 Note about NetBSD: If your backspace doesn't produce 407 the right code, try this: > 408 xmodmap -e "keycode 22 = BackSpace" 409< If this works, add this in your .Xmodmap file: > 410 keysym 22 = BackSpace 411< You need to restart for this to take effect. 412 413============================================================================== 4142. Automatically setting options *auto-setting* 415 416Besides changing options with the ":set" command, there are three alternatives 417to set options automatically for one or more files: 418 4191. When starting Vim initializations are read from various places. See 420 |initialization|. Most of them are performed for all editing sessions, 421 and some of them depend on the directory where Vim is started. 422 You can create an initialization file with |:mkvimrc|, |:mkview| and 423 |:mksession|. 4242. If you start editing a new file, the automatic commands are executed. 425 This can be used to set options for files matching a particular pattern and 426 many other things. See |autocommand|. 4273. If you start editing a new file, and the 'modeline' option is on, a 428 number of lines at the beginning and end of the file are checked for 429 modelines. This is explained here. 430 431 *modeline* *vim:* *vi:* *ex:* *E520* 432There are two forms of modelines. The first form: 433 [text]{white}{vi:|vim:|ex:}[white]{options} 434 435[text] any text or empty 436{white} at least one blank character (<Space> or <Tab>) 437{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" 438[white] optional white space 439{options} a list of option settings, separated with white space or ':', 440 where each part between ':' is the argument for a ":set" 441 command 442 443Example: > 444 vi:noai:sw=3 ts=6 445 446The second form (this is compatible with some versions of Vi): 447 448 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text] 449 450[text] any text or empty 451{white} at least one blank character (<Space> or <Tab>) 452{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" 453[white] optional white space 454se[t] the string "set " or "se " (note the space) 455{options} a list of options, separated with white space, which is the 456 argument for a ":set" command 457: a colon 458[text] any text or empty 459 460Example: > 461 /* vim: set ai tw=75: */ 462 463The white space before {vi:|vim:|ex:} is required. This minimizes the chance 464that a normal word like "lex:" is caught. There is one exception: "vi:" and 465"vim:" can also be at the start of the line (for compatibility with version 4663.0). Using "ex:" at the start of the line will be ignored (this could be 467short for "example:"). 468 469 *modeline-local* 470The options are set like with ":setlocal": The new value only applies to the 471buffer and window that contain the file. Although it's possible to set global 472options from a modeline, this is unusual. If you have two windows open and 473the files in it set the same global option to a different value, the result 474depends on which one was opened last. 475 476 *modeline-version* 477If the modeline is only to be used for some versions of Vim, the version 478number can be specified where "vim:" is used: 479 vim{vers}: version {vers} or later 480 vim<{vers}: version before {vers} 481 vim={vers}: version {vers} 482 vim>{vers}: version after {vers} 483{vers} is 600 for Vim 6.0 (hundred times the major version plus minor). 484For example, to use a modeline only for Vim 6.0 and later: > 485 /* vim600: set foldmethod=marker: */ 486To use a modeline for Vim before version 5.7: > 487 /* vim<570: set sw=4: */ 488There can be no blanks between "vim" and the ":". 489 490 491The number of lines that are checked can be set with the 'modelines' option. 492If 'modeline' is off or 'modelines' is 0 no lines are checked. 493 494Note that for the first form all of the rest of the line is used, thus a line 495like: > 496 /* vi:ts=4: */ 497will give an error message for the trailing "*/". This line is OK: > 498 /* vi:set ts=4: */ 499 500If an error is detected the rest of the line is skipped. 501 502If you want to include a ':' in a set command precede it with a '\'. The 503backslash in front of the ':' will be removed. Example: > 504 /* vi:set dir=c\:\tmp: */ 505This sets the 'dir' option to "c:\tmp". Only a single backslash before the 506':' is removed. Thus to include "\:" you have to specify "\\:". 507 508No other commands than "set" are supported, for security reasons (somebody 509might create a Trojan horse text file with modelines). 510 511Hint: If you would like to do something else than setting an option, you could 512define an autocommand that checks the file for a specific string. For 513example: > 514 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif 515And define a function SetVar() that does something with the line containing 516"VAR". 517 518============================================================================== 5193. Options summary *option-summary* 520 521In the list below all the options are mentioned with their full name and with 522an abbreviation if there is one. Both forms may be used. 523 524In this document when a boolean option is "set" that means that ":set option" 525is entered. When an option is "reset", ":set nooption" is used. 526 527For some options there are two default values: The "Vim default", which is 528used when 'compatible' is not set, and the "Vi default", which is used when 529'compatible' is set. 530 531Most options are the same in all windows and buffers. There are a few that 532are specific to how the text is presented in a window. These can be set to a 533different value in each window. For example the 'list' option can be set in 534one window and reset in another for the same text, giving both types of view 535at the same time. There are a few options that are specific to a certain 536file. These can have a different value for each file or buffer. For example 537the 'textwidth' option can be 78 for a normal text file and 0 for a C 538program. 539 540 global one option for all buffers and windows 541 local to window each window has its own copy of this option 542 local to buffer each buffer has its own copy of this option 543 544When creating a new window the option values from the currently active window 545are used as a default value for the window-specific options. For the 546buffer-specific options this depends on the 's' and 'S' flags in the 547'cpoptions' option. If 's' is included (which is the default) the values for 548buffer options are copied from the currently active buffer when a buffer is 549first entered. If 'S' is present the options are copied each time the buffer 550is entered, this is almost like having global options. If 's' and 'S' are not 551present, the options are copied from the currently active buffer when the 552buffer is created. 553 554Not all options are supported in all versions. To test if option "foo" can be 555used with ":set" use "exists('&foo')". This doesn't mean the value is 556actually remembered and works. Some options are hidden, which means that you 557can set them but the value is not remembered. To test if option "foo" is 558really supported use "exists('+foo')". 559 560 *E355* 561A jump table for the options with a short description can be found at |Q_op|. 562 563 *'aleph'* *'al'* *aleph* *Aleph* 564'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) 565 global 566 {not in Vi} 567 {only available when compiled with the |+rightleft| 568 feature} 569 The ASCII code for the first letter of the Hebrew alphabet. The 570 routine that maps the keyboard in Hebrew mode, both in Insert mode 571 (when hkmap is set) and on the command-line (when hitting CTRL-_) 572 outputs the Hebrew characters in the range [aleph..aleph+26]. 573 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. 574 See |rileft.txt|. 575 576 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* 577'allowrevins' 'ari' boolean (default off) 578 global 579 {not in Vi} 580 {only available when compiled with the |+rightleft| 581 feature} 582 Allow CTRL-_ in Insert and Command-line mode. This is default off, to 583 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get 584 into reverse Insert mode, and don't know how to get out. See 585 'revins'. 586 NOTE: This option is reset when 'compatible' is set. 587 588 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* 589'altkeymap' 'akm' boolean (default off) 590 global 591 {not in Vi} 592 {only available when compiled with the |+farsi| 593 feature} 594 When on, the second language is Farsi. In editing mode CTRL-_ toggles 595 the keyboard map between Farsi and English, when 'allowrevins' set. 596 597 When off, the keyboard map toggles between Hebrew and English. This 598 is useful to start the Vim in native mode i.e. English (left-to-right 599 mode) and have default second language Farsi or Hebrew (right-to-left 600 mode). See |farsi.txt|. 601 602 *'ambiwidth'* *'ambw'* 603'ambiwidth' 'ambw' string (default: "single") 604 global 605 {not in Vi} 606 {only available when compiled with the |+multi_byte| 607 feature} 608 Only effective when 'encoding' is "utf-8" or another Unicode encoding. 609 Tells Vim what to do with characters with East Asian Width Class 610 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek 611 letters, Cyrillic letters). 612 613 There are currently two possible values: 614 "single": Use the same width as characters in US-ASCII. This is 615 expected by most users. 616 "double": Use twice the width of ASCII characters. 617 618 There are a number of CJK fonts for which the width of glyphs for 619 those characters are solely based on how many octets they take in 620 legacy/traditional CJK encodings. In those encodings, Euro, 621 Registered sign, Greek/Cyrillic letters are represented by two octets, 622 therefore those fonts have "wide" glyphs for them. This is also 623 true of some line drawing characters used to make tables in text 624 file. Therefore, when a CJK font is used for GUI Vim or 625 Vim is running inside a terminal (emulators) that uses a CJK font 626 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), 627 this option should be set to "double" to match the width perceived 628 by Vim with the width of glyphs in the font. Perhaps it also has 629 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP 630 when the system locale is set to one of CJK locales. See Unicode 631 Standard Annex #11 (http://www.unicode.org/reports/tr11). 632 633 *'antialias'* *'anti'* *'noantialias'* *'noanti'* 634'antialias' 'anti' boolean (default: off) 635 global 636 {not in Vi} 637 {only available when compiled with GUI enabled 638 on Mac OS X} 639 This option only has an effect in the GUI version of Vim on Mac OS X 640 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, 641 which can be easier to read at certain sizes on certain displays. 642 Setting this option can sometimes cause problems if 'guifont' is set 643 to its default (empty string). 644 645 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* 646'autochdir' 'acd' boolean (default off) 647 global 648 {not in Vi} 649 {only available when compiled with the 650 |+netbeans_intg| or |+sun_workshop| feature} 651 When on, Vim will change its value for the current working directory 652 whenever you open a file, switch buffers, delete a buffer or 653 open/close a window. It will change to the directory containing the 654 file which was opened or selected. This option is provided for 655 backward compatibility with the Vim released with Sun ONE Studio 4 656 Enterprise Edition. 657 658 *'arabic'* *'arab'* *'noarabic'* *'noarab'* 659'arabic' 'arab' boolean (default off) 660 local to window 661 {not in Vi} 662 {only available when compiled with the |+arabic| 663 feature} 664 This option can be set to start editing Arabic text. 665 Setting this option will: 666 - Set the 'rightleft' option, unless 'termbidi' is set. 667 - Set the 'arabicshape' option, unless 'termbidi' is set. 668 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles 669 between typing English and Arabic key mapping. 670 - Set the 'delcombine' option 671 Note that 'encoding' must be "utf-8" for working with Arabic text. 672 673 Resetting this option will: 674 - Reset the 'rightleft' option. 675 - Disable the use of 'keymap' (without changing its value). 676 Note that 'arabicshape' and 'delcombine' are not reset (it is a global 677 option. 678 Also see |arabic.txt|. 679 680 *'arabicshape'* *'arshape'* 681 *'noarabicshape'* *'noarshape'* 682'arabicshape' 'arshape' boolean (default on) 683 global 684 {not in Vi} 685 {only available when compiled with the |+arabic| 686 feature} 687 When on and 'termbidi' is off, the required visual character 688 corrections that need to take place for displaying the Arabic language 689 take affect. Shaping, in essence, gets enabled; the term is a broad 690 one which encompasses: 691 a) the changing/morphing of characters based on their location 692 within a word (initial, medial, final and stand-alone). 693 b) the enabling of the ability to compose characters 694 c) the enabling of the required combining of some characters 695 When disabled the character display reverts back to each character's 696 true stand-alone form. 697 Arabic is a complex language which requires other settings, for 698 further details see |arabic.txt|. 699 700 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* 701'autoindent' 'ai' boolean (default off) 702 local to buffer 703 Copy indent from current line when starting a new line (typing <CR> 704 in Insert mode or when using the "o" or "O" command). If you do not 705 type anything on the new line except <BS> or CTRL-D and then type 706 <Esc> or <CR>, the indent is deleted again. Moving the cursor to 707 another line has the same effect, unless the 'I' flag is included in 708 'cpoptions'. 709 When autoindent is on, formatting (with the "gq" command or when you 710 reach 'textwidth' in Insert mode) uses the indentation of the first 711 line. 712 When 'smartindent' or 'cindent' is on the indent is changed in 713 a different way. 714 The 'autoindent' option is reset when the 'paste' option is set. 715 {small difference from Vi: After the indent is deleted when typing 716 <Esc> or <CR>, the cursor position when moving up or down is after the 717 deleted indent; Vi puts the cursor somewhere in the deleted indent}. 718 719 *'autoread'* *'ar'* *'noautoread'* *'noar'* 720'autoread' 'ar' boolean (default off) 721 global or local to buffer |global-local| 722 {not in Vi} 723 When a file has been detected to have been changed outside of Vim and 724 it has not been changed inside of Vim, automatically read it again. 725 When the file has been deleted this is not done. |timestamp| 726 If this option has a local value, use this command to switch back to 727 using the global value: > 728 :set autoread< 729< 730 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* 731'autowrite' 'aw' boolean (default off) 732 global 733 Write the contents of the file, if it has been modified, on each 734 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, 735 :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I, 736 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. 737 Note that for some commands the 'autowrite' option is not used, see 738 'autowriteall' for that. 739 740 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* 741'autowriteall' 'awa' boolean (default off) 742 global 743 {not in Vi} 744 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", 745 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. 746 Setting this option also implies that Vim behaves like 'autowrite' has 747 been set. 748 749 *'background'* *'bg'* 750'background' 'bg' string (default "dark" or "light") 751 global 752 {not in Vi} 753 When set to "dark", Vim will try to use colors that look good on a 754 dark background. When set to "light", Vim will try to use colors that 755 look good on a light background. Any other value is illegal. 756 Vim tries to set the default value according to the terminal used. 757 This will not always be correct. 758 Setting this option does not change the background color, it tells Vim 759 what the background color looks like. For changing the background 760 color, see |:hi-normal|. 761 762 When 'background' is set Vim will adjust the default color groups for 763 the new value. But the colors used for syntax highlighting will not 764 change. 765 When a color scheme is loaded (the "colors_name" variable is set) 766 setting 'background' will cause the color scheme to be reloaded. If 767 the color scheme adjusts to the value of 'background' this will work. 768 However, if the color scheme sets 'background' itself the effect may 769 be undone. First delete the "colors_name" variable when needed. 770 771 When setting 'background' to the default value with: > 772 :set background& 773< Vim will guess the value. In the GUI this should work correctly, 774 in other cases Vim might not be able to guess the right value. 775 776 When starting the GUI, the default value for 'background' will be 777 "light". When the value is not set in the .gvimrc, and Vim detects 778 that the background is actually quite dark, 'background' is set to 779 "dark". But this happens only AFTER the .gvimrc file has been read 780 (because the window needs to be opened to find the actual background 781 color). To get around this, force the GUI window to be opened by 782 putting a ":gui" command in the .gvimrc file, before where the value 783 of 'background' is used (e.g., before ":syntax on"). 784 Normally this option would be set in the .vimrc file. Possibly 785 depending on the terminal name. Example: > 786 :if &term == "pcterm" 787 : set background=dark 788 :endif 789< When this option is set, the default settings for the highlight groups 790 will change. To use other settings, place ":highlight" commands AFTER 791 the setting of the 'background' option. 792 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file 793 to select the colors for syntax highlighting. After changing this 794 option, you must load syntax.vim again to see the result. This can be 795 done with ":syntax on". 796 797 *'backspace'* *'bs'* 798'backspace' 'bs' string (default "") 799 global 800 {not in Vi} 801 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert 802 mode. This is a list of items, separated by commas. Each item allows 803 a way to backspace over something: 804 value effect ~ 805 indent allow backspacing over autoindent 806 eol allow backspacing over line breaks (join lines) 807 start allow backspacing over the start of insert; CTRL-W and CTRL-U 808 stop once at the start of insert. 809 810 When the value is empty, Vi compatible backspacing is used. 811 812 For backwards compatibility with version 5.4 and earlier: 813 value effect ~ 814 0 same as ":set backspace=" (Vi compatible) 815 1 same as ":set backspace=indent,eol" 816 2 same as ":set backspace=indent,eol,start" 817 818 See |:fixdel| if your <BS> or <Del> key does not do what you want. 819 NOTE: This option is set to "" when 'compatible' is set. 820 821 *'backup'* *'bk'* *'nobackup'* *'nobk'* 822'backup' 'bk' boolean (default off) 823 global 824 {not in Vi} 825 Make a backup before overwriting a file. Leave it around after the 826 file has been successfully written. If you do not want to keep the 827 backup file, but you do want a backup while the file is being 828 written, reset this option and set the 'writebackup' option (this is 829 the default). If you do not want a backup file at all reset both 830 options (use this if your file system is almost full). See the 831 |backup-table| for more explanations. 832 When the 'backupskip' pattern matches, a backup is not made anyway. 833 When 'patchmode' is set, the backup may be renamed to become the 834 oldest version of a file. 835 NOTE: This option is reset when 'compatible' is set. 836 837 *'backupcopy'* *'bkc'* 838'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") 839 global 840 {not in Vi} 841 When writing a file and a backup is made, this option tells how it's 842 done. This is a comma separated list of words. 843 844 The main values are: 845 "yes" make a copy of the file and overwrite the original one 846 "no" rename the file and write a new one 847 "auto" one of the previous, what works best 848 849 Extra values that can be combined with the ones above are: 850 "breaksymlink" always break symlinks when writing 851 "breakhardlink" always break hardlinks when writing 852 853 Making a copy and overwriting the original file: 854 - Takes extra time to copy the file. 855 + When the file has special attributes, is a (hard/symbolic) link or 856 has a resource fork, all this is preserved. 857 - When the file is a link the backup will have the name of the link, 858 not of the real file. 859 860 Renaming the file and writing a new one: 861 + It's fast. 862 - Sometimes not all attributes of the file can be copied to the new 863 file. 864 - When the file is a link the new file will not be a link. 865 866 The "auto" value is the middle way: When Vim sees that renaming file 867 is possible without side effects (the attributes can be passed on and 868 and the file is not a link) that is used. When problems are expected, 869 a copy will be made. 870 871 The "breaksymlink" and "breakhardlink" values can be used in 872 combination with any of "yes", "no" and "auto". When included, they 873 force Vim to always break either symbolic or hard links by doing 874 exactly what the "no" option does, renaming the original file to 875 become the backup and writing a new file in its place. This can be 876 useful for example in source trees where all the files are symbolic or 877 hard links and any changes should stay in the local source tree, not 878 be propagated back to the original source. 879 *crontab* 880 One situation where "no" and "auto" will cause problems: A program 881 that opens a file, invokes Vim to edit that file, and then tests if 882 the open file was changed (through the file descriptor) will check the 883 backup file instead of the newly created file. "crontab -e" is an 884 example. 885 886 When a copy is made, the original file is truncated and then filled 887 with the new text. This means that protection bits, owner and 888 symbolic links of the original file are unmodified. The backup file 889 however, is a new file, owned by the user who edited the file. The 890 group of the backup is set to the group of the original file. If this 891 fails, the protection bits for the group are made the same as for 892 others. 893 894 When the file is renamed this is the other way around: The backup has 895 the same attributes of the original file, and the newly written file 896 is owned by the current user. When the file was a (hard/symbolic) 897 link, the new file will not! That's why the "auto" value doesn't 898 rename when the file is a link. The owner and group of the newly 899 written file will be set to the same ones as the original file, but 900 the system may refuse to do this. In that case the "auto" value will 901 again not rename the file. 902 903 *'backupdir'* *'bdir'* 904'backupdir' 'bdir' string (default for Amiga: ".,t:", 905 for MS-DOS and Win32: ".,c:/tmp,c:/temp" 906 for Unix: ".,~/tmp,~/") 907 global 908 {not in Vi} 909 List of directories for the backup file, separated with commas. 910 - The backup file will be created in the first directory in the list 911 where this is possible. 912 - Empty means that no backup file will be created ('patchmode' is 913 impossible!). Writing may fail because of this. 914 - A directory "." means to put the backup file in the same directory 915 as the edited file. 916 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to 917 put the backup file relative to where the edited file is. The 918 leading "." is replaced with the path name of the edited file. 919 ("." inside a directory name has no special meaning). 920 - Spaces after the comma are ignored, other spaces are considered part 921 of the directory name. To have a space at the start of a directory 922 name, precede it with a backslash. 923 - To include a comma in a directory name precede it with a backslash. 924 - A directory name may end in an '/'. 925 - Environment variables are expanded |:set_env|. 926 - Careful with '\' characters, type one before a space, type two to 927 get one in the option (see |option-backslash|), for example: > 928 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces 929< - For backwards compatibility with Vim version 3.0 a '>' at the start 930 of the option is removed. 931 See also 'backup' and 'writebackup' options. 932 If you want to hide your backup files on Unix, consider this value: > 933 :set backupdir=./.backup,~/.backup,.,/tmp 934< You must create a ".backup" directory in each directory and in your 935 home directory for this to work properly. 936 The use of |:set+=| and |:set-=| is preferred when adding or removing 937 directories from the list. This avoids problems when a future version 938 uses another default. 939 This option cannot be set from a |modeline| or in the |sandbox|, for 940 security reasons. 941 942 *'backupext'* *'bex'* *E589* 943'backupext' 'bex' string (default "~", for VMS: "_") 944 global 945 {not in Vi} 946 String which is appended to a file name to make the name of the 947 backup file. The default is quite unusual, because this avoids 948 accidentally overwriting existing files with a backup file. You might 949 prefer using ".bak", but make sure that you don't have files with 950 ".bak" that you want to keep. 951 952 *'backupskip'* *'bsk'* 953'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") 954 global 955 {not in Vi} 956 {not available when compiled without the |+wildignore| 957 feature} 958 A list of file patterns. When one of the patterns matches with the 959 name of the file which is written, no backup file is created. Both 960 the specified file name and the full path name of the file are used. 961 The pattern is used like with |:autocmd|, see |autocmd-patterns|. 962 Watch out for special characters, see |option-backslash|. 963 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the 964 default value. "/tmp/*" is only used for Unix. 965 966 *'balloondelay'* *'bdlay'* 967'balloondelay' 'bdlay' number (default: 600) 968 global 969 {not in Vi} 970 {only available when compiled with the |+balloon_eval| 971 feature} 972 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. 973 974 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* 975'ballooneval' 'beval' boolean (default off) 976 global 977 {not in Vi} 978 {only available when compiled with the |+balloon_eval| 979 and |+sun_workshop| or |+netbeans_intg| features} 980 Switch on the |balloon-eval| functionality. 981 982 *'binary'* *'bin'* *'nobinary'* *'nobin'* 983'binary' 'bin' boolean (default off) 984 local to buffer 985 {not in Vi} 986 This option should be set before editing a binary file. You can also 987 use the |-b| Vim argument. When this option is switched on a few 988 options will be changed (also when it already was on): 989 'textwidth' will be set to 0 990 'wrapmargin' will be set to 0 991 'modeline' will be off 992 'expandtab' will be off 993 Also, 'fileformat' and 'fileformats' options will not be used, the 994 file is read and written like 'fileformat' was "unix" (a single <NL> 995 separates lines). 996 The 'fileencoding' and 'fileencodings' options will not be used, the 997 file is read without conversion. 998 NOTE: When you start editing a(nother) file while the 'bin' option is 999 on, settings from autocommands may change the settings again (e.g., 1000 'textwidth'), causing trouble when editing. You might want to set 1001 'bin' again when the file has been loaded. 1002 The previous values of these options are remembered and restored when 1003 'bin' is switched from on to off. Each buffer has its own set of 1004 saved option values. 1005 To edit a file with 'binary' set you can use the |++bin| argument. 1006 This avoids you have to do ":set bin", which would have effect for all 1007 files you edit. 1008 When writing a file the <EOL> for the last line is only written if 1009 there was one in the original file (normally Vim appends an <EOL> to 1010 the last line if there is none; this would make the file longer). See 1011 the 'endofline' option. 1012 1013 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* 1014'bioskey' 'biosk' boolean (default on) 1015 global 1016 {not in Vi} {only for MS-DOS} 1017 When on the bios is called to obtain a keyboard character. This works 1018 better to detect CTRL-C, but only works for the console. When using a 1019 terminal over a serial port reset this option. 1020 Also see |'conskey'|. 1021 1022 *'bomb'* *'nobomb'* 1023'bomb' boolean (default off) 1024 local to buffer 1025 {not in Vi} 1026 {only available when compiled with the |+multi_byte| 1027 feature} 1028 When writing a file and the following conditions are met, a BOM (Byte 1029 Order Mark) is prepended to the file: 1030 - this option is on 1031 - the 'binary' option is off 1032 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big 1033 endian variants. 1034 Some applications use the BOM to recognize the encoding of the file. 1035 Often used for UCS-2 files on MS-Windows. For other applications it 1036 causes trouble, for example: "cat file1 file2" makes the BOM of file2 1037 appear halfway the resulting file. 1038 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a 1039 check for the presence of the BOM is done and 'bomb' set accordingly. 1040 Unless 'binary' is set, it is removed from the first line, so that you 1041 don't see it when editing. When you don't change the options, the BOM 1042 will be restored when writing the file. 1043 1044 *'breakat'* *'brk'* 1045'breakat' 'brk' string (default " ^I!@*-+;:,./?") 1046 global 1047 {not in Vi} 1048 {not available when compiled without the |+linebreak| 1049 feature} 1050 This option lets you choose which characters might cause a line 1051 break if 'linebreak' is on. 1052 1053 *'browsedir'* *'bsdir'* 1054'browsedir' 'bsdir' string (default for "last") 1055 global 1056 {not in Vi} {only for Motif and Win32 GUI} 1057 Which directory to use for the file browser: 1058 last Use same directory as with last file browser. 1059 buffer Use the directory of the related buffer. 1060 current Use the current directory. 1061 {path} Use the specified directory 1062 1063 *'bufhidden'* *'bh'* 1064'bufhidden' 'bh' string (default: "") 1065 local to buffer 1066 {not in Vi} 1067 {not available when compiled without the |+quickfix| 1068 feature} 1069 This option specifies what happens when a buffer is no longer 1070 displayed in a window: 1071 <empty> follow the global 'hidden' option 1072 hide hide the buffer (don't unload it), also when 'hidden' 1073 is not set 1074 unload unload the buffer, also when 'hidden' is set or using 1075 |:hide| 1076 delete delete the buffer from the buffer list, also when 1077 'hidden' is set or using |:hide|, like using 1078 |:bdelete| 1079 wipe wipe out the buffer from the buffer list, also when 1080 'hidden' is set or using |:hide|, like using 1081 |:bwipeout| 1082 1083 This option is used together with 'buftype' and 'swapfile' to specify 1084 special kinds of buffers. See |special-buffers|. 1085 1086 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* 1087'buflisted' 'bl' boolean (default: on) 1088 local to buffer 1089 {not in Vi} 1090 When this option is set, the buffer shows up in the buffer list. If 1091 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. 1092 This option is reset by Vim for buffers that are only used to remember 1093 a file name or marks. Vim sets it when starting to edit a buffer. 1094 But not when moving to a buffer with ":buffer". 1095 1096 *'buftype'* *'bt'* *E382* 1097'buftype' 'bt' string (default: "") 1098 local to buffer 1099 {not in Vi} 1100 {not available when compiled without the |+quickfix| 1101 feature} 1102 The value of this option specifies the type of a buffer: 1103 <empty> normal buffer 1104 nofile buffer which is not related to a file and will not be 1105 written 1106 nowrite buffer which will not be written 1107 acwrite buffer which will always be written with BufWriteCmd 1108 autocommands. {not available when compiled without the 1109 |+autocmd| feature} 1110 quickfix quickfix buffer, contains list of errors |:cwindow| 1111 help help buffer (you are not supposed to set this 1112 manually) 1113 1114 This option is used together with 'bufhidden' and 'swapfile' to 1115 specify special kinds of buffers. See |special-buffers|. 1116 1117 Be careful with changing this option, it can have many side effects! 1118 1119 A "quickfix" buffer is only used for the error list. This value is 1120 set by the |:cwindow| command and you are not supposed to change it. 1121 1122 "nofile" and "nowrite" buffers are similar: 1123 both: The buffer is not to be written to disk, ":w" doesn't 1124 work (":w filename" does work though). 1125 both: The buffer is never considered to be |'modified'|. 1126 There is no warning when the changes will be lost, for 1127 example when you quit Vim. 1128 both: A swap file is only created when using too much memory 1129 (when 'swapfile' has been reset there is never a swap 1130 file). 1131 nofile only: The buffer name is fixed, it is not handled like a 1132 file name. It is not modified in response to a |:cd| 1133 command. 1134 *E676* 1135 "acwrite" implies that the buffer name is not related to a file, like 1136 "nofile", but it will be written. Thus, in contrast to "nofile" and 1137 "nowrite", ":w" does work and a modified buffer can't be abandoned 1138 without saving. For writing there must be matching |BufWriteCmd|, 1139 |FileWriteCmd| or |FileAppendCmd| autocommands. 1140 1141 *'casemap'* *'cmp'* 1142'casemap' 'cmp' string (default: "internal,keepascii") 1143 global 1144 {not in Vi} 1145 Specifies details about changing the case of letters. It may contain 1146 these words, separated by a comma: 1147 internal Use internal case mapping functions, the current 1148 locale does not change the case mapping. This only 1149 matters when 'encoding' is a Unicode encoding. When 1150 "internal" is omitted, the towupper() and towlower() 1151 system library functions are used when available. 1152 keepascii For the ASCII characters (0x00 to 0x7f) use the US 1153 case mapping, the current locale is not effective. 1154 This probably only matters for Turkish. 1155 1156 *'cdpath'* *'cd'* *E344* *E346* 1157'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") 1158 global 1159 {not in Vi} 1160 {not available when compiled without the 1161 |+file_in_path| feature} 1162 This is a list of directories which will be searched when using the 1163 |:cd| and |:lcd| commands, provided that the directory being searched 1164 for has a relative path (not starting with "/", "./" or "../"). 1165 The 'cdpath' option's value has the same form and semantics as 1166 |'path'|. Also see |file-searching|. 1167 The default value is taken from $CDPATH, with a "," prepended to look 1168 in the current directory first. 1169 If the default value taken from $CDPATH is not what you want, include 1170 a modified version of the following command in your vimrc file to 1171 override it: > 1172 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') 1173< This option cannot be set from a |modeline| or in the |sandbox|, for 1174 security reasons. 1175 (parts of 'cdpath' can be passed to the shell to expand file names). 1176 1177 *'cedit'* 1178'cedit' string (Vi default: "", Vim default: CTRL-F) 1179 global 1180 {not in Vi} 1181 {not available when compiled without the |+vertsplit| 1182 feature} 1183 The key used in Command-line Mode to open the command-line window. 1184 The default is CTRL-F when 'compatible' is off. 1185 Only non-printable keys are allowed. 1186 The key can be specified as a single character, but it is difficult to 1187 type. The preferred way is to use the <> notation. Examples: > 1188 :set cedit=<C-Y> 1189 :set cedit=<Esc> 1190< |Nvi| also has this option, but it only uses the first character. 1191 See |cmdwin|. 1192 1193 *'charconvert'* *'ccv'* *E202* *E214* *E513* 1194'charconvert' 'ccv' string (default "") 1195 global 1196 {only available when compiled with the |+multi_byte| 1197 feature and the |+eval| feature} 1198 {not in Vi} 1199 An expression that is used for character encoding conversion. It is 1200 evaluated when a file that is to be read or has been written has a 1201 different encoding from what is desired. 1202 'charconvert' is not used when the internal iconv() function is 1203 supported and is able to do the conversion. Using iconv() is 1204 preferred, because it is much faster. 1205 'charconvert' is not used when reading stdin |--|, because there is no 1206 file to convert from. You will have to save the text in a file first. 1207 The expression must return zero or an empty string for success, 1208 non-zero for failure. 1209 The possible encoding names encountered are in 'encoding'. 1210 Additionally, names given in 'fileencodings' and 'fileencoding' are 1211 used. 1212 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" 1213 is done internally by Vim, 'charconvert' is not used for this. 1214 'charconvert' is also used to convert the viminfo file, if the 'c' 1215 flag is present in 'viminfo'. Also used for Unicode conversion. 1216 Example: > 1217 set charconvert=CharConvert() 1218 fun CharConvert() 1219 system("recode " 1220 \ . v:charconvert_from . ".." . v:charconvert_to 1221 \ . " <" . v:fname_in . " >" v:fname_out) 1222 return v:shell_error 1223 endfun 1224< The related Vim variables are: 1225 v:charconvert_from name of the current encoding 1226 v:charconvert_to name of the desired encoding 1227 v:fname_in name of the input file 1228 v:fname_out name of the output file 1229 Note that v:fname_in and v:fname_out will never be the same. 1230 Note that v:charconvert_from and v:charconvert_to may be different 1231 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. 1232 Encryption is not done by Vim when using 'charconvert'. If you want 1233 to encrypt the file after conversion, 'charconvert' should take care 1234 of this. 1235 This option cannot be set from a |modeline| or in the |sandbox|, for 1236 security reasons. 1237 1238 *'cindent'* *'cin'* *'nocindent'* *'nocin'* 1239'cindent' 'cin' boolean (default off) 1240 local to buffer 1241 {not in Vi} 1242 {not available when compiled without the |+cindent| 1243 feature} 1244 Enables automatic C program indenting See 'cinkeys' to set the keys 1245 that trigger reindenting in insert mode and 'cinoptions' to set your 1246 preferred indent style. 1247 If 'indentexpr' is not empty, it overrules 'cindent'. 1248 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, 1249 the "=" operator indents using this algorithm rather than calling an 1250 external program. 1251 See |C-indenting|. 1252 When you don't like the way 'cindent' works, try the 'smartindent' 1253 option or 'indentexpr'. 1254 This option is not used when 'paste' is set. 1255 NOTE: This option is reset when 'compatible' is set. 1256 1257 *'cinkeys'* *'cink'* 1258'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") 1259 local to buffer 1260 {not in Vi} 1261 {not available when compiled without the |+cindent| 1262 feature} 1263 A list of keys that, when typed in Insert mode, cause reindenting of 1264 the current line. Only used if 'cindent' is on and 'indentexpr' is 1265 empty. 1266 For the format of this option see |cinkeys-format|. 1267 See |C-indenting|. 1268 1269 *'cinoptions'* *'cino'* 1270'cinoptions' 'cino' string (default "") 1271 local to buffer 1272 {not in Vi} 1273 {not available when compiled without the |+cindent| 1274 feature} 1275 The 'cinoptions' affect the way 'cindent' reindents lines in a C 1276 program. See |cinoptions-values| for the values of this option, and 1277 |C-indenting| for info on C indenting in general. 1278 1279 1280 *'cinwords'* *'cinw'* 1281'cinwords' 'cinw' string (default "if,else,while,do,for,switch") 1282 local to buffer 1283 {not in Vi} 1284 {not available when compiled without both the 1285 |+cindent| and the |+smartindent| features} 1286 These keywords start an extra indent in the next line when 1287 'smartindent' or 'cindent' is set. For 'cindent' this is only done at 1288 an appropriate place (inside {}). 1289 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't 1290 matter, include the keyword both the uppercase and lowercase: 1291 "if,If,IF". 1292 1293 *'clipboard'* *'cb'* 1294'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" 1295 for X-windows, "" otherwise) 1296 global 1297 {not in Vi} 1298 {only in GUI versions or when the |+xterm_clipboard| 1299 feature is included} 1300 This option is a list of comma separated names. 1301 These names are recognized: 1302 1303 unnamed When included, Vim will use the clipboard register '*' 1304 for all yank, delete, change and put operations which 1305 would normally go to the unnamed register. When a 1306 register is explicitly specified, it will always be 1307 used regardless of whether "unnamed" is in 'clipboard' 1308 or not. The clipboard register can always be 1309 explicitly accessed using the "* notation. Also see 1310 |gui-clipboard|. 1311 1312 autoselect Works like the 'a' flag in 'guioptions': If present, 1313 then whenever Visual mode is started, or the Visual 1314 area extended, Vim tries to become the owner of the 1315 windowing system's global selection or put the 1316 selected text on the clipboard used by the selection 1317 register "*. See |guioptions_a| and |quotestar| for 1318 details. When the GUI is active, the 'a' flag in 1319 'guioptions' is used, when the GUI is not active, this 1320 "autoselect" flag is used. 1321 Also applies to the modeless selection. 1322 1323 autoselectml Like "autoselect", but for the modeless selection 1324 only. Compare to the 'A' flag in 'guioptions'. 1325 1326 exclude:{pattern} 1327 Defines a pattern that is matched against the name of 1328 the terminal 'term'. If there is a match, no 1329 connection will be made to the X server. This is 1330 useful in this situation: 1331 - Running Vim in a console. 1332 - $DISPLAY is set to start applications on another 1333 display. 1334 - You do not want to connect to the X server in the 1335 console, but do want this in a terminal emulator. 1336 To never connect to the X server use: > 1337 exclude:.* 1338< This has the same effect as using the |-X| argument. 1339 Note that when there is no connection to the X server 1340 the window title won't be restored and the clipboard 1341 cannot be accessed. 1342 The value of 'magic' is ignored, {pattern} is 1343 interpreted as if 'magic' was on. 1344 The rest of the option value will be used for 1345 {pattern}, this must be the last entry. 1346 1347 *'cmdheight'* *'ch'* 1348'cmdheight' 'ch' number (default 1) 1349 global 1350 {not in Vi} 1351 Number of screen lines to use for the command-line. Helps avoiding 1352 |hit-enter| prompts. 1353 1354 *'cmdwinheight'* *'cwh'* 1355'cmdwinheight' 'cwh' number (default 7) 1356 global 1357 {not in Vi} 1358 {not available when compiled without the |+vertsplit| 1359 feature} 1360 Number of screen lines to use for the command-line window. |cmdwin| 1361 1362 *'columns'* *'co'* *E594* 1363'columns' 'co' number (default 80 or terminal width) 1364 global 1365 {not in Vi} 1366 Number of columns of the screen. Normally this is set by the terminal 1367 initialization and does not have to be set by hand. 1368 When Vim is running in the GUI or in a resizable window, setting this 1369 option will cause the window size to be changed. When you only want 1370 to use the size for the GUI, put the command in your |gvimrc| file. 1371 When you set this option and Vim is unable to change the physical 1372 number of columns of the display, the display may be messed up. 1373 1374 *'comments'* *'com'* *E524* *E525* 1375'comments' 'com' string (default 1376 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") 1377 local to buffer 1378 {not in Vi} 1379 {not available when compiled without the |+comments| 1380 feature} 1381 A comma separated list of strings that can start a comment line. See 1382 |format-comments|. See |option-backslash| about using backslashes to 1383 insert a space. 1384 1385 *'commentstring'* *'cms'* *E537* 1386'commentstring' 'cms' string (default "/*%s*/") 1387 local to buffer 1388 {not in Vi} 1389 {not available when compiled without the |+folding| 1390 feature} 1391 A template for a comment. The "%s" in the value is replaced with the 1392 comment text. Currently only used to add markers for folding, see 1393 |fold-marker|. 1394 1395 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* 1396'compatible' 'cp' boolean (default on, off when a .vimrc file is found) 1397 global 1398 {not in Vi} 1399 This option has the effect of making Vim either more Vi-compatible, or 1400 make Vim behave in a more useful way. 1401 This is a special kind of option, because when it's set or reset, 1402 other options are also changed as a side effect. CAREFUL: Setting or 1403 resetting this option can have a lot of unexpected effects: Mappings 1404 are interpreted in another way, undo behaves differently, etc. If you 1405 set this option in your vimrc file, you should probably put it at the 1406 very start. 1407 By default this option is on and the Vi defaults are used for the 1408 options. This default was chosen for those people who want to use Vim 1409 just like Vi, and don't even (want to) know about the 'compatible' 1410 option. 1411 When a ".vimrc" file is found while Vim is starting up, this option is 1412 switched off, and all options that have not been modified will be set 1413 to the Vim defaults. Effectively, this means that when a ".vimrc" 1414 file exists, Vim will use the Vim defaults, otherwise it will use the 1415 Vi defaults. (Note: This doesn't happen for the system-wide vimrc 1416 file). Also see |compatible-default|. 1417 You can also set this option with the "-C" argument, and reset it with 1418 "-N". See |-C| and |-N|. 1419 Switching this option off makes the Vim defaults be used for options 1420 that have a different Vi and Vim default value. See the options 1421 marked with a '+' below. Other options are not modified. 1422 At the moment this option is set, several other options will be set 1423 or reset to make Vim as Vi-compatible as possible. See the table 1424 below. This can be used if you want to revert to Vi compatible 1425 editing. 1426 See also 'cpoptions'. 1427 1428 option + set value effect ~ 1429 1430 'allowrevins' off no CTRL-_ command 1431 'backupcopy' Unix: "yes" backup file is a copy 1432 others: "auto" copy or rename backup file 1433 'backspace' "" normal backspace 1434 'backup' off no backup file 1435 'cindent' off no C code indentation 1436 'cedit' + "" no key to open the |cmdwin| 1437 'cpoptions' + (all flags) Vi-compatible flags 1438 'cscopetag' off don't use cscope for ":tag" 1439 'cscopetagorder' 0 see |cscopetagorder| 1440 'cscopeverbose' off see |cscopeverbose| 1441 'digraph' off no digraphs 1442 'esckeys' + off no <Esc>-keys in Insert mode 1443 'expandtab' off tabs not expanded to spaces 1444 'fileformats' + "" no automatic file format detection, 1445 "dos,unix" except for DOS, Windows and OS/2 1446 'formatoptions' + "vt" Vi compatible formatting 1447 'gdefault' off no default 'g' flag for ":s" 1448 'history' + 0 no commandline history 1449 'hkmap' off no Hebrew keyboard mapping 1450 'hkmapp' off no phonetic Hebrew keyboard mapping 1451 'hlsearch' off no highlighting of search matches 1452 'incsearch' off no incremental searching 1453 'indentexpr' "" no indenting by expression 1454 'insertmode' off do not start in Insert mode 1455 'iskeyword' + "@,48-57,_" keywords contain alphanumeric 1456 characters and '_' 1457 'joinspaces' on insert 2 spaces after period 1458 'modeline' + off no modelines 1459 'more' + off no pauses in listings 1460 'revins' off no reverse insert 1461 'ruler' off no ruler 1462 'scrolljump' 1 no jump scroll 1463 'scrolloff' 0 no scroll offset 1464 'shiftround' off indent not rounded to shiftwidth 1465 'shortmess' + "" no shortening of messages 1466 'showcmd' + off command characters not shown 1467 'showmode' + off current mode not shown 1468 'smartcase' off no automatic ignore case switch 1469 'smartindent' off no smart indentation 1470 'smarttab' off no smart tab size 1471 'softtabstop' 0 tabs are always 'tabstop' positions 1472 'startofline' on goto startofline with some commands 1473 'tagrelative' + off tag file names are not relative 1474 'textauto' + off no automatic textmode detection 1475 'textwidth' 0 no automatic line wrap 1476 'tildeop' off tilde is not an operator 1477 'ttimeout' off no terminal timeout 1478 'whichwrap' + "" left-right movements don't wrap 1479 'wildchar' + CTRL-E only when the current value is <Tab> 1480 use CTRL-E for cmdline completion 1481 'writebackup' on or off depends on +writebackup feature 1482 1483 *'complete'* *'cpt'* *E535* 1484'complete' 'cpt' string (default: ".,w,b,u,t,i") 1485 local to buffer 1486 {not in Vi} 1487 This option specifies how keyword completion |ins-completion| works 1488 when CTRL-P or CTRL-N are used. It is also used for whole-line 1489 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion 1490 and the places to scan. It is a comma separated list of flags: 1491 . scan the current buffer ('wrapscan' is ignored) 1492 w scan buffers from other windows 1493 b scan other loaded buffers that are in the buffer list 1494 u scan the unloaded buffers that are in the buffer list 1495 U scan the buffers that are not in the buffer list 1496 k scan the files given with the 'dictionary' option 1497 k{dict} scan the file {dict}. Several "k" flags can be given, 1498 patterns are valid too. For example: > 1499 :set cpt=k/usr/dict/*,k~/spanish 1500< s scan the files given with the 'thesaurus' option 1501 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns 1502 are valid too. 1503 i scan current and included files 1504 d scan current and included files for defined name or macro 1505 |i_CTRL-X_CTRL-D| 1506 ] tag completion 1507 t same as "]" 1508 1509 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are 1510 not executed, this may lead to unexpected completions from some files 1511 (gzipped files for example). Unloaded buffers are not scanned for 1512 whole-line completion. 1513 1514 The default is ".,w,b,u,t,i", which means to scan: 1515 1. the current buffer 1516 2. buffers in other windows 1517 3. other loaded buffers 1518 4. unloaded buffers 1519 5. tags 1520 6. included files 1521 1522 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- 1523 based expansion (eg dictionary |i_CTRL-X_CTRL-K|, included patterns 1524 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions) 1525 1526 *'completefunc'* *'cfu'* 1527'completefunc' 'cfu' string (default: empty) 1528 local to buffer 1529 {not in Vi} 1530 This option specifies a completion function to be used for CTRL-X 1531 CTRL-X. The function will be invoked with four arguments: 1532 a:line the text of the current line 1533 a:base the text with which matches should match 1534 a:col column in a:line where the cursor is, first column is 1535 zero 1536 a:findstart either 1 or 0 1537 When the a:findstart argument is 1, the function must return the 1538 column of where the completion starts. It must be a number between 1539 zero and "a:col". This involves looking at the characters in a:line 1540 before column a:col and include those characters that could be part of 1541 the completed item. 1542 When the a:findstart argument is 0 the function must return a string 1543 with the matching words, separated by newlines. When there are no 1544 matches return an empty string. 1545 An example that completes the names of the months: > 1546 fun! CompleteMonths(line, base, col, findstart) 1547 if a:findstart 1548 " locate start column of word 1549 let start = a:col 1550 while start > 0 && a:line[start - 1] =~ '\a' 1551 let start = start - 1 1552 endwhile 1553 return start 1554 else 1555 " find months matching with "a:base" 1556 let res = "Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec" 1557 if a:base != '' 1558 let res = substitute(res, '\c\<\(\(' . a:base . '.\{-}\>\)\|.\{-}\>\)', '\2', 'g') 1559 endif 1560 let res = substitute(res, ' \+', "\n", 'g') 1561 return res 1562 endif 1563 endfun 1564 set completefunc=CompleteMonths 1565< Note that a substitute() function is used to reduce the list of 1566 possible values and remove the ones that don't match the base. The 1567 part before the "\|" matches the base, the part after it is used 1568 when there is no match. The "\2" in the replacement is empty if the 1569 part before the "\|" does not match. 1570 1571 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* 1572'confirm' 'cf' boolean (default off) 1573 global 1574 {not in Vi} 1575 When 'confirm' is on, certain operations that would normally 1576 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", 1577 instead raise a |dialog| asking if you wish to save the current 1578 file(s). You can still use a ! to unconditionally |abandon| a buffer. 1579 If 'confirm' is off you can still activate confirmation for one 1580 command only (this is most useful in mappings) with the |:confirm| 1581 command. 1582 Also see the |confirm()| function and the 'v' flag in 'guioptions'. 1583 1584 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* 1585'conskey' 'consk' boolean (default off) 1586 global 1587 {not in Vi} {only for MS-DOS} 1588 When on direct console I/O is used to obtain a keyboard character. 1589 This should work in most cases. Also see |'bioskey'|. Together, 1590 three methods of console input are available: 1591 'conskey' 'bioskey' action ~ 1592 on on or off direct console input 1593 off on BIOS 1594 off off STDIN 1595 1596 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* 1597'copyindent' 'ci' boolean (default off) 1598 local to buffer 1599 {not in Vi} 1600 Copy the structure of the existing lines indent when autoindenting a 1601 new line. Normally the new indent is reconstructed by a series of 1602 tabs followed by spaces as required (unless |'expandtab'| is enabled, 1603 in which case only spaces are used). Enabling this option makes the 1604 new line copy whatever characters were used for indenting on the 1605 existing line. If the new indent is greater than on the existing 1606 line, the remaining space is filled in the normal manner. 1607 NOTE: 'copyindent' is reset when 'compatible' is set. 1608 Also see 'preserveindent'. 1609 1610 *'cpoptions'* *'cpo'* 1611'cpoptions' 'cpo' string (Vim default: "aABceFs", 1612 Vi default: all flags) 1613 global 1614 {not in Vi} 1615 A sequence of single character flags. When a character is present 1616 this indicates vi-compatible behavior. This is used for things where 1617 not being vi-compatible is mostly or sometimes preferred. 1618 'cpoptions' stands for "compatible-options". 1619 Commas can be added for readability. 1620 To avoid problems with flags that are added in the future, use the 1621 "+=" and "-=" feature of ":set" |add-option-flags|. 1622 NOTE: This option is set to the Vi default value when 'compatible' is 1623 set and to the Vim default value when 'compatible' is reset. 1624 1625 contains behavior ~ 1626 *cpo-a* 1627 a When included, a ":read" command with a file name 1628 argument will set the alternate file name for the 1629 current window. 1630 *cpo-A* 1631 A When included, a ":write" command with a file name 1632 argument will set the alternate file name for the 1633 current window. 1634 *cpo-b* 1635 b "\|" in a ":map" command is recognized as the end of 1636 the map command. The '\' is included in the mapping, 1637 the text after the '|' is interpreted as the next 1638 command. Use a CTRL-V instead of a backslash to 1639 include the '|' in the mapping. Applies to all 1640 mapping, abbreviation, menu and autocmd commands. 1641 See also |map_bar|. 1642 *cpo-B* 1643 B A backslash has no special meaning in mappings, 1644 abbreviations and the "to" part of the menu commands. 1645 Remove this flag to be able to use a backslash like a 1646 CTRL-V. For example, the command ":map X \<Esc>" 1647 results in X being mapped to: 1648 'B' included: "\^[" (^[ is a real <Esc>) 1649 'B' excluded: "<Esc>" (5 characters) 1650 ('<' excluded in both cases) 1651 *cpo-c* 1652 c Searching continues at the end of any match at the 1653 cursor position, but not further than the start of the 1654 next line. When not present searching continues 1655 one character from the cursor position. With 'c' 1656 "abababababab" only gets three matches when repeating 1657 "/abab", without 'c' there are five matches. 1658 *cpo-C* 1659 C Do not concatenate sourced lines that start with a 1660 backslash. See |line-continuation|. 1661 *cpo-d* 1662 d Using "./" in the 'tags' option doesn't mean to use 1663 the tags file relative to the current file, but the 1664 tags file in the current directory. 1665 *cpo-D* 1666 D Can't use CTRL-K to enter a digraph after Normal mode 1667 commands with a character argument, like |r|, |f| and 1668 |t|. 1669 *cpo-e* 1670 e When executing a register with ":@r", always add a 1671 <CR> to the last line, also when the register is not 1672 linewise. If this flag is not present, the register 1673 is not linewise and the last line does not end in a 1674 <CR>, then the last line is put on the command-line 1675 and can be edited before hitting <CR>. 1676 *cpo-E* 1677 E It is an error when using "y", "d", "c", "g~", "gu" or 1678 "gU" on an Empty region. The operators only work when 1679 at least one character is to be operate on. Example: 1680 This makes "y0" fail in the first column. 1681 *cpo-f* 1682 f When included, a ":read" command with a file name 1683 argument will set the file name for the current buffer, 1684 if the current buffer doesn't have a file name yet. 1685 *cpo-F* 1686 F When included, a ":write" command with a file name 1687 argument will set the file name for the current 1688 buffer, if the current buffer doesn't have a file name 1689 yet. 1690 *cpo-g* 1691 g Goto line 1 when using ":edit" without argument. 1692 *cpo-i* 1693 i When included, interrupting the reading of a file will 1694 leave it modified. 1695 *cpo-I* 1696 I When moving the cursor up or down just after inserting 1697 indent for 'autoindent', do not delete the indent. 1698 *cpo-j* 1699 j When joining lines, only add two spaces after a '.', 1700 not after '!' or '?'. Also see 'joinspaces'. 1701 *cpo-J* 1702 J A |sentence| has to be followed by two spaces after 1703 the '.', '!' or '?'. A <Tab> is not recognized as 1704 white space. 1705 *cpo-k* 1706 k Disable the recognition of raw key codes in 1707 mappings, abbreviations, and the "to" part of menu 1708 commands. For example, if <Key> sends ^[OA (where ^[ 1709 is <Esc>), the command ":map X ^[OA" results in X 1710 being mapped to: 1711 'k' included: "^[OA" (3 characters) 1712 'k' excluded: "<Key>" (one key code) 1713 Also see the '<' flag below. 1714 *cpo-K* 1715 K Don't wait for a key code to complete when it is 1716 halfway a mapping. This breaks mapping <F1><F1> when 1717 only part of the second <F1> has been read. It 1718 enables cancelling the mapping by typing <F1><Esc>. 1719 *cpo-l* 1720 l Backslash in a [] range in a search pattern is taken 1721 literally, only "\]" is special See |/[]| 1722 'l' included: "/[ \t]" finds <Space>, '\' and 't' 1723 'l' excluded: "/[ \t]" finds <Space> and <Tab> 1724 *cpo-L* 1725 L When the 'list' option is set, 'wrapmargin', 1726 'textwidth', 'softtabstop' and Virtual Replace mode 1727 (see |gR|) count a <Tab> as two characters, instead of 1728 the normal behavior of a <Tab>. 1729 *cpo-m* 1730 m When included, a showmatch will always wait half a 1731 second. When not included, a showmatch will wait half 1732 a second or until a character is typed. |'showmatch'| 1733 *cpo-M* 1734 M When excluded, "%" matching will take backslashes into 1735 account. Thus in "( \( )" and "\( ( \)" the outer 1736 parenthesis match. When included "%" ignores 1737 backslashes, which is Vi compatible. 1738 *cpo-n* 1739 n When included, the column used for 'number' will also 1740 be used for text of wrapped lines. 1741 *cpo-o* 1742 o Line offset to search command is not remembered for 1743 next search. 1744 *cpo-O* 1745 O Don't complain if a file is being overwritten, even 1746 when it didn't exist when editing it. This is a 1747 protection against a file unexpectedly created by 1748 someone else. Vi didn't complain about this. 1749 *cpo-p* 1750 p Vi compatible Lisp indenting. When not present, a 1751 slightly better algorithm is used. 1752 *cpo-r* 1753 r Redo ("." command) uses "/" to repeat a search 1754 command, instead of the actually used search string. 1755 *cpo-R* 1756 R Remove marks from filtered lines. Without this flag 1757 marks are kept like |:keepmarks| was used. 1758 *cpo-s* 1759 s Set buffer options when entering the buffer for the 1760 first time. This is like it is in Vim version 3.0. 1761 And it is the default. If not present the options are 1762 set when the buffer is created. 1763 *cpo-S* 1764 S Set buffer options always when entering a buffer 1765 (except 'readonly', 'fileformat', 'filetype' and 1766 'syntax'). This is the (most) Vi compatible setting. 1767 The options are set to the values in the current 1768 buffer. When you change an option and go to another 1769 buffer, the value is copied. Effectively makes the 1770 buffer options global to all buffers. 1771 1772 's' 'S' copy buffer options 1773 no no when buffer created 1774 yes no when buffer first entered (default) 1775 X yes each time when buffer entered (vi comp.) 1776 *cpo-t* 1777 t Search pattern for the tag command is remembered for 1778 "n" command. Otherwise Vim only puts the pattern in 1779 the history for search pattern, but doesn't change the 1780 last used search pattern. 1781 *cpo-u* 1782 u Undo is Vi compatible. See |undo-two-ways|. 1783 *cpo-v* 1784 v Backspaced characters remain visible on the screen in 1785 Insert mode. Without this flag the characters are 1786 erased from the screen right away. With this flag the 1787 screen newly typed text overwrites backspaced 1788 characters. 1789 *cpo-w* 1790 w When using "cw" on a blank character, only change one 1791 character and not all blanks until the start of the 1792 next word. 1793 *cpo-W* 1794 W Don't overwrite a readonly file. When omitted, ":w!" 1795 overwrites a readonly file, if possible. 1796 *cpo-x* 1797 x <Esc> on the command-line executes the command-line. 1798 The default in Vim is to abandon the command-line, 1799 because <Esc> normally aborts a command. |c_<Esc>| 1800 *cpo-y* 1801 y A yank command can be redone with ".". 1802 *cpo-!* 1803 ! When redoing a filter command, use the last used 1804 external command, whatever it was. Otherwise the last 1805 used -filter- command is used. 1806 *cpo-$* 1807 $ When making a change to one line, don't redisplay the 1808 line, but put a '$' at the end of the changed text. 1809 The changed text will be overwritten when you type the 1810 new text. The line is redisplayed if you type any 1811 command that moves the cursor from the insertion 1812 point. 1813 *cpo-%* 1814 % Vi-compatible matching is done for the "%" command. 1815 Does not recognize "#if", "#endif", etc. 1816 Does not recognize "/*" and "*/". 1817 Parens inside single and double quotes are also 1818 counted, causing a string that contains a paren to 1819 disturb the matching. For example, in a line like 1820 "if (strcmp("foo(", s))" the first paren does not 1821 match the last one. When this flag is not included, 1822 parens inside single and double quotes are treated 1823 specially. When matching a paren outside of quotes, 1824 everything inside quotes is ignored. When matching a 1825 paren inside quotes, it will find the matching one (if 1826 there is one). This works very well for C programs. 1827 *cpo-star* 1828 * Use ":*" in the same way as ":@". When not included, 1829 ":*" is an alias for ":'<,'>", select the Visual area. 1830 *cpo-<* 1831 < Disable the recognition of special key codes in |<>| 1832 form in mappings, abbreviations, and the "to" part of 1833 menu commands. For example, the command 1834 ":map X <Tab>" results in X being mapped to: 1835 '<' included: "<Tab>" (5 characters) 1836 '<' excluded: "^I" (^I is a real <Tab>) 1837 Also see the 'k' flag above. 1838 1839 *'cscopepathcomp'* *'cspc'* 1840'cscopepathcomp' 'cspc' number (default 0) 1841 global 1842 {not available when compiled without the |+cscope| 1843 feature} 1844 {not in Vi} 1845 Determines how many components of the path to show in a list of tags. 1846 See |cscopepathcomp|. 1847 1848 *'cscopeprg'* *'csprg'* 1849'cscopeprg' 'csprg' string (default "cscope") 1850 global 1851 {not available when compiled without the |+cscope| 1852 feature} 1853 {not in Vi} 1854 Specifies the command to execute cscope. See |cscopeprg|. 1855 This option cannot be set from a |modeline| or in the |sandbox|, for 1856 security reasons. 1857 1858 *'cscopequickfix'* *'csqf'* 1859'cscopequickfix' 'csqf' string (default "") 1860 global 1861 {not available when compiled without the |+cscope| 1862 or |+quickfix| features} 1863 {not in Vi} 1864 Specifies whether to use quickfix window to show cscope results. 1865 See |cscopequickfix|. 1866 1867 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* 1868'cscopetag' 'cst' boolean (default off) 1869 global 1870 {not available when compiled without the |+cscope| 1871 feature} 1872 {not in Vi} 1873 Use cscope for tag commands. See |cscope-options|. 1874 NOTE: This option is reset when 'compatible' is set. 1875 1876 *'cscopetagorder'* *'csto'* 1877'cscopetagorder' 'csto' number (default 0) 1878 global 1879 {not available when compiled without the |+cscope| 1880 feature} 1881 {not in Vi} 1882 Determines the order in which ":cstag" performs a search. See 1883 |cscopetagorder|. 1884 NOTE: This option is set to 0 when 'compatible' is set. 1885 1886 *'cscopeverbose'* *'csverb'* 1887 *'nocscopeverbose'* *'nocsverb'* 1888'cscopeverbose' 'csverb' boolean (default off) 1889 global 1890 {not available when compiled without the |+cscope| 1891 feature} 1892 {not in Vi} 1893 Give messages when adding a cscope database. See |cscopeverbose|. 1894 NOTE: This option is reset when 'compatible' is set. 1895 1896 *'debug'* 1897'debug' string (default "") 1898 global 1899 {not in Vi} 1900 When set to "msg", error messages that would otherwise be omitted will 1901 be given anyway. This is useful when debugging 'foldexpr' or 1902 'indentexpr'. 1903 1904 *'define'* *'def'* 1905'define' 'def' string (default "^\s*#\s*define") 1906 global or local to buffer |global-local| 1907 {not in Vi} 1908 Pattern to be used to find a macro definition. It is a search 1909 pattern, just like for the "/" command. This option is used for the 1910 commands like "[i" and "[d" |include-search|. The 'isident' option is 1911 used to recognize the defined name after the match: 1912 {match with 'define'}{non-ID chars}{defined name}{non-ID char} 1913 See |option-backslash| about inserting backslashes to include a space 1914 or backslash. 1915 The default value is for C programs. For C++ this value would be 1916 useful, to include const type declarations: > 1917 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) 1918< When using the ":set" command, you need to double the backslashes! 1919 1920 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* 1921'delcombine' 'deco' boolean (default off) 1922 global 1923 {not in Vi} 1924 {only available when compiled with the |+multi_byte| 1925 feature} 1926 If editing Unicode and this option is set, backspace and Normal mode 1927 "x" delete each combining character on its own. When it is off (the 1928 default) the character along with its combining characters are 1929 deleted. 1930 Note: When 'delcombine' is set "xx" may work different from "2x"! 1931 1932 This is useful for Arabic, Hebrew and many other languages where one 1933 may have combining characters overtop of base characters, and want 1934 to remove only the combining ones. 1935 1936 *'dictionary'* *'dict'* 1937'dictionary' 'dict' string (default "") 1938 global or local to buffer |global-local| 1939 {not in Vi} 1940 List of file names, separated by commas, that are used to lookup words 1941 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should 1942 contain a list of words. This can be one word per line, or several 1943 words per line, separated by non-keyword characters (white space is 1944 preferred). Maximum line length is 510 bytes. 1945 To include a comma in a file name precede it with a backslash. Spaces 1946 after a comma are ignored, otherwise spaces are included in the file 1947 name. See |option-backslash| about using backslashes. 1948 Where to find a list of words? 1949 - On FreeBSD, there is the file "/usr/share/dict/words". 1950 - In the Simtel archive, look in the "msdos/linguist" directory. 1951 - In "miscfiles" of the GNU collection. 1952 The use of |:set+=| and |:set-=| is preferred when adding or removing 1953 directories from the list. This avoids problems when a future version 1954 uses another default. 1955 Backticks cannot be used in this option for security reasons. 1956 1957 *'diff'* *'nodiff'* 1958'diff' boolean (default off) 1959 local to window 1960 {not in Vi} 1961 {not available when compiled without the |+diff| 1962 feature} 1963 Join the current window in the group of windows that shows differences 1964 between files. See |vimdiff|. 1965 1966 *'dex'* *'diffexpr'* 1967'diffexpr' 'dex' string (default "") 1968 global 1969 {not in Vi} 1970 {not available when compiled without the |+diff| 1971 feature} 1972 Expression which is evaluated to obtain an ed-style diff file from two 1973 versions of a file. See |diff-diffexpr|. 1974 This option cannot be set from a |modeline| or in the |sandbox|, for 1975 security reasons. 1976 1977 *'dip'* *'diffopt'* 1978'diffopt' 'dip' string (default "filler") 1979 global 1980 {not in Vi} 1981 {not available when compiled without the |+diff| 1982 feature} 1983 Option settings for diff mode. It can consist of the following items. 1984 All are optional. Items must be separated by a comma. 1985 1986 filler Show filler lines, to keep the text 1987 synchronized with a window that has inserted 1988 lines at the same position. Mostly useful 1989 when windows are side-by-side and 'scrollbind' 1990 is set. 1991 1992 context:{n} Use a context of {n} lines between a change 1993 and a fold that contains unchanged lines. 1994 When omitted a context of six lines is used. 1995 See |fold-diff|. 1996 1997 icase Ignore changes in case of text. "a" and "A" 1998 are considered the same. Adds the "-i" flag 1999 to the "diff" command if 'diffexpr' is empty. 2000 2001 iwhite Ignore changes in amount of white space. Adds 2002 the "-b" flag to the "diff" command if 2003 'diffexpr' is empty. Check the documentation 2004 of the "diff" command for what this does 2005 exactly. It should ignore adding trailing 2006 white space, but not leading white space. 2007 2008 Examples: > 2009 2010 :set diffopt=filler,context:4 2011 :set diffopt= 2012 :set diffopt=filler 2013< 2014 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* 2015'digraph' 'dg' boolean (default off) 2016 global 2017 {not in Vi} 2018 {not available when compiled without the |+digraphs| 2019 feature} 2020 Enable the entering of digraphs in Insert mode with {char1} <BS> 2021 {char2}. See |digraphs|. 2022 NOTE: This option is reset when 'compatible' is set. 2023 2024 *'directory'* *'dir'* 2025'directory' 'dir' string (default for Amiga: ".,t:", 2026 for MS-DOS and Win32: ".,c:\tmp,c:\temp" 2027 for Unix: ".,~/tmp,/var/tmp,/tmp") 2028 global 2029 List of directory names for the swap file, separated with commas. 2030 - The swap file will be created in the first directory where this is 2031 possible. 2032 - Empty means that no swap file will be used (recovery is 2033 impossible!). 2034 - A directory "." means to put the swap file in the same directory as 2035 the edited file. On Unix, a dot is prepended to the file name, so 2036 it doesn't show in a directory listing. On MS-Windows the "hidden" 2037 attribute is set and a dot prepended if possible. 2038 - A directory starting with "./" (or ".\" for MS-DOS et.al.) means to 2039 put the swap file relative to where the edited file is. The leading 2040 "." is replaced with the path name of the edited file. 2041 - For Unix and Win32, if a directory ends in two path separators, the 2042 swap file name will be built from the complete path to the file 2043 with all path separators substituted to percent '%' signs. This will 2044 ensure file name uniqueness in the preserve directory. 2045 - Spaces after the comma are ignored, other spaces are considered part 2046 of the directory name. To have a space at the start of a directory 2047 name, precede it with a backslash. 2048 - To include a comma in a directory name precede it with a backslash. 2049 - A directory name may end in an ':' or '/'. 2050 - Environment variables are expanded |:set_env|. 2051 - Careful with '\' characters, type one before a space, type two to 2052 get one in the option (see |option-backslash|), for example: > 2053 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces 2054< - For backwards compatibility with Vim version 3.0 a '>' at the start 2055 of the option is removed. 2056 Using "." first in the list is recommended. This means that editing 2057 the same file twice will result in a warning. Using "/tmp" on Unix is 2058 discouraged: When the system crashes you lose the swap file. 2059 "/var/tmp" is often not cleared when rebooting, thus is a better 2060 choice than "/tmp". But it can contain a lot of files, your swap 2061 files get lost in the crowd. That is why a "tmp" directory in your 2062 home directory is tried first. 2063 The use of |:set+=| and |:set-=| is preferred when adding or removing 2064 directories from the list. This avoids problems when a future version 2065 uses another default. 2066 This option cannot be set from a |modeline| or in the |sandbox|, for 2067 security reasons. 2068 {Vi: directory to put temp file in, defaults to "/tmp"} 2069 2070 *'display'* *'dy'* 2071'display' 'dy' string (default "") 2072 global 2073 {not in Vi} 2074 Change the way text is displayed. This is comma separated list of 2075 flags: 2076 lastline When included, as much as possible of the last line 2077 in a window will be displayed. When not included, a 2078 last line that doesn't fit is replaced with "@" lines. 2079 uhex Show unprintable characters hexadecimal as <xx> 2080 instead of using ^C and ~C. 2081 2082 *'eadirection'* *'ead'* 2083'eadirection' 'ead' string (default "both") 2084 global 2085 {not in Vi} 2086 {not available when compiled without the +vertsplit 2087 feature} 2088 Tells when the 'equalalways' option applies: 2089 ver vertically, width of windows is not affected 2090 hor horizontally, height of windows is not affected 2091 both width and height of windows is affected 2092 2093 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* 2094'edcompatible' 'ed' boolean (default off) 2095 global 2096 Makes the 'g' and 'c' flags of the ":substitute" command to be 2097 toggled each time the flag is given. See |complex-change|. See 2098 also 'gdefault' option. 2099 Switching this option on is discouraged! 2100 2101 *'encoding'* *'enc'* *E543* 2102'encoding' 'enc' string (default: "latin1" or value from $LANG) 2103 global 2104 {only available when compiled with the |+multi_byte| 2105 feature} 2106 {not in Vi} 2107 Sets the character encoding used inside Vim. It applies to text in 2108 the buffers, registers, Strings in expressions, text stored in the 2109 viminfo file, etc. It sets the kind of characters which Vim can work 2110 with. See |encoding-names| for the possible values. 2111 2112 NOTE: Changing this option will not change the encoding of the 2113 existing text in Vim. It may cause multi-byte text to become invalid. 2114 It should normally be kept at its default value, or set when Vim 2115 starts up. See |multibyte|. 2116 2117 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to 2118 "utf-8". Although care has been taken to allow different values of 2119 'encoding', "utf-8" is the natural choice for the environment and 2120 avoids unnecessary conversion overhead. "utf-8" has not been made 2121 the default to prevent different behavior of the GUI and terminal 2122 versions, and to avoid changing the encoding of newly created files 2123 without your knowledge (in case 'fileencodings' is empty). 2124 2125 The character encoding of files can be different from 'encoding'. 2126 This is specified with 'fileencoding'. The conversion is done with 2127 iconv() or as specified with 'charconvert'. 2128 2129 Normally 'encoding' will be equal to your current locale. This will 2130 be the default if Vim recognizes your environment settings. If 2131 'encoding' is not set to the current locale, 'termencoding' must be 2132 set to convert typed and displayed text. See |encoding-table|. 2133 2134 When you set this option, it fires the |EncodingChanged| autocommand 2135 event so that you can set up fonts if necessary. 2136 2137 When the option is set, the value is converted to lowercase. Thus 2138 you can set it with uppercase values too. Underscores are translated 2139 to '-' signs. 2140 When the encoding is recognized, it is changed to the standard name. 2141 For example "Latin-1" becomes "latin1", "ISO_88592" becomes 2142 "iso-8859-2" and "utf8" becomes "utf-8". 2143 2144 Note: "latin1" is also used when the encoding could not be detected. 2145 This only works when editing files in the same encoding! When the 2146 actual character set is not latin1, make sure 'fileencoding' and 2147 'fileencodings' are empty. When conversion is needed, switch to using 2148 utf-8. 2149 2150 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. 2151 You don't notice this while editing, but it does matter for the 2152 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus 2153 setting 'encoding' to one of these values instead of utf-8 only has 2154 effect for encoding used for files when 'fileencoding' is empty. 2155 2156 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was 2157 not set yet, the default for 'fileencodings' is changed. 2158 2159 *'endofline'* *'eol'* *'noendofline'* *'noeol'* 2160'endofline' 'eol' boolean (default on) 2161 local to buffer 2162 {not in Vi} 2163 When writing a file and this option is off and the 'binary' option 2164 is on, no <EOL> will be written for the last line in the file. This 2165 option is automatically set when starting to edit a new file, unless 2166 the file does not have an <EOL> for the last line in the file, in 2167 which case it is reset. Normally you don't have to set or reset this 2168 option. When 'binary' is off the value is not used when writing the 2169 file. When 'binary' is on it is used to remember the presence of a 2170 <EOL> for the last line in the file, so that when you write the file 2171 the situation from the original file can be kept. But you can change 2172 it if you want to. 2173 2174 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* 2175'equalalways' 'ea' boolean (default on) 2176 global 2177 {not in Vi} 2178 When on, all the windows are automatically made the same size after 2179 splitting or closing a window. When off, splitting a window will 2180 reduce the size of the current window and leave the other windows the 2181 same. When closing a window the extra lines are given to the window 2182 next to it (depending on 'splitbelow' and 'splitright'). 2183 When mixing vertically and horizontally split windows, a minimal size 2184 is computed and some windows may be larger if there is room. The 2185 'eadirection' option tells in which direction the size is affected. 2186 Changing the height of a window can be avoided by setting 2187 'winfixheight'. 2188 2189 *'equalprg'* *'ep'* 2190'equalprg' 'ep' string (default "") 2191 global or local to buffer |global-local| 2192 {not in Vi} 2193 External program to use for "=" command. When this option is empty 2194 the internal formatting functions are used ('lisp', 'cindent' or 2195 'indentexpr'). 2196 Environment variables are expanded |:set_env|. See |option-backslash| 2197 about including spaces and backslashes. 2198 This option cannot be set from a |modeline| or in the |sandbox|, for 2199 security reasons. 2200 2201 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* 2202'errorbells' 'eb' boolean (default off) 2203 global 2204 Ring the bell (beep or screen flash) for error messages. This only 2205 makes a difference for error messages, the bell will be used always 2206 for a lot of errors without a message (e.g., hitting <Esc> in Normal 2207 mode). See 'visualbell' on how to make the bell behave like a beep, 2208 screen flash or do nothing. 2209 2210 *'errorfile'* *'ef'* 2211'errorfile' 'ef' string (Amiga default: "AztecC.Err", 2212 others: "errors.err") 2213 global 2214 {not in Vi} 2215 {not available when compiled without the |+quickfix| 2216 feature} 2217 Name of the errorfile for the QuickFix mode (see |:cf|). 2218 When the "-q" command-line argument is used, 'errorfile' is set to the 2219 following argument. See |-q|. 2220 NOT used for the ":make" command. See 'makeef' for that. 2221 Environment variables are expanded |:set_env|. 2222 See |option-backslash| about including spaces and backslashes. 2223 This option cannot be set from a |modeline| or in the |sandbox|, for 2224 security reasons. 2225 2226 *'errorformat'* *'efm'* 2227'errorformat' 'efm' string (default is very long) 2228 global or local to buffer |global-local| 2229 {not in Vi} 2230 {not available when compiled without the |+quickfix| 2231 feature} 2232 Scanf-like description of the format for the lines in the error file 2233 (see |errorformat|). 2234 2235 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* 2236'esckeys' 'ek' boolean (Vim default: on, Vi default: off) 2237 global 2238 {not in Vi} 2239 Function keys that start with an <Esc> are recognized in Insert 2240 mode. When this option is off, the cursor and function keys cannot be 2241 used in Insert mode if they start with an <Esc>. The advantage of 2242 this is that the single <Esc> is recognized immediately, instead of 2243 after one second. Instead of resetting this option, you might want to 2244 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that 2245 when 'esckeys' is off, you can still map anything, but the cursor keys 2246 won't work by default. 2247 NOTE: This option is set to the Vi default value when 'compatible' is 2248 set and to the Vim default value when 'compatible' is reset. 2249 2250 *'eventignore'* *'ei'* 2251'eventignore' 'ei' string (default "") 2252 global 2253 {not in Vi} 2254 {not available when compiled without the |+autocmd| 2255 feature} 2256 A list of autocommand event names, which are to be ignored. 2257 When set to "all", all autocommand events are ignored, autocommands 2258 will not be executed. 2259 Otherwise this is a comma separated list of event names. Example: > 2260 :set ei=WinEnter,WinLeave 2261< 2262 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* 2263'expandtab' 'et' boolean (default off) 2264 local to buffer 2265 {not in Vi} 2266 In Insert mode: Use the appropriate number of spaces to insert a 2267 <Tab>. Spaces are used in indents with the '>' and '<' commands and 2268 when 'autoindent' is on. To insert a real tab when 'expandtab' is 2269 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. 2270 NOTE: This option is reset when 'compatible' is set. 2271 2272 *'exrc'* *'ex'* *'noexrc'* *'noex'* 2273'exrc' 'ex' boolean (default off) 2274 global 2275 {not in Vi} 2276 Enables the reading of .vimrc, .exrc and .gvimrc in the current 2277 directory. If you switch this option on you should also consider 2278 setting the 'secure' option (see |initialization|). Using a local 2279 .exrc, .vimrc or .gvimrc is a potential security leak, use with care! 2280 also see |.vimrc| and |gui-init|. 2281 This option cannot be set from a |modeline| or in the |sandbox|, for 2282 security reasons. 2283 2284 *'fileencoding'* *'fenc'* *E213* 2285'fileencoding' 'fenc' string (default: "") 2286 local to buffer 2287 {only available when compiled with the |+multi_byte| 2288 feature} 2289 {not in Vi} 2290 Sets the character encoding for the file of this buffer. 2291 When 'fileencoding' is different from 'encoding', conversion will be 2292 done when reading and writing the file. 2293 When 'fileencoding' is empty, the same value as 'encoding' will be 2294 used (no conversion when reading or writing a file). 2295 WARNING: Conversion can cause loss of information! When 2296 'encoding' is "utf-8" conversion is most likely done in a way 2297 that the reverse conversion results in the same text. When 2298 'encoding' is not "utf-8" some characters may be lost! 2299 See 'encoding' for the possible values. Additionally, values may be 2300 specified that can be handled by the converter, see 2301 |mbyte-conversion|. 2302 When reading a file 'fileencoding' will be set from 'fileencodings'. 2303 To read a file in a certain encoding it won't work by setting 2304 'fileencoding', use the |++enc| argument. 2305 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. 2306 When the option is set, the value is converted to lowercase. Thus 2307 you can set it with uppercase values too. '_' characters are 2308 replaced with '-'. If a name is recognized from the list for 2309 'encoding', it is replaced by the standard name. For example 2310 "ISO8859-2" becomes "iso-8859-2". 2311 When this option is set, after starting to edit a file, the 'modified' 2312 option is set, because the file would be different when written. 2313 If you do this in a modeline, you might want to set 'nomodified' to 2314 avoid this. 2315 This option can not be changed when 'modifiable' is off. 2316 2317 *'fe'* 2318 NOTE: Before version 6.0 this option specified the encoding for the 2319 whole of Vim, this was a mistake. Now use 'encoding' instead. The 2320 old short name was 'fe', which is no longer used. 2321 2322 *'fileencodings'* *'fencs'* 2323'fileencodings' 'fencs' string (default: "ucs-bom", "ucs-bom,utf-8,latin1" 2324 when 'encoding' is set to a Unicode value) 2325 global 2326 {only available when compiled with the |+multi_byte| 2327 feature} 2328 {not in Vi} 2329 This is a list of character encodings considered when starting to edit 2330 an existing file. When a file is read, Vim tries to use the first 2331 mentioned character encoding. If an error is detected, the next one 2332 in the list is tried. When an encoding is found that works, 2333 'fileencoding' is set to it. If all fail, 'fileencoding' is set to 2334 an empty string, which means the value of 'encoding' is used. 2335 WARNING: Conversion can cause loss of information! When 2336 'encoding' is "utf-8" (or one of the other Unicode variants) 2337 conversion is most likely done in a way that the reverse 2338 conversion results in the same text. When 'encoding' is not 2339 "utf-8" special characters may be lost! 2340 For an empty file or a file with only ASCII characters most encodings 2341 will work and the first entry of 'fileencodings' will be used (except 2342 "ucs-bom", which requires the BOM to be present). If you prefer 2343 another encoding use an BufReadPost autocommand event to test if your 2344 preferred encoding is to be used. Example: > 2345 au BufReadPost * if search('\S', 'w') == 0 | 2346 \ set fenc=iso-2022-jp | endif 2347< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain 2348 non-blank characters. 2349 Note that 'fileencodings' is not used for an new file, 'fileencoding' 2350 is always empty then. This means that a non-existing file may get a 2351 different encoding than an empty file. 2352 The special value "ucs-bom" can be used to check for a Unicode BOM 2353 (Byte Order Mark) at the start of the file. It must not be preceded 2354 by "utf-8" or another Unicode encoding for this to work properly. 2355 An entry for an 8-bit encoding (e.g., "latin1") should be the last, 2356 because Vim cannot detect an error, thus the encoding is always 2357 accepted. 2358 WRONG VALUES: WHAT'S WRONG: 2359 latin1,utf-8 "latin1" will always be used 2360 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 2361 file 2362 cp1250,latin1 "cp1250" will always be used 2363 If 'fileencodings' is empty, 'fileencoding' is not modified. 2364 See 'fileencoding' for the possible values. 2365 Setting this option does not have an effect until the next time a file 2366 is read. 2367 2368 *'fileformat'* *'ff'* 2369'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", 2370 Unix default: "unix", 2371 Macintosh default: "mac") 2372 local to buffer 2373 {not in Vi} 2374 This gives the <EOL> of the current buffer, which is used for 2375 reading/writing the buffer from/to a file: 2376 dos <CR> <NL> 2377 unix <NL> 2378 mac <CR> 2379 When "dos" is used, CTRL-Z at the end of a file is ignored. 2380 See |file-formats| and |file-read|. 2381 For the character encoding of the file see 'fileencoding'. 2382 When 'binary' is set, the value of 'fileformat' is ignored, file I/O 2383 works like it was set to "unix'. 2384 This option is set automatically when starting to edit a file and 2385 'fileformats' is not empty and 'binary' is off. 2386 When this option is set, after starting to edit a file, the 'modified' 2387 option is set, because the file would be different when written. 2388 This option can not be changed when 'modifiable' is off. 2389 For backwards compatibility: When this option is set to "dos", 2390 'textmode' is set, otherwise 'textmode' is reset. 2391 2392 *'fileformats'* *'ffs'* 2393'fileformats' 'ffs' string (default: 2394 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", 2395 Vim Unix: "unix,dos", 2396 Vim Mac: "mac,unix,dos", 2397 Vi Cygwin: "unix,dos", 2398 Vi others: "") 2399 global 2400 {not in Vi} 2401 This gives the end-of-line (<EOL>) formats that will be tried when 2402 starting to edit a new buffer and when reading a file into an existing 2403 buffer: 2404 - When empty, the format defined with 'fileformat' will be used 2405 always. It is not set automatically. 2406 - When set to one name, that format will be used whenever a new buffer 2407 is opened. 'fileformat' is set accordingly for that buffer. The 2408 'fileformats' name will be used when a file is read into an existing 2409 buffer, no matter what 'fileformat' for that buffer is set to. 2410 - When more than one name is present, separated by commas, automatic 2411 <EOL> detection will be done when reading a file. When starting to 2412 edit a file, a check is done for the <EOL>: 2413 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", 2414 'fileformat' is set to "dos". 2415 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' 2416 is set to "unix". Note that when a <NL> is found without a 2417 preceding <CR>, "unix" is preferred over "dos". 2418 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac". 2419 This means that "mac" is only chosen when "unix" is not present, 2420 or when no <NL> is found in the file, and when "dos" is not 2421 present, or no <CR><NL> is present in the file. 2422 Also if "unix" was first chosen, but the first <CR> is before 2423 the first <NL> and there appears to be more <CR>'s than <NL>'s in 2424 the file, then 'fileformat' is set to "mac". 2425 4. If 'fileformat' is still not set, the first name from 2426 'fileformats' is used. 2427 When reading a file into an existing buffer, the same is done, but 2428 this happens like 'fileformat' has been set appropriately for that 2429 file only, the option is not changed. 2430 When 'binary' is set, the value of 'fileformats' is not used. 2431 2432 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that 2433 are ":source"ed and for vimrc files, automatic <EOL> detection may be 2434 done: 2435 - When 'fileformats' is empty, there is no automatic detection. Dos 2436 format will be used. 2437 - When 'fileformats' is set to one or more names, automatic detection 2438 is done. This is based on the first <NL> in the file: If there is a 2439 <CR> in front of it, Dos format is used, otherwise Unix format is 2440 used. 2441 Also see |file-formats|. 2442 For backwards compatibility: When this option is set to an empty 2443 string or one format (no comma is included), 'textauto' is reset, 2444 otherwise 'textauto' is set. 2445 NOTE: This option is set to the Vi default value when 'compatible' is 2446 set and to the Vim default value when 'compatible' is reset. 2447 2448 *'filetype'* *'ft'* 2449'filetype' 'ft' string (default: "") 2450 local to buffer 2451 {not in Vi} 2452 {not available when compiled without the |+autocmd| 2453 feature} 2454 When this option is set, the FileType autocommand event is triggered. 2455 All autocommands that match with the value of this option will be 2456 executed. Thus the value of 'filetype' is used in place of the file 2457 name. 2458 Otherwise this option does not always reflect the current file type. 2459 This option is normally set when the file type is detected. To enable 2460 this use the ":filetype on" command. |:filetype| 2461 Setting this option to a different value is most useful in a modeline, 2462 for a file for which the file type is not automatically recognized. 2463 Example, for in an IDL file: > 2464 /* vim: set filetype=idl : */ 2465< |FileType| |filetypes| 2466 Do not confuse this option with 'osfiletype', which is for the file 2467 type that is actually stored with the file. 2468 This option is not copied to another buffer, independent of the 's' or 2469 'S' flag in 'cpoptions'. 2470 2471 *'fillchars'* *'fcs'* 2472'fillchars' 'fcs' string (default "vert:|,fold:-") 2473 global 2474 {not in Vi} 2475 {not available when compiled without the |+windows| 2476 and |+folding| features} 2477 Characters to fill the statuslines and vertical separators. 2478 It is a comma separated list of items: 2479 2480 item default Used for ~ 2481 stl:c ' ' or '^' statusline of the current window 2482 stlnc:c ' ' or '-' statusline of the non-current windows 2483 vert:c '|' vertical separators |:vsplit| 2484 fold:c '-' filling 'foldtext' 2485 diff:c '-' deleted lines of the 'diff' option 2486 2487 Any one that is omitted will fall back to the default. For "stl" and 2488 "stlnc" the space will be used when there is highlighting, '^' or '-' 2489 otherwise. 2490 2491 Example: > 2492 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- 2493< This is similar to the default, except that these characters will also 2494 be used when there is highlighting. 2495 2496 The highlighting used for these items: 2497 item highlight group ~ 2498 stl:c StatusLine |hl-StatusLine| 2499 stlnc:c StatusLineNC |hl-StatusLineNC| 2500 vert:c VertSplit |hl-VertSplit| 2501 fold:c Folded |hl-Folded| 2502 diff:c DiffDelete |hl-DiffDelete| 2503 2504 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* 2505'fkmap' 'fk' boolean (default off) *E198* 2506 global 2507 {not in Vi} 2508 {only available when compiled with the |+rightleft| 2509 feature} 2510 When on, the keyboard is mapped for the Farsi character set. 2511 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to 2512 toggle this option |i_CTRL-_|. See |farsi.txt|. 2513 2514 *'foldclose'* *'fcl'* 2515'foldclose' 'fcl' string (default "") 2516 global 2517 {not in Vi} 2518 {not available when compiled without the |+folding| 2519 feature} 2520 When set to "all", a fold is closed when the cursor isn't in it and 2521 its level is higher than 'foldlevel'. Useful if you want folds to 2522 automatically close when moving out of them. 2523 2524 *'foldcolumn'* *'fdc'* 2525'foldcolumn' 'fdc' number (default 0) 2526 local to window 2527 {not in Vi} 2528 {not available when compiled without the |+folding| 2529 feature} 2530 When non-zero, a column with the specified width is shown at the side 2531 of the window which indicates open and closed folds. The maximum 2532 value is 12. 2533 See |folding|. 2534 2535 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* 2536'foldenable' 'fen' boolean (default on) 2537 local to window 2538 {not in Vi} 2539 {not available when compiled without the |+folding| 2540 feature} 2541 When off, all folds are open. This option can be used to quickly 2542 switch between showing all text unfolded and viewing the text with 2543 folds (including manually opened or closed folds). It can be toggled 2544 with the |zi| command. The 'foldcolumn' will remain blank when 2545 'foldenable' is off. 2546 This option is set by commands that create a new fold or close a fold. 2547 See |folding|. 2548 2549 *'foldexpr'* *'fde'* 2550'foldexpr' 'fde' string (default: "0") 2551 local to window 2552 {not in Vi} 2553 {not available when compiled without the |+folding| 2554 or |+eval| feature} 2555 The expression used for when 'foldmethod' is "expr". It is evaluated 2556 for each line to obtain its fold level. See |fold-expr|. Also see 2557 |eval-sandbox|. 2558 2559 *'foldignore'* *'fdi'* 2560'foldignore' 'fdi' string (default: "#") 2561 local to window 2562 {not in Vi} 2563 {not available when compiled without the |+folding| 2564 feature} 2565 Used only when 'foldmethod' is "indent". Lines starting with 2566 characters in 'foldignore' will get their fold level from surrounding 2567 lines. White space is skipped before checking for this character. 2568 The default "#" works well for C programs. See |fold-indent|. 2569 2570 *'foldlevel'* *'fdl'* 2571'foldlevel' 'fdl' number (default: 0) 2572 local to window 2573 {not in Vi} 2574 {not available when compiled without the |+folding| 2575 feature} 2576 Sets the fold level: Folds with a higher level will be closed. 2577 Setting this option to zero will close all folds. Higher numbers will 2578 close fewer folds. 2579 This option is set by commands like |zm|, |zM| and |zR|. 2580 See |fold-foldlevel|. 2581 2582 *'foldlevelstart'* *'fdls'* 2583'foldlevelstart' 'fdls' number (default: -1) 2584 global 2585 {not in Vi} 2586 {not available when compiled without the |+folding| 2587 feature} 2588 Sets 'foldlevel' when starting to edit another buffer in a window. 2589 Useful to always start editing with all folds closed (value zero), 2590 some folds closed (one) or no folds closed (99). 2591 This is done before reading any modeline, thus a setting in a modeline 2592 overrules this option. Starting to edit a file for |diff-mode| also 2593 ignores this option and closes all folds. 2594 It is also done before BufReadPre autocommands, to allow an autocmd to 2595 overrule the 'foldlevel' value for specific files. 2596 When the value is negative, it is not used. 2597 2598 *'foldmarker'* *'fmr'* *E536* 2599'foldmarker' 'fmr' string (default: "{{{,}}}") 2600 local to window 2601 {not in Vi} 2602 {not available when compiled without the |+folding| 2603 feature} 2604 The start and end marker used when 'foldmethod' is "marker". There 2605 must be one comma, which separates the start and end marker. The 2606 marker is a literal string (a regular expression would be too slow). 2607 See |fold-marker|. 2608 2609 *'foldmethod'* *'fdm'* 2610'foldmethod' 'fdm' string (default: "manual") 2611 local to window 2612 {not in Vi} 2613 {not available when compiled without the |+folding| 2614 feature} 2615 The kind of folding used for the current window. Possible values: 2616 |fold-manual| manual Folds are created manually. 2617 |fold-indent| indent Lines with equal indent form a fold. 2618 |fold-expr| expr 'foldexpr' gives the fold level of a line. 2619 |fold-marker| marker Markers are used to specify folds. 2620 |fold-syntax| syntax Syntax highlighting items specify folds. 2621 |fold-diff| diff Fold text that is not changed. 2622 2623 *'foldminlines'* *'fml'* 2624'foldminlines' 'fml' number (default: 1) 2625 local to window 2626 {not in Vi} 2627 {not available when compiled without the |+folding| 2628 feature} 2629 Sets the minimum number of screen lines for a fold to be displayed 2630 closed. Also for manually closed folds. 2631 Note that this only has an effect of what is displayed. After using 2632 "zc" to close a fold, which is displayed open because it's smaller 2633 than 'foldminlines', a following "zc" may close a containing fold. 2634 2635 *'foldnestmax'* *'fdn'* 2636'foldnestmax' 'fdn' number (default: 20) 2637 local to window 2638 {not in Vi} 2639 {not available when compiled without the |+folding| 2640 feature} 2641 Sets the maximum nesting of folds for the "indent" and "syntax" 2642 methods. This avoids that too many folds will be created. Using more 2643 than 20 doesn't work, because the internal limit is 20. 2644 2645 *'foldopen'* *'fdo'* 2646'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, 2647 search,tag,undo") 2648 global 2649 {not in Vi} 2650 {not available when compiled without the |+folding| 2651 feature} 2652 Specifies for which type of commands folds will be opened, if the 2653 command moves the cursor into a closed fold. It is a comma separated 2654 list of items. 2655 item commands ~ 2656 all any 2657 block "(", "{", "[[", "[{", etc. 2658 hor horizontal movements: "l", "w", "fx", etc. 2659 insert any command in Insert mode 2660 jump far jumps: "G", "gg", etc. 2661 mark jumping to a mark: "'m", CTRL-O, etc. 2662 percent "%" 2663 quickfix ":cn", ":crew", ":make", etc. 2664 search search for a pattern: "/", "n", "*", "gd", etc. 2665 (not for a search pattern in a ":" command) 2666 tag jumping to a tag: ":ta", CTRL-T, etc. 2667 undo undo or redo: "u" and CTRL-R 2668 When the command is part of a mapping this option is not used. Add 2669 the |zv| command to the mapping to get the same effect. 2670 When a movement command is used for an operator (e.g., "dl" or "y%") 2671 this option is not used. This means the operator will include the 2672 whole closed fold. 2673 Note that vertical movements are not here, because it would make it 2674 very difficult to move onto a closed fold. 2675 In insert mode the folds containing the cursor will always be open 2676 when text is inserted. 2677 To close folds you can re-apply 'foldlevel' with the |zx| command or 2678 set the 'foldclose' option to "all". 2679 2680 *'foldtext'* *'fdt'* 2681'foldtext' 'fdt' string (default: "foldtext()") 2682 local to window 2683 {not in Vi} 2684 {not available when compiled without the |+folding| 2685 feature} 2686 An expression which is used to specify the text displayed for a closed 2687 fold. See |fold-foldtext|. 2688 2689 *'formatoptions'* *'fo'* 2690'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") 2691 local to buffer 2692 {not in Vi} 2693 This is a sequence of letters which describes how automatic 2694 formatting is to be done. See |fo-table|. When the 'paste' option is 2695 on, no formatting is done (like 'formatoptions' is empty). Commas can 2696 be inserted for readability. 2697 To avoid problems with flags that are added in the future, use the 2698 "+=" and "-=" feature of ":set" |add-option-flags|. 2699 NOTE: This option is set to the Vi default value when 'compatible' is 2700 set and to the Vim default value when 'compatible' is reset. 2701 2702 *'formatprg'* *'fp'* 2703'formatprg' 'fp' string (default "") 2704 global 2705 {not in Vi} 2706 The name of an external program that will be used to format the lines 2707 selected with the "gq" command. The program must take the input on 2708 stdin and produce the output on stdout. The Unix program "fmt" is 2709 such a program. If this option is an empty string, the internal 2710 format function will be used |C-indenting|. Environment variables are 2711 expanded |:set_env|. See |option-backslash| about including spaces 2712 and backslashes. 2713 This option cannot be set from a |modeline| or in the |sandbox|, for 2714 security reasons. 2715 2716 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* 2717'gdefault' 'gd' boolean (default off) 2718 global 2719 {not in Vi} 2720 When on, the ":substitute" flag 'g' is default on. This means that 2721 all matches in a line are substituted instead of one. When a 'g' flag 2722 is given to a ":substitute" command, this will toggle the substitution 2723 of all or one match. See |complex-change|. 2724 2725 command 'gdefault' on 'gdefault' off ~ 2726 :s/// subst. all subst. one 2727 :s///g subst. one subst. all 2728 :s///gg subst. all subst. one 2729 2730 NOTE: This option is reset when 'compatible' is set. 2731 2732 *'grepformat'* *'gfm'* 2733'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m") 2734 global 2735 {not in Vi} 2736 Format to recognize for the ":grep" command output. 2737 This is a scanf-like string that uses the same format as the 2738 'errorformat' option: see |errorformat|. 2739 2740 *'grepprg'* *'gp'* 2741'grepprg' 'gp' string (default "grep -n ", 2742 Unix: "grep -n $* /dev/null", 2743 Win32: "findstr /n" or "grep -n", 2744 VMS: "SEARCH/NUMBERS ") 2745 global or local to buffer |global-local| 2746 {not in Vi} 2747 Program to use for the ":grep" command. This option may contain '%' 2748 and '#' characters, which are expanded like when used in a command- 2749 line. The placeholder "$*" is allowed to specify where the arguments 2750 will be included. Environment variables are expanded |:set_env|. See 2751 |option-backslash| about including spaces and backslashes. 2752 When your "grep" accepts the "-H" argument, use this to make ":grep" 2753 also work well with a single file: > 2754 :set grepprg=grep\ -nH 2755< See also the section |:make_makeprg|, since most of the comments there 2756 apply equally to 'grepprg'. 2757 For Win32, the default is "findstr /n" if "findstr.exe" can be found, 2758 otherwise it's "grep -n". 2759 This option cannot be set from a |modeline| or in the |sandbox|, for 2760 security reasons. 2761 2762 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* 2763'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, 2764 ve:ver35-Cursor, 2765 o:hor50-Cursor, 2766 i-ci:ver25-Cursor/lCursor, 2767 r-cr:hor20-Cursor/lCursor, 2768 sm:block-Cursor 2769 -blinkwait175-blinkoff150-blinkon175", 2770 for MS-DOS and Win32 console: 2771 "n-v-c:block,o:hor50,i-ci:hor15, 2772 r-cr:hor30,sm:block") 2773 global 2774 {not in Vi} 2775 {only available when compiled with GUI enabled, and 2776 for MS-DOS and Win32 console} 2777 This option tells Vim what the cursor should look like in different 2778 modes. It fully works in the GUI. In an MSDOS or Win32 console, only 2779 the height of the cursor can be changed. This can be done by 2780 specifying a block cursor, or a percentage for a vertical or 2781 horizontal cursor. 2782 2783 The option is a comma separated list of parts. Each part consist of a 2784 mode-list and an argument-list: 2785 mode-list:argument-list,mode-list:argument-list,.. 2786 The mode-list is a dash separated list of these modes: 2787 n Normal mode 2788 v Visual mode 2789 ve Visual mode with 'selection' "exclusive" (same as 'v', 2790 if not specified) 2791 o Operator-pending mode 2792 i Insert mode 2793 r Replace mode 2794 c Command-line Normal (append) mode 2795 ci Command-line Insert mode 2796 cr Command-line Replace mode 2797 sm showmatch in Insert mode 2798 a all modes 2799 The argument-list is a dash separated list of these arguments: 2800 hor{N} horizontal bar, {N} percent of the character height 2801 ver{N} vertical bar, {N} percent of the character width 2802 block block cursor, fills the whole character 2803 [only one of the above three should be present] 2804 blinkwait{N} *cursor-blinking* 2805 blinkon{N} 2806 blinkoff{N} 2807 blink times for cursor: blinkwait is the delay before 2808 the cursor starts blinking, blinkon is the time that 2809 the cursor is shown and blinkoff is the time that the 2810 cursor is not shown. The times are in msec. When one 2811 of the numbers is zero, there is no blinking. The 2812 default is: "blinkwait700-blinkon400-blinkoff250". 2813 These numbers are used for a missing entry. This 2814 means that blinking is enabled by default. To switch 2815 blinking off you can use "blinkon0". The cursor only 2816 blinks when Vim is waiting for input, not while 2817 executing a command. 2818 To make the cursor blink in an xterm, see 2819 |xterm-blink|. 2820 {group-name} 2821 a highlight group name, that sets the color and font 2822 for the cursor 2823 {group-name}/{group-name} 2824 Two highlight group names, the first is used when 2825 no language mappings are used, the other when they 2826 are. |language-mapping| 2827 2828 Examples of parts: 2829 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a 2830 block cursor with colors from the "nCursor" 2831 highlight group 2832 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 2833 In Insert and Command-line Insert mode, use a 2834 30% vertical bar cursor with colors from the 2835 "iCursor" highlight group. Blink a bit 2836 faster. 2837 2838 The 'a' mode is different. It will set the given argument-list for 2839 all modes. It does not reset anything to defaults. This can be used 2840 to do a common setting for all modes. For example, to switch off 2841 blinking: "a:blinkon0" 2842 2843 Examples of cursor highlighting: > 2844 :highlight Cursor gui=reverse guifg=NONE guibg=NONE 2845 :highlight Cursor gui=NONE guifg=bg guibg=fg 2846< 2847 *'guifont'* *'gfn'* 2848 *E235* *E596* *E610* *E611* 2849'guifont' 'gfn' string (default "") 2850 global 2851 {not in Vi} 2852 {only available when compiled with GUI enabled} 2853 This is a list of fonts which will be used for the GUI version of Vim. 2854 In its simplest form the value is just one font name. When 2855 the font cannot be found you will get an error message. To try other 2856 font names a list can be specified, font names separated with commas. 2857 The first valid font is used. 2858 2859 When 'guifontset' is not empty, 'guifont' is not used. 2860 2861 Spaces after a comma are ignored. To include a comma in a font name 2862 precede it with a backslash. Setting an option requires an extra 2863 backslash before a space and a backslash. See also 2864 |option-backslash|. For example: > 2865 :set guifont=Screen15,\ 7x13,font\\,with\\,commas 2866< will make Vim try to use the font "Screen15" first, and if it fails it 2867 will try to use "7x13" and then "font,with,commas" instead. 2868 2869 If none of the fonts can be loaded, Vim will keep the current setting. 2870 If an empty font list is given, Vim will try using other resource 2871 settings (for X, it will use the Vim.font resource), and finally it 2872 will try some builtin default which should always be there ("7x13" in 2873 the case of X). The font names given should be "normal" fonts. Vim 2874 will try to find the related bold and italic fonts. 2875 2876 For Win32, GTK and Photon only: > 2877 :set guifont=* 2878< will bring up a font requester, where you can pick the font you want. 2879 2880 The font name depends on the GUI used. See |setting-guifont| for a 2881 way to set 'guifont' for various systems. 2882 2883 For the GTK+ 2 GUI the font name looks like this: > 2884 :set guifont=Andale\ Mono\ 11 2885< That's all. XLFDs are no longer accepted. 2886 *E236* 2887 Note that the fonts must be mono-spaced (all characters have the same 2888 width). An exception is GTK 2: all fonts are accepted, but 2889 mono-spaced fonts look best. 2890 2891 To preview a font on X11, you might be able to use the "xfontsel" 2892 program. The "xlsfonts" program gives a list of all available fonts. 2893 2894 For the Win32 GUI *E244* *E245* 2895 - takes these options in the font name: 2896 hXX - height is XX (points, can be floating-point) 2897 wXX - width is XX (points, can be floating-point) 2898 b - bold 2899 i - italic 2900 u - underline 2901 s - strikeout 2902 cXX - character set XX. valid charsets are: ANSI, ARABIC, 2903 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, 2904 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, 2905 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. 2906 2907 Use a ':' to separate the options. 2908 - A '_' can be used in the place of a space, so you don't need to use 2909 backslashes to escape the spaces. 2910 - Examples: > 2911 :set guifont=courier_new:h12:w5:b:cRUSSIAN 2912 :set guifont=Andale_Mono:h7.5:w4.5 2913< See also |font-sizes|. 2914 2915 *'guifontset'* *'gfs'* 2916 *E250* *E252* *E234* *E597* *E598* 2917'guifontset' 'gfs' string (default "") 2918 global 2919 {not in Vi} 2920 {only available when compiled with GUI enabled and 2921 with the |+xfontset| feature} 2922 {not available in the GTK+ 2 GUI} 2923 When not empty, specifies two (or more) fonts to be used. The first 2924 one for normal English, the second one for your special language. See 2925 |xfontset|. 2926 Setting this option also means that all font names will be handled as 2927 a fontset name. Also the ones used for the "font" argument of the 2928 |:highlight| command. 2929 The fonts must match with the current locale. If fonts for the 2930 character sets that the current locale uses are not included, setting 2931 'guifontset' will fail. 2932 Note the difference between 'guifont' and 'guifontset': In 'guifont' 2933 the comma-separated names are alternative names, one of which will be 2934 used. In 'guifontset' the whole string is one fontset name, 2935 including the commas. It is not possible to specify alternative 2936 fontset names. 2937 This example works on many X11 systems: > 2938 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* 2939< 2940 *'guifontwide'* *'gfw'* *E231* *E533* *E534* 2941'guifontwide' 'gfw' string (default "") 2942 global 2943 {not in Vi} 2944 {only available when compiled with GUI enabled} 2945 When not empty, specifies a comma-separated list of fonts to be used 2946 for double-width characters. The first font that can be loaded is 2947 used. 2948 Note: The size of these fonts must be exactly twice as wide as the one 2949 specified with 'guifont' and the same height. 2950 2951 All GUI versions but GTK+ 2: 2952 2953 'guifontwide' is only used when 'encoding' is set to "utf-8" and 2954 'guifontset' is empty or invalid. 2955 When 'guifont' is set and a valid font is found in it and 2956 'guifontwide' is empty Vim will attempt to find a matching 2957 double-width font and set 'guifontwide' to it. 2958 2959 GTK+ 2 GUI only: *guifontwide_gtk2* 2960 2961 If set and valid, 'guifontwide' is always used for double width 2962 characters, even if 'encoding' is not set to "utf-8". 2963 Vim does not attempt to find an appropriate value for 'guifontwide' 2964 automatically. If 'guifontwide' is empty Pango/Xft will choose the 2965 font for characters not available in 'guifont'. Thus you do not need 2966 to set 'guifontwide' at all unless you want to override the choice 2967 made by Pango/Xft. 2968 2969 *'guiheadroom'* *'ghr'* 2970'guiheadroom' 'ghr' number (default 50) 2971 global 2972 {not in Vi} {only for GTK and X11 GUI} 2973 The number of pixels subtracted from the screen height when fitting 2974 the GUI window on the screen. Set this before the GUI is started, 2975 e.g., in your |gvimrc| file. When zero, the whole screen height will 2976 be used by the window. When positive, the specified number of pixel 2977 lines will be left for window decorations and other items on the 2978 screen. Set it to a negative value to allow windows taller than the 2979 screen. 2980 2981 *'guioptions'* *'go'* 2982'guioptions' 'go' string (default "gmrLtT" (MS-Windows), 2983 "agimrLtT" (GTK, Motif and Athena) 2984 global 2985 {not in Vi} 2986 {only available when compiled with GUI enabled} 2987 This option only has an effect in the GUI version of Vim. It is a 2988 sequence of letters which describes what components and options of the 2989 GUI should be used. 2990 To avoid problems with flags that are added in the future, use the 2991 "+=" and "-=" feature of ":set" |add-option-flags|. 2992 2993 Valid letters are as follows: 2994 *guioptions_a* 2995 'a' Autoselect: If present, then whenever VISUAL mode is started, 2996 or the Visual area extended, Vim tries to become the owner of 2997 the windowing system's global selection. This means that the 2998 Visually highlighted text is available for pasting into other 2999 applications as well as into Vim itself. When the Visual mode 3000 ends, possibly due to an operation on the text, or when an 3001 application wants to paste the selection, the highlighted text 3002 is automatically yanked into the "* selection register. 3003 Thus the selection is still available for pasting into other 3004 applications after the VISUAL mode has ended. 3005 If not present, then Vim won't become the owner of the 3006 windowing system's global selection unless explicitly told to 3007 by a yank or delete operation for the "* register. 3008 The same applies to the modeless selection. 3009 3010 'A' Autoselect for the modeless selection. Like 'a', but only 3011 applies to the modeless selection. 3012 3013 'guioptions' autoselect Visual autoselect modeless ~ 3014 "" - - 3015 "a" yes yes 3016 "A" - yes 3017 "aA" yes yes 3018 3019 'c' Use console dialogs instead of popup dialogs for simple 3020 choices. 3021 3022 'f' Foreground: Don't use fork() to detach the GUI from the shell 3023 where it was started. Use this for programs that wait for the 3024 editor to finish (e.g., an e-mail program). Alternatively you 3025 can use "gvim -f" or ":gui -f" to start the GUI in the 3026 foreground. |gui-fork| 3027 Note: Set this option in the vimrc file. The forking may have 3028 happened already when the gvimrc file is read. 3029 3030 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper 3031 corner of the window. It's black&white on non-GTK, because of 3032 limitations of X11. For a color icon, see |X11-icon|. 3033 3034 'm' Menu bar is present. 3035 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note 3036 that this flag must be added in the .vimrc file, before 3037 switching on syntax or filetype recognition (when the .gvimrc 3038 file is sourced the system menu has already been loaded; the 3039 ":syntax on" and ":filetype on" commands load the menu too). 3040 'g' Grey menu items: Make menu items that are not active grey. If 3041 'g' is not included inactive menu items are not shown at all. 3042 Exception: Athena will always use grey menu items. 3043 3044 't' Include tearoff menu items. Currently only works for Win32, 3045 GTK+, and Motif 1.2 GUI. 3046 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and 3047 Athena GUIs. 3048 3049 'r' Right-hand scrollbar is always present. 3050 'R' Right-hand scrollbar is present when there is a vertically 3051 split window. 3052 'l' Left-hand scrollbar is always present. 3053 'L' Left-hand scrollbar is present when there is a vertically 3054 split window. 3055 'b' Bottom (horizontal) scrollbar is present. Its size depends on 3056 the longest visible line, or on the cursor line if the 'h' 3057 flag is included. |gui-horiz-scroll| 3058 'h' Limit horizontal scrollbar size to the length of the cursor 3059 line. Reduces computations. |gui-horiz-scroll| 3060 3061 And yes, you may even have scrollbars on the left AND the right if 3062 you really want to :-). See |gui-scrollbars| for more information. 3063 3064 'v' Use a vertical button layout for dialogs. When not included, 3065 a horizontal layout is preferred, but when it doesn't fit a 3066 vertical layout is used anyway. 3067 'p' Use Pointer callbacks for X11 GUI. This is required for some 3068 window managers. If the cursor is not blinking or hollow at 3069 the right moment, try adding this flag. This must be done 3070 before starting the GUI. Set it in your gvimrc. Adding or 3071 removing it after the GUI has started has no effect. 3072 'F' Add a footer. Only for Motif. See |gui-footer|. 3073 3074 *'guipty'* *'noguipty'* 3075'guipty' boolean (default on) 3076 global 3077 {not in Vi} 3078 {only available when compiled with GUI enabled} 3079 Only in the GUI: If on, an attempt is made to open a pseudo-tty for 3080 I/O to/from shell commands. See |gui-pty|. 3081 3082 *'helpfile'* *'hf'* 3083'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" 3084 (others) "$VIMRUNTIME/doc/help.txt") 3085 global 3086 {not in Vi} 3087 Name of the main help file. All distributed help files should be 3088 placed together in one directory. Additionally, all "doc" directories 3089 in 'runtimepath' will be used. 3090 Environment variables are expanded |:set_env|. For example: 3091 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also 3092 tried. Also see |$VIMRUNTIME| and |option-backslash| about including 3093 spaces and backslashes. 3094 This option cannot be set from a |modeline| or in the |sandbox|, for 3095 security reasons. 3096 3097 *'helpheight'* *'hh'* 3098'helpheight' 'hh' number (default 20) 3099 global 3100 {not in Vi} 3101 {not available when compiled without the +windows 3102 feature} 3103 Minimal initial height of the help window when it is opened with the 3104 ":help" command. The initial height of the help window is half of the 3105 current window, or (when the 'ea' option is on) the same as other 3106 windows. When the height is less than 'helpheight', the height is 3107 set to 'helpheight'. Set to zero to disable. 3108 3109 *'helplang'* *'hlg'* 3110'helplang' 'hlg' string (default: messages language or empty) 3111 global 3112 {only available when compiled with the |+multi_lang| 3113 feature} 3114 {not in Vi} 3115 Comma separated list of languages. Vim will use the first language 3116 for which the desired help can be found. The English help will always 3117 be used as a last resort. You can add "en" to prefer English over 3118 another language, but that will only find tags that exist in that 3119 language and not in the English help. 3120 Example: > 3121 :set helplang=de,it 3122< This will first search German, then Italian and finally English help 3123 files. 3124 When using |CTRL-]| and ":help!" in a non-English help file Vim will 3125 try to find the tag in the current language before using this option. 3126 See |help-translated|. 3127 3128 *'hidden'* *'hid'* *'nohidden'* *'nohid'* 3129'hidden' 'hid' boolean (default off) 3130 global 3131 {not in Vi} 3132 When off a buffer is unloaded when it is |abandon|ed. When on a 3133 buffer becomes hidden when it is |abandon|ed. If the buffer is still 3134 displayed in another window, it does not become hidden, of course. 3135 The commands that move through the buffer list sometimes make a buffer 3136 hidden although the 'hidden' option is off: When the buffer is 3137 modified, 'autowrite' is off or writing is not possible, and the '!' 3138 flag was used. See also |windows.txt|. 3139 To only make one buffer hidden use the 'bufhidden' option. 3140 This option is set for one command with ":hide {command}" |:hide|. 3141 WARNING: It's easy to forget that you have changes in hidden buffers. 3142 Think twice when using ":q!" or ":qa!". 3143 3144 *'highlight'* *'hl'* 3145'highlight' 'hl' string (default (as a single string): 3146 "8:SpecialKey,@:NonText,d:Directory, 3147 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg, 3148 M:ModeMsg,n:LineNr,r:Question, 3149 s:StatusLine,S:StatusLineNC,c:VertSplit 3150 t:Title,v:Visual,w:WarningMsg,W:WildMenu, 3151 f:Folded,F:FoldColumn,A:DiffAdd, 3152 C:DiffChange,D:DiffDelete,T:DiffText, 3153 >:SignColumn") 3154 global 3155 {not in Vi} 3156 This option can be used to set highlighting mode for various 3157 occasions. It is a comma separated list of character pairs. The 3158 first character in a pair gives the occasion, the second the mode to 3159 use for that occasion. The occasions are: 3160 |hl-SpecialKey| 8 Meta and special keys listed with ":map" 3161 |hl-NonText| @ '~' and '@' at the end of the window and 3162 characters from 'showbreak' 3163 |hl-Directory| d directories in CTRL-D listing and other special 3164 things in listings 3165 |hl-ErrorMsg| e error messages 3166 h (obsolete, ignored) 3167 |hl-IncSearch| i 'incsearch' highlighting 3168 |hl-Search| l last search pattern highlighting (see 'hlsearch') 3169 |hl-MoreMsg| m |more-prompt| 3170 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") 3171 |hl-LineNr| n line number for ":number" and ":#" commands 3172 |hl-Question| r |hit-enter| prompt and yes/no questions 3173 |hl-StatusLine| s status line of current window |status-line| 3174 |hl-StatusLineNC| S status lines of not-current windows 3175 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. 3176 |hl-VertSplit| c column used to separate vertically split windows 3177 |hl-Visual| v Visual mode 3178 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the 3179 Selection" Only X11 Gui's |gui-x11| and 3180 |xterm-clipboard|. 3181 |hl-WarningMsg| w warning messages 3182 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' 3183 |hl-Folded| f line used for closed folds 3184 |hl-FoldColumn| F 'foldcolumn' 3185 |hl-SignColumn| > column used for |signs| 3186 3187 The display modes are: 3188 r reverse (termcap entry "mr" and "me") 3189 i italic (termcap entry "ZH" and "ZR") 3190 b bold (termcap entry "md" and "me") 3191 s standout (termcap entry "so" and "se") 3192 u underline (termcap entry "us" and "ue") 3193 n no highlighting 3194 - no highlighting 3195 : use a highlight group 3196 The default is used for occasions that are not included. 3197 If you want to change what the display modes do, see |dos-colors| 3198 for an example. 3199 When using the ':' display mode, this must be followed by the name of 3200 a highlight group. A highlight group can be used to define any type 3201 of highlighting, including using color. See |:highlight| on how to 3202 define one. The default uses a different group for each occasion. 3203 See |highlight-default| for the default highlight groups. 3204 3205 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* 3206'hlsearch' 'hls' boolean (default off) 3207 global 3208 {not in Vi} 3209 {not available when compiled without the 3210 |+extra_search| feature} 3211 When there is a previous search pattern, highlight all its matches. 3212 The type of highlighting used can be set with the 'l' occasion in the 3213 'highlight' option. This uses the "Search" highlight group by 3214 default. Note that only the matching text is highlighted, any offsets 3215 are not applied. 3216 See also: 'incsearch' and |:match|. 3217 When you get bored looking at the highlighted matches, you can turn it 3218 off with |:nohlsearch|. As soon as you use a search command, the 3219 highlighting comes back. 3220 When the search pattern can match an end-of-line, Vim will try to 3221 highlight all of the matched text. However, this depends on where the 3222 search starts. This will be the first line in the window or the first 3223 line below a closed fold. A match in a previous line which is not 3224 drawn may not continue in an newly drawn line. 3225 NOTE: This option is reset when 'compatible' is set. 3226 3227 *'history'* *'hi'* 3228'history' 'hi' number (Vim default: 20, Vi default: 0) 3229 global 3230 {not in Vi} 3231 A history of ":" commands, and a history of previous search patterns 3232 are remembered. This option decides how many entries may be stored in 3233 each of these histories (see |cmdline-editing|). 3234 NOTE: This option is set to the Vi default value when 'compatible' is 3235 set and to the Vim default value when 'compatible' is reset. 3236 3237 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* 3238'hkmap' 'hk' boolean (default off) 3239 global 3240 {not in Vi} 3241 {only available when compiled with the |+rightleft| 3242 feature} 3243 When on, the keyboard is mapped for the Hebrew character set. 3244 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to 3245 toggle this option. See |rileft.txt|. 3246 NOTE: This option is reset when 'compatible' is set. 3247 3248 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* 3249'hkmapp' 'hkp' boolean (default off) 3250 global 3251 {not in Vi} 3252 {only available when compiled with the |+rightleft| 3253 feature} 3254 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. 3255 This is useful if you have a non-Hebrew keyboard. 3256 See |rileft.txt|. 3257 NOTE: This option is reset when 'compatible' is set. 3258 3259 *'icon'* *'noicon'* 3260'icon' boolean (default off, on when title can be restored) 3261 global 3262 {not in Vi} 3263 {not available when compiled without the |+title| 3264 feature} 3265 When on, the icon text of the window will be set to the value of 3266 'iconstring' (if it is not empty), or to the name of the file 3267 currently being edited. Only the last part of the name is used. 3268 Overridden by the 'iconstring' option. 3269 Only works if the terminal supports setting window icons (currently 3270 only X11 GUI and terminals with a non-empty 't_IS' option - these are 3271 Unix xterm and iris-ansi by default, where 't_IS' is taken from the 3272 builtin termcap). 3273 When Vim was compiled with HAVE_X11 defined, the original icon will be 3274 restored if possible |X11|. See |X11-icon| for changing the icon on 3275 X11. 3276 3277 *'iconstring'* 3278'iconstring' string (default "") 3279 global 3280 {not in Vi} 3281 {not available when compiled without the |+title| 3282 feature} 3283 When this option is not empty, it will be used for the icon text of 3284 the window. This happens only when the 'icon' option is on. 3285 Only works if the terminal supports setting window icon text 3286 (currently only X11 GUI and terminals with a non-empty 't_IS' option). 3287 Does not work for MS Windows. 3288 When Vim was compiled with HAVE_X11 defined, the original icon will be 3289 restored if possible |X11|. 3290 When this option contains printf-style '%' items, they will be 3291 expanded according to the rules used for 'statusline'. See 3292 'titlestring' for example settings. 3293 {not available when compiled without the |+statusline| feature} 3294 3295 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* 3296'ignorecase' 'ic' boolean (default off) 3297 global 3298 Ignore case in search patterns. Also used when searching in the tags 3299 file. 3300 Also see 'smartcase'. 3301 Can be overruled by using "\c" or "\C" in the pattern, see 3302 |/ignorecase|. 3303 3304 *'imactivatekey'* *'imak'* 3305'imactivatekey' 'imak' string (default "") 3306 global 3307 {not in Vi} 3308 {only available when compiled with |+xim| and 3309 |+GUI_GTK|} 3310 Specifies the key that your Input Method in X-Windows uses for 3311 activation. When this is specified correctly, vim can fully control 3312 IM with 'imcmdline', 'iminsert' and 'imsearch'. 3313 You can't use this option to change the activation key, the option 3314 tells Vim what the key is. 3315 Format: 3316 [MODIFIER_FLAG-]KEY_STRING 3317 3318 These characters can be used for MODIFIER_FLAG (case is ignored): 3319 S Shift key 3320 L Lock key 3321 C Control key 3322 1 Mod1 key 3323 2 Mod2 key 3324 3 Mod3 key 3325 4 Mod4 key 3326 5 Mod5 key 3327 Combinations are allowed, for example "S-C-space" or "SC-space" are 3328 both shift+ctrl+space. 3329 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. 3330 3331 Example: > 3332 :set imactivatekey=S-space 3333< "S-space" means shift+space. This is the activation key for kinput2 + 3334 canna (Japanese), and ami (Korean). 3335 3336 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* 3337'imcmdline' 'imc' boolean (default off) 3338 global 3339 {not in Vi} 3340 {only available when compiled with the |+xim| 3341 |+multi_byte_ime| or |global-ime| feature} 3342 When set the Input Method is always on when starting to edit a command 3343 line, unless entering a search pattern (see 'imsearch' for that). 3344 Setting this option is useful when your input method allows entering 3345 English characters directly, e.g., when it's used to type accented 3346 characters with dead keys. 3347 3348 *'imdisable'* *'imd'* *'nodisable'* *'noimd'* 3349'imdisable' 'imd' boolean (default off, on for some systems (SGI)) 3350 global 3351 {not in Vi} 3352 {only available when compiled with the |+xim| 3353 |+multi_byte_ime| or |global-ime| feature} 3354 When set the Input Method is never used. This is useful to disable 3355 the IM when it doesn't work properly. 3356 Currently this option is on by default for SGI/IRIX machines. This 3357 may change in later releases. 3358 3359 *'iminsert'* *'imi'* 3360'iminsert' 'imi' number (default 0, 2 when an input method is supported) 3361 local to buffer 3362 {not in Vi} 3363 Specifies whether :lmap or an Input Method (IM) is to be used in 3364 Insert mode. Valid values: 3365 0 :lmap is off and IM is off 3366 1 :lmap is ON and IM is off 3367 2 :lmap is off and IM is ON 3368 2 is available only when compiled with the |+multi_byte_ime|, |+xim| 3369 or |global-ime|. 3370 To always reset the option to zero when leaving Insert mode with <Esc> 3371 this can be used: > 3372 :inoremap <ESC> <ESC>:set iminsert=0<CR> 3373< This makes :lmap and IM turn off automatically when leaving Insert 3374 mode. 3375 Note that this option changes when using CTRL-^ in Insert mode 3376 |i_CTRL-^|. 3377 The value is set to 1 when setting 'keymap' to a valid keymap name. 3378 It is also used for the argument of commands like "r" and "f". 3379 The value 0 may not work correctly with Athena and Motif with some XIM 3380 methods. Use 'imdisable' to disable XIM then. 3381 3382 *'imsearch'* *'ims'* 3383'imsearch' 'ims' number (default 0, 2 when an input method is supported) 3384 local to buffer 3385 {not in Vi} 3386 Specifies whether :lmap or an Input Method (IM) is to be used when 3387 entering a search pattern. Valid values: 3388 -1 the value of 'iminsert' is used, makes it look like 3389 'iminsert' is also used when typing a search pattern 3390 0 :lmap is off and IM is off 3391 1 :lmap is ON and IM is off 3392 2 :lmap is off and IM is ON 3393 Note that this option changes when using CTRL-^ in Command-line mode 3394 |c_CTRL-^|. 3395 The value is set to 1 when it is not -1 and setting the 'keymap' 3396 option to a valid keymap name. 3397 The value 0 may not work correctly with Athena and Motif with some XIM 3398 methods. Use 'imdisable' to disable XIM then. 3399 3400 *'include'* *'inc'* 3401'include' 'inc' string (default "^\s*#\s*include") 3402 global or local to buffer |global-local| 3403 {not in Vi} 3404 {not available when compiled without the 3405 |+find_in_path| feature} 3406 Pattern to be used to find an include command. It is a search 3407 pattern, just like for the "/" command (See |pattern|). The default 3408 value is for C programs. This option is used for the commands "[i", 3409 "]I", "[d", etc.. The 'isfname' option is used to recognize the file 3410 name that comes after the matched pattern. See |option-backslash| 3411 about including spaces and backslashes. 3412 3413 *'includeexpr'* *'inex'* 3414'includeexpr' 'inex' string (default "") 3415 local to buffer 3416 {not in Vi} 3417 {not available when compiled without the 3418 |+find_in_path| or |+eval| feature} 3419 Expression to be used to transform the string found with the 'include' 3420 option to a file name. Mostly useful to change "." to "/" for Java: > 3421 :set includeexpr=substitute(v:fname,'\\.','/','g') 3422< The "v:fname" variable will be set to the file name that was detected. 3423 Evaluated in the |sandbox|. 3424 Also used for the |gf| command if an unmodified file name can't be 3425 found. Allows doing "gf" on the name after an 'include' statement. 3426 Also used for |<cfile>|. 3427 3428 *'incsearch'* *'is'* *'noincsearch'* *'nois'* 3429'incsearch' 'is' boolean (default off) 3430 global 3431 {not in Vi} 3432 {not available when compiled without the 3433 |+extra_search| feature} 3434 While typing a search command, show where the pattern, as it was typed 3435 so far, matches. The matched string is highlighted. If the pattern 3436 is invalid or not found, nothing is shown. The screen will be updated 3437 often, this is only useful on fast terminals. 3438 Note that the match will be shown, but the cursor will return to its 3439 original position when no match is found and when pressing <Esc>. You 3440 still need to finish the search command with <Enter> to move the 3441 cursor to the match. 3442 The highlighting can be set with the 'i' flag in 'highlight'. 3443 See also: 'hlsearch'. 3444 NOTE: This option is reset when 'compatible' is set. 3445 3446 *'indentexpr'* *'inde'* 3447'indentexpr' 'inde' string (default "") 3448 local to buffer 3449 {not in Vi} 3450 {not available when compiled without the |+cindent| 3451 or |+eval| features} 3452 Expression which is evaluated to obtain the proper indent for a line. 3453 It is used when a new line is created, for the |=| operator and 3454 in Insert mode as specified with the 'indentkeys' option. 3455 When this option is not empty, it overrules the 'cindent' and 3456 'smartindent' indenting. 3457 When 'paste' is set this option is not used for indenting. 3458 The expression is evaluated with |v:lnum| set to the line number for 3459 which the indent is to be computed. The cursor is also as this line 3460 when the expression is evaluated (but it may be moved around). 3461 The expression must return the number of spaces worth of indent. It 3462 can return "-1" to keep the current indent (this means 'autoindent' is 3463 used for the indent). 3464 Functions useful for computing the indent are |indent()|, |cindent()| 3465 and |lispindent()|. 3466 The evaluation of the expression must not have side effects! It must 3467 not change the text, jump to another window, etc. Afterwards the 3468 cursor position is always restored, thus the cursor may be moved. 3469 Normally this option would be set to call a function: > 3470 :set indentexpr=GetMyIndent() 3471< Error messages will be suppressed, unless the 'debug' option contains 3472 "msg". 3473 See |indent-expression|. Also see |eval-sandbox|. 3474 NOTE: This option is made empty when 'compatible' is set. 3475 3476 *'indentkeys'* *'indk'* 3477'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") 3478 local to buffer 3479 {not in Vi} 3480 {not available when compiled without the |+cindent| 3481 feature} 3482 A list of keys that, when typed in Insert mode, cause reindenting of 3483 the current line. Only happens if 'indentexpr' isn't empty. 3484 The format is identical to 'cinkeys', see |indentkeys-format|. 3485 See |C-indenting| and |indent-expression|. 3486 3487 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* 3488'infercase' 'inf' boolean (default off) 3489 local to buffer 3490 {not in Vi} 3491 When doing keyword completion in insert mode |ins-completion|, and 3492 'ignorecase' is also on, the case of the match is adjusted. If the 3493 typed text contains a lowercase letter where the match has an upper 3494 case letter, the completed part is made lowercase. If the typed text 3495 has no lowercase letters and the match has a lowercase letter where 3496 the typed text has an uppercase letter, and there is a letter before 3497 it, the completed part is made uppercase. 3498 3499 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* 3500'insertmode' 'im' boolean (default off) 3501 global 3502 {not in Vi} 3503 Makes Vim work in a way that Insert mode is the default mode. Useful 3504 if you want to use Vim as a modeless editor. Used for |evim|. 3505 These Insert mode commands will be useful: 3506 - Use the cursor keys to move around. 3507 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When 3508 this is a mapping, it is executed as if 'insertmode' was off. 3509 Normal mode remains active until the mapping is finished. 3510 *i_CTRL-L* 3511 - Use CTRL-L to execute a number of Normal mode commands, then use 3512 <Esc> to get back to Insert mode. 3513 3514 These items change when 'insertmode' is set: 3515 - when starting to edit of a file, Vim goes to Insert mode. 3516 - <Esc> in Insert mode is a no-op and beeps. 3517 - <Esc> in Normal mode makes Vim go to Insert mode. 3518 - CTRL-L in Insert mode is a command, it is not inserted. 3519 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* 3520 However, when <Esc> is used inside a mapping, it behaves like 3521 'insertmode' was not set. This was done to be able to use the same 3522 mappings with 'insertmode' set or not set. 3523 When executing commands with |:normal| 'insertmode' is not used. 3524 3525 NOTE: This option is reset when 'compatible' is set. 3526 3527 *'isfname'* *'isf'* 3528'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: 3529 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" 3530 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" 3531 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" 3532 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" 3533 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") 3534 global 3535 {not in Vi} 3536 The characters specified by this option are included in file names and 3537 path names. Filenames are used for commands like "gf", "[i" and in 3538 the tags file. It is also used for "\f" in a |pattern|. 3539 Multi-byte characters 256 and above are always included, only the 3540 characters up to 255 are specified with this option. 3541 For UTF-8 the characters 0xa0 to 0xff are included as well. 3542 3543 Note that on systems using a backslash as path separator, Vim tries to 3544 do its best to make it work as you would expect. That is a bit 3545 tricky, since Vi originally used the backslash to escape special 3546 characters. Vim will not remove a backslash in front of a normal file 3547 name character on these systems, but it will on Unix and alikes. The 3548 '&' and '^' are not included by default, because these are special for 3549 cmd.exe. 3550 3551 The format of this option is a list of parts, separated with commas. 3552 Each part can be a single character number or a range. A range is two 3553 character numbers with '-' in between. A character number can be a 3554 decimal number between 0 and 255 or the ASCII character itself (does 3555 not work for digits). Example: 3556 "_,-,128-140,#-43" (include '_' and '-' and the range 3557 128 to 140 and '#' to 43) 3558 If a part starts with '^', the following character number or range 3559 will be excluded from the option. The option is interpreted from left 3560 to right. Put the excluded character after the range where it is 3561 included. To include '^' itself use it as the last character of the 3562 option or the end of a range. Example: 3563 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') 3564 If the character is '@', all characters where isalpha() returns TRUE 3565 are included. Normally these are the characters a to z and A to Z, 3566 plus accented characters. To include '@' itself use "@-@". Examples: 3567 "@,^a-z" All alphabetic characters, excluding lower 3568 case letters. 3569 "a-z,A-Z,@-@" All letters plus the '@' character. 3570 A comma can be included by using it where a character number is 3571 expected. Example: 3572 "48-57,,,_" Digits, comma and underscore. 3573 A comma can be excluded by prepending a '^'. Example: 3574 " -~,^,,9" All characters from space to '~', excluding 3575 comma, plus <Tab>. 3576 See |option-backslash| about including spaces and backslashes. 3577 3578 *'isident'* *'isi'* 3579'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: 3580 "@,48-57,_,128-167,224-235" 3581 otherwise: "@,48-57,_,192-255") 3582 global 3583 {not in Vi} 3584 The characters given by this option are included in identifiers. 3585 Identifiers are used in recognizing environment variables and after a 3586 match of the 'define' option. It is also used for "\i" in a 3587 |pattern|. See 'isfname' for a description of the format of this 3588 option. 3589 Careful: If you change this option, it might break expanding 3590 environment variables. E.g., when '/' is included and Vim tries to 3591 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. 3592 3593 *'iskeyword'* *'isk'* 3594'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: 3595 "@,48-57,_,128-167,224-235" 3596 otherwise: "@,48-57,_,192-255" 3597 Vi default: "@,48-57,_") 3598 local to buffer 3599 {not in Vi} 3600 Keywords are used in searching and recognizing with many commands: 3601 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See 3602 'isfname' for a description of the format of this option. For C 3603 programs you could use "a-z,A-Z,48-57,_,.,-,>". 3604 For a help file it is set to all non-blank printable characters except 3605 '*', '"' and '|' (so that CTRL-] on a command finds the help for that 3606 command). 3607 When the 'lisp' option is on the '-' character is always included. 3608 NOTE: This option is set to the Vi default value when 'compatible' is 3609 set and to the Vim default value when 'compatible' is reset. 3610 3611 *'isprint'* *'isp'* 3612'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: 3613 "@,~-255"; otherwise: "@,161-255") 3614 global 3615 {not in Vi} 3616 The characters given by this option are displayed directly on the 3617 screen. It is also used for "\p" in a |pattern|. The characters from 3618 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, 3619 even when they are not included in 'isprint' or excluded. See 3620 'isfname' for a description of the format of this option. 3621 3622 Non-printable characters are displayed with two characters: 3623 0 - 31 "^@" - "^_" 3624 32 - 126 always single characters 3625 127 "^?" 3626 128 - 159 "~@" - "~_" 3627 160 - 254 "| " - "|~" 3628 255 "~?" 3629 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are 3630 displayed as <xx>, with the hexadecimal value of the byte. 3631 When 'display' contains "uhex" all unprintable characters are 3632 displayed as <xx>. 3633 The NonText highlighting will be used for unprintable characters. 3634 |hl-NonText| 3635 3636 Multi-byte characters 256 and above are always included, only the 3637 characters up to 255 are specified with this option. When a character 3638 is printable but it is not available in the current font, a 3639 replacement character will be shown. 3640 Unprintable and zero-width Unicode characters are displayed as <xxxx>. 3641 There is no option to specify these characters. 3642 3643 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* 3644'joinspaces' 'js' boolean (default on) 3645 global 3646 {not in Vi} 3647 Insert two spaces after a '.', '?' and '!' with a join command. 3648 When 'cpoptions' includes the 'j' flag, only do this after a '.'. 3649 Otherwise only one space is inserted. 3650 NOTE: This option is set when 'compatible' is set. 3651 3652 *'key'* 3653'key' string (default "") 3654 local to buffer 3655 {not in Vi} 3656 The key that is used for encrypting and decrypting the current buffer. 3657 See |encryption|. 3658 Careful: Do not set the key value by hand, someone might see the typed 3659 key. Use the |:X| command. But you can make 'key' empty: > 3660 :set key= 3661< It is not possible to get the value of this option with ":set key" or 3662 "echo &key". This is to avoid showing it to someone who shouldn't 3663 know. It also means you cannot see it yourself once you have set it, 3664 be careful not to make a typing error! 3665 3666 *'keymap'* *'kmp'* *E544* 3667'keymap' 'kmp' string (default "") 3668 local to buffer 3669 {not in Vi} 3670 {only available when compiled with the |+keymap| 3671 feature} 3672 Name of a keyboard mapping. See |mbyte-keymap|. 3673 Setting this option to a valid keymap name has the side effect of 3674 setting 'iminsert' to one, so that the keymap becomes effective. 3675 'imsearch' is also set to one, unless it was -1 3676 3677 *'keymodel'* *'km'* 3678'keymodel' 'km' string (default "") 3679 global 3680 {not in Vi} 3681 List of comma separated words, which enable special things that keys 3682 can do. These values can be used: 3683 startsel Using a shifted special key starts selection (either 3684 Select mode or Visual mode, depending on "key" being 3685 present in 'selectmode'). 3686 stopsel Using a not-shifted special key stops selection. 3687 Special keys in this context are the cursor keys, <End>, <Home>, 3688 <PageUp> and <PageDown>. 3689 The 'keymodel' option is set by the |:behave| command. 3690 3691 *'keywordprg'* *'kp'* 3692'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help", 3693 OS/2: "view /", VMS: "help") 3694 global or local to buffer |global-local| 3695 {not in Vi} 3696 Program to use for the |K| command. Environment variables are 3697 expanded |:set_env|. ":help" may be used to access the Vim internal 3698 help. (Note that previously setting the global option to the empty 3699 value did this, which is now deprecated.) 3700 When "man" is used, Vim will automatically translate a count for the 3701 "K" command to a section number. Also for "man -s", in which case the 3702 "-s" is removed when there is no count. 3703 See |option-backslash| about including spaces and backslashes. 3704 Example: > 3705 :set keywordprg=man\ -s 3706< This option cannot be set from a |modeline| or in the |sandbox|, for 3707 security reasons. 3708 3709 *'langmap'* *'lmap'* *E357* *E358* 3710'langmap' 'lmap' string (default "") 3711 global 3712 {not in Vi} 3713 {only available when compiled with the |+langmap| 3714 feature} 3715 This option allows switching your keyboard into a special language 3716 mode. When you are typing text in Insert mode the characters are 3717 inserted directly. When in command mode the 'langmap' option takes 3718 care of translating these special characters to the original meaning 3719 of the key. This means you don't have to change the keyboard mode to 3720 be able to execute Normal mode commands. 3721 This is the opposite of the 'keymap' option, where characters are 3722 mapped in Insert mode. 3723 This only works for 8-bit characters. The value of 'langmap' may be 3724 specified with multi-byte characters (e.g., UTF-8), but only the lower 3725 8 bits of each character will be used. 3726 3727 Example (for Greek): *greek* > 3728 :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 3729< Example (exchanges meaning of z and y for commands): > 3730 :set langmap=zy,yz,ZY,YZ 3731< 3732 The 'langmap' option is a list of parts, separated with commas. Each 3733 part can be in one of two forms: 3734 1. A list of pairs. Each pair is a "from" character immediately 3735 followed by the "to" character. Examples: "aA", "aAbBcC". 3736 2. A list of "from" characters, a semi-colon and a list of "to" 3737 characters. Example: "abc;ABC" 3738 Example: "aA,fgh;FGH,cCdDeE" 3739 Special characters need to be preceded with a backslash. These are 3740 ";", ',' and backslash itself. 3741 3742 This will allow you to activate vim actions without having to switch 3743 back and forth between the languages. Your language characters will 3744 be understood as normal vim English characters (according to the 3745 langmap mappings) in the following cases: 3746 o Normal/Visual mode (commands, buffer/register names, user mappings) 3747 o Insert/Replace Mode: Register names after CTRL-R 3748 o Insert/Replace Mode: Mappings 3749 Characters entered in Command-line mode will NOT be affected by 3750 this option. Note that this option can be changed at any time 3751 allowing to switch between mappings for different languages/encodings. 3752 Use a mapping to avoid having to type it each time! 3753 3754 *'langmenu'* *'lm'* 3755'langmenu' 'lm' string (default "") 3756 global 3757 {not in Vi} 3758 {only available when compiled with the |+menu| and 3759 |+multi_lang| features} 3760 Language to use for menu translation. Tells which file is loaded 3761 from the "lang" directory in 'runtimepath': > 3762 "lang/menu_" . &langmenu . ".vim" 3763< (without the spaces). For example, to always use the Dutch menus, no 3764 matter what $LANG is set to: > 3765 :set langmenu=nl_NL.ISO_8859-1 3766< When 'langmenu' is empty, |v:lang| is used. 3767 If your $LANG is set to a non-English language but you do want to use 3768 the English menus: > 3769 :set langmenu=none 3770< This option must be set before loading menus, switching on filetype 3771 detection or syntax highlighting. Once the menus are defined setting 3772 this option has no effect. But you could do this: > 3773 :source $VIMRUNTIME/delmenu.vim 3774 :set langmenu=de_DE.ISO_8859-1 3775 :source $VIMRUNTIME/menu.vim 3776< Warning: This deletes all menus that you defined yourself! 3777 3778 *'laststatus'* *'ls'* 3779'laststatus' 'ls' number (default 1) 3780 global 3781 {not in Vi} 3782 The value of this option influences when the last window will have a 3783 status line: 3784 0: never 3785 1: only if there are at least two windows 3786 2: always 3787 The screen looks nicer with a status line if you have several 3788 windows, but it takes another screen line. |status-line| 3789 3790 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* 3791'lazyredraw' 'lz' boolean (default off) 3792 global 3793 {not in Vi} 3794 When this option is set, the screen will not be redrawn while 3795 executing macros, registers and other commands that have not been 3796 typed. Also, updating the window title is postponed. To force an 3797 update use |:redraw|. 3798 3799 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* 3800'linebreak' 'lbr' boolean (default off) 3801 local to window 3802 {not in Vi} 3803 {not available when compiled without the |+linebreak| 3804 feature} 3805 If on Vim will wrap long lines at a character in 'breakat' rather 3806 than at the last character that fits on the screen. Unlike 3807 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, 3808 it only affects the way the file is displayed, not its contents. The 3809 value of 'showbreak' is used to put in front of wrapped lines. 3810 This option is not used when the 'wrap' option is off or 'list' is on. 3811 Note that <Tab> characters after an <EOL> are mostly not displayed 3812 with the right amount of white space. 3813 3814 *'lines'* *E593* 3815'lines' number (default 24 or terminal height) 3816 global 3817 Number of lines of the Vim window. 3818 Normally you don't need to set this. It is done automatically by the 3819 terminal initialization code. 3820 When Vim is running in the GUI or in a resizable window, setting this 3821 option will cause the window size to be changed. When you only want 3822 to use the size for the GUI, put the command in your |gvimrc| file. 3823 Vim limits the number of lines to what fits on the screen. You can 3824 use this command to get the tallest window possible: > 3825 :set lines=999 3826< If you get less lines than expected, check the 'guiheadroom' option. 3827 When you set this option and Vim is unable to change the physical 3828 number of lines of the display, the display may be messed up. 3829 3830 *'linespace'* *'lsp'* 3831'linespace' 'lsp' number (default 0, 1 for Win32 GUI) 3832 global 3833 {not in Vi} 3834 {only in the GUI} 3835 Number of pixel lines inserted between characters. Useful if the font 3836 uses the full character cell height, making lines touch each other. 3837 When non-zero there is room for underlining. 3838 3839 *'lisp'* *'nolisp'* 3840'lisp' boolean (default off) 3841 local to buffer 3842 {not available when compiled without the |+lispindent| 3843 feature} 3844 Lisp mode: When <Enter> is typed in insert mode set the indent for 3845 the next line to Lisp standards (well, sort of). Also happens with 3846 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' 3847 flag in 'cpoptions' changes the method of indenting: Vi compatible or 3848 better. Also see 'lispwords'. 3849 The '-' character is included in keyword characters. Redefines the 3850 "=" operator to use this same indentation algorithm rather than 3851 calling an external program if 'equalprg' is empty. 3852 This option is not used when 'paste' is set. 3853 {Vi: Does it a little bit differently} 3854 3855 *'lispwords'* *'lw'* 3856'lispwords' 'lw' string (default is very long) 3857 global 3858 {not in Vi} 3859 {not available when compiled without the |+lispindent| 3860 feature} 3861 Comma separated list of words that influence the Lisp indenting. 3862 |'lisp'| 3863 3864 *'list'* *'nolist'* 3865'list' boolean (default off) 3866 local to window 3867 List mode: Show tabs as CTRL-I, show end of line with $. Useful to 3868 see the difference between tabs and spaces and for trailing blanks. 3869 Note that this will also affect formatting (set with 'textwidth' or 3870 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for 3871 changing the way tabs are displayed. 3872 3873 *'listchars'* *'lcs'* 3874'listchars' 'lcs' string (default "eol:$") 3875 global 3876 {not in Vi} 3877 Strings to use in 'list' mode. It is a comma separated list of string 3878 settings. 3879 eol:c Character to show at the end of each line. When 3880 omitted, there is no extra character at the end of the 3881 line. 3882 tab:xy Two characters to be used to show a Tab. The first 3883 char is used once. The second char is repeated to 3884 fill the space that the Tab normally occupies. 3885 "tab:>-" will show a Tab that takes four spaces as 3886 ">---". When omitted, a Tab is show as ^I. 3887 trail:c Character to show for trailing spaces. When omitted, 3888 trailing spaces are blank. 3889 extends:c Character to show in the last column, when 'wrap' is 3890 off and the line continues beyond the right of the 3891 screen. 3892 precedes:c Character to show in the first column, when 'wrap' 3893 is off and there is text preceding the character 3894 visible in the first column. 3895 nbsp:c Character to show for a non-breakable space (character 3896 0xA0, 160). Left blank when omitted. 3897 3898 The characters ':' and ',' should not be used. UTF-8 characters can 3899 be used when 'encoding' is "utf-8", otherwise only printable 3900 characters are allowed. 3901 3902 Examples: > 3903 :set lcs=tab:>-,trail:- 3904 :set lcs=tab:>-,eol:<,nbsp:% 3905 :set lcs=extends:>,precedes:< 3906< The "NonText" highlighting will be used for "eol", "extends" and 3907 "precedes". "SpecialKey" for "nbsp", "tab" and "trail". 3908 3909 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* 3910'loadplugins' 'lpl' boolean (default on) 3911 global 3912 {not in Vi} 3913 When on the plugin scripts are loaded when starting up |load-plugins|. 3914 This option can be reset in your |vimrc| file to disable the loading 3915 of plugins. 3916 Note that using the "-u NONE" and "--noplugin" command line arguments 3917 reset this option. |-u| |--noplugin| 3918 3919 *'magic'* *'nomagic'* 3920'magic' boolean (default on) 3921 global 3922 Changes the special characters that can be used in search patterns. 3923 See |pattern|. 3924 NOTE: To avoid portability problems with using patterns, always keep 3925 this option at the default "on". Only switch it off when working with 3926 old Vi scripts. In any other situation write patterns that work when 3927 'magic' is on. 3928 3929 *'makeef'* *'mef'* 3930'makeef' 'mef' string (default: "") 3931 global 3932 {not in Vi} 3933 {not available when compiled without the |+quickfix| 3934 feature} 3935 Name of the errorfile for the |:make| command (see |:make_makeprg|) 3936 and the |:grep| command. 3937 When it is empty, an internally generated temp file will be used. 3938 When "##" is included, it is replaced by a number to make the name 3939 unique. This makes sure that the ":make" command doesn't overwrite an 3940 existing file. 3941 NOT used for the ":cf" command. See 'errorfile' for that. 3942 Environment variables are expanded |:set_env|. 3943 See |option-backslash| about including spaces and backslashes. 3944 This option cannot be set from a |modeline| or in the |sandbox|, for 3945 security reasons. 3946 3947 *'makeprg'* *'mp'* 3948'makeprg' 'mp' string (default "make", VMS: "MMS") 3949 global or local to buffer |global-local| 3950 {not in Vi} 3951 Program to use for the ":make" command. See |:make_makeprg|. This 3952 option may contain '%' and '#' characters, which are expanded like 3953 when used in a command-line. Environment variables are expanded 3954 |:set_env|. See |option-backslash| about including spaces and 3955 backslashes. Note that a '|' must be escaped twice: once for ":set" 3956 and once for the interpretation of a command. When you use a filter 3957 called "myfilter" do it like this: > 3958 :set makeprg=gmake\ \\\|\ myfilter 3959< The placeholder "$*" can be given (even multiple times) to specify 3960 where the arguments will be included, for example: > 3961 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} 3962< This option cannot be set from a |modeline| or in the |sandbox|, for 3963 security reasons. 3964 3965 *'matchpairs'* *'mps'* 3966'matchpairs' 'mps' string (default "(:),{:},[:]") 3967 local to buffer 3968 {not in Vi} 3969 Characters that form pairs. The |%| command jumps from one to the 3970 other. Currently only single character pairs are allowed, and they 3971 must be different. The characters must be separated by a colon. The 3972 pairs must be separated by a comma. Example for including '<' and '>' 3973 (HTML): > 3974 :set mps+=<:> 3975 3976< A more exotic example, to jump between the '=' and ';' in an 3977 assignment, useful for languages like C and Java: > 3978 :au FileType c,cpp,java set mps+==:; 3979 3980< For a more advanced way of using "%", see the matchit.vim plugin in 3981 the $VIMRUNTIME/macros directory. |add-local-help| 3982 3983 *'matchtime'* *'mat'* 3984'matchtime' 'mat' number (default 5) 3985 global 3986 {not in Vi}{in Nvi} 3987 Tenths of a second to show the matching paren, when 'showmatch' is 3988 set. Note that this is not in milliseconds, like other options that 3989 set a time. This is to be compatible with Nvi. 3990 3991 *'maxfuncdepth'* *'mfd'* 3992'maxfuncdepth' 'mfd' number (default 100) 3993 global 3994 {not in Vi} 3995 Maximum depth of function calls for user functions. This normally 3996 catches endless recursion. When using a recursive function with 3997 more depth, set 'maxfuncdepth' to a bigger number. But this will use 3998 more memory, there is the danger of failing when memory is exhausted. 3999 See also |:function|. 4000 4001 *'maxmapdepth'* *'mmd'* *E223* 4002'maxmapdepth' 'mmd' number (default 1000) 4003 global 4004 {not in Vi} 4005 Maximum number of times a mapping is done without resulting in a 4006 character to be used. This normally catches endless mappings, like 4007 ":map x y" with ":map y x". It still does not catch ":map g wg", 4008 because the 'w' is used before the next mapping is done. See also 4009 |key-mapping|. 4010 4011 *'maxmem'* *'mm'* 4012'maxmem' 'mm' number (default between 256 to 5120 (system 4013 dependent) or half the amount of memory 4014 available) 4015 global 4016 {not in Vi} 4017 Maximum amount of memory (in Kbyte) to use for one buffer. When this 4018 limit is reached allocating extra memory for a buffer will cause 4019 other memory to be freed. Maximum value 2000000. Use this to work 4020 without a limit. Also see 'maxmemtot'. 4021 4022 *'maxmemtot'* *'mmt'* 4023'maxmemtot' 'mmt' number (default between 2048 and 10240 (system 4024 dependent) or half the amount of memory 4025 available) 4026 global 4027 {not in Vi} 4028 Maximum amount of memory (in Kbyte) to use for all buffers together. 4029 Maximum value 2000000. Use this to work without a limit. Also see 4030 'maxmem'. 4031 4032 *'menuitems'* *'mis'* 4033'menuitems' 'mis' number (default 25) 4034 global 4035 {not in Vi} 4036 {not available when compiled without the |+menu| 4037 feature} 4038 Maximum number of items to use in a menu. Used for menus that are 4039 generated from a list of items, e.g., the Buffers menu. Changing this 4040 option has no direct effect, the menu must be refreshed first. 4041 4042 *'modeline'* *'ml'* *'nomodeline'* *'noml'* 4043'modeline' 'ml' boolean (Vim default: on, Vi default: off) 4044 local to buffer 4045 *'modelines'* *'mls'* 4046'modelines' 'mls' number (default 5) 4047 global 4048 {not in Vi} 4049 If 'modeline' is on 'modelines' gives the number of lines that is 4050 checked for set commands. If 'modeline' is off or 'modelines' is zero 4051 no lines are checked. See |modeline|. 4052 NOTE: 'modeline' is set to the Vi default value when 'compatible' is 4053 set and to the Vim default value when 'compatible' is reset. 4054 4055 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* 4056'modifiable' 'ma' boolean (default on) 4057 local to buffer 4058 {not in Vi} *E21* 4059 When off the buffer contents cannot be changed. The 'fileformat' and 4060 'fileencoding' options also can't be changed. 4061 Can be reset with the |-M| command line argument. 4062 4063 *'modified'* *'mod'* *'nomodified'* *'nomod'* 4064'modified' 'mod' boolean (default off) 4065 local to buffer 4066 {not in Vi} 4067 When on, the buffer is considered to be modified. This option is set 4068 when: 4069 1. A change was made to the text since it was last written. Using the 4070 |undo| command to go back to the original text will reset the 4071 option. But undoing changes that were made before writing the 4072 buffer will set the option again, since the text is different from 4073 when it was written. 4074 2. 'fileformat' or 'fileencoding' is different from its original 4075 value. The original value is set when the buffer is read or 4076 written. A ":set nomodified" command also resets the original 4077 values to the current values and the 'modified' option will be 4078 reset. 4079 When 'buftype' is "nowrite" or "nofile" this option may be set, but 4080 will be ignored. 4081 4082 *'more'* *'nomore'* 4083'more' boolean (Vim default: on, Vi default: off) 4084 global 4085 {not in Vi} 4086 When on, listings pause when the whole screen is filled. You will get 4087 the |more-prompt|. When this option is off there are no pauses, the 4088 listing continues until finished. 4089 NOTE: This option is set to the Vi default value when 'compatible' is 4090 set and to the Vim default value when 'compatible' is reset. 4091 4092 *'mouse'* *E538* 4093'mouse' string (default "", "a" for GUI, MS-DOS and Win32) 4094 global 4095 {not in Vi} 4096 Enable the use of the mouse. Only works for certain terminals 4097 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console 4098 with gpm). For using the mouse in the GUI, see |gui-mouse|. 4099 The mouse can be enabled for different modes: 4100 n Normal mode 4101 v Visual mode 4102 i Insert mode 4103 c Command-line mode 4104 h all previous modes when editing a help file 4105 a all previous modes 4106 r for |hit-enter| and |more-prompt| prompt 4107 A auto-select in Visual mode 4108 Normally you would enable the mouse in all four modes with: > 4109 :set mouse=a 4110< When the mouse is not enabled, the GUI will still use the mouse for 4111 modeless selection. This doesn't move the text cursor. 4112 4113 See |mouse-using|. Also see |'clipboard'|. 4114 4115 Note: When enabling the mouse in a terminal, copy/paste will use the 4116 "* register if there is access to an X-server. The xterm handling of 4117 the mouse buttons can still be used by keeping the shift key pressed. 4118 Also see the 'clipboard' option. 4119 4120 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* 4121'mousefocus' 'mousef' boolean (default off) 4122 global 4123 {not in Vi} 4124 {only works in the GUI} 4125 The window that the mouse pointer is on is automatically activated. 4126 When changing the window layout or window focus in another way, the 4127 mouse pointer is moved to the window with keyboard focus. Off is the 4128 default because it makes using the pull down menus a little goofy, as 4129 a pointer transit may activate a window unintentionally. 4130 4131 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* 4132'mousehide' 'mh' boolean (default on) 4133 global 4134 {not in Vi} 4135 {only works in the GUI} 4136 When on, the mouse pointer is hidden when characters are typed. 4137 The mouse pointer is restored when the mouse is moved. 4138 4139 *'mousemodel'* *'mousem'* 4140'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) 4141 global 4142 {not in Vi} 4143 Sets the model to use for the mouse. The name mostly specifies what 4144 the right mouse button is used for: 4145 extend Right mouse button extends a selection. This works 4146 like in an xterm. 4147 popup Right mouse button pops up a menu. The shifted left 4148 mouse button extends a selection. This works like 4149 with Microsoft Windows 4150 popup_setpos Like "popup", but the cursor will be moved to the 4151 position where the mouse was clicked, and thus the 4152 selected operation will act upon the clicked object. 4153 If clicking inside a selection, that selection will 4154 be acted upon, ie. no cursor move. This implies of 4155 course, that right clicking outside a selection will 4156 end Visual mode. 4157 Overview of what button does what for each model: 4158 mouse extend popup(_setpos) ~ 4159 left click place cursor place cursor 4160 left drag start selection start selection 4161 shift-left search word extend selection 4162 right click extend selection popup menu (place cursor) 4163 right drag extend selection - 4164 middle click paste paste 4165 4166 In the "popup" model the right mouse button produces a pop-up menu. 4167 You need to define this first, see |popup-menu|. 4168 4169 Note that you can further refine the meaning of buttons with mappings. 4170 See |gui-mouse-mapping|. But mappings are NOT used for modeless 4171 selection (because that's handled in the GUI code directly). 4172 4173 The 'mousemodel' option is set by the |:behave| command. 4174 4175 *'mouseshape'* *'mouses'* *E547* 4176'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, 4177 m:no,ml:up-arrow,v:rightup-arrow" 4178 global 4179 {not in Vi} 4180 {only available when compiled with the |+mouseshape| 4181 feature} 4182 This option tells Vim what the mouse pointer should look like in 4183 different modes. The option is a comma separated list of parts, much 4184 like used for 'guicursor'. Each part consist of a mode/location-list 4185 and an argument-list: 4186 mode-list:shape,mode-list:shape,.. 4187 The mode-list is a dash separated list of these modes/locations: 4188 In a normal window: ~ 4189 n Normal mode 4190 v Visual mode 4191 ve Visual mode with 'selection' "exclusive" (same as 'v', 4192 if not specified) 4193 o Operator-pending mode 4194 i Insert mode 4195 r Replace mode 4196 4197 Others: ~ 4198 c appending to the command-line 4199 ci inserting in the command-line 4200 cr replacing in the command-line 4201 m at the 'Hit ENTER' or 'More' prompts 4202 ml idem, but cursor in the last line 4203 e any mode, pointer below last window 4204 s any mode, pointer on a status line 4205 sd any mode, while dragging a status line 4206 vs any mode, pointer on a vertical separator line 4207 vd any mode, while dragging a vertical separator line 4208 a everywhere 4209 4210 The shape is one of the following: 4211 avail name looks like ~ 4212 w x arrow Normal mouse pointer 4213 w x blank no pointer at all (use with care!) 4214 w x beam I-beam 4215 w x updown up-down sizing arrows 4216 w x leftright left-right sizing arrows 4217 w x busy The system's usual busy pointer 4218 w x no The system's usual 'no input' pointer 4219 x udsizing indicates up-down resizing 4220 x lrsizing indicates left-right resizing 4221 x crosshair like a big thin + 4222 x hand1 black hand 4223 x hand2 white hand 4224 x pencil what you write with 4225 x question big ? 4226 x rightup-arrow arrow pointing right-up 4227 w x up-arrow arrow pointing up 4228 x <number> any X11 pointer number (see X11/cursorfont.h) 4229 4230 The "avail" column contains a 'w' if the shape is available for Win32, 4231 x for X11. 4232 Any modes not specified or shapes not available use the normal mouse 4233 pointer. 4234 4235 Example: > 4236 :set mouseshape=s:udsizing,m:no 4237< will make the mouse turn to a sizing arrow over the status lines and 4238 indicate no input when the hit-enter prompt is displayed (since 4239 clicking the mouse has no effect in this state.) 4240 4241 *'mousetime'* *'mouset'* 4242'mousetime' 'mouset' number (default 500) 4243 global 4244 {not in Vi} 4245 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum 4246 time in msec between two mouse clicks for the second click to be 4247 recognized as a multi click. 4248 4249 *'mzquantum'* *'mzq'* 4250'mzquantum' 'mzq' number (default 100) 4251 global 4252 {not in Vi} 4253 {not available when compiled without the |+mzscheme| 4254 feature} 4255 The number of milliseconds between polls for MzScheme threads. 4256 Negative or zero value means no thread scheduling. 4257 4258 *'nrformats'* *'nf'* 4259'nrformats' 'nf' string (default "octal,hex") 4260 local to buffer 4261 {not in Vi} 4262 This defines what bases Vim will consider for numbers when using the 4263 CTRL-A and CTRL-X commands for adding to and subtracting from a number 4264 respectively; see |CTRL-A| for more info on these commands. 4265 alpha if included, single alphabetical characters will be 4266 incremented or decremented. This is useful for a list with a 4267 letter index a), b), etc. 4268 octal if included, numbers that start with a zero will be considered 4269 to be octal. Example: Using CTRL-A on "007" results in "010". 4270 hex if included, numbers starting with "0x" or "0X" will be 4271 considered to be hexadecimal. Example: Using CTRL-X on 4272 "0x100" results in "0x0ff". 4273 Numbers which simply begin with a digit in the range 1-9 are always 4274 considered decimal. This also happens for numbers that are not 4275 recognized as octal or hex. 4276 4277 *'number'* *'nu'* *'nonumber'* *'nonu'* 4278'number' 'nu' boolean (default off) 4279 local to window 4280 Print the line number in front of each line. When the 'n' option is 4281 excluded from 'cpoptions' a wrapped line will not use the column of 4282 line numbers (this is the default when 'compatible' isn't set). 4283 The 'numberwidth' option can be used to set the room used for the line 4284 number. 4285 When a long, wrapped line doesn't start with the first character, '-' 4286 characters are put before the number. 4287 See |hl-LineNr| for the highlighting used for the number. 4288 4289 *'numberwidth'* *'nuw'* 4290'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) 4291 local to window 4292 {not in Vi} 4293 {only available when compiled with the |+linebreak| 4294 feature} 4295 Minimal number of columns to use for the line number. Only relevant 4296 when the 'number' option is set. 4297 Since one space is always between the number and the text, there is 4298 one less character for the number itself. 4299 The value is the minimum width. A bigger width is used when needed to 4300 fit the highest line number in the buffer. Thus with the Vim default 4301 of 4 there is room for a line number up to 999. When the buffer has 4302 1000 lines five columns will be used. 4303 The minimum value is 1, the maximum value is 10. 4304 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set. 4305 4306 *'osfiletype'* *'oft'* *E366* 4307'osfiletype' 'oft' string (RISC-OS default: "Text", 4308 others default: "") 4309 local to buffer 4310 {not in Vi} 4311 {only available when compiled with the |+osfiletype| 4312 feature} 4313 Some operating systems store extra information about files besides 4314 name, datestamp and permissions. This option contains the extra 4315 information, the nature of which will vary between systems. 4316 The value of this option is usually set when the file is loaded, and 4317 use to set the file type when file is written. 4318 It can affect the pattern matching of the automatic commands. 4319 |autocmd-osfiletypes| 4320 4321 *'paragraphs'* *'para'* 4322'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp") 4323 global 4324 Specifies the nroff macros that separate paragraphs. These are pairs 4325 of two letters (see |object-motions|). 4326 4327 *'paste'* *'nopaste'* 4328'paste' boolean (default off) 4329 global 4330 {not in Vi} 4331 Put Vim in Paste mode. This is useful if you want to cut or copy 4332 some text from one window and paste it in Vim. This will avoid 4333 unexpected effects. 4334 Setting this option is useful when using Vim in a terminal, where Vim 4335 cannot distinguish between typed text and pasted text. In the GUI, Vim 4336 knows about pasting and will mostly do the right thing without 'paste' 4337 being set. The same is true for a terminal where Vim handles the 4338 mouse clicks itself. 4339 When the 'paste' option is switched on (also when it was already on): 4340 - mapping in Insert mode and Command-line mode is disabled 4341 - abbreviations are disabled 4342 - 'textwidth' is set to 0 4343 - 'wrapmargin' is set to 0 4344 - 'autoindent' is reset 4345 - 'smartindent' is reset 4346 - 'softtabstop' is set to 0 4347 - 'revins' is reset 4348 - 'ruler' is reset 4349 - 'showmatch' is reset 4350 - 'formatoptions' is used like it is empty 4351 These options keep their value, but their effect is disabled: 4352 - 'lisp' 4353 - 'indentexpr' 4354 - 'cindent' 4355 NOTE: When you start editing another file while the 'paste' option is 4356 on, settings from the modelines or autocommands may change the 4357 settings again, causing trouble when pasting text. You might want to 4358 set the 'paste' option again. 4359 When the 'paste' option is reset the mentioned options are restored to 4360 the value before the moment 'paste' was switched from off to on. 4361 Resetting 'paste' before ever setting it does not have any effect. 4362 Since mapping doesn't work while 'paste' is active, you need to use 4363 the 'pastetoggle' option to toggle the 'paste' option with some key. 4364 4365 *'pastetoggle'* *'pt'* 4366'pastetoggle' 'pt' string (default "") 4367 global 4368 {not in Vi} 4369 When non-empty, specifies the key sequence that toggles the 'paste' 4370 option. This is like specifying a mapping: > 4371 :map {keys} :set invpaste<CR> 4372< Where {keys} is the value of 'pastetoggle'. 4373 The difference is that it will work even when 'paste' is set. 4374 'pastetoggle' works in Insert mode and Normal mode, but not in 4375 Command-line mode. 4376 Mappings are checked first, thus overrule 'pastetoggle'. However, 4377 when 'paste' is on mappings are ignored in Insert mode, thus you can do 4378 this: > 4379 :map <F10> :set paste<CR> 4380 :map <F11> :set nopaste<CR> 4381 :imap <F10> <C-O>:set paste<CR> 4382 :imap <F11> <nop> 4383 :set pastetoggle=<F11> 4384< This will make <F10> start paste mode and <F11> stop paste mode. 4385 Note that typing <F10> in paste mode inserts "<F10>", since in paste 4386 mode everything is inserted literally, except the 'pastetoggle' key 4387 sequence. 4388 4389 *'pex'* *'patchexpr'* 4390'patchexpr' 'pex' string (default "") 4391 global 4392 {not in Vi} 4393 {not available when compiled without the |+diff| 4394 feature} 4395 Expression which is evaluated to apply a patch to a file and generate 4396 the resulting new version of the file. See |diff-patchexpr|. 4397 4398 *'patchmode'* *'pm'* *E206* 4399'patchmode' 'pm' string (default "") 4400 global 4401 {not in Vi} 4402 When non-empty the oldest version of a file is kept. This can be used 4403 to keep the original version of a file if you are changing files in a 4404 source distribution. Only the first time that a file is written a 4405 copy of the original file will be kept. The name of the copy is the 4406 name of the original file with the string in the 'patchmode' option 4407 appended. This option should start with a dot. Use a string like 4408 ".org". 'backupdir' must not be empty for this to work (Detail: The 4409 backup file is renamed to the patchmode file after the new file has 4410 been successfully written, that's why it must be possible to write a 4411 backup file). If there was no file to be backed up, an empty file is 4412 created. 4413 When the 'backupskip' pattern matches, a patchmode file is not made. 4414 Using 'patchmode' for compressed files appends the extension at the 4415 end (e.g., "file.gz.orig"), thus the resulting name isn't always 4416 recognized as a compressed file. 4417 4418 *'path'* *'pa'* *E343* *E345* *E347* 4419'path' 'pa' string (default on Unix: ".,/usr/include,," 4420 on OS/2: ".,/emx/include,," 4421 other systems: ".,,") 4422 global or local to buffer |global-local| 4423 {not in Vi} 4424 This is a list of directories which will be searched when using the 4425 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file 4426 being searched for has a relative path (not starting with '/'). The 4427 directories in the 'path' option may be relative or absolute. 4428 - Use commas to separate directory names: > 4429 :set path=.,/usr/local/include,/usr/include 4430< - Spaces can also be used to separate directory names (for backwards 4431 compatibility with version 3.0). To have a space in a directory 4432 name, precede it with an extra backslash, and escape the space: > 4433 :set path=.,/dir/with\\\ space 4434< - To include a comma in a directory name precede it with an extra 4435 backslash: > 4436 :set path=.,/dir/with\\,comma 4437< - To search relative to the directory of the current file, use: > 4438 :set path=. 4439< - To search in the current directory use an empty string between two 4440 commas: > 4441 :set path=,, 4442< - A directory name may end in a ':' or '/'. 4443 - Environment variables are expanded |:set_env|. 4444 - When using |netrw.vim| URLs can be used. For example, adding 4445 "http://www.vim.org" will make ":find index.html" work. 4446 - Search upwards and downwards in a directory tree: 4447 1) "*" matches a sequence of characters, e.g.: > 4448 :set path=/usr/include/* 4449< means all subdirectories in /usr/include (but not /usr/include 4450 itself). > 4451 :set path=/usr/*c 4452< matches /usr/doc and /usr/src. 4453 2) "**" matches a subtree, up to 100 directories deep. Example: > 4454 :set path=/home/user_x/src/** 4455< means search in the whole subtree under "/home/usr_x/src". 4456 3) If the path ends with a ';', this path is the startpoint 4457 for upward search. 4458 See |file-searching| for more info and exact syntax. 4459 {not available when compiled without the |+path_extra| feature} 4460 - Careful with '\' characters, type two to get one in the option: > 4461 :set path=.,c:\\include 4462< Or just use '/' instead: > 4463 :set path=.,c:/include 4464< Don't forget "." or files won't even be found in the same directory as 4465 the file! 4466 The maximum length is limited. How much depends on the system, mostly 4467 it is something like 256 or 1024 characters. 4468 You can check if all the include files are found, using the value of 4469 'path', see |:checkpath|. 4470 The use of |:set+=| and |:set-=| is preferred when adding or removing 4471 directories from the list. This avoids problems when a future version 4472 uses another default. To remove the current directory use: > 4473 :set path-= 4474< To add the current directory use: > 4475 :set path+= 4476< To use an environment variable, you probably need to replace the 4477 separator. Here is an example to append $INCL, in which directory 4478 names are separated with a semi-colon: > 4479 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') 4480< Replace the ';' with a ':' or whatever separator is used. Note that 4481 this doesn't work when $INCL contains a comma or white space. 4482 4483 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* 4484'preserveindent' 'pi' boolean (default off) 4485 local to buffer 4486 {not in Vi} 4487 When changing the indent of the current line, preserve as much of the 4488 indent structure as possible. Normally the indent is replaced by a 4489 series of tabs followed by spaces as required (unless |'expandtab'| is 4490 enabled, in which case only spaces are used). Enabling this option 4491 means the indent will preserve as many existing characters as possible 4492 for indenting, and only add additional tabs or spaces as required. 4493 NOTE: When using ">>" multiple times the resulting indent is a mix of 4494 tabs and spaces. You might not like this. 4495 NOTE: 'preserveindent' is reset when 'compatible' is set. 4496 Also see 'copyindent'. 4497 Use |:retab| to clean up white space. 4498 4499 *'previewheight'* *'pvh'* 4500'previewheight' 'pvh' number (default 12) 4501 global 4502 {not in Vi} 4503 {not available when compiled without the |+windows| or 4504 |+quickfix| feature} 4505 Default height for a preview window. Used for |:ptag| and associated 4506 commands. Used for |CTRL-W_}| when no count is given. 4507 4508 *'previewwindow'* *'nopreviewwindow'* 4509 *'pvw'* *'nopvw'* *E590* 4510'previewwindow' 'pvw' boolean (default off) 4511 local to window 4512 {not in Vi} 4513 {not available when compiled without the |+windows| or 4514 |+quickfix| feature} 4515 Identifies the preview window. Only one window can have this option 4516 set. It's normally not set directly, but by using one of the commands 4517 |:ptag|, |:pedit|, etc. 4518 4519 *'printdevice'* *'pdev'* 4520'printdevice' 'pdev' string (default empty) 4521 global 4522 {not in Vi} 4523 {only available when compiled with the |+printer| 4524 feature} 4525 The name of the printer to be used for |:hardcopy|. 4526 See |pdev-option|. 4527 4528 *'printencoding'* *'penc'* 4529'printencoding' 'penc' String (default empty, except for some systems) 4530 global 4531 {not in Vi} 4532 {only available when compiled with the |+printer| 4533 and |+postscript| features} 4534 Sets the character encoding used when printing. 4535 See |penc-option|. 4536 4537 *'printexpr'* *'pexpr'* 4538'printexpr' 'pexpr' String (default: see below) 4539 global 4540 {not in Vi} 4541 {only available when compiled with the |+printer| 4542 and |+postscript| features} 4543 Expression used to print the PostScript produced with |:hardcopy|. 4544 See |pexpr-option|. 4545 4546 *'printfont'* *'pfn'* 4547'printfont' 'pfn' string (default "courier") 4548 global 4549 {not in Vi} 4550 {only available when compiled with the |+printer| 4551 feature} 4552 The name of the font that will be used for |:hardcopy|. 4553 See |pfn-option|. 4554 4555 *'printheader'* *'pheader'* 4556'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") 4557 global 4558 {not in Vi} 4559 {only available when compiled with the |+printer| 4560 feature} 4561 The format of the header produced in |:hardcopy| output. 4562 See |pheader-option|. 4563 4564 *'printmbcharset'* *'pmbcs'* 4565'printmbcharset' 'pmbcs' string (default "") 4566 global 4567 {not in Vi} 4568 {only available when compiled with the |+printer| 4569 and |+multi_byte| features} 4570 The CJK character set to be used for CJK output from |:hardcopy|. 4571 See |pmbcs-option|. 4572 4573 *'printmbfont'* *'pmbfn'* 4574'printmbfont' 'pmbfn' string (default "") 4575 global 4576 {not in Vi} 4577 {only available when compiled with the |+printer| 4578 and |+multi_byte| features} 4579 List of font names to be used for CJK output from |:hardcopy|. 4580 See |pmbfn-option|. 4581 4582 *'printoptions'* *'popt'* 4583'printoptions' 'popt' string (default "") 4584 global 4585 {not in Vi} 4586 {only available when compiled with |+printer| feature} 4587 List of items that control the format of the output of |:hardcopy|. 4588 See |popt-option|. 4589 4590 *'quoteescape''* *'qe'* 4591'quoteescape' 'qe' string (default "\") 4592 local to buffer 4593 {not in Vi} 4594 The characters that are used to escape quotes in a string. Used for 4595 objects like a', a" and a` |a'|. 4596 When one of the characters in this option is found inside a string, 4597 the following character will be skipped. The default value makes the 4598 text "foo\"bar\\" considered to be one string. 4599 4600 *'readonly'* *'ro'* *'noreadonly'* *'noro'* 4601'readonly' 'ro' boolean (default off) 4602 local to buffer 4603 If on, writes fail unless you use a '!'. Protects you from 4604 accidentally overwriting a file. Default on when Vim is started 4605 in read-only mode ("vim -R") or when the executable is called "view". 4606 {not in Vi:} When using the ":view" command the 'readonly' option is 4607 set for the newly edited buffer. When using ":w!" the 'readonly' 4608 option is reset for the current buffer. 4609 4610 *'remap'* *'noremap'* 4611'remap' boolean (default on) 4612 global 4613 Allows for mappings to work recursively. If you do not want this for 4614 a single entry, use the :noremap[!] command. 4615 4616 *'report'* 4617'report' number (default 2) 4618 global 4619 Threshold for reporting number of lines changed. When the number of 4620 changed lines is more than 'report' a message will be given for most 4621 ":" commands. If you want it always, set 'report' to 0. 4622 For the ":substitute" command the number of substitutions is used 4623 instead of the number of lines. 4624 4625 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* 4626'restorescreen' 'rs' boolean (default on) 4627 global 4628 {not in Vi} {only in Windows 95/NT console version} 4629 When set, the screen contents is restored when exiting Vim. This also 4630 happens when executing external commands. 4631 4632 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' 4633 options in your .vimrc. To disable restoring: 4634 set t_ti= t_te= 4635 To enable restoring (for an xterm): 4636 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 4637 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) 4638 4639 *'revins'* *'ri'* *'norevins'* *'nori'* 4640'revins' 'ri' boolean (default off) 4641 global 4642 {not in Vi} 4643 {only available when compiled with the |+rightleft| 4644 feature} 4645 Inserting characters in Insert mode will work backwards. See "typing 4646 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ 4647 command in Insert mode, when 'allowrevins' is set. 4648 NOTE: This option is reset when 'compatible' or 'paste' is set. 4649 4650 *'rightleft'* *'rl'* *'norightleft'* *'norl'* 4651'rightleft' 'rl' boolean (default off) 4652 local to window 4653 {not in Vi} 4654 {only available when compiled with the |+rightleft| 4655 feature} 4656 When on, display orientation becomes right-to-left, i.e., characters 4657 that are stored in the file appear from the right to the left. 4658 Using this option, it is possible to edit files for languages that 4659 are written from the right to the left such as Hebrew and Arabic. 4660 This option is per window, so it is possible to edit mixed files 4661 simultaneously, or to view the same file in both ways (this is 4662 useful whenever you have a mixed text file with both right-to-left 4663 and left-to-right strings so that both sets are displayed properly 4664 in different windows). Also see |rileft.txt|. 4665 4666 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'* 4667'rightleftcmd' 'rlc' string (default "search") 4668 local to window 4669 {not in Vi} 4670 {only available when compiled with the |+rightleft| 4671 feature} 4672 Each word in this option enables the command line editing to work in 4673 right-to-left mode for a group of commands: 4674 4675 search "/" and "?" commands 4676 4677 This is useful for languages such as Hebrew, Arabic and Farsi. 4678 The 'rightleft' option must be set for 'rightleftcmd' to take effect. 4679 4680 *'ruler'* *'ru'* *'noruler'* *'noru'* 4681'ruler' 'ru' boolean (default off) 4682 global 4683 {not in Vi} 4684 {not available when compiled without the 4685 |+cmdline_info| feature} 4686 Show the line and column number of the cursor position, separated by a 4687 comma. When there is room, the relative position of the displayed 4688 text in the file is shown on the far right: 4689 Top first line is visible 4690 Bot last line is visible 4691 All first and last line are visible 4692 45% relative position in the file 4693 If 'rulerformat' is set, it will determine the contents of the ruler. 4694 Each window has its own ruler. If a window has a status line, the 4695 ruler is shown there. Otherwise it is shown in the last line of the 4696 screen. If the statusline is given by 'statusline' (ie. not empty), 4697 this option takes precedence over 'ruler' and 'rulerformat' 4698 If the number of characters displayed is different from the number of 4699 bytes in the text (e.g., for a TAB or a multi-byte character), both 4700 the text column (byte number) and the screen column are shown, 4701 separated with a dash. 4702 For an empty line "0-1" is shown. 4703 For an empty buffer the line number will also be zero: "0,0-1". 4704 This option is reset when the 'paste' option is set. 4705 If you don't want to see the ruler all the time but want to know where 4706 you are, use "g CTRL-G" |g_CTRL-G|. 4707 NOTE: This option is reset when 'compatible' is set. 4708 4709 *'rulerformat'* *'ruf'* 4710'rulerformat' 'ruf' string (default empty) 4711 global 4712 {not in Vi} 4713 {not available when compiled without the |+statusline| 4714 feature} 4715 When this option is not empty, it determines the content of the ruler 4716 string, as displayed for the 'ruler' option. 4717 The format of this option, is like that of 'statusline'. 4718 The default ruler width is 17 characters. To make the ruler 15 4719 characters wide, put "%15(" at the start and "%)" at the end. 4720 Example: > 4721 :set rulerformat=%15(%c%V\ %p%%%) 4722< 4723 *'runtimepath'* *'rtp'* *vimfiles* 4724'runtimepath' 'rtp' string (default: 4725 Unix: "$HOME/.vim, 4726 $VIM/vimfiles, 4727 $VIMRUNTIME, 4728 $VIM/vimfiles/after, 4729 $HOME/.vim/after" 4730 Amiga: "home:vimfiles, 4731 $VIM/vimfiles, 4732 $VIMRUNTIME, 4733 $VIM/vimfiles/after, 4734 home:vimfiles/after" 4735 PC, OS/2: "$HOME/vimfiles, 4736 $VIM/vimfiles, 4737 $VIMRUNTIME, 4738 $VIM/vimfiles/after, 4739 $HOME/vimfiles/after" 4740 Macintosh: "$VIM:vimfiles, 4741 $VIMRUNTIME, 4742 $VIM:vimfiles:after" 4743 RISC-OS: "Choices:vimfiles, 4744 $VIMRUNTIME, 4745 Choices:vimfiles/after" 4746 VMS: "sys$login:vimfiles, 4747 $VIM/vimfiles, 4748 $VIMRUNTIME, 4749 $VIM/vimfiles/after, 4750 sys$login:vimfiles/after" 4751 global 4752 {not in Vi} 4753 This is a list of directories which will be searched for runtime 4754 files: 4755 filetype.vim filetypes by file name |new-filetype| 4756 scripts.vim filetypes by file contents |new-filetype-scripts| 4757 colors/ color scheme files |:colorscheme| 4758 compiler/ compiler files |:compiler| 4759 doc/ documentation |write-local-help| 4760 ftplugin/ filetype plugins |write-filetype-plugin| 4761 indent/ indent scripts |indent-expression| 4762 keymap/ key mapping files |mbyte-keymap| 4763 lang/ menu translations |:menutrans| 4764 menu.vim GUI menus |menu.vim| 4765 plugin/ plugin scripts |write-plugin| 4766 print/ files for printing |postscript-print-encoding| 4767 syntax/ syntax files |mysyntaxfile| 4768 tutor/ files for vimtutor |tutor| 4769 4770 And any other file searched for with the |:runtime| command. 4771 4772 The defaults for most systems are setup to search five locations: 4773 1. In your home directory, for your personal preferences. 4774 2. In a system-wide Vim directory, for preferences from the system 4775 administrator. 4776 3. In $VIMRUNTIME, for files distributed with Vim. 4777 *after-directory* 4778 4. In the "after" directory in the system-wide Vim directory. This is 4779 for the system administrator to overrule or add to the distributed 4780 defaults (rarely needed) 4781 5. In the "after" directory in your home directory. This is for 4782 personal preferences to overrule or add to the distributed defaults 4783 or system-wide settings (rarely needed). 4784 4785 Note that, unlike 'path', no wildcards like "**" are allowed. Normal 4786 wildcards are allowed, but can significantly slow down searching for 4787 runtime files. For speed, use as few items as possible and avoid 4788 wildcards. 4789 See |:runtime|. 4790 Example: > 4791 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME 4792< This will use the directory "~/vimruntime" first (containing your 4793 personal Vim runtime files), then "/mygroup/vim" (shared between a 4794 group of people) and finally "$VIMRUNTIME" (the distributed runtime 4795 files). 4796 You probably should always include $VIMRUNTIME somewhere, to use the 4797 distributed runtime files. You can put a directory before $VIMRUNTIME 4798 to find files which replace a distributed runtime files. You can put 4799 a directory after $VIMRUNTIME to find files which add to distributed 4800 runtime files. 4801 This option cannot be set from a |modeline| or in the |sandbox|, for 4802 security reasons. 4803 4804 *'scroll'* *'scr'* 4805'scroll' 'scr' number (default: half the window height) 4806 local to window 4807 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be 4808 set to half the number of lines in the window when the window size 4809 changes. If you give a count to the CTRL-U or CTRL-D command it will 4810 be used as the new value for 'scroll'. Reset to half the window 4811 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives 4812 the number of screen lines instead of file lines, makes a difference 4813 when lines wrap} 4814 4815 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* 4816'scrollbind' 'scb' boolean (default off) 4817 local to window 4818 {not in Vi} 4819 {not available when compiled without the |+scrollbind| 4820 feature} 4821 See also |scroll-binding|. When this option is set, the current 4822 window scrolls as other scrollbind windows (windows that also have 4823 this option set) scroll. This option is useful for viewing the 4824 differences between two versions of a file, see 'diff'. 4825 See |'scrollopt'| for options that determine how this option should be 4826 interpreted. 4827 This option is mostly reset when splitting a window to edit another 4828 file. This means that ":split | edit file" results in two windows 4829 with scroll-binding, but ":split file" does not. 4830 4831 *'scrolljump'* *'sj'* 4832'scrolljump' 'sj' number (default 1) 4833 global 4834 {not in Vi} 4835 Minimal number of lines to scroll when the cursor gets off the 4836 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, 4837 CTRL-D). Useful if your terminal scrolls very slowly. 4838 NOTE: This option is set to 1 when 'compatible' is set. 4839 4840 *'scrolloff'* *'so'* 4841'scrolloff' 'so' number (default 0) 4842 global 4843 {not in Vi} 4844 Minimal number of screen lines to keep above and below the cursor. 4845 This will make some context visible around where you are working. If 4846 you set it to a very large value (999) the cursor line will always be 4847 in the middle of the window (except at the start or end of the file or 4848 when long lines wrap). 4849 For scrolling horizontally see 'sidescrolloff'. 4850 NOTE: This option is set to 0 when 'compatible' is set. 4851 4852 *'scrollopt'* *'sbo'* 4853'scrollopt' 'sbo' string (default "ver,jump") 4854 global 4855 {not available when compiled without the |+scrollbind| 4856 feature} 4857 {not in Vi} 4858 This is a comma-separated list of words that specifies how 4859 'scrollbind' windows should behave. 4860 The following words are available: 4861 ver Bind vertical scrolling for 'scrollbind' windows 4862 hor Bind horizontal scrolling for 'scrollbind' windows 4863 jump Applies to the offset between two windows for vertical 4864 scrolling. This offset is the difference in the first 4865 displayed line of the bound windows. When moving 4866 around in a window, another 'scrollbind' window may 4867 reach a position before the start or after the end of 4868 the buffer. The offset is not changed though, when 4869 moving back the 'scrollbind' window will try to scroll 4870 to the desired position when possible. 4871 When now making that window the current one, two 4872 things can be done with the relative offset: 4873 1. When "jump" is not included, the relative offset is 4874 adjusted for the scroll position in the new current 4875 window. When going back to the other window, the 4876 the new relative offset will be used. 4877 2. When "jump" is included, the other windows are 4878 scrolled to keep the same relative offset. When 4879 going back to the other window, it still uses the 4880 same relative offset. 4881 Also see |scroll-binding|. 4882 4883 *'sections'* *'sect'* 4884'sections' 'sect' string (default "SHNHH HUnhsh") 4885 global 4886 Specifies the nroff macros that separate sections. These are pairs of 4887 two letters (See |object-motions|). The default makes a section start 4888 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". 4889 4890 *'secure'* *'nosecure'* *E523* 4891'secure' boolean (default off) 4892 global 4893 {not in Vi} 4894 When on, ":autocmd", shell and write commands are not allowed in 4895 ".vimrc" and ".exrc" in the current directory and map commands are 4896 displayed. Switch it off only if you know that you will not run into 4897 problems, or when the 'exrc' option is off. On Unix this option is 4898 only used if the ".vimrc" or ".exrc" is not owned by you. This can be 4899 dangerous if the systems allows users to do a "chown". You better set 4900 'secure' at the end of your ~/.vimrc then. 4901 This option cannot be set from a |modeline| or in the |sandbox|, for 4902 security reasons. 4903 4904 *'selection'* *'sel'* 4905'selection' 'sel' string (default "inclusive") 4906 global 4907 {not in Vi} 4908 This option defines the behavior of the selection. It is only used 4909 in Visual and Select mode. 4910 Possible values: 4911 value past line inclusive ~ 4912 old no yes 4913 inclusive yes yes 4914 exclusive yes no 4915 "past line" means that the cursor is allowed to be positioned one 4916 character past the line. 4917 "inclusive" means that the last character of the selection is included 4918 in an operation. For example, when "x" is used to delete the 4919 selection. 4920 Note that when "exclusive" is used and selecting from the end 4921 backwards, you cannot include the last character of a line, when 4922 starting in Normal mode and 'virtualedit' empty. 4923 4924 The 'selection' option is set by the |:behave| command. 4925 4926 *'selectmode'* *'slm'* 4927'selectmode' 'slm' string (default "") 4928 global 4929 {not in Vi} 4930 This is a comma separated list of words, which specifies when to start 4931 Select mode instead of Visual mode, when a selection is started. 4932 Possible values: 4933 mouse when using the mouse 4934 key when using shifted special keys 4935 cmd when using "v", "V" or CTRL-V 4936 See |Select-mode|. 4937 The 'selectmode' option is set by the |:behave| command. 4938 4939 *'sessionoptions'* *'ssop'* 4940'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, 4941 help,options,winsize") 4942 global 4943 {not in Vi} 4944 {not available when compiled without the +mksession 4945 feature} 4946 Changes the effect of the |:mksession| command. It is a comma 4947 separated list of words. Each word enables saving and restoring 4948 something: 4949 word save and restore ~ 4950 blank empty windows 4951 buffers hidden and unloaded buffers, not just those in windows 4952 curdir the current directory 4953 folds manually created folds, opened/closed folds and local 4954 fold options 4955 globals global variables that start with an uppercase letter 4956 and contain at least one lowercase letter. 4957 help the help window 4958 localoptions options and mappings local to a window or buffer (not 4959 global values for local options) 4960 options all options and mappings (also global values for local 4961 options) 4962 resize size of the Vim window: 'lines' and 'columns' 4963 sesdir the directory in which the session file is located 4964 will become the current directory (useful with 4965 projects accessed over a network from different 4966 systems) 4967 slash backslashes in file names replaced with forward 4968 slashes 4969 unix with Unix end-of-line format (single <NL>), even when 4970 on Windows or DOS 4971 winpos position of the whole Vim window 4972 winsize window sizes 4973 4974 Don't include both "curdir" and "sesdir". 4975 When "curdir" nor "sesdir" is included, file names are stored with 4976 absolute paths. 4977 "slash" and "unix" are useful on Windows when sharing session files 4978 with Unix. The Unix version of Vim cannot source dos format scripts, 4979 but the Windows version of Vim can source unix format scripts. 4980 4981 *'shell'* *'sh'* *E91* 4982'shell' 'sh' string (default $SHELL or "sh", 4983 MS-DOS and Win32: "command.com" or 4984 "cmd.exe", OS/2: "cmd") 4985 global 4986 Name of the shell to use for ! and :! commands. When changing the 4987 value also check these options: 'shelltype', 'shellpipe', 'shellslash' 4988 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. 4989 It is allowed to give an argument to the command, e.g. "csh -f". 4990 See |option-backslash| about including spaces and backslashes. 4991 Environment variables are expanded |:set_env|. 4992 If the name of the shell contains a space, you might need to enclose 4993 it in quotes. Example: > 4994 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f 4995< Note the backslash before each quote (to avoid starting a comment) and 4996 each space (to avoid ending the option value). Also note that the 4997 "-f" is not inside the quotes, because it is not part of the command 4998 name. And Vim automagically recognizes the backslashes that are path 4999 separators. 5000 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment 5001 variable to change the way external commands are executed. See the 5002 libc.inf file of DJGPP. 5003 Under MS-Windows, when the executable ends in ".com" it must be 5004 included. Thus setting the shell to "command.com" or "4dos.com" 5005 works, but "command" and "4dos" do not work for all commands (e.g., 5006 filtering). 5007 For unknown reasons, when using "4dos.com" the current directory is 5008 changed to "C:\". To avoid this set 'shell' like this: > 5009 :set shell=command.com\ /c\ 4dos 5010< This option cannot be set from a |modeline| or in the |sandbox|, for 5011 security reasons. 5012 5013 *'shellcmdflag'* *'shcf'* 5014'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell' 5015 does not contain "sh" somewhere: "/c") 5016 global 5017 {not in Vi} 5018 Flag passed to the shell to execute "!" and ":!" commands; e.g., 5019 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like 5020 systems, the default is set according to the value of 'shell', to 5021 reduce the need to set this option by the user. It's not used for 5022 OS/2 (EMX figures this out itself). See |option-backslash| about 5023 including spaces and backslashes. See |dos-shell|. 5024 This option cannot be set from a |modeline| or in the |sandbox|, for 5025 security reasons. 5026 5027 *'shellpipe'* *'sp'* 5028'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") 5029 global 5030 {not in Vi} 5031 {not available when compiled without the |+quickfix| 5032 feature} 5033 String to be used to put the output of the ":make" command in the 5034 error file. See also |:make_makeprg|. See |option-backslash| about 5035 including spaces and backslashes. 5036 The name of the temporary file can be represented by "%s" if necessary 5037 (the file name is appended automatically if no %s appears in the value 5038 of this option). 5039 For the Amiga and MS-DOS the default is ">". The output is directly 5040 saved in a file and not echoed to the screen. 5041 For Unix the default it "| tee". The stdout of the compiler is saved 5042 in a file and echoed to the screen. If the 'shell' option is "csh" or 5043 "tcsh" after initializations, the default becomes "|& tee". If the 5044 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes 5045 "2>&1| tee". This means that stderr is also included. 5046 The initialization of this option is done after reading the ".vimrc" 5047 and the other initializations, so that when the 'shell' option is set 5048 there, the 'shellpipe' option changes automatically, unless it was 5049 explicitly set before. 5050 When 'shellpipe' is set to an empty string, no redirection of the 5051 ":make" output will be done. This is useful if you use a 'makeprg' 5052 that writes to 'makeef' by itself. If you want no piping, but do 5053 want to include the 'makeef', set 'shellpipe' to a single space. 5054 Don't forget to precede the space with a backslash: ":set sp=\ ". 5055 In the future pipes may be used for filtering and this option will 5056 become obsolete (at least for Unix). 5057 This option cannot be set from a |modeline| or in the |sandbox|, for 5058 security reasons. 5059 5060 *'shellquote'* *'shq'* 5061'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' 5062 contains "sh" somewhere: "\"") 5063 global 5064 {not in Vi} 5065 Quoting character(s), put around the command passed to the shell, for 5066 the "!" and ":!" commands. The redirection is kept outside of the 5067 quoting. See 'shellxquote' to include the redirection. It's 5068 probably not useful to set both options. 5069 This is an empty string by default. Only known to be useful for 5070 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell 5071 or bash, where it should be "\"". The default is adjusted according 5072 the value of 'shell', to reduce the need to set this option by the 5073 user. See |dos-shell|. 5074 This option cannot be set from a |modeline| or in the |sandbox|, for 5075 security reasons. 5076 5077 *'shellredir'* *'srr'* 5078'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") 5079 global 5080 {not in Vi} 5081 String to be used to put the output of a filter command in a temporary 5082 file. See also |:!|. See |option-backslash| about including spaces 5083 and backslashes. 5084 The name of the temporary file can be represented by "%s" if necessary 5085 (the file name is appended automatically if no %s appears in the value 5086 of this option). 5087 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" 5088 or "zsh" during initializations, the default becomes ">&". If the 5089 'shell' option is "sh", "ksh" or "bash" the default becomes 5090 ">%s 2>&1". This means that stderr is also included. 5091 For Win32, the Unix checks are done and additionally "cmd" is checked 5092 for, which makes the default ">%s 2>&1". Also, the same names with 5093 ".exe" appended are checked for. 5094 The initialization of this option is done after reading the ".vimrc" 5095 and the other initializations, so that when the 'shell' option is set 5096 there, the 'shellredir' option changes automatically unless it was 5097 explicitly set before. 5098 In the future pipes may be used for filtering and this option will 5099 become obsolete (at least for Unix). 5100 This option cannot be set from a |modeline| or in the |sandbox|, for 5101 security reasons. 5102 5103 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* 5104'shellslash' 'ssl' boolean (default off) 5105 global 5106 {not in Vi} {only for MSDOS, MS-Windows and OS/2} 5107 When set, a forward slash is used when expanding file names. This is 5108 useful when a Unix-like shell is used instead of command.com or 5109 cmd.exe. Backward slashes can still be typed, but they are changed to 5110 forward slashes by Vim. 5111 Note that setting or resetting this option has no effect for some 5112 existing file names, thus this option needs to be set before opening 5113 any file for best results. This might change in the future. 5114 'shellslash' only works when a backslash can be used as a path 5115 separator. To test if this is so use: > 5116 if exists('+shellslash') 5117< 5118 *'shelltype'* *'st'* 5119'shelltype' 'st' number (default 0) 5120 global 5121 {not in Vi} {only for the Amiga} 5122 On the Amiga this option influences the way how the commands work 5123 which use a shell. 5124 0 and 1: always use the shell 5125 2 and 3: use the shell only to filter lines 5126 4 and 5: use shell only for ':sh' command 5127 When not using the shell, the command is executed directly. 5128 5129 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands 5130 1 and 3: use "shell cmd" to start external commands 5131 5132 *'shellxquote'* *'sxq'* 5133'shellxquote' 'sxq' string (default: ""; 5134 for Win32, when 'shell' contains "sh" 5135 somewhere: "\"" 5136 for Unix, when using system(): "\"") 5137 global 5138 {not in Vi} 5139 Quoting character(s), put around the command passed to the shell, for 5140 the "!" and ":!" commands. Includes the redirection. See 5141 'shellquote' to exclude the redirection. It's probably not useful 5142 to set both options. 5143 This is an empty string by default. Known to be useful for 5144 third-party shells when using the Win32 version, such as the MKS Korn 5145 Shell or bash, where it should be "\"". The default is adjusted 5146 according the value of 'shell', to reduce the need to set this option 5147 by the user. See |dos-shell|. 5148 This option cannot be set from a |modeline| or in the |sandbox|, for 5149 security reasons. 5150 5151 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* 5152'shiftround' 'sr' boolean (default off) 5153 global 5154 {not in Vi} 5155 Round indent to multiple of 'shiftwidth'. Applies to > and < 5156 commands. CTRL-T and CTRL-D in Insert mode always round the indent to 5157 a multiple of 'shiftwidth' (this is Vi compatible). 5158 NOTE: This option is reset when 'compatible' is set. 5159 5160 *'shiftwidth'* *'sw'* 5161'shiftwidth' 'sw' number (default 8) 5162 local to buffer 5163 Number of spaces to use for each step of (auto)indent. Used for 5164 |'cindent'|, |>>|, |<<|, etc. 5165 5166 *'shortmess'* *'shm'* 5167'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "") 5168 global 5169 {not in Vi} 5170 This option helps to avoid all the |hit-enter| prompts caused by file 5171 messages, for example with CTRL-G, and to avoid some other messages. 5172 It is a list of flags: 5173 flag meaning when present ~ 5174 f use "(3 of 5)" instead of "(file 3 of 5)" 5175 i use "[noeol]" instead of "[Incomplete last line]" 5176 l use "999L, 888C" instead of "999 lines, 888 characters" 5177 m use "[+]" instead of "[Modified]" 5178 n use "[New]" instead of "[New File]" 5179 r use "[RO]" instead of "[readonly]" 5180 w use "[w]" instead of "written" for file write message 5181 and "[a]" instead of "appended" for ':w >> file' command 5182 x use "[dos]" instead of "[dos format]", "[unix]" instead of 5183 "[unix format]" and "[mac]" instead of "[mac format]". 5184 a all of the above abbreviations 5185 5186 o overwrite message for writing a file with subsequent message 5187 for reading a file (useful for ":wn" or when 'autowrite' on) 5188 O message for reading a file overwrites any previous message. 5189 Also for quickfix message (e.g., ":cn"). 5190 s don't give "search hit BOTTOM, continuing at TOP" or "search 5191 hit TOP, continuing at BOTTOM" messages 5192 t truncate file message at the start if it is too long to fit 5193 on the command-line, "<" will appear in the left most column. 5194 Ignored in Ex mode. 5195 T truncate other messages in the middle if they are too long to 5196 fit on the command line. "..." will appear in the middle. 5197 Ignored in Ex mode. 5198 W don't give "written" or "[w]" when writing a file 5199 A don't give the "ATTENTION" message when an existing swap file 5200 is found. 5201 I don't give the intro message when starting Vim |:intro|. 5202 5203 This gives you the opportunity to avoid that a change between buffers 5204 requires you to hit <Enter>, but still gives as useful a message as 5205 possible for the space available. To get the whole message that you 5206 would have got with 'shm' empty, use ":file!" 5207 Useful values: 5208 shm= No abbreviation of message. 5209 shm=a Abbreviation, but no loss of information. 5210 shm=at Abbreviation, and truncate message when necessary. 5211 5212 NOTE: This option is set to the Vi default value when 'compatible' is 5213 set and to the Vim default value when 'compatible' is reset. 5214 5215 *'shortname'* *'sn'* *'noshortname'* *'nosn'* 5216'shortname' 'sn' boolean (default off) 5217 local to buffer 5218 {not in Vi, not in MS-DOS versions} 5219 Filenames are assumed to be 8 characters plus one extension of 3 5220 characters. Multiple dots in file names are not allowed. When this 5221 option is on, dots in file names are replaced with underscores when 5222 adding an extension (".~" or ".swp"). This option is not available 5223 for MS-DOS, because then it would always be on. This option is useful 5224 when editing files on an MS-DOS compatible filesystem, e.g., messydos 5225 or crossdos. When running the Win32 GUI version under Win32s, this 5226 option is always on by default. 5227 5228 *'showbreak'* *'sbr'* *E595* 5229'showbreak' 'sbr' string (default "") 5230 global 5231 {not in Vi} 5232 {not available when compiled without the |+linebreak| 5233 feature} 5234 String to put at the start of lines that have been wrapped. Useful 5235 values are "> " or "+++ ". 5236 Only printable single-cell characters are allowed, excluding <Tab> and 5237 comma (in a future version the comma might be used to separate the 5238 part that is shown at the end and at the start of a line). 5239 The characters are highlighted according to the '@' flag in 5240 'highlight'. 5241 Note that tabs after the showbreak will be displayed differently. 5242 If you want the 'showbreak' to appear in between line numbers, add the 5243 "n" flag to 'cpoptions'. 5244 5245 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* 5246'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default: 5247 off) 5248 global 5249 {not in Vi} 5250 {not available when compiled without the 5251 |+cmdline_info| feature} 5252 Show (partial) command in status line. Set this option off if your 5253 terminal is slow. 5254 In Visual mode the size of the selected area is shown: 5255 - When selecting characters within a line, the number of characters. 5256 - When selecting more than one line, the number of lines. 5257 - When selecting a block, the size in screen characters: linesxcolumns. 5258 NOTE: This option is set to the Vi default value when 'compatible' is 5259 set and to the Vim default value when 'compatible' is reset. 5260 5261 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* 5262'showfulltag' 'sft' boolean (default off) 5263 global 5264 {not in Vi} 5265 When completing a word in insert mode (see |ins-completion|) from the 5266 tags file, show both the tag name and a tidied-up form of the search 5267 pattern (if there is one) as possible matches. Thus, if you have 5268 matched a C function, you can see a template for what arguments are 5269 required (coding style permitting). 5270 5271 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* 5272'showmatch' 'sm' boolean (default off) 5273 global 5274 When a bracket is inserted, briefly jump to the matching one. The 5275 jump is only done if the match can be seen on the screen. The time to 5276 show the match can be set with 'matchtime'. 5277 A Beep is given if there is no match (no matter if the match can be 5278 seen or not). This option is reset when the 'paste' option is set. 5279 When the 'm' flag is not included in 'cpoptions', typing a character 5280 will immediately move the cursor back to where it belongs. 5281 See the "sm" field in 'guicursor' for setting the cursor shape and 5282 blinking when showing the match. 5283 The 'matchpairs' option can be used to specify the characters to show 5284 matches for. 'rightleft' and 'revins' are used to look for opposite 5285 matches. 5286 Note: For the use of the short form parental guidance is advised. 5287 5288 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* 5289'showmode' 'smd' boolean (Vim default: on, Vi default: off) 5290 global 5291 If in Insert, Replace or Visual mode put a message on the last line. 5292 Use the 'M' flag in 'highlight' to set the type of highlighting for 5293 this message. 5294 When |XIM| may be used the message will include "XIM". But this 5295 doesn't mean XIM is really active, especially when 'imactivatekey' is 5296 not set. 5297 NOTE: This option is set to the Vi default value when 'compatible' is 5298 set and to the Vim default value when 'compatible' is reset. 5299 5300 *'sidescroll'* *'ss'* 5301'sidescroll' 'ss' number (default 0) 5302 global 5303 {not in Vi} 5304 The minimal number of columns to scroll horizontally. Used only when 5305 the 'wrap' option is off and the cursor is moved off of the screen. 5306 When it is zero the cursor will be put in the middle of the screen. 5307 When using a slow terminal set it to a large number or 0. When using 5308 a fast terminal use a small number or 1. Not used for "zh" and "zl" 5309 commands. 5310 5311 *'sidescrolloff'* *'siso'* 5312'sidescrolloff' 'siso' number (default 0) 5313 global 5314 {not in Vi} 5315 The minimal number of screen columns to keep to the left and to the 5316 right of the cursor if 'nowrap' is set. Setting this option to a value 5317 greater than 0 while having |'sidescroll'| also at a non-zero value 5318 makes some context visible in the line you are scrolling in 5319 horizontally (except at the end and beginning of the line). Setting 5320 this option to a large value (like 999) has the effect of keeping the 5321 cursor horizontally centered in the window, as long as one does not 5322 come too close to the beginning or end of the line. 5323 NOTE: This option is set to 0 when 'compatible' is set. 5324 5325 Example: Try this together with 'sidescroll' and 'listchars' as 5326 in the following example to never allow the cursor to move 5327 onto the "extends" character: 5328 5329 :set nowrap sidescroll=1 listchars=extends:>,precedes:< 5330 :set sidescrolloff=1 5331 5332 5333 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* 5334'smartcase' 'scs' boolean (default off) 5335 global 5336 {not in Vi} 5337 Override the 'ignorecase' option if the search pattern contains upper 5338 case characters. Only used when the search pattern is typed and 5339 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", 5340 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After 5341 "*" and "#" you can make 'smartcase' used by doing a "/" command, 5342 recalling the search pattern from history and hitting <Enter>. 5343 NOTE: This option is reset when 'compatible' is set. 5344 5345 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* 5346'smartindent' 'si' boolean (default off) 5347 local to buffer 5348 {not in Vi} 5349 {not available when compiled without the 5350 |+smartindent| feature} 5351 Do smart autoindenting when starting a new line. Works for C-like 5352 programs, but can also be used for other languages. 'cindent' does 5353 something like this, works better in most cases, but is more strict, 5354 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect. 5355 'indentexpr' is a more advanced alternative. 5356 Normally 'autoindent' should also be on when using 'smartindent'. 5357 An indent is automatically inserted: 5358 - After a line ending in '{'. 5359 - After a line starting with a keyword from 'cinwords'. 5360 - Before a line starting with '}' (only with the "O" command). 5361 When typing '}' as the first character in a new line, that line is 5362 given the same indent as the matching '{'. 5363 When typing '#' as the first character in a new line, the indent for 5364 that line is removed, the '#' is put in the first column. The indent 5365 is restored for the next line. If you don't want this, use this 5366 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. 5367 When using the ">>" command, lines starting with '#' are not shifted 5368 right. 5369 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste' 5370 is set smart indenting is disabled. 5371 5372 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* 5373'smarttab' 'sta' boolean (default off) 5374 global 5375 {not in Vi} 5376 When on, a <Tab> in front of a line inserts blanks according to 5377 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete 5378 a 'shiftwidth' worth of space at the start of the line. 5379 When off a <Tab> always inserts blanks according to 'tabstop'. 5380 'shiftwidth' is only used for shifting text left or right 5381 |shift-left-right|. 5382 What gets inserted (a Tab or spaces) depends on the 'expandtab' 5383 option. Also see |ins-expandtab|. When 'expandtab' is not set, the 5384 number of spaces is minimized by using <Tab>s. 5385 NOTE: This option is reset when 'compatible' is set. 5386 5387 *'softtabstop'* *'sts'* 5388'softtabstop' 'sts' number (default 0) 5389 local to buffer 5390 {not in Vi} 5391 Number of spaces that a <Tab> counts for while performing editing 5392 operations, like inserting a <Tab> or using <BS>. It "feels" like 5393 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is 5394 used. This is useful to keep the 'ts' setting at its standard value 5395 of 8, while being able to edit like it is set to 'sts'. However, 5396 commands like "x" still work on the actual characters. 5397 When 'sts' is zero, this feature is off. 5398 'softtabstop' is set to 0 when the 'paste' option is set. 5399 See also |ins-expandtab|. When 'expandtab' is not set, the number of 5400 spaces is minimized by using <Tab>s. 5401 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is 5402 set. 5403 NOTE: This option is set to 0 when 'compatible' is set. 5404 5405 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* 5406'splitbelow' 'sb' boolean (default off) 5407 global 5408 {not in Vi} 5409 {not available when compiled without the +windows 5410 feature} 5411 When on, splitting a window will put the new window below the current 5412 one. |:split| 5413 5414 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* 5415'splitright' 'spr' boolean (default off) 5416 global 5417 {not in Vi} 5418 {not available when compiled without the +vertsplit 5419 feature} 5420 When on, splitting a window will put the new window right of the 5421 current one. |:vsplit| 5422 5423 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* 5424'startofline' 'sol' boolean (default on) 5425 global 5426 {not in Vi} 5427 When "on" the commands listed below move the cursor to the first 5428 non-blank of the line. When off the cursor is kept in the same column 5429 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, 5430 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" 5431 with a linewise operator, with "%" with a count and to buffer changing 5432 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that 5433 only has a line number, e.g., ":25" or ":+". 5434 In case of buffer changing commands the cursor is placed at the column 5435 where it was the last time the buffer was edited. 5436 NOTE: This option is set when 'compatible' is set. 5437 5438 *'statusline'* *'stl'* *E540* *E541* *E542* 5439'statusline' 'stl' string (default empty) 5440 global 5441 {not in Vi} 5442 {not available when compiled without the |+statusline| 5443 feature} 5444 When nonempty, this option determines the content of the status line. 5445 Also see |status-line|. 5446 5447 The option consists of printf style '%' items interspersed with 5448 normal text. Each status line item is of the form: 5449 %-0{minwid}.{maxwid}{item} 5450 All fields except the {item} is optional. A single percent sign can 5451 be given as "%%". Up to 80 items can be specified. 5452 5453 Note that the only effect of 'ruler' when this option is set (and 5454 'laststatus' is 2) is controlling the output of |CTRL-G|. 5455 5456 field meaning ~ 5457 - Left justify the item. The default is right justified 5458 when minwid is larger than the length of the item. 5459 0 Leading zeroes in numeric items. Overridden by '-'. 5460 minwid Minimum width of the item, padding as set by '-' & '0'. 5461 Value must be 50 or less. 5462 maxwid Maximum width of the item. Truncation occurs with a '<' 5463 on the left for text items. Numeric items will be 5464 shifted down to maxwid-2 digits followed by '>'number 5465 where number is the amount of missing digits, much like 5466 an exponential notation. 5467 item A one letter code as described below. 5468 5469 Following is a description of the possible statusline items. The 5470 second character in "item" is the type: 5471 N for number 5472 S for string 5473 F for flags as described below 5474 - not applicable 5475 5476 item meaning ~ 5477 f S Path to the file in the buffer, relative to current directory. 5478 F S Full path to the file in the buffer. 5479 t S File name (tail) of file in the buffer. 5480 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off. 5481 M F Modified flag, text is ",+" or ",-". 5482 r F Readonly flag, text is " [RO]". 5483 R F Readonly flag, text is ",RO". 5484 h F Help buffer flag, text is " [help]". 5485 H F Help buffer flag, text is ",HLP". 5486 w F Preview window flag, text is " [Preview]". 5487 W F Preview window flag, text is ",PRV". 5488 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'. 5489 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. 5490 {not available when compiled without |+autocmd| feature} 5491 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are 5492 being used: "<keymap>" 5493 n N Buffer number. 5494 b N Value of byte under cursor. 5495 B N As above, in hexadecimal. 5496 o N Byte number in file of byte under cursor, first byte is 1. 5497 Mnemonic: Offset from start of file (with one added) 5498 {not available when compiled without |+byte_offset| feature} 5499 O N As above, in hexadecimal. 5500 N N Printer page number. (Only works in the 'printheader' option.) 5501 l N Line number. 5502 L N Number of lines in buffer. 5503 c N Column number. 5504 v N Virtual column number. 5505 V N Virtual column number as -{num}. Not displayed if equal to 'c'. 5506 p N Percentage through file in lines as in |CTRL-G|. 5507 P S Percentage through file of displayed window. This is like the 5508 percentage described for 'ruler'. Always 3 in length. 5509 a S Argument list status as in default title. ({current} of {max}) 5510 Empty if the argument file count is zero or one. 5511 { NF Evaluate expression between '{' and '}' and substitute result. 5512 ( - Start of item group. Can be used for setting the width and 5513 alignment of a section. Must be followed by %) somewhere. 5514 ) - End of item group. No width fields allowed. 5515 < - Where to truncate line if too long. Default is at the start. 5516 No width fields allowed. 5517 = - Separation point between left and right aligned items. 5518 No width fields allowed. 5519 * - Set highlight group to User{N}, where {N} is taken from the 5520 minwid field. eg. %1*. Restore normal highlight with %* or %0*. 5521 The difference between User{N} and StatusLine will be applied 5522 to StatusLineNC for the statusline of non-current windows. 5523 The number N must be between 1 and 9. See |hl-User1..9| 5524 5525 Display of flags are controlled by the following heuristic: 5526 If a flag text starts with comma it is assumed that it wants to 5527 separate itself from anything but preceding plaintext. If it starts 5528 with a space it is assumed that it wants to separate itself from 5529 anything but other flags. That is: A leading comma is removed if the 5530 preceding character stems from plaintext. A leading space is removed 5531 if the preceding character stems from another active flag. This will 5532 make a nice display when flags are used like in the examples below. 5533 5534 When all items in a group becomes an empty string (ie. flags that are 5535 not set) and a minwid is not set for the group, the whole group will 5536 become empty. This will make a group like the following disappear 5537 completely from the statusline when none of the flags are set. > 5538 :set statusline=...%(\ [%M%R%H]%)... 5539< 5540 Beware that an expression is evaluated each and every time the status 5541 line is displayed. The current buffer and current window will be set 5542 temporarily to that of the window (and buffer) whose statusline is 5543 currently being drawn. The expression will evaluate in this context. 5544 The variable "actual_curbuf" is set to the 'bufnr()' number of the 5545 real current buffer. The expression is evaluated in the |sandbox|. 5546 5547 If the statusline is not updated when you want it (e.g., after setting 5548 a variable that's used in an expression), you can force an update by 5549 setting an option without changing its value. Example: > 5550 :let &ro = &ro 5551 5552< A result of all digits is regarded a number for display purposes. 5553 Otherwise the result is taken as flag text and applied to the rules 5554 described above. 5555 5556 Watch out for errors in expressions. They may render Vim unusable ! 5557 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and 5558 edit your .vimrc or whatever with "vim -u NONE" to get it right. 5559 5560 Examples: 5561 Emulate standard status line with 'ruler' set > 5562 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P 5563< Similar, but add ASCII value of char under the cursor (like "ga") > 5564 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P 5565< Display byte count and byte value, modified flag in red. > 5566 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' 5567 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red 5568< Display a ,GZ flag if a compressed file is loaded > 5569 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... 5570< In the |:autocmd|'s: > 5571 :let b:gzflag = 1 5572< And: > 5573 :unlet b:gzflag 5574< And define this function: > 5575 :function VarExists(var, val) 5576 : if exists(a:var) | return a:val | else | return '' | endif 5577 :endfunction 5578< 5579 *'suffixes'* *'su'* 5580'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") 5581 global 5582 {not in Vi} 5583 Files with these suffixes get a lower priority when multiple files 5584 match a wildcard. See |suffixes|. Commas can be used to separate the 5585 suffixes. Spaces after the comma are ignored. A dot is also seen as 5586 the start of a suffix. To avoid a dot or comma being recognized as a 5587 separator, precede it with a backslash (see |option-backslash| about 5588 including spaces and backslashes). 5589 See 'wildignore' for completely ignoring files. 5590 The use of |:set+=| and |:set-=| is preferred when adding or removing 5591 suffixes from the list. This avoids problems when a future version 5592 uses another default. 5593 5594 *'suffixesadd'* *'sua'* 5595'suffixesadd' 'sua' string (default "") 5596 local to buffer 5597 {not in Vi} 5598 {not available when compiled without the 5599 |+file_in_path| feature} 5600 Comma separated list of suffixes, which are used when searching for a 5601 file for the "gf", "[I", etc. commands. Example: > 5602 :set suffixesadd=.java 5603< 5604 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* 5605'swapfile' 'swf' boolean (default on) 5606 local to buffer 5607 {not in Vi} 5608 Use a swapfile for the buffer. This option can be reset when a 5609 swapfile is not wanted for a specific buffer. For example, with 5610 confidential information that even root must not be able to access. 5611 Careful: All text will be in memory: 5612 - Don't use this for big files. 5613 - Recovery will be impossible! 5614 A swapfile will only be present when |'updatecount'| is non-zero and 5615 'swapfile' is set. 5616 When 'swapfile' is reset, the swap file for the current buffer is 5617 immediately deleted. When 'swapfile' is set, and 'updatecount' is 5618 non-zero, a swap file is immediately created. 5619 Also see |swap-file| and |'swapsync'|. 5620 5621 This option is used together with 'bufhidden' and 'buftype' to 5622 specify special kinds of buffers. See |special-buffers|. 5623 5624 *'swapsync'* *'sws'* 5625'swapsync' 'sws' string (default "fsync") 5626 global 5627 {not in Vi} 5628 When this option is not empty a swap file is synced to disk after 5629 writing to it. This takes some time, especially on busy unix systems. 5630 When this option is empty parts of the swap file may be in memory and 5631 not written to disk. When the system crashes you may lose more work. 5632 On Unix the system does a sync now and then without Vim asking for it, 5633 so the disadvantage of setting this option off is small. On some 5634 systems the swap file will not be written at all. For a unix system 5635 setting it to "sync" will use the sync() call instead of the default 5636 fsync(), which may work better on some systems. 5637 5638 *'switchbuf'* *'swb'* 5639'switchbuf' 'swb' string (default "") 5640 global 5641 {not in Vi} 5642 This option controls the behavior when switching between buffers. 5643 Possible values (comma separated list): 5644 useopen If included, jump to the first open window that 5645 contains the specified buffer (if there is one). 5646 Otherwise: Do not examine other windows. 5647 This setting is checked with |quickfix| commands, when 5648 jumping to errors (":cc", ":cn", "cp", etc.). It is 5649 also used in all buffer related split commands, for 5650 example ":sbuffer", ":sbnext", or ":sbrewind". 5651 split If included, split the current window before loading 5652 a buffer. Otherwise: do not split, use current window. 5653 Supported in |quickfix| commands that display errors. 5654 5655 *'syntax'* *'syn'* 5656'syntax' 'syn' string (default empty) 5657 local to buffer 5658 {not in Vi} 5659 {not available when compiled without the |+syntax| 5660 feature} 5661 When this option is set, the syntax with this name is loaded, unless 5662 syntax highlighting has been switched off with ":syntax off". 5663 Otherwise this option does not always reflect the current syntax (the 5664 b:current_syntax variable does). 5665 This option is most useful in a modeline, for a file which syntax is 5666 not automatically recognized. Example, for in an IDL file: > 5667 /* vim: set syntax=idl : */ 5668< To switch off syntax highlighting for the current file, use: > 5669 :set syntax=OFF 5670< To switch syntax highlighting on according to the current value of the 5671 'filetype' option: > 5672 :set syntax=ON 5673< What actually happens when setting the 'syntax' option is that the 5674 Syntax autocommand event is triggered with the value as argument. 5675 This option is not copied to another buffer, independent of the 's' or 5676 'S' flag in 'cpoptions'. 5677 5678 *'tabstop'* *'ts'* 5679'tabstop' 'ts' number (default 8) 5680 local to buffer 5681 Number of spaces that a <Tab> in the file counts for. Also see 5682 |:retab| command, and 'softtabstop' option. 5683 5684 Note: Setting 'tabstop' to any other value than 8 can make your file 5685 appear wrong in many places (e.g., when printing it). 5686 5687 There are four main ways to use tabs in Vim: 5688 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 5689 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim 5690 will use a mix of tabs and spaces, but typing Tab and BS will 5691 behave like a tab appears every 4 (or 3) characters. 5692 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use 5693 'expandtab'. This way you will always insert spaces. The 5694 formatting will never be messed up when 'tabstop' is changed. 5695 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a 5696 |modeline| to set these values when editing the file again. Only 5697 works when using Vim to edit the file. 5698 4. Always set 'tabstop' and 'shiftwidth' to the same value, and 5699 'noexpandtab'. This should then work (for initial indents only) 5700 for any tabstop setting that people use. It might be nice to have 5701 tabs after the first non-blank inserted as spaces if you do this 5702 though. Otherwise aligned comments will be wrong when 'tabstop' is 5703 changed. 5704 5705 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* 5706'tagbsearch' 'tbs' boolean (default on) 5707 global 5708 {not in Vi} 5709 When searching for a tag (e.g., for the |:ta| command), Vim can either 5710 use a binary search or a linear search in a tags file. Binary 5711 searching makes searching for a tag a LOT faster, but a linear search 5712 will find more tags if the tags file wasn't properly sorted. 5713 Vim normally assumes that your tags files are sorted, or indicate that 5714 they are not sorted. Only when this is not the case does the 5715 'tagbsearch' option need to be switched off. 5716 5717 When 'tagbsearch' is on, binary searching is first used in the tags 5718 files. In certain situations, Vim will do a linear search instead for 5719 certain files, or retry all files with a linear search. When 5720 'tagbsearch' is off, only a linear search is done. 5721 5722 Linear searching is done anyway, for one file, when Vim finds a line 5723 at the start of the file indicating that it's not sorted: > 5724 !_TAG_FILE_SORTED 0 /some command/ 5725< [The whitespace before and after the '0' must be a single <Tab>] 5726 5727 When a binary search was done and no match was found in any of the 5728 files listed in 'tags', and 'ignorecase' is set or a pattern is used 5729 instead of a normal tag name, a retry is done with a linear search. 5730 Tags in unsorted tags files, and matches with different case will only 5731 be found in the retry. 5732 5733 If a tag file indicates that is is case-fold sorted, the second, 5734 linear search can be avoided for the 'ignorecase' case. Use a value 5735 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be 5736 case-fold sorted with the -f switch to "sort" in most unices, as in 5737 the command: "sort -f -o tags tags". For "Exuberant ctags" version 5738 5.3 or higher the -f or --fold-case-sort switch can be used for this 5739 as well. Note that case must be folded to uppercase for this to work. 5740 5741 When 'tagbsearch' is off, tags searching is slower when a full match 5742 exists, but faster when no full match exists. Tags in unsorted tags 5743 files may only be found with 'tagbsearch' off. 5744 When the tags file is not sorted, or sorted in a wrong way (not on 5745 ASCII byte value), 'tagbsearch' should be off, or the line given above 5746 must be included in the tags file. 5747 This option doesn't affect commands that find all matching tags (e.g., 5748 command-line completion and ":help"). 5749 {Vi: always uses binary search in some versions} 5750 5751 *'taglength'* *'tl'* 5752'taglength' 'tl' number (default 0) 5753 global 5754 If non-zero, tags are significant up to this number of characters. 5755 5756 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* 5757'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) 5758 global 5759 {not in Vi} 5760 If on and using a tag file in another directory, file names in that 5761 tag file are relative to the directory where the tag file is. 5762 NOTE: This option is set to the Vi default value when 'compatible' is 5763 set and to the Vim default value when 'compatible' is reset. 5764 5765 *'tags'* *'tag'* *E433* 5766'tags' 'tag' string (default "./tags,tags", when compiled with 5767 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") 5768 global or local to buffer |global-local| 5769 Filenames for the tag command, separated by spaces or commas. To 5770 include a space or comma in a file name, precede it with a backslash 5771 (see |option-backslash| about including spaces and backslashes). 5772 When a file name starts with "./", the '.' is replaced with the path 5773 of the current file. But only when the 'd' flag is not included in 5774 'cpoptions'. Environment variables are expanded |:set_env|. Also see 5775 |tags-option|. 5776 "*", "**" and other wildcards can be used to search for tags files in 5777 a directory tree. See |file-searching|. {not available when compiled 5778 without the |+path_extra| feature} 5779 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag 5780 files are also supported. They are automatically recognized. The 5781 default value becomes "./tags,./TAGS,tags,TAGS", unless case 5782 differences are ignored (MS-Windows). |emacs-tags| 5783 The use of |:set+=| and |:set-=| is preferred when adding or removing 5784 file names from the list. This avoids problems when a future version 5785 uses another default. 5786 {Vi: default is "tags /usr/lib/tags"} 5787 5788 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* 5789'tagstack' 'tgst' boolean (default on) 5790 global 5791 {not in all versions of Vi} 5792 When on, the |tagstack| is used normally. When off, a ":tag" or 5793 ":tselect" command with an argument will not push the tag onto the 5794 tagstack. A following ":tag" without an argument, a ":pop" command or 5795 any other command that uses the tagstack will use the unmodified 5796 tagstack, but does change the pointer to the active entry. 5797 Resetting this option is useful when using a ":tag" command in a 5798 mapping which should not change the tagstack. 5799 5800 *'term'* *E529* *E530* *E531* 5801'term' string (default is $TERM, if that fails: 5802 in the GUI: "builtin_gui" 5803 on Amiga: "amiga" 5804 on BeOS: "beos-ansi" 5805 on Mac: "mac-ansi" 5806 on MiNT: "vt52" 5807 on MS-DOS: "pcterm" 5808 on OS/2: "os2ansi" 5809 on Unix: "ansi" 5810 on VMS: "ansi" 5811 on Win 32: "win32") 5812 global 5813 Name of the terminal. Used for choosing the terminal control 5814 characters. Environment variables are expanded |:set_env|. 5815 For example: > 5816 :set term=$TERM 5817< See |termcap|. 5818 5819 *'termbidi'* *'tbidi'* 5820 *'notermbidi'* *'notbidi'* 5821'termbidi' 'tbidi' boolean (default off, on for "mlterm") 5822 global 5823 {not in Vi} 5824 {only available when compiled with the |+arabic| 5825 feature} 5826 The terminal is in charge of Bi-directionality of text (as specified 5827 by Unicode). The terminal is also expected to do the required shaping 5828 that some languages (such as Arabic) require. 5829 Setting this option implies that 'rightleft' will not be set when 5830 'arabic' is set and the value of 'arabicshape' will be ignored. 5831 Note that setting 'termbidi' has the immediate effect that 5832 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. 5833 This option is reset when the GUI is started. 5834 For further details see |arabic.txt|. 5835 5836 *'termencoding'* *'tenc'* 5837'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with 5838 Macintosh GUI: "macroman") 5839 global 5840 {only available when compiled with the |+multi_byte| 5841 feature} 5842 {not in Vi} 5843 Encoding used for the terminal. This specifies what character 5844 encoding the keyboard produces and the display will understand. For 5845 the GUI it only applies to the keyboard ('encoding' is used for the 5846 display). 5847 In the Win32 console version the default value is the console codepage 5848 when it differs from the ANSI codepage. 5849 *E617* 5850 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been 5851 successfully initialized, 'termencoding' is forcibly set to "utf-8". 5852 Any attempts to set a different value will be rejected, and an error 5853 message is shown. 5854 For the Win32 GUI 'termencoding' is not used for typed characters, 5855 because the Win32 system always passes Unicode characters. 5856 When empty, the same encoding is used as for the 'encoding' option. 5857 This is the normal value. 5858 Not all combinations for 'termencoding' and 'encoding' are valid. See 5859 |encoding-table|. 5860 The value for this option must be supported by internal conversions or 5861 iconv(). When this is not possible no conversion will be done and you 5862 will probably experience problems with non-ASCII characters. 5863 Example: You are working with the locale set to euc-jp (Japanese) and 5864 want to edit a UTF-8 file: > 5865 :let &termencoding = &encoding 5866 :set encoding=utf-8 5867< You need to do this when your system has no locale support for UTF-8. 5868 5869 *'terse'* *'noterse'* 5870'terse' boolean (default off) 5871 global 5872 When set: Add 's' flag to 'shortmess' option (this makes the message 5873 for a search that hits the start or end of the file not being 5874 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi 5875 shortens a lot of messages} 5876 5877 *'textauto'* *'ta'* *'notextauto'* *'nota'* 5878'textauto' 'ta' boolean (Vim default: on, Vi default: off) 5879 global 5880 {not in Vi} 5881 This option is obsolete. Use 'fileformats'. 5882 For backwards compatibility, when 'textauto' is set, 'fileformats' is 5883 set to the default value for the current system. When 'textauto' is 5884 reset, 'fileformats' is made empty. 5885 NOTE: This option is set to the Vi default value when 'compatible' is 5886 set and to the Vim default value when 'compatible' is reset. 5887 5888 *'textmode'* *'tx'* *'notextmode'* *'notx'* 5889'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, 5890 others: default off) 5891 local to buffer 5892 {not in Vi} 5893 This option is obsolete. Use 'fileformat'. 5894 For backwards compatibility, when 'textmode' is set, 'fileformat' is 5895 set to "dos". When 'textmode' is reset, 'fileformat' is set to 5896 "unix". 5897 5898 *'textwidth'* *'tw'* 5899'textwidth' 'tw' number (default 0) 5900 local to buffer 5901 {not in Vi} 5902 Maximum width of text that is being inserted. A longer line will be 5903 broken after white space to get this width. A zero value disables 5904 this. 'textwidth' is set to 0 when the 'paste' option is set. When 5905 'textwidth' is zero, 'wrapmargin' may be used. See also 5906 'formatoptions' and |ins-textwidth|. 5907 NOTE: This option is set to 0 when 'compatible' is set. 5908 5909 *'thesaurus'* *'tsr'* 5910'thesaurus' 'tsr' string (default "") 5911 global or local to buffer |global-local| 5912 {not in Vi} 5913 List of file names, separated by commas, that are used to lookup words 5914 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in 5915 the file should contain words with similar meaning, separated by 5916 non-keyword characters (white space is preferred). Maximum line 5917 length is 510 bytes. 5918 To obtain a file to be used here, check out the wordlist FAQ at 5919 http://www.hyphenologist.co.uk . 5920 To include a comma in a file name precede it with a backslash. Spaces 5921 after a comma are ignored, otherwise spaces are included in the file 5922 name. See |option-backslash| about using backslashes. 5923 The use of |:set+=| and |:set-=| is preferred when adding or removing 5924 directories from the list. This avoids problems when a future version 5925 uses another default. 5926 Backticks cannot be used in this option for security reasons. 5927 5928 *'tildeop'* *'top'* *'notildeop'* *'notop'* 5929'tildeop' 'top' boolean (default off) 5930 global 5931 {not in Vi} 5932 When on: The tilde command "~" behaves like an operator. 5933 NOTE: This option is reset when 'compatible' is set. 5934 5935 *'timeout'* *'to'* *'notimeout'* *'noto'* 5936'timeout' 'to' boolean (default on) 5937 global 5938 *'ttimeout'* *'nottimeout'* 5939'ttimeout' boolean (default off) 5940 global 5941 {not in Vi} 5942 These two options together determine the behavior when part of a 5943 mapped key sequence or keyboard code has been received: 5944 5945 'timeout' 'ttimeout' action ~ 5946 off off do not time out 5947 on on or off time out on :mappings and key codes 5948 off on time out on key codes 5949 5950 If both options are off, Vim will wait until either the complete 5951 mapping or key sequence has been received, or it is clear that there 5952 is no mapping or key sequence for the received characters. For 5953 example: if you have mapped "vl" and Vim has received 'v', the next 5954 character is needed to see if the 'v' is followed by an 'l'. 5955 When one of the options is on, Vim will wait for about 1 second for 5956 the next character to arrive. After that the already received 5957 characters are interpreted as single characters. The waiting time can 5958 be changed with the 'timeoutlen' option. 5959 On slow terminals or very busy systems timing out may cause 5960 malfunctioning cursor keys. If both options are off, Vim waits 5961 forever after an entered <Esc> if there are key codes that start 5962 with <Esc>. You will have to type <Esc> twice. If you do not have 5963 problems with key codes, but would like to have :mapped key 5964 sequences not timing out in 1 second, set the 'ttimeout' option and 5965 reset the 'timeout' option. 5966 5967 NOTE: 'ttimeout' is reset when 'compatible' is set. 5968 5969 *'timeoutlen'* *'tm'* 5970'timeoutlen' 'tm' number (default 1000) 5971 global 5972 {not in all versions of Vi} 5973 *'ttimeoutlen'* *'ttm'* 5974'ttimeoutlen' 'ttm' number (default -1) 5975 global 5976 {not in Vi} 5977 The time in milliseconds that is waited for a key code or mapped key 5978 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G 5979 when part of a command has been typed. 5980 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a 5981 different timeout value for key codes is desired set 'ttimeoutlen' to 5982 a non-negative number. 5983 5984 ttimeoutlen mapping delay key code delay ~ 5985 < 0 'timeoutlen' 'timeoutlen' 5986 >= 0 'timeoutlen' 'ttimeoutlen' 5987 5988 The timeout only happens when the 'timeout' and 'ttimeout' options 5989 tell so. A useful setting would be > 5990 :set timeout timeoutlen=3000 ttimeoutlen=100 5991< (time out on mapping after three seconds, time out on key codes after 5992 a tenth of a second). 5993 5994 *'title'* *'notitle'* 5995'title' boolean (default off, on when title can be restored) 5996 global 5997 {not in Vi} 5998 {not available when compiled without the |+title| 5999 feature} 6000 When on, the title of the window will be set to the value of 6001 'titlestring' (if it is not empty), or to: 6002 filename [+=-] (path) - VIM 6003 Where: 6004 filename the name of the file being edited 6005 - indicates the file cannot be modified, 'ma' off 6006 + indicates the file was modified 6007 = indicates the file is read-only 6008 =+ indicates the file is read-only and modified 6009 (path) is the path of the file being edited 6010 - VIM the server name |v:servername| or "VIM" 6011 Only works if the terminal supports setting window titles 6012 (currently Amiga console, Win32 console, all GUI versions and 6013 terminals with a non- empty 't_ts' option - these are Unix xterm and 6014 iris-ansi by default, where 't_ts' is taken from the builtin termcap). 6015 *X11* 6016 When Vim was compiled with HAVE_X11 defined, the original title will 6017 be restored if possible. The output of ":version" will include "+X11" 6018 when HAVE_X11 was defined, otherwise it will be "-X11". This also 6019 works for the icon name |'icon'|. 6020 But: When Vim was started with the |-X| argument, restoring the title 6021 will not work (except in the GUI). 6022 If the title cannot be restored, it is set to the value of 'titleold'. 6023 You might want to restore the title outside of Vim then. 6024 When using an xterm from a remote machine you can use this command: 6025 rsh machine_name xterm -display $DISPLAY & 6026 then the WINDOWID environment variable should be inherited and the 6027 title of the window should change back to what it should be after 6028 exiting Vim. 6029 6030 *'titlelen'* 6031'titlelen' number (default 85) 6032 global 6033 {not in Vi} 6034 {not available when compiled without the |+title| 6035 feature} 6036 Gives the percentage of 'columns' to use for the length of the window 6037 title. When the title is longer, only the end of the path name is 6038 shown. A '<' character before the path name is used to indicate this. 6039 Using a percentage makes this adapt to the width of the window. But 6040 it won't work perfectly, because the actual number of characters 6041 available also depends on the font used and other things in the title 6042 bar. When 'titlelen' is zero the full path is used. Otherwise, 6043 values from 1 to 30000 percent can be used. 6044 'titlelen' is also used for the 'titlestring' option. 6045 6046 *'titleold'* 6047'titleold' string (default "Thanks for flying Vim") 6048 global 6049 {not in Vi} 6050 {only available when compiled with the |+title| 6051 feature} 6052 This option will be used for the window title when exiting Vim if the 6053 original title cannot be restored. Only happens if 'title' is on or 6054 'titlestring' is not empty. 6055 *'titlestring'* 6056'titlestring' string (default "") 6057 global 6058 {not in Vi} 6059 {not available when compiled without the |+title| 6060 feature} 6061 When this option is not empty, it will be used for the title of the 6062 window. This happens only when the 'title' option is on. 6063 Only works if the terminal supports setting window titles (currently 6064 Amiga console, Win32 console, all GUI versions and terminals with a 6065 non-empty 't_ts' option). 6066 When Vim was compiled with HAVE_X11 defined, the original title will 6067 be restored if possible |X11|. 6068 When this option contains printf-style '%' items, they will be 6069 expanded according to the rules used for 'statusline'. 6070 Example: > 6071 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") 6072 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 6073< The value of 'titlelen' is used to align items in the middle or right 6074 of the available space. 6075 Some people prefer to have the file name first: > 6076 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) 6077< Note the use of "%{ }" and an expression to get the path of the file, 6078 without the file name. The "%( %)" constructs are used to add a 6079 separating space only when needed. 6080 NOTE: Use of special characters in 'titlestring' may cause the display 6081 to be garbled (e.g., when it contains a CR or NL character). 6082 {not available when compiled without the |+statusline| feature} 6083 6084 *'toolbar'* *'tb'* 6085'toolbar' 'tb' string (default "icons,tooltips") 6086 global 6087 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and 6088 |+GUI_Photon|} 6089 The contents of this option controls various toolbar settings. The 6090 possible values are: 6091 icons Toolbar buttons are shown with icons. 6092 text Toolbar buttons shown with text. 6093 horiz Icon and text of a toolbar button are 6094 horizontally arranged. {only in GTK+ 2 GUI} 6095 tooltips Tooltips are active for toolbar buttons. 6096 Tooltips refer to the popup help text which appears after the mouse 6097 cursor is placed over a toolbar button for a brief moment. 6098 6099 If you want the toolbar to be shown with icons as well as text, do the 6100 following: > 6101 :set tb=icons,text 6102< Motif and Athena cannot display icons and text at the same time. They 6103 will show icons if both are requested. 6104 6105 If none of the strings specified in 'toolbar' are valid or if 6106 'toolbar' is empty, this option is ignored. If you want to disable 6107 the toolbar, you need to set the 'guioptions' option. For example: > 6108 :set guioptions-=T 6109< Also see |gui-toolbar|. 6110 6111 *'toolbariconsize'* *'tbis'* 6112'toolbariconsize' 'tbis' string (default "small") 6113 global 6114 {not in Vi} 6115 {only in the GTK+ 2 GUI} 6116 Controls the size of toolbar icons. The possible values are: 6117 tiny Use tiny toolbar icons. 6118 small Use small toolbar icons (default). 6119 medium Use medium-sized toolbar icons. 6120 large Use large toolbar icons. 6121 The exact dimensions in pixels of the various icon sizes depend on 6122 the current theme. Common dimensions are large=32x32, medium=24x24, 6123 small=20x20 and tiny=16x16. 6124 6125 If 'toolbariconsize' is empty, the global default size as determined 6126 by user preferences or the current theme is used. 6127 6128 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* 6129'ttybuiltin' 'tbi' boolean (default on) 6130 global 6131 {not in Vi} 6132 When on, the builtin termcaps are searched before the external ones. 6133 When off the builtin termcaps are searched after the external ones. 6134 When this option is changed, you should set the 'term' option next for 6135 the change to take effect, for example: > 6136 :set notbi term=$TERM 6137< See also |termcap|. 6138 Rationale: The default for this option is "on", because the builtin 6139 termcap entries are generally better (many systems contain faulty 6140 xterm entries...). 6141 6142 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* 6143'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, 6144 sun-cmd, screen, rxvt, dtterm or 6145 iris-ansi; also on when running Vim in 6146 a DOS console) 6147 global 6148 {not in Vi} 6149 Indicates a fast terminal connection. More characters will be sent to 6150 the screen for redrawing, instead of using insert/delete line 6151 commands. Improves smoothness of redrawing when there are multiple 6152 windows and the terminal does not support a scrolling region. 6153 Also enables the extra writing of characters at the end of each screen 6154 line for lines that wrap. This helps when using copy/paste with the 6155 mouse in an xterm and other terminals. 6156 6157 *'ttymouse'* *'ttym'* 6158'ttymouse' 'ttym' string (default depends on 'term') 6159 global 6160 {not in Vi} 6161 {only in Unix and VMS, doesn't work in the GUI; not 6162 available when compiled without |+mouse|} 6163 Name of the terminal type for which mouse codes are to be recognized. 6164 Currently these three strings are valid: 6165 *xterm-mouse* 6166 xterm xterm-like mouse handling. The mouse generates 6167 "<Esc>[Mscr", where "scr" is three bytes: 6168 "s" = button state 6169 "c" = column plus 33 6170 "r" = row plus 33 6171 xterm2 Works like "xterm", but with the xterm reporting the 6172 mouse position while the mouse is dragged. This works 6173 much faster and more precise. Your xterm must at 6174 least at patchlevel 88 / XFree 3.3.3 for this to 6175 work. See below for how Vim detects this 6176 automatically. 6177 *netterm-mouse* 6178 netterm NetTerm mouse handling. The mouse generates 6179 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers 6180 for the row and column. 6181 *dec-mouse* 6182 dec DEC terminal mouse handling. The mouse generates a 6183 rather complex sequence, starting with "<Esc>[". 6184 *jsbterm-mouse* 6185 jsbterm JSB term mouse handling. 6186 *pterm-mouse* 6187 pterm QNX pterm mouse handling. 6188 6189 The mouse handling must be enabled at compile time |+mouse_xterm| 6190 |+mouse_dec| |+mouse_netterm|. 6191 Only "xterm"(2) is really recognized. NetTerm mouse codes are always 6192 recognized, if enabled at compile time. DEC terminal mouse codes 6193 are recognized if enabled at compile time, and 'ttymouse' is not 6194 "xterm" (because the xterm and dec mouse codes conflict). 6195 This option is automatically set to "xterm", when the 'term' option is 6196 set to a name that starts with "xterm", and 'ttymouse' is not "xterm" 6197 or "xterm2" already. The main use of this option is to set it to 6198 "xterm", when the terminal name doesn't start with "xterm", but it can 6199 handle xterm mouse codes. 6200 The "xterm2" value will be set if the xterm version is reported to be 6201 95 of higher. This only works when compiled with the |+termresponse| 6202 feature and if |t_RV| is set to the escape sequence to request the 6203 xterm version number. Otherwise "xterm2" must be set explicitly. 6204 If you do not want 'ttymouse' to be set to "xterm2" automatically, set 6205 t_RV to an empty string: > 6206 :set t_RV= 6207< 6208 *'ttyscroll'* *'tsl'* 6209'ttyscroll' 'tsl' number (default 999) 6210 global 6211 Maximum number of lines to scroll the screen. If there are more lines 6212 to scroll the window is redrawn. For terminals where scrolling is 6213 very slow and redrawing is not slow this can be set to a small number, 6214 e.g., 3, to speed up displaying. 6215 6216 *'ttytype'* *'tty'* 6217'ttytype' 'tty' string (default from $TERM) 6218 global 6219 Alias for 'term', see above. 6220 6221 *'undolevels'* *'ul'* 6222'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, 6223 Win32 and OS/2) 6224 global 6225 {not in Vi} 6226 Maximum number of changes that can be undone. Since undo information 6227 is kept in memory, higher numbers will cause more memory to be used 6228 (nevertheless, a single change can use an unlimited amount of memory). 6229 Set to 0 for Vi compatibility: One level of undo and "u" undoes 6230 itself: > 6231 set ul=0 6232< But you can also get Vi compatibility by including the 'u' flag in 6233 'cpoptions', and still be able to use CTRL-R to repeat undo. 6234 Set to a negative number for no undo at all: > 6235 set ul=-1 6236< This helps when you run out of memory for a single change. 6237 Also see |undo-two-ways|. 6238 6239 *'updatecount'* *'uc'* 6240'updatecount' 'uc' number (default: 200) 6241 global 6242 {not in Vi} 6243 After typing this many characters the swap file will be written to 6244 disk. When zero, no swap file will be created at all (see chapter on 6245 recovery |crash-recovery|). 'updatecount' is set to zero by starting 6246 Vim with the "-n" option, see |startup|. When editing in readonly 6247 mode this option will be initialized to 10000. 6248 The swapfile can be disabled per buffer with |'swapfile'|. 6249 When 'updatecount' is set from zero to non-zero, swap files are 6250 created for all buffers that have 'swapfile' set. When 'updatecount' 6251 is set to zero, existing swap files are not deleted. 6252 Also see |'swapsync'|. 6253 This option has no meaning in buffers where |'buftype'| is "nofile" 6254 or "nowrite". 6255 6256 *'updatetime'* *'ut'* 6257'updatetime' 'ut' number (default 4000) 6258 global 6259 {not in Vi} 6260 If this many milliseconds nothing is typed the swap file will be 6261 written to disk (see |crash-recovery|). Also used for the 6262 |CursorHold| autocommand event. 6263 6264 *'verbose'* *'vbs'* 6265'verbose' 'vbs' number (default 0) 6266 global 6267 {not in Vi, although some versions have a boolean 6268 verbose option} 6269 When bigger than zero, Vim will give messages about what it is doing. 6270 Currently, these messages are given: 6271 >= 1 When the viminfo file is read or written. 6272 >= 2 When a file is ":source"'ed. 6273 >= 5 Every searched tags file. 6274 >= 8 Files for which a group of autocommands is executed. 6275 >= 9 Every executed autocommand. 6276 >= 12 Every executed function. 6277 >= 13 When an exception is thrown, caught, finished, or discarded. 6278 >= 14 Anything pending in a ":finally" clause. 6279 >= 15 Every executed Ex command (truncated at 200 characters). 6280 6281 This option can also be set with the "-V" argument. See |-V|. 6282 This option is also set by the |:verbose| command. 6283 6284 *'viewdir'* *'vdir'* 6285'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: 6286 "$VIM/vimfiles/view", 6287 for Unix: "~/.vim/view", 6288 for Macintosh: "$VIM:vimfiles:view" 6289 for VMS: "sys$login:vimfiles/view" 6290 for RiscOS: "Choices:vimfiles/view") 6291 global 6292 {not in Vi} 6293 {not available when compiled without the +mksession 6294 feature} 6295 Name of the directory where to store files for |:mkview|. 6296 This option cannot be set from a |modeline| or in the |sandbox|, for 6297 security reasons. 6298 6299 *'viewoptions'* *'vop'* 6300'viewoptions' 'vop' string (default: "folds,options,cursor") 6301 global 6302 {not in Vi} 6303 {not available when compiled without the +mksession 6304 feature} 6305 Changes the effect of the |:mkview| command. It is a comma separated 6306 list of words. Each word enables saving and restoring something: 6307 word save and restore ~ 6308 cursor cursor position in file and in window 6309 folds manually created folds, opened/closed folds and local 6310 fold options 6311 options options and mappings local to a window or buffer (not 6312 global values for local options) 6313 slash backslashes in file names replaced with forward 6314 slashes 6315 unix with Unix end-of-line format (single <NL>), even when 6316 on Windows or DOS 6317 6318 "slash" and "unix" are useful on Windows when sharing view files 6319 with Unix. The Unix version of Vim cannot source dos format scripts, 6320 but the Windows version of Vim can source unix format scripts. 6321 6322 *'viminfo'* *'vi'* *E526* *E527* *E528* 6323'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, 6324 Windows and OS/2: '20,<50,s10,h,rA:,rB:, 6325 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2: 6326 for others: '20,<50,s10,h) 6327 global 6328 {not in Vi} 6329 {not available when compiled without the |+viminfo| 6330 feature} 6331 When non-empty, the viminfo file is read upon startup and written 6332 when exiting Vim (see |viminfo-file|). The string should be a comma 6333 separated list of parameters, each consisting of a single character 6334 identifying the particular parameter, followed by a number or string 6335 which specifies the value of that parameter. If a particular 6336 character is left out, then the default value is used for that 6337 parameter. The following is a list of the identifying characters and 6338 the effect of their value. 6339 CHAR VALUE ~ 6340 ! When included, save and restore global variables that start 6341 with an uppercase letter, and don't contain a lowercase 6342 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" 6343 and "_K_L_M" are not. 6344 " Maximum number of lines saved for each register. Old name of 6345 the '<' item, with the disadvantage that you need to put a 6346 backslash before the ", otherwise it will be recognized as the 6347 start of a comment! 6348 % When included, save and restore the buffer list. If Vim is 6349 started with a file name argument, the buffer list is not 6350 restored. If Vim is started without a file name argument, the 6351 buffer list is restored from the viminfo file. Buffers 6352 without a file name and buffers for help files are not written 6353 to the viminfo file. 6354 ' Maximum number of previously edited files for which the marks 6355 are remembered. This parameter must always be included when 6356 'viminfo' is non-empty. 6357 Including this item also means that the |jumplist| and the 6358 |changelist| are stored in the viminfo file. 6359 / Maximum number of items in the search pattern history to be 6360 saved. If non-zero, then the previous search and substitute 6361 patterns are also saved. When not included, the value of 6362 'history' is used. 6363 : Maximum number of items in the command-line history to be 6364 saved. When not included, the value of 'history' is used. 6365 < Maximum number of lines saved for each register. If zero then 6366 registers are not saved. When not included, all lines are 6367 saved. '"' is the old name for this item. 6368 Also see the 's' item below: limit specified in Kbyte. 6369 @ Maximum number of items in the input-line history to be 6370 saved. When not included, the value of 'history' is used. 6371 c When included, convert the text in the viminfo file from the 6372 'encoding' used when writing the file to the current 6373 'encoding'. See |viminfo-encoding|. 6374 f Whether file marks need to be stored. If zero, file marks ('0 6375 to '9, 'A to 'Z) are not stored. When not present or when 6376 non-zero, they are all stored. '0 is used for the current 6377 cursor position (when exiting or when doing ":wviminfo"). 6378 h Disable the effect of 'hlsearch' when loading the viminfo 6379 file. When not included, it depends on whether ":nohlsearch" 6380 has been used since the last search command. 6381 n Name of the viminfo file. The name must immediately follow 6382 the 'n'. Must be the last one! If the "-i" argument was 6383 given when starting Vim, that file name overrides the one 6384 given here with 'viminfo'. Environment variables are expanded 6385 when opening the file, not when setting the option. 6386 r Removable media. The argument is a string (up to the next 6387 ','). This parameter can be given several times. Each 6388 specifies the start of a path for which no marks will be 6389 stored. This is to avoid removable media. For MS-DOS you 6390 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can 6391 also use it for temp files, e.g., for Unix: "r/tmp". Case is 6392 ignored. Maximum length of each 'r' argument is 50 6393 characters. 6394 s Maximum size of an item in Kbyte. If zero then registers are 6395 not saved. Currently only applies to registers. The default 6396 "s10" will exclude registers with more than 10 Kbyte of text. 6397 Also see the '<' item above: line count limit. 6398 6399 Example: > 6400 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo 6401< 6402 '50 Marks will be remembered for the last 50 files you 6403 edited. 6404 <1000 Contents of registers (up to 1000 lines each) will be 6405 remembered. 6406 s100 Registers with more than 100 Kbyte text are skipped. 6407 :0 Command-line history will not be saved. 6408 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". 6409 no / Since '/' is not specified, the default will be used, 6410 that is, save all of the search history, and also the 6411 previous search and substitute patterns. 6412 no % The buffer list will not be saved nor read back. 6413 no h 'hlsearch' highlighting will be restored. 6414 6415 When setting 'viminfo' from an empty value you can use |:rviminfo| to 6416 load the contents of the file, this is not done automatically. 6417 6418 This option cannot be set from a |modeline| or in the |sandbox|, for 6419 security reasons. 6420 6421 *'virtualedit'* *'ve'* 6422'virtualedit' 've' string (default "") 6423 global 6424 {not in Vi} 6425 {not available when compiled without the 6426 |+virtualedit| feature} 6427 A comma separated list of these words: 6428 block Allow virtual editing in Visual block mode. 6429 insert Allow virtual editing in Insert mode. 6430 all Allow virtual editing in all modes. 6431 Virtual editing means that the cursor can be positioned where there is 6432 no actual character. This can be halfway into a Tab or beyond the end 6433 of the line. Useful for selecting a rectangle in Visual mode and 6434 editing a table. 6435 6436 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* 6437'visualbell' 'vb' boolean (default off) 6438 global 6439 {not in Vi} 6440 Use visual bell instead of beeping. The terminal code to display the 6441 visual bell is given with 't_vb'. When no beep or flash is wanted, 6442 use ":set vb t_vb=". 6443 Note: When the GUI starts, 't_vb' is reset to its default value. You 6444 might want to set it again in your |gvimrc|. 6445 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display 6446 for 20 msec. If you want to use a different time, use "<Esc>|40f", 6447 where 40 is the time in msec. 6448 Does not work on the Amiga, you always get a screen flash. 6449 Also see 'errorbells'. 6450 6451 *'warn'* *'nowarn'* 6452'warn' boolean (default on) 6453 global 6454 Give a warning message when a shell command is used while the buffer 6455 has been changed. 6456 6457 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* 6458'weirdinvert' 'wiv' boolean (default off) 6459 global 6460 {not in Vi} 6461 This option has the same effect as the 't_xs' termcap option. 6462 It is provided for backwards compatibility with version 4.x. 6463 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and 6464 vice versa. Has no effect when the GUI is running. 6465 6466 *'whichwrap'* *'ww'* 6467'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") 6468 global 6469 {not in Vi} 6470 Allow specified keys that move the cursor left/right to move to the 6471 previous/next line when the cursor is on the first/last character in 6472 the line. Concatenate characters to allow this for these keys: 6473 char key mode ~ 6474 b <BS> Normal and Visual 6475 s <Space> Normal and Visual 6476 h "h" Normal and Visual 6477 l "l" Normal and Visual 6478 < <Left> Normal and Visual 6479 > <Right> Normal and Visual 6480 ~ "~" Normal 6481 [ <Left> Insert and Replace 6482 ] <Right> Insert and Replace 6483 For example: > 6484 :set ww=<,>,[,] 6485< allows wrap only when cursor keys are used. 6486 When the movement keys are used in combination with a delete or change 6487 operator, the <EOL> also counts for a character. This makes "3h" 6488 different from "3dh" when the cursor crosses the end of a line. This 6489 is also true for "x" and "X", because they do the same as "dl" and 6490 "dh". If you use this, you may also want to use the mapping 6491 ":map <BS> X" to make backspace delete the character in front of the 6492 cursor. 6493 When 'l' is included, you get a side effect: "yl" on an empty line 6494 will include the <EOL>, so that "p" will insert a new line. 6495 NOTE: This option is set to the Vi default value when 'compatible' is 6496 set and to the Vim default value when 'compatible' is reset. 6497 6498 *'wildchar'* *'wc'* 6499'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) 6500 global 6501 {not in Vi} 6502 Character you have to type to start wildcard expansion in the 6503 command-line, as specified with 'wildmode'. 6504 The character is not recognized when used inside a macro. See 6505 'wildcharm' for that. 6506 Although 'wc' is a number option, you can set it to a special key: > 6507 :set wc=<Esc> 6508< NOTE: This option is set to the Vi default value when 'compatible' is 6509 set and to the Vim default value when 'compatible' is reset. 6510 6511 *'wildcharm'* *'wcm'* 6512'wildcharm' 'wcm' number (default: none (0)) 6513 global 6514 {not in Vi} 6515 'wildcharm' works exactly like 'wildchar', except that it is 6516 recognized when used inside a macro. You can find "spare" command-line 6517 keys suitable for this option by looking at |ex-edit-index|. Normally 6518 you'll never actually type 'wildcharm', just use it in mappings that 6519 automatically invoke completion mode, e.g.: > 6520 :set wcm=<C-Z> 6521 :cmap ss so $vim/sessions/*.vim<C-Z> 6522< Then after typing :ss you can use CTRL-P & CTRL-N. 6523 6524 *'wildignore'* *'wig'* 6525'wildignore' 'wig' string (default "") 6526 global 6527 {not in Vi} 6528 {not available when compiled without the |+wildignore| 6529 feature} 6530 A list of file patterns. A file that matches with one of these 6531 patterns is ignored when completing file or directory names. 6532 The pattern is used like with |:autocmd|, see |autocmd-patterns|. 6533 Also see 'suffixes'. 6534 Example: > 6535 :set wildignore=*.o,*.obj 6536< The use of |:set+=| and |:set-=| is preferred when adding or removing 6537 a pattern from the list. This avoids problems when a future version 6538 uses another default. 6539 6540 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* 6541'wildmenu' 'wmnu' boolean (default off) 6542 global 6543 {not in Vi} 6544 {not available if compiled without the |+wildmenu| 6545 feature} 6546 When 'wildmenu' is on, command-line completion operates in an enhanced 6547 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, 6548 the possible matches are shown just above the command line, with the 6549 first match highlighted (overwriting the status line, if there is 6550 one). Keys that show the previous/next match, such as <Tab> or 6551 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. 6552 When 'wildmode' is used, "wildmenu" mode is used where "full" is 6553 specified. "longest" and "list" do not start "wildmenu" mode. 6554 If there are more matches than can fit in the line, a ">" is shown on 6555 the right and/or a "<" is shown on the left. The status line scrolls 6556 as needed. 6557 The "wildmenu" mode is abandoned when a key is hit that is not used 6558 for selecting a completion. 6559 While the "wildmenu" is active the following keys have special 6560 meanings: 6561 6562 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) 6563 <Down> - in filename/menu name completion: move into a 6564 subdirectory or submenu. 6565 <CR> - in menu completion, when the cursor is just after a 6566 dot: move into a submenu. 6567 <Up> - in filename/menu name completion: move up into 6568 parent directory or parent menu. 6569 6570 This makes the menus accessible from the console |console-menus|. 6571 6572 If you prefer the <Left> and <Right> keys to move the cursor instead 6573 of selecting a different match, use this: > 6574 :cnoremap <Left> <Space><BS><Left> 6575 :cnoremap <Right> <Space><BS><Right> 6576< 6577 The "WildMenu" highlighting is used for displaying the current match 6578 |hl-WildMenu|. 6579 6580 *'wildmode'* *'wim'* 6581'wildmode' 'wim' string (Vim default: "full") 6582 global 6583 {not in Vi} 6584 Completion mode that is used for the character specified with 6585 'wildchar'. It is a comma separated list of up to four parts. Each 6586 part specifies what to do for each consecutive use of 'wildchar. The 6587 first part specifies the behavior for the first use of 'wildchar', 6588 The second part for the second use, etc. 6589 These are the possible values for each part: 6590 "" Complete only the first match. 6591 "full" Complete the next full match. After the last match, 6592 the original string is used and then the first match 6593 again. 6594 "longest" Complete till longest common string. If this doesn't 6595 result in a longer string, use the next part. 6596 "longest:full" Like "longest", but also start 'wildmenu' if it is 6597 enabled. 6598 "list" When more than one match, list all matches. 6599 "list:full" When more than one match, list all matches and 6600 complete first match. 6601 "list:longest" When more than one match, list all matches and 6602 complete till longest common string. 6603 When there is only a single match, it is fully completed in all cases. 6604 6605 Examples: > 6606 :set wildmode=full 6607< Complete first full match, next match, etc. (the default) > 6608 :set wildmode=longest,full 6609< Complete longest common string, then each full match > 6610 :set wildmode=list:full 6611< List all matches and complete each full match > 6612 :set wildmode=list,full 6613< List all matches without completing, then each full match > 6614 :set wildmode=longest,list 6615< Complete longest common string, then list alternatives. 6616 6617 *'winaltkeys'* *'wak'* 6618'winaltkeys' 'wak' string (default "menu") 6619 global 6620 {not in Vi} 6621 {only used in Win32, Motif, GTK and Photon GUI} 6622 Some GUI versions allow the access to menu entries by using the ALT 6623 key in combination with a character that appears underlined in the 6624 menu. This conflicts with the use of the ALT key for mappings and 6625 entering special characters. This option tells what to do: 6626 no Don't use ALT keys for menus. ALT key combinations can be 6627 mapped, but there is no automatic handling. This can then be 6628 done with the |:simalt| command. 6629 yes ALT key handling is done by the windowing system. ALT key 6630 combinations cannot be mapped. 6631 menu Using ALT in combination with a character that is a menu 6632 shortcut key, will be handled by the windowing system. Other 6633 keys can be mapped. 6634 If the menu is disabled by excluding 'm' from 'guioptions', the ALT 6635 key is never used for the menu. 6636 In the Win32 version, the <F10> key is handled like this too, since 6637 Windows uses it to select a menu. 6638 6639 *'winheight'* *'wh'* *E591* 6640'winheight' 'wh' number (default 1) 6641 global 6642 {not in Vi} 6643 {not available when compiled without the +windows 6644 feature} 6645 Minimal number of lines for the current window. This is not a hard 6646 minimum, Vim will use fewer lines if there is not enough room. If the 6647 current window is smaller, its size is increased, at the cost of the 6648 height of other windows. Set it to 999 to make the current window 6649 always fill the screen (although this has the drawback that ":all" 6650 will create only two windows). Set it to a small number for normal 6651 editing. 6652 Minimum value is 1. 6653 The height is not adjusted after one of the commands to change the 6654 height of the current window. 6655 'winheight' applies to the current window. Use 'winminheight' to set 6656 the minimal height for other windows. 6657 6658 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* 6659'winfixheight' 'wfh' boolean (default off) 6660 local to window 6661 {not in Vi} 6662 {not available when compiled without the +windows 6663 feature} 6664 Keep the window height when windows are opened or closed and 6665 'equalalways' is set. Set by default for the |preview-window| and 6666 |quickfix-window|. 6667 The height may be changed anyway when running out of room. 6668 6669 *'winminheight'* *'wmh'* 6670'winminheight' 'wmh' number (default 1) 6671 global 6672 {not in Vi} 6673 {not available when compiled without the +windows 6674 feature} 6675 The minimal height of a window, when it's not the current window. 6676 This is a hard minimum, windows will never become smaller. 6677 When set to zero, windows may be "squashed" to zero lines (i.e. just a 6678 status bar) if necessary. They will return to at least one line when 6679 they become active (since the cursor has to have somewhere to go.) 6680 Use 'winheight' to set the minimal height of the current window. 6681 This option is only checked when making a window smaller. Don't use a 6682 large number, it will cause errors when opening more than a few 6683 windows. A value of 0 to 3 is reasonable. 6684 6685 *'winminwidth'* *'wmw'* 6686'winminwidth' 'wmw' number (default 1) 6687 global 6688 {not in Vi} 6689 {not available when compiled without the +vertsplit 6690 feature} 6691 The minimal width of a window, when it's not the current window. 6692 This is a hard minimum, windows will never become smaller. 6693 When set to zero, windows may be "squashed" to zero columns (i.e. just 6694 a vertical separator) if necessary. They will return to at least one 6695 line when they become active (since the cursor has to have somewhere 6696 to go.) 6697 Use 'winwidth' to set the minimal width of the current window. 6698 This option is only checked when making a window smaller. Don't use a 6699 large number, it will cause errors when opening more than a few 6700 windows. A value of 0 to 12 is reasonable. 6701 6702 *'winwidth'* *'wiw'* *E592* 6703'winwidth' 'wiw' number (default 20) 6704 global 6705 {not in Vi} 6706 {not available when compiled without the +vertsplit 6707 feature} 6708 Minimal number of columns for the current window. This is not a hard 6709 minimum, Vim will use fewer columns if there is not enough room. If 6710 the current window is smaller, its size is increased, at the cost of 6711 the width of other windows. Set it to 999 to make the current window 6712 always fill the screen. Set it to a small number for normal editing. 6713 The width is not adjusted after one of the commands to change the 6714 width of the current window. 6715 'winwidth' applies to the current window. Use 'winminwidth' to set 6716 the minimal width for other windows. 6717 6718 *'wrap'* *'nowrap'* 6719'wrap' boolean (default on) 6720 local to window 6721 {not in Vi} 6722 This option changes how text is displayed. It doesn't change the text 6723 in the buffer, see 'textwidth' for that. 6724 When on, lines longer than the width of the window will wrap and 6725 displaying continues on the next line. When off lines will not wrap 6726 and only part of long lines will be displayed. When the cursor is 6727 moved to a part that is not shown, the screen will scroll 6728 horizontally. 6729 The line will be broken in the middle of a word if necessary. See 6730 'linebreak' to get the break at a word boundary. 6731 To make scrolling horizontally a bit more useful, try this: > 6732 :set sidescroll=5 6733 :set listchars+=precedes:<,extends:> 6734< See 'sidescroll', 'listchars' and |wrap-off|. 6735 6736 *'wrapmargin'* *'wm'* 6737'wrapmargin' 'wm' number (default 0) 6738 local to buffer 6739 Number of characters from the right window border where wrapping 6740 starts. When typing text beyond this limit, an <EOL> will be inserted 6741 and inserting continues on the next line. 6742 Options that add a margin, such as 'number' and 'foldcolumn', cause 6743 the text width to be further reduced. This is Vi compatible. 6744 When 'textwidth' is non-zero, this option is not used. 6745 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently 6746 and less usefully} 6747 6748 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* 6749'wrapscan' 'ws' boolean (default on) *E384* *E385* 6750 global 6751 Searches wrap around the end of the file. 6752 6753 *'write'* *'nowrite'* 6754'write' boolean (default on) 6755 global 6756 {not in Vi} 6757 Allows writing files. When not set, writing a file is not allowed. 6758 Can be used for a view-only mode, where modifications to the text are 6759 still allowed. Can be reset with the |-m| or |-M| command line 6760 argument. Filtering text is still possible, even though this requires 6761 writing a temporary file. 6762 6763 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* 6764'writeany' 'wa' boolean (default off) 6765 global 6766 Allows writing to any file with no need for "!" override. 6767 6768 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* 6769'writebackup' 'wb' boolean (default on with |+writebackup| feature, off 6770 otherwise) 6771 global 6772 {not in Vi} 6773 Make a backup before overwriting a file. The backup is removed after 6774 the file was successfully written, unless the 'backup' option is 6775 also on. Reset this option if your file system is almost full. See 6776 |backup-table| for another explanation. 6777 When the 'backupskip' pattern matches, a backup is not made anyway. 6778 NOTE: This option is set to the default value when 'compatible' is 6779 set. 6780 6781 *'writedelay'* *'wd'* 6782'writedelay' 'wd' number (default 0) 6783 global 6784 {not in Vi} 6785 The number of microseconds to wait for each character sent to the 6786 screen. When non-zero, characters are sent to the terminal one by 6787 one. For MS-DOS pcterm this does not work. For debugging purposes. 6788 6789 vim:tw=78:ts=8:ft=help:norl: 6790