Bram Moolenaar | 90915b5 | 2005-08-21 22:17:52 +0000 | [diff] [blame] | 1 | *options.txt* For Vim version 7.0aa. Last change: 2005 Aug 21 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2 | |
| 3 | |
| 4 | VIM REFERENCE MANUAL by Bram Moolenaar |
| 5 | |
| 6 | |
| 7 | Options *options* |
| 8 | |
| 9 | 1. Setting options |set-option| |
| 10 | 2. Automatically setting options |auto-setting| |
| 11 | 3. Options summary |option-summary| |
| 12 | |
| 13 | For an overview of options see help.txt |option-list|. |
| 14 | |
| 15 | Vim has a number of internal variables and switches which can be set to |
| 16 | achieve 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 | ============================================================================== |
| 22 | 1. 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 |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 53 | default value. The values of 'term', 'lines' and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 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 | |
| 107 | The {option} arguments to ":set" may be repeated. For example: > |
| 108 | :set ai nosi sw=3 ts=3 |
| 109 | If you make an error in one of the arguments, an error message will be given |
| 110 | and the following arguments will be ignored. |
| 111 | |
| 112 | *:set-verbose* |
| 113 | When 'verbose' is non-zero, displaying an option value will also tell where it |
| 114 | was 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 |
| 120 | This is only done when specific option values are requested, not for ":set |
| 121 | all" or ":set" without an argument. |
| 122 | When the option was set by hand there is no "Last set" message. There is only |
| 123 | one value for all local options with the same name. Thus the message applies |
| 124 | to the option name, not necessarily its value. |
| 125 | When the option was set while executing a function, user command or |
| 126 | autocommand, the script in which it was defined is reported. |
| 127 | Note 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* |
| 132 | For {option} the form "t_xx" may be used to set a termcap option. This will |
| 133 | override the value from the termcap. You can then use it in a mapping. If |
| 134 | the "xx" part contains special characters, use the <t_xx> form: > |
| 135 | :set <t_#4>=^[Ot |
| 136 | This can also be used to translate a special code for a normal key. For |
| 137 | example, 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) |
| 140 | The advantage over a mapping is that it works in all situations. |
| 141 | |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 142 | The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 143 | security reasons. |
| 144 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 145 | The listing from ":set" looks different from Vi. Long string options are put |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 146 | at the end of the list. The number of options is quite large. The output of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 147 | "set all" probably does not fit on the screen, causing Vim to give the |
| 148 | |more-prompt|. |
| 149 | |
| 150 | *option-backslash* |
| 151 | To include white space in a string option value it has to be preceded with a |
| 152 | backslash. To include a backslash you have to use two. Effectively this |
| 153 | means that the number of backslashes in an option value is halved (rounded |
| 154 | down). |
| 155 | A few examples: > |
| 156 | :set tags=tags\ /usr/tags results in "tags /usr/tags" |
| 157 | :set tags=tags\\,file results in "tags\,file" |
| 158 | :set tags=tags\\\ file results in "tags\ file" |
| 159 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 160 | The "|" character separates a ":set" command from a following command. To |
| 161 | include the "|" in the option value, use "\|" instead. This example sets the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 162 | 'titlestring' option to "hi|there": > |
| 163 | :set titlestring=hi\|there |
| 164 | This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > |
| 165 | :set titlestring=hi|set iconstring=there |
| 166 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 167 | For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 168 | precise: For options that expect a file name (those where environment |
| 169 | variables are expanded) a backslash before a normal file name character is not |
| 170 | removed. But a backslash before a special character (space, backslash, comma, |
| 171 | etc.) is used like explained above. |
| 172 | There is one special situation, when the value starts with "\\": > |
| 173 | :set dir=\\machine\path results in "\\machine\path" |
| 174 | :set dir=\\\\machine\\path results in "\\machine\path" |
| 175 | :set dir=\\path\\file results in "\\path\file" (wrong!) |
| 176 | For the first one the start is kept, but for the second one the backslashes |
| 177 | are halved. This makes sure it works both when you expect backslashes to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 178 | halved and when you expect the backslashes to be kept. The third gives a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 179 | result which is probably not what you want. Avoid it. |
| 180 | |
| 181 | *add-option-flags* *remove-option-flags* |
| 182 | *E539* *E550* *E551* *E552* |
| 183 | Some options are a list of flags. When you want to add a flag to such an |
| 184 | option, without changing the existing ones, you can do it like this: > |
| 185 | :set guioptions+=a |
| 186 | Remove a flag from an option like this: > |
| 187 | :set guioptions-=a |
| 188 | This removes the 'a' flag from 'guioptions'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 189 | Note that you should add or remove one flag at a time. If 'guioptions' has |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 190 | the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
| 191 | doesn't appear. |
| 192 | |
| 193 | *:set_env* *expand-env* *expand-environment-var* |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 194 | Environment variables in specific string options will be expanded. If the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 195 | environment variable exists the '$' and the following environment variable |
| 196 | name is replaced with its value. If it does not exist the '$' and the name |
| 197 | are not modified. Any non-id character (not a letter, digit or '_') may |
| 198 | follow the environment variable name. That character and what follows is |
| 199 | appended to the value of the environment variable. Examples: > |
| 200 | :set term=$TERM.new |
| 201 | :set path=/usr/$INCLUDE,$HOME/include,. |
| 202 | When adding or removing a string from an option with ":set opt-=val" or ":set |
| 203 | opt+=val" the expansion is done before the adding or removing. |
| 204 | |
| 205 | |
| 206 | Handling of local options *local-options* |
| 207 | |
| 208 | Some of the options only apply to a window or buffer. Each window or buffer |
| 209 | has its own copy of this option, thus can each have their own value. This |
| 210 | allows you to set 'list' in one window but not in another. And set |
| 211 | 'shiftwidth' to 3 in one buffer and 4 in another. |
| 212 | |
| 213 | The following explains what happens to these local options in specific |
| 214 | situations. You don't really need to know all of this, since Vim mostly uses |
| 215 | the option values you would expect. Unfortunately, doing what the user |
| 216 | expects is a bit complicated... |
| 217 | |
| 218 | When splitting a window, the local options are copied to the new window. Thus |
| 219 | right after the split the contents of the two windows look the same. |
| 220 | |
| 221 | When editing a new buffer, its local option values must be initialized. Since |
| 222 | the local options of the current buffer might be specifically for that buffer, |
| 223 | these are not used. Instead, for each buffer-local option there also is a |
| 224 | global value, which is used for new buffers. With ":set" both the local and |
| 225 | global value is changed. With "setlocal" only the local value is changed, |
| 226 | thus this value is not used when editing a new buffer. |
| 227 | |
| 228 | When editing a buffer that has been edited before, the last used window |
| 229 | options are used again. If this buffer has been edited in this window, the |
| 230 | values from back then are used. Otherwise the values from the window where |
| 231 | the buffer was edited last are used. |
| 232 | |
| 233 | It's possible to set a local window option specifically for a type of buffer. |
| 234 | When you edit another buffer in the same window, you don't want to keep |
| 235 | using these local window options. Therefore Vim keeps a global value of the |
| 236 | local window options, which is used when editing another buffer. Each window |
| 237 | has its own copy of these values. Thus these are local to the window, but |
| 238 | global to all buffers in the window. With this you can do: > |
| 239 | :e one |
| 240 | :set list |
| 241 | :e two |
| 242 | Now the 'list' option will also be set in "two", since with the ":set list" |
| 243 | command you have also set the global value. > |
| 244 | :set nolist |
| 245 | :e one |
| 246 | :setlocal list |
| 247 | :e two |
| 248 | Now the 'list' option is not set, because ":set nolist" resets the global |
| 249 | value, ":setlocal list" only changes the local value and ":e two" gets the |
| 250 | global value. Note that if you do this next: > |
| 251 | :e one |
| 252 | You will not get back the 'list' value as it was the last time you edited |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 253 | "one". The options local to a window are not remembered for each buffer. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 254 | |
| 255 | *:setl* *:setlocal* |
| 256 | :setl[ocal] ... Like ":set" but set only the value local to the |
| 257 | current buffer or window. Not all options have a |
| 258 | local value. If the option does not have a local |
| 259 | value the global value is set. |
| 260 | With the "all" argument: display all local option's |
| 261 | local values. |
| 262 | Without argument: Display all local option's local |
| 263 | values which are different from the default. |
| 264 | When displaying a specific local option, show the |
| 265 | local value. For a global option the global value is |
| 266 | shown (but that might change in the future). |
| 267 | {not in Vi} |
| 268 | |
| 269 | :setl[ocal] {option}< Set the local value of {option} to its global value. |
| 270 | {not in Vi} |
| 271 | |
| 272 | *:setg* *:setglobal* |
| 273 | :setg[lobal] ... Like ":set" but set only the global value for a local |
| 274 | option without changing the local value. |
| 275 | When displaying an option, the global value is shown. |
| 276 | With the "all" argument: display all local option's |
| 277 | global values. |
| 278 | Without argument: display all local option's global |
| 279 | values which are different from the default. |
| 280 | {not in Vi} |
| 281 | |
| 282 | For buffer-local and window-local options: |
| 283 | Command global value local value ~ |
| 284 | :set option=value set set |
| 285 | :setlocal option=value - set |
| 286 | :setglobal option=value set - |
| 287 | :set option? - display |
| 288 | :setlocal option? - display |
| 289 | :setglobal option? display - |
| 290 | |
| 291 | |
| 292 | Global options with a local value *global-local* |
| 293 | |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 294 | Options are global when you mostly use one value for all buffers and windows. |
| 295 | For some global options it's useful to sometimes have a different local value. |
| 296 | You can set the local value with ":setlocal". That buffer or window will then |
| 297 | use the local value, while other buffers and windows continue using the global |
| 298 | value. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 299 | |
| 300 | For example, you have two windows, both on C source code. They use the global |
| 301 | 'makeprg' option. If you do this in one of the two windows: > |
| 302 | :set makeprg=gmake |
| 303 | then the other window will switch to the same value. There is no need to set |
| 304 | the 'makeprg' option in the other C source window too. |
| 305 | However, if you start editing a Perl file in a new window, you want to use |
| 306 | another 'makeprog' for it, without changing the value used for the C source |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 307 | files. You use this command: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 308 | :setlocal makeprg=perlmake |
| 309 | You can switch back to using the global value by making the local value empty: > |
| 310 | :setlocal makeprg= |
| 311 | This only works for a string option. For a boolean option you need to use the |
| 312 | "<" flag, like this: > |
| 313 | :setlocal autoread< |
| 314 | Note that for non-boolean options using "<" copies the global value to the |
| 315 | local value, it doesn't switch back to using the global value (that matters |
| 316 | when changing the global value later). |
| 317 | Note: In the future more global options can be made global-local. Using |
| 318 | ":setlocal" on a global option might work differently then. |
| 319 | |
| 320 | |
| 321 | Setting the filetype |
| 322 | |
| 323 | :setf[iletype] {filetype} *:setf* *:setfiletype* |
| 324 | Set the 'filetype' option to {filetype}, but only if |
| 325 | not done yet in a sequence of (nested) autocommands. |
| 326 | This is short for: > |
| 327 | :if !did_filetype() |
| 328 | : setlocal filetype={filetype} |
| 329 | :endif |
| 330 | < This command is used in a filetype.vim file to avoid |
| 331 | setting the 'filetype' option twice, causing different |
| 332 | settings and syntax files to be loaded. |
| 333 | {not in Vi} |
| 334 | |
| 335 | :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 336 | :opt[ions] Open a window for viewing and setting all options. |
| 337 | Options are grouped by function. |
| 338 | Offers short help for each option. Hit <CR> on the |
| 339 | short help to open a help window with more help for |
| 340 | the option. |
| 341 | Modify the value of the option and hit <CR> on the |
| 342 | "set" line to set the new value. For window and |
| 343 | buffer specific options, the last accessed window is |
| 344 | used to set the option value in, unless this is a help |
| 345 | window, in which case the window below help window is |
| 346 | used (skipping the option-window). |
| 347 | {not available when compiled without the |+eval| or |
| 348 | |+autocmd| features} |
| 349 | |
| 350 | *$HOME* |
| 351 | Using "~" is like using "$HOME", but it is only recognized at the start of an |
| 352 | option and after a space or comma. |
| 353 | |
| 354 | On Unix systems "~user" can be used too. It is replaced by the home directory |
| 355 | of user "user". Example: > |
| 356 | :set path=~mool/include,/usr/include,. |
| 357 | |
| 358 | On Unix systems the form "${HOME}" can be used too. The name between {} can |
| 359 | contain non-id characters then. Note that if you want to use this for the |
| 360 | "gf" command, you need to add the '{' and '}' characters to 'isfname'. |
| 361 | |
| 362 | NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 363 | command, not when assigning a value to an option with ":let". |
| 364 | |
| 365 | |
| 366 | Note the maximum length of an expanded option is limited. How much depends on |
| 367 | the system, mostly it is something like 256 or 1024 characters. |
| 368 | |
| 369 | *:fix* *:fixdel* |
| 370 | :fix[del] Set the value of 't_kD': |
| 371 | 't_kb' is 't_kD' becomes ~ |
| 372 | CTRL-? CTRL-H |
| 373 | not CTRL-? CTRL-? |
| 374 | |
| 375 | (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} |
| 376 | |
| 377 | If your delete key terminal code is wrong, but the |
| 378 | code for backspace is alright, you can put this in |
| 379 | your .vimrc: > |
| 380 | :fixdel |
| 381 | < This works no matter what the actual code for |
| 382 | backspace is. |
| 383 | |
| 384 | If the backspace key terminal code is wrong you can |
| 385 | use this: > |
| 386 | :if &term == "termname" |
| 387 | : set t_kb=^V<BS> |
| 388 | : fixdel |
| 389 | :endif |
| 390 | < Where "^V" is CTRL-V and "<BS>" is the backspace key |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 391 | (don't type four characters!). Replace "termname" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 392 | with your terminal name. |
| 393 | |
| 394 | If your <Delete> key sends a strange key sequence (not |
| 395 | CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > |
| 396 | :if &term == "termname" |
| 397 | : set t_kD=^V<Delete> |
| 398 | :endif |
| 399 | < Where "^V" is CTRL-V and "<Delete>" is the delete key |
| 400 | (don't type eight characters!). Replace "termname" |
| 401 | with your terminal name. |
| 402 | |
| 403 | *Linux-backspace* |
| 404 | Note about Linux: By default the backspace key |
| 405 | produces CTRL-?, which is wrong. You can fix it by |
| 406 | putting this line in your rc.local: > |
| 407 | echo "keycode 14 = BackSpace" | loadkeys |
| 408 | < |
| 409 | *NetBSD-backspace* |
| 410 | Note about NetBSD: If your backspace doesn't produce |
| 411 | the right code, try this: > |
| 412 | xmodmap -e "keycode 22 = BackSpace" |
| 413 | < If this works, add this in your .Xmodmap file: > |
| 414 | keysym 22 = BackSpace |
| 415 | < You need to restart for this to take effect. |
| 416 | |
| 417 | ============================================================================== |
| 418 | 2. Automatically setting options *auto-setting* |
| 419 | |
| 420 | Besides changing options with the ":set" command, there are three alternatives |
| 421 | to set options automatically for one or more files: |
| 422 | |
| 423 | 1. When starting Vim initializations are read from various places. See |
| 424 | |initialization|. Most of them are performed for all editing sessions, |
| 425 | and some of them depend on the directory where Vim is started. |
| 426 | You can create an initialization file with |:mkvimrc|, |:mkview| and |
| 427 | |:mksession|. |
| 428 | 2. If you start editing a new file, the automatic commands are executed. |
| 429 | This can be used to set options for files matching a particular pattern and |
| 430 | many other things. See |autocommand|. |
| 431 | 3. If you start editing a new file, and the 'modeline' option is on, a |
| 432 | number of lines at the beginning and end of the file are checked for |
| 433 | modelines. This is explained here. |
| 434 | |
| 435 | *modeline* *vim:* *vi:* *ex:* *E520* |
| 436 | There are two forms of modelines. The first form: |
| 437 | [text]{white}{vi:|vim:|ex:}[white]{options} |
| 438 | |
| 439 | [text] any text or empty |
| 440 | {white} at least one blank character (<Space> or <Tab>) |
| 441 | {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
| 442 | [white] optional white space |
| 443 | {options} a list of option settings, separated with white space or ':', |
| 444 | where each part between ':' is the argument for a ":set" |
| 445 | command |
| 446 | |
| 447 | Example: > |
| 448 | vi:noai:sw=3 ts=6 |
| 449 | |
| 450 | The second form (this is compatible with some versions of Vi): |
| 451 | |
| 452 | [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text] |
| 453 | |
| 454 | [text] any text or empty |
| 455 | {white} at least one blank character (<Space> or <Tab>) |
| 456 | {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
| 457 | [white] optional white space |
| 458 | se[t] the string "set " or "se " (note the space) |
| 459 | {options} a list of options, separated with white space, which is the |
| 460 | argument for a ":set" command |
| 461 | : a colon |
| 462 | [text] any text or empty |
| 463 | |
| 464 | Example: > |
| 465 | /* vim: set ai tw=75: */ |
| 466 | |
| 467 | The white space before {vi:|vim:|ex:} is required. This minimizes the chance |
| 468 | that a normal word like "lex:" is caught. There is one exception: "vi:" and |
| 469 | "vim:" can also be at the start of the line (for compatibility with version |
| 470 | 3.0). Using "ex:" at the start of the line will be ignored (this could be |
| 471 | short for "example:"). |
| 472 | |
| 473 | *modeline-local* |
| 474 | The options are set like with ":setlocal": The new value only applies to the |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 475 | buffer and window that contain the file. Although it's possible to set global |
| 476 | options from a modeline, this is unusual. If you have two windows open and |
| 477 | the files in it set the same global option to a different value, the result |
| 478 | depends on which one was opened last. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 479 | |
Bram Moolenaar | 15d0a8c | 2004-09-06 17:44:46 +0000 | [diff] [blame] | 480 | When editing a file that was already loaded, only the window-local options |
| 481 | from the modeline are used. Thus if you manually changed a buffer-local |
| 482 | option after opening the file, it won't be changed if you edit the same buffer |
| 483 | in another window. But window-local options will be set. |
| 484 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 485 | *modeline-version* |
| 486 | If the modeline is only to be used for some versions of Vim, the version |
| 487 | number can be specified where "vim:" is used: |
| 488 | vim{vers}: version {vers} or later |
| 489 | vim<{vers}: version before {vers} |
| 490 | vim={vers}: version {vers} |
| 491 | vim>{vers}: version after {vers} |
| 492 | {vers} is 600 for Vim 6.0 (hundred times the major version plus minor). |
| 493 | For example, to use a modeline only for Vim 6.0 and later: > |
| 494 | /* vim600: set foldmethod=marker: */ |
| 495 | To use a modeline for Vim before version 5.7: > |
| 496 | /* vim<570: set sw=4: */ |
| 497 | There can be no blanks between "vim" and the ":". |
| 498 | |
| 499 | |
| 500 | The number of lines that are checked can be set with the 'modelines' option. |
| 501 | If 'modeline' is off or 'modelines' is 0 no lines are checked. |
| 502 | |
| 503 | Note that for the first form all of the rest of the line is used, thus a line |
| 504 | like: > |
| 505 | /* vi:ts=4: */ |
| 506 | will give an error message for the trailing "*/". This line is OK: > |
| 507 | /* vi:set ts=4: */ |
| 508 | |
| 509 | If an error is detected the rest of the line is skipped. |
| 510 | |
| 511 | If you want to include a ':' in a set command precede it with a '\'. The |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 512 | backslash in front of the ':' will be removed. Example: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 513 | /* vi:set dir=c\:\tmp: */ |
| 514 | This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
| 515 | ':' is removed. Thus to include "\:" you have to specify "\\:". |
| 516 | |
| 517 | No other commands than "set" are supported, for security reasons (somebody |
| 518 | might create a Trojan horse text file with modelines). |
| 519 | |
| 520 | Hint: If you would like to do something else than setting an option, you could |
| 521 | define an autocommand that checks the file for a specific string. For |
| 522 | example: > |
| 523 | au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif |
| 524 | And define a function SetVar() that does something with the line containing |
| 525 | "VAR". |
| 526 | |
| 527 | ============================================================================== |
| 528 | 3. Options summary *option-summary* |
| 529 | |
| 530 | In the list below all the options are mentioned with their full name and with |
| 531 | an abbreviation if there is one. Both forms may be used. |
| 532 | |
| 533 | In this document when a boolean option is "set" that means that ":set option" |
| 534 | is entered. When an option is "reset", ":set nooption" is used. |
| 535 | |
| 536 | For some options there are two default values: The "Vim default", which is |
| 537 | used when 'compatible' is not set, and the "Vi default", which is used when |
| 538 | 'compatible' is set. |
| 539 | |
| 540 | Most options are the same in all windows and buffers. There are a few that |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 541 | are specific to how the text is presented in a window. These can be set to a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 542 | different value in each window. For example the 'list' option can be set in |
| 543 | one window and reset in another for the same text, giving both types of view |
| 544 | at the same time. There are a few options that are specific to a certain |
| 545 | file. These can have a different value for each file or buffer. For example |
| 546 | the 'textwidth' option can be 78 for a normal text file and 0 for a C |
| 547 | program. |
| 548 | |
| 549 | global one option for all buffers and windows |
| 550 | local to window each window has its own copy of this option |
| 551 | local to buffer each buffer has its own copy of this option |
| 552 | |
| 553 | When creating a new window the option values from the currently active window |
| 554 | are used as a default value for the window-specific options. For the |
| 555 | buffer-specific options this depends on the 's' and 'S' flags in the |
| 556 | 'cpoptions' option. If 's' is included (which is the default) the values for |
| 557 | buffer options are copied from the currently active buffer when a buffer is |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 558 | first entered. If 'S' is present the options are copied each time the buffer |
| 559 | is entered, this is almost like having global options. If 's' and 'S' are not |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 560 | present, the options are copied from the currently active buffer when the |
| 561 | buffer is created. |
| 562 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 563 | Not all options are supported in all versions. To test if option "foo" can be |
| 564 | used with ":set" use "exists('&foo')". This doesn't mean the value is |
| 565 | actually remembered and works. Some options are hidden, which means that you |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 566 | can set them but the value is not remembered. To test if option "foo" is |
| 567 | really supported use "exists('+foo')". |
| 568 | |
| 569 | *E355* |
| 570 | A jump table for the options with a short description can be found at |Q_op|. |
| 571 | |
| 572 | *'aleph'* *'al'* *aleph* *Aleph* |
| 573 | 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) |
| 574 | global |
| 575 | {not in Vi} |
| 576 | {only available when compiled with the |+rightleft| |
| 577 | feature} |
| 578 | The ASCII code for the first letter of the Hebrew alphabet. The |
| 579 | routine that maps the keyboard in Hebrew mode, both in Insert mode |
| 580 | (when hkmap is set) and on the command-line (when hitting CTRL-_) |
| 581 | outputs the Hebrew characters in the range [aleph..aleph+26]. |
| 582 | aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. |
| 583 | See |rileft.txt|. |
| 584 | |
| 585 | *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* |
| 586 | 'allowrevins' 'ari' boolean (default off) |
| 587 | global |
| 588 | {not in Vi} |
| 589 | {only available when compiled with the |+rightleft| |
| 590 | feature} |
| 591 | Allow CTRL-_ in Insert and Command-line mode. This is default off, to |
| 592 | avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get |
| 593 | into reverse Insert mode, and don't know how to get out. See |
| 594 | 'revins'. |
| 595 | NOTE: This option is reset when 'compatible' is set. |
| 596 | |
| 597 | *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* |
| 598 | 'altkeymap' 'akm' boolean (default off) |
| 599 | global |
| 600 | {not in Vi} |
| 601 | {only available when compiled with the |+farsi| |
| 602 | feature} |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 603 | When on, the second language is Farsi. In editing mode CTRL-_ toggles |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 604 | the keyboard map between Farsi and English, when 'allowrevins' set. |
| 605 | |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 606 | When off, the keyboard map toggles between Hebrew and English. This |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 607 | is useful to start the Vim in native mode i.e. English (left-to-right |
| 608 | mode) and have default second language Farsi or Hebrew (right-to-left |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 609 | mode). See |farsi.txt|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 610 | |
| 611 | *'ambiwidth'* *'ambw'* |
| 612 | 'ambiwidth' 'ambw' string (default: "single") |
| 613 | global |
| 614 | {not in Vi} |
| 615 | {only available when compiled with the |+multi_byte| |
| 616 | feature} |
| 617 | Only effective when 'encoding' is "utf-8" or another Unicode encoding. |
| 618 | Tells Vim what to do with characters with East Asian Width Class |
| 619 | Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek |
| 620 | letters, Cyrillic letters). |
| 621 | |
| 622 | There are currently two possible values: |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 623 | "single": Use the same width as characters in US-ASCII. This is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 624 | expected by most users. |
| 625 | "double": Use twice the width of ASCII characters. |
| 626 | |
| 627 | There are a number of CJK fonts for which the width of glyphs for |
| 628 | those characters are solely based on how many octets they take in |
| 629 | legacy/traditional CJK encodings. In those encodings, Euro, |
| 630 | Registered sign, Greek/Cyrillic letters are represented by two octets, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 631 | therefore those fonts have "wide" glyphs for them. This is also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 632 | true of some line drawing characters used to make tables in text |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 633 | file. Therefore, when a CJK font is used for GUI Vim or |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 634 | Vim is running inside a terminal (emulators) that uses a CJK font |
| 635 | (or Vim is run inside an xterm invoked with "-cjkwidth" option.), |
| 636 | this option should be set to "double" to match the width perceived |
| 637 | by Vim with the width of glyphs in the font. Perhaps it also has |
| 638 | to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP |
| 639 | when the system locale is set to one of CJK locales. See Unicode |
| 640 | Standard Annex #11 (http://www.unicode.org/reports/tr11). |
| 641 | |
| 642 | *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 643 | 'antialias' 'anti' boolean (default: off) |
| 644 | global |
| 645 | {not in Vi} |
| 646 | {only available when compiled with GUI enabled |
| 647 | on Mac OS X} |
| 648 | This option only has an effect in the GUI version of Vim on Mac OS X |
| 649 | v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
| 650 | which can be easier to read at certain sizes on certain displays. |
| 651 | Setting this option can sometimes cause problems if 'guifont' is set |
| 652 | to its default (empty string). |
| 653 | |
| 654 | *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* |
| 655 | 'autochdir' 'acd' boolean (default off) |
| 656 | global |
| 657 | {not in Vi} |
| 658 | {only available when compiled with the |
| 659 | |+netbeans_intg| or |+sun_workshop| feature} |
Bram Moolenaar | d8c0087 | 2005-07-22 21:52:15 +0000 | [diff] [blame] | 660 | When on, Vim will change the current working directory whenever you |
| 661 | open a file, switch buffers, delete a buffer or open/close a window. |
| 662 | It will change to the directory containing the file which was opened |
| 663 | or selected. |
| 664 | This option is provided for backward compatibility with the Vim |
| 665 | released with Sun ONE Studio 4 Enterprise Edition. |
| 666 | Note: When this option is on some plugins may not work. The directory |
| 667 | browser sets if off. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 668 | |
| 669 | *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
| 670 | 'arabic' 'arab' boolean (default off) |
| 671 | local to window |
| 672 | {not in Vi} |
| 673 | {only available when compiled with the |+arabic| |
| 674 | feature} |
| 675 | This option can be set to start editing Arabic text. |
| 676 | Setting this option will: |
| 677 | - Set the 'rightleft' option, unless 'termbidi' is set. |
| 678 | - Set the 'arabicshape' option, unless 'termbidi' is set. |
| 679 | - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles |
| 680 | between typing English and Arabic key mapping. |
| 681 | - Set the 'delcombine' option |
| 682 | Note that 'encoding' must be "utf-8" for working with Arabic text. |
| 683 | |
| 684 | Resetting this option will: |
| 685 | - Reset the 'rightleft' option. |
| 686 | - Disable the use of 'keymap' (without changing its value). |
| 687 | Note that 'arabicshape' and 'delcombine' are not reset (it is a global |
| 688 | option. |
| 689 | Also see |arabic.txt|. |
| 690 | |
| 691 | *'arabicshape'* *'arshape'* |
| 692 | *'noarabicshape'* *'noarshape'* |
| 693 | 'arabicshape' 'arshape' boolean (default on) |
| 694 | global |
| 695 | {not in Vi} |
| 696 | {only available when compiled with the |+arabic| |
| 697 | feature} |
| 698 | When on and 'termbidi' is off, the required visual character |
| 699 | corrections that need to take place for displaying the Arabic language |
| 700 | take affect. Shaping, in essence, gets enabled; the term is a broad |
| 701 | one which encompasses: |
| 702 | a) the changing/morphing of characters based on their location |
| 703 | within a word (initial, medial, final and stand-alone). |
| 704 | b) the enabling of the ability to compose characters |
| 705 | c) the enabling of the required combining of some characters |
| 706 | When disabled the character display reverts back to each character's |
| 707 | true stand-alone form. |
| 708 | Arabic is a complex language which requires other settings, for |
| 709 | further details see |arabic.txt|. |
| 710 | |
| 711 | *'autoindent'* *'ai'* *'noautoindent'* *'noai'* |
| 712 | 'autoindent' 'ai' boolean (default off) |
| 713 | local to buffer |
| 714 | Copy indent from current line when starting a new line (typing <CR> |
| 715 | in Insert mode or when using the "o" or "O" command). If you do not |
| 716 | type anything on the new line except <BS> or CTRL-D and then type |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 717 | <Esc> or <CR>, the indent is deleted again. Moving the cursor to |
| 718 | another line has the same effect, unless the 'I' flag is included in |
| 719 | 'cpoptions'. |
| 720 | When autoindent is on, formatting (with the "gq" command or when you |
| 721 | reach 'textwidth' in Insert mode) uses the indentation of the first |
| 722 | line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 723 | When 'smartindent' or 'cindent' is on the indent is changed in |
| 724 | a different way. |
| 725 | The 'autoindent' option is reset when the 'paste' option is set. |
| 726 | {small difference from Vi: After the indent is deleted when typing |
| 727 | <Esc> or <CR>, the cursor position when moving up or down is after the |
| 728 | deleted indent; Vi puts the cursor somewhere in the deleted indent}. |
| 729 | |
| 730 | *'autoread'* *'ar'* *'noautoread'* *'noar'* |
| 731 | 'autoread' 'ar' boolean (default off) |
| 732 | global or local to buffer |global-local| |
| 733 | {not in Vi} |
| 734 | When a file has been detected to have been changed outside of Vim and |
| 735 | it has not been changed inside of Vim, automatically read it again. |
| 736 | When the file has been deleted this is not done. |timestamp| |
| 737 | If this option has a local value, use this command to switch back to |
| 738 | using the global value: > |
| 739 | :set autoread< |
| 740 | < |
| 741 | *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* |
| 742 | 'autowrite' 'aw' boolean (default off) |
| 743 | global |
| 744 | Write the contents of the file, if it has been modified, on each |
| 745 | :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, |
| 746 | :make, CTRL-] and CTRL-^ command; and when a CTRL-O, CTRL-I, |
| 747 | '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
| 748 | Note that for some commands the 'autowrite' option is not used, see |
| 749 | 'autowriteall' for that. |
| 750 | |
| 751 | *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* |
| 752 | 'autowriteall' 'awa' boolean (default off) |
| 753 | global |
| 754 | {not in Vi} |
| 755 | Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", |
| 756 | ":qall", ":exit", ":xit", ":recover" and closing the Vim window. |
| 757 | Setting this option also implies that Vim behaves like 'autowrite' has |
| 758 | been set. |
| 759 | |
| 760 | *'background'* *'bg'* |
| 761 | 'background' 'bg' string (default "dark" or "light") |
| 762 | global |
| 763 | {not in Vi} |
| 764 | When set to "dark", Vim will try to use colors that look good on a |
| 765 | dark background. When set to "light", Vim will try to use colors that |
| 766 | look good on a light background. Any other value is illegal. |
| 767 | Vim tries to set the default value according to the terminal used. |
| 768 | This will not always be correct. |
| 769 | Setting this option does not change the background color, it tells Vim |
| 770 | what the background color looks like. For changing the background |
| 771 | color, see |:hi-normal|. |
| 772 | |
| 773 | When 'background' is set Vim will adjust the default color groups for |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 774 | the new value. But the colors used for syntax highlighting will not |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 775 | change. |
| 776 | When a color scheme is loaded (the "colors_name" variable is set) |
| 777 | setting 'background' will cause the color scheme to be reloaded. If |
| 778 | the color scheme adjusts to the value of 'background' this will work. |
| 779 | However, if the color scheme sets 'background' itself the effect may |
| 780 | be undone. First delete the "colors_name" variable when needed. |
| 781 | |
| 782 | When setting 'background' to the default value with: > |
| 783 | :set background& |
| 784 | < Vim will guess the value. In the GUI this should work correctly, |
| 785 | in other cases Vim might not be able to guess the right value. |
| 786 | |
| 787 | When starting the GUI, the default value for 'background' will be |
| 788 | "light". When the value is not set in the .gvimrc, and Vim detects |
| 789 | that the background is actually quite dark, 'background' is set to |
| 790 | "dark". But this happens only AFTER the .gvimrc file has been read |
| 791 | (because the window needs to be opened to find the actual background |
| 792 | color). To get around this, force the GUI window to be opened by |
| 793 | putting a ":gui" command in the .gvimrc file, before where the value |
| 794 | of 'background' is used (e.g., before ":syntax on"). |
| 795 | Normally this option would be set in the .vimrc file. Possibly |
| 796 | depending on the terminal name. Example: > |
| 797 | :if &term == "pcterm" |
| 798 | : set background=dark |
| 799 | :endif |
| 800 | < When this option is set, the default settings for the highlight groups |
| 801 | will change. To use other settings, place ":highlight" commands AFTER |
| 802 | the setting of the 'background' option. |
| 803 | This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file |
| 804 | to select the colors for syntax highlighting. After changing this |
| 805 | option, you must load syntax.vim again to see the result. This can be |
| 806 | done with ":syntax on". |
| 807 | |
| 808 | *'backspace'* *'bs'* |
| 809 | 'backspace' 'bs' string (default "") |
| 810 | global |
| 811 | {not in Vi} |
| 812 | Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert |
| 813 | mode. This is a list of items, separated by commas. Each item allows |
| 814 | a way to backspace over something: |
| 815 | value effect ~ |
| 816 | indent allow backspacing over autoindent |
| 817 | eol allow backspacing over line breaks (join lines) |
| 818 | start allow backspacing over the start of insert; CTRL-W and CTRL-U |
| 819 | stop once at the start of insert. |
| 820 | |
| 821 | When the value is empty, Vi compatible backspacing is used. |
| 822 | |
| 823 | For backwards compatibility with version 5.4 and earlier: |
| 824 | value effect ~ |
| 825 | 0 same as ":set backspace=" (Vi compatible) |
| 826 | 1 same as ":set backspace=indent,eol" |
| 827 | 2 same as ":set backspace=indent,eol,start" |
| 828 | |
| 829 | See |:fixdel| if your <BS> or <Del> key does not do what you want. |
| 830 | NOTE: This option is set to "" when 'compatible' is set. |
| 831 | |
| 832 | *'backup'* *'bk'* *'nobackup'* *'nobk'* |
| 833 | 'backup' 'bk' boolean (default off) |
| 834 | global |
| 835 | {not in Vi} |
| 836 | Make a backup before overwriting a file. Leave it around after the |
| 837 | file has been successfully written. If you do not want to keep the |
| 838 | backup file, but you do want a backup while the file is being |
| 839 | written, reset this option and set the 'writebackup' option (this is |
| 840 | the default). If you do not want a backup file at all reset both |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 841 | options (use this if your file system is almost full). See the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 842 | |backup-table| for more explanations. |
| 843 | When the 'backupskip' pattern matches, a backup is not made anyway. |
| 844 | When 'patchmode' is set, the backup may be renamed to become the |
| 845 | oldest version of a file. |
| 846 | NOTE: This option is reset when 'compatible' is set. |
| 847 | |
| 848 | *'backupcopy'* *'bkc'* |
| 849 | 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") |
| 850 | global |
| 851 | {not in Vi} |
| 852 | When writing a file and a backup is made, this option tells how it's |
| 853 | done. This is a comma separated list of words. |
| 854 | |
| 855 | The main values are: |
| 856 | "yes" make a copy of the file and overwrite the original one |
| 857 | "no" rename the file and write a new one |
| 858 | "auto" one of the previous, what works best |
| 859 | |
| 860 | Extra values that can be combined with the ones above are: |
| 861 | "breaksymlink" always break symlinks when writing |
| 862 | "breakhardlink" always break hardlinks when writing |
| 863 | |
| 864 | Making a copy and overwriting the original file: |
| 865 | - Takes extra time to copy the file. |
| 866 | + When the file has special attributes, is a (hard/symbolic) link or |
| 867 | has a resource fork, all this is preserved. |
| 868 | - When the file is a link the backup will have the name of the link, |
| 869 | not of the real file. |
| 870 | |
| 871 | Renaming the file and writing a new one: |
| 872 | + It's fast. |
| 873 | - Sometimes not all attributes of the file can be copied to the new |
| 874 | file. |
| 875 | - When the file is a link the new file will not be a link. |
| 876 | |
| 877 | The "auto" value is the middle way: When Vim sees that renaming file |
| 878 | is possible without side effects (the attributes can be passed on and |
| 879 | and the file is not a link) that is used. When problems are expected, |
| 880 | a copy will be made. |
| 881 | |
| 882 | The "breaksymlink" and "breakhardlink" values can be used in |
| 883 | combination with any of "yes", "no" and "auto". When included, they |
| 884 | force Vim to always break either symbolic or hard links by doing |
| 885 | exactly what the "no" option does, renaming the original file to |
| 886 | become the backup and writing a new file in its place. This can be |
| 887 | useful for example in source trees where all the files are symbolic or |
| 888 | hard links and any changes should stay in the local source tree, not |
| 889 | be propagated back to the original source. |
| 890 | *crontab* |
| 891 | One situation where "no" and "auto" will cause problems: A program |
| 892 | that opens a file, invokes Vim to edit that file, and then tests if |
| 893 | the open file was changed (through the file descriptor) will check the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 894 | backup file instead of the newly created file. "crontab -e" is an |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 895 | example. |
| 896 | |
| 897 | When a copy is made, the original file is truncated and then filled |
| 898 | with the new text. This means that protection bits, owner and |
| 899 | symbolic links of the original file are unmodified. The backup file |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 900 | however, is a new file, owned by the user who edited the file. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 901 | group of the backup is set to the group of the original file. If this |
| 902 | fails, the protection bits for the group are made the same as for |
| 903 | others. |
| 904 | |
| 905 | When the file is renamed this is the other way around: The backup has |
| 906 | the same attributes of the original file, and the newly written file |
| 907 | is owned by the current user. When the file was a (hard/symbolic) |
| 908 | link, the new file will not! That's why the "auto" value doesn't |
| 909 | rename when the file is a link. The owner and group of the newly |
| 910 | written file will be set to the same ones as the original file, but |
| 911 | the system may refuse to do this. In that case the "auto" value will |
| 912 | again not rename the file. |
| 913 | |
| 914 | *'backupdir'* *'bdir'* |
| 915 | 'backupdir' 'bdir' string (default for Amiga: ".,t:", |
| 916 | for MS-DOS and Win32: ".,c:/tmp,c:/temp" |
| 917 | for Unix: ".,~/tmp,~/") |
| 918 | global |
| 919 | {not in Vi} |
| 920 | List of directories for the backup file, separated with commas. |
| 921 | - The backup file will be created in the first directory in the list |
| 922 | where this is possible. |
| 923 | - Empty means that no backup file will be created ('patchmode' is |
| 924 | impossible!). Writing may fail because of this. |
| 925 | - A directory "." means to put the backup file in the same directory |
| 926 | as the edited file. |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 927 | - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 928 | put the backup file relative to where the edited file is. The |
| 929 | leading "." is replaced with the path name of the edited file. |
| 930 | ("." inside a directory name has no special meaning). |
| 931 | - Spaces after the comma are ignored, other spaces are considered part |
| 932 | of the directory name. To have a space at the start of a directory |
| 933 | name, precede it with a backslash. |
| 934 | - To include a comma in a directory name precede it with a backslash. |
| 935 | - A directory name may end in an '/'. |
| 936 | - Environment variables are expanded |:set_env|. |
| 937 | - Careful with '\' characters, type one before a space, type two to |
| 938 | get one in the option (see |option-backslash|), for example: > |
| 939 | :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces |
| 940 | < - For backwards compatibility with Vim version 3.0 a '>' at the start |
| 941 | of the option is removed. |
| 942 | See also 'backup' and 'writebackup' options. |
| 943 | If you want to hide your backup files on Unix, consider this value: > |
| 944 | :set backupdir=./.backup,~/.backup,.,/tmp |
| 945 | < You must create a ".backup" directory in each directory and in your |
| 946 | home directory for this to work properly. |
| 947 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 948 | directories from the list. This avoids problems when a future version |
| 949 | uses another default. |
| 950 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 951 | security reasons. |
| 952 | |
| 953 | *'backupext'* *'bex'* *E589* |
| 954 | 'backupext' 'bex' string (default "~", for VMS: "_") |
| 955 | global |
| 956 | {not in Vi} |
| 957 | String which is appended to a file name to make the name of the |
| 958 | backup file. The default is quite unusual, because this avoids |
| 959 | accidentally overwriting existing files with a backup file. You might |
| 960 | prefer using ".bak", but make sure that you don't have files with |
| 961 | ".bak" that you want to keep. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 962 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 963 | |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 964 | If you like to keep a lot of backups, you could use a BufWritePre |
| 965 | autocommand to change 'backupext' just before writing the file to |
| 966 | include a timestamp. > |
| 967 | :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' |
| 968 | < Use 'backupdir' to put the backup in a different directory. |
| 969 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 970 | *'backupskip'* *'bsk'* |
| 971 | 'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
| 972 | global |
| 973 | {not in Vi} |
| 974 | {not available when compiled without the |+wildignore| |
| 975 | feature} |
| 976 | A list of file patterns. When one of the patterns matches with the |
| 977 | name of the file which is written, no backup file is created. Both |
| 978 | the specified file name and the full path name of the file are used. |
| 979 | The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 980 | Watch out for special characters, see |option-backslash|. |
| 981 | When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 982 | default value. "/tmp/*" is only used for Unix. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 983 | |
| 984 | *'balloondelay'* *'bdlay'* |
| 985 | 'balloondelay' 'bdlay' number (default: 600) |
| 986 | global |
| 987 | {not in Vi} |
| 988 | {only available when compiled with the |+balloon_eval| |
| 989 | feature} |
| 990 | Delay in milliseconds before a balloon may pop up. See |balloon-eval|. |
| 991 | |
| 992 | *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* |
| 993 | 'ballooneval' 'beval' boolean (default off) |
| 994 | global |
| 995 | {not in Vi} |
| 996 | {only available when compiled with the |+balloon_eval| |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 997 | feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 998 | Switch on the |balloon-eval| functionality. |
| 999 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1000 | *'balloonexpr'* *'bexpr'* |
| 1001 | 'balloonexpr' 'bexpr' string (default "") |
| 1002 | global |
| 1003 | {not in Vi} |
| 1004 | {only available when compiled with the |+balloon_eval| |
| 1005 | feature} |
| 1006 | Expression to show in evaluation balloon. It is only used when |
| 1007 | 'ballooneval' is on. These variables can be used: |
| 1008 | |
| 1009 | v:beval_bufnr number of the buffer in which balloon is going to show |
| 1010 | v:beval_winnr number of the window |
| 1011 | v:beval_lnum line number |
| 1012 | v:beval_col column number (byte index) |
| 1013 | v:beval_text word under or after the mouse pointer |
| 1014 | |
| 1015 | The evaluation of the expression must not have side effects! |
| 1016 | Example: > |
| 1017 | function! MyBalloonExpr() |
Bram Moolenaar | 4536002 | 2005-07-21 21:08:21 +0000 | [diff] [blame] | 1018 | return 'Cursor is at line ' . v:beval_lnum . |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1019 | \', column ' . v:beval_col . |
| 1020 | \ ' of file ' . bufname(v:beval_bufnr) . |
| 1021 | \ ' on word "' . v:beval_text . '"' |
| 1022 | endfunction |
| 1023 | set bexpr=MyBalloonExpr() |
| 1024 | set ballooneval |
| 1025 | < |
| 1026 | NOTE: The balloon is displayed only if the cursor is on a text |
| 1027 | character. If the result of evaluating 'balloonexpr' is not empty, |
| 1028 | Vim does not try to send a message to an external debugger (Netbeans |
| 1029 | or Sun Workshop). |
| 1030 | |
Bram Moolenaar | 87e25fd | 2005-07-27 21:13:01 +0000 | [diff] [blame] | 1031 | To check whether line breaks in the balloon text work use this check: > |
Bram Moolenaar | 4536002 | 2005-07-21 21:08:21 +0000 | [diff] [blame] | 1032 | if has("balloon_multiline") |
| 1033 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1034 | *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1035 | 'binary' 'bin' boolean (default off) |
| 1036 | local to buffer |
| 1037 | {not in Vi} |
| 1038 | This option should be set before editing a binary file. You can also |
| 1039 | use the |-b| Vim argument. When this option is switched on a few |
| 1040 | options will be changed (also when it already was on): |
| 1041 | 'textwidth' will be set to 0 |
| 1042 | 'wrapmargin' will be set to 0 |
| 1043 | 'modeline' will be off |
| 1044 | 'expandtab' will be off |
| 1045 | Also, 'fileformat' and 'fileformats' options will not be used, the |
| 1046 | file is read and written like 'fileformat' was "unix" (a single <NL> |
| 1047 | separates lines). |
| 1048 | The 'fileencoding' and 'fileencodings' options will not be used, the |
| 1049 | file is read without conversion. |
| 1050 | NOTE: When you start editing a(nother) file while the 'bin' option is |
| 1051 | on, settings from autocommands may change the settings again (e.g., |
| 1052 | 'textwidth'), causing trouble when editing. You might want to set |
| 1053 | 'bin' again when the file has been loaded. |
| 1054 | The previous values of these options are remembered and restored when |
| 1055 | 'bin' is switched from on to off. Each buffer has its own set of |
| 1056 | saved option values. |
| 1057 | To edit a file with 'binary' set you can use the |++bin| argument. |
| 1058 | This avoids you have to do ":set bin", which would have effect for all |
| 1059 | files you edit. |
| 1060 | When writing a file the <EOL> for the last line is only written if |
| 1061 | there was one in the original file (normally Vim appends an <EOL> to |
| 1062 | the last line if there is none; this would make the file longer). See |
| 1063 | the 'endofline' option. |
| 1064 | |
| 1065 | *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* |
| 1066 | 'bioskey' 'biosk' boolean (default on) |
| 1067 | global |
| 1068 | {not in Vi} {only for MS-DOS} |
Bram Moolenaar | 87e25fd | 2005-07-27 21:13:01 +0000 | [diff] [blame] | 1069 | When on the BIOS is called to obtain a keyboard character. This works |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1070 | better to detect CTRL-C, but only works for the console. When using a |
| 1071 | terminal over a serial port reset this option. |
| 1072 | Also see |'conskey'|. |
| 1073 | |
| 1074 | *'bomb'* *'nobomb'* |
| 1075 | 'bomb' boolean (default off) |
| 1076 | local to buffer |
| 1077 | {not in Vi} |
| 1078 | {only available when compiled with the |+multi_byte| |
| 1079 | feature} |
| 1080 | When writing a file and the following conditions are met, a BOM (Byte |
| 1081 | Order Mark) is prepended to the file: |
| 1082 | - this option is on |
| 1083 | - the 'binary' option is off |
| 1084 | - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big |
| 1085 | endian variants. |
| 1086 | Some applications use the BOM to recognize the encoding of the file. |
| 1087 | Often used for UCS-2 files on MS-Windows. For other applications it |
| 1088 | causes trouble, for example: "cat file1 file2" makes the BOM of file2 |
| 1089 | appear halfway the resulting file. |
| 1090 | When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1091 | check for the presence of the BOM is done and 'bomb' set accordingly. |
| 1092 | Unless 'binary' is set, it is removed from the first line, so that you |
| 1093 | don't see it when editing. When you don't change the options, the BOM |
| 1094 | will be restored when writing the file. |
| 1095 | |
| 1096 | *'breakat'* *'brk'* |
| 1097 | 'breakat' 'brk' string (default " ^I!@*-+;:,./?") |
| 1098 | global |
| 1099 | {not in Vi} |
| 1100 | {not available when compiled without the |+linebreak| |
| 1101 | feature} |
| 1102 | This option lets you choose which characters might cause a line |
| 1103 | break if 'linebreak' is on. |
| 1104 | |
| 1105 | *'browsedir'* *'bsdir'* |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 1106 | 'browsedir' 'bsdir' string (default: "last") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1107 | global |
| 1108 | {not in Vi} {only for Motif and Win32 GUI} |
| 1109 | Which directory to use for the file browser: |
| 1110 | last Use same directory as with last file browser. |
| 1111 | buffer Use the directory of the related buffer. |
| 1112 | current Use the current directory. |
| 1113 | {path} Use the specified directory |
| 1114 | |
| 1115 | *'bufhidden'* *'bh'* |
| 1116 | 'bufhidden' 'bh' string (default: "") |
| 1117 | local to buffer |
| 1118 | {not in Vi} |
| 1119 | {not available when compiled without the |+quickfix| |
| 1120 | feature} |
| 1121 | This option specifies what happens when a buffer is no longer |
| 1122 | displayed in a window: |
| 1123 | <empty> follow the global 'hidden' option |
| 1124 | hide hide the buffer (don't unload it), also when 'hidden' |
| 1125 | is not set |
| 1126 | unload unload the buffer, also when 'hidden' is set or using |
| 1127 | |:hide| |
| 1128 | delete delete the buffer from the buffer list, also when |
| 1129 | 'hidden' is set or using |:hide|, like using |
| 1130 | |:bdelete| |
| 1131 | wipe wipe out the buffer from the buffer list, also when |
| 1132 | 'hidden' is set or using |:hide|, like using |
| 1133 | |:bwipeout| |
| 1134 | |
Bram Moolenaar | a14de3d | 2005-01-07 21:48:26 +0000 | [diff] [blame] | 1135 | CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
| 1136 | are lost without a warning. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1137 | This option is used together with 'buftype' and 'swapfile' to specify |
| 1138 | special kinds of buffers. See |special-buffers|. |
| 1139 | |
| 1140 | *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* |
| 1141 | 'buflisted' 'bl' boolean (default: on) |
| 1142 | local to buffer |
| 1143 | {not in Vi} |
| 1144 | When this option is set, the buffer shows up in the buffer list. If |
| 1145 | it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. |
| 1146 | This option is reset by Vim for buffers that are only used to remember |
| 1147 | a file name or marks. Vim sets it when starting to edit a buffer. |
| 1148 | But not when moving to a buffer with ":buffer". |
| 1149 | |
| 1150 | *'buftype'* *'bt'* *E382* |
| 1151 | 'buftype' 'bt' string (default: "") |
| 1152 | local to buffer |
| 1153 | {not in Vi} |
| 1154 | {not available when compiled without the |+quickfix| |
| 1155 | feature} |
| 1156 | The value of this option specifies the type of a buffer: |
| 1157 | <empty> normal buffer |
| 1158 | nofile buffer which is not related to a file and will not be |
| 1159 | written |
| 1160 | nowrite buffer which will not be written |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 1161 | acwrite buffer which will always be written with BufWriteCmd |
| 1162 | autocommands. {not available when compiled without the |
| 1163 | |+autocmd| feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1164 | quickfix quickfix buffer, contains list of errors |:cwindow| |
| 1165 | help help buffer (you are not supposed to set this |
| 1166 | manually) |
| 1167 | |
| 1168 | This option is used together with 'bufhidden' and 'swapfile' to |
| 1169 | specify special kinds of buffers. See |special-buffers|. |
| 1170 | |
| 1171 | Be careful with changing this option, it can have many side effects! |
| 1172 | |
| 1173 | A "quickfix" buffer is only used for the error list. This value is |
| 1174 | set by the |:cwindow| command and you are not supposed to change it. |
| 1175 | |
| 1176 | "nofile" and "nowrite" buffers are similar: |
| 1177 | both: The buffer is not to be written to disk, ":w" doesn't |
| 1178 | work (":w filename" does work though). |
| 1179 | both: The buffer is never considered to be |'modified'|. |
| 1180 | There is no warning when the changes will be lost, for |
| 1181 | example when you quit Vim. |
| 1182 | both: A swap file is only created when using too much memory |
| 1183 | (when 'swapfile' has been reset there is never a swap |
| 1184 | file). |
| 1185 | nofile only: The buffer name is fixed, it is not handled like a |
| 1186 | file name. It is not modified in response to a |:cd| |
| 1187 | command. |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 1188 | *E676* |
| 1189 | "acwrite" implies that the buffer name is not related to a file, like |
| 1190 | "nofile", but it will be written. Thus, in contrast to "nofile" and |
| 1191 | "nowrite", ":w" does work and a modified buffer can't be abandoned |
| 1192 | without saving. For writing there must be matching |BufWriteCmd|, |
| 1193 | |FileWriteCmd| or |FileAppendCmd| autocommands. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1194 | |
| 1195 | *'casemap'* *'cmp'* |
| 1196 | 'casemap' 'cmp' string (default: "internal,keepascii") |
| 1197 | global |
| 1198 | {not in Vi} |
| 1199 | Specifies details about changing the case of letters. It may contain |
| 1200 | these words, separated by a comma: |
| 1201 | internal Use internal case mapping functions, the current |
| 1202 | locale does not change the case mapping. This only |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1203 | matters when 'encoding' is a Unicode encoding. When |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1204 | "internal" is omitted, the towupper() and towlower() |
| 1205 | system library functions are used when available. |
| 1206 | keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1207 | case mapping, the current locale is not effective. |
| 1208 | This probably only matters for Turkish. |
| 1209 | |
| 1210 | *'cdpath'* *'cd'* *E344* *E346* |
| 1211 | 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") |
| 1212 | global |
| 1213 | {not in Vi} |
| 1214 | {not available when compiled without the |
| 1215 | |+file_in_path| feature} |
| 1216 | This is a list of directories which will be searched when using the |
| 1217 | |:cd| and |:lcd| commands, provided that the directory being searched |
| 1218 | for has a relative path (not starting with "/", "./" or "../"). |
| 1219 | The 'cdpath' option's value has the same form and semantics as |
| 1220 | |'path'|. Also see |file-searching|. |
| 1221 | The default value is taken from $CDPATH, with a "," prepended to look |
| 1222 | in the current directory first. |
| 1223 | If the default value taken from $CDPATH is not what you want, include |
| 1224 | a modified version of the following command in your vimrc file to |
| 1225 | override it: > |
| 1226 | :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
| 1227 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1228 | security reasons. |
| 1229 | (parts of 'cdpath' can be passed to the shell to expand file names). |
| 1230 | |
| 1231 | *'cedit'* |
| 1232 | 'cedit' string (Vi default: "", Vim default: CTRL-F) |
| 1233 | global |
| 1234 | {not in Vi} |
| 1235 | {not available when compiled without the |+vertsplit| |
| 1236 | feature} |
| 1237 | The key used in Command-line Mode to open the command-line window. |
| 1238 | The default is CTRL-F when 'compatible' is off. |
| 1239 | Only non-printable keys are allowed. |
| 1240 | The key can be specified as a single character, but it is difficult to |
| 1241 | type. The preferred way is to use the <> notation. Examples: > |
| 1242 | :set cedit=<C-Y> |
| 1243 | :set cedit=<Esc> |
| 1244 | < |Nvi| also has this option, but it only uses the first character. |
| 1245 | See |cmdwin|. |
| 1246 | |
| 1247 | *'charconvert'* *'ccv'* *E202* *E214* *E513* |
| 1248 | 'charconvert' 'ccv' string (default "") |
| 1249 | global |
| 1250 | {only available when compiled with the |+multi_byte| |
| 1251 | feature and the |+eval| feature} |
| 1252 | {not in Vi} |
| 1253 | An expression that is used for character encoding conversion. It is |
| 1254 | evaluated when a file that is to be read or has been written has a |
| 1255 | different encoding from what is desired. |
| 1256 | 'charconvert' is not used when the internal iconv() function is |
| 1257 | supported and is able to do the conversion. Using iconv() is |
| 1258 | preferred, because it is much faster. |
| 1259 | 'charconvert' is not used when reading stdin |--|, because there is no |
| 1260 | file to convert from. You will have to save the text in a file first. |
| 1261 | The expression must return zero or an empty string for success, |
| 1262 | non-zero for failure. |
| 1263 | The possible encoding names encountered are in 'encoding'. |
| 1264 | Additionally, names given in 'fileencodings' and 'fileencoding' are |
| 1265 | used. |
| 1266 | Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" |
| 1267 | is done internally by Vim, 'charconvert' is not used for this. |
| 1268 | 'charconvert' is also used to convert the viminfo file, if the 'c' |
| 1269 | flag is present in 'viminfo'. Also used for Unicode conversion. |
| 1270 | Example: > |
| 1271 | set charconvert=CharConvert() |
| 1272 | fun CharConvert() |
| 1273 | system("recode " |
| 1274 | \ . v:charconvert_from . ".." . v:charconvert_to |
| 1275 | \ . " <" . v:fname_in . " >" v:fname_out) |
| 1276 | return v:shell_error |
| 1277 | endfun |
| 1278 | < The related Vim variables are: |
| 1279 | v:charconvert_from name of the current encoding |
| 1280 | v:charconvert_to name of the desired encoding |
| 1281 | v:fname_in name of the input file |
| 1282 | v:fname_out name of the output file |
| 1283 | Note that v:fname_in and v:fname_out will never be the same. |
| 1284 | Note that v:charconvert_from and v:charconvert_to may be different |
| 1285 | from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. |
| 1286 | Encryption is not done by Vim when using 'charconvert'. If you want |
| 1287 | to encrypt the file after conversion, 'charconvert' should take care |
| 1288 | of this. |
| 1289 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1290 | security reasons. |
| 1291 | |
| 1292 | *'cindent'* *'cin'* *'nocindent'* *'nocin'* |
| 1293 | 'cindent' 'cin' boolean (default off) |
| 1294 | local to buffer |
| 1295 | {not in Vi} |
| 1296 | {not available when compiled without the |+cindent| |
| 1297 | feature} |
| 1298 | Enables automatic C program indenting See 'cinkeys' to set the keys |
| 1299 | that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1300 | preferred indent style. |
| 1301 | If 'indentexpr' is not empty, it overrules 'cindent'. |
| 1302 | If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, |
| 1303 | the "=" operator indents using this algorithm rather than calling an |
| 1304 | external program. |
| 1305 | See |C-indenting|. |
| 1306 | When you don't like the way 'cindent' works, try the 'smartindent' |
| 1307 | option or 'indentexpr'. |
| 1308 | This option is not used when 'paste' is set. |
| 1309 | NOTE: This option is reset when 'compatible' is set. |
| 1310 | |
| 1311 | *'cinkeys'* *'cink'* |
| 1312 | 'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") |
| 1313 | local to buffer |
| 1314 | {not in Vi} |
| 1315 | {not available when compiled without the |+cindent| |
| 1316 | feature} |
| 1317 | A list of keys that, when typed in Insert mode, cause reindenting of |
| 1318 | the current line. Only used if 'cindent' is on and 'indentexpr' is |
| 1319 | empty. |
| 1320 | For the format of this option see |cinkeys-format|. |
| 1321 | See |C-indenting|. |
| 1322 | |
| 1323 | *'cinoptions'* *'cino'* |
| 1324 | 'cinoptions' 'cino' string (default "") |
| 1325 | local to buffer |
| 1326 | {not in Vi} |
| 1327 | {not available when compiled without the |+cindent| |
| 1328 | feature} |
| 1329 | The 'cinoptions' affect the way 'cindent' reindents lines in a C |
| 1330 | program. See |cinoptions-values| for the values of this option, and |
| 1331 | |C-indenting| for info on C indenting in general. |
| 1332 | |
| 1333 | |
| 1334 | *'cinwords'* *'cinw'* |
| 1335 | 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") |
| 1336 | local to buffer |
| 1337 | {not in Vi} |
| 1338 | {not available when compiled without both the |
| 1339 | |+cindent| and the |+smartindent| features} |
| 1340 | These keywords start an extra indent in the next line when |
| 1341 | 'smartindent' or 'cindent' is set. For 'cindent' this is only done at |
| 1342 | an appropriate place (inside {}). |
| 1343 | Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't |
| 1344 | matter, include the keyword both the uppercase and lowercase: |
| 1345 | "if,If,IF". |
| 1346 | |
| 1347 | *'clipboard'* *'cb'* |
| 1348 | 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" |
| 1349 | for X-windows, "" otherwise) |
| 1350 | global |
| 1351 | {not in Vi} |
| 1352 | {only in GUI versions or when the |+xterm_clipboard| |
| 1353 | feature is included} |
| 1354 | This option is a list of comma separated names. |
| 1355 | These names are recognized: |
| 1356 | |
| 1357 | unnamed When included, Vim will use the clipboard register '*' |
| 1358 | for all yank, delete, change and put operations which |
| 1359 | would normally go to the unnamed register. When a |
| 1360 | register is explicitly specified, it will always be |
| 1361 | used regardless of whether "unnamed" is in 'clipboard' |
| 1362 | or not. The clipboard register can always be |
| 1363 | explicitly accessed using the "* notation. Also see |
| 1364 | |gui-clipboard|. |
| 1365 | |
| 1366 | autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1367 | then whenever Visual mode is started, or the Visual |
| 1368 | area extended, Vim tries to become the owner of the |
| 1369 | windowing system's global selection or put the |
| 1370 | selected text on the clipboard used by the selection |
| 1371 | register "*. See |guioptions_a| and |quotestar| for |
| 1372 | details. When the GUI is active, the 'a' flag in |
| 1373 | 'guioptions' is used, when the GUI is not active, this |
| 1374 | "autoselect" flag is used. |
| 1375 | Also applies to the modeless selection. |
| 1376 | |
| 1377 | autoselectml Like "autoselect", but for the modeless selection |
| 1378 | only. Compare to the 'A' flag in 'guioptions'. |
| 1379 | |
| 1380 | exclude:{pattern} |
| 1381 | Defines a pattern that is matched against the name of |
| 1382 | the terminal 'term'. If there is a match, no |
| 1383 | connection will be made to the X server. This is |
| 1384 | useful in this situation: |
| 1385 | - Running Vim in a console. |
| 1386 | - $DISPLAY is set to start applications on another |
| 1387 | display. |
| 1388 | - You do not want to connect to the X server in the |
| 1389 | console, but do want this in a terminal emulator. |
| 1390 | To never connect to the X server use: > |
| 1391 | exclude:.* |
| 1392 | < This has the same effect as using the |-X| argument. |
| 1393 | Note that when there is no connection to the X server |
| 1394 | the window title won't be restored and the clipboard |
| 1395 | cannot be accessed. |
| 1396 | The value of 'magic' is ignored, {pattern} is |
| 1397 | interpreted as if 'magic' was on. |
| 1398 | The rest of the option value will be used for |
| 1399 | {pattern}, this must be the last entry. |
| 1400 | |
| 1401 | *'cmdheight'* *'ch'* |
| 1402 | 'cmdheight' 'ch' number (default 1) |
| 1403 | global |
| 1404 | {not in Vi} |
| 1405 | Number of screen lines to use for the command-line. Helps avoiding |
| 1406 | |hit-enter| prompts. |
| 1407 | |
| 1408 | *'cmdwinheight'* *'cwh'* |
| 1409 | 'cmdwinheight' 'cwh' number (default 7) |
| 1410 | global |
| 1411 | {not in Vi} |
| 1412 | {not available when compiled without the |+vertsplit| |
| 1413 | feature} |
| 1414 | Number of screen lines to use for the command-line window. |cmdwin| |
| 1415 | |
| 1416 | *'columns'* *'co'* *E594* |
| 1417 | 'columns' 'co' number (default 80 or terminal width) |
| 1418 | global |
| 1419 | {not in Vi} |
| 1420 | Number of columns of the screen. Normally this is set by the terminal |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 1421 | initialization and does not have to be set by hand. Also see |
| 1422 | |posix-screen-size|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1423 | When Vim is running in the GUI or in a resizable window, setting this |
| 1424 | option will cause the window size to be changed. When you only want |
| 1425 | to use the size for the GUI, put the command in your |gvimrc| file. |
| 1426 | When you set this option and Vim is unable to change the physical |
| 1427 | number of columns of the display, the display may be messed up. |
| 1428 | |
| 1429 | *'comments'* *'com'* *E524* *E525* |
| 1430 | 'comments' 'com' string (default |
| 1431 | "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") |
| 1432 | local to buffer |
| 1433 | {not in Vi} |
| 1434 | {not available when compiled without the |+comments| |
| 1435 | feature} |
| 1436 | A comma separated list of strings that can start a comment line. See |
| 1437 | |format-comments|. See |option-backslash| about using backslashes to |
| 1438 | insert a space. |
| 1439 | |
| 1440 | *'commentstring'* *'cms'* *E537* |
| 1441 | 'commentstring' 'cms' string (default "/*%s*/") |
| 1442 | local to buffer |
| 1443 | {not in Vi} |
| 1444 | {not available when compiled without the |+folding| |
| 1445 | feature} |
| 1446 | A template for a comment. The "%s" in the value is replaced with the |
| 1447 | comment text. Currently only used to add markers for folding, see |
| 1448 | |fold-marker|. |
| 1449 | |
| 1450 | *'compatible'* *'cp'* *'nocompatible'* *'nocp'* |
Bram Moolenaar | d042c56 | 2005-06-30 22:04:15 +0000 | [diff] [blame] | 1451 | 'compatible' 'cp' boolean (default on, off when a .vimrc or .gvimrc file |
| 1452 | is found) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1453 | global |
| 1454 | {not in Vi} |
| 1455 | This option has the effect of making Vim either more Vi-compatible, or |
| 1456 | make Vim behave in a more useful way. |
| 1457 | This is a special kind of option, because when it's set or reset, |
| 1458 | other options are also changed as a side effect. CAREFUL: Setting or |
| 1459 | resetting this option can have a lot of unexpected effects: Mappings |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1460 | are interpreted in another way, undo behaves differently, etc. If you |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1461 | set this option in your vimrc file, you should probably put it at the |
| 1462 | very start. |
| 1463 | By default this option is on and the Vi defaults are used for the |
| 1464 | options. This default was chosen for those people who want to use Vim |
| 1465 | just like Vi, and don't even (want to) know about the 'compatible' |
| 1466 | option. |
Bram Moolenaar | d042c56 | 2005-06-30 22:04:15 +0000 | [diff] [blame] | 1467 | When a ".vimrc" or ".gvimrc" file is found while Vim is starting up, |
| 1468 | this option is switched off, and all options that have not been |
| 1469 | modified will be set to the Vim defaults. Effectively, this means |
| 1470 | that when a ".vimrc" or ".gvimrc" file exists, Vim will use the Vim |
| 1471 | defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
| 1472 | happen for the system-wide vimrc or gvimrc file). Also see |
| 1473 | |compatible-default| and |posix-compliance|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1474 | You can also set this option with the "-C" argument, and reset it with |
| 1475 | "-N". See |-C| and |-N|. |
| 1476 | Switching this option off makes the Vim defaults be used for options |
| 1477 | that have a different Vi and Vim default value. See the options |
| 1478 | marked with a '+' below. Other options are not modified. |
| 1479 | At the moment this option is set, several other options will be set |
| 1480 | or reset to make Vim as Vi-compatible as possible. See the table |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1481 | below. This can be used if you want to revert to Vi compatible |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1482 | editing. |
| 1483 | See also 'cpoptions'. |
| 1484 | |
| 1485 | option + set value effect ~ |
| 1486 | |
| 1487 | 'allowrevins' off no CTRL-_ command |
| 1488 | 'backupcopy' Unix: "yes" backup file is a copy |
| 1489 | others: "auto" copy or rename backup file |
| 1490 | 'backspace' "" normal backspace |
| 1491 | 'backup' off no backup file |
| 1492 | 'cindent' off no C code indentation |
| 1493 | 'cedit' + "" no key to open the |cmdwin| |
| 1494 | 'cpoptions' + (all flags) Vi-compatible flags |
| 1495 | 'cscopetag' off don't use cscope for ":tag" |
| 1496 | 'cscopetagorder' 0 see |cscopetagorder| |
| 1497 | 'cscopeverbose' off see |cscopeverbose| |
| 1498 | 'digraph' off no digraphs |
| 1499 | 'esckeys' + off no <Esc>-keys in Insert mode |
| 1500 | 'expandtab' off tabs not expanded to spaces |
| 1501 | 'fileformats' + "" no automatic file format detection, |
| 1502 | "dos,unix" except for DOS, Windows and OS/2 |
| 1503 | 'formatoptions' + "vt" Vi compatible formatting |
| 1504 | 'gdefault' off no default 'g' flag for ":s" |
| 1505 | 'history' + 0 no commandline history |
| 1506 | 'hkmap' off no Hebrew keyboard mapping |
| 1507 | 'hkmapp' off no phonetic Hebrew keyboard mapping |
| 1508 | 'hlsearch' off no highlighting of search matches |
| 1509 | 'incsearch' off no incremental searching |
| 1510 | 'indentexpr' "" no indenting by expression |
| 1511 | 'insertmode' off do not start in Insert mode |
| 1512 | 'iskeyword' + "@,48-57,_" keywords contain alphanumeric |
| 1513 | characters and '_' |
| 1514 | 'joinspaces' on insert 2 spaces after period |
| 1515 | 'modeline' + off no modelines |
| 1516 | 'more' + off no pauses in listings |
| 1517 | 'revins' off no reverse insert |
| 1518 | 'ruler' off no ruler |
| 1519 | 'scrolljump' 1 no jump scroll |
| 1520 | 'scrolloff' 0 no scroll offset |
| 1521 | 'shiftround' off indent not rounded to shiftwidth |
| 1522 | 'shortmess' + "" no shortening of messages |
| 1523 | 'showcmd' + off command characters not shown |
| 1524 | 'showmode' + off current mode not shown |
| 1525 | 'smartcase' off no automatic ignore case switch |
| 1526 | 'smartindent' off no smart indentation |
| 1527 | 'smarttab' off no smart tab size |
| 1528 | 'softtabstop' 0 tabs are always 'tabstop' positions |
| 1529 | 'startofline' on goto startofline with some commands |
| 1530 | 'tagrelative' + off tag file names are not relative |
| 1531 | 'textauto' + off no automatic textmode detection |
| 1532 | 'textwidth' 0 no automatic line wrap |
| 1533 | 'tildeop' off tilde is not an operator |
| 1534 | 'ttimeout' off no terminal timeout |
| 1535 | 'whichwrap' + "" left-right movements don't wrap |
| 1536 | 'wildchar' + CTRL-E only when the current value is <Tab> |
| 1537 | use CTRL-E for cmdline completion |
| 1538 | 'writebackup' on or off depends on +writebackup feature |
| 1539 | |
| 1540 | *'complete'* *'cpt'* *E535* |
| 1541 | 'complete' 'cpt' string (default: ".,w,b,u,t,i") |
| 1542 | local to buffer |
| 1543 | {not in Vi} |
| 1544 | This option specifies how keyword completion |ins-completion| works |
| 1545 | when CTRL-P or CTRL-N are used. It is also used for whole-line |
| 1546 | completion |i_CTRL-X_CTRL-L|. It indicates the type of completion |
| 1547 | and the places to scan. It is a comma separated list of flags: |
| 1548 | . scan the current buffer ('wrapscan' is ignored) |
| 1549 | w scan buffers from other windows |
| 1550 | b scan other loaded buffers that are in the buffer list |
| 1551 | u scan the unloaded buffers that are in the buffer list |
| 1552 | U scan the buffers that are not in the buffer list |
| 1553 | k scan the files given with the 'dictionary' option |
| 1554 | k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1555 | patterns are valid too. For example: > |
| 1556 | :set cpt=k/usr/dict/*,k~/spanish |
| 1557 | < s scan the files given with the 'thesaurus' option |
| 1558 | s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns |
| 1559 | are valid too. |
| 1560 | i scan current and included files |
| 1561 | d scan current and included files for defined name or macro |
| 1562 | |i_CTRL-X_CTRL-D| |
| 1563 | ] tag completion |
| 1564 | t same as "]" |
| 1565 | |
| 1566 | Unloaded buffers are not loaded, thus their autocmds |:autocmd| are |
| 1567 | not executed, this may lead to unexpected completions from some files |
| 1568 | (gzipped files for example). Unloaded buffers are not scanned for |
| 1569 | whole-line completion. |
| 1570 | |
| 1571 | The default is ".,w,b,u,t,i", which means to scan: |
| 1572 | 1. the current buffer |
| 1573 | 2. buffers in other windows |
| 1574 | 3. other loaded buffers |
| 1575 | 4. unloaded buffers |
| 1576 | 5. tags |
| 1577 | 6. included files |
| 1578 | |
| 1579 | As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 1580 | based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 1581 | |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1582 | |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1583 | *'completefunc'* *'cfu'* |
| 1584 | 'completefunc' 'cfu' string (default: empty) |
| 1585 | local to buffer |
| 1586 | {not in Vi} |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1587 | {not available when compiled without the +eval |
| 1588 | or +insert_expand feature} |
| 1589 | This option specifies a function to be used for CTRL-X CTRL-U |
| 1590 | completion. |i_CTRL-X_CTRL-U| |
| 1591 | |
| 1592 | The function will be invoked with three arguments: |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1593 | a:findstart either 1 or 0 |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1594 | a:col column in the cursor line where the completion ends, |
| 1595 | first column is zero |
| 1596 | a:base the text with which matches should match |
| 1597 | |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1598 | When the a:findstart argument is 1, the function must return the |
| 1599 | column of where the completion starts. It must be a number between |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1600 | zero and "a:col". This involves looking at the characters in the |
| 1601 | cursor line before column a:col and include those characters that |
| 1602 | could be part of the completed item. The text between this column and |
| 1603 | a:col will be replaced with the matches. Return -1 if no completion |
| 1604 | can be done. |
| 1605 | |
| 1606 | When the a:findstart argument is 0 the function must return a List |
| 1607 | with the matching words. These matches should include the "a:base" |
| 1608 | text. When there are no matches return an empty List. |
| 1609 | |
Bram Moolenaar | 572cb56 | 2005-08-05 21:35:02 +0000 | [diff] [blame] | 1610 | When searching for matches takes some time call |complete_add()| to |
| 1611 | add each match to the total list. These matches should then not |
| 1612 | appear in the returned list! Call |complete_check()| now and then to |
| 1613 | allow the user to press a key while still searching for matches. Stop |
| 1614 | searching when it returns non-zero. |
| 1615 | |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1616 | The function must not move the cursor! |
Bram Moolenaar | 572cb56 | 2005-08-05 21:35:02 +0000 | [diff] [blame] | 1617 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1618 | security reasons. |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1619 | |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1620 | An example that completes the names of the months: > |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1621 | fun! CompleteMonths(findstart, col, base) |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1622 | if a:findstart |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1623 | " locate the start of the word |
| 1624 | let line = getline('.') |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1625 | let start = a:col |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1626 | while start > 0 && line[start - 1] =~ '\a' |
| 1627 | let start -= 1 |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1628 | endwhile |
| 1629 | return start |
| 1630 | else |
| 1631 | " find months matching with "a:base" |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1632 | let res = [] |
| 1633 | for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") |
| 1634 | if m =~ '^' . a:base |
| 1635 | call add(res, m) |
| 1636 | endif |
| 1637 | endfor |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1638 | return res |
| 1639 | endif |
| 1640 | endfun |
| 1641 | set completefunc=CompleteMonths |
Bram Moolenaar | 5a8684e | 2005-07-30 22:43:24 +0000 | [diff] [blame] | 1642 | < |
Bram Moolenaar | 572cb56 | 2005-08-05 21:35:02 +0000 | [diff] [blame] | 1643 | The same, but now pretending searching for matches is slow: > |
| 1644 | fun! CompleteMonths(findstart, col, base) |
| 1645 | if a:findstart |
| 1646 | " locate the start of the word |
| 1647 | let line = getline('.') |
| 1648 | let start = a:col |
| 1649 | while start > 0 && line[start - 1] =~ '\a' |
| 1650 | let start -= 1 |
| 1651 | endwhile |
| 1652 | return start |
| 1653 | else |
| 1654 | " find months matching with "a:base" |
| 1655 | for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") |
| 1656 | if m =~ '^' . a:base |
| 1657 | call complete_add(m) |
| 1658 | endif |
| 1659 | sleep 300m " simulate searching for next match |
| 1660 | if complete_check() |
| 1661 | break |
| 1662 | endif |
| 1663 | endfor |
| 1664 | return [] |
| 1665 | endif |
| 1666 | endfun |
| 1667 | set completefunc=CompleteMonths |
| 1668 | < |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 1669 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1670 | *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 1671 | 'confirm' 'cf' boolean (default off) |
| 1672 | global |
| 1673 | {not in Vi} |
| 1674 | When 'confirm' is on, certain operations that would normally |
| 1675 | fail because of unsaved changes to a buffer, e.g. ":q" and ":e", |
| 1676 | instead raise a |dialog| asking if you wish to save the current |
| 1677 | file(s). You can still use a ! to unconditionally |abandon| a buffer. |
| 1678 | If 'confirm' is off you can still activate confirmation for one |
| 1679 | command only (this is most useful in mappings) with the |:confirm| |
| 1680 | command. |
| 1681 | Also see the |confirm()| function and the 'v' flag in 'guioptions'. |
| 1682 | |
| 1683 | *'conskey'* *'consk'* *'noconskey'* *'noconsk'* |
| 1684 | 'conskey' 'consk' boolean (default off) |
| 1685 | global |
| 1686 | {not in Vi} {only for MS-DOS} |
| 1687 | When on direct console I/O is used to obtain a keyboard character. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1688 | This should work in most cases. Also see |'bioskey'|. Together, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1689 | three methods of console input are available: |
| 1690 | 'conskey' 'bioskey' action ~ |
| 1691 | on on or off direct console input |
| 1692 | off on BIOS |
| 1693 | off off STDIN |
| 1694 | |
| 1695 | *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* |
| 1696 | 'copyindent' 'ci' boolean (default off) |
| 1697 | local to buffer |
| 1698 | {not in Vi} |
| 1699 | Copy the structure of the existing lines indent when autoindenting a |
| 1700 | new line. Normally the new indent is reconstructed by a series of |
| 1701 | tabs followed by spaces as required (unless |'expandtab'| is enabled, |
| 1702 | in which case only spaces are used). Enabling this option makes the |
| 1703 | new line copy whatever characters were used for indenting on the |
| 1704 | existing line. If the new indent is greater than on the existing |
| 1705 | line, the remaining space is filled in the normal manner. |
| 1706 | NOTE: 'copyindent' is reset when 'compatible' is set. |
| 1707 | Also see 'preserveindent'. |
| 1708 | |
| 1709 | *'cpoptions'* *'cpo'* |
| 1710 | 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 1711 | Vi default: all flags) |
| 1712 | global |
| 1713 | {not in Vi} |
| 1714 | A sequence of single character flags. When a character is present |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1715 | this indicates vi-compatible behavior. This is used for things where |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1716 | not being vi-compatible is mostly or sometimes preferred. |
| 1717 | 'cpoptions' stands for "compatible-options". |
| 1718 | Commas can be added for readability. |
| 1719 | To avoid problems with flags that are added in the future, use the |
| 1720 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 1721 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 1722 | set and to the Vim default value when 'compatible' is reset. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1723 | NOTE: This option is set to the POSIX default value at startup when |
| 1724 | the Vi default value would be used and the $VIM_POSIX environment |
| 1725 | variable exists |posix|. This means tries to behave like the POSIX |
| 1726 | specification. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1727 | |
| 1728 | contains behavior ~ |
| 1729 | *cpo-a* |
| 1730 | a When included, a ":read" command with a file name |
| 1731 | argument will set the alternate file name for the |
| 1732 | current window. |
| 1733 | *cpo-A* |
| 1734 | A When included, a ":write" command with a file name |
| 1735 | argument will set the alternate file name for the |
| 1736 | current window. |
| 1737 | *cpo-b* |
| 1738 | b "\|" in a ":map" command is recognized as the end of |
| 1739 | the map command. The '\' is included in the mapping, |
| 1740 | the text after the '|' is interpreted as the next |
| 1741 | command. Use a CTRL-V instead of a backslash to |
| 1742 | include the '|' in the mapping. Applies to all |
| 1743 | mapping, abbreviation, menu and autocmd commands. |
| 1744 | See also |map_bar|. |
| 1745 | *cpo-B* |
| 1746 | B A backslash has no special meaning in mappings, |
| 1747 | abbreviations and the "to" part of the menu commands. |
| 1748 | Remove this flag to be able to use a backslash like a |
| 1749 | CTRL-V. For example, the command ":map X \<Esc>" |
| 1750 | results in X being mapped to: |
| 1751 | 'B' included: "\^[" (^[ is a real <Esc>) |
| 1752 | 'B' excluded: "<Esc>" (5 characters) |
| 1753 | ('<' excluded in both cases) |
| 1754 | *cpo-c* |
| 1755 | c Searching continues at the end of any match at the |
| 1756 | cursor position, but not further than the start of the |
| 1757 | next line. When not present searching continues |
| 1758 | one character from the cursor position. With 'c' |
| 1759 | "abababababab" only gets three matches when repeating |
| 1760 | "/abab", without 'c' there are five matches. |
| 1761 | *cpo-C* |
| 1762 | C Do not concatenate sourced lines that start with a |
| 1763 | backslash. See |line-continuation|. |
| 1764 | *cpo-d* |
| 1765 | d Using "./" in the 'tags' option doesn't mean to use |
| 1766 | the tags file relative to the current file, but the |
| 1767 | tags file in the current directory. |
| 1768 | *cpo-D* |
| 1769 | D Can't use CTRL-K to enter a digraph after Normal mode |
| 1770 | commands with a character argument, like |r|, |f| and |
| 1771 | |t|. |
| 1772 | *cpo-e* |
| 1773 | e When executing a register with ":@r", always add a |
| 1774 | <CR> to the last line, also when the register is not |
| 1775 | linewise. If this flag is not present, the register |
| 1776 | is not linewise and the last line does not end in a |
| 1777 | <CR>, then the last line is put on the command-line |
| 1778 | and can be edited before hitting <CR>. |
| 1779 | *cpo-E* |
| 1780 | E It is an error when using "y", "d", "c", "g~", "gu" or |
| 1781 | "gU" on an Empty region. The operators only work when |
| 1782 | at least one character is to be operate on. Example: |
| 1783 | This makes "y0" fail in the first column. |
| 1784 | *cpo-f* |
| 1785 | f When included, a ":read" command with a file name |
| 1786 | argument will set the file name for the current buffer, |
| 1787 | if the current buffer doesn't have a file name yet. |
| 1788 | *cpo-F* |
| 1789 | F When included, a ":write" command with a file name |
| 1790 | argument will set the file name for the current |
| 1791 | buffer, if the current buffer doesn't have a file name |
| 1792 | yet. |
| 1793 | *cpo-g* |
| 1794 | g Goto line 1 when using ":edit" without argument. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1795 | *cpo-H* |
| 1796 | H When using "I" on a line with only blanks, insert |
| 1797 | before the last blank. Without this flag insert after |
| 1798 | the last blank. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1799 | *cpo-i* |
| 1800 | i When included, interrupting the reading of a file will |
| 1801 | leave it modified. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1802 | *cpo-I* |
| 1803 | I When moving the cursor up or down just after inserting |
| 1804 | indent for 'autoindent', do not delete the indent. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1805 | *cpo-j* |
| 1806 | j When joining lines, only add two spaces after a '.', |
| 1807 | not after '!' or '?'. Also see 'joinspaces'. |
| 1808 | *cpo-J* |
| 1809 | J A |sentence| has to be followed by two spaces after |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 1810 | the '.', '!' or '?'. A <Tab> is not recognized as |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1811 | white space. |
| 1812 | *cpo-k* |
| 1813 | k Disable the recognition of raw key codes in |
| 1814 | mappings, abbreviations, and the "to" part of menu |
| 1815 | commands. For example, if <Key> sends ^[OA (where ^[ |
| 1816 | is <Esc>), the command ":map X ^[OA" results in X |
| 1817 | being mapped to: |
| 1818 | 'k' included: "^[OA" (3 characters) |
| 1819 | 'k' excluded: "<Key>" (one key code) |
| 1820 | Also see the '<' flag below. |
| 1821 | *cpo-K* |
| 1822 | K Don't wait for a key code to complete when it is |
| 1823 | halfway a mapping. This breaks mapping <F1><F1> when |
| 1824 | only part of the second <F1> has been read. It |
| 1825 | enables cancelling the mapping by typing <F1><Esc>. |
| 1826 | *cpo-l* |
| 1827 | l Backslash in a [] range in a search pattern is taken |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 1828 | literally, only "\]", "\^", "\-" and "\\" are special. |
| 1829 | See |/[]| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1830 | 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 1831 | 'l' excluded: "/[ \t]" finds <Space> and <Tab> |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 1832 | Also see |cpo-\|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1833 | *cpo-L* |
| 1834 | L When the 'list' option is set, 'wrapmargin', |
| 1835 | 'textwidth', 'softtabstop' and Virtual Replace mode |
| 1836 | (see |gR|) count a <Tab> as two characters, instead of |
| 1837 | the normal behavior of a <Tab>. |
| 1838 | *cpo-m* |
| 1839 | m When included, a showmatch will always wait half a |
| 1840 | second. When not included, a showmatch will wait half |
| 1841 | a second or until a character is typed. |'showmatch'| |
| 1842 | *cpo-M* |
| 1843 | M When excluded, "%" matching will take backslashes into |
| 1844 | account. Thus in "( \( )" and "\( ( \)" the outer |
| 1845 | parenthesis match. When included "%" ignores |
| 1846 | backslashes, which is Vi compatible. |
| 1847 | *cpo-n* |
| 1848 | n When included, the column used for 'number' will also |
| 1849 | be used for text of wrapped lines. |
| 1850 | *cpo-o* |
| 1851 | o Line offset to search command is not remembered for |
| 1852 | next search. |
| 1853 | *cpo-O* |
| 1854 | O Don't complain if a file is being overwritten, even |
| 1855 | when it didn't exist when editing it. This is a |
| 1856 | protection against a file unexpectedly created by |
| 1857 | someone else. Vi didn't complain about this. |
| 1858 | *cpo-p* |
| 1859 | p Vi compatible Lisp indenting. When not present, a |
| 1860 | slightly better algorithm is used. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1861 | *cpo-q* |
| 1862 | q When joining multiple lines leave the cursor at the |
| 1863 | position where it would be when joining two lines. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1864 | *cpo-r* |
| 1865 | r Redo ("." command) uses "/" to repeat a search |
| 1866 | command, instead of the actually used search string. |
| 1867 | *cpo-R* |
| 1868 | R Remove marks from filtered lines. Without this flag |
| 1869 | marks are kept like |:keepmarks| was used. |
| 1870 | *cpo-s* |
| 1871 | s Set buffer options when entering the buffer for the |
| 1872 | first time. This is like it is in Vim version 3.0. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1873 | And it is the default. If not present the options are |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1874 | set when the buffer is created. |
| 1875 | *cpo-S* |
| 1876 | S Set buffer options always when entering a buffer |
| 1877 | (except 'readonly', 'fileformat', 'filetype' and |
| 1878 | 'syntax'). This is the (most) Vi compatible setting. |
| 1879 | The options are set to the values in the current |
| 1880 | buffer. When you change an option and go to another |
| 1881 | buffer, the value is copied. Effectively makes the |
| 1882 | buffer options global to all buffers. |
| 1883 | |
| 1884 | 's' 'S' copy buffer options |
| 1885 | no no when buffer created |
| 1886 | yes no when buffer first entered (default) |
| 1887 | X yes each time when buffer entered (vi comp.) |
| 1888 | *cpo-t* |
| 1889 | t Search pattern for the tag command is remembered for |
| 1890 | "n" command. Otherwise Vim only puts the pattern in |
| 1891 | the history for search pattern, but doesn't change the |
| 1892 | last used search pattern. |
| 1893 | *cpo-u* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1894 | u Undo is Vi compatible. See |undo-two-ways|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1895 | *cpo-v* |
| 1896 | v Backspaced characters remain visible on the screen in |
| 1897 | Insert mode. Without this flag the characters are |
| 1898 | erased from the screen right away. With this flag the |
| 1899 | screen newly typed text overwrites backspaced |
| 1900 | characters. |
| 1901 | *cpo-w* |
| 1902 | w When using "cw" on a blank character, only change one |
| 1903 | character and not all blanks until the start of the |
| 1904 | next word. |
| 1905 | *cpo-W* |
| 1906 | W Don't overwrite a readonly file. When omitted, ":w!" |
| 1907 | overwrites a readonly file, if possible. |
| 1908 | *cpo-x* |
| 1909 | x <Esc> on the command-line executes the command-line. |
| 1910 | The default in Vim is to abandon the command-line, |
| 1911 | because <Esc> normally aborts a command. |c_<Esc>| |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1912 | *cpo-X* |
| 1913 | X When using a count with "R" the replaced text is |
| 1914 | deleted only once. Also when repeating "R" with "." |
| 1915 | and a count. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1916 | *cpo-y* |
| 1917 | y A yank command can be redone with ".". |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1918 | *cpo-Z* |
| 1919 | Z When using "w!" while the 'readonly' option is set, |
| 1920 | don't reset 'readonly'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1921 | *cpo-!* |
| 1922 | ! When redoing a filter command, use the last used |
| 1923 | external command, whatever it was. Otherwise the last |
| 1924 | used -filter- command is used. |
| 1925 | *cpo-$* |
| 1926 | $ When making a change to one line, don't redisplay the |
| 1927 | line, but put a '$' at the end of the changed text. |
| 1928 | The changed text will be overwritten when you type the |
| 1929 | new text. The line is redisplayed if you type any |
| 1930 | command that moves the cursor from the insertion |
| 1931 | point. |
| 1932 | *cpo-%* |
| 1933 | % Vi-compatible matching is done for the "%" command. |
| 1934 | Does not recognize "#if", "#endif", etc. |
| 1935 | Does not recognize "/*" and "*/". |
| 1936 | Parens inside single and double quotes are also |
| 1937 | counted, causing a string that contains a paren to |
| 1938 | disturb the matching. For example, in a line like |
| 1939 | "if (strcmp("foo(", s))" the first paren does not |
| 1940 | match the last one. When this flag is not included, |
| 1941 | parens inside single and double quotes are treated |
| 1942 | specially. When matching a paren outside of quotes, |
| 1943 | everything inside quotes is ignored. When matching a |
| 1944 | paren inside quotes, it will find the matching one (if |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1945 | there is one). This works very well for C programs. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1946 | This flag is also used for other features, such as |
| 1947 | C-indenting. |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 1948 | *cpo--* |
| 1949 | - When included, a vertical movement command fails when |
| 1950 | it would above the first line or below the last line. |
| 1951 | Without it the cursor moves to the first or last line, |
| 1952 | unless it already was in that line. |
| 1953 | Applies to the commands "-", "k", CTRL-P, "+", "j", |
| 1954 | CTRL-N and CTRL-J. |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 1955 | *cpo-+* |
| 1956 | + When included, a ":write file" command will reset the |
| 1957 | 'modified' flag of the buffer, even though the buffer |
| 1958 | itself may still be different from its file. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1959 | *cpo-star* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1960 | * Use ":*" in the same way as ":@". When not included, |
| 1961 | ":*" is an alias for ":'<,'>", select the Visual area. |
| 1962 | *cpo-<* |
| 1963 | < Disable the recognition of special key codes in |<>| |
| 1964 | form in mappings, abbreviations, and the "to" part of |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1965 | menu commands. For example, the command |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1966 | ":map X <Tab>" results in X being mapped to: |
| 1967 | '<' included: "<Tab>" (5 characters) |
| 1968 | '<' excluded: "^I" (^I is a real <Tab>) |
| 1969 | Also see the 'k' flag above. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1970 | *cpo->* |
| 1971 | > When appending to a register, put a line break before |
| 1972 | the appended text. |
| 1973 | |
| 1974 | POSIX flags. These are not included in the Vi default value, except |
| 1975 | when $VIM_POSIX was set on startup. |posix| |
| 1976 | |
| 1977 | contains behavior ~ |
| 1978 | *cpo-#* |
| 1979 | # A count before "D", "o" and "O" has no effect. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 1980 | *cpo-&* |
| 1981 | & When ":preserve" was used keep the swap file when |
| 1982 | exiting normally while this buffer is still loaded. |
| 1983 | This flag is tested when exiting. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 1984 | *cpo-\* |
| 1985 | \ Backslash in a [] range in a search pattern is taken |
| 1986 | literally, only "\]" is special See |/[]| |
Bram Moolenaar | 90915b5 | 2005-08-21 22:17:52 +0000 | [diff] [blame] | 1987 | '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 1988 | '\' excluded: "/[ \-]" finds <Space> and '-' |
| 1989 | Also see |cpo-l|. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 1990 | *cpo-/* |
| 1991 | / When "%" is used as the replacement string in a |:s| |
| 1992 | command, use the previous replacement string. |:s%| |
| 1993 | *cpo-{* |
| 1994 | { The |{| and |}| commands also stop at a "{" character |
| 1995 | at the start of a line. |
| 1996 | *cpo-.* |
| 1997 | . The ":chdir" and ":cd" commands fail if the current |
| 1998 | buffer is modified, unless ! is used. Vim doesn't |
| 1999 | need this, since it remembers the full path of an |
| 2000 | opened file. |
| 2001 | *cpo-bar* |
| 2002 | | The value of the $LINES and $COLUMNS environment |
| 2003 | variables overrule the terminal size values obtained |
| 2004 | with system specific functions. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2005 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2006 | |
| 2007 | *'cscopepathcomp'* *'cspc'* |
| 2008 | 'cscopepathcomp' 'cspc' number (default 0) |
| 2009 | global |
| 2010 | {not available when compiled without the |+cscope| |
| 2011 | feature} |
| 2012 | {not in Vi} |
| 2013 | Determines how many components of the path to show in a list of tags. |
| 2014 | See |cscopepathcomp|. |
| 2015 | |
| 2016 | *'cscopeprg'* *'csprg'* |
| 2017 | 'cscopeprg' 'csprg' string (default "cscope") |
| 2018 | global |
| 2019 | {not available when compiled without the |+cscope| |
| 2020 | feature} |
| 2021 | {not in Vi} |
| 2022 | Specifies the command to execute cscope. See |cscopeprg|. |
| 2023 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2024 | security reasons. |
| 2025 | |
| 2026 | *'cscopequickfix'* *'csqf'* |
| 2027 | 'cscopequickfix' 'csqf' string (default "") |
| 2028 | global |
| 2029 | {not available when compiled without the |+cscope| |
| 2030 | or |+quickfix| features} |
| 2031 | {not in Vi} |
| 2032 | Specifies whether to use quickfix window to show cscope results. |
| 2033 | See |cscopequickfix|. |
| 2034 | |
| 2035 | *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2036 | 'cscopetag' 'cst' boolean (default off) |
| 2037 | global |
| 2038 | {not available when compiled without the |+cscope| |
| 2039 | feature} |
| 2040 | {not in Vi} |
| 2041 | Use cscope for tag commands. See |cscope-options|. |
| 2042 | NOTE: This option is reset when 'compatible' is set. |
| 2043 | |
| 2044 | *'cscopetagorder'* *'csto'* |
| 2045 | 'cscopetagorder' 'csto' number (default 0) |
| 2046 | global |
| 2047 | {not available when compiled without the |+cscope| |
| 2048 | feature} |
| 2049 | {not in Vi} |
| 2050 | Determines the order in which ":cstag" performs a search. See |
| 2051 | |cscopetagorder|. |
| 2052 | NOTE: This option is set to 0 when 'compatible' is set. |
| 2053 | |
| 2054 | *'cscopeverbose'* *'csverb'* |
| 2055 | *'nocscopeverbose'* *'nocsverb'* |
| 2056 | 'cscopeverbose' 'csverb' boolean (default off) |
| 2057 | global |
| 2058 | {not available when compiled without the |+cscope| |
| 2059 | feature} |
| 2060 | {not in Vi} |
| 2061 | Give messages when adding a cscope database. See |cscopeverbose|. |
| 2062 | NOTE: This option is reset when 'compatible' is set. |
| 2063 | |
| 2064 | *'debug'* |
| 2065 | 'debug' string (default "") |
| 2066 | global |
| 2067 | {not in Vi} |
| 2068 | When set to "msg", error messages that would otherwise be omitted will |
| 2069 | be given anyway. This is useful when debugging 'foldexpr' or |
| 2070 | 'indentexpr'. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2071 | When set to "beep", a message will be given when otherwise only a beep |
| 2072 | would be produced. |
| 2073 | The values can be combined, separated by a comma. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2074 | |
| 2075 | *'define'* *'def'* |
| 2076 | 'define' 'def' string (default "^\s*#\s*define") |
| 2077 | global or local to buffer |global-local| |
| 2078 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2079 | Pattern to be used to find a macro definition. It is a search |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2080 | pattern, just like for the "/" command. This option is used for the |
| 2081 | commands like "[i" and "[d" |include-search|. The 'isident' option is |
| 2082 | used to recognize the defined name after the match: |
| 2083 | {match with 'define'}{non-ID chars}{defined name}{non-ID char} |
| 2084 | See |option-backslash| about inserting backslashes to include a space |
| 2085 | or backslash. |
| 2086 | The default value is for C programs. For C++ this value would be |
| 2087 | useful, to include const type declarations: > |
| 2088 | ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) |
| 2089 | < When using the ":set" command, you need to double the backslashes! |
| 2090 | |
| 2091 | *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* |
| 2092 | 'delcombine' 'deco' boolean (default off) |
| 2093 | global |
| 2094 | {not in Vi} |
| 2095 | {only available when compiled with the |+multi_byte| |
| 2096 | feature} |
| 2097 | If editing Unicode and this option is set, backspace and Normal mode |
| 2098 | "x" delete each combining character on its own. When it is off (the |
| 2099 | default) the character along with its combining characters are |
| 2100 | deleted. |
| 2101 | Note: When 'delcombine' is set "xx" may work different from "2x"! |
| 2102 | |
| 2103 | This is useful for Arabic, Hebrew and many other languages where one |
| 2104 | may have combining characters overtop of base characters, and want |
| 2105 | to remove only the combining ones. |
| 2106 | |
| 2107 | *'dictionary'* *'dict'* |
| 2108 | 'dictionary' 'dict' string (default "") |
| 2109 | global or local to buffer |global-local| |
| 2110 | {not in Vi} |
| 2111 | List of file names, separated by commas, that are used to lookup words |
| 2112 | for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should |
| 2113 | contain a list of words. This can be one word per line, or several |
| 2114 | words per line, separated by non-keyword characters (white space is |
| 2115 | preferred). Maximum line length is 510 bytes. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2116 | To include a comma in a file name precede it with a backslash. Spaces |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2117 | after a comma are ignored, otherwise spaces are included in the file |
| 2118 | name. See |option-backslash| about using backslashes. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 2119 | This has nothing to do with the |Dictionary| variable type. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2120 | Where to find a list of words? |
| 2121 | - On FreeBSD, there is the file "/usr/share/dict/words". |
| 2122 | - In the Simtel archive, look in the "msdos/linguist" directory. |
| 2123 | - In "miscfiles" of the GNU collection. |
| 2124 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2125 | directories from the list. This avoids problems when a future version |
| 2126 | uses another default. |
| 2127 | Backticks cannot be used in this option for security reasons. |
| 2128 | |
| 2129 | *'diff'* *'nodiff'* |
| 2130 | 'diff' boolean (default off) |
| 2131 | local to window |
| 2132 | {not in Vi} |
| 2133 | {not available when compiled without the |+diff| |
| 2134 | feature} |
| 2135 | Join the current window in the group of windows that shows differences |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2136 | between files. See |vimdiff|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2137 | |
| 2138 | *'dex'* *'diffexpr'* |
| 2139 | 'diffexpr' 'dex' string (default "") |
| 2140 | global |
| 2141 | {not in Vi} |
| 2142 | {not available when compiled without the |+diff| |
| 2143 | feature} |
| 2144 | Expression which is evaluated to obtain an ed-style diff file from two |
| 2145 | versions of a file. See |diff-diffexpr|. |
| 2146 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2147 | security reasons. |
| 2148 | |
| 2149 | *'dip'* *'diffopt'* |
| 2150 | 'diffopt' 'dip' string (default "filler") |
| 2151 | global |
| 2152 | {not in Vi} |
| 2153 | {not available when compiled without the |+diff| |
| 2154 | feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2155 | Option settings for diff mode. It can consist of the following items. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2156 | All are optional. Items must be separated by a comma. |
| 2157 | |
| 2158 | filler Show filler lines, to keep the text |
| 2159 | synchronized with a window that has inserted |
| 2160 | lines at the same position. Mostly useful |
| 2161 | when windows are side-by-side and 'scrollbind' |
| 2162 | is set. |
| 2163 | |
| 2164 | context:{n} Use a context of {n} lines between a change |
| 2165 | and a fold that contains unchanged lines. |
| 2166 | When omitted a context of six lines is used. |
| 2167 | See |fold-diff|. |
| 2168 | |
| 2169 | icase Ignore changes in case of text. "a" and "A" |
| 2170 | are considered the same. Adds the "-i" flag |
| 2171 | to the "diff" command if 'diffexpr' is empty. |
| 2172 | |
| 2173 | iwhite Ignore changes in amount of white space. Adds |
| 2174 | the "-b" flag to the "diff" command if |
| 2175 | 'diffexpr' is empty. Check the documentation |
| 2176 | of the "diff" command for what this does |
| 2177 | exactly. It should ignore adding trailing |
| 2178 | white space, but not leading white space. |
| 2179 | |
| 2180 | Examples: > |
| 2181 | |
| 2182 | :set diffopt=filler,context:4 |
| 2183 | :set diffopt= |
| 2184 | :set diffopt=filler |
| 2185 | < |
| 2186 | *'digraph'* *'dg'* *'nodigraph'* *'nodg'* |
| 2187 | 'digraph' 'dg' boolean (default off) |
| 2188 | global |
| 2189 | {not in Vi} |
| 2190 | {not available when compiled without the |+digraphs| |
| 2191 | feature} |
| 2192 | Enable the entering of digraphs in Insert mode with {char1} <BS> |
| 2193 | {char2}. See |digraphs|. |
| 2194 | NOTE: This option is reset when 'compatible' is set. |
| 2195 | |
| 2196 | *'directory'* *'dir'* |
| 2197 | 'directory' 'dir' string (default for Amiga: ".,t:", |
| 2198 | for MS-DOS and Win32: ".,c:\tmp,c:\temp" |
| 2199 | for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2200 | global |
| 2201 | List of directory names for the swap file, separated with commas. |
| 2202 | - The swap file will be created in the first directory where this is |
| 2203 | possible. |
| 2204 | - Empty means that no swap file will be used (recovery is |
| 2205 | impossible!). |
| 2206 | - A directory "." means to put the swap file in the same directory as |
| 2207 | the edited file. On Unix, a dot is prepended to the file name, so |
| 2208 | it doesn't show in a directory listing. On MS-Windows the "hidden" |
| 2209 | attribute is set and a dot prepended if possible. |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 2210 | - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2211 | put the swap file relative to where the edited file is. The leading |
| 2212 | "." is replaced with the path name of the edited file. |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 2213 | - For Unix and Win32, if a directory ends in two path separators "//" |
| 2214 | or "\\", the swap file name will be built from the complete path to |
| 2215 | the file with all path separators substituted to percent '%' signs. |
| 2216 | This will ensure file name uniqueness in the preserve directory. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2217 | - Spaces after the comma are ignored, other spaces are considered part |
| 2218 | of the directory name. To have a space at the start of a directory |
| 2219 | name, precede it with a backslash. |
| 2220 | - To include a comma in a directory name precede it with a backslash. |
| 2221 | - A directory name may end in an ':' or '/'. |
| 2222 | - Environment variables are expanded |:set_env|. |
| 2223 | - Careful with '\' characters, type one before a space, type two to |
| 2224 | get one in the option (see |option-backslash|), for example: > |
| 2225 | :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces |
| 2226 | < - For backwards compatibility with Vim version 3.0 a '>' at the start |
| 2227 | of the option is removed. |
| 2228 | Using "." first in the list is recommended. This means that editing |
| 2229 | the same file twice will result in a warning. Using "/tmp" on Unix is |
| 2230 | discouraged: When the system crashes you lose the swap file. |
| 2231 | "/var/tmp" is often not cleared when rebooting, thus is a better |
| 2232 | choice than "/tmp". But it can contain a lot of files, your swap |
| 2233 | files get lost in the crowd. That is why a "tmp" directory in your |
| 2234 | home directory is tried first. |
| 2235 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2236 | directories from the list. This avoids problems when a future version |
| 2237 | uses another default. |
| 2238 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2239 | security reasons. |
| 2240 | {Vi: directory to put temp file in, defaults to "/tmp"} |
| 2241 | |
| 2242 | *'display'* *'dy'* |
| 2243 | 'display' 'dy' string (default "") |
| 2244 | global |
| 2245 | {not in Vi} |
| 2246 | Change the way text is displayed. This is comma separated list of |
| 2247 | flags: |
| 2248 | lastline When included, as much as possible of the last line |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2249 | in a window will be displayed. When not included, a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2250 | last line that doesn't fit is replaced with "@" lines. |
| 2251 | uhex Show unprintable characters hexadecimal as <xx> |
| 2252 | instead of using ^C and ~C. |
| 2253 | |
| 2254 | *'eadirection'* *'ead'* |
| 2255 | 'eadirection' 'ead' string (default "both") |
| 2256 | global |
| 2257 | {not in Vi} |
| 2258 | {not available when compiled without the +vertsplit |
| 2259 | feature} |
| 2260 | Tells when the 'equalalways' option applies: |
| 2261 | ver vertically, width of windows is not affected |
| 2262 | hor horizontally, height of windows is not affected |
| 2263 | both width and height of windows is affected |
| 2264 | |
| 2265 | *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* |
| 2266 | 'edcompatible' 'ed' boolean (default off) |
| 2267 | global |
| 2268 | Makes the 'g' and 'c' flags of the ":substitute" command to be |
| 2269 | toggled each time the flag is given. See |complex-change|. See |
| 2270 | also 'gdefault' option. |
| 2271 | Switching this option on is discouraged! |
| 2272 | |
| 2273 | *'encoding'* *'enc'* *E543* |
| 2274 | 'encoding' 'enc' string (default: "latin1" or value from $LANG) |
| 2275 | global |
| 2276 | {only available when compiled with the |+multi_byte| |
| 2277 | feature} |
| 2278 | {not in Vi} |
| 2279 | Sets the character encoding used inside Vim. It applies to text in |
| 2280 | the buffers, registers, Strings in expressions, text stored in the |
| 2281 | viminfo file, etc. It sets the kind of characters which Vim can work |
| 2282 | with. See |encoding-names| for the possible values. |
| 2283 | |
| 2284 | NOTE: Changing this option will not change the encoding of the |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 2285 | existing text in Vim. It may cause non-ASCII text to become invalid. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2286 | It should normally be kept at its default value, or set when Vim |
| 2287 | starts up. See |multibyte|. |
| 2288 | |
| 2289 | NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to |
| 2290 | "utf-8". Although care has been taken to allow different values of |
| 2291 | 'encoding', "utf-8" is the natural choice for the environment and |
| 2292 | avoids unnecessary conversion overhead. "utf-8" has not been made |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2293 | the default to prevent different behavior of the GUI and terminal |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2294 | versions, and to avoid changing the encoding of newly created files |
| 2295 | without your knowledge (in case 'fileencodings' is empty). |
| 2296 | |
| 2297 | The character encoding of files can be different from 'encoding'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2298 | This is specified with 'fileencoding'. The conversion is done with |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2299 | iconv() or as specified with 'charconvert'. |
| 2300 | |
| 2301 | Normally 'encoding' will be equal to your current locale. This will |
| 2302 | be the default if Vim recognizes your environment settings. If |
| 2303 | 'encoding' is not set to the current locale, 'termencoding' must be |
| 2304 | set to convert typed and displayed text. See |encoding-table|. |
| 2305 | |
| 2306 | When you set this option, it fires the |EncodingChanged| autocommand |
| 2307 | event so that you can set up fonts if necessary. |
| 2308 | |
| 2309 | When the option is set, the value is converted to lowercase. Thus |
| 2310 | you can set it with uppercase values too. Underscores are translated |
| 2311 | to '-' signs. |
| 2312 | When the encoding is recognized, it is changed to the standard name. |
| 2313 | For example "Latin-1" becomes "latin1", "ISO_88592" becomes |
| 2314 | "iso-8859-2" and "utf8" becomes "utf-8". |
| 2315 | |
| 2316 | Note: "latin1" is also used when the encoding could not be detected. |
| 2317 | This only works when editing files in the same encoding! When the |
| 2318 | actual character set is not latin1, make sure 'fileencoding' and |
| 2319 | 'fileencodings' are empty. When conversion is needed, switch to using |
| 2320 | utf-8. |
| 2321 | |
| 2322 | When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. |
| 2323 | You don't notice this while editing, but it does matter for the |
| 2324 | |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus |
| 2325 | setting 'encoding' to one of these values instead of utf-8 only has |
| 2326 | effect for encoding used for files when 'fileencoding' is empty. |
| 2327 | |
Bram Moolenaar | 661b182 | 2005-07-28 22:36:45 +0000 | [diff] [blame] | 2328 | When 'encoding' is set to a Unicode encoding, and 'fileencodings' was |
| 2329 | not set yet, the default for 'fileencodings' is changed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2330 | |
| 2331 | *'endofline'* *'eol'* *'noendofline'* *'noeol'* |
| 2332 | 'endofline' 'eol' boolean (default on) |
| 2333 | local to buffer |
| 2334 | {not in Vi} |
| 2335 | When writing a file and this option is off and the 'binary' option |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2336 | is on, no <EOL> will be written for the last line in the file. This |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2337 | option is automatically set when starting to edit a new file, unless |
| 2338 | the file does not have an <EOL> for the last line in the file, in |
| 2339 | which case it is reset. Normally you don't have to set or reset this |
| 2340 | option. When 'binary' is off the value is not used when writing the |
| 2341 | file. When 'binary' is on it is used to remember the presence of a |
| 2342 | <EOL> for the last line in the file, so that when you write the file |
| 2343 | the situation from the original file can be kept. But you can change |
| 2344 | it if you want to. |
| 2345 | |
| 2346 | *'equalalways'* *'ea'* *'noequalalways'* *'noea'* |
| 2347 | 'equalalways' 'ea' boolean (default on) |
| 2348 | global |
| 2349 | {not in Vi} |
| 2350 | When on, all the windows are automatically made the same size after |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 2351 | splitting or closing a window. This also happens the moment the |
| 2352 | option is switched on. When off, splitting a window will reduce the |
| 2353 | size of the current window and leave the other windows the same. When |
| 2354 | closing a window the extra lines are given to the window next to it |
| 2355 | (depending on 'splitbelow' and 'splitright'). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2356 | When mixing vertically and horizontally split windows, a minimal size |
| 2357 | is computed and some windows may be larger if there is room. The |
| 2358 | 'eadirection' option tells in which direction the size is affected. |
| 2359 | Changing the height of a window can be avoided by setting |
| 2360 | 'winfixheight'. |
| 2361 | |
| 2362 | *'equalprg'* *'ep'* |
| 2363 | 'equalprg' 'ep' string (default "") |
| 2364 | global or local to buffer |global-local| |
| 2365 | {not in Vi} |
| 2366 | External program to use for "=" command. When this option is empty |
| 2367 | the internal formatting functions are used ('lisp', 'cindent' or |
| 2368 | 'indentexpr'). |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2369 | Environment variables are expanded |:set_env|. See |option-backslash| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2370 | about including spaces and backslashes. |
| 2371 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2372 | security reasons. |
| 2373 | |
| 2374 | *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* |
| 2375 | 'errorbells' 'eb' boolean (default off) |
| 2376 | global |
| 2377 | Ring the bell (beep or screen flash) for error messages. This only |
| 2378 | makes a difference for error messages, the bell will be used always |
| 2379 | for a lot of errors without a message (e.g., hitting <Esc> in Normal |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2380 | mode). See 'visualbell' on how to make the bell behave like a beep, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2381 | screen flash or do nothing. |
| 2382 | |
| 2383 | *'errorfile'* *'ef'* |
| 2384 | 'errorfile' 'ef' string (Amiga default: "AztecC.Err", |
| 2385 | others: "errors.err") |
| 2386 | global |
| 2387 | {not in Vi} |
| 2388 | {not available when compiled without the |+quickfix| |
| 2389 | feature} |
| 2390 | Name of the errorfile for the QuickFix mode (see |:cf|). |
| 2391 | When the "-q" command-line argument is used, 'errorfile' is set to the |
| 2392 | following argument. See |-q|. |
| 2393 | NOT used for the ":make" command. See 'makeef' for that. |
| 2394 | Environment variables are expanded |:set_env|. |
| 2395 | See |option-backslash| about including spaces and backslashes. |
| 2396 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2397 | security reasons. |
| 2398 | |
| 2399 | *'errorformat'* *'efm'* |
| 2400 | 'errorformat' 'efm' string (default is very long) |
| 2401 | global or local to buffer |global-local| |
| 2402 | {not in Vi} |
| 2403 | {not available when compiled without the |+quickfix| |
| 2404 | feature} |
| 2405 | Scanf-like description of the format for the lines in the error file |
| 2406 | (see |errorformat|). |
| 2407 | |
| 2408 | *'esckeys'* *'ek'* *'noesckeys'* *'noek'* |
| 2409 | 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) |
| 2410 | global |
| 2411 | {not in Vi} |
| 2412 | Function keys that start with an <Esc> are recognized in Insert |
| 2413 | mode. When this option is off, the cursor and function keys cannot be |
| 2414 | used in Insert mode if they start with an <Esc>. The advantage of |
| 2415 | this is that the single <Esc> is recognized immediately, instead of |
| 2416 | after one second. Instead of resetting this option, you might want to |
| 2417 | try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that |
| 2418 | when 'esckeys' is off, you can still map anything, but the cursor keys |
| 2419 | won't work by default. |
| 2420 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 2421 | set and to the Vim default value when 'compatible' is reset. |
| 2422 | |
| 2423 | *'eventignore'* *'ei'* |
| 2424 | 'eventignore' 'ei' string (default "") |
| 2425 | global |
| 2426 | {not in Vi} |
| 2427 | {not available when compiled without the |+autocmd| |
| 2428 | feature} |
| 2429 | A list of autocommand event names, which are to be ignored. |
| 2430 | When set to "all", all autocommand events are ignored, autocommands |
| 2431 | will not be executed. |
| 2432 | Otherwise this is a comma separated list of event names. Example: > |
| 2433 | :set ei=WinEnter,WinLeave |
| 2434 | < |
| 2435 | *'expandtab'* *'et'* *'noexpandtab'* *'noet'* |
| 2436 | 'expandtab' 'et' boolean (default off) |
| 2437 | local to buffer |
| 2438 | {not in Vi} |
| 2439 | In Insert mode: Use the appropriate number of spaces to insert a |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2440 | <Tab>. Spaces are used in indents with the '>' and '<' commands and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2441 | when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 2442 | on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. |
| 2443 | NOTE: This option is reset when 'compatible' is set. |
| 2444 | |
| 2445 | *'exrc'* *'ex'* *'noexrc'* *'noex'* |
| 2446 | 'exrc' 'ex' boolean (default off) |
| 2447 | global |
| 2448 | {not in Vi} |
| 2449 | Enables the reading of .vimrc, .exrc and .gvimrc in the current |
| 2450 | directory. If you switch this option on you should also consider |
| 2451 | setting the 'secure' option (see |initialization|). Using a local |
| 2452 | .exrc, .vimrc or .gvimrc is a potential security leak, use with care! |
| 2453 | also see |.vimrc| and |gui-init|. |
| 2454 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2455 | security reasons. |
| 2456 | |
| 2457 | *'fileencoding'* *'fenc'* *E213* |
| 2458 | 'fileencoding' 'fenc' string (default: "") |
| 2459 | local to buffer |
| 2460 | {only available when compiled with the |+multi_byte| |
| 2461 | feature} |
| 2462 | {not in Vi} |
| 2463 | Sets the character encoding for the file of this buffer. |
| 2464 | When 'fileencoding' is different from 'encoding', conversion will be |
| 2465 | done when reading and writing the file. |
| 2466 | When 'fileencoding' is empty, the same value as 'encoding' will be |
| 2467 | used (no conversion when reading or writing a file). |
| 2468 | WARNING: Conversion can cause loss of information! When |
| 2469 | 'encoding' is "utf-8" conversion is most likely done in a way |
| 2470 | that the reverse conversion results in the same text. When |
| 2471 | 'encoding' is not "utf-8" some characters may be lost! |
| 2472 | See 'encoding' for the possible values. Additionally, values may be |
| 2473 | specified that can be handled by the converter, see |
| 2474 | |mbyte-conversion|. |
| 2475 | When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 2476 | To read a file in a certain encoding it won't work by setting |
| 2477 | 'fileencoding', use the |++enc| argument. |
| 2478 | Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 2479 | When the option is set, the value is converted to lowercase. Thus |
| 2480 | you can set it with uppercase values too. '_' characters are |
| 2481 | replaced with '-'. If a name is recognized from the list for |
| 2482 | 'encoding', it is replaced by the standard name. For example |
| 2483 | "ISO8859-2" becomes "iso-8859-2". |
| 2484 | When this option is set, after starting to edit a file, the 'modified' |
| 2485 | option is set, because the file would be different when written. |
| 2486 | If you do this in a modeline, you might want to set 'nomodified' to |
| 2487 | avoid this. |
| 2488 | This option can not be changed when 'modifiable' is off. |
| 2489 | |
| 2490 | *'fe'* |
| 2491 | NOTE: Before version 6.0 this option specified the encoding for the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2492 | whole of Vim, this was a mistake. Now use 'encoding' instead. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2493 | old short name was 'fe', which is no longer used. |
| 2494 | |
| 2495 | *'fileencodings'* *'fencs'* |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 2496 | 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 2497 | "ucs-bom,utf-8,default,latin1" when |
| 2498 | 'encoding' is set to a Unicode value) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2499 | global |
| 2500 | {only available when compiled with the |+multi_byte| |
| 2501 | feature} |
| 2502 | {not in Vi} |
| 2503 | This is a list of character encodings considered when starting to edit |
| 2504 | an existing file. When a file is read, Vim tries to use the first |
| 2505 | mentioned character encoding. If an error is detected, the next one |
| 2506 | in the list is tried. When an encoding is found that works, |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2507 | 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2508 | an empty string, which means the value of 'encoding' is used. |
| 2509 | WARNING: Conversion can cause loss of information! When |
| 2510 | 'encoding' is "utf-8" (or one of the other Unicode variants) |
| 2511 | conversion is most likely done in a way that the reverse |
| 2512 | conversion results in the same text. When 'encoding' is not |
| 2513 | "utf-8" special characters may be lost! |
| 2514 | For an empty file or a file with only ASCII characters most encodings |
| 2515 | will work and the first entry of 'fileencodings' will be used (except |
| 2516 | "ucs-bom", which requires the BOM to be present). If you prefer |
| 2517 | another encoding use an BufReadPost autocommand event to test if your |
| 2518 | preferred encoding is to be used. Example: > |
| 2519 | au BufReadPost * if search('\S', 'w') == 0 | |
| 2520 | \ set fenc=iso-2022-jp | endif |
| 2521 | < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain |
| 2522 | non-blank characters. |
| 2523 | Note that 'fileencodings' is not used for an new file, 'fileencoding' |
| 2524 | is always empty then. This means that a non-existing file may get a |
| 2525 | different encoding than an empty file. |
| 2526 | The special value "ucs-bom" can be used to check for a Unicode BOM |
| 2527 | (Byte Order Mark) at the start of the file. It must not be preceded |
| 2528 | by "utf-8" or another Unicode encoding for this to work properly. |
| 2529 | An entry for an 8-bit encoding (e.g., "latin1") should be the last, |
| 2530 | because Vim cannot detect an error, thus the encoding is always |
| 2531 | accepted. |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 2532 | The special value "default" can be used for the encoding from the |
| 2533 | environment. This is the default value for 'encoding'. It is useful |
| 2534 | when 'encoding' is set to "utf-8" and your environment uses a |
| 2535 | non-latin1 encoding, such as Russian. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2536 | WRONG VALUES: WHAT'S WRONG: |
| 2537 | latin1,utf-8 "latin1" will always be used |
| 2538 | utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 |
| 2539 | file |
| 2540 | cp1250,latin1 "cp1250" will always be used |
| 2541 | If 'fileencodings' is empty, 'fileencoding' is not modified. |
| 2542 | See 'fileencoding' for the possible values. |
| 2543 | Setting this option does not have an effect until the next time a file |
| 2544 | is read. |
| 2545 | |
| 2546 | *'fileformat'* *'ff'* |
| 2547 | 'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", |
| 2548 | Unix default: "unix", |
| 2549 | Macintosh default: "mac") |
| 2550 | local to buffer |
| 2551 | {not in Vi} |
| 2552 | This gives the <EOL> of the current buffer, which is used for |
| 2553 | reading/writing the buffer from/to a file: |
| 2554 | dos <CR> <NL> |
| 2555 | unix <NL> |
| 2556 | mac <CR> |
| 2557 | When "dos" is used, CTRL-Z at the end of a file is ignored. |
| 2558 | See |file-formats| and |file-read|. |
| 2559 | For the character encoding of the file see 'fileencoding'. |
| 2560 | When 'binary' is set, the value of 'fileformat' is ignored, file I/O |
| 2561 | works like it was set to "unix'. |
| 2562 | This option is set automatically when starting to edit a file and |
| 2563 | 'fileformats' is not empty and 'binary' is off. |
| 2564 | When this option is set, after starting to edit a file, the 'modified' |
| 2565 | option is set, because the file would be different when written. |
| 2566 | This option can not be changed when 'modifiable' is off. |
| 2567 | For backwards compatibility: When this option is set to "dos", |
| 2568 | 'textmode' is set, otherwise 'textmode' is reset. |
| 2569 | |
| 2570 | *'fileformats'* *'ffs'* |
| 2571 | 'fileformats' 'ffs' string (default: |
| 2572 | Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", |
| 2573 | Vim Unix: "unix,dos", |
| 2574 | Vim Mac: "mac,unix,dos", |
| 2575 | Vi Cygwin: "unix,dos", |
| 2576 | Vi others: "") |
| 2577 | global |
| 2578 | {not in Vi} |
| 2579 | This gives the end-of-line (<EOL>) formats that will be tried when |
| 2580 | starting to edit a new buffer and when reading a file into an existing |
| 2581 | buffer: |
| 2582 | - When empty, the format defined with 'fileformat' will be used |
| 2583 | always. It is not set automatically. |
| 2584 | - When set to one name, that format will be used whenever a new buffer |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2585 | is opened. 'fileformat' is set accordingly for that buffer. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2586 | 'fileformats' name will be used when a file is read into an existing |
| 2587 | buffer, no matter what 'fileformat' for that buffer is set to. |
| 2588 | - When more than one name is present, separated by commas, automatic |
| 2589 | <EOL> detection will be done when reading a file. When starting to |
| 2590 | edit a file, a check is done for the <EOL>: |
| 2591 | 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", |
| 2592 | 'fileformat' is set to "dos". |
| 2593 | 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2594 | is set to "unix". Note that when a <NL> is found without a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2595 | preceding <CR>, "unix" is preferred over "dos". |
| 2596 | 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac". |
| 2597 | This means that "mac" is only chosen when "unix" is not present, |
| 2598 | or when no <NL> is found in the file, and when "dos" is not |
| 2599 | present, or no <CR><NL> is present in the file. |
| 2600 | Also if "unix" was first chosen, but the first <CR> is before |
| 2601 | the first <NL> and there appears to be more <CR>'s than <NL>'s in |
| 2602 | the file, then 'fileformat' is set to "mac". |
| 2603 | 4. If 'fileformat' is still not set, the first name from |
| 2604 | 'fileformats' is used. |
| 2605 | When reading a file into an existing buffer, the same is done, but |
| 2606 | this happens like 'fileformat' has been set appropriately for that |
| 2607 | file only, the option is not changed. |
| 2608 | When 'binary' is set, the value of 'fileformats' is not used. |
| 2609 | |
| 2610 | For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 2611 | are ":source"ed and for vimrc files, automatic <EOL> detection may be |
| 2612 | done: |
| 2613 | - When 'fileformats' is empty, there is no automatic detection. Dos |
| 2614 | format will be used. |
| 2615 | - When 'fileformats' is set to one or more names, automatic detection |
| 2616 | is done. This is based on the first <NL> in the file: If there is a |
| 2617 | <CR> in front of it, Dos format is used, otherwise Unix format is |
| 2618 | used. |
| 2619 | Also see |file-formats|. |
| 2620 | For backwards compatibility: When this option is set to an empty |
| 2621 | string or one format (no comma is included), 'textauto' is reset, |
| 2622 | otherwise 'textauto' is set. |
| 2623 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 2624 | set and to the Vim default value when 'compatible' is reset. |
| 2625 | |
| 2626 | *'filetype'* *'ft'* |
| 2627 | 'filetype' 'ft' string (default: "") |
| 2628 | local to buffer |
| 2629 | {not in Vi} |
| 2630 | {not available when compiled without the |+autocmd| |
| 2631 | feature} |
| 2632 | When this option is set, the FileType autocommand event is triggered. |
| 2633 | All autocommands that match with the value of this option will be |
| 2634 | executed. Thus the value of 'filetype' is used in place of the file |
| 2635 | name. |
| 2636 | Otherwise this option does not always reflect the current file type. |
| 2637 | This option is normally set when the file type is detected. To enable |
| 2638 | this use the ":filetype on" command. |:filetype| |
| 2639 | Setting this option to a different value is most useful in a modeline, |
| 2640 | for a file for which the file type is not automatically recognized. |
| 2641 | Example, for in an IDL file: > |
| 2642 | /* vim: set filetype=idl : */ |
| 2643 | < |FileType| |filetypes| |
| 2644 | Do not confuse this option with 'osfiletype', which is for the file |
| 2645 | type that is actually stored with the file. |
| 2646 | This option is not copied to another buffer, independent of the 's' or |
| 2647 | 'S' flag in 'cpoptions'. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 2648 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2649 | |
| 2650 | *'fillchars'* *'fcs'* |
| 2651 | 'fillchars' 'fcs' string (default "vert:|,fold:-") |
| 2652 | global |
| 2653 | {not in Vi} |
| 2654 | {not available when compiled without the |+windows| |
| 2655 | and |+folding| features} |
| 2656 | Characters to fill the statuslines and vertical separators. |
| 2657 | It is a comma separated list of items: |
| 2658 | |
| 2659 | item default Used for ~ |
| 2660 | stl:c ' ' or '^' statusline of the current window |
| 2661 | stlnc:c ' ' or '-' statusline of the non-current windows |
| 2662 | vert:c '|' vertical separators |:vsplit| |
| 2663 | fold:c '-' filling 'foldtext' |
| 2664 | diff:c '-' deleted lines of the 'diff' option |
| 2665 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2666 | Any one that is omitted will fall back to the default. For "stl" and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2667 | "stlnc" the space will be used when there is highlighting, '^' or '-' |
| 2668 | otherwise. |
| 2669 | |
| 2670 | Example: > |
| 2671 | :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:- |
| 2672 | < This is similar to the default, except that these characters will also |
| 2673 | be used when there is highlighting. |
| 2674 | |
| 2675 | The highlighting used for these items: |
| 2676 | item highlight group ~ |
| 2677 | stl:c StatusLine |hl-StatusLine| |
| 2678 | stlnc:c StatusLineNC |hl-StatusLineNC| |
| 2679 | vert:c VertSplit |hl-VertSplit| |
| 2680 | fold:c Folded |hl-Folded| |
| 2681 | diff:c DiffDelete |hl-DiffDelete| |
| 2682 | |
| 2683 | *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 2684 | 'fkmap' 'fk' boolean (default off) *E198* |
| 2685 | global |
| 2686 | {not in Vi} |
| 2687 | {only available when compiled with the |+rightleft| |
| 2688 | feature} |
| 2689 | When on, the keyboard is mapped for the Farsi character set. |
| 2690 | Normally you would set 'allowrevins' and use CTRL-_ in insert mode to |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2691 | toggle this option |i_CTRL-_|. See |farsi.txt|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2692 | |
| 2693 | *'foldclose'* *'fcl'* |
| 2694 | 'foldclose' 'fcl' string (default "") |
| 2695 | global |
| 2696 | {not in Vi} |
| 2697 | {not available when compiled without the |+folding| |
| 2698 | feature} |
| 2699 | When set to "all", a fold is closed when the cursor isn't in it and |
| 2700 | its level is higher than 'foldlevel'. Useful if you want folds to |
| 2701 | automatically close when moving out of them. |
| 2702 | |
| 2703 | *'foldcolumn'* *'fdc'* |
| 2704 | 'foldcolumn' 'fdc' number (default 0) |
| 2705 | local to window |
| 2706 | {not in Vi} |
| 2707 | {not available when compiled without the |+folding| |
| 2708 | feature} |
| 2709 | When non-zero, a column with the specified width is shown at the side |
| 2710 | of the window which indicates open and closed folds. The maximum |
| 2711 | value is 12. |
| 2712 | See |folding|. |
| 2713 | |
| 2714 | *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* |
| 2715 | 'foldenable' 'fen' boolean (default on) |
| 2716 | local to window |
| 2717 | {not in Vi} |
| 2718 | {not available when compiled without the |+folding| |
| 2719 | feature} |
| 2720 | When off, all folds are open. This option can be used to quickly |
| 2721 | switch between showing all text unfolded and viewing the text with |
| 2722 | folds (including manually opened or closed folds). It can be toggled |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2723 | with the |zi| command. The 'foldcolumn' will remain blank when |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2724 | 'foldenable' is off. |
| 2725 | This option is set by commands that create a new fold or close a fold. |
| 2726 | See |folding|. |
| 2727 | |
| 2728 | *'foldexpr'* *'fde'* |
| 2729 | 'foldexpr' 'fde' string (default: "0") |
| 2730 | local to window |
| 2731 | {not in Vi} |
| 2732 | {not available when compiled without the |+folding| |
| 2733 | or |+eval| feature} |
| 2734 | The expression used for when 'foldmethod' is "expr". It is evaluated |
| 2735 | for each line to obtain its fold level. See |fold-expr|. Also see |
| 2736 | |eval-sandbox|. |
| 2737 | |
| 2738 | *'foldignore'* *'fdi'* |
| 2739 | 'foldignore' 'fdi' string (default: "#") |
| 2740 | local to window |
| 2741 | {not in Vi} |
| 2742 | {not available when compiled without the |+folding| |
| 2743 | feature} |
| 2744 | Used only when 'foldmethod' is "indent". Lines starting with |
| 2745 | characters in 'foldignore' will get their fold level from surrounding |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2746 | lines. White space is skipped before checking for this character. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2747 | The default "#" works well for C programs. See |fold-indent|. |
| 2748 | |
| 2749 | *'foldlevel'* *'fdl'* |
| 2750 | 'foldlevel' 'fdl' number (default: 0) |
| 2751 | local to window |
| 2752 | {not in Vi} |
| 2753 | {not available when compiled without the |+folding| |
| 2754 | feature} |
| 2755 | Sets the fold level: Folds with a higher level will be closed. |
| 2756 | Setting this option to zero will close all folds. Higher numbers will |
| 2757 | close fewer folds. |
| 2758 | This option is set by commands like |zm|, |zM| and |zR|. |
| 2759 | See |fold-foldlevel|. |
| 2760 | |
| 2761 | *'foldlevelstart'* *'fdls'* |
| 2762 | 'foldlevelstart' 'fdls' number (default: -1) |
| 2763 | global |
| 2764 | {not in Vi} |
| 2765 | {not available when compiled without the |+folding| |
| 2766 | feature} |
| 2767 | Sets 'foldlevel' when starting to edit another buffer in a window. |
| 2768 | Useful to always start editing with all folds closed (value zero), |
| 2769 | some folds closed (one) or no folds closed (99). |
| 2770 | This is done before reading any modeline, thus a setting in a modeline |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2771 | overrules this option. Starting to edit a file for |diff-mode| also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2772 | ignores this option and closes all folds. |
| 2773 | It is also done before BufReadPre autocommands, to allow an autocmd to |
| 2774 | overrule the 'foldlevel' value for specific files. |
| 2775 | When the value is negative, it is not used. |
| 2776 | |
| 2777 | *'foldmarker'* *'fmr'* *E536* |
| 2778 | 'foldmarker' 'fmr' string (default: "{{{,}}}") |
| 2779 | local to window |
| 2780 | {not in Vi} |
| 2781 | {not available when compiled without the |+folding| |
| 2782 | feature} |
| 2783 | The start and end marker used when 'foldmethod' is "marker". There |
| 2784 | must be one comma, which separates the start and end marker. The |
| 2785 | marker is a literal string (a regular expression would be too slow). |
| 2786 | See |fold-marker|. |
| 2787 | |
| 2788 | *'foldmethod'* *'fdm'* |
| 2789 | 'foldmethod' 'fdm' string (default: "manual") |
| 2790 | local to window |
| 2791 | {not in Vi} |
| 2792 | {not available when compiled without the |+folding| |
| 2793 | feature} |
| 2794 | The kind of folding used for the current window. Possible values: |
| 2795 | |fold-manual| manual Folds are created manually. |
| 2796 | |fold-indent| indent Lines with equal indent form a fold. |
| 2797 | |fold-expr| expr 'foldexpr' gives the fold level of a line. |
| 2798 | |fold-marker| marker Markers are used to specify folds. |
| 2799 | |fold-syntax| syntax Syntax highlighting items specify folds. |
| 2800 | |fold-diff| diff Fold text that is not changed. |
| 2801 | |
| 2802 | *'foldminlines'* *'fml'* |
| 2803 | 'foldminlines' 'fml' number (default: 1) |
| 2804 | local to window |
| 2805 | {not in Vi} |
| 2806 | {not available when compiled without the |+folding| |
| 2807 | feature} |
| 2808 | Sets the minimum number of screen lines for a fold to be displayed |
| 2809 | closed. Also for manually closed folds. |
| 2810 | Note that this only has an effect of what is displayed. After using |
| 2811 | "zc" to close a fold, which is displayed open because it's smaller |
| 2812 | than 'foldminlines', a following "zc" may close a containing fold. |
| 2813 | |
| 2814 | *'foldnestmax'* *'fdn'* |
| 2815 | 'foldnestmax' 'fdn' number (default: 20) |
| 2816 | local to window |
| 2817 | {not in Vi} |
| 2818 | {not available when compiled without the |+folding| |
| 2819 | feature} |
| 2820 | Sets the maximum nesting of folds for the "indent" and "syntax" |
| 2821 | methods. This avoids that too many folds will be created. Using more |
| 2822 | than 20 doesn't work, because the internal limit is 20. |
| 2823 | |
| 2824 | *'foldopen'* *'fdo'* |
| 2825 | 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, |
| 2826 | search,tag,undo") |
| 2827 | global |
| 2828 | {not in Vi} |
| 2829 | {not available when compiled without the |+folding| |
| 2830 | feature} |
| 2831 | Specifies for which type of commands folds will be opened, if the |
| 2832 | command moves the cursor into a closed fold. It is a comma separated |
| 2833 | list of items. |
| 2834 | item commands ~ |
| 2835 | all any |
| 2836 | block "(", "{", "[[", "[{", etc. |
| 2837 | hor horizontal movements: "l", "w", "fx", etc. |
| 2838 | insert any command in Insert mode |
| 2839 | jump far jumps: "G", "gg", etc. |
| 2840 | mark jumping to a mark: "'m", CTRL-O, etc. |
| 2841 | percent "%" |
| 2842 | quickfix ":cn", ":crew", ":make", etc. |
| 2843 | search search for a pattern: "/", "n", "*", "gd", etc. |
| 2844 | (not for a search pattern in a ":" command) |
| 2845 | tag jumping to a tag: ":ta", CTRL-T, etc. |
| 2846 | undo undo or redo: "u" and CTRL-R |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2847 | When the command is part of a mapping this option is not used. Add |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2848 | the |zv| command to the mapping to get the same effect. |
| 2849 | When a movement command is used for an operator (e.g., "dl" or "y%") |
| 2850 | this option is not used. This means the operator will include the |
| 2851 | whole closed fold. |
| 2852 | Note that vertical movements are not here, because it would make it |
| 2853 | very difficult to move onto a closed fold. |
| 2854 | In insert mode the folds containing the cursor will always be open |
| 2855 | when text is inserted. |
| 2856 | To close folds you can re-apply 'foldlevel' with the |zx| command or |
| 2857 | set the 'foldclose' option to "all". |
| 2858 | |
| 2859 | *'foldtext'* *'fdt'* |
| 2860 | 'foldtext' 'fdt' string (default: "foldtext()") |
| 2861 | local to window |
| 2862 | {not in Vi} |
| 2863 | {not available when compiled without the |+folding| |
| 2864 | feature} |
| 2865 | An expression which is used to specify the text displayed for a closed |
| 2866 | fold. See |fold-foldtext|. |
| 2867 | |
| 2868 | *'formatoptions'* *'fo'* |
| 2869 | 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") |
| 2870 | local to buffer |
| 2871 | {not in Vi} |
| 2872 | This is a sequence of letters which describes how automatic |
| 2873 | formatting is to be done. See |fo-table|. When the 'paste' option is |
| 2874 | on, no formatting is done (like 'formatoptions' is empty). Commas can |
| 2875 | be inserted for readability. |
| 2876 | To avoid problems with flags that are added in the future, use the |
| 2877 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 2878 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 2879 | set and to the Vim default value when 'compatible' is reset. |
| 2880 | |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 2881 | *'formatlistpat'* *'flp'* |
| 2882 | 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") |
| 2883 | local to buffer |
| 2884 | {not in Vi} |
| 2885 | A pattern that is used to recognize a list header. This is used for |
| 2886 | the "n" flag in 'formatoptions'. |
| 2887 | The pattern must match exactly the text that will be the indent for |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 2888 | the line below it. You can use |/\ze| to mark the end of the match |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 2889 | while still checking more characters. There must be a character |
| 2890 | following the pattern, when it matches the whole line it is handled |
| 2891 | like there is no match. |
| 2892 | The default recognizes a number, followed by an optional punctuation |
| 2893 | character and white space. |
| 2894 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2895 | *'formatprg'* *'fp'* |
| 2896 | 'formatprg' 'fp' string (default "") |
| 2897 | global |
| 2898 | {not in Vi} |
| 2899 | The name of an external program that will be used to format the lines |
| 2900 | selected with the "gq" command. The program must take the input on |
| 2901 | stdin and produce the output on stdout. The Unix program "fmt" is |
| 2902 | such a program. If this option is an empty string, the internal |
| 2903 | format function will be used |C-indenting|. Environment variables are |
| 2904 | expanded |:set_env|. See |option-backslash| about including spaces |
| 2905 | and backslashes. |
| 2906 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2907 | security reasons. |
| 2908 | |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 2909 | *'fsync'* *'fs'* |
| 2910 | 'fsync' 'fs' boolean (default on) |
| 2911 | global |
| 2912 | {not in Vi} |
| 2913 | When on, the library function fsync() will be called after writing a |
| 2914 | file. This will flush a file to disk, ensuring that it is safely |
| 2915 | written even on filesystems which do metadata-only journaling. This |
| 2916 | will force the harddrive to spin up on Linux systems running in laptop |
| 2917 | mode, so it may be undesirable in some situations. Be warned that |
| 2918 | turning this off increases the chances of data loss after a crash. On |
| 2919 | systems without an fsync() implementation, this variable is always |
| 2920 | off. |
| 2921 | Also see 'swapsync' for controlling fsync() on swap files. |
| 2922 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2923 | *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 2924 | 'gdefault' 'gd' boolean (default off) |
| 2925 | global |
| 2926 | {not in Vi} |
| 2927 | When on, the ":substitute" flag 'g' is default on. This means that |
| 2928 | all matches in a line are substituted instead of one. When a 'g' flag |
| 2929 | is given to a ":substitute" command, this will toggle the substitution |
| 2930 | of all or one match. See |complex-change|. |
| 2931 | |
| 2932 | command 'gdefault' on 'gdefault' off ~ |
| 2933 | :s/// subst. all subst. one |
| 2934 | :s///g subst. one subst. all |
| 2935 | :s///gg subst. all subst. one |
| 2936 | |
| 2937 | NOTE: This option is reset when 'compatible' is set. |
| 2938 | |
| 2939 | *'grepformat'* *'gfm'* |
| 2940 | 'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m") |
| 2941 | global |
| 2942 | {not in Vi} |
| 2943 | Format to recognize for the ":grep" command output. |
| 2944 | This is a scanf-like string that uses the same format as the |
| 2945 | 'errorformat' option: see |errorformat|. |
| 2946 | |
| 2947 | *'grepprg'* *'gp'* |
| 2948 | 'grepprg' 'gp' string (default "grep -n ", |
| 2949 | Unix: "grep -n $* /dev/null", |
| 2950 | Win32: "findstr /n" or "grep -n", |
| 2951 | VMS: "SEARCH/NUMBERS ") |
| 2952 | global or local to buffer |global-local| |
| 2953 | {not in Vi} |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 2954 | Program to use for the |:grep| command. This option may contain '%' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2955 | and '#' characters, which are expanded like when used in a command- |
| 2956 | line. The placeholder "$*" is allowed to specify where the arguments |
| 2957 | will be included. Environment variables are expanded |:set_env|. See |
| 2958 | |option-backslash| about including spaces and backslashes. |
| 2959 | When your "grep" accepts the "-H" argument, use this to make ":grep" |
| 2960 | also work well with a single file: > |
| 2961 | :set grepprg=grep\ -nH |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2962 | < Special value: When 'grepprg' is set to "internal" the |:grep| command |
| 2963 | works like |:vimgrep| and |:grepadd| like |:vimgrepadd|. |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 2964 | See also the section |:make_makeprg|, since most of the comments there |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2965 | apply equally to 'grepprg'. |
| 2966 | For Win32, the default is "findstr /n" if "findstr.exe" can be found, |
| 2967 | otherwise it's "grep -n". |
| 2968 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2969 | security reasons. |
| 2970 | |
| 2971 | *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* |
| 2972 | 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, |
| 2973 | ve:ver35-Cursor, |
| 2974 | o:hor50-Cursor, |
| 2975 | i-ci:ver25-Cursor/lCursor, |
| 2976 | r-cr:hor20-Cursor/lCursor, |
| 2977 | sm:block-Cursor |
| 2978 | -blinkwait175-blinkoff150-blinkon175", |
| 2979 | for MS-DOS and Win32 console: |
| 2980 | "n-v-c:block,o:hor50,i-ci:hor15, |
| 2981 | r-cr:hor30,sm:block") |
| 2982 | global |
| 2983 | {not in Vi} |
| 2984 | {only available when compiled with GUI enabled, and |
| 2985 | for MS-DOS and Win32 console} |
| 2986 | This option tells Vim what the cursor should look like in different |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2987 | modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2988 | the height of the cursor can be changed. This can be done by |
| 2989 | specifying a block cursor, or a percentage for a vertical or |
| 2990 | horizontal cursor. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 2991 | For a console the 't_SI' and 't_EI' escape sequences are used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2992 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2993 | The option is a comma separated list of parts. Each part consist of a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2994 | mode-list and an argument-list: |
| 2995 | mode-list:argument-list,mode-list:argument-list,.. |
| 2996 | The mode-list is a dash separated list of these modes: |
| 2997 | n Normal mode |
| 2998 | v Visual mode |
| 2999 | ve Visual mode with 'selection' "exclusive" (same as 'v', |
| 3000 | if not specified) |
| 3001 | o Operator-pending mode |
| 3002 | i Insert mode |
| 3003 | r Replace mode |
| 3004 | c Command-line Normal (append) mode |
| 3005 | ci Command-line Insert mode |
| 3006 | cr Command-line Replace mode |
| 3007 | sm showmatch in Insert mode |
| 3008 | a all modes |
| 3009 | The argument-list is a dash separated list of these arguments: |
| 3010 | hor{N} horizontal bar, {N} percent of the character height |
| 3011 | ver{N} vertical bar, {N} percent of the character width |
| 3012 | block block cursor, fills the whole character |
| 3013 | [only one of the above three should be present] |
| 3014 | blinkwait{N} *cursor-blinking* |
| 3015 | blinkon{N} |
| 3016 | blinkoff{N} |
| 3017 | blink times for cursor: blinkwait is the delay before |
| 3018 | the cursor starts blinking, blinkon is the time that |
| 3019 | the cursor is shown and blinkoff is the time that the |
| 3020 | cursor is not shown. The times are in msec. When one |
| 3021 | of the numbers is zero, there is no blinking. The |
| 3022 | default is: "blinkwait700-blinkon400-blinkoff250". |
| 3023 | These numbers are used for a missing entry. This |
| 3024 | means that blinking is enabled by default. To switch |
| 3025 | blinking off you can use "blinkon0". The cursor only |
| 3026 | blinks when Vim is waiting for input, not while |
| 3027 | executing a command. |
| 3028 | To make the cursor blink in an xterm, see |
| 3029 | |xterm-blink|. |
| 3030 | {group-name} |
| 3031 | a highlight group name, that sets the color and font |
| 3032 | for the cursor |
| 3033 | {group-name}/{group-name} |
| 3034 | Two highlight group names, the first is used when |
| 3035 | no language mappings are used, the other when they |
| 3036 | are. |language-mapping| |
| 3037 | |
| 3038 | Examples of parts: |
| 3039 | n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a |
| 3040 | block cursor with colors from the "nCursor" |
| 3041 | highlight group |
| 3042 | i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 |
| 3043 | In Insert and Command-line Insert mode, use a |
| 3044 | 30% vertical bar cursor with colors from the |
| 3045 | "iCursor" highlight group. Blink a bit |
| 3046 | faster. |
| 3047 | |
| 3048 | The 'a' mode is different. It will set the given argument-list for |
| 3049 | all modes. It does not reset anything to defaults. This can be used |
| 3050 | to do a common setting for all modes. For example, to switch off |
| 3051 | blinking: "a:blinkon0" |
| 3052 | |
| 3053 | Examples of cursor highlighting: > |
| 3054 | :highlight Cursor gui=reverse guifg=NONE guibg=NONE |
| 3055 | :highlight Cursor gui=NONE guifg=bg guibg=fg |
| 3056 | < |
| 3057 | *'guifont'* *'gfn'* |
| 3058 | *E235* *E596* *E610* *E611* |
| 3059 | 'guifont' 'gfn' string (default "") |
| 3060 | global |
| 3061 | {not in Vi} |
| 3062 | {only available when compiled with GUI enabled} |
| 3063 | This is a list of fonts which will be used for the GUI version of Vim. |
| 3064 | In its simplest form the value is just one font name. When |
| 3065 | the font cannot be found you will get an error message. To try other |
| 3066 | font names a list can be specified, font names separated with commas. |
| 3067 | The first valid font is used. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3068 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 3069 | On systems where 'guifontset' is supported (X11) and 'guifontset' is |
| 3070 | not empty, then 'guifont' is not used. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3071 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3072 | Spaces after a comma are ignored. To include a comma in a font name |
| 3073 | precede it with a backslash. Setting an option requires an extra |
| 3074 | backslash before a space and a backslash. See also |
| 3075 | |option-backslash|. For example: > |
| 3076 | :set guifont=Screen15,\ 7x13,font\\,with\\,commas |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3077 | < will make Vim try to use the font "Screen15" first, and if it fails it |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3078 | will try to use "7x13" and then "font,with,commas" instead. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3079 | |
| 3080 | If none of the fonts can be loaded, Vim will keep the current setting. |
| 3081 | If an empty font list is given, Vim will try using other resource |
| 3082 | settings (for X, it will use the Vim.font resource), and finally it |
| 3083 | will try some builtin default which should always be there ("7x13" in |
| 3084 | the case of X). The font names given should be "normal" fonts. Vim |
| 3085 | will try to find the related bold and italic fonts. |
| 3086 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 3087 | For Win32, GTK, Mac OS and Photon: > |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3088 | :set guifont=* |
| 3089 | < will bring up a font requester, where you can pick the font you want. |
| 3090 | |
| 3091 | The font name depends on the GUI used. See |setting-guifont| for a |
| 3092 | way to set 'guifont' for various systems. |
| 3093 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3094 | For the GTK+ 2 GUI the font name looks like this: > |
| 3095 | :set guifont=Andale\ Mono\ 11 |
| 3096 | < That's all. XLFDs are no longer accepted. |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 3097 | |
| 3098 | For Mac OSX you can use something like this: > |
| 3099 | :set guifont=Monaco:h10 |
| 3100 | < *E236* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3101 | Note that the fonts must be mono-spaced (all characters have the same |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3102 | width). An exception is GTK 2: all fonts are accepted, but |
| 3103 | mono-spaced fonts look best. |
| 3104 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3105 | To preview a font on X11, you might be able to use the "xfontsel" |
| 3106 | program. The "xlsfonts" program gives a list of all available fonts. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3107 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3108 | For the Win32 GUI *E244* *E245* |
| 3109 | - takes these options in the font name: |
| 3110 | hXX - height is XX (points, can be floating-point) |
| 3111 | wXX - width is XX (points, can be floating-point) |
| 3112 | b - bold |
| 3113 | i - italic |
| 3114 | u - underline |
| 3115 | s - strikeout |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3116 | cXX - character set XX. Valid charsets are: ANSI, ARABIC, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3117 | BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, |
| 3118 | HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, |
| 3119 | SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3120 | Normally you would use "cDEFAULT". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3121 | |
| 3122 | Use a ':' to separate the options. |
| 3123 | - A '_' can be used in the place of a space, so you don't need to use |
| 3124 | backslashes to escape the spaces. |
| 3125 | - Examples: > |
| 3126 | :set guifont=courier_new:h12:w5:b:cRUSSIAN |
| 3127 | :set guifont=Andale_Mono:h7.5:w4.5 |
| 3128 | < See also |font-sizes|. |
| 3129 | |
| 3130 | *'guifontset'* *'gfs'* |
| 3131 | *E250* *E252* *E234* *E597* *E598* |
| 3132 | 'guifontset' 'gfs' string (default "") |
| 3133 | global |
| 3134 | {not in Vi} |
| 3135 | {only available when compiled with GUI enabled and |
| 3136 | with the |+xfontset| feature} |
| 3137 | {not available in the GTK+ 2 GUI} |
| 3138 | When not empty, specifies two (or more) fonts to be used. The first |
| 3139 | one for normal English, the second one for your special language. See |
| 3140 | |xfontset|. |
| 3141 | Setting this option also means that all font names will be handled as |
| 3142 | a fontset name. Also the ones used for the "font" argument of the |
| 3143 | |:highlight| command. |
| 3144 | The fonts must match with the current locale. If fonts for the |
| 3145 | character sets that the current locale uses are not included, setting |
| 3146 | 'guifontset' will fail. |
| 3147 | Note the difference between 'guifont' and 'guifontset': In 'guifont' |
| 3148 | the comma-separated names are alternative names, one of which will be |
| 3149 | used. In 'guifontset' the whole string is one fontset name, |
| 3150 | including the commas. It is not possible to specify alternative |
| 3151 | fontset names. |
| 3152 | This example works on many X11 systems: > |
| 3153 | :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* |
| 3154 | < |
| 3155 | *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
| 3156 | 'guifontwide' 'gfw' string (default "") |
| 3157 | global |
| 3158 | {not in Vi} |
| 3159 | {only available when compiled with GUI enabled} |
| 3160 | When not empty, specifies a comma-separated list of fonts to be used |
| 3161 | for double-width characters. The first font that can be loaded is |
| 3162 | used. |
| 3163 | Note: The size of these fonts must be exactly twice as wide as the one |
| 3164 | specified with 'guifont' and the same height. |
| 3165 | |
| 3166 | All GUI versions but GTK+ 2: |
| 3167 | |
| 3168 | 'guifontwide' is only used when 'encoding' is set to "utf-8" and |
| 3169 | 'guifontset' is empty or invalid. |
| 3170 | When 'guifont' is set and a valid font is found in it and |
| 3171 | 'guifontwide' is empty Vim will attempt to find a matching |
| 3172 | double-width font and set 'guifontwide' to it. |
| 3173 | |
| 3174 | GTK+ 2 GUI only: *guifontwide_gtk2* |
| 3175 | |
| 3176 | If set and valid, 'guifontwide' is always used for double width |
| 3177 | characters, even if 'encoding' is not set to "utf-8". |
| 3178 | Vim does not attempt to find an appropriate value for 'guifontwide' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3179 | automatically. If 'guifontwide' is empty Pango/Xft will choose the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3180 | font for characters not available in 'guifont'. Thus you do not need |
| 3181 | to set 'guifontwide' at all unless you want to override the choice |
| 3182 | made by Pango/Xft. |
| 3183 | |
| 3184 | *'guiheadroom'* *'ghr'* |
| 3185 | 'guiheadroom' 'ghr' number (default 50) |
| 3186 | global |
| 3187 | {not in Vi} {only for GTK and X11 GUI} |
| 3188 | The number of pixels subtracted from the screen height when fitting |
| 3189 | the GUI window on the screen. Set this before the GUI is started, |
| 3190 | e.g., in your |gvimrc| file. When zero, the whole screen height will |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3191 | be used by the window. When positive, the specified number of pixel |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3192 | lines will be left for window decorations and other items on the |
| 3193 | screen. Set it to a negative value to allow windows taller than the |
| 3194 | screen. |
| 3195 | |
| 3196 | *'guioptions'* *'go'* |
| 3197 | 'guioptions' 'go' string (default "gmrLtT" (MS-Windows), |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3198 | "agimrLtT" (GTK, Motif and Athena)) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3199 | global |
| 3200 | {not in Vi} |
| 3201 | {only available when compiled with GUI enabled} |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3202 | This option only has an effect in the GUI version of Vim. It is a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3203 | sequence of letters which describes what components and options of the |
| 3204 | GUI should be used. |
| 3205 | To avoid problems with flags that are added in the future, use the |
| 3206 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 3207 | |
| 3208 | Valid letters are as follows: |
| 3209 | *guioptions_a* |
| 3210 | 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3211 | or the Visual area extended, Vim tries to become the owner of |
| 3212 | the windowing system's global selection. This means that the |
| 3213 | Visually highlighted text is available for pasting into other |
| 3214 | applications as well as into Vim itself. When the Visual mode |
| 3215 | ends, possibly due to an operation on the text, or when an |
| 3216 | application wants to paste the selection, the highlighted text |
| 3217 | is automatically yanked into the "* selection register. |
| 3218 | Thus the selection is still available for pasting into other |
| 3219 | applications after the VISUAL mode has ended. |
| 3220 | If not present, then Vim won't become the owner of the |
| 3221 | windowing system's global selection unless explicitly told to |
| 3222 | by a yank or delete operation for the "* register. |
| 3223 | The same applies to the modeless selection. |
| 3224 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3225 | 'A' Autoselect for the modeless selection. Like 'a', but only |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3226 | applies to the modeless selection. |
| 3227 | |
| 3228 | 'guioptions' autoselect Visual autoselect modeless ~ |
| 3229 | "" - - |
| 3230 | "a" yes yes |
| 3231 | "A" - yes |
| 3232 | "aA" yes yes |
| 3233 | |
| 3234 | 'c' Use console dialogs instead of popup dialogs for simple |
| 3235 | choices. |
| 3236 | |
| 3237 | 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 3238 | where it was started. Use this for programs that wait for the |
| 3239 | editor to finish (e.g., an e-mail program). Alternatively you |
| 3240 | can use "gvim -f" or ":gui -f" to start the GUI in the |
| 3241 | foreground. |gui-fork| |
| 3242 | Note: Set this option in the vimrc file. The forking may have |
| 3243 | happened already when the gvimrc file is read. |
| 3244 | |
| 3245 | 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 3246 | corner of the window. It's black&white on non-GTK, because of |
| 3247 | limitations of X11. For a color icon, see |X11-icon|. |
| 3248 | |
| 3249 | 'm' Menu bar is present. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3250 | 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3251 | that this flag must be added in the .vimrc file, before |
| 3252 | switching on syntax or filetype recognition (when the .gvimrc |
| 3253 | file is sourced the system menu has already been loaded; the |
| 3254 | ":syntax on" and ":filetype on" commands load the menu too). |
| 3255 | 'g' Grey menu items: Make menu items that are not active grey. If |
| 3256 | 'g' is not included inactive menu items are not shown at all. |
| 3257 | Exception: Athena will always use grey menu items. |
| 3258 | |
| 3259 | 't' Include tearoff menu items. Currently only works for Win32, |
| 3260 | GTK+, and Motif 1.2 GUI. |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 3261 | 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
| 3262 | and Athena GUIs. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3263 | |
| 3264 | 'r' Right-hand scrollbar is always present. |
| 3265 | 'R' Right-hand scrollbar is present when there is a vertically |
| 3266 | split window. |
| 3267 | 'l' Left-hand scrollbar is always present. |
| 3268 | 'L' Left-hand scrollbar is present when there is a vertically |
| 3269 | split window. |
| 3270 | 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 3271 | the longest visible line, or on the cursor line if the 'h' |
| 3272 | flag is included. |gui-horiz-scroll| |
| 3273 | 'h' Limit horizontal scrollbar size to the length of the cursor |
| 3274 | line. Reduces computations. |gui-horiz-scroll| |
| 3275 | |
| 3276 | And yes, you may even have scrollbars on the left AND the right if |
| 3277 | you really want to :-). See |gui-scrollbars| for more information. |
| 3278 | |
| 3279 | 'v' Use a vertical button layout for dialogs. When not included, |
| 3280 | a horizontal layout is preferred, but when it doesn't fit a |
| 3281 | vertical layout is used anyway. |
| 3282 | 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 3283 | window managers. If the cursor is not blinking or hollow at |
| 3284 | the right moment, try adding this flag. This must be done |
| 3285 | before starting the GUI. Set it in your gvimrc. Adding or |
| 3286 | removing it after the GUI has started has no effect. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3287 | 'F' Add a footer. Only for Motif. See |gui-footer|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3288 | |
| 3289 | *'guipty'* *'noguipty'* |
| 3290 | 'guipty' boolean (default on) |
| 3291 | global |
| 3292 | {not in Vi} |
| 3293 | {only available when compiled with GUI enabled} |
| 3294 | Only in the GUI: If on, an attempt is made to open a pseudo-tty for |
| 3295 | I/O to/from shell commands. See |gui-pty|. |
| 3296 | |
| 3297 | *'helpfile'* *'hf'* |
| 3298 | 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" |
| 3299 | (others) "$VIMRUNTIME/doc/help.txt") |
| 3300 | global |
| 3301 | {not in Vi} |
| 3302 | Name of the main help file. All distributed help files should be |
| 3303 | placed together in one directory. Additionally, all "doc" directories |
| 3304 | in 'runtimepath' will be used. |
| 3305 | Environment variables are expanded |:set_env|. For example: |
| 3306 | "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3307 | tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3308 | spaces and backslashes. |
| 3309 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3310 | security reasons. |
| 3311 | |
| 3312 | *'helpheight'* *'hh'* |
| 3313 | 'helpheight' 'hh' number (default 20) |
| 3314 | global |
| 3315 | {not in Vi} |
| 3316 | {not available when compiled without the +windows |
| 3317 | feature} |
| 3318 | Minimal initial height of the help window when it is opened with the |
| 3319 | ":help" command. The initial height of the help window is half of the |
| 3320 | current window, or (when the 'ea' option is on) the same as other |
| 3321 | windows. When the height is less than 'helpheight', the height is |
| 3322 | set to 'helpheight'. Set to zero to disable. |
| 3323 | |
| 3324 | *'helplang'* *'hlg'* |
| 3325 | 'helplang' 'hlg' string (default: messages language or empty) |
| 3326 | global |
| 3327 | {only available when compiled with the |+multi_lang| |
| 3328 | feature} |
| 3329 | {not in Vi} |
| 3330 | Comma separated list of languages. Vim will use the first language |
| 3331 | for which the desired help can be found. The English help will always |
| 3332 | be used as a last resort. You can add "en" to prefer English over |
| 3333 | another language, but that will only find tags that exist in that |
| 3334 | language and not in the English help. |
| 3335 | Example: > |
| 3336 | :set helplang=de,it |
| 3337 | < This will first search German, then Italian and finally English help |
| 3338 | files. |
| 3339 | When using |CTRL-]| and ":help!" in a non-English help file Vim will |
| 3340 | try to find the tag in the current language before using this option. |
| 3341 | See |help-translated|. |
| 3342 | |
| 3343 | *'hidden'* *'hid'* *'nohidden'* *'nohid'* |
| 3344 | 'hidden' 'hid' boolean (default off) |
| 3345 | global |
| 3346 | {not in Vi} |
| 3347 | When off a buffer is unloaded when it is |abandon|ed. When on a |
| 3348 | buffer becomes hidden when it is |abandon|ed. If the buffer is still |
| 3349 | displayed in another window, it does not become hidden, of course. |
| 3350 | The commands that move through the buffer list sometimes make a buffer |
| 3351 | hidden although the 'hidden' option is off: When the buffer is |
| 3352 | modified, 'autowrite' is off or writing is not possible, and the '!' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3353 | flag was used. See also |windows.txt|. |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 3354 | To only make one buffer hidden use the 'bufhidden' option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3355 | This option is set for one command with ":hide {command}" |:hide|. |
| 3356 | WARNING: It's easy to forget that you have changes in hidden buffers. |
| 3357 | Think twice when using ":q!" or ":qa!". |
| 3358 | |
| 3359 | *'highlight'* *'hl'* |
| 3360 | 'highlight' 'hl' string (default (as a single string): |
| 3361 | "8:SpecialKey,@:NonText,d:Directory, |
| 3362 | e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg, |
| 3363 | M:ModeMsg,n:LineNr,r:Question, |
| 3364 | s:StatusLine,S:StatusLineNC,c:VertSplit |
| 3365 | t:Title,v:Visual,w:WarningMsg,W:WildMenu, |
| 3366 | f:Folded,F:FoldColumn,A:DiffAdd, |
| 3367 | C:DiffChange,D:DiffDelete,T:DiffText, |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 3368 | >:SignColumn,B:SpellBad,P:SpellCap, |
| 3369 | R:SpellRare,L:SpellLocal") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3370 | global |
| 3371 | {not in Vi} |
| 3372 | This option can be used to set highlighting mode for various |
| 3373 | occasions. It is a comma separated list of character pairs. The |
| 3374 | first character in a pair gives the occasion, the second the mode to |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3375 | use for that occasion. The occasions are: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3376 | |hl-SpecialKey| 8 Meta and special keys listed with ":map" |
| 3377 | |hl-NonText| @ '~' and '@' at the end of the window and |
| 3378 | characters from 'showbreak' |
| 3379 | |hl-Directory| d directories in CTRL-D listing and other special |
| 3380 | things in listings |
| 3381 | |hl-ErrorMsg| e error messages |
| 3382 | h (obsolete, ignored) |
| 3383 | |hl-IncSearch| i 'incsearch' highlighting |
| 3384 | |hl-Search| l last search pattern highlighting (see 'hlsearch') |
| 3385 | |hl-MoreMsg| m |more-prompt| |
| 3386 | |hl-ModeMsg| M Mode (e.g., "-- INSERT --") |
| 3387 | |hl-LineNr| n line number for ":number" and ":#" commands |
| 3388 | |hl-Question| r |hit-enter| prompt and yes/no questions |
| 3389 | |hl-StatusLine| s status line of current window |status-line| |
| 3390 | |hl-StatusLineNC| S status lines of not-current windows |
| 3391 | |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
| 3392 | |hl-VertSplit| c column used to separate vertically split windows |
| 3393 | |hl-Visual| v Visual mode |
| 3394 | |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the |
| 3395 | Selection" Only X11 Gui's |gui-x11| and |
| 3396 | |xterm-clipboard|. |
| 3397 | |hl-WarningMsg| w warning messages |
| 3398 | |hl-WildMenu| W wildcard matches displayed for 'wildmenu' |
| 3399 | |hl-Folded| f line used for closed folds |
| 3400 | |hl-FoldColumn| F 'foldcolumn' |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 3401 | |hl-DiffAdd| A added line in diff mode |
| 3402 | |hl-DiffChange| C changed line in diff mode |
| 3403 | |hl-DiffDelete| D deleted line in diff mode |
| 3404 | |hl-DiffText| T inserted text in diff mode |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3405 | |hl-SignColumn| > column used for |signs| |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 3406 | |hl-SpellBad| B misspelled word |spell| |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 3407 | |hl-SpellCap| P word that should start with capital|spell| |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 3408 | |hl-SpellRare| R rare word |spell| |
| 3409 | |hl-SpellLocal| L word from other region |spell| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3410 | |
| 3411 | The display modes are: |
| 3412 | r reverse (termcap entry "mr" and "me") |
| 3413 | i italic (termcap entry "ZH" and "ZR") |
| 3414 | b bold (termcap entry "md" and "me") |
| 3415 | s standout (termcap entry "so" and "se") |
| 3416 | u underline (termcap entry "us" and "ue") |
Bram Moolenaar | e2cc970 | 2005-03-15 22:43:58 +0000 | [diff] [blame] | 3417 | c undercurl (termcap entry "Cs" and "Ce") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3418 | n no highlighting |
| 3419 | - no highlighting |
| 3420 | : use a highlight group |
| 3421 | The default is used for occasions that are not included. |
| 3422 | If you want to change what the display modes do, see |dos-colors| |
| 3423 | for an example. |
| 3424 | When using the ':' display mode, this must be followed by the name of |
| 3425 | a highlight group. A highlight group can be used to define any type |
| 3426 | of highlighting, including using color. See |:highlight| on how to |
| 3427 | define one. The default uses a different group for each occasion. |
| 3428 | See |highlight-default| for the default highlight groups. |
| 3429 | |
| 3430 | *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
| 3431 | 'hlsearch' 'hls' boolean (default off) |
| 3432 | global |
| 3433 | {not in Vi} |
| 3434 | {not available when compiled without the |
| 3435 | |+extra_search| feature} |
| 3436 | When there is a previous search pattern, highlight all its matches. |
| 3437 | The type of highlighting used can be set with the 'l' occasion in the |
| 3438 | 'highlight' option. This uses the "Search" highlight group by |
| 3439 | default. Note that only the matching text is highlighted, any offsets |
| 3440 | are not applied. |
| 3441 | See also: 'incsearch' and |:match|. |
| 3442 | When you get bored looking at the highlighted matches, you can turn it |
| 3443 | off with |:nohlsearch|. As soon as you use a search command, the |
| 3444 | highlighting comes back. |
| 3445 | When the search pattern can match an end-of-line, Vim will try to |
| 3446 | highlight all of the matched text. However, this depends on where the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3447 | search starts. This will be the first line in the window or the first |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3448 | line below a closed fold. A match in a previous line which is not |
| 3449 | drawn may not continue in an newly drawn line. |
| 3450 | NOTE: This option is reset when 'compatible' is set. |
| 3451 | |
| 3452 | *'history'* *'hi'* |
| 3453 | 'history' 'hi' number (Vim default: 20, Vi default: 0) |
| 3454 | global |
| 3455 | {not in Vi} |
| 3456 | A history of ":" commands, and a history of previous search patterns |
| 3457 | are remembered. This option decides how many entries may be stored in |
| 3458 | each of these histories (see |cmdline-editing|). |
| 3459 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 3460 | set and to the Vim default value when 'compatible' is reset. |
| 3461 | |
| 3462 | *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* |
| 3463 | 'hkmap' 'hk' boolean (default off) |
| 3464 | global |
| 3465 | {not in Vi} |
| 3466 | {only available when compiled with the |+rightleft| |
| 3467 | feature} |
| 3468 | When on, the keyboard is mapped for the Hebrew character set. |
| 3469 | Normally you would set 'allowrevins' and use CTRL-_ in insert mode to |
| 3470 | toggle this option. See |rileft.txt|. |
| 3471 | NOTE: This option is reset when 'compatible' is set. |
| 3472 | |
| 3473 | *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* |
| 3474 | 'hkmapp' 'hkp' boolean (default off) |
| 3475 | global |
| 3476 | {not in Vi} |
| 3477 | {only available when compiled with the |+rightleft| |
| 3478 | feature} |
| 3479 | When on, phonetic keyboard mapping is used. 'hkmap' must also be on. |
| 3480 | This is useful if you have a non-Hebrew keyboard. |
| 3481 | See |rileft.txt|. |
| 3482 | NOTE: This option is reset when 'compatible' is set. |
| 3483 | |
| 3484 | *'icon'* *'noicon'* |
| 3485 | 'icon' boolean (default off, on when title can be restored) |
| 3486 | global |
| 3487 | {not in Vi} |
| 3488 | {not available when compiled without the |+title| |
| 3489 | feature} |
| 3490 | When on, the icon text of the window will be set to the value of |
| 3491 | 'iconstring' (if it is not empty), or to the name of the file |
| 3492 | currently being edited. Only the last part of the name is used. |
| 3493 | Overridden by the 'iconstring' option. |
| 3494 | Only works if the terminal supports setting window icons (currently |
| 3495 | only X11 GUI and terminals with a non-empty 't_IS' option - these are |
| 3496 | Unix xterm and iris-ansi by default, where 't_IS' is taken from the |
| 3497 | builtin termcap). |
| 3498 | When Vim was compiled with HAVE_X11 defined, the original icon will be |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3499 | restored if possible |X11|. See |X11-icon| for changing the icon on |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3500 | X11. |
| 3501 | |
| 3502 | *'iconstring'* |
| 3503 | 'iconstring' string (default "") |
| 3504 | global |
| 3505 | {not in Vi} |
| 3506 | {not available when compiled without the |+title| |
| 3507 | feature} |
| 3508 | When this option is not empty, it will be used for the icon text of |
| 3509 | the window. This happens only when the 'icon' option is on. |
| 3510 | Only works if the terminal supports setting window icon text |
| 3511 | (currently only X11 GUI and terminals with a non-empty 't_IS' option). |
| 3512 | Does not work for MS Windows. |
| 3513 | When Vim was compiled with HAVE_X11 defined, the original icon will be |
| 3514 | restored if possible |X11|. |
| 3515 | When this option contains printf-style '%' items, they will be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3516 | expanded according to the rules used for 'statusline'. See |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3517 | 'titlestring' for example settings. |
| 3518 | {not available when compiled without the |+statusline| feature} |
| 3519 | |
| 3520 | *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* |
| 3521 | 'ignorecase' 'ic' boolean (default off) |
| 3522 | global |
| 3523 | Ignore case in search patterns. Also used when searching in the tags |
| 3524 | file. |
| 3525 | Also see 'smartcase'. |
| 3526 | Can be overruled by using "\c" or "\C" in the pattern, see |
| 3527 | |/ignorecase|. |
| 3528 | |
| 3529 | *'imactivatekey'* *'imak'* |
| 3530 | 'imactivatekey' 'imak' string (default "") |
| 3531 | global |
| 3532 | {not in Vi} |
| 3533 | {only available when compiled with |+xim| and |
| 3534 | |+GUI_GTK|} |
| 3535 | Specifies the key that your Input Method in X-Windows uses for |
| 3536 | activation. When this is specified correctly, vim can fully control |
| 3537 | IM with 'imcmdline', 'iminsert' and 'imsearch'. |
| 3538 | You can't use this option to change the activation key, the option |
| 3539 | tells Vim what the key is. |
| 3540 | Format: |
| 3541 | [MODIFIER_FLAG-]KEY_STRING |
| 3542 | |
| 3543 | These characters can be used for MODIFIER_FLAG (case is ignored): |
| 3544 | S Shift key |
| 3545 | L Lock key |
| 3546 | C Control key |
| 3547 | 1 Mod1 key |
| 3548 | 2 Mod2 key |
| 3549 | 3 Mod3 key |
| 3550 | 4 Mod4 key |
| 3551 | 5 Mod5 key |
| 3552 | Combinations are allowed, for example "S-C-space" or "SC-space" are |
| 3553 | both shift+ctrl+space. |
| 3554 | See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. |
| 3555 | |
| 3556 | Example: > |
| 3557 | :set imactivatekey=S-space |
| 3558 | < "S-space" means shift+space. This is the activation key for kinput2 + |
| 3559 | canna (Japanese), and ami (Korean). |
| 3560 | |
| 3561 | *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* |
| 3562 | 'imcmdline' 'imc' boolean (default off) |
| 3563 | global |
| 3564 | {not in Vi} |
| 3565 | {only available when compiled with the |+xim| |
| 3566 | |+multi_byte_ime| or |global-ime| feature} |
| 3567 | When set the Input Method is always on when starting to edit a command |
| 3568 | line, unless entering a search pattern (see 'imsearch' for that). |
| 3569 | Setting this option is useful when your input method allows entering |
| 3570 | English characters directly, e.g., when it's used to type accented |
| 3571 | characters with dead keys. |
| 3572 | |
| 3573 | *'imdisable'* *'imd'* *'nodisable'* *'noimd'* |
| 3574 | 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 3575 | global |
| 3576 | {not in Vi} |
| 3577 | {only available when compiled with the |+xim| |
| 3578 | |+multi_byte_ime| or |global-ime| feature} |
| 3579 | When set the Input Method is never used. This is useful to disable |
| 3580 | the IM when it doesn't work properly. |
| 3581 | Currently this option is on by default for SGI/IRIX machines. This |
| 3582 | may change in later releases. |
| 3583 | |
| 3584 | *'iminsert'* *'imi'* |
| 3585 | 'iminsert' 'imi' number (default 0, 2 when an input method is supported) |
| 3586 | local to buffer |
| 3587 | {not in Vi} |
| 3588 | Specifies whether :lmap or an Input Method (IM) is to be used in |
| 3589 | Insert mode. Valid values: |
| 3590 | 0 :lmap is off and IM is off |
| 3591 | 1 :lmap is ON and IM is off |
| 3592 | 2 :lmap is off and IM is ON |
| 3593 | 2 is available only when compiled with the |+multi_byte_ime|, |+xim| |
| 3594 | or |global-ime|. |
| 3595 | To always reset the option to zero when leaving Insert mode with <Esc> |
| 3596 | this can be used: > |
| 3597 | :inoremap <ESC> <ESC>:set iminsert=0<CR> |
| 3598 | < This makes :lmap and IM turn off automatically when leaving Insert |
| 3599 | mode. |
| 3600 | Note that this option changes when using CTRL-^ in Insert mode |
| 3601 | |i_CTRL-^|. |
| 3602 | The value is set to 1 when setting 'keymap' to a valid keymap name. |
| 3603 | It is also used for the argument of commands like "r" and "f". |
| 3604 | The value 0 may not work correctly with Athena and Motif with some XIM |
| 3605 | methods. Use 'imdisable' to disable XIM then. |
| 3606 | |
| 3607 | *'imsearch'* *'ims'* |
| 3608 | 'imsearch' 'ims' number (default 0, 2 when an input method is supported) |
| 3609 | local to buffer |
| 3610 | {not in Vi} |
| 3611 | Specifies whether :lmap or an Input Method (IM) is to be used when |
| 3612 | entering a search pattern. Valid values: |
| 3613 | -1 the value of 'iminsert' is used, makes it look like |
| 3614 | 'iminsert' is also used when typing a search pattern |
| 3615 | 0 :lmap is off and IM is off |
| 3616 | 1 :lmap is ON and IM is off |
| 3617 | 2 :lmap is off and IM is ON |
| 3618 | Note that this option changes when using CTRL-^ in Command-line mode |
| 3619 | |c_CTRL-^|. |
| 3620 | The value is set to 1 when it is not -1 and setting the 'keymap' |
| 3621 | option to a valid keymap name. |
| 3622 | The value 0 may not work correctly with Athena and Motif with some XIM |
| 3623 | methods. Use 'imdisable' to disable XIM then. |
| 3624 | |
| 3625 | *'include'* *'inc'* |
| 3626 | 'include' 'inc' string (default "^\s*#\s*include") |
| 3627 | global or local to buffer |global-local| |
| 3628 | {not in Vi} |
| 3629 | {not available when compiled without the |
| 3630 | |+find_in_path| feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3631 | Pattern to be used to find an include command. It is a search |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3632 | pattern, just like for the "/" command (See |pattern|). The default |
| 3633 | value is for C programs. This option is used for the commands "[i", |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3634 | "]I", "[d", etc. The 'isfname' option is used to recognize the file |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3635 | name that comes after the matched pattern. See |option-backslash| |
| 3636 | about including spaces and backslashes. |
| 3637 | |
| 3638 | *'includeexpr'* *'inex'* |
| 3639 | 'includeexpr' 'inex' string (default "") |
| 3640 | local to buffer |
| 3641 | {not in Vi} |
| 3642 | {not available when compiled without the |
| 3643 | |+find_in_path| or |+eval| feature} |
| 3644 | Expression to be used to transform the string found with the 'include' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3645 | option to a file name. Mostly useful to change "." to "/" for Java: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3646 | :set includeexpr=substitute(v:fname,'\\.','/','g') |
| 3647 | < The "v:fname" variable will be set to the file name that was detected. |
| 3648 | Evaluated in the |sandbox|. |
| 3649 | Also used for the |gf| command if an unmodified file name can't be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3650 | found. Allows doing "gf" on the name after an 'include' statement. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3651 | Also used for |<cfile>|. |
| 3652 | |
| 3653 | *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
| 3654 | 'incsearch' 'is' boolean (default off) |
| 3655 | global |
| 3656 | {not in Vi} |
| 3657 | {not available when compiled without the |
| 3658 | |+extra_search| feature} |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 3659 | While typing a search command, show where the pattern, as it was typed |
| 3660 | so far, matches. The matched string is highlighted. If the pattern |
| 3661 | is invalid or not found, nothing is shown. The screen will be updated |
| 3662 | often, this is only useful on fast terminals. |
| 3663 | Note that the match will be shown, but the cursor will return to its |
| 3664 | original position when no match is found and when pressing <Esc>. You |
| 3665 | still need to finish the search command with <Enter> to move the |
| 3666 | cursor to the match. |
| 3667 | The highlighting can be set with the 'i' flag in 'highlight'. |
| 3668 | See also: 'hlsearch'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3669 | NOTE: This option is reset when 'compatible' is set. |
| 3670 | |
| 3671 | *'indentexpr'* *'inde'* |
| 3672 | 'indentexpr' 'inde' string (default "") |
| 3673 | local to buffer |
| 3674 | {not in Vi} |
| 3675 | {not available when compiled without the |+cindent| |
| 3676 | or |+eval| features} |
| 3677 | Expression which is evaluated to obtain the proper indent for a line. |
| 3678 | It is used when a new line is created, for the |=| operator and |
| 3679 | in Insert mode as specified with the 'indentkeys' option. |
| 3680 | When this option is not empty, it overrules the 'cindent' and |
| 3681 | 'smartindent' indenting. |
| 3682 | When 'paste' is set this option is not used for indenting. |
| 3683 | The expression is evaluated with |v:lnum| set to the line number for |
| 3684 | which the indent is to be computed. The cursor is also as this line |
| 3685 | when the expression is evaluated (but it may be moved around). |
| 3686 | The expression must return the number of spaces worth of indent. It |
| 3687 | can return "-1" to keep the current indent (this means 'autoindent' is |
| 3688 | used for the indent). |
| 3689 | Functions useful for computing the indent are |indent()|, |cindent()| |
| 3690 | and |lispindent()|. |
| 3691 | The evaluation of the expression must not have side effects! It must |
| 3692 | not change the text, jump to another window, etc. Afterwards the |
| 3693 | cursor position is always restored, thus the cursor may be moved. |
| 3694 | Normally this option would be set to call a function: > |
| 3695 | :set indentexpr=GetMyIndent() |
| 3696 | < Error messages will be suppressed, unless the 'debug' option contains |
| 3697 | "msg". |
| 3698 | See |indent-expression|. Also see |eval-sandbox|. |
| 3699 | NOTE: This option is made empty when 'compatible' is set. |
| 3700 | |
| 3701 | *'indentkeys'* *'indk'* |
| 3702 | 'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") |
| 3703 | local to buffer |
| 3704 | {not in Vi} |
| 3705 | {not available when compiled without the |+cindent| |
| 3706 | feature} |
| 3707 | A list of keys that, when typed in Insert mode, cause reindenting of |
| 3708 | the current line. Only happens if 'indentexpr' isn't empty. |
| 3709 | The format is identical to 'cinkeys', see |indentkeys-format|. |
| 3710 | See |C-indenting| and |indent-expression|. |
| 3711 | |
| 3712 | *'infercase'* *'inf'* *'noinfercase'* *'noinf'* |
| 3713 | 'infercase' 'inf' boolean (default off) |
| 3714 | local to buffer |
| 3715 | {not in Vi} |
| 3716 | When doing keyword completion in insert mode |ins-completion|, and |
| 3717 | 'ignorecase' is also on, the case of the match is adjusted. If the |
| 3718 | typed text contains a lowercase letter where the match has an upper |
| 3719 | case letter, the completed part is made lowercase. If the typed text |
| 3720 | has no lowercase letters and the match has a lowercase letter where |
| 3721 | the typed text has an uppercase letter, and there is a letter before |
| 3722 | it, the completed part is made uppercase. |
| 3723 | |
| 3724 | *'insertmode'* *'im'* *'noinsertmode'* *'noim'* |
| 3725 | 'insertmode' 'im' boolean (default off) |
| 3726 | global |
| 3727 | {not in Vi} |
| 3728 | Makes Vim work in a way that Insert mode is the default mode. Useful |
| 3729 | if you want to use Vim as a modeless editor. Used for |evim|. |
| 3730 | These Insert mode commands will be useful: |
| 3731 | - Use the cursor keys to move around. |
| 3732 | - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When |
| 3733 | this is a mapping, it is executed as if 'insertmode' was off. |
| 3734 | Normal mode remains active until the mapping is finished. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3735 | - Use CTRL-L to execute a number of Normal mode commands, then use |
Bram Moolenaar | 488c651 | 2005-08-11 20:09:58 +0000 | [diff] [blame] | 3736 | <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 3737 | left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3738 | |
| 3739 | These items change when 'insertmode' is set: |
| 3740 | - when starting to edit of a file, Vim goes to Insert mode. |
| 3741 | - <Esc> in Insert mode is a no-op and beeps. |
| 3742 | - <Esc> in Normal mode makes Vim go to Insert mode. |
| 3743 | - CTRL-L in Insert mode is a command, it is not inserted. |
| 3744 | - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* |
| 3745 | However, when <Esc> is used inside a mapping, it behaves like |
| 3746 | 'insertmode' was not set. This was done to be able to use the same |
| 3747 | mappings with 'insertmode' set or not set. |
| 3748 | When executing commands with |:normal| 'insertmode' is not used. |
| 3749 | |
| 3750 | NOTE: This option is reset when 'compatible' is set. |
| 3751 | |
| 3752 | *'isfname'* *'isf'* |
| 3753 | 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: |
| 3754 | "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
| 3755 | for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" |
| 3756 | for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" |
| 3757 | for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" |
| 3758 | otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") |
| 3759 | global |
| 3760 | {not in Vi} |
| 3761 | The characters specified by this option are included in file names and |
| 3762 | path names. Filenames are used for commands like "gf", "[i" and in |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3763 | the tags file. It is also used for "\f" in a |pattern|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3764 | Multi-byte characters 256 and above are always included, only the |
| 3765 | characters up to 255 are specified with this option. |
| 3766 | For UTF-8 the characters 0xa0 to 0xff are included as well. |
| 3767 | |
| 3768 | Note that on systems using a backslash as path separator, Vim tries to |
| 3769 | do its best to make it work as you would expect. That is a bit |
| 3770 | tricky, since Vi originally used the backslash to escape special |
| 3771 | characters. Vim will not remove a backslash in front of a normal file |
| 3772 | name character on these systems, but it will on Unix and alikes. The |
| 3773 | '&' and '^' are not included by default, because these are special for |
| 3774 | cmd.exe. |
| 3775 | |
| 3776 | The format of this option is a list of parts, separated with commas. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3777 | Each part can be a single character number or a range. A range is two |
| 3778 | character numbers with '-' in between. A character number can be a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3779 | decimal number between 0 and 255 or the ASCII character itself (does |
| 3780 | not work for digits). Example: |
| 3781 | "_,-,128-140,#-43" (include '_' and '-' and the range |
| 3782 | 128 to 140 and '#' to 43) |
| 3783 | If a part starts with '^', the following character number or range |
| 3784 | will be excluded from the option. The option is interpreted from left |
| 3785 | to right. Put the excluded character after the range where it is |
| 3786 | included. To include '^' itself use it as the last character of the |
| 3787 | option or the end of a range. Example: |
| 3788 | "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') |
| 3789 | If the character is '@', all characters where isalpha() returns TRUE |
| 3790 | are included. Normally these are the characters a to z and A to Z, |
| 3791 | plus accented characters. To include '@' itself use "@-@". Examples: |
| 3792 | "@,^a-z" All alphabetic characters, excluding lower |
| 3793 | case letters. |
| 3794 | "a-z,A-Z,@-@" All letters plus the '@' character. |
| 3795 | A comma can be included by using it where a character number is |
| 3796 | expected. Example: |
| 3797 | "48-57,,,_" Digits, comma and underscore. |
| 3798 | A comma can be excluded by prepending a '^'. Example: |
| 3799 | " -~,^,,9" All characters from space to '~', excluding |
| 3800 | comma, plus <Tab>. |
| 3801 | See |option-backslash| about including spaces and backslashes. |
| 3802 | |
| 3803 | *'isident'* *'isi'* |
| 3804 | 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: |
| 3805 | "@,48-57,_,128-167,224-235" |
| 3806 | otherwise: "@,48-57,_,192-255") |
| 3807 | global |
| 3808 | {not in Vi} |
| 3809 | The characters given by this option are included in identifiers. |
| 3810 | Identifiers are used in recognizing environment variables and after a |
| 3811 | match of the 'define' option. It is also used for "\i" in a |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3812 | |pattern|. See 'isfname' for a description of the format of this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3813 | option. |
| 3814 | Careful: If you change this option, it might break expanding |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3815 | environment variables. E.g., when '/' is included and Vim tries to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3816 | expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 3817 | |
| 3818 | *'iskeyword'* *'isk'* |
| 3819 | 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: |
| 3820 | "@,48-57,_,128-167,224-235" |
| 3821 | otherwise: "@,48-57,_,192-255" |
| 3822 | Vi default: "@,48-57,_") |
| 3823 | local to buffer |
| 3824 | {not in Vi} |
| 3825 | Keywords are used in searching and recognizing with many commands: |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3826 | "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3827 | 'isfname' for a description of the format of this option. For C |
| 3828 | programs you could use "a-z,A-Z,48-57,_,.,-,>". |
| 3829 | For a help file it is set to all non-blank printable characters except |
| 3830 | '*', '"' and '|' (so that CTRL-] on a command finds the help for that |
| 3831 | command). |
| 3832 | When the 'lisp' option is on the '-' character is always included. |
| 3833 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 3834 | set and to the Vim default value when 'compatible' is reset. |
| 3835 | |
| 3836 | *'isprint'* *'isp'* |
| 3837 | 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: |
| 3838 | "@,~-255"; otherwise: "@,161-255") |
| 3839 | global |
| 3840 | {not in Vi} |
| 3841 | The characters given by this option are displayed directly on the |
| 3842 | screen. It is also used for "\p" in a |pattern|. The characters from |
| 3843 | space (ASCII 32) to '~' (ASCII 126) are always displayed directly, |
| 3844 | even when they are not included in 'isprint' or excluded. See |
| 3845 | 'isfname' for a description of the format of this option. |
| 3846 | |
| 3847 | Non-printable characters are displayed with two characters: |
| 3848 | 0 - 31 "^@" - "^_" |
| 3849 | 32 - 126 always single characters |
| 3850 | 127 "^?" |
| 3851 | 128 - 159 "~@" - "~_" |
| 3852 | 160 - 254 "| " - "|~" |
| 3853 | 255 "~?" |
| 3854 | When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are |
| 3855 | displayed as <xx>, with the hexadecimal value of the byte. |
| 3856 | When 'display' contains "uhex" all unprintable characters are |
| 3857 | displayed as <xx>. |
| 3858 | The NonText highlighting will be used for unprintable characters. |
| 3859 | |hl-NonText| |
| 3860 | |
| 3861 | Multi-byte characters 256 and above are always included, only the |
| 3862 | characters up to 255 are specified with this option. When a character |
| 3863 | is printable but it is not available in the current font, a |
| 3864 | replacement character will be shown. |
| 3865 | Unprintable and zero-width Unicode characters are displayed as <xxxx>. |
| 3866 | There is no option to specify these characters. |
| 3867 | |
| 3868 | *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* |
| 3869 | 'joinspaces' 'js' boolean (default on) |
| 3870 | global |
| 3871 | {not in Vi} |
| 3872 | Insert two spaces after a '.', '?' and '!' with a join command. |
| 3873 | When 'cpoptions' includes the 'j' flag, only do this after a '.'. |
| 3874 | Otherwise only one space is inserted. |
| 3875 | NOTE: This option is set when 'compatible' is set. |
| 3876 | |
| 3877 | *'key'* |
| 3878 | 'key' string (default "") |
| 3879 | local to buffer |
| 3880 | {not in Vi} |
| 3881 | The key that is used for encrypting and decrypting the current buffer. |
| 3882 | See |encryption|. |
| 3883 | Careful: Do not set the key value by hand, someone might see the typed |
| 3884 | key. Use the |:X| command. But you can make 'key' empty: > |
| 3885 | :set key= |
| 3886 | < It is not possible to get the value of this option with ":set key" or |
| 3887 | "echo &key". This is to avoid showing it to someone who shouldn't |
| 3888 | know. It also means you cannot see it yourself once you have set it, |
| 3889 | be careful not to make a typing error! |
| 3890 | |
| 3891 | *'keymap'* *'kmp'* *E544* |
| 3892 | 'keymap' 'kmp' string (default "") |
| 3893 | local to buffer |
| 3894 | {not in Vi} |
| 3895 | {only available when compiled with the |+keymap| |
| 3896 | feature} |
| 3897 | Name of a keyboard mapping. See |mbyte-keymap|. |
| 3898 | Setting this option to a valid keymap name has the side effect of |
| 3899 | setting 'iminsert' to one, so that the keymap becomes effective. |
| 3900 | 'imsearch' is also set to one, unless it was -1 |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3901 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3902 | |
| 3903 | *'keymodel'* *'km'* |
| 3904 | 'keymodel' 'km' string (default "") |
| 3905 | global |
| 3906 | {not in Vi} |
| 3907 | List of comma separated words, which enable special things that keys |
| 3908 | can do. These values can be used: |
| 3909 | startsel Using a shifted special key starts selection (either |
| 3910 | Select mode or Visual mode, depending on "key" being |
| 3911 | present in 'selectmode'). |
| 3912 | stopsel Using a not-shifted special key stops selection. |
| 3913 | Special keys in this context are the cursor keys, <End>, <Home>, |
| 3914 | <PageUp> and <PageDown>. |
| 3915 | The 'keymodel' option is set by the |:behave| command. |
| 3916 | |
| 3917 | *'keywordprg'* *'kp'* |
| 3918 | 'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help", |
| 3919 | OS/2: "view /", VMS: "help") |
| 3920 | global or local to buffer |global-local| |
| 3921 | {not in Vi} |
| 3922 | Program to use for the |K| command. Environment variables are |
| 3923 | expanded |:set_env|. ":help" may be used to access the Vim internal |
| 3924 | help. (Note that previously setting the global option to the empty |
| 3925 | value did this, which is now deprecated.) |
| 3926 | When "man" is used, Vim will automatically translate a count for the |
| 3927 | "K" command to a section number. Also for "man -s", in which case the |
| 3928 | "-s" is removed when there is no count. |
| 3929 | See |option-backslash| about including spaces and backslashes. |
| 3930 | Example: > |
| 3931 | :set keywordprg=man\ -s |
| 3932 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3933 | security reasons. |
| 3934 | |
| 3935 | *'langmap'* *'lmap'* *E357* *E358* |
| 3936 | 'langmap' 'lmap' string (default "") |
| 3937 | global |
| 3938 | {not in Vi} |
| 3939 | {only available when compiled with the |+langmap| |
| 3940 | feature} |
| 3941 | This option allows switching your keyboard into a special language |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3942 | mode. When you are typing text in Insert mode the characters are |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3943 | inserted directly. When in command mode the 'langmap' option takes |
| 3944 | care of translating these special characters to the original meaning |
| 3945 | of the key. This means you don't have to change the keyboard mode to |
| 3946 | be able to execute Normal mode commands. |
| 3947 | This is the opposite of the 'keymap' option, where characters are |
| 3948 | mapped in Insert mode. |
| 3949 | This only works for 8-bit characters. The value of 'langmap' may be |
| 3950 | specified with multi-byte characters (e.g., UTF-8), but only the lower |
| 3951 | 8 bits of each character will be used. |
| 3952 | |
| 3953 | Example (for Greek): *greek* > |
| 3954 | :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 |
| 3955 | < Example (exchanges meaning of z and y for commands): > |
| 3956 | :set langmap=zy,yz,ZY,YZ |
| 3957 | < |
| 3958 | The 'langmap' option is a list of parts, separated with commas. Each |
| 3959 | part can be in one of two forms: |
| 3960 | 1. A list of pairs. Each pair is a "from" character immediately |
| 3961 | followed by the "to" character. Examples: "aA", "aAbBcC". |
| 3962 | 2. A list of "from" characters, a semi-colon and a list of "to" |
| 3963 | characters. Example: "abc;ABC" |
| 3964 | Example: "aA,fgh;FGH,cCdDeE" |
| 3965 | Special characters need to be preceded with a backslash. These are |
| 3966 | ";", ',' and backslash itself. |
| 3967 | |
| 3968 | This will allow you to activate vim actions without having to switch |
| 3969 | back and forth between the languages. Your language characters will |
| 3970 | be understood as normal vim English characters (according to the |
| 3971 | langmap mappings) in the following cases: |
| 3972 | o Normal/Visual mode (commands, buffer/register names, user mappings) |
| 3973 | o Insert/Replace Mode: Register names after CTRL-R |
| 3974 | o Insert/Replace Mode: Mappings |
| 3975 | Characters entered in Command-line mode will NOT be affected by |
| 3976 | this option. Note that this option can be changed at any time |
| 3977 | allowing to switch between mappings for different languages/encodings. |
| 3978 | Use a mapping to avoid having to type it each time! |
| 3979 | |
| 3980 | *'langmenu'* *'lm'* |
| 3981 | 'langmenu' 'lm' string (default "") |
| 3982 | global |
| 3983 | {not in Vi} |
| 3984 | {only available when compiled with the |+menu| and |
| 3985 | |+multi_lang| features} |
| 3986 | Language to use for menu translation. Tells which file is loaded |
| 3987 | from the "lang" directory in 'runtimepath': > |
| 3988 | "lang/menu_" . &langmenu . ".vim" |
| 3989 | < (without the spaces). For example, to always use the Dutch menus, no |
| 3990 | matter what $LANG is set to: > |
| 3991 | :set langmenu=nl_NL.ISO_8859-1 |
| 3992 | < When 'langmenu' is empty, |v:lang| is used. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3993 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3994 | If your $LANG is set to a non-English language but you do want to use |
| 3995 | the English menus: > |
| 3996 | :set langmenu=none |
| 3997 | < This option must be set before loading menus, switching on filetype |
| 3998 | detection or syntax highlighting. Once the menus are defined setting |
| 3999 | this option has no effect. But you could do this: > |
| 4000 | :source $VIMRUNTIME/delmenu.vim |
| 4001 | :set langmenu=de_DE.ISO_8859-1 |
| 4002 | :source $VIMRUNTIME/menu.vim |
| 4003 | < Warning: This deletes all menus that you defined yourself! |
| 4004 | |
| 4005 | *'laststatus'* *'ls'* |
| 4006 | 'laststatus' 'ls' number (default 1) |
| 4007 | global |
| 4008 | {not in Vi} |
| 4009 | The value of this option influences when the last window will have a |
| 4010 | status line: |
| 4011 | 0: never |
| 4012 | 1: only if there are at least two windows |
| 4013 | 2: always |
| 4014 | The screen looks nicer with a status line if you have several |
| 4015 | windows, but it takes another screen line. |status-line| |
| 4016 | |
| 4017 | *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* |
| 4018 | 'lazyredraw' 'lz' boolean (default off) |
| 4019 | global |
| 4020 | {not in Vi} |
| 4021 | When this option is set, the screen will not be redrawn while |
| 4022 | executing macros, registers and other commands that have not been |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4023 | typed. Also, updating the window title is postponed. To force an |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4024 | update use |:redraw|. |
| 4025 | |
| 4026 | *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* |
| 4027 | 'linebreak' 'lbr' boolean (default off) |
| 4028 | local to window |
| 4029 | {not in Vi} |
| 4030 | {not available when compiled without the |+linebreak| |
| 4031 | feature} |
| 4032 | If on Vim will wrap long lines at a character in 'breakat' rather |
| 4033 | than at the last character that fits on the screen. Unlike |
| 4034 | 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, |
| 4035 | it only affects the way the file is displayed, not its contents. The |
| 4036 | value of 'showbreak' is used to put in front of wrapped lines. |
| 4037 | This option is not used when the 'wrap' option is off or 'list' is on. |
| 4038 | Note that <Tab> characters after an <EOL> are mostly not displayed |
| 4039 | with the right amount of white space. |
| 4040 | |
| 4041 | *'lines'* *E593* |
| 4042 | 'lines' number (default 24 or terminal height) |
| 4043 | global |
| 4044 | Number of lines of the Vim window. |
| 4045 | Normally you don't need to set this. It is done automatically by the |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 4046 | terminal initialization code. Also see |posix-screen-size|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4047 | When Vim is running in the GUI or in a resizable window, setting this |
| 4048 | option will cause the window size to be changed. When you only want |
| 4049 | to use the size for the GUI, put the command in your |gvimrc| file. |
| 4050 | Vim limits the number of lines to what fits on the screen. You can |
| 4051 | use this command to get the tallest window possible: > |
| 4052 | :set lines=999 |
| 4053 | < If you get less lines than expected, check the 'guiheadroom' option. |
| 4054 | When you set this option and Vim is unable to change the physical |
| 4055 | number of lines of the display, the display may be messed up. |
| 4056 | |
| 4057 | *'linespace'* *'lsp'* |
| 4058 | 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) |
| 4059 | global |
| 4060 | {not in Vi} |
| 4061 | {only in the GUI} |
| 4062 | Number of pixel lines inserted between characters. Useful if the font |
| 4063 | uses the full character cell height, making lines touch each other. |
| 4064 | When non-zero there is room for underlining. |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 4065 | With some fonts there can be too much room between lines (to have |
| 4066 | space for ascents and descents). Then it makes sense to set |
| 4067 | 'linespace' to a negative value. This may cause display problems |
| 4068 | though! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4069 | |
| 4070 | *'lisp'* *'nolisp'* |
| 4071 | 'lisp' boolean (default off) |
| 4072 | local to buffer |
| 4073 | {not available when compiled without the |+lispindent| |
| 4074 | feature} |
| 4075 | Lisp mode: When <Enter> is typed in insert mode set the indent for |
| 4076 | the next line to Lisp standards (well, sort of). Also happens with |
| 4077 | "cc" or "S". 'autoindent' must also be on for this to work. The 'p' |
| 4078 | flag in 'cpoptions' changes the method of indenting: Vi compatible or |
| 4079 | better. Also see 'lispwords'. |
| 4080 | The '-' character is included in keyword characters. Redefines the |
| 4081 | "=" operator to use this same indentation algorithm rather than |
| 4082 | calling an external program if 'equalprg' is empty. |
| 4083 | This option is not used when 'paste' is set. |
| 4084 | {Vi: Does it a little bit differently} |
| 4085 | |
| 4086 | *'lispwords'* *'lw'* |
| 4087 | 'lispwords' 'lw' string (default is very long) |
| 4088 | global |
| 4089 | {not in Vi} |
| 4090 | {not available when compiled without the |+lispindent| |
| 4091 | feature} |
| 4092 | Comma separated list of words that influence the Lisp indenting. |
| 4093 | |'lisp'| |
| 4094 | |
| 4095 | *'list'* *'nolist'* |
| 4096 | 'list' boolean (default off) |
| 4097 | local to window |
| 4098 | List mode: Show tabs as CTRL-I, show end of line with $. Useful to |
| 4099 | see the difference between tabs and spaces and for trailing blanks. |
| 4100 | Note that this will also affect formatting (set with 'textwidth' or |
| 4101 | 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
| 4102 | changing the way tabs are displayed. |
| 4103 | |
| 4104 | *'listchars'* *'lcs'* |
| 4105 | 'listchars' 'lcs' string (default "eol:$") |
| 4106 | global |
| 4107 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4108 | Strings to use in 'list' mode. It is a comma separated list of string |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4109 | settings. |
| 4110 | eol:c Character to show at the end of each line. When |
| 4111 | omitted, there is no extra character at the end of the |
| 4112 | line. |
| 4113 | tab:xy Two characters to be used to show a Tab. The first |
| 4114 | char is used once. The second char is repeated to |
| 4115 | fill the space that the Tab normally occupies. |
| 4116 | "tab:>-" will show a Tab that takes four spaces as |
| 4117 | ">---". When omitted, a Tab is show as ^I. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4118 | trail:c Character to show for trailing spaces. When omitted, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4119 | trailing spaces are blank. |
| 4120 | extends:c Character to show in the last column, when 'wrap' is |
| 4121 | off and the line continues beyond the right of the |
| 4122 | screen. |
| 4123 | precedes:c Character to show in the first column, when 'wrap' |
| 4124 | is off and there is text preceding the character |
| 4125 | visible in the first column. |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 4126 | nbsp:c Character to show for a non-breakable space (character |
| 4127 | 0xA0, 160). Left blank when omitted. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4128 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4129 | The characters ':' and ',' should not be used. UTF-8 characters can |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4130 | be used when 'encoding' is "utf-8", otherwise only printable |
| 4131 | characters are allowed. |
| 4132 | |
| 4133 | Examples: > |
| 4134 | :set lcs=tab:>-,trail:- |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 4135 | :set lcs=tab:>-,eol:<,nbsp:% |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4136 | :set lcs=extends:>,precedes:< |
| 4137 | < The "NonText" highlighting will be used for "eol", "extends" and |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 4138 | "precedes". "SpecialKey" for "nbsp", "tab" and "trail". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4139 | |
| 4140 | *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* |
| 4141 | 'loadplugins' 'lpl' boolean (default on) |
| 4142 | global |
| 4143 | {not in Vi} |
| 4144 | When on the plugin scripts are loaded when starting up |load-plugins|. |
| 4145 | This option can be reset in your |vimrc| file to disable the loading |
| 4146 | of plugins. |
| 4147 | Note that using the "-u NONE" and "--noplugin" command line arguments |
| 4148 | reset this option. |-u| |--noplugin| |
| 4149 | |
| 4150 | *'magic'* *'nomagic'* |
| 4151 | 'magic' boolean (default on) |
| 4152 | global |
| 4153 | Changes the special characters that can be used in search patterns. |
| 4154 | See |pattern|. |
| 4155 | NOTE: To avoid portability problems with using patterns, always keep |
| 4156 | this option at the default "on". Only switch it off when working with |
| 4157 | old Vi scripts. In any other situation write patterns that work when |
Bram Moolenaar | 5eb86f9 | 2004-07-26 12:53:41 +0000 | [diff] [blame] | 4158 | 'magic' is on. Include "\M" when you want to |/\M|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4159 | |
| 4160 | *'makeef'* *'mef'* |
| 4161 | 'makeef' 'mef' string (default: "") |
| 4162 | global |
| 4163 | {not in Vi} |
| 4164 | {not available when compiled without the |+quickfix| |
| 4165 | feature} |
| 4166 | Name of the errorfile for the |:make| command (see |:make_makeprg|) |
| 4167 | and the |:grep| command. |
| 4168 | When it is empty, an internally generated temp file will be used. |
| 4169 | When "##" is included, it is replaced by a number to make the name |
| 4170 | unique. This makes sure that the ":make" command doesn't overwrite an |
| 4171 | existing file. |
| 4172 | NOT used for the ":cf" command. See 'errorfile' for that. |
| 4173 | Environment variables are expanded |:set_env|. |
| 4174 | See |option-backslash| about including spaces and backslashes. |
| 4175 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4176 | security reasons. |
| 4177 | |
| 4178 | *'makeprg'* *'mp'* |
| 4179 | 'makeprg' 'mp' string (default "make", VMS: "MMS") |
| 4180 | global or local to buffer |global-local| |
| 4181 | {not in Vi} |
| 4182 | Program to use for the ":make" command. See |:make_makeprg|. This |
| 4183 | option may contain '%' and '#' characters, which are expanded like |
| 4184 | when used in a command-line. Environment variables are expanded |
| 4185 | |:set_env|. See |option-backslash| about including spaces and |
| 4186 | backslashes. Note that a '|' must be escaped twice: once for ":set" |
| 4187 | and once for the interpretation of a command. When you use a filter |
| 4188 | called "myfilter" do it like this: > |
| 4189 | :set makeprg=gmake\ \\\|\ myfilter |
| 4190 | < The placeholder "$*" can be given (even multiple times) to specify |
| 4191 | where the arguments will be included, for example: > |
| 4192 | :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} |
| 4193 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4194 | security reasons. |
| 4195 | |
| 4196 | *'matchpairs'* *'mps'* |
| 4197 | 'matchpairs' 'mps' string (default "(:),{:},[:]") |
| 4198 | local to buffer |
| 4199 | {not in Vi} |
| 4200 | Characters that form pairs. The |%| command jumps from one to the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4201 | other. Currently only single character pairs are allowed, and they |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4202 | must be different. The characters must be separated by a colon. The |
| 4203 | pairs must be separated by a comma. Example for including '<' and '>' |
| 4204 | (HTML): > |
| 4205 | :set mps+=<:> |
| 4206 | |
| 4207 | < A more exotic example, to jump between the '=' and ';' in an |
| 4208 | assignment, useful for languages like C and Java: > |
| 4209 | :au FileType c,cpp,java set mps+==:; |
| 4210 | |
| 4211 | < For a more advanced way of using "%", see the matchit.vim plugin in |
| 4212 | the $VIMRUNTIME/macros directory. |add-local-help| |
| 4213 | |
| 4214 | *'matchtime'* *'mat'* |
| 4215 | 'matchtime' 'mat' number (default 5) |
| 4216 | global |
| 4217 | {not in Vi}{in Nvi} |
| 4218 | Tenths of a second to show the matching paren, when 'showmatch' is |
| 4219 | set. Note that this is not in milliseconds, like other options that |
| 4220 | set a time. This is to be compatible with Nvi. |
| 4221 | |
| 4222 | *'maxfuncdepth'* *'mfd'* |
| 4223 | 'maxfuncdepth' 'mfd' number (default 100) |
| 4224 | global |
| 4225 | {not in Vi} |
| 4226 | Maximum depth of function calls for user functions. This normally |
| 4227 | catches endless recursion. When using a recursive function with |
| 4228 | more depth, set 'maxfuncdepth' to a bigger number. But this will use |
| 4229 | more memory, there is the danger of failing when memory is exhausted. |
| 4230 | See also |:function|. |
| 4231 | |
| 4232 | *'maxmapdepth'* *'mmd'* *E223* |
| 4233 | 'maxmapdepth' 'mmd' number (default 1000) |
| 4234 | global |
| 4235 | {not in Vi} |
| 4236 | Maximum number of times a mapping is done without resulting in a |
| 4237 | character to be used. This normally catches endless mappings, like |
| 4238 | ":map x y" with ":map y x". It still does not catch ":map g wg", |
| 4239 | because the 'w' is used before the next mapping is done. See also |
| 4240 | |key-mapping|. |
| 4241 | |
| 4242 | *'maxmem'* *'mm'* |
| 4243 | 'maxmem' 'mm' number (default between 256 to 5120 (system |
| 4244 | dependent) or half the amount of memory |
| 4245 | available) |
| 4246 | global |
| 4247 | {not in Vi} |
| 4248 | Maximum amount of memory (in Kbyte) to use for one buffer. When this |
| 4249 | limit is reached allocating extra memory for a buffer will cause |
| 4250 | other memory to be freed. Maximum value 2000000. Use this to work |
| 4251 | without a limit. Also see 'maxmemtot'. |
| 4252 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 4253 | *'maxmempattern'* *'mmp'* |
| 4254 | 'maxmempattern' 'mmp' number (default 1000) |
| 4255 | global |
| 4256 | {not in Vi} |
| 4257 | Maximum amount of memory (in Kbyte) to use for pattern matching. |
| 4258 | Maximum value 2000000. Use this to work without a limit. |
| 4259 | *E363* |
| 4260 | When Vim runs into the limit it gives an error message mostly behaves |
| 4261 | like CTRL-C was typed. |
| 4262 | Running into the limit often means that the pattern is very |
| 4263 | inefficient or too complex. This may already happen with the pattern |
| 4264 | "\(.\)*" on a very long line. ".*" works much better. |
| 4265 | Vim may run out of memory before hitting the 'maxmempattern' limit. |
| 4266 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4267 | *'maxmemtot'* *'mmt'* |
| 4268 | 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system |
| 4269 | dependent) or half the amount of memory |
| 4270 | available) |
| 4271 | global |
| 4272 | {not in Vi} |
| 4273 | Maximum amount of memory (in Kbyte) to use for all buffers together. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4274 | Maximum value 2000000. Use this to work without a limit. Also see |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4275 | 'maxmem'. |
| 4276 | |
| 4277 | *'menuitems'* *'mis'* |
| 4278 | 'menuitems' 'mis' number (default 25) |
| 4279 | global |
| 4280 | {not in Vi} |
| 4281 | {not available when compiled without the |+menu| |
| 4282 | feature} |
| 4283 | Maximum number of items to use in a menu. Used for menus that are |
| 4284 | generated from a list of items, e.g., the Buffers menu. Changing this |
| 4285 | option has no direct effect, the menu must be refreshed first. |
| 4286 | |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 4287 | *'mkspellmem'* *'msm'* |
| 4288 | 'mkspellmem' 'msm' string (default "460000,2000,500") |
| 4289 | global |
| 4290 | {not in Vi} |
| 4291 | {not available when compiled without the |+syntax| |
| 4292 | feature} |
| 4293 | Parameters for |:mkspell|. This tunes when to start compressing the |
| 4294 | word tree. Compression can be slow when there are many words, but |
| 4295 | it's needed to avoid running out of memory. The amount of memory used |
| 4296 | per word depends very much on how similar the words are, that's why |
| 4297 | this tuning is complicated. |
| 4298 | |
| 4299 | There are three numbers, separated by commas: |
| 4300 | {start},{inc},{added} |
| 4301 | |
| 4302 | For most languages the uncompressed word tree fits in memory. {start} |
| 4303 | gives the amount of memory in Kbyte that can be used before any |
| 4304 | compression is done. It should be a bit smaller than the amount of |
| 4305 | memory that is available to Vim. |
| 4306 | |
| 4307 | When going over the {start} limit the {inc} number specifies the |
| 4308 | amount of memory in Kbyte that can be allocated before another |
| 4309 | compression is done. A low number means compression is done after |
| 4310 | less words are added, which is slow. A high number means more memory |
| 4311 | will be allocated. |
| 4312 | |
| 4313 | After doing compression, {added} times 1024 words can be added before |
| 4314 | the {inc} limit is ignored and compression is done when any extra |
| 4315 | amount of memory is needed. A low number means there is a smaller |
| 4316 | chance of hitting the {inc} limit, less memory is used but it's |
| 4317 | slower. |
| 4318 | |
| 4319 | The languages for which these numbers are important are Italian and |
| 4320 | Hungarian. The default works for when you have about 512 Mbyte. If |
| 4321 | you have 1 Gbyte you could use: > |
| 4322 | :set mkspellmem=900000,3000,800 |
| 4323 | < If you have less than 512 Mbyte |:mkspell| may fail for some |
| 4324 | languages, no matter what you set 'mkspellmem' to. |
| 4325 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4326 | *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
| 4327 | 'modeline' 'ml' boolean (Vim default: on, Vi default: off) |
| 4328 | local to buffer |
| 4329 | *'modelines'* *'mls'* |
| 4330 | 'modelines' 'mls' number (default 5) |
| 4331 | global |
| 4332 | {not in Vi} |
| 4333 | If 'modeline' is on 'modelines' gives the number of lines that is |
| 4334 | checked for set commands. If 'modeline' is off or 'modelines' is zero |
| 4335 | no lines are checked. See |modeline|. |
| 4336 | NOTE: 'modeline' is set to the Vi default value when 'compatible' is |
| 4337 | set and to the Vim default value when 'compatible' is reset. |
| 4338 | |
| 4339 | *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* |
| 4340 | 'modifiable' 'ma' boolean (default on) |
| 4341 | local to buffer |
| 4342 | {not in Vi} *E21* |
| 4343 | When off the buffer contents cannot be changed. The 'fileformat' and |
| 4344 | 'fileencoding' options also can't be changed. |
| 4345 | Can be reset with the |-M| command line argument. |
| 4346 | |
| 4347 | *'modified'* *'mod'* *'nomodified'* *'nomod'* |
| 4348 | 'modified' 'mod' boolean (default off) |
| 4349 | local to buffer |
| 4350 | {not in Vi} |
| 4351 | When on, the buffer is considered to be modified. This option is set |
| 4352 | when: |
| 4353 | 1. A change was made to the text since it was last written. Using the |
| 4354 | |undo| command to go back to the original text will reset the |
| 4355 | option. But undoing changes that were made before writing the |
| 4356 | buffer will set the option again, since the text is different from |
| 4357 | when it was written. |
| 4358 | 2. 'fileformat' or 'fileencoding' is different from its original |
| 4359 | value. The original value is set when the buffer is read or |
| 4360 | written. A ":set nomodified" command also resets the original |
| 4361 | values to the current values and the 'modified' option will be |
| 4362 | reset. |
| 4363 | When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 4364 | will be ignored. |
| 4365 | |
| 4366 | *'more'* *'nomore'* |
| 4367 | 'more' boolean (Vim default: on, Vi default: off) |
| 4368 | global |
| 4369 | {not in Vi} |
| 4370 | When on, listings pause when the whole screen is filled. You will get |
| 4371 | the |more-prompt|. When this option is off there are no pauses, the |
| 4372 | listing continues until finished. |
| 4373 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 4374 | set and to the Vim default value when 'compatible' is reset. |
| 4375 | |
| 4376 | *'mouse'* *E538* |
| 4377 | 'mouse' string (default "", "a" for GUI, MS-DOS and Win32) |
| 4378 | global |
| 4379 | {not in Vi} |
| 4380 | Enable the use of the mouse. Only works for certain terminals |
| 4381 | (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console |
| 4382 | with gpm). For using the mouse in the GUI, see |gui-mouse|. |
| 4383 | The mouse can be enabled for different modes: |
| 4384 | n Normal mode |
| 4385 | v Visual mode |
| 4386 | i Insert mode |
| 4387 | c Command-line mode |
| 4388 | h all previous modes when editing a help file |
| 4389 | a all previous modes |
| 4390 | r for |hit-enter| and |more-prompt| prompt |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4391 | Normally you would enable the mouse in all four modes with: > |
| 4392 | :set mouse=a |
| 4393 | < When the mouse is not enabled, the GUI will still use the mouse for |
| 4394 | modeless selection. This doesn't move the text cursor. |
| 4395 | |
| 4396 | See |mouse-using|. Also see |'clipboard'|. |
| 4397 | |
| 4398 | Note: When enabling the mouse in a terminal, copy/paste will use the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4399 | "* register if there is access to an X-server. The xterm handling of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4400 | the mouse buttons can still be used by keeping the shift key pressed. |
| 4401 | Also see the 'clipboard' option. |
| 4402 | |
| 4403 | *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* |
| 4404 | 'mousefocus' 'mousef' boolean (default off) |
| 4405 | global |
| 4406 | {not in Vi} |
| 4407 | {only works in the GUI} |
| 4408 | The window that the mouse pointer is on is automatically activated. |
| 4409 | When changing the window layout or window focus in another way, the |
| 4410 | mouse pointer is moved to the window with keyboard focus. Off is the |
| 4411 | default because it makes using the pull down menus a little goofy, as |
| 4412 | a pointer transit may activate a window unintentionally. |
| 4413 | |
| 4414 | *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* |
| 4415 | 'mousehide' 'mh' boolean (default on) |
| 4416 | global |
| 4417 | {not in Vi} |
| 4418 | {only works in the GUI} |
| 4419 | When on, the mouse pointer is hidden when characters are typed. |
| 4420 | The mouse pointer is restored when the mouse is moved. |
| 4421 | |
| 4422 | *'mousemodel'* *'mousem'* |
| 4423 | 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) |
| 4424 | global |
| 4425 | {not in Vi} |
| 4426 | Sets the model to use for the mouse. The name mostly specifies what |
| 4427 | the right mouse button is used for: |
| 4428 | extend Right mouse button extends a selection. This works |
| 4429 | like in an xterm. |
| 4430 | popup Right mouse button pops up a menu. The shifted left |
| 4431 | mouse button extends a selection. This works like |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 4432 | with Microsoft Windows. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4433 | popup_setpos Like "popup", but the cursor will be moved to the |
| 4434 | position where the mouse was clicked, and thus the |
| 4435 | selected operation will act upon the clicked object. |
| 4436 | If clicking inside a selection, that selection will |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 4437 | be acted upon, i.e. no cursor move. This implies of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4438 | course, that right clicking outside a selection will |
| 4439 | end Visual mode. |
| 4440 | Overview of what button does what for each model: |
| 4441 | mouse extend popup(_setpos) ~ |
| 4442 | left click place cursor place cursor |
| 4443 | left drag start selection start selection |
| 4444 | shift-left search word extend selection |
| 4445 | right click extend selection popup menu (place cursor) |
| 4446 | right drag extend selection - |
| 4447 | middle click paste paste |
| 4448 | |
| 4449 | In the "popup" model the right mouse button produces a pop-up menu. |
| 4450 | You need to define this first, see |popup-menu|. |
| 4451 | |
| 4452 | Note that you can further refine the meaning of buttons with mappings. |
| 4453 | See |gui-mouse-mapping|. But mappings are NOT used for modeless |
| 4454 | selection (because that's handled in the GUI code directly). |
| 4455 | |
| 4456 | The 'mousemodel' option is set by the |:behave| command. |
| 4457 | |
| 4458 | *'mouseshape'* *'mouses'* *E547* |
| 4459 | 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 4460 | m:no,ml:up-arrow,v:rightup-arrow") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4461 | global |
| 4462 | {not in Vi} |
| 4463 | {only available when compiled with the |+mouseshape| |
| 4464 | feature} |
| 4465 | This option tells Vim what the mouse pointer should look like in |
| 4466 | different modes. The option is a comma separated list of parts, much |
| 4467 | like used for 'guicursor'. Each part consist of a mode/location-list |
| 4468 | and an argument-list: |
| 4469 | mode-list:shape,mode-list:shape,.. |
| 4470 | The mode-list is a dash separated list of these modes/locations: |
| 4471 | In a normal window: ~ |
| 4472 | n Normal mode |
| 4473 | v Visual mode |
| 4474 | ve Visual mode with 'selection' "exclusive" (same as 'v', |
| 4475 | if not specified) |
| 4476 | o Operator-pending mode |
| 4477 | i Insert mode |
| 4478 | r Replace mode |
| 4479 | |
| 4480 | Others: ~ |
| 4481 | c appending to the command-line |
| 4482 | ci inserting in the command-line |
| 4483 | cr replacing in the command-line |
| 4484 | m at the 'Hit ENTER' or 'More' prompts |
| 4485 | ml idem, but cursor in the last line |
| 4486 | e any mode, pointer below last window |
| 4487 | s any mode, pointer on a status line |
| 4488 | sd any mode, while dragging a status line |
| 4489 | vs any mode, pointer on a vertical separator line |
| 4490 | vd any mode, while dragging a vertical separator line |
| 4491 | a everywhere |
| 4492 | |
| 4493 | The shape is one of the following: |
| 4494 | avail name looks like ~ |
| 4495 | w x arrow Normal mouse pointer |
| 4496 | w x blank no pointer at all (use with care!) |
| 4497 | w x beam I-beam |
| 4498 | w x updown up-down sizing arrows |
| 4499 | w x leftright left-right sizing arrows |
| 4500 | w x busy The system's usual busy pointer |
| 4501 | w x no The system's usual 'no input' pointer |
| 4502 | x udsizing indicates up-down resizing |
| 4503 | x lrsizing indicates left-right resizing |
| 4504 | x crosshair like a big thin + |
| 4505 | x hand1 black hand |
| 4506 | x hand2 white hand |
| 4507 | x pencil what you write with |
| 4508 | x question big ? |
| 4509 | x rightup-arrow arrow pointing right-up |
| 4510 | w x up-arrow arrow pointing up |
| 4511 | x <number> any X11 pointer number (see X11/cursorfont.h) |
| 4512 | |
| 4513 | The "avail" column contains a 'w' if the shape is available for Win32, |
| 4514 | x for X11. |
| 4515 | Any modes not specified or shapes not available use the normal mouse |
| 4516 | pointer. |
| 4517 | |
| 4518 | Example: > |
| 4519 | :set mouseshape=s:udsizing,m:no |
| 4520 | < will make the mouse turn to a sizing arrow over the status lines and |
| 4521 | indicate no input when the hit-enter prompt is displayed (since |
| 4522 | clicking the mouse has no effect in this state.) |
| 4523 | |
| 4524 | *'mousetime'* *'mouset'* |
| 4525 | 'mousetime' 'mouset' number (default 500) |
| 4526 | global |
| 4527 | {not in Vi} |
| 4528 | Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum |
| 4529 | time in msec between two mouse clicks for the second click to be |
| 4530 | recognized as a multi click. |
| 4531 | |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 4532 | *'mzquantum'* *'mzq'* |
| 4533 | 'mzquantum' 'mzq' number (default 100) |
| 4534 | global |
| 4535 | {not in Vi} |
| 4536 | {not available when compiled without the |+mzscheme| |
| 4537 | feature} |
| 4538 | The number of milliseconds between polls for MzScheme threads. |
| 4539 | Negative or zero value means no thread scheduling. |
| 4540 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4541 | *'nrformats'* *'nf'* |
| 4542 | 'nrformats' 'nf' string (default "octal,hex") |
| 4543 | local to buffer |
| 4544 | {not in Vi} |
| 4545 | This defines what bases Vim will consider for numbers when using the |
| 4546 | CTRL-A and CTRL-X commands for adding to and subtracting from a number |
| 4547 | respectively; see |CTRL-A| for more info on these commands. |
| 4548 | alpha if included, single alphabetical characters will be |
| 4549 | incremented or decremented. This is useful for a list with a |
| 4550 | letter index a), b), etc. |
| 4551 | octal if included, numbers that start with a zero will be considered |
| 4552 | to be octal. Example: Using CTRL-A on "007" results in "010". |
| 4553 | hex if included, numbers starting with "0x" or "0X" will be |
| 4554 | considered to be hexadecimal. Example: Using CTRL-X on |
| 4555 | "0x100" results in "0x0ff". |
| 4556 | Numbers which simply begin with a digit in the range 1-9 are always |
| 4557 | considered decimal. This also happens for numbers that are not |
| 4558 | recognized as octal or hex. |
| 4559 | |
| 4560 | *'number'* *'nu'* *'nonumber'* *'nonu'* |
| 4561 | 'number' 'nu' boolean (default off) |
| 4562 | local to window |
| 4563 | Print the line number in front of each line. When the 'n' option is |
| 4564 | excluded from 'cpoptions' a wrapped line will not use the column of |
| 4565 | line numbers (this is the default when 'compatible' isn't set). |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 4566 | The 'numberwidth' option can be used to set the room used for the line |
| 4567 | number. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4568 | When a long, wrapped line doesn't start with the first character, '-' |
| 4569 | characters are put before the number. |
| 4570 | See |hl-LineNr| for the highlighting used for the number. |
| 4571 | |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 4572 | *'numberwidth'* *'nuw'* |
| 4573 | 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) |
| 4574 | local to window |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 4575 | {not in Vi} |
| 4576 | {only available when compiled with the |+linebreak| |
| 4577 | feature} |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 4578 | Minimal number of columns to use for the line number. Only relevant |
| 4579 | when the 'number' option is set. |
| 4580 | Since one space is always between the number and the text, there is |
| 4581 | one less character for the number itself. |
| 4582 | The value is the minimum width. A bigger width is used when needed to |
| 4583 | fit the highest line number in the buffer. Thus with the Vim default |
| 4584 | of 4 there is room for a line number up to 999. When the buffer has |
| 4585 | 1000 lines five columns will be used. |
| 4586 | The minimum value is 1, the maximum value is 10. |
| 4587 | NOTE: 'numberwidth' is reset to 8 when 'compatible' is set. |
| 4588 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4589 | *'osfiletype'* *'oft'* *E366* |
| 4590 | 'osfiletype' 'oft' string (RISC-OS default: "Text", |
| 4591 | others default: "") |
| 4592 | local to buffer |
| 4593 | {not in Vi} |
| 4594 | {only available when compiled with the |+osfiletype| |
| 4595 | feature} |
| 4596 | Some operating systems store extra information about files besides |
| 4597 | name, datestamp and permissions. This option contains the extra |
| 4598 | information, the nature of which will vary between systems. |
| 4599 | The value of this option is usually set when the file is loaded, and |
| 4600 | use to set the file type when file is written. |
| 4601 | It can affect the pattern matching of the automatic commands. |
| 4602 | |autocmd-osfiletypes| |
| 4603 | |
| 4604 | *'paragraphs'* *'para'* |
| 4605 | 'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp") |
| 4606 | global |
| 4607 | Specifies the nroff macros that separate paragraphs. These are pairs |
| 4608 | of two letters (see |object-motions|). |
| 4609 | |
| 4610 | *'paste'* *'nopaste'* |
| 4611 | 'paste' boolean (default off) |
| 4612 | global |
| 4613 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4614 | Put Vim in Paste mode. This is useful if you want to cut or copy |
| 4615 | some text from one window and paste it in Vim. This will avoid |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4616 | unexpected effects. |
| 4617 | Setting this option is useful when using Vim in a terminal, where Vim |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4618 | cannot distinguish between typed text and pasted text. In the GUI, Vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4619 | knows about pasting and will mostly do the right thing without 'paste' |
| 4620 | being set. The same is true for a terminal where Vim handles the |
| 4621 | mouse clicks itself. |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 4622 | This option is reset when starting the GUI. Thus if you set it in |
| 4623 | your .vimrc it will work in a terminal, but not in the GUI. Setting |
| 4624 | 'paste' in the GUI has side effects: e.g., the Paste toolbar button |
| 4625 | will no longer work in Insert mode, because it uses a mapping. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4626 | When the 'paste' option is switched on (also when it was already on): |
| 4627 | - mapping in Insert mode and Command-line mode is disabled |
| 4628 | - abbreviations are disabled |
| 4629 | - 'textwidth' is set to 0 |
| 4630 | - 'wrapmargin' is set to 0 |
| 4631 | - 'autoindent' is reset |
| 4632 | - 'smartindent' is reset |
| 4633 | - 'softtabstop' is set to 0 |
| 4634 | - 'revins' is reset |
| 4635 | - 'ruler' is reset |
| 4636 | - 'showmatch' is reset |
| 4637 | - 'formatoptions' is used like it is empty |
| 4638 | These options keep their value, but their effect is disabled: |
| 4639 | - 'lisp' |
| 4640 | - 'indentexpr' |
| 4641 | - 'cindent' |
| 4642 | NOTE: When you start editing another file while the 'paste' option is |
| 4643 | on, settings from the modelines or autocommands may change the |
| 4644 | settings again, causing trouble when pasting text. You might want to |
| 4645 | set the 'paste' option again. |
| 4646 | When the 'paste' option is reset the mentioned options are restored to |
| 4647 | the value before the moment 'paste' was switched from off to on. |
| 4648 | Resetting 'paste' before ever setting it does not have any effect. |
| 4649 | Since mapping doesn't work while 'paste' is active, you need to use |
| 4650 | the 'pastetoggle' option to toggle the 'paste' option with some key. |
| 4651 | |
| 4652 | *'pastetoggle'* *'pt'* |
| 4653 | 'pastetoggle' 'pt' string (default "") |
| 4654 | global |
| 4655 | {not in Vi} |
| 4656 | When non-empty, specifies the key sequence that toggles the 'paste' |
| 4657 | option. This is like specifying a mapping: > |
| 4658 | :map {keys} :set invpaste<CR> |
| 4659 | < Where {keys} is the value of 'pastetoggle'. |
| 4660 | The difference is that it will work even when 'paste' is set. |
| 4661 | 'pastetoggle' works in Insert mode and Normal mode, but not in |
| 4662 | Command-line mode. |
| 4663 | Mappings are checked first, thus overrule 'pastetoggle'. However, |
| 4664 | when 'paste' is on mappings are ignored in Insert mode, thus you can do |
| 4665 | this: > |
| 4666 | :map <F10> :set paste<CR> |
| 4667 | :map <F11> :set nopaste<CR> |
| 4668 | :imap <F10> <C-O>:set paste<CR> |
| 4669 | :imap <F11> <nop> |
| 4670 | :set pastetoggle=<F11> |
| 4671 | < This will make <F10> start paste mode and <F11> stop paste mode. |
| 4672 | Note that typing <F10> in paste mode inserts "<F10>", since in paste |
| 4673 | mode everything is inserted literally, except the 'pastetoggle' key |
| 4674 | sequence. |
| 4675 | |
| 4676 | *'pex'* *'patchexpr'* |
| 4677 | 'patchexpr' 'pex' string (default "") |
| 4678 | global |
| 4679 | {not in Vi} |
| 4680 | {not available when compiled without the |+diff| |
| 4681 | feature} |
| 4682 | Expression which is evaluated to apply a patch to a file and generate |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4683 | the resulting new version of the file. See |diff-patchexpr|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4684 | |
| 4685 | *'patchmode'* *'pm'* *E206* |
| 4686 | 'patchmode' 'pm' string (default "") |
| 4687 | global |
| 4688 | {not in Vi} |
| 4689 | When non-empty the oldest version of a file is kept. This can be used |
| 4690 | to keep the original version of a file if you are changing files in a |
| 4691 | source distribution. Only the first time that a file is written a |
| 4692 | copy of the original file will be kept. The name of the copy is the |
| 4693 | name of the original file with the string in the 'patchmode' option |
| 4694 | appended. This option should start with a dot. Use a string like |
| 4695 | ".org". 'backupdir' must not be empty for this to work (Detail: The |
| 4696 | backup file is renamed to the patchmode file after the new file has |
| 4697 | been successfully written, that's why it must be possible to write a |
| 4698 | backup file). If there was no file to be backed up, an empty file is |
| 4699 | created. |
| 4700 | When the 'backupskip' pattern matches, a patchmode file is not made. |
| 4701 | Using 'patchmode' for compressed files appends the extension at the |
| 4702 | end (e.g., "file.gz.orig"), thus the resulting name isn't always |
| 4703 | recognized as a compressed file. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 4704 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4705 | |
| 4706 | *'path'* *'pa'* *E343* *E345* *E347* |
| 4707 | 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 4708 | on OS/2: ".,/emx/include,," |
| 4709 | other systems: ".,,") |
| 4710 | global or local to buffer |global-local| |
| 4711 | {not in Vi} |
| 4712 | This is a list of directories which will be searched when using the |
| 4713 | |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file |
| 4714 | being searched for has a relative path (not starting with '/'). The |
| 4715 | directories in the 'path' option may be relative or absolute. |
| 4716 | - Use commas to separate directory names: > |
| 4717 | :set path=.,/usr/local/include,/usr/include |
| 4718 | < - Spaces can also be used to separate directory names (for backwards |
| 4719 | compatibility with version 3.0). To have a space in a directory |
| 4720 | name, precede it with an extra backslash, and escape the space: > |
| 4721 | :set path=.,/dir/with\\\ space |
| 4722 | < - To include a comma in a directory name precede it with an extra |
| 4723 | backslash: > |
| 4724 | :set path=.,/dir/with\\,comma |
| 4725 | < - To search relative to the directory of the current file, use: > |
| 4726 | :set path=. |
| 4727 | < - To search in the current directory use an empty string between two |
| 4728 | commas: > |
| 4729 | :set path=,, |
| 4730 | < - A directory name may end in a ':' or '/'. |
| 4731 | - Environment variables are expanded |:set_env|. |
| 4732 | - When using |netrw.vim| URLs can be used. For example, adding |
| 4733 | "http://www.vim.org" will make ":find index.html" work. |
| 4734 | - Search upwards and downwards in a directory tree: |
| 4735 | 1) "*" matches a sequence of characters, e.g.: > |
| 4736 | :set path=/usr/include/* |
| 4737 | < means all subdirectories in /usr/include (but not /usr/include |
| 4738 | itself). > |
| 4739 | :set path=/usr/*c |
| 4740 | < matches /usr/doc and /usr/src. |
| 4741 | 2) "**" matches a subtree, up to 100 directories deep. Example: > |
| 4742 | :set path=/home/user_x/src/** |
| 4743 | < means search in the whole subtree under "/home/usr_x/src". |
| 4744 | 3) If the path ends with a ';', this path is the startpoint |
| 4745 | for upward search. |
| 4746 | See |file-searching| for more info and exact syntax. |
| 4747 | {not available when compiled without the |+path_extra| feature} |
| 4748 | - Careful with '\' characters, type two to get one in the option: > |
| 4749 | :set path=.,c:\\include |
| 4750 | < Or just use '/' instead: > |
| 4751 | :set path=.,c:/include |
| 4752 | < Don't forget "." or files won't even be found in the same directory as |
| 4753 | the file! |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4754 | The maximum length is limited. How much depends on the system, mostly |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4755 | it is something like 256 or 1024 characters. |
| 4756 | You can check if all the include files are found, using the value of |
| 4757 | 'path', see |:checkpath|. |
| 4758 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 4759 | directories from the list. This avoids problems when a future version |
| 4760 | uses another default. To remove the current directory use: > |
| 4761 | :set path-= |
| 4762 | < To add the current directory use: > |
| 4763 | :set path+= |
| 4764 | < To use an environment variable, you probably need to replace the |
| 4765 | separator. Here is an example to append $INCL, in which directory |
| 4766 | names are separated with a semi-colon: > |
| 4767 | :let &path = &path . "," . substitute($INCL, ';', ',', 'g') |
| 4768 | < Replace the ';' with a ':' or whatever separator is used. Note that |
| 4769 | this doesn't work when $INCL contains a comma or white space. |
| 4770 | |
| 4771 | *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 4772 | 'preserveindent' 'pi' boolean (default off) |
| 4773 | local to buffer |
| 4774 | {not in Vi} |
| 4775 | When changing the indent of the current line, preserve as much of the |
| 4776 | indent structure as possible. Normally the indent is replaced by a |
| 4777 | series of tabs followed by spaces as required (unless |'expandtab'| is |
| 4778 | enabled, in which case only spaces are used). Enabling this option |
| 4779 | means the indent will preserve as many existing characters as possible |
| 4780 | for indenting, and only add additional tabs or spaces as required. |
| 4781 | NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 4782 | tabs and spaces. You might not like this. |
| 4783 | NOTE: 'preserveindent' is reset when 'compatible' is set. |
| 4784 | Also see 'copyindent'. |
| 4785 | Use |:retab| to clean up white space. |
| 4786 | |
| 4787 | *'previewheight'* *'pvh'* |
| 4788 | 'previewheight' 'pvh' number (default 12) |
| 4789 | global |
| 4790 | {not in Vi} |
| 4791 | {not available when compiled without the |+windows| or |
| 4792 | |+quickfix| feature} |
| 4793 | Default height for a preview window. Used for |:ptag| and associated |
| 4794 | commands. Used for |CTRL-W_}| when no count is given. |
| 4795 | |
| 4796 | *'previewwindow'* *'nopreviewwindow'* |
| 4797 | *'pvw'* *'nopvw'* *E590* |
| 4798 | 'previewwindow' 'pvw' boolean (default off) |
| 4799 | local to window |
| 4800 | {not in Vi} |
| 4801 | {not available when compiled without the |+windows| or |
| 4802 | |+quickfix| feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4803 | Identifies the preview window. Only one window can have this option |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4804 | set. It's normally not set directly, but by using one of the commands |
| 4805 | |:ptag|, |:pedit|, etc. |
| 4806 | |
| 4807 | *'printdevice'* *'pdev'* |
| 4808 | 'printdevice' 'pdev' string (default empty) |
| 4809 | global |
| 4810 | {not in Vi} |
| 4811 | {only available when compiled with the |+printer| |
| 4812 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4813 | The name of the printer to be used for |:hardcopy|. |
| 4814 | See |pdev-option|. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 4815 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4816 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4817 | |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4818 | *'printencoding'* *'penc'* |
| 4819 | 'printencoding' 'penc' String (default empty, except for some systems) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4820 | global |
| 4821 | {not in Vi} |
| 4822 | {only available when compiled with the |+printer| |
| 4823 | and |+postscript| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4824 | Sets the character encoding used when printing. |
| 4825 | See |penc-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4826 | |
| 4827 | *'printexpr'* *'pexpr'* |
| 4828 | 'printexpr' 'pexpr' String (default: see below) |
| 4829 | global |
| 4830 | {not in Vi} |
| 4831 | {only available when compiled with the |+printer| |
| 4832 | and |+postscript| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4833 | Expression used to print the PostScript produced with |:hardcopy|. |
| 4834 | See |pexpr-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4835 | |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4836 | *'printfont'* *'pfn'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4837 | 'printfont' 'pfn' string (default "courier") |
| 4838 | global |
| 4839 | {not in Vi} |
| 4840 | {only available when compiled with the |+printer| |
| 4841 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4842 | The name of the font that will be used for |:hardcopy|. |
| 4843 | See |pfn-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4844 | |
| 4845 | *'printheader'* *'pheader'* |
| 4846 | 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") |
| 4847 | global |
| 4848 | {not in Vi} |
| 4849 | {only available when compiled with the |+printer| |
| 4850 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4851 | The format of the header produced in |:hardcopy| output. |
| 4852 | See |pheader-option|. |
| 4853 | |
| 4854 | *'printmbcharset'* *'pmbcs'* |
| 4855 | 'printmbcharset' 'pmbcs' string (default "") |
| 4856 | global |
| 4857 | {not in Vi} |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 4858 | {only available when compiled with the |+printer|, |
| 4859 | |+postscript| and |+multi_byte| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4860 | The CJK character set to be used for CJK output from |:hardcopy|. |
| 4861 | See |pmbcs-option|. |
| 4862 | |
| 4863 | *'printmbfont'* *'pmbfn'* |
| 4864 | 'printmbfont' 'pmbfn' string (default "") |
| 4865 | global |
| 4866 | {not in Vi} |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 4867 | {only available when compiled with the |+printer|, |
| 4868 | |+postscript| and |+multi_byte| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4869 | List of font names to be used for CJK output from |:hardcopy|. |
| 4870 | See |pmbfn-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4871 | |
| 4872 | *'printoptions'* *'popt'* |
| 4873 | 'printoptions' 'popt' string (default "") |
| 4874 | global |
| 4875 | {not in Vi} |
| 4876 | {only available when compiled with |+printer| feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 4877 | List of items that control the format of the output of |:hardcopy|. |
| 4878 | See |popt-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4879 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 4880 | *'prompt'* *'noprompt'* |
| 4881 | 'prompt' boolean (default on) |
| 4882 | global |
| 4883 | When on a ":" prompt is used in Ex mode. |
| 4884 | |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 4885 | *'quoteescape'* *'qe'* |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 4886 | 'quoteescape' 'qe' string (default "\") |
| 4887 | local to buffer |
| 4888 | {not in Vi} |
| 4889 | The characters that are used to escape quotes in a string. Used for |
| 4890 | objects like a', a" and a` |a'|. |
| 4891 | When one of the characters in this option is found inside a string, |
| 4892 | the following character will be skipped. The default value makes the |
| 4893 | text "foo\"bar\\" considered to be one string. |
| 4894 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4895 | *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 4896 | 'readonly' 'ro' boolean (default off) |
| 4897 | local to buffer |
| 4898 | If on, writes fail unless you use a '!'. Protects you from |
| 4899 | accidentally overwriting a file. Default on when Vim is started |
| 4900 | in read-only mode ("vim -R") or when the executable is called "view". |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 4901 | When using ":w!" the 'readonly' option is reset for the current |
| 4902 | buffer, unless the 'Z' flag is in 'cpoptions'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4903 | {not in Vi:} When using the ":view" command the 'readonly' option is |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 4904 | set for the newly edited buffer. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4905 | |
| 4906 | *'remap'* *'noremap'* |
| 4907 | 'remap' boolean (default on) |
| 4908 | global |
| 4909 | Allows for mappings to work recursively. If you do not want this for |
| 4910 | a single entry, use the :noremap[!] command. |
| 4911 | |
| 4912 | *'report'* |
| 4913 | 'report' number (default 2) |
| 4914 | global |
| 4915 | Threshold for reporting number of lines changed. When the number of |
| 4916 | changed lines is more than 'report' a message will be given for most |
| 4917 | ":" commands. If you want it always, set 'report' to 0. |
| 4918 | For the ":substitute" command the number of substitutions is used |
| 4919 | instead of the number of lines. |
| 4920 | |
| 4921 | *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* |
| 4922 | 'restorescreen' 'rs' boolean (default on) |
| 4923 | global |
| 4924 | {not in Vi} {only in Windows 95/NT console version} |
| 4925 | When set, the screen contents is restored when exiting Vim. This also |
| 4926 | happens when executing external commands. |
| 4927 | |
| 4928 | For non-Windows Vim: You can set or reset the 't_ti' and 't_te' |
| 4929 | options in your .vimrc. To disable restoring: |
| 4930 | set t_ti= t_te= |
| 4931 | To enable restoring (for an xterm): |
| 4932 | set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 |
| 4933 | (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) |
| 4934 | |
| 4935 | *'revins'* *'ri'* *'norevins'* *'nori'* |
| 4936 | 'revins' 'ri' boolean (default off) |
| 4937 | global |
| 4938 | {not in Vi} |
| 4939 | {only available when compiled with the |+rightleft| |
| 4940 | feature} |
| 4941 | Inserting characters in Insert mode will work backwards. See "typing |
| 4942 | backwards" |ins-reverse|. This option can be toggled with the CTRL-_ |
| 4943 | command in Insert mode, when 'allowrevins' is set. |
| 4944 | NOTE: This option is reset when 'compatible' or 'paste' is set. |
| 4945 | |
| 4946 | *'rightleft'* *'rl'* *'norightleft'* *'norl'* |
| 4947 | 'rightleft' 'rl' boolean (default off) |
| 4948 | local to window |
| 4949 | {not in Vi} |
| 4950 | {only available when compiled with the |+rightleft| |
| 4951 | feature} |
| 4952 | When on, display orientation becomes right-to-left, i.e., characters |
| 4953 | that are stored in the file appear from the right to the left. |
| 4954 | Using this option, it is possible to edit files for languages that |
| 4955 | are written from the right to the left such as Hebrew and Arabic. |
| 4956 | This option is per window, so it is possible to edit mixed files |
| 4957 | simultaneously, or to view the same file in both ways (this is |
| 4958 | useful whenever you have a mixed text file with both right-to-left |
| 4959 | and left-to-right strings so that both sets are displayed properly |
| 4960 | in different windows). Also see |rileft.txt|. |
| 4961 | |
| 4962 | *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'* |
| 4963 | 'rightleftcmd' 'rlc' string (default "search") |
| 4964 | local to window |
| 4965 | {not in Vi} |
| 4966 | {only available when compiled with the |+rightleft| |
| 4967 | feature} |
| 4968 | Each word in this option enables the command line editing to work in |
| 4969 | right-to-left mode for a group of commands: |
| 4970 | |
| 4971 | search "/" and "?" commands |
| 4972 | |
| 4973 | This is useful for languages such as Hebrew, Arabic and Farsi. |
| 4974 | The 'rightleft' option must be set for 'rightleftcmd' to take effect. |
| 4975 | |
| 4976 | *'ruler'* *'ru'* *'noruler'* *'noru'* |
| 4977 | 'ruler' 'ru' boolean (default off) |
| 4978 | global |
| 4979 | {not in Vi} |
| 4980 | {not available when compiled without the |
| 4981 | |+cmdline_info| feature} |
| 4982 | Show the line and column number of the cursor position, separated by a |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4983 | comma. When there is room, the relative position of the displayed |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4984 | text in the file is shown on the far right: |
| 4985 | Top first line is visible |
| 4986 | Bot last line is visible |
| 4987 | All first and last line are visible |
| 4988 | 45% relative position in the file |
| 4989 | If 'rulerformat' is set, it will determine the contents of the ruler. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4990 | Each window has its own ruler. If a window has a status line, the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4991 | ruler is shown there. Otherwise it is shown in the last line of the |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 4992 | screen. If the statusline is given by 'statusline' (i.e. not empty), |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4993 | this option takes precedence over 'ruler' and 'rulerformat' |
| 4994 | If the number of characters displayed is different from the number of |
| 4995 | bytes in the text (e.g., for a TAB or a multi-byte character), both |
| 4996 | the text column (byte number) and the screen column are shown, |
| 4997 | separated with a dash. |
| 4998 | For an empty line "0-1" is shown. |
| 4999 | For an empty buffer the line number will also be zero: "0,0-1". |
| 5000 | This option is reset when the 'paste' option is set. |
| 5001 | If you don't want to see the ruler all the time but want to know where |
| 5002 | you are, use "g CTRL-G" |g_CTRL-G|. |
| 5003 | NOTE: This option is reset when 'compatible' is set. |
| 5004 | |
| 5005 | *'rulerformat'* *'ruf'* |
| 5006 | 'rulerformat' 'ruf' string (default empty) |
| 5007 | global |
| 5008 | {not in Vi} |
| 5009 | {not available when compiled without the |+statusline| |
| 5010 | feature} |
| 5011 | When this option is not empty, it determines the content of the ruler |
| 5012 | string, as displayed for the 'ruler' option. |
| 5013 | The format of this option, is like that of 'statusline'. |
| 5014 | The default ruler width is 17 characters. To make the ruler 15 |
| 5015 | characters wide, put "%15(" at the start and "%)" at the end. |
| 5016 | Example: > |
| 5017 | :set rulerformat=%15(%c%V\ %p%%%) |
| 5018 | < |
| 5019 | *'runtimepath'* *'rtp'* *vimfiles* |
| 5020 | 'runtimepath' 'rtp' string (default: |
| 5021 | Unix: "$HOME/.vim, |
| 5022 | $VIM/vimfiles, |
| 5023 | $VIMRUNTIME, |
| 5024 | $VIM/vimfiles/after, |
| 5025 | $HOME/.vim/after" |
| 5026 | Amiga: "home:vimfiles, |
| 5027 | $VIM/vimfiles, |
| 5028 | $VIMRUNTIME, |
| 5029 | $VIM/vimfiles/after, |
| 5030 | home:vimfiles/after" |
| 5031 | PC, OS/2: "$HOME/vimfiles, |
| 5032 | $VIM/vimfiles, |
| 5033 | $VIMRUNTIME, |
| 5034 | $VIM/vimfiles/after, |
| 5035 | $HOME/vimfiles/after" |
| 5036 | Macintosh: "$VIM:vimfiles, |
| 5037 | $VIMRUNTIME, |
| 5038 | $VIM:vimfiles:after" |
| 5039 | RISC-OS: "Choices:vimfiles, |
| 5040 | $VIMRUNTIME, |
| 5041 | Choices:vimfiles/after" |
| 5042 | VMS: "sys$login:vimfiles, |
| 5043 | $VIM/vimfiles, |
| 5044 | $VIMRUNTIME, |
| 5045 | $VIM/vimfiles/after, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5046 | sys$login:vimfiles/after") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5047 | global |
| 5048 | {not in Vi} |
| 5049 | This is a list of directories which will be searched for runtime |
| 5050 | files: |
| 5051 | filetype.vim filetypes by file name |new-filetype| |
| 5052 | scripts.vim filetypes by file contents |new-filetype-scripts| |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 5053 | autoload/ automatically loaded scripts |autoload-functions| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5054 | colors/ color scheme files |:colorscheme| |
| 5055 | compiler/ compiler files |:compiler| |
| 5056 | doc/ documentation |write-local-help| |
| 5057 | ftplugin/ filetype plugins |write-filetype-plugin| |
| 5058 | indent/ indent scripts |indent-expression| |
| 5059 | keymap/ key mapping files |mbyte-keymap| |
| 5060 | lang/ menu translations |:menutrans| |
| 5061 | menu.vim GUI menus |menu.vim| |
| 5062 | plugin/ plugin scripts |write-plugin| |
| 5063 | print/ files for printing |postscript-print-encoding| |
| 5064 | syntax/ syntax files |mysyntaxfile| |
| 5065 | tutor/ files for vimtutor |tutor| |
| 5066 | |
| 5067 | And any other file searched for with the |:runtime| command. |
| 5068 | |
| 5069 | The defaults for most systems are setup to search five locations: |
| 5070 | 1. In your home directory, for your personal preferences. |
| 5071 | 2. In a system-wide Vim directory, for preferences from the system |
| 5072 | administrator. |
| 5073 | 3. In $VIMRUNTIME, for files distributed with Vim. |
| 5074 | *after-directory* |
| 5075 | 4. In the "after" directory in the system-wide Vim directory. This is |
| 5076 | for the system administrator to overrule or add to the distributed |
| 5077 | defaults (rarely needed) |
| 5078 | 5. In the "after" directory in your home directory. This is for |
| 5079 | personal preferences to overrule or add to the distributed defaults |
| 5080 | or system-wide settings (rarely needed). |
| 5081 | |
| 5082 | Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 5083 | wildcards are allowed, but can significantly slow down searching for |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5084 | runtime files. For speed, use as few items as possible and avoid |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5085 | wildcards. |
| 5086 | See |:runtime|. |
| 5087 | Example: > |
| 5088 | :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME |
| 5089 | < This will use the directory "~/vimruntime" first (containing your |
| 5090 | personal Vim runtime files), then "/mygroup/vim" (shared between a |
| 5091 | group of people) and finally "$VIMRUNTIME" (the distributed runtime |
| 5092 | files). |
| 5093 | You probably should always include $VIMRUNTIME somewhere, to use the |
| 5094 | distributed runtime files. You can put a directory before $VIMRUNTIME |
| 5095 | to find files which replace a distributed runtime files. You can put |
| 5096 | a directory after $VIMRUNTIME to find files which add to distributed |
| 5097 | runtime files. |
| 5098 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5099 | security reasons. |
| 5100 | |
| 5101 | *'scroll'* *'scr'* |
| 5102 | 'scroll' 'scr' number (default: half the window height) |
| 5103 | local to window |
| 5104 | Number of lines to scroll with CTRL-U and CTRL-D commands. Will be |
| 5105 | set to half the number of lines in the window when the window size |
| 5106 | changes. If you give a count to the CTRL-U or CTRL-D command it will |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5107 | be used as the new value for 'scroll'. Reset to half the window |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5108 | height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
| 5109 | the number of screen lines instead of file lines, makes a difference |
| 5110 | when lines wrap} |
| 5111 | |
| 5112 | *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* |
| 5113 | 'scrollbind' 'scb' boolean (default off) |
| 5114 | local to window |
| 5115 | {not in Vi} |
| 5116 | {not available when compiled without the |+scrollbind| |
| 5117 | feature} |
| 5118 | See also |scroll-binding|. When this option is set, the current |
| 5119 | window scrolls as other scrollbind windows (windows that also have |
| 5120 | this option set) scroll. This option is useful for viewing the |
| 5121 | differences between two versions of a file, see 'diff'. |
| 5122 | See |'scrollopt'| for options that determine how this option should be |
| 5123 | interpreted. |
| 5124 | This option is mostly reset when splitting a window to edit another |
| 5125 | file. This means that ":split | edit file" results in two windows |
| 5126 | with scroll-binding, but ":split file" does not. |
| 5127 | |
| 5128 | *'scrolljump'* *'sj'* |
| 5129 | 'scrolljump' 'sj' number (default 1) |
| 5130 | global |
| 5131 | {not in Vi} |
| 5132 | Minimal number of lines to scroll when the cursor gets off the |
| 5133 | screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, |
| 5134 | CTRL-D). Useful if your terminal scrolls very slowly. |
| 5135 | NOTE: This option is set to 1 when 'compatible' is set. |
| 5136 | |
| 5137 | *'scrolloff'* *'so'* |
| 5138 | 'scrolloff' 'so' number (default 0) |
| 5139 | global |
| 5140 | {not in Vi} |
| 5141 | Minimal number of screen lines to keep above and below the cursor. |
| 5142 | This will make some context visible around where you are working. If |
| 5143 | you set it to a very large value (999) the cursor line will always be |
| 5144 | in the middle of the window (except at the start or end of the file or |
| 5145 | when long lines wrap). |
| 5146 | For scrolling horizontally see 'sidescrolloff'. |
| 5147 | NOTE: This option is set to 0 when 'compatible' is set. |
| 5148 | |
| 5149 | *'scrollopt'* *'sbo'* |
| 5150 | 'scrollopt' 'sbo' string (default "ver,jump") |
| 5151 | global |
| 5152 | {not available when compiled without the |+scrollbind| |
| 5153 | feature} |
| 5154 | {not in Vi} |
| 5155 | This is a comma-separated list of words that specifies how |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 5156 | 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 5157 | Options. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5158 | The following words are available: |
| 5159 | ver Bind vertical scrolling for 'scrollbind' windows |
| 5160 | hor Bind horizontal scrolling for 'scrollbind' windows |
| 5161 | jump Applies to the offset between two windows for vertical |
| 5162 | scrolling. This offset is the difference in the first |
| 5163 | displayed line of the bound windows. When moving |
| 5164 | around in a window, another 'scrollbind' window may |
| 5165 | reach a position before the start or after the end of |
| 5166 | the buffer. The offset is not changed though, when |
| 5167 | moving back the 'scrollbind' window will try to scroll |
| 5168 | to the desired position when possible. |
| 5169 | When now making that window the current one, two |
| 5170 | things can be done with the relative offset: |
| 5171 | 1. When "jump" is not included, the relative offset is |
| 5172 | adjusted for the scroll position in the new current |
| 5173 | window. When going back to the other window, the |
| 5174 | the new relative offset will be used. |
| 5175 | 2. When "jump" is included, the other windows are |
| 5176 | scrolled to keep the same relative offset. When |
| 5177 | going back to the other window, it still uses the |
| 5178 | same relative offset. |
| 5179 | Also see |scroll-binding|. |
| 5180 | |
| 5181 | *'sections'* *'sect'* |
| 5182 | 'sections' 'sect' string (default "SHNHH HUnhsh") |
| 5183 | global |
| 5184 | Specifies the nroff macros that separate sections. These are pairs of |
| 5185 | two letters (See |object-motions|). The default makes a section start |
| 5186 | at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". |
| 5187 | |
| 5188 | *'secure'* *'nosecure'* *E523* |
| 5189 | 'secure' boolean (default off) |
| 5190 | global |
| 5191 | {not in Vi} |
| 5192 | When on, ":autocmd", shell and write commands are not allowed in |
| 5193 | ".vimrc" and ".exrc" in the current directory and map commands are |
| 5194 | displayed. Switch it off only if you know that you will not run into |
| 5195 | problems, or when the 'exrc' option is off. On Unix this option is |
| 5196 | only used if the ".vimrc" or ".exrc" is not owned by you. This can be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5197 | dangerous if the systems allows users to do a "chown". You better set |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5198 | 'secure' at the end of your ~/.vimrc then. |
| 5199 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5200 | security reasons. |
| 5201 | |
| 5202 | *'selection'* *'sel'* |
| 5203 | 'selection' 'sel' string (default "inclusive") |
| 5204 | global |
| 5205 | {not in Vi} |
| 5206 | This option defines the behavior of the selection. It is only used |
| 5207 | in Visual and Select mode. |
| 5208 | Possible values: |
| 5209 | value past line inclusive ~ |
| 5210 | old no yes |
| 5211 | inclusive yes yes |
| 5212 | exclusive yes no |
| 5213 | "past line" means that the cursor is allowed to be positioned one |
| 5214 | character past the line. |
| 5215 | "inclusive" means that the last character of the selection is included |
| 5216 | in an operation. For example, when "x" is used to delete the |
| 5217 | selection. |
| 5218 | Note that when "exclusive" is used and selecting from the end |
| 5219 | backwards, you cannot include the last character of a line, when |
| 5220 | starting in Normal mode and 'virtualedit' empty. |
| 5221 | |
| 5222 | The 'selection' option is set by the |:behave| command. |
| 5223 | |
| 5224 | *'selectmode'* *'slm'* |
| 5225 | 'selectmode' 'slm' string (default "") |
| 5226 | global |
| 5227 | {not in Vi} |
| 5228 | This is a comma separated list of words, which specifies when to start |
| 5229 | Select mode instead of Visual mode, when a selection is started. |
| 5230 | Possible values: |
| 5231 | mouse when using the mouse |
| 5232 | key when using shifted special keys |
| 5233 | cmd when using "v", "V" or CTRL-V |
| 5234 | See |Select-mode|. |
| 5235 | The 'selectmode' option is set by the |:behave| command. |
| 5236 | |
| 5237 | *'sessionoptions'* *'ssop'* |
| 5238 | 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, |
| 5239 | help,options,winsize") |
| 5240 | global |
| 5241 | {not in Vi} |
| 5242 | {not available when compiled without the +mksession |
| 5243 | feature} |
| 5244 | Changes the effect of the |:mksession| command. It is a comma |
| 5245 | separated list of words. Each word enables saving and restoring |
| 5246 | something: |
| 5247 | word save and restore ~ |
| 5248 | blank empty windows |
| 5249 | buffers hidden and unloaded buffers, not just those in windows |
| 5250 | curdir the current directory |
| 5251 | folds manually created folds, opened/closed folds and local |
| 5252 | fold options |
| 5253 | globals global variables that start with an uppercase letter |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 5254 | and contain at least one lowercase letter. Only |
| 5255 | String and Number types are stored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5256 | help the help window |
| 5257 | localoptions options and mappings local to a window or buffer (not |
| 5258 | global values for local options) |
| 5259 | options all options and mappings (also global values for local |
| 5260 | options) |
| 5261 | resize size of the Vim window: 'lines' and 'columns' |
| 5262 | sesdir the directory in which the session file is located |
| 5263 | will become the current directory (useful with |
| 5264 | projects accessed over a network from different |
| 5265 | systems) |
| 5266 | slash backslashes in file names replaced with forward |
| 5267 | slashes |
| 5268 | unix with Unix end-of-line format (single <NL>), even when |
| 5269 | on Windows or DOS |
| 5270 | winpos position of the whole Vim window |
| 5271 | winsize window sizes |
| 5272 | |
| 5273 | Don't include both "curdir" and "sesdir". |
| 5274 | When "curdir" nor "sesdir" is included, file names are stored with |
| 5275 | absolute paths. |
| 5276 | "slash" and "unix" are useful on Windows when sharing session files |
| 5277 | with Unix. The Unix version of Vim cannot source dos format scripts, |
| 5278 | but the Windows version of Vim can source unix format scripts. |
| 5279 | |
| 5280 | *'shell'* *'sh'* *E91* |
| 5281 | 'shell' 'sh' string (default $SHELL or "sh", |
| 5282 | MS-DOS and Win32: "command.com" or |
| 5283 | "cmd.exe", OS/2: "cmd") |
| 5284 | global |
| 5285 | Name of the shell to use for ! and :! commands. When changing the |
| 5286 | value also check these options: 'shelltype', 'shellpipe', 'shellslash' |
| 5287 | 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5288 | It is allowed to give an argument to the command, e.g. "csh -f". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5289 | See |option-backslash| about including spaces and backslashes. |
| 5290 | Environment variables are expanded |:set_env|. |
| 5291 | If the name of the shell contains a space, you might need to enclose |
| 5292 | it in quotes. Example: > |
| 5293 | :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
| 5294 | < Note the backslash before each quote (to avoid starting a comment) and |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5295 | each space (to avoid ending the option value). Also note that the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5296 | "-f" is not inside the quotes, because it is not part of the command |
| 5297 | name. And Vim automagically recognizes the backslashes that are path |
| 5298 | separators. |
| 5299 | For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment |
| 5300 | variable to change the way external commands are executed. See the |
| 5301 | libc.inf file of DJGPP. |
| 5302 | Under MS-Windows, when the executable ends in ".com" it must be |
| 5303 | included. Thus setting the shell to "command.com" or "4dos.com" |
| 5304 | works, but "command" and "4dos" do not work for all commands (e.g., |
| 5305 | filtering). |
| 5306 | For unknown reasons, when using "4dos.com" the current directory is |
| 5307 | changed to "C:\". To avoid this set 'shell' like this: > |
| 5308 | :set shell=command.com\ /c\ 4dos |
| 5309 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5310 | security reasons. |
| 5311 | |
| 5312 | *'shellcmdflag'* *'shcf'* |
| 5313 | 'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell' |
| 5314 | does not contain "sh" somewhere: "/c") |
| 5315 | global |
| 5316 | {not in Vi} |
| 5317 | Flag passed to the shell to execute "!" and ":!" commands; e.g., |
| 5318 | "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like |
| 5319 | systems, the default is set according to the value of 'shell', to |
| 5320 | reduce the need to set this option by the user. It's not used for |
| 5321 | OS/2 (EMX figures this out itself). See |option-backslash| about |
| 5322 | including spaces and backslashes. See |dos-shell|. |
| 5323 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5324 | security reasons. |
| 5325 | |
| 5326 | *'shellpipe'* *'sp'* |
| 5327 | 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") |
| 5328 | global |
| 5329 | {not in Vi} |
| 5330 | {not available when compiled without the |+quickfix| |
| 5331 | feature} |
| 5332 | String to be used to put the output of the ":make" command in the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5333 | error file. See also |:make_makeprg|. See |option-backslash| about |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5334 | including spaces and backslashes. |
| 5335 | The name of the temporary file can be represented by "%s" if necessary |
| 5336 | (the file name is appended automatically if no %s appears in the value |
| 5337 | of this option). |
| 5338 | For the Amiga and MS-DOS the default is ">". The output is directly |
| 5339 | saved in a file and not echoed to the screen. |
| 5340 | For Unix the default it "| tee". The stdout of the compiler is saved |
| 5341 | in a file and echoed to the screen. If the 'shell' option is "csh" or |
| 5342 | "tcsh" after initializations, the default becomes "|& tee". If the |
| 5343 | 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes |
| 5344 | "2>&1| tee". This means that stderr is also included. |
| 5345 | The initialization of this option is done after reading the ".vimrc" |
| 5346 | and the other initializations, so that when the 'shell' option is set |
| 5347 | there, the 'shellpipe' option changes automatically, unless it was |
| 5348 | explicitly set before. |
| 5349 | When 'shellpipe' is set to an empty string, no redirection of the |
| 5350 | ":make" output will be done. This is useful if you use a 'makeprg' |
| 5351 | that writes to 'makeef' by itself. If you want no piping, but do |
| 5352 | want to include the 'makeef', set 'shellpipe' to a single space. |
| 5353 | Don't forget to precede the space with a backslash: ":set sp=\ ". |
| 5354 | In the future pipes may be used for filtering and this option will |
| 5355 | become obsolete (at least for Unix). |
| 5356 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5357 | security reasons. |
| 5358 | |
| 5359 | *'shellquote'* *'shq'* |
| 5360 | 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' |
| 5361 | contains "sh" somewhere: "\"") |
| 5362 | global |
| 5363 | {not in Vi} |
| 5364 | Quoting character(s), put around the command passed to the shell, for |
| 5365 | the "!" and ":!" commands. The redirection is kept outside of the |
| 5366 | quoting. See 'shellxquote' to include the redirection. It's |
| 5367 | probably not useful to set both options. |
| 5368 | This is an empty string by default. Only known to be useful for |
| 5369 | third-party shells on MS-DOS-like systems, such as the MKS Korn Shell |
| 5370 | or bash, where it should be "\"". The default is adjusted according |
| 5371 | the value of 'shell', to reduce the need to set this option by the |
| 5372 | user. See |dos-shell|. |
| 5373 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5374 | security reasons. |
| 5375 | |
| 5376 | *'shellredir'* *'srr'* |
| 5377 | 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") |
| 5378 | global |
| 5379 | {not in Vi} |
| 5380 | String to be used to put the output of a filter command in a temporary |
| 5381 | file. See also |:!|. See |option-backslash| about including spaces |
| 5382 | and backslashes. |
| 5383 | The name of the temporary file can be represented by "%s" if necessary |
| 5384 | (the file name is appended automatically if no %s appears in the value |
| 5385 | of this option). |
| 5386 | The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" |
| 5387 | or "zsh" during initializations, the default becomes ">&". If the |
| 5388 | 'shell' option is "sh", "ksh" or "bash" the default becomes |
| 5389 | ">%s 2>&1". This means that stderr is also included. |
| 5390 | For Win32, the Unix checks are done and additionally "cmd" is checked |
| 5391 | for, which makes the default ">%s 2>&1". Also, the same names with |
| 5392 | ".exe" appended are checked for. |
| 5393 | The initialization of this option is done after reading the ".vimrc" |
| 5394 | and the other initializations, so that when the 'shell' option is set |
| 5395 | there, the 'shellredir' option changes automatically unless it was |
| 5396 | explicitly set before. |
| 5397 | In the future pipes may be used for filtering and this option will |
| 5398 | become obsolete (at least for Unix). |
| 5399 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5400 | security reasons. |
| 5401 | |
| 5402 | *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* |
| 5403 | 'shellslash' 'ssl' boolean (default off) |
| 5404 | global |
| 5405 | {not in Vi} {only for MSDOS, MS-Windows and OS/2} |
| 5406 | When set, a forward slash is used when expanding file names. This is |
| 5407 | useful when a Unix-like shell is used instead of command.com or |
| 5408 | cmd.exe. Backward slashes can still be typed, but they are changed to |
| 5409 | forward slashes by Vim. |
| 5410 | Note that setting or resetting this option has no effect for some |
| 5411 | existing file names, thus this option needs to be set before opening |
| 5412 | any file for best results. This might change in the future. |
| 5413 | 'shellslash' only works when a backslash can be used as a path |
| 5414 | separator. To test if this is so use: > |
| 5415 | if exists('+shellslash') |
| 5416 | < |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 5417 | *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 5418 | 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) |
| 5419 | global |
| 5420 | {not in Vi} |
| 5421 | When on, use temp files for shell commands. When off use a pipe. |
| 5422 | When using a pipe is not possible temp files are used anyway. |
| 5423 | Currently a pipe is only supported on Unix. You can check it with: > |
| 5424 | :if has("filterpipe") |
| 5425 | < The advantage of using a pipe is that nobody can read the temp file |
| 5426 | and the 'shell' command does not need to support redirection. |
| 5427 | The advantage of using a temp file is that the file type and encoding |
| 5428 | can be detected. |
| 5429 | The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, |
| 5430 | |FilterWritePost| autocommands event are not triggered when |
| 5431 | 'shelltemp' is off. |
| 5432 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5433 | *'shelltype'* *'st'* |
| 5434 | 'shelltype' 'st' number (default 0) |
| 5435 | global |
| 5436 | {not in Vi} {only for the Amiga} |
| 5437 | On the Amiga this option influences the way how the commands work |
| 5438 | which use a shell. |
| 5439 | 0 and 1: always use the shell |
| 5440 | 2 and 3: use the shell only to filter lines |
| 5441 | 4 and 5: use shell only for ':sh' command |
| 5442 | When not using the shell, the command is executed directly. |
| 5443 | |
| 5444 | 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands |
| 5445 | 1 and 3: use "shell cmd" to start external commands |
| 5446 | |
| 5447 | *'shellxquote'* *'sxq'* |
| 5448 | 'shellxquote' 'sxq' string (default: ""; |
| 5449 | for Win32, when 'shell' contains "sh" |
| 5450 | somewhere: "\"" |
| 5451 | for Unix, when using system(): "\"") |
| 5452 | global |
| 5453 | {not in Vi} |
| 5454 | Quoting character(s), put around the command passed to the shell, for |
| 5455 | the "!" and ":!" commands. Includes the redirection. See |
| 5456 | 'shellquote' to exclude the redirection. It's probably not useful |
| 5457 | to set both options. |
| 5458 | This is an empty string by default. Known to be useful for |
| 5459 | third-party shells when using the Win32 version, such as the MKS Korn |
| 5460 | Shell or bash, where it should be "\"". The default is adjusted |
| 5461 | according the value of 'shell', to reduce the need to set this option |
| 5462 | by the user. See |dos-shell|. |
| 5463 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5464 | security reasons. |
| 5465 | |
| 5466 | *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* |
| 5467 | 'shiftround' 'sr' boolean (default off) |
| 5468 | global |
| 5469 | {not in Vi} |
| 5470 | Round indent to multiple of 'shiftwidth'. Applies to > and < |
| 5471 | commands. CTRL-T and CTRL-D in Insert mode always round the indent to |
| 5472 | a multiple of 'shiftwidth' (this is Vi compatible). |
| 5473 | NOTE: This option is reset when 'compatible' is set. |
| 5474 | |
| 5475 | *'shiftwidth'* *'sw'* |
| 5476 | 'shiftwidth' 'sw' number (default 8) |
| 5477 | local to buffer |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5478 | Number of spaces to use for each step of (auto)indent. Used for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5479 | |'cindent'|, |>>|, |<<|, etc. |
| 5480 | |
| 5481 | *'shortmess'* *'shm'* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 5482 | 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "", |
| 5483 | POSIX default: "A") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5484 | global |
| 5485 | {not in Vi} |
| 5486 | This option helps to avoid all the |hit-enter| prompts caused by file |
| 5487 | messages, for example with CTRL-G, and to avoid some other messages. |
| 5488 | It is a list of flags: |
| 5489 | flag meaning when present ~ |
| 5490 | f use "(3 of 5)" instead of "(file 3 of 5)" |
| 5491 | i use "[noeol]" instead of "[Incomplete last line]" |
| 5492 | l use "999L, 888C" instead of "999 lines, 888 characters" |
| 5493 | m use "[+]" instead of "[Modified]" |
| 5494 | n use "[New]" instead of "[New File]" |
| 5495 | r use "[RO]" instead of "[readonly]" |
| 5496 | w use "[w]" instead of "written" for file write message |
| 5497 | and "[a]" instead of "appended" for ':w >> file' command |
| 5498 | x use "[dos]" instead of "[dos format]", "[unix]" instead of |
| 5499 | "[unix format]" and "[mac]" instead of "[mac format]". |
| 5500 | a all of the above abbreviations |
| 5501 | |
| 5502 | o overwrite message for writing a file with subsequent message |
| 5503 | for reading a file (useful for ":wn" or when 'autowrite' on) |
| 5504 | O message for reading a file overwrites any previous message. |
| 5505 | Also for quickfix message (e.g., ":cn"). |
| 5506 | s don't give "search hit BOTTOM, continuing at TOP" or "search |
| 5507 | hit TOP, continuing at BOTTOM" messages |
| 5508 | t truncate file message at the start if it is too long to fit |
| 5509 | on the command-line, "<" will appear in the left most column. |
| 5510 | Ignored in Ex mode. |
| 5511 | T truncate other messages in the middle if they are too long to |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5512 | fit on the command line. "..." will appear in the middle. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5513 | Ignored in Ex mode. |
| 5514 | W don't give "written" or "[w]" when writing a file |
| 5515 | A don't give the "ATTENTION" message when an existing swap file |
| 5516 | is found. |
| 5517 | I don't give the intro message when starting Vim |:intro|. |
| 5518 | |
| 5519 | This gives you the opportunity to avoid that a change between buffers |
| 5520 | requires you to hit <Enter>, but still gives as useful a message as |
| 5521 | possible for the space available. To get the whole message that you |
| 5522 | would have got with 'shm' empty, use ":file!" |
| 5523 | Useful values: |
| 5524 | shm= No abbreviation of message. |
| 5525 | shm=a Abbreviation, but no loss of information. |
| 5526 | shm=at Abbreviation, and truncate message when necessary. |
| 5527 | |
| 5528 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 5529 | set and to the Vim default value when 'compatible' is reset. |
| 5530 | |
| 5531 | *'shortname'* *'sn'* *'noshortname'* *'nosn'* |
| 5532 | 'shortname' 'sn' boolean (default off) |
| 5533 | local to buffer |
| 5534 | {not in Vi, not in MS-DOS versions} |
| 5535 | Filenames are assumed to be 8 characters plus one extension of 3 |
| 5536 | characters. Multiple dots in file names are not allowed. When this |
| 5537 | option is on, dots in file names are replaced with underscores when |
| 5538 | adding an extension (".~" or ".swp"). This option is not available |
| 5539 | for MS-DOS, because then it would always be on. This option is useful |
| 5540 | when editing files on an MS-DOS compatible filesystem, e.g., messydos |
| 5541 | or crossdos. When running the Win32 GUI version under Win32s, this |
| 5542 | option is always on by default. |
| 5543 | |
| 5544 | *'showbreak'* *'sbr'* *E595* |
| 5545 | 'showbreak' 'sbr' string (default "") |
| 5546 | global |
| 5547 | {not in Vi} |
| 5548 | {not available when compiled without the |+linebreak| |
| 5549 | feature} |
| 5550 | String to put at the start of lines that have been wrapped. Useful |
| 5551 | values are "> " or "+++ ". |
| 5552 | Only printable single-cell characters are allowed, excluding <Tab> and |
| 5553 | comma (in a future version the comma might be used to separate the |
| 5554 | part that is shown at the end and at the start of a line). |
| 5555 | The characters are highlighted according to the '@' flag in |
| 5556 | 'highlight'. |
| 5557 | Note that tabs after the showbreak will be displayed differently. |
| 5558 | If you want the 'showbreak' to appear in between line numbers, add the |
| 5559 | "n" flag to 'cpoptions'. |
| 5560 | |
| 5561 | *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
| 5562 | 'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default: |
| 5563 | off) |
| 5564 | global |
| 5565 | {not in Vi} |
| 5566 | {not available when compiled without the |
| 5567 | |+cmdline_info| feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5568 | Show (partial) command in status line. Set this option off if your |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5569 | terminal is slow. |
| 5570 | In Visual mode the size of the selected area is shown: |
| 5571 | - When selecting characters within a line, the number of characters. |
| 5572 | - When selecting more than one line, the number of lines. |
| 5573 | - When selecting a block, the size in screen characters: linesxcolumns. |
| 5574 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 5575 | set and to the Vim default value when 'compatible' is reset. |
| 5576 | |
| 5577 | *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* |
| 5578 | 'showfulltag' 'sft' boolean (default off) |
| 5579 | global |
| 5580 | {not in Vi} |
| 5581 | When completing a word in insert mode (see |ins-completion|) from the |
| 5582 | tags file, show both the tag name and a tidied-up form of the search |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5583 | pattern (if there is one) as possible matches. Thus, if you have |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5584 | matched a C function, you can see a template for what arguments are |
| 5585 | required (coding style permitting). |
| 5586 | |
| 5587 | *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* |
| 5588 | 'showmatch' 'sm' boolean (default off) |
| 5589 | global |
| 5590 | When a bracket is inserted, briefly jump to the matching one. The |
| 5591 | jump is only done if the match can be seen on the screen. The time to |
| 5592 | show the match can be set with 'matchtime'. |
| 5593 | A Beep is given if there is no match (no matter if the match can be |
| 5594 | seen or not). This option is reset when the 'paste' option is set. |
| 5595 | When the 'm' flag is not included in 'cpoptions', typing a character |
| 5596 | will immediately move the cursor back to where it belongs. |
| 5597 | See the "sm" field in 'guicursor' for setting the cursor shape and |
| 5598 | blinking when showing the match. |
| 5599 | The 'matchpairs' option can be used to specify the characters to show |
| 5600 | matches for. 'rightleft' and 'revins' are used to look for opposite |
| 5601 | matches. |
| 5602 | Note: For the use of the short form parental guidance is advised. |
| 5603 | |
| 5604 | *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* |
| 5605 | 'showmode' 'smd' boolean (Vim default: on, Vi default: off) |
| 5606 | global |
| 5607 | If in Insert, Replace or Visual mode put a message on the last line. |
| 5608 | Use the 'M' flag in 'highlight' to set the type of highlighting for |
| 5609 | this message. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5610 | When |XIM| may be used the message will include "XIM". But this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5611 | doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 5612 | not set. |
| 5613 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 5614 | set and to the Vim default value when 'compatible' is reset. |
| 5615 | |
| 5616 | *'sidescroll'* *'ss'* |
| 5617 | 'sidescroll' 'ss' number (default 0) |
| 5618 | global |
| 5619 | {not in Vi} |
| 5620 | The minimal number of columns to scroll horizontally. Used only when |
| 5621 | the 'wrap' option is off and the cursor is moved off of the screen. |
| 5622 | When it is zero the cursor will be put in the middle of the screen. |
| 5623 | When using a slow terminal set it to a large number or 0. When using |
| 5624 | a fast terminal use a small number or 1. Not used for "zh" and "zl" |
| 5625 | commands. |
| 5626 | |
| 5627 | *'sidescrolloff'* *'siso'* |
| 5628 | 'sidescrolloff' 'siso' number (default 0) |
| 5629 | global |
| 5630 | {not in Vi} |
| 5631 | The minimal number of screen columns to keep to the left and to the |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5632 | right of the cursor if 'nowrap' is set. Setting this option to a value |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5633 | greater than 0 while having |'sidescroll'| also at a non-zero value |
| 5634 | makes some context visible in the line you are scrolling in |
| 5635 | horizontally (except at the end and beginning of the line). Setting |
| 5636 | this option to a large value (like 999) has the effect of keeping the |
| 5637 | cursor horizontally centered in the window, as long as one does not |
| 5638 | come too close to the beginning or end of the line. |
| 5639 | NOTE: This option is set to 0 when 'compatible' is set. |
| 5640 | |
| 5641 | Example: Try this together with 'sidescroll' and 'listchars' as |
| 5642 | in the following example to never allow the cursor to move |
| 5643 | onto the "extends" character: |
| 5644 | |
| 5645 | :set nowrap sidescroll=1 listchars=extends:>,precedes:< |
| 5646 | :set sidescrolloff=1 |
| 5647 | |
| 5648 | |
| 5649 | *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* |
| 5650 | 'smartcase' 'scs' boolean (default off) |
| 5651 | global |
| 5652 | {not in Vi} |
| 5653 | Override the 'ignorecase' option if the search pattern contains upper |
| 5654 | case characters. Only used when the search pattern is typed and |
| 5655 | 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5656 | ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5657 | "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 5658 | recalling the search pattern from history and hitting <Enter>. |
| 5659 | NOTE: This option is reset when 'compatible' is set. |
| 5660 | |
| 5661 | *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* |
| 5662 | 'smartindent' 'si' boolean (default off) |
| 5663 | local to buffer |
| 5664 | {not in Vi} |
| 5665 | {not available when compiled without the |
| 5666 | |+smartindent| feature} |
| 5667 | Do smart autoindenting when starting a new line. Works for C-like |
| 5668 | programs, but can also be used for other languages. 'cindent' does |
| 5669 | something like this, works better in most cases, but is more strict, |
| 5670 | see |C-indenting|. When 'cindent' is on, setting 'si' has no effect. |
| 5671 | 'indentexpr' is a more advanced alternative. |
| 5672 | Normally 'autoindent' should also be on when using 'smartindent'. |
| 5673 | An indent is automatically inserted: |
| 5674 | - After a line ending in '{'. |
| 5675 | - After a line starting with a keyword from 'cinwords'. |
| 5676 | - Before a line starting with '}' (only with the "O" command). |
| 5677 | When typing '}' as the first character in a new line, that line is |
| 5678 | given the same indent as the matching '{'. |
| 5679 | When typing '#' as the first character in a new line, the indent for |
| 5680 | that line is removed, the '#' is put in the first column. The indent |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5681 | is restored for the next line. If you don't want this, use this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5682 | mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 5683 | When using the ">>" command, lines starting with '#' are not shifted |
| 5684 | right. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5685 | NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5686 | is set smart indenting is disabled. |
| 5687 | |
| 5688 | *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* |
| 5689 | 'smarttab' 'sta' boolean (default off) |
| 5690 | global |
| 5691 | {not in Vi} |
| 5692 | When on, a <Tab> in front of a line inserts blanks according to |
| 5693 | 'shiftwidth'. 'tabstop' is used in other places. A <BS> will delete |
| 5694 | a 'shiftwidth' worth of space at the start of the line. |
| 5695 | When off a <Tab> always inserts blanks according to 'tabstop'. |
| 5696 | 'shiftwidth' is only used for shifting text left or right |
| 5697 | |shift-left-right|. |
| 5698 | What gets inserted (a Tab or spaces) depends on the 'expandtab' |
| 5699 | option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 5700 | number of spaces is minimized by using <Tab>s. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5701 | NOTE: This option is reset when 'compatible' is set. |
| 5702 | |
| 5703 | *'softtabstop'* *'sts'* |
| 5704 | 'softtabstop' 'sts' number (default 0) |
| 5705 | local to buffer |
| 5706 | {not in Vi} |
| 5707 | Number of spaces that a <Tab> counts for while performing editing |
| 5708 | operations, like inserting a <Tab> or using <BS>. It "feels" like |
| 5709 | <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is |
| 5710 | used. This is useful to keep the 'ts' setting at its standard value |
| 5711 | of 8, while being able to edit like it is set to 'sts'. However, |
| 5712 | commands like "x" still work on the actual characters. |
| 5713 | When 'sts' is zero, this feature is off. |
| 5714 | 'softtabstop' is set to 0 when the 'paste' option is set. |
| 5715 | See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 5716 | spaces is minimized by using <Tab>s. |
| 5717 | The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is |
| 5718 | set. |
| 5719 | NOTE: This option is set to 0 when 'compatible' is set. |
| 5720 | |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 5721 | *'spell'* *'nospell'* |
| 5722 | 'spell' boolean (default off) |
| 5723 | local to window |
| 5724 | {not in Vi} |
| 5725 | {not available when compiled without the |+syntax| |
| 5726 | feature} |
| 5727 | When on spell checking will be done. See |spell|. |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 5728 | The languages are specified with 'spelllang'. |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 5729 | |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 5730 | *'spellcapcheck'* *'spc'* |
Bram Moolenaar | 0dc065e | 2005-07-04 22:49:24 +0000 | [diff] [blame] | 5731 | 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 5732 | local to buffer |
| 5733 | {not in Vi} |
| 5734 | {not available when compiled without the |+syntax| |
| 5735 | feature} |
| 5736 | Pattern to locate the end of a sentence. The following word will be |
| 5737 | checked to start with a capital letter. If not then it is highlighted |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 5738 | with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 5739 | When this check is not wanted make this option empty. |
| 5740 | Only used when 'spell' is set. |
Bram Moolenaar | 0dc065e | 2005-07-04 22:49:24 +0000 | [diff] [blame] | 5741 | Be careful with special characters, see |option-backslash| about |
| 5742 | including spaces and backslashes. |
Bram Moolenaar | 90cfdbe | 2005-08-12 19:59:19 +0000 | [diff] [blame] | 5743 | To set this option automatically depending on the language, see |
| 5744 | |set-spc-auto|. |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 5745 | |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 5746 | *'spellfile'* *'spf'* |
| 5747 | 'spellfile' 'spf' string (default empty) |
| 5748 | local to buffer |
| 5749 | {not in Vi} |
| 5750 | {not available when compiled without the |+syntax| |
| 5751 | feature} |
| 5752 | Name of the word list file where words are added for the |zg| and |zw| |
Bram Moolenaar | 045e82d | 2005-07-08 22:25:33 +0000 | [diff] [blame] | 5753 | commands. It must end in ".{encoding}.add". You need to include the |
| 5754 | path, otherwise the file is placed in the current directory. |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 5755 | *E765* |
| 5756 | It may also be a comma separated list of names. A count before the |
| 5757 | |zg| and |zw| commands can be used to access each. This allows using |
| 5758 | a personal word list file and a project word list file. |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 5759 | When a word is added while this option is empty Vim will set it for |
| 5760 | you: Using the first "spell" directory in 'runtimepath' that is |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 5761 | writable and the first language name that appears in 'spelllang', |
| 5762 | ignoring the region. |
| 5763 | The resulting ".spl" file will be used for spell checking, it does not |
| 5764 | have to appear in 'spelllang'. |
| 5765 | Normally one file is used for all regions, but you can add the region |
| 5766 | name if you want to. However, it will then only be used when |
| 5767 | 'spellfile' is set to it, for entries in 'spelllang' only files |
| 5768 | without region name will be found. |
Bram Moolenaar | e756604 | 2005-06-17 22:00:15 +0000 | [diff] [blame] | 5769 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5770 | security reasons. |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 5771 | |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 5772 | *'spelllang'* *'spl'* |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 5773 | 'spelllang' 'spl' string (default "en") |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 5774 | local to buffer |
| 5775 | {not in Vi} |
| 5776 | {not available when compiled without the |+syntax| |
| 5777 | feature} |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 5778 | A comma separated list of word list names. When the 'spell' option is |
| 5779 | on spellchecking will be done for these languages. Example: > |
| 5780 | set spelllang=en_us,nl,medical |
| 5781 | < This means US English, Dutch and medical words are recognized. Words |
| 5782 | that are not recognized will be highlighted. |
| 5783 | The word list name must not include a comma or dot. Using a dash is |
| 5784 | recommended to separate the two letter language name from a |
| 5785 | specification. Thus "en-rare" is used for rare English words. |
| 5786 | A region name must come last and have the form "_xx", where "xx" is |
| 5787 | the two-letter, lower case region name. You can use more than one |
| 5788 | region by listing them: "en_us,en_ca" supports both US and Canadian |
| 5789 | English, but not words specific for Australia, New Zealand or Great |
| 5790 | Britain. |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 5791 | *E757* |
Bram Moolenaar | ce0842a | 2005-07-18 21:58:11 +0000 | [diff] [blame] | 5792 | As a special case the name of a .spl file can be given as-is. The |
| 5793 | first "_xx" in the name is removed and used as the region name |
| 5794 | (_xx is an underscore, two letters and followed by a non-letter). |
| 5795 | This is mainly for testing purposes. You must make sure the correct |
| 5796 | encoding is used, Vim doesn't check it. |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 5797 | When 'encoding' is set the word lists are reloaded. Thus it's a good |
Bram Moolenaar | ce0842a | 2005-07-18 21:58:11 +0000 | [diff] [blame] | 5798 | idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 5799 | files twice. |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 5800 | How the related spell files are found is explained here: |spell-load|. |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 5801 | |
Bram Moolenaar | 90cfdbe | 2005-08-12 19:59:19 +0000 | [diff] [blame] | 5802 | After this option has been set successfully, Vim will source the files |
| 5803 | "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' |
| 5804 | up to the first comma, dot or underscore. See |set-spc-auto|. |
| 5805 | |
| 5806 | |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 5807 | *'spellsuggest'* *'sps'* |
| 5808 | 'spellsuggest' 'sps' string (default "best") |
| 5809 | global |
| 5810 | {not in Vi} |
| 5811 | {not available when compiled without the |+syntax| |
| 5812 | feature} |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 5813 | Methods used for spelling suggestions. Both for the |z?| command and |
| 5814 | the |spellsuggest()| function. This is a comma-separated list of |
| 5815 | items: |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 5816 | |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 5817 | best Internal method that works best for English. Finds |
| 5818 | changes like "fast" and uses a bit of sound-a-like |
| 5819 | scoring to improve the ordering. |
| 5820 | |
| 5821 | double Internal method that uses two methods and mixes the |
| 5822 | results. The first method is "fast", the other method |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 5823 | computes how much the suggestion sounds like the bad |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 5824 | word. That only works when the language specifies |
| 5825 | sound folding. Can be slow and doesn't always give |
| 5826 | better results. |
| 5827 | |
| 5828 | fast Internal method that only checks for simple changes: |
| 5829 | character inserts/deletes/swaps. Works well for |
| 5830 | simple typing mistakes. |
| 5831 | |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 5832 | {number} The maximum number of suggestions listed for |z?|. |
| 5833 | Not used for |spellsuggest()|. The number of |
| 5834 | suggestions is never more than the value of 'lines' |
| 5835 | minus two. |
| 5836 | |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 5837 | file:{filename} Read file {filename}, which must have two columns, |
| 5838 | separated by a slash. The first column contains the |
| 5839 | bad word, the second column the suggested good word. |
| 5840 | Example: |
| 5841 | theribal/terrible ~ |
| 5842 | Use this for common mistakes that do not appear at the |
| 5843 | top of the suggestion list with the internal methods. |
| 5844 | Lines without a slash are ignored, use this for |
| 5845 | comments. |
| 5846 | The file is used for all languages. |
| 5847 | |
| 5848 | expr:{expr} Evaluate expression {expr}. Use a function to avoid |
| 5849 | trouble with spaces. |v:val| holds the badly spelled |
| 5850 | word. The expression must evaluate to a List of |
| 5851 | Lists, each with a suggestion and a score. |
| 5852 | Example: |
| 5853 | [['the', 33], ['that', 44]] |
| 5854 | Set 'verbose' and use |z?| to see the scores that the |
| 5855 | internal methods use. A lower score is better. |
| 5856 | This may invoke |spellsuggest()| if you temporarily |
| 5857 | set 'spellsuggest' to exclude the "expr:" part. |
| 5858 | Errors are silently ignored, unless you set the |
| 5859 | 'verbose' option to a non-zero value. |
| 5860 | |
| 5861 | Only one of "best", "double" or "fast" may be used. The others may |
| 5862 | appear several times in any order. Example: > |
| 5863 | :set sps=file:~/.vim/sugg,best,expr:MySuggest() |
| 5864 | < |
| 5865 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5866 | security reasons. |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 5867 | |
| 5868 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5869 | *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 5870 | 'splitbelow' 'sb' boolean (default off) |
| 5871 | global |
| 5872 | {not in Vi} |
| 5873 | {not available when compiled without the +windows |
| 5874 | feature} |
| 5875 | When on, splitting a window will put the new window below the current |
| 5876 | one. |:split| |
| 5877 | |
| 5878 | *'splitright'* *'spr'* *'nosplitright'* *'nospr'* |
| 5879 | 'splitright' 'spr' boolean (default off) |
| 5880 | global |
| 5881 | {not in Vi} |
| 5882 | {not available when compiled without the +vertsplit |
| 5883 | feature} |
| 5884 | When on, splitting a window will put the new window right of the |
| 5885 | current one. |:vsplit| |
| 5886 | |
| 5887 | *'startofline'* *'sol'* *'nostartofline'* *'nosol'* |
| 5888 | 'startofline' 'sol' boolean (default on) |
| 5889 | global |
| 5890 | {not in Vi} |
| 5891 | When "on" the commands listed below move the cursor to the first |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 5892 | non-blank of the line. When off the cursor is kept in the same column |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5893 | (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 5894 | CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5895 | with a linewise operator, with "%" with a count and to buffer changing |
| 5896 | commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that |
| 5897 | only has a line number, e.g., ":25" or ":+". |
| 5898 | In case of buffer changing commands the cursor is placed at the column |
| 5899 | where it was the last time the buffer was edited. |
| 5900 | NOTE: This option is set when 'compatible' is set. |
| 5901 | |
| 5902 | *'statusline'* *'stl'* *E540* *E541* *E542* |
| 5903 | 'statusline' 'stl' string (default empty) |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 5904 | global or local to window |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5905 | {not in Vi} |
| 5906 | {not available when compiled without the |+statusline| |
| 5907 | feature} |
| 5908 | When nonempty, this option determines the content of the status line. |
| 5909 | Also see |status-line|. |
| 5910 | |
| 5911 | The option consists of printf style '%' items interspersed with |
| 5912 | normal text. Each status line item is of the form: |
| 5913 | %-0{minwid}.{maxwid}{item} |
| 5914 | All fields except the {item} is optional. A single percent sign can |
| 5915 | be given as "%%". Up to 80 items can be specified. |
| 5916 | |
| 5917 | Note that the only effect of 'ruler' when this option is set (and |
| 5918 | 'laststatus' is 2) is controlling the output of |CTRL-G|. |
| 5919 | |
| 5920 | field meaning ~ |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5921 | - Left justify the item. The default is right justified |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5922 | when minwid is larger than the length of the item. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5923 | 0 Leading zeroes in numeric items. Overridden by '-'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5924 | minwid Minimum width of the item, padding as set by '-' & '0'. |
| 5925 | Value must be 50 or less. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5926 | maxwid Maximum width of the item. Truncation occurs with a '<' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5927 | on the left for text items. Numeric items will be |
| 5928 | shifted down to maxwid-2 digits followed by '>'number |
| 5929 | where number is the amount of missing digits, much like |
| 5930 | an exponential notation. |
| 5931 | item A one letter code as described below. |
| 5932 | |
| 5933 | Following is a description of the possible statusline items. The |
| 5934 | second character in "item" is the type: |
| 5935 | N for number |
| 5936 | S for string |
| 5937 | F for flags as described below |
| 5938 | - not applicable |
| 5939 | |
| 5940 | item meaning ~ |
| 5941 | f S Path to the file in the buffer, relative to current directory. |
| 5942 | F S Full path to the file in the buffer. |
| 5943 | t S File name (tail) of file in the buffer. |
| 5944 | m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off. |
| 5945 | M F Modified flag, text is ",+" or ",-". |
| 5946 | r F Readonly flag, text is " [RO]". |
| 5947 | R F Readonly flag, text is ",RO". |
| 5948 | h F Help buffer flag, text is " [help]". |
| 5949 | H F Help buffer flag, text is ",HLP". |
| 5950 | w F Preview window flag, text is " [Preview]". |
| 5951 | W F Preview window flag, text is ",PRV". |
| 5952 | y F Type of file in the buffer, e.g., " [vim]". See 'filetype'. |
| 5953 | Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
| 5954 | {not available when compiled without |+autocmd| feature} |
| 5955 | k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 5956 | being used: "<keymap>" |
| 5957 | n N Buffer number. |
| 5958 | b N Value of byte under cursor. |
| 5959 | B N As above, in hexadecimal. |
| 5960 | o N Byte number in file of byte under cursor, first byte is 1. |
| 5961 | Mnemonic: Offset from start of file (with one added) |
| 5962 | {not available when compiled without |+byte_offset| feature} |
| 5963 | O N As above, in hexadecimal. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5964 | N N Printer page number. (Only works in the 'printheader' option.) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5965 | l N Line number. |
| 5966 | L N Number of lines in buffer. |
| 5967 | c N Column number. |
| 5968 | v N Virtual column number. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5969 | V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5970 | p N Percentage through file in lines as in |CTRL-G|. |
| 5971 | P S Percentage through file of displayed window. This is like the |
| 5972 | percentage described for 'ruler'. Always 3 in length. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5973 | a S Argument list status as in default title. ({current} of {max}) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5974 | Empty if the argument file count is zero or one. |
| 5975 | { NF Evaluate expression between '{' and '}' and substitute result. |
| 5976 | ( - Start of item group. Can be used for setting the width and |
| 5977 | alignment of a section. Must be followed by %) somewhere. |
| 5978 | ) - End of item group. No width fields allowed. |
| 5979 | < - Where to truncate line if too long. Default is at the start. |
| 5980 | No width fields allowed. |
| 5981 | = - Separation point between left and right aligned items. |
| 5982 | No width fields allowed. |
| 5983 | * - Set highlight group to User{N}, where {N} is taken from the |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5984 | minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5985 | The difference between User{N} and StatusLine will be applied |
| 5986 | to StatusLineNC for the statusline of non-current windows. |
| 5987 | The number N must be between 1 and 9. See |hl-User1..9| |
| 5988 | |
| 5989 | Display of flags are controlled by the following heuristic: |
| 5990 | If a flag text starts with comma it is assumed that it wants to |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5991 | separate itself from anything but preceding plaintext. If it starts |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5992 | with a space it is assumed that it wants to separate itself from |
| 5993 | anything but other flags. That is: A leading comma is removed if the |
| 5994 | preceding character stems from plaintext. A leading space is removed |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5995 | if the preceding character stems from another active flag. This will |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5996 | make a nice display when flags are used like in the examples below. |
| 5997 | |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5998 | When all items in a group becomes an empty string (i.e. flags that are |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5999 | not set) and a minwid is not set for the group, the whole group will |
| 6000 | become empty. This will make a group like the following disappear |
| 6001 | completely from the statusline when none of the flags are set. > |
| 6002 | :set statusline=...%(\ [%M%R%H]%)... |
| 6003 | < |
| 6004 | Beware that an expression is evaluated each and every time the status |
| 6005 | line is displayed. The current buffer and current window will be set |
| 6006 | temporarily to that of the window (and buffer) whose statusline is |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 6007 | currently being drawn. The expression will evaluate in this context. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6008 | The variable "actual_curbuf" is set to the 'bufnr()' number of the |
| 6009 | real current buffer. The expression is evaluated in the |sandbox|. |
| 6010 | |
| 6011 | If the statusline is not updated when you want it (e.g., after setting |
| 6012 | a variable that's used in an expression), you can force an update by |
| 6013 | setting an option without changing its value. Example: > |
| 6014 | :let &ro = &ro |
| 6015 | |
| 6016 | < A result of all digits is regarded a number for display purposes. |
| 6017 | Otherwise the result is taken as flag text and applied to the rules |
| 6018 | described above. |
| 6019 | |
Bram Moolenaar | cd71fa3 | 2005-03-11 22:46:48 +0000 | [diff] [blame] | 6020 | Watch out for errors in expressions. They may render Vim unusable! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6021 | If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and |
| 6022 | edit your .vimrc or whatever with "vim -u NONE" to get it right. |
| 6023 | |
| 6024 | Examples: |
| 6025 | Emulate standard status line with 'ruler' set > |
| 6026 | :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P |
| 6027 | < Similar, but add ASCII value of char under the cursor (like "ga") > |
| 6028 | :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P |
| 6029 | < Display byte count and byte value, modified flag in red. > |
| 6030 | :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' |
| 6031 | :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red |
| 6032 | < Display a ,GZ flag if a compressed file is loaded > |
| 6033 | :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... |
| 6034 | < In the |:autocmd|'s: > |
| 6035 | :let b:gzflag = 1 |
| 6036 | < And: > |
| 6037 | :unlet b:gzflag |
| 6038 | < And define this function: > |
| 6039 | :function VarExists(var, val) |
| 6040 | : if exists(a:var) | return a:val | else | return '' | endif |
| 6041 | :endfunction |
| 6042 | < |
| 6043 | *'suffixes'* *'su'* |
| 6044 | 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") |
| 6045 | global |
| 6046 | {not in Vi} |
| 6047 | Files with these suffixes get a lower priority when multiple files |
| 6048 | match a wildcard. See |suffixes|. Commas can be used to separate the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6049 | suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 6050 | the start of a suffix. To avoid a dot or comma being recognized as a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6051 | separator, precede it with a backslash (see |option-backslash| about |
| 6052 | including spaces and backslashes). |
| 6053 | See 'wildignore' for completely ignoring files. |
| 6054 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 6055 | suffixes from the list. This avoids problems when a future version |
| 6056 | uses another default. |
| 6057 | |
| 6058 | *'suffixesadd'* *'sua'* |
| 6059 | 'suffixesadd' 'sua' string (default "") |
| 6060 | local to buffer |
| 6061 | {not in Vi} |
| 6062 | {not available when compiled without the |
| 6063 | |+file_in_path| feature} |
| 6064 | Comma separated list of suffixes, which are used when searching for a |
| 6065 | file for the "gf", "[I", etc. commands. Example: > |
| 6066 | :set suffixesadd=.java |
| 6067 | < |
| 6068 | *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* |
| 6069 | 'swapfile' 'swf' boolean (default on) |
| 6070 | local to buffer |
| 6071 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6072 | Use a swapfile for the buffer. This option can be reset when a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6073 | swapfile is not wanted for a specific buffer. For example, with |
| 6074 | confidential information that even root must not be able to access. |
| 6075 | Careful: All text will be in memory: |
| 6076 | - Don't use this for big files. |
| 6077 | - Recovery will be impossible! |
| 6078 | A swapfile will only be present when |'updatecount'| is non-zero and |
| 6079 | 'swapfile' is set. |
| 6080 | When 'swapfile' is reset, the swap file for the current buffer is |
| 6081 | immediately deleted. When 'swapfile' is set, and 'updatecount' is |
| 6082 | non-zero, a swap file is immediately created. |
| 6083 | Also see |swap-file| and |'swapsync'|. |
| 6084 | |
| 6085 | This option is used together with 'bufhidden' and 'buftype' to |
| 6086 | specify special kinds of buffers. See |special-buffers|. |
| 6087 | |
| 6088 | *'swapsync'* *'sws'* |
| 6089 | 'swapsync' 'sws' string (default "fsync") |
| 6090 | global |
| 6091 | {not in Vi} |
| 6092 | When this option is not empty a swap file is synced to disk after |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6093 | writing to it. This takes some time, especially on busy unix systems. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6094 | When this option is empty parts of the swap file may be in memory and |
| 6095 | not written to disk. When the system crashes you may lose more work. |
| 6096 | On Unix the system does a sync now and then without Vim asking for it, |
| 6097 | so the disadvantage of setting this option off is small. On some |
| 6098 | systems the swap file will not be written at all. For a unix system |
| 6099 | setting it to "sync" will use the sync() call instead of the default |
| 6100 | fsync(), which may work better on some systems. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 6101 | The 'fsync' option is used for the actual file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6102 | |
| 6103 | *'switchbuf'* *'swb'* |
| 6104 | 'switchbuf' 'swb' string (default "") |
| 6105 | global |
| 6106 | {not in Vi} |
| 6107 | This option controls the behavior when switching between buffers. |
| 6108 | Possible values (comma separated list): |
| 6109 | useopen If included, jump to the first open window that |
| 6110 | contains the specified buffer (if there is one). |
| 6111 | Otherwise: Do not examine other windows. |
| 6112 | This setting is checked with |quickfix| commands, when |
| 6113 | jumping to errors (":cc", ":cn", "cp", etc.). It is |
| 6114 | also used in all buffer related split commands, for |
| 6115 | example ":sbuffer", ":sbnext", or ":sbrewind". |
| 6116 | split If included, split the current window before loading |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 6117 | a buffer. Otherwise: do not split, use current window. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6118 | Supported in |quickfix| commands that display errors. |
| 6119 | |
Bram Moolenaar | 3b56eb3 | 2005-07-11 22:40:32 +0000 | [diff] [blame] | 6120 | *'synmaxcol'* *'smc'* |
| 6121 | 'synmaxcol' 'smc' number (default 3000) |
| 6122 | local to buffer |
| 6123 | {not in Vi} |
| 6124 | {not available when compiled without the |+syntax| |
| 6125 | feature} |
Bram Moolenaar | ce0842a | 2005-07-18 21:58:11 +0000 | [diff] [blame] | 6126 | Maximum column in which to search for syntax items. In long lines the |
| 6127 | text after this column is not highlighted and following lines may not |
| 6128 | be highlighted correctly, because the syntax state is cleared. |
Bram Moolenaar | 3b56eb3 | 2005-07-11 22:40:32 +0000 | [diff] [blame] | 6129 | This helps to avoid very slow redrawing for an XML file that is one |
| 6130 | long line. |
| 6131 | Set to zero to remove the limit. |
| 6132 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6133 | *'syntax'* *'syn'* |
| 6134 | 'syntax' 'syn' string (default empty) |
| 6135 | local to buffer |
| 6136 | {not in Vi} |
| 6137 | {not available when compiled without the |+syntax| |
| 6138 | feature} |
| 6139 | When this option is set, the syntax with this name is loaded, unless |
| 6140 | syntax highlighting has been switched off with ":syntax off". |
| 6141 | Otherwise this option does not always reflect the current syntax (the |
| 6142 | b:current_syntax variable does). |
| 6143 | This option is most useful in a modeline, for a file which syntax is |
Bram Moolenaar | 3b56eb3 | 2005-07-11 22:40:32 +0000 | [diff] [blame] | 6144 | not automatically recognized. Example, in an IDL file: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6145 | /* vim: set syntax=idl : */ |
| 6146 | < To switch off syntax highlighting for the current file, use: > |
| 6147 | :set syntax=OFF |
| 6148 | < To switch syntax highlighting on according to the current value of the |
| 6149 | 'filetype' option: > |
| 6150 | :set syntax=ON |
| 6151 | < What actually happens when setting the 'syntax' option is that the |
| 6152 | Syntax autocommand event is triggered with the value as argument. |
| 6153 | This option is not copied to another buffer, independent of the 's' or |
| 6154 | 'S' flag in 'cpoptions'. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 6155 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6156 | |
| 6157 | *'tabstop'* *'ts'* |
| 6158 | 'tabstop' 'ts' number (default 8) |
| 6159 | local to buffer |
| 6160 | Number of spaces that a <Tab> in the file counts for. Also see |
| 6161 | |:retab| command, and 'softtabstop' option. |
| 6162 | |
| 6163 | Note: Setting 'tabstop' to any other value than 8 can make your file |
| 6164 | appear wrong in many places (e.g., when printing it). |
| 6165 | |
| 6166 | There are four main ways to use tabs in Vim: |
| 6167 | 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 |
| 6168 | (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim |
| 6169 | will use a mix of tabs and spaces, but typing Tab and BS will |
| 6170 | behave like a tab appears every 4 (or 3) characters. |
| 6171 | 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use |
| 6172 | 'expandtab'. This way you will always insert spaces. The |
| 6173 | formatting will never be messed up when 'tabstop' is changed. |
| 6174 | 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6175 | |modeline| to set these values when editing the file again. Only |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6176 | works when using Vim to edit the file. |
| 6177 | 4. Always set 'tabstop' and 'shiftwidth' to the same value, and |
| 6178 | 'noexpandtab'. This should then work (for initial indents only) |
| 6179 | for any tabstop setting that people use. It might be nice to have |
| 6180 | tabs after the first non-blank inserted as spaces if you do this |
| 6181 | though. Otherwise aligned comments will be wrong when 'tabstop' is |
| 6182 | changed. |
| 6183 | |
| 6184 | *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
| 6185 | 'tagbsearch' 'tbs' boolean (default on) |
| 6186 | global |
| 6187 | {not in Vi} |
| 6188 | When searching for a tag (e.g., for the |:ta| command), Vim can either |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6189 | use a binary search or a linear search in a tags file. Binary |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6190 | searching makes searching for a tag a LOT faster, but a linear search |
| 6191 | will find more tags if the tags file wasn't properly sorted. |
| 6192 | Vim normally assumes that your tags files are sorted, or indicate that |
| 6193 | they are not sorted. Only when this is not the case does the |
| 6194 | 'tagbsearch' option need to be switched off. |
| 6195 | |
| 6196 | When 'tagbsearch' is on, binary searching is first used in the tags |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6197 | files. In certain situations, Vim will do a linear search instead for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6198 | certain files, or retry all files with a linear search. When |
| 6199 | 'tagbsearch' is off, only a linear search is done. |
| 6200 | |
| 6201 | Linear searching is done anyway, for one file, when Vim finds a line |
| 6202 | at the start of the file indicating that it's not sorted: > |
| 6203 | !_TAG_FILE_SORTED 0 /some command/ |
| 6204 | < [The whitespace before and after the '0' must be a single <Tab>] |
| 6205 | |
| 6206 | When a binary search was done and no match was found in any of the |
| 6207 | files listed in 'tags', and 'ignorecase' is set or a pattern is used |
| 6208 | instead of a normal tag name, a retry is done with a linear search. |
| 6209 | Tags in unsorted tags files, and matches with different case will only |
| 6210 | be found in the retry. |
| 6211 | |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 6212 | If a tag file indicates that it is case-fold sorted, the second, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6213 | linear search can be avoided for the 'ignorecase' case. Use a value |
| 6214 | of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be |
| 6215 | case-fold sorted with the -f switch to "sort" in most unices, as in |
| 6216 | the command: "sort -f -o tags tags". For "Exuberant ctags" version |
| 6217 | 5.3 or higher the -f or --fold-case-sort switch can be used for this |
| 6218 | as well. Note that case must be folded to uppercase for this to work. |
| 6219 | |
| 6220 | When 'tagbsearch' is off, tags searching is slower when a full match |
| 6221 | exists, but faster when no full match exists. Tags in unsorted tags |
| 6222 | files may only be found with 'tagbsearch' off. |
| 6223 | When the tags file is not sorted, or sorted in a wrong way (not on |
| 6224 | ASCII byte value), 'tagbsearch' should be off, or the line given above |
| 6225 | must be included in the tags file. |
| 6226 | This option doesn't affect commands that find all matching tags (e.g., |
| 6227 | command-line completion and ":help"). |
| 6228 | {Vi: always uses binary search in some versions} |
| 6229 | |
| 6230 | *'taglength'* *'tl'* |
| 6231 | 'taglength' 'tl' number (default 0) |
| 6232 | global |
| 6233 | If non-zero, tags are significant up to this number of characters. |
| 6234 | |
| 6235 | *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* |
| 6236 | 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) |
| 6237 | global |
| 6238 | {not in Vi} |
| 6239 | If on and using a tag file in another directory, file names in that |
| 6240 | tag file are relative to the directory where the tag file is. |
| 6241 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 6242 | set and to the Vim default value when 'compatible' is reset. |
| 6243 | |
| 6244 | *'tags'* *'tag'* *E433* |
| 6245 | 'tags' 'tag' string (default "./tags,tags", when compiled with |
| 6246 | |+emacs_tags|: "./tags,./TAGS,tags,TAGS") |
| 6247 | global or local to buffer |global-local| |
| 6248 | Filenames for the tag command, separated by spaces or commas. To |
| 6249 | include a space or comma in a file name, precede it with a backslash |
| 6250 | (see |option-backslash| about including spaces and backslashes). |
| 6251 | When a file name starts with "./", the '.' is replaced with the path |
| 6252 | of the current file. But only when the 'd' flag is not included in |
| 6253 | 'cpoptions'. Environment variables are expanded |:set_env|. Also see |
| 6254 | |tags-option|. |
| 6255 | "*", "**" and other wildcards can be used to search for tags files in |
| 6256 | a directory tree. See |file-searching|. {not available when compiled |
| 6257 | without the |+path_extra| feature} |
| 6258 | If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 6259 | files are also supported. They are automatically recognized. The |
| 6260 | default value becomes "./tags,./TAGS,tags,TAGS", unless case |
| 6261 | differences are ignored (MS-Windows). |emacs-tags| |
| 6262 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 6263 | file names from the list. This avoids problems when a future version |
| 6264 | uses another default. |
| 6265 | {Vi: default is "tags /usr/lib/tags"} |
| 6266 | |
| 6267 | *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* |
| 6268 | 'tagstack' 'tgst' boolean (default on) |
| 6269 | global |
| 6270 | {not in all versions of Vi} |
| 6271 | When on, the |tagstack| is used normally. When off, a ":tag" or |
| 6272 | ":tselect" command with an argument will not push the tag onto the |
| 6273 | tagstack. A following ":tag" without an argument, a ":pop" command or |
| 6274 | any other command that uses the tagstack will use the unmodified |
| 6275 | tagstack, but does change the pointer to the active entry. |
| 6276 | Resetting this option is useful when using a ":tag" command in a |
| 6277 | mapping which should not change the tagstack. |
| 6278 | |
| 6279 | *'term'* *E529* *E530* *E531* |
| 6280 | 'term' string (default is $TERM, if that fails: |
| 6281 | in the GUI: "builtin_gui" |
| 6282 | on Amiga: "amiga" |
| 6283 | on BeOS: "beos-ansi" |
| 6284 | on Mac: "mac-ansi" |
| 6285 | on MiNT: "vt52" |
| 6286 | on MS-DOS: "pcterm" |
| 6287 | on OS/2: "os2ansi" |
| 6288 | on Unix: "ansi" |
| 6289 | on VMS: "ansi" |
| 6290 | on Win 32: "win32") |
| 6291 | global |
| 6292 | Name of the terminal. Used for choosing the terminal control |
| 6293 | characters. Environment variables are expanded |:set_env|. |
| 6294 | For example: > |
| 6295 | :set term=$TERM |
| 6296 | < See |termcap|. |
| 6297 | |
| 6298 | *'termbidi'* *'tbidi'* |
| 6299 | *'notermbidi'* *'notbidi'* |
| 6300 | 'termbidi' 'tbidi' boolean (default off, on for "mlterm") |
| 6301 | global |
| 6302 | {not in Vi} |
| 6303 | {only available when compiled with the |+arabic| |
| 6304 | feature} |
| 6305 | The terminal is in charge of Bi-directionality of text (as specified |
| 6306 | by Unicode). The terminal is also expected to do the required shaping |
| 6307 | that some languages (such as Arabic) require. |
| 6308 | Setting this option implies that 'rightleft' will not be set when |
| 6309 | 'arabic' is set and the value of 'arabicshape' will be ignored. |
| 6310 | Note that setting 'termbidi' has the immediate effect that |
| 6311 | 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. |
| 6312 | This option is reset when the GUI is started. |
| 6313 | For further details see |arabic.txt|. |
| 6314 | |
| 6315 | *'termencoding'* *'tenc'* |
| 6316 | 'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with |
| 6317 | Macintosh GUI: "macroman") |
| 6318 | global |
| 6319 | {only available when compiled with the |+multi_byte| |
| 6320 | feature} |
| 6321 | {not in Vi} |
| 6322 | Encoding used for the terminal. This specifies what character |
| 6323 | encoding the keyboard produces and the display will understand. For |
| 6324 | the GUI it only applies to the keyboard ('encoding' is used for the |
| 6325 | display). |
| 6326 | In the Win32 console version the default value is the console codepage |
| 6327 | when it differs from the ANSI codepage. |
| 6328 | *E617* |
| 6329 | Note: This does not apply to the GTK+ 2 GUI. After the GUI has been |
| 6330 | successfully initialized, 'termencoding' is forcibly set to "utf-8". |
| 6331 | Any attempts to set a different value will be rejected, and an error |
| 6332 | message is shown. |
| 6333 | For the Win32 GUI 'termencoding' is not used for typed characters, |
| 6334 | because the Win32 system always passes Unicode characters. |
| 6335 | When empty, the same encoding is used as for the 'encoding' option. |
| 6336 | This is the normal value. |
| 6337 | Not all combinations for 'termencoding' and 'encoding' are valid. See |
| 6338 | |encoding-table|. |
| 6339 | The value for this option must be supported by internal conversions or |
| 6340 | iconv(). When this is not possible no conversion will be done and you |
| 6341 | will probably experience problems with non-ASCII characters. |
| 6342 | Example: You are working with the locale set to euc-jp (Japanese) and |
| 6343 | want to edit a UTF-8 file: > |
| 6344 | :let &termencoding = &encoding |
| 6345 | :set encoding=utf-8 |
| 6346 | < You need to do this when your system has no locale support for UTF-8. |
| 6347 | |
| 6348 | *'terse'* *'noterse'* |
| 6349 | 'terse' boolean (default off) |
| 6350 | global |
| 6351 | When set: Add 's' flag to 'shortmess' option (this makes the message |
| 6352 | for a search that hits the start or end of the file not being |
| 6353 | displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi |
| 6354 | shortens a lot of messages} |
| 6355 | |
| 6356 | *'textauto'* *'ta'* *'notextauto'* *'nota'* |
| 6357 | 'textauto' 'ta' boolean (Vim default: on, Vi default: off) |
| 6358 | global |
| 6359 | {not in Vi} |
| 6360 | This option is obsolete. Use 'fileformats'. |
| 6361 | For backwards compatibility, when 'textauto' is set, 'fileformats' is |
| 6362 | set to the default value for the current system. When 'textauto' is |
| 6363 | reset, 'fileformats' is made empty. |
| 6364 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 6365 | set and to the Vim default value when 'compatible' is reset. |
| 6366 | |
| 6367 | *'textmode'* *'tx'* *'notextmode'* *'notx'* |
| 6368 | 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, |
| 6369 | others: default off) |
| 6370 | local to buffer |
| 6371 | {not in Vi} |
| 6372 | This option is obsolete. Use 'fileformat'. |
| 6373 | For backwards compatibility, when 'textmode' is set, 'fileformat' is |
| 6374 | set to "dos". When 'textmode' is reset, 'fileformat' is set to |
| 6375 | "unix". |
| 6376 | |
| 6377 | *'textwidth'* *'tw'* |
| 6378 | 'textwidth' 'tw' number (default 0) |
| 6379 | local to buffer |
| 6380 | {not in Vi} |
| 6381 | Maximum width of text that is being inserted. A longer line will be |
| 6382 | broken after white space to get this width. A zero value disables |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6383 | this. 'textwidth' is set to 0 when the 'paste' option is set. When |
| 6384 | 'textwidth' is zero, 'wrapmargin' may be used. See also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6385 | 'formatoptions' and |ins-textwidth|. |
| 6386 | NOTE: This option is set to 0 when 'compatible' is set. |
| 6387 | |
| 6388 | *'thesaurus'* *'tsr'* |
| 6389 | 'thesaurus' 'tsr' string (default "") |
| 6390 | global or local to buffer |global-local| |
| 6391 | {not in Vi} |
| 6392 | List of file names, separated by commas, that are used to lookup words |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6393 | for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6394 | the file should contain words with similar meaning, separated by |
| 6395 | non-keyword characters (white space is preferred). Maximum line |
| 6396 | length is 510 bytes. |
| 6397 | To obtain a file to be used here, check out the wordlist FAQ at |
| 6398 | http://www.hyphenologist.co.uk . |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6399 | To include a comma in a file name precede it with a backslash. Spaces |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6400 | after a comma are ignored, otherwise spaces are included in the file |
| 6401 | name. See |option-backslash| about using backslashes. |
| 6402 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 6403 | directories from the list. This avoids problems when a future version |
| 6404 | uses another default. |
| 6405 | Backticks cannot be used in this option for security reasons. |
| 6406 | |
| 6407 | *'tildeop'* *'top'* *'notildeop'* *'notop'* |
| 6408 | 'tildeop' 'top' boolean (default off) |
| 6409 | global |
| 6410 | {not in Vi} |
| 6411 | When on: The tilde command "~" behaves like an operator. |
| 6412 | NOTE: This option is reset when 'compatible' is set. |
| 6413 | |
| 6414 | *'timeout'* *'to'* *'notimeout'* *'noto'* |
| 6415 | 'timeout' 'to' boolean (default on) |
| 6416 | global |
| 6417 | *'ttimeout'* *'nottimeout'* |
| 6418 | 'ttimeout' boolean (default off) |
| 6419 | global |
| 6420 | {not in Vi} |
| 6421 | These two options together determine the behavior when part of a |
| 6422 | mapped key sequence or keyboard code has been received: |
| 6423 | |
| 6424 | 'timeout' 'ttimeout' action ~ |
| 6425 | off off do not time out |
| 6426 | on on or off time out on :mappings and key codes |
| 6427 | off on time out on key codes |
| 6428 | |
| 6429 | If both options are off, Vim will wait until either the complete |
| 6430 | mapping or key sequence has been received, or it is clear that there |
| 6431 | is no mapping or key sequence for the received characters. For |
| 6432 | example: if you have mapped "vl" and Vim has received 'v', the next |
| 6433 | character is needed to see if the 'v' is followed by an 'l'. |
| 6434 | When one of the options is on, Vim will wait for about 1 second for |
| 6435 | the next character to arrive. After that the already received |
| 6436 | characters are interpreted as single characters. The waiting time can |
| 6437 | be changed with the 'timeoutlen' option. |
| 6438 | On slow terminals or very busy systems timing out may cause |
| 6439 | malfunctioning cursor keys. If both options are off, Vim waits |
| 6440 | forever after an entered <Esc> if there are key codes that start |
| 6441 | with <Esc>. You will have to type <Esc> twice. If you do not have |
| 6442 | problems with key codes, but would like to have :mapped key |
| 6443 | sequences not timing out in 1 second, set the 'ttimeout' option and |
| 6444 | reset the 'timeout' option. |
| 6445 | |
| 6446 | NOTE: 'ttimeout' is reset when 'compatible' is set. |
| 6447 | |
| 6448 | *'timeoutlen'* *'tm'* |
| 6449 | 'timeoutlen' 'tm' number (default 1000) |
| 6450 | global |
| 6451 | {not in all versions of Vi} |
| 6452 | *'ttimeoutlen'* *'ttm'* |
| 6453 | 'ttimeoutlen' 'ttm' number (default -1) |
| 6454 | global |
| 6455 | {not in Vi} |
| 6456 | The time in milliseconds that is waited for a key code or mapped key |
| 6457 | sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G |
| 6458 | when part of a command has been typed. |
| 6459 | Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a |
| 6460 | different timeout value for key codes is desired set 'ttimeoutlen' to |
| 6461 | a non-negative number. |
| 6462 | |
| 6463 | ttimeoutlen mapping delay key code delay ~ |
| 6464 | < 0 'timeoutlen' 'timeoutlen' |
| 6465 | >= 0 'timeoutlen' 'ttimeoutlen' |
| 6466 | |
| 6467 | The timeout only happens when the 'timeout' and 'ttimeout' options |
| 6468 | tell so. A useful setting would be > |
| 6469 | :set timeout timeoutlen=3000 ttimeoutlen=100 |
| 6470 | < (time out on mapping after three seconds, time out on key codes after |
| 6471 | a tenth of a second). |
| 6472 | |
| 6473 | *'title'* *'notitle'* |
| 6474 | 'title' boolean (default off, on when title can be restored) |
| 6475 | global |
| 6476 | {not in Vi} |
| 6477 | {not available when compiled without the |+title| |
| 6478 | feature} |
| 6479 | When on, the title of the window will be set to the value of |
| 6480 | 'titlestring' (if it is not empty), or to: |
| 6481 | filename [+=-] (path) - VIM |
| 6482 | Where: |
| 6483 | filename the name of the file being edited |
| 6484 | - indicates the file cannot be modified, 'ma' off |
| 6485 | + indicates the file was modified |
| 6486 | = indicates the file is read-only |
| 6487 | =+ indicates the file is read-only and modified |
| 6488 | (path) is the path of the file being edited |
| 6489 | - VIM the server name |v:servername| or "VIM" |
| 6490 | Only works if the terminal supports setting window titles |
| 6491 | (currently Amiga console, Win32 console, all GUI versions and |
| 6492 | terminals with a non- empty 't_ts' option - these are Unix xterm and |
| 6493 | iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
| 6494 | *X11* |
| 6495 | When Vim was compiled with HAVE_X11 defined, the original title will |
| 6496 | be restored if possible. The output of ":version" will include "+X11" |
| 6497 | when HAVE_X11 was defined, otherwise it will be "-X11". This also |
| 6498 | works for the icon name |'icon'|. |
| 6499 | But: When Vim was started with the |-X| argument, restoring the title |
| 6500 | will not work (except in the GUI). |
| 6501 | If the title cannot be restored, it is set to the value of 'titleold'. |
| 6502 | You might want to restore the title outside of Vim then. |
| 6503 | When using an xterm from a remote machine you can use this command: |
| 6504 | rsh machine_name xterm -display $DISPLAY & |
| 6505 | then the WINDOWID environment variable should be inherited and the |
| 6506 | title of the window should change back to what it should be after |
| 6507 | exiting Vim. |
| 6508 | |
| 6509 | *'titlelen'* |
| 6510 | 'titlelen' number (default 85) |
| 6511 | global |
| 6512 | {not in Vi} |
| 6513 | {not available when compiled without the |+title| |
| 6514 | feature} |
| 6515 | Gives the percentage of 'columns' to use for the length of the window |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6516 | title. When the title is longer, only the end of the path name is |
| 6517 | shown. A '<' character before the path name is used to indicate this. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6518 | Using a percentage makes this adapt to the width of the window. But |
| 6519 | it won't work perfectly, because the actual number of characters |
| 6520 | available also depends on the font used and other things in the title |
| 6521 | bar. When 'titlelen' is zero the full path is used. Otherwise, |
| 6522 | values from 1 to 30000 percent can be used. |
| 6523 | 'titlelen' is also used for the 'titlestring' option. |
| 6524 | |
| 6525 | *'titleold'* |
| 6526 | 'titleold' string (default "Thanks for flying Vim") |
| 6527 | global |
| 6528 | {not in Vi} |
| 6529 | {only available when compiled with the |+title| |
| 6530 | feature} |
| 6531 | This option will be used for the window title when exiting Vim if the |
| 6532 | original title cannot be restored. Only happens if 'title' is on or |
| 6533 | 'titlestring' is not empty. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 6534 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6535 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6536 | *'titlestring'* |
| 6537 | 'titlestring' string (default "") |
| 6538 | global |
| 6539 | {not in Vi} |
| 6540 | {not available when compiled without the |+title| |
| 6541 | feature} |
| 6542 | When this option is not empty, it will be used for the title of the |
| 6543 | window. This happens only when the 'title' option is on. |
| 6544 | Only works if the terminal supports setting window titles (currently |
| 6545 | Amiga console, Win32 console, all GUI versions and terminals with a |
| 6546 | non-empty 't_ts' option). |
| 6547 | When Vim was compiled with HAVE_X11 defined, the original title will |
| 6548 | be restored if possible |X11|. |
| 6549 | When this option contains printf-style '%' items, they will be |
| 6550 | expanded according to the rules used for 'statusline'. |
| 6551 | Example: > |
| 6552 | :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") |
| 6553 | :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
| 6554 | < The value of 'titlelen' is used to align items in the middle or right |
| 6555 | of the available space. |
| 6556 | Some people prefer to have the file name first: > |
| 6557 | :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) |
| 6558 | < Note the use of "%{ }" and an expression to get the path of the file, |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6559 | without the file name. The "%( %)" constructs are used to add a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6560 | separating space only when needed. |
| 6561 | NOTE: Use of special characters in 'titlestring' may cause the display |
| 6562 | to be garbled (e.g., when it contains a CR or NL character). |
| 6563 | {not available when compiled without the |+statusline| feature} |
| 6564 | |
| 6565 | *'toolbar'* *'tb'* |
| 6566 | 'toolbar' 'tb' string (default "icons,tooltips") |
| 6567 | global |
| 6568 | {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and |
| 6569 | |+GUI_Photon|} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6570 | The contents of this option controls various toolbar settings. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6571 | possible values are: |
| 6572 | icons Toolbar buttons are shown with icons. |
| 6573 | text Toolbar buttons shown with text. |
| 6574 | horiz Icon and text of a toolbar button are |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6575 | horizontally arranged. {only in GTK+ 2 GUI} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6576 | tooltips Tooltips are active for toolbar buttons. |
| 6577 | Tooltips refer to the popup help text which appears after the mouse |
| 6578 | cursor is placed over a toolbar button for a brief moment. |
| 6579 | |
| 6580 | If you want the toolbar to be shown with icons as well as text, do the |
| 6581 | following: > |
| 6582 | :set tb=icons,text |
| 6583 | < Motif and Athena cannot display icons and text at the same time. They |
| 6584 | will show icons if both are requested. |
| 6585 | |
| 6586 | If none of the strings specified in 'toolbar' are valid or if |
| 6587 | 'toolbar' is empty, this option is ignored. If you want to disable |
| 6588 | the toolbar, you need to set the 'guioptions' option. For example: > |
| 6589 | :set guioptions-=T |
| 6590 | < Also see |gui-toolbar|. |
| 6591 | |
| 6592 | *'toolbariconsize'* *'tbis'* |
| 6593 | 'toolbariconsize' 'tbis' string (default "small") |
| 6594 | global |
| 6595 | {not in Vi} |
| 6596 | {only in the GTK+ 2 GUI} |
| 6597 | Controls the size of toolbar icons. The possible values are: |
| 6598 | tiny Use tiny toolbar icons. |
| 6599 | small Use small toolbar icons (default). |
| 6600 | medium Use medium-sized toolbar icons. |
| 6601 | large Use large toolbar icons. |
| 6602 | The exact dimensions in pixels of the various icon sizes depend on |
| 6603 | the current theme. Common dimensions are large=32x32, medium=24x24, |
| 6604 | small=20x20 and tiny=16x16. |
| 6605 | |
| 6606 | If 'toolbariconsize' is empty, the global default size as determined |
| 6607 | by user preferences or the current theme is used. |
| 6608 | |
| 6609 | *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* |
| 6610 | 'ttybuiltin' 'tbi' boolean (default on) |
| 6611 | global |
| 6612 | {not in Vi} |
| 6613 | When on, the builtin termcaps are searched before the external ones. |
| 6614 | When off the builtin termcaps are searched after the external ones. |
| 6615 | When this option is changed, you should set the 'term' option next for |
| 6616 | the change to take effect, for example: > |
| 6617 | :set notbi term=$TERM |
| 6618 | < See also |termcap|. |
| 6619 | Rationale: The default for this option is "on", because the builtin |
| 6620 | termcap entries are generally better (many systems contain faulty |
| 6621 | xterm entries...). |
| 6622 | |
| 6623 | *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* |
| 6624 | 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, |
| 6625 | sun-cmd, screen, rxvt, dtterm or |
| 6626 | iris-ansi; also on when running Vim in |
| 6627 | a DOS console) |
| 6628 | global |
| 6629 | {not in Vi} |
| 6630 | Indicates a fast terminal connection. More characters will be sent to |
| 6631 | the screen for redrawing, instead of using insert/delete line |
| 6632 | commands. Improves smoothness of redrawing when there are multiple |
| 6633 | windows and the terminal does not support a scrolling region. |
| 6634 | Also enables the extra writing of characters at the end of each screen |
| 6635 | line for lines that wrap. This helps when using copy/paste with the |
| 6636 | mouse in an xterm and other terminals. |
| 6637 | |
| 6638 | *'ttymouse'* *'ttym'* |
| 6639 | 'ttymouse' 'ttym' string (default depends on 'term') |
| 6640 | global |
| 6641 | {not in Vi} |
| 6642 | {only in Unix and VMS, doesn't work in the GUI; not |
| 6643 | available when compiled without |+mouse|} |
| 6644 | Name of the terminal type for which mouse codes are to be recognized. |
| 6645 | Currently these three strings are valid: |
| 6646 | *xterm-mouse* |
| 6647 | xterm xterm-like mouse handling. The mouse generates |
| 6648 | "<Esc>[Mscr", where "scr" is three bytes: |
| 6649 | "s" = button state |
| 6650 | "c" = column plus 33 |
| 6651 | "r" = row plus 33 |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 6652 | This only works up to 223 columns! See "dec" for a |
| 6653 | solution. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6654 | xterm2 Works like "xterm", but with the xterm reporting the |
| 6655 | mouse position while the mouse is dragged. This works |
| 6656 | much faster and more precise. Your xterm must at |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 6657 | least at patchlevel 88 / XFree 3.3.3 for this to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6658 | work. See below for how Vim detects this |
| 6659 | automatically. |
| 6660 | *netterm-mouse* |
| 6661 | netterm NetTerm mouse handling. The mouse generates |
| 6662 | "<Esc>}r,c<CR>", where "r,c" are two decimal numbers |
| 6663 | for the row and column. |
| 6664 | *dec-mouse* |
| 6665 | dec DEC terminal mouse handling. The mouse generates a |
| 6666 | rather complex sequence, starting with "<Esc>[". |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 6667 | This is also available for an Xterm, if it was |
| 6668 | configured with "--enable-dec-locator". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6669 | *jsbterm-mouse* |
| 6670 | jsbterm JSB term mouse handling. |
| 6671 | *pterm-mouse* |
| 6672 | pterm QNX pterm mouse handling. |
| 6673 | |
| 6674 | The mouse handling must be enabled at compile time |+mouse_xterm| |
| 6675 | |+mouse_dec| |+mouse_netterm|. |
| 6676 | Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 6677 | recognized, if enabled at compile time. DEC terminal mouse codes |
| 6678 | are recognized if enabled at compile time, and 'ttymouse' is not |
| 6679 | "xterm" (because the xterm and dec mouse codes conflict). |
| 6680 | This option is automatically set to "xterm", when the 'term' option is |
| 6681 | set to a name that starts with "xterm", and 'ttymouse' is not "xterm" |
| 6682 | or "xterm2" already. The main use of this option is to set it to |
| 6683 | "xterm", when the terminal name doesn't start with "xterm", but it can |
| 6684 | handle xterm mouse codes. |
| 6685 | The "xterm2" value will be set if the xterm version is reported to be |
| 6686 | 95 of higher. This only works when compiled with the |+termresponse| |
| 6687 | feature and if |t_RV| is set to the escape sequence to request the |
| 6688 | xterm version number. Otherwise "xterm2" must be set explicitly. |
| 6689 | If you do not want 'ttymouse' to be set to "xterm2" automatically, set |
| 6690 | t_RV to an empty string: > |
| 6691 | :set t_RV= |
| 6692 | < |
| 6693 | *'ttyscroll'* *'tsl'* |
| 6694 | 'ttyscroll' 'tsl' number (default 999) |
| 6695 | global |
| 6696 | Maximum number of lines to scroll the screen. If there are more lines |
| 6697 | to scroll the window is redrawn. For terminals where scrolling is |
| 6698 | very slow and redrawing is not slow this can be set to a small number, |
| 6699 | e.g., 3, to speed up displaying. |
| 6700 | |
| 6701 | *'ttytype'* *'tty'* |
| 6702 | 'ttytype' 'tty' string (default from $TERM) |
| 6703 | global |
| 6704 | Alias for 'term', see above. |
| 6705 | |
| 6706 | *'undolevels'* *'ul'* |
| 6707 | 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, |
| 6708 | Win32 and OS/2) |
| 6709 | global |
| 6710 | {not in Vi} |
| 6711 | Maximum number of changes that can be undone. Since undo information |
| 6712 | is kept in memory, higher numbers will cause more memory to be used |
| 6713 | (nevertheless, a single change can use an unlimited amount of memory). |
| 6714 | Set to 0 for Vi compatibility: One level of undo and "u" undoes |
| 6715 | itself: > |
| 6716 | set ul=0 |
| 6717 | < But you can also get Vi compatibility by including the 'u' flag in |
| 6718 | 'cpoptions', and still be able to use CTRL-R to repeat undo. |
| 6719 | Set to a negative number for no undo at all: > |
| 6720 | set ul=-1 |
| 6721 | < This helps when you run out of memory for a single change. |
| 6722 | Also see |undo-two-ways|. |
| 6723 | |
| 6724 | *'updatecount'* *'uc'* |
| 6725 | 'updatecount' 'uc' number (default: 200) |
| 6726 | global |
| 6727 | {not in Vi} |
| 6728 | After typing this many characters the swap file will be written to |
| 6729 | disk. When zero, no swap file will be created at all (see chapter on |
| 6730 | recovery |crash-recovery|). 'updatecount' is set to zero by starting |
| 6731 | Vim with the "-n" option, see |startup|. When editing in readonly |
| 6732 | mode this option will be initialized to 10000. |
| 6733 | The swapfile can be disabled per buffer with |'swapfile'|. |
| 6734 | When 'updatecount' is set from zero to non-zero, swap files are |
| 6735 | created for all buffers that have 'swapfile' set. When 'updatecount' |
| 6736 | is set to zero, existing swap files are not deleted. |
| 6737 | Also see |'swapsync'|. |
| 6738 | This option has no meaning in buffers where |'buftype'| is "nofile" |
| 6739 | or "nowrite". |
| 6740 | |
| 6741 | *'updatetime'* *'ut'* |
| 6742 | 'updatetime' 'ut' number (default 4000) |
| 6743 | global |
| 6744 | {not in Vi} |
| 6745 | If this many milliseconds nothing is typed the swap file will be |
| 6746 | written to disk (see |crash-recovery|). Also used for the |
| 6747 | |CursorHold| autocommand event. |
| 6748 | |
| 6749 | *'verbose'* *'vbs'* |
| 6750 | 'verbose' 'vbs' number (default 0) |
| 6751 | global |
| 6752 | {not in Vi, although some versions have a boolean |
| 6753 | verbose option} |
| 6754 | When bigger than zero, Vim will give messages about what it is doing. |
| 6755 | Currently, these messages are given: |
| 6756 | >= 1 When the viminfo file is read or written. |
| 6757 | >= 2 When a file is ":source"'ed. |
| 6758 | >= 5 Every searched tags file. |
| 6759 | >= 8 Files for which a group of autocommands is executed. |
| 6760 | >= 9 Every executed autocommand. |
| 6761 | >= 12 Every executed function. |
| 6762 | >= 13 When an exception is thrown, caught, finished, or discarded. |
| 6763 | >= 14 Anything pending in a ":finally" clause. |
| 6764 | >= 15 Every executed Ex command (truncated at 200 characters). |
| 6765 | |
| 6766 | This option can also be set with the "-V" argument. See |-V|. |
| 6767 | This option is also set by the |:verbose| command. |
| 6768 | |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 6769 | When the 'verbosefile' option is set then the verbose messages are not |
| 6770 | displayed. |
| 6771 | |
| 6772 | *'verbosefile'* *'vfile'* |
| 6773 | 'verbosefile' 'vfile' string (default empty) |
| 6774 | global |
| 6775 | {not in Vi} |
| 6776 | When not empty all messages are written in a file with this name. |
| 6777 | When the file exists messages are appended. |
| 6778 | Writing to the file ends when Vim exits or when 'verbosefile' is made |
| 6779 | empty. |
| 6780 | Setting 'verbosefile' to a new value is like making it empty first. |
| 6781 | The difference with |:redir| is that verbose messages are not |
| 6782 | displayed when 'verbosefile' is set. |
| 6783 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6784 | *'viewdir'* *'vdir'* |
| 6785 | 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: |
| 6786 | "$VIM/vimfiles/view", |
| 6787 | for Unix: "~/.vim/view", |
| 6788 | for Macintosh: "$VIM:vimfiles:view" |
| 6789 | for VMS: "sys$login:vimfiles/view" |
| 6790 | for RiscOS: "Choices:vimfiles/view") |
| 6791 | global |
| 6792 | {not in Vi} |
| 6793 | {not available when compiled without the +mksession |
| 6794 | feature} |
| 6795 | Name of the directory where to store files for |:mkview|. |
| 6796 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6797 | security reasons. |
| 6798 | |
| 6799 | *'viewoptions'* *'vop'* |
| 6800 | 'viewoptions' 'vop' string (default: "folds,options,cursor") |
| 6801 | global |
| 6802 | {not in Vi} |
| 6803 | {not available when compiled without the +mksession |
| 6804 | feature} |
| 6805 | Changes the effect of the |:mkview| command. It is a comma separated |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6806 | list of words. Each word enables saving and restoring something: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6807 | word save and restore ~ |
| 6808 | cursor cursor position in file and in window |
| 6809 | folds manually created folds, opened/closed folds and local |
| 6810 | fold options |
| 6811 | options options and mappings local to a window or buffer (not |
| 6812 | global values for local options) |
| 6813 | slash backslashes in file names replaced with forward |
| 6814 | slashes |
| 6815 | unix with Unix end-of-line format (single <NL>), even when |
| 6816 | on Windows or DOS |
| 6817 | |
| 6818 | "slash" and "unix" are useful on Windows when sharing view files |
| 6819 | with Unix. The Unix version of Vim cannot source dos format scripts, |
| 6820 | but the Windows version of Vim can source unix format scripts. |
| 6821 | |
| 6822 | *'viminfo'* *'vi'* *E526* *E527* *E528* |
| 6823 | 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, |
| 6824 | Windows and OS/2: '20,<50,s10,h,rA:,rB:, |
| 6825 | for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2: |
| 6826 | for others: '20,<50,s10,h) |
| 6827 | global |
| 6828 | {not in Vi} |
| 6829 | {not available when compiled without the |+viminfo| |
| 6830 | feature} |
| 6831 | When non-empty, the viminfo file is read upon startup and written |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6832 | when exiting Vim (see |viminfo-file|). The string should be a comma |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6833 | separated list of parameters, each consisting of a single character |
| 6834 | identifying the particular parameter, followed by a number or string |
| 6835 | which specifies the value of that parameter. If a particular |
| 6836 | character is left out, then the default value is used for that |
| 6837 | parameter. The following is a list of the identifying characters and |
| 6838 | the effect of their value. |
| 6839 | CHAR VALUE ~ |
| 6840 | ! When included, save and restore global variables that start |
| 6841 | with an uppercase letter, and don't contain a lowercase |
| 6842 | letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 6843 | and "_K_L_M" are not. Only String and Number types are |
| 6844 | stored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6845 | " Maximum number of lines saved for each register. Old name of |
| 6846 | the '<' item, with the disadvantage that you need to put a |
| 6847 | backslash before the ", otherwise it will be recognized as the |
| 6848 | start of a comment! |
| 6849 | % When included, save and restore the buffer list. If Vim is |
| 6850 | started with a file name argument, the buffer list is not |
| 6851 | restored. If Vim is started without a file name argument, the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6852 | buffer list is restored from the viminfo file. Buffers |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6853 | without a file name and buffers for help files are not written |
| 6854 | to the viminfo file. |
Bram Moolenaar | 15d0a8c | 2004-09-06 17:44:46 +0000 | [diff] [blame] | 6855 | When followed by a number, the number specifies the maximum |
| 6856 | number of buffers that are stored. Without a number all |
| 6857 | buffers are stored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6858 | ' Maximum number of previously edited files for which the marks |
| 6859 | are remembered. This parameter must always be included when |
| 6860 | 'viminfo' is non-empty. |
| 6861 | Including this item also means that the |jumplist| and the |
| 6862 | |changelist| are stored in the viminfo file. |
| 6863 | / Maximum number of items in the search pattern history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6864 | saved. If non-zero, then the previous search and substitute |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6865 | patterns are also saved. When not included, the value of |
| 6866 | 'history' is used. |
| 6867 | : Maximum number of items in the command-line history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6868 | saved. When not included, the value of 'history' is used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6869 | < Maximum number of lines saved for each register. If zero then |
| 6870 | registers are not saved. When not included, all lines are |
| 6871 | saved. '"' is the old name for this item. |
| 6872 | Also see the 's' item below: limit specified in Kbyte. |
| 6873 | @ Maximum number of items in the input-line history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6874 | saved. When not included, the value of 'history' is used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6875 | c When included, convert the text in the viminfo file from the |
| 6876 | 'encoding' used when writing the file to the current |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 6877 | 'encoding'. See |viminfo-encoding|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6878 | f Whether file marks need to be stored. If zero, file marks ('0 |
| 6879 | to '9, 'A to 'Z) are not stored. When not present or when |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6880 | non-zero, they are all stored. '0 is used for the current |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6881 | cursor position (when exiting or when doing ":wviminfo"). |
| 6882 | h Disable the effect of 'hlsearch' when loading the viminfo |
| 6883 | file. When not included, it depends on whether ":nohlsearch" |
| 6884 | has been used since the last search command. |
| 6885 | n Name of the viminfo file. The name must immediately follow |
| 6886 | the 'n'. Must be the last one! If the "-i" argument was |
| 6887 | given when starting Vim, that file name overrides the one |
| 6888 | given here with 'viminfo'. Environment variables are expanded |
| 6889 | when opening the file, not when setting the option. |
| 6890 | r Removable media. The argument is a string (up to the next |
| 6891 | ','). This parameter can be given several times. Each |
| 6892 | specifies the start of a path for which no marks will be |
| 6893 | stored. This is to avoid removable media. For MS-DOS you |
| 6894 | could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
| 6895 | also use it for temp files, e.g., for Unix: "r/tmp". Case is |
| 6896 | ignored. Maximum length of each 'r' argument is 50 |
| 6897 | characters. |
| 6898 | s Maximum size of an item in Kbyte. If zero then registers are |
| 6899 | not saved. Currently only applies to registers. The default |
| 6900 | "s10" will exclude registers with more than 10 Kbyte of text. |
| 6901 | Also see the '<' item above: line count limit. |
| 6902 | |
| 6903 | Example: > |
| 6904 | :set viminfo='50,<1000,s100,:0,n~/vim/viminfo |
| 6905 | < |
| 6906 | '50 Marks will be remembered for the last 50 files you |
| 6907 | edited. |
| 6908 | <1000 Contents of registers (up to 1000 lines each) will be |
| 6909 | remembered. |
| 6910 | s100 Registers with more than 100 Kbyte text are skipped. |
| 6911 | :0 Command-line history will not be saved. |
| 6912 | n~/vim/viminfo The name of the file to use is "~/vim/viminfo". |
| 6913 | no / Since '/' is not specified, the default will be used, |
| 6914 | that is, save all of the search history, and also the |
| 6915 | previous search and substitute patterns. |
| 6916 | no % The buffer list will not be saved nor read back. |
| 6917 | no h 'hlsearch' highlighting will be restored. |
| 6918 | |
| 6919 | When setting 'viminfo' from an empty value you can use |:rviminfo| to |
| 6920 | load the contents of the file, this is not done automatically. |
| 6921 | |
| 6922 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6923 | security reasons. |
| 6924 | |
| 6925 | *'virtualedit'* *'ve'* |
| 6926 | 'virtualedit' 've' string (default "") |
| 6927 | global |
| 6928 | {not in Vi} |
| 6929 | {not available when compiled without the |
| 6930 | |+virtualedit| feature} |
| 6931 | A comma separated list of these words: |
| 6932 | block Allow virtual editing in Visual block mode. |
| 6933 | insert Allow virtual editing in Insert mode. |
| 6934 | all Allow virtual editing in all modes. |
| 6935 | Virtual editing means that the cursor can be positioned where there is |
| 6936 | no actual character. This can be halfway into a Tab or beyond the end |
| 6937 | of the line. Useful for selecting a rectangle in Visual mode and |
| 6938 | editing a table. |
| 6939 | |
| 6940 | *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* |
| 6941 | 'visualbell' 'vb' boolean (default off) |
| 6942 | global |
| 6943 | {not in Vi} |
| 6944 | Use visual bell instead of beeping. The terminal code to display the |
| 6945 | visual bell is given with 't_vb'. When no beep or flash is wanted, |
| 6946 | use ":set vb t_vb=". |
| 6947 | Note: When the GUI starts, 't_vb' is reset to its default value. You |
| 6948 | might want to set it again in your |gvimrc|. |
| 6949 | In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
| 6950 | for 20 msec. If you want to use a different time, use "<Esc>|40f", |
| 6951 | where 40 is the time in msec. |
| 6952 | Does not work on the Amiga, you always get a screen flash. |
| 6953 | Also see 'errorbells'. |
| 6954 | |
| 6955 | *'warn'* *'nowarn'* |
| 6956 | 'warn' boolean (default on) |
| 6957 | global |
| 6958 | Give a warning message when a shell command is used while the buffer |
| 6959 | has been changed. |
| 6960 | |
| 6961 | *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* |
| 6962 | 'weirdinvert' 'wiv' boolean (default off) |
| 6963 | global |
| 6964 | {not in Vi} |
| 6965 | This option has the same effect as the 't_xs' termcap option. |
| 6966 | It is provided for backwards compatibility with version 4.x. |
| 6967 | Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and |
| 6968 | vice versa. Has no effect when the GUI is running. |
| 6969 | |
| 6970 | *'whichwrap'* *'ww'* |
| 6971 | 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") |
| 6972 | global |
| 6973 | {not in Vi} |
| 6974 | Allow specified keys that move the cursor left/right to move to the |
| 6975 | previous/next line when the cursor is on the first/last character in |
| 6976 | the line. Concatenate characters to allow this for these keys: |
| 6977 | char key mode ~ |
| 6978 | b <BS> Normal and Visual |
| 6979 | s <Space> Normal and Visual |
| 6980 | h "h" Normal and Visual |
| 6981 | l "l" Normal and Visual |
| 6982 | < <Left> Normal and Visual |
| 6983 | > <Right> Normal and Visual |
| 6984 | ~ "~" Normal |
| 6985 | [ <Left> Insert and Replace |
| 6986 | ] <Right> Insert and Replace |
| 6987 | For example: > |
| 6988 | :set ww=<,>,[,] |
| 6989 | < allows wrap only when cursor keys are used. |
| 6990 | When the movement keys are used in combination with a delete or change |
| 6991 | operator, the <EOL> also counts for a character. This makes "3h" |
| 6992 | different from "3dh" when the cursor crosses the end of a line. This |
| 6993 | is also true for "x" and "X", because they do the same as "dl" and |
| 6994 | "dh". If you use this, you may also want to use the mapping |
| 6995 | ":map <BS> X" to make backspace delete the character in front of the |
| 6996 | cursor. |
| 6997 | When 'l' is included, you get a side effect: "yl" on an empty line |
| 6998 | will include the <EOL>, so that "p" will insert a new line. |
| 6999 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 7000 | set and to the Vim default value when 'compatible' is reset. |
| 7001 | |
| 7002 | *'wildchar'* *'wc'* |
| 7003 | 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) |
| 7004 | global |
| 7005 | {not in Vi} |
| 7006 | Character you have to type to start wildcard expansion in the |
| 7007 | command-line, as specified with 'wildmode'. |
| 7008 | The character is not recognized when used inside a macro. See |
| 7009 | 'wildcharm' for that. |
| 7010 | Although 'wc' is a number option, you can set it to a special key: > |
| 7011 | :set wc=<Esc> |
| 7012 | < NOTE: This option is set to the Vi default value when 'compatible' is |
| 7013 | set and to the Vim default value when 'compatible' is reset. |
| 7014 | |
| 7015 | *'wildcharm'* *'wcm'* |
| 7016 | 'wildcharm' 'wcm' number (default: none (0)) |
| 7017 | global |
| 7018 | {not in Vi} |
| 7019 | 'wildcharm' works exactly like 'wildchar', except that it is |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7020 | recognized when used inside a macro. You can find "spare" command-line |
| 7021 | keys suitable for this option by looking at |ex-edit-index|. Normally |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7022 | you'll never actually type 'wildcharm', just use it in mappings that |
| 7023 | automatically invoke completion mode, e.g.: > |
| 7024 | :set wcm=<C-Z> |
| 7025 | :cmap ss so $vim/sessions/*.vim<C-Z> |
| 7026 | < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 7027 | |
| 7028 | *'wildignore'* *'wig'* |
| 7029 | 'wildignore' 'wig' string (default "") |
| 7030 | global |
| 7031 | {not in Vi} |
| 7032 | {not available when compiled without the |+wildignore| |
| 7033 | feature} |
| 7034 | A list of file patterns. A file that matches with one of these |
| 7035 | patterns is ignored when completing file or directory names. |
| 7036 | The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 7037 | Also see 'suffixes'. |
| 7038 | Example: > |
| 7039 | :set wildignore=*.o,*.obj |
| 7040 | < The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 7041 | a pattern from the list. This avoids problems when a future version |
| 7042 | uses another default. |
| 7043 | |
| 7044 | *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
| 7045 | 'wildmenu' 'wmnu' boolean (default off) |
| 7046 | global |
| 7047 | {not in Vi} |
| 7048 | {not available if compiled without the |+wildmenu| |
| 7049 | feature} |
| 7050 | When 'wildmenu' is on, command-line completion operates in an enhanced |
| 7051 | mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, |
| 7052 | the possible matches are shown just above the command line, with the |
| 7053 | first match highlighted (overwriting the status line, if there is |
| 7054 | one). Keys that show the previous/next match, such as <Tab> or |
| 7055 | CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
| 7056 | When 'wildmode' is used, "wildmenu" mode is used where "full" is |
| 7057 | specified. "longest" and "list" do not start "wildmenu" mode. |
| 7058 | If there are more matches than can fit in the line, a ">" is shown on |
| 7059 | the right and/or a "<" is shown on the left. The status line scrolls |
| 7060 | as needed. |
| 7061 | The "wildmenu" mode is abandoned when a key is hit that is not used |
| 7062 | for selecting a completion. |
| 7063 | While the "wildmenu" is active the following keys have special |
| 7064 | meanings: |
| 7065 | |
| 7066 | <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) |
| 7067 | <Down> - in filename/menu name completion: move into a |
| 7068 | subdirectory or submenu. |
| 7069 | <CR> - in menu completion, when the cursor is just after a |
| 7070 | dot: move into a submenu. |
| 7071 | <Up> - in filename/menu name completion: move up into |
| 7072 | parent directory or parent menu. |
| 7073 | |
| 7074 | This makes the menus accessible from the console |console-menus|. |
| 7075 | |
| 7076 | If you prefer the <Left> and <Right> keys to move the cursor instead |
| 7077 | of selecting a different match, use this: > |
| 7078 | :cnoremap <Left> <Space><BS><Left> |
| 7079 | :cnoremap <Right> <Space><BS><Right> |
| 7080 | < |
| 7081 | The "WildMenu" highlighting is used for displaying the current match |
| 7082 | |hl-WildMenu|. |
| 7083 | |
| 7084 | *'wildmode'* *'wim'* |
| 7085 | 'wildmode' 'wim' string (Vim default: "full") |
| 7086 | global |
| 7087 | {not in Vi} |
| 7088 | Completion mode that is used for the character specified with |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7089 | 'wildchar'. It is a comma separated list of up to four parts. Each |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7090 | part specifies what to do for each consecutive use of 'wildchar. The |
| 7091 | first part specifies the behavior for the first use of 'wildchar', |
| 7092 | The second part for the second use, etc. |
| 7093 | These are the possible values for each part: |
| 7094 | "" Complete only the first match. |
| 7095 | "full" Complete the next full match. After the last match, |
| 7096 | the original string is used and then the first match |
| 7097 | again. |
| 7098 | "longest" Complete till longest common string. If this doesn't |
| 7099 | result in a longer string, use the next part. |
| 7100 | "longest:full" Like "longest", but also start 'wildmenu' if it is |
| 7101 | enabled. |
| 7102 | "list" When more than one match, list all matches. |
| 7103 | "list:full" When more than one match, list all matches and |
| 7104 | complete first match. |
| 7105 | "list:longest" When more than one match, list all matches and |
| 7106 | complete till longest common string. |
| 7107 | When there is only a single match, it is fully completed in all cases. |
| 7108 | |
| 7109 | Examples: > |
| 7110 | :set wildmode=full |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7111 | < Complete first full match, next match, etc. (the default) > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7112 | :set wildmode=longest,full |
| 7113 | < Complete longest common string, then each full match > |
| 7114 | :set wildmode=list:full |
| 7115 | < List all matches and complete each full match > |
| 7116 | :set wildmode=list,full |
| 7117 | < List all matches without completing, then each full match > |
| 7118 | :set wildmode=longest,list |
| 7119 | < Complete longest common string, then list alternatives. |
| 7120 | |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 7121 | *'wildoptions'* *'wop'* |
| 7122 | 'wildoptions' 'wop' string (default "") |
| 7123 | global |
| 7124 | {not in Vi} |
| 7125 | {not available when compiled without the |+wildignore| |
| 7126 | feature} |
| 7127 | A list of words that change how command line completion is done. |
| 7128 | Currently only one word is allowed: |
| 7129 | tagfile When using CTRL-D to list matching tags, the kind of |
| 7130 | tag and the file of the tag is listed. Only one match |
| 7131 | is displayed per line. Often used tag kinds are: |
| 7132 | d #define |
| 7133 | f function |
| 7134 | Also see |cmdline-completion|. |
| 7135 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7136 | *'winaltkeys'* *'wak'* |
| 7137 | 'winaltkeys' 'wak' string (default "menu") |
| 7138 | global |
| 7139 | {not in Vi} |
| 7140 | {only used in Win32, Motif, GTK and Photon GUI} |
| 7141 | Some GUI versions allow the access to menu entries by using the ALT |
| 7142 | key in combination with a character that appears underlined in the |
| 7143 | menu. This conflicts with the use of the ALT key for mappings and |
| 7144 | entering special characters. This option tells what to do: |
| 7145 | no Don't use ALT keys for menus. ALT key combinations can be |
| 7146 | mapped, but there is no automatic handling. This can then be |
| 7147 | done with the |:simalt| command. |
| 7148 | yes ALT key handling is done by the windowing system. ALT key |
| 7149 | combinations cannot be mapped. |
| 7150 | menu Using ALT in combination with a character that is a menu |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7151 | shortcut key, will be handled by the windowing system. Other |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7152 | keys can be mapped. |
| 7153 | If the menu is disabled by excluding 'm' from 'guioptions', the ALT |
| 7154 | key is never used for the menu. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 7155 | This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 7156 | select the menu, unless it has been mapped. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7157 | |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 7158 | *'window'* *'wi'* |
| 7159 | 'window' 'wi' number (default screen height - 1) |
| 7160 | global |
| 7161 | Window height. Do not confuse this with the height of the Vim window, |
| 7162 | use 'lines' for that. |
Bram Moolenaar | 19a09a1 | 2005-03-04 23:39:37 +0000 | [diff] [blame] | 7163 | Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
| 7164 | value is smaller than 'lines' minus one. The screen will scroll |
| 7165 | 'window' minus two lines, with a minimum of one. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 7166 | When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 7167 | in a much smarter way, taking care of wrapping lines. |
| 7168 | When resizing the Vim window, the value is smaller than 1 or more than |
| 7169 | or equal to 'lines' it will be set to 'lines' minus 1. |
| 7170 | {Vi also uses the option to specify the number of displayed lines} |
| 7171 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7172 | *'winheight'* *'wh'* *E591* |
| 7173 | 'winheight' 'wh' number (default 1) |
| 7174 | global |
| 7175 | {not in Vi} |
| 7176 | {not available when compiled without the +windows |
| 7177 | feature} |
| 7178 | Minimal number of lines for the current window. This is not a hard |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7179 | minimum, Vim will use fewer lines if there is not enough room. If the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7180 | current window is smaller, its size is increased, at the cost of the |
| 7181 | height of other windows. Set it to 999 to make the current window |
| 7182 | always fill the screen (although this has the drawback that ":all" |
| 7183 | will create only two windows). Set it to a small number for normal |
| 7184 | editing. |
| 7185 | Minimum value is 1. |
| 7186 | The height is not adjusted after one of the commands to change the |
| 7187 | height of the current window. |
| 7188 | 'winheight' applies to the current window. Use 'winminheight' to set |
| 7189 | the minimal height for other windows. |
| 7190 | |
| 7191 | *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* |
| 7192 | 'winfixheight' 'wfh' boolean (default off) |
| 7193 | local to window |
| 7194 | {not in Vi} |
| 7195 | {not available when compiled without the +windows |
| 7196 | feature} |
| 7197 | Keep the window height when windows are opened or closed and |
| 7198 | 'equalalways' is set. Set by default for the |preview-window| and |
| 7199 | |quickfix-window|. |
| 7200 | The height may be changed anyway when running out of room. |
| 7201 | |
| 7202 | *'winminheight'* *'wmh'* |
| 7203 | 'winminheight' 'wmh' number (default 1) |
| 7204 | global |
| 7205 | {not in Vi} |
| 7206 | {not available when compiled without the +windows |
| 7207 | feature} |
| 7208 | The minimal height of a window, when it's not the current window. |
| 7209 | This is a hard minimum, windows will never become smaller. |
| 7210 | When set to zero, windows may be "squashed" to zero lines (i.e. just a |
| 7211 | status bar) if necessary. They will return to at least one line when |
| 7212 | they become active (since the cursor has to have somewhere to go.) |
| 7213 | Use 'winheight' to set the minimal height of the current window. |
| 7214 | This option is only checked when making a window smaller. Don't use a |
| 7215 | large number, it will cause errors when opening more than a few |
| 7216 | windows. A value of 0 to 3 is reasonable. |
| 7217 | |
| 7218 | *'winminwidth'* *'wmw'* |
| 7219 | 'winminwidth' 'wmw' number (default 1) |
| 7220 | global |
| 7221 | {not in Vi} |
| 7222 | {not available when compiled without the +vertsplit |
| 7223 | feature} |
| 7224 | The minimal width of a window, when it's not the current window. |
| 7225 | This is a hard minimum, windows will never become smaller. |
| 7226 | When set to zero, windows may be "squashed" to zero columns (i.e. just |
| 7227 | a vertical separator) if necessary. They will return to at least one |
| 7228 | line when they become active (since the cursor has to have somewhere |
| 7229 | to go.) |
| 7230 | Use 'winwidth' to set the minimal width of the current window. |
| 7231 | This option is only checked when making a window smaller. Don't use a |
| 7232 | large number, it will cause errors when opening more than a few |
| 7233 | windows. A value of 0 to 12 is reasonable. |
| 7234 | |
| 7235 | *'winwidth'* *'wiw'* *E592* |
| 7236 | 'winwidth' 'wiw' number (default 20) |
| 7237 | global |
| 7238 | {not in Vi} |
| 7239 | {not available when compiled without the +vertsplit |
| 7240 | feature} |
| 7241 | Minimal number of columns for the current window. This is not a hard |
| 7242 | minimum, Vim will use fewer columns if there is not enough room. If |
| 7243 | the current window is smaller, its size is increased, at the cost of |
| 7244 | the width of other windows. Set it to 999 to make the current window |
| 7245 | always fill the screen. Set it to a small number for normal editing. |
| 7246 | The width is not adjusted after one of the commands to change the |
| 7247 | width of the current window. |
| 7248 | 'winwidth' applies to the current window. Use 'winminwidth' to set |
| 7249 | the minimal width for other windows. |
| 7250 | |
| 7251 | *'wrap'* *'nowrap'* |
| 7252 | 'wrap' boolean (default on) |
| 7253 | local to window |
| 7254 | {not in Vi} |
| 7255 | This option changes how text is displayed. It doesn't change the text |
| 7256 | in the buffer, see 'textwidth' for that. |
| 7257 | When on, lines longer than the width of the window will wrap and |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7258 | displaying continues on the next line. When off lines will not wrap |
| 7259 | and only part of long lines will be displayed. When the cursor is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7260 | moved to a part that is not shown, the screen will scroll |
| 7261 | horizontally. |
| 7262 | The line will be broken in the middle of a word if necessary. See |
| 7263 | 'linebreak' to get the break at a word boundary. |
| 7264 | To make scrolling horizontally a bit more useful, try this: > |
| 7265 | :set sidescroll=5 |
| 7266 | :set listchars+=precedes:<,extends:> |
| 7267 | < See 'sidescroll', 'listchars' and |wrap-off|. |
| 7268 | |
| 7269 | *'wrapmargin'* *'wm'* |
| 7270 | 'wrapmargin' 'wm' number (default 0) |
| 7271 | local to buffer |
| 7272 | Number of characters from the right window border where wrapping |
| 7273 | starts. When typing text beyond this limit, an <EOL> will be inserted |
| 7274 | and inserting continues on the next line. |
| 7275 | Options that add a margin, such as 'number' and 'foldcolumn', cause |
| 7276 | the text width to be further reduced. This is Vi compatible. |
| 7277 | When 'textwidth' is non-zero, this option is not used. |
| 7278 | See also 'formatoptions' and |ins-textwidth|. {Vi: works differently |
| 7279 | and less usefully} |
| 7280 | |
| 7281 | *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* |
| 7282 | 'wrapscan' 'ws' boolean (default on) *E384* *E385* |
| 7283 | global |
| 7284 | Searches wrap around the end of the file. |
| 7285 | |
| 7286 | *'write'* *'nowrite'* |
| 7287 | 'write' boolean (default on) |
| 7288 | global |
| 7289 | {not in Vi} |
| 7290 | Allows writing files. When not set, writing a file is not allowed. |
| 7291 | Can be used for a view-only mode, where modifications to the text are |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7292 | still allowed. Can be reset with the |-m| or |-M| command line |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7293 | argument. Filtering text is still possible, even though this requires |
| 7294 | writing a temporary file. |
| 7295 | |
| 7296 | *'writeany'* *'wa'* *'nowriteany'* *'nowa'* |
| 7297 | 'writeany' 'wa' boolean (default off) |
| 7298 | global |
| 7299 | Allows writing to any file with no need for "!" override. |
| 7300 | |
| 7301 | *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* |
| 7302 | 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off |
| 7303 | otherwise) |
| 7304 | global |
| 7305 | {not in Vi} |
| 7306 | Make a backup before overwriting a file. The backup is removed after |
| 7307 | the file was successfully written, unless the 'backup' option is |
| 7308 | also on. Reset this option if your file system is almost full. See |
| 7309 | |backup-table| for another explanation. |
| 7310 | When the 'backupskip' pattern matches, a backup is not made anyway. |
| 7311 | NOTE: This option is set to the default value when 'compatible' is |
| 7312 | set. |
| 7313 | |
| 7314 | *'writedelay'* *'wd'* |
| 7315 | 'writedelay' 'wd' number (default 0) |
| 7316 | global |
| 7317 | {not in Vi} |
| 7318 | The number of microseconds to wait for each character sent to the |
| 7319 | screen. When non-zero, characters are sent to the terminal one by |
| 7320 | one. For MS-DOS pcterm this does not work. For debugging purposes. |
| 7321 | |
| 7322 | vim:tw=78:ts=8:ft=help:norl: |