Bram Moolenaar | 6d150f7 | 2018-04-21 20:03:20 +0200 | [diff] [blame] | 1 | *options.txt* For Vim version 8.0. Last change: 2018 Apr 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 | |
Bram Moolenaar | 2ec618c | 2016-10-01 14:47:05 +0200 | [diff] [blame] | 13 | For an overview of options see quickref.txt |option-list|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 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 | ============================================================================== |
Bram Moolenaar | f75a963 | 2005-09-13 21:20:47 +0000 | [diff] [blame] | 22 | 1. Setting options *set-option* *E764* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 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 | |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 43 | *:set-!* *:set-inv* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 44 | :se[t] {option}! or |
| 45 | :se[t] inv{option} Toggle option: Invert value. {not in Vi} |
| 46 | |
| 47 | *:set-default* *:set-&* *:set-&vi* *:set-&vim* |
| 48 | :se[t] {option}& Reset option to its default value. May depend on the |
| 49 | current value of 'compatible'. {not in Vi} |
| 50 | :se[t] {option}&vi Reset option to its Vi default value. {not in Vi} |
| 51 | :se[t] {option}&vim Reset option to its Vim default value. {not in Vi} |
| 52 | |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 53 | :se[t] all& Set all options to their default value. The values of |
Bram Moolenaar | 88774fd | 2015-08-25 19:52:04 +0200 | [diff] [blame] | 54 | these options are not changed: |
| 55 | all terminal options, starting with t_ |
| 56 | 'columns' |
| 57 | 'cryptmethod' |
| 58 | 'encoding' |
| 59 | 'key' |
| 60 | 'lines' |
| 61 | 'term' |
| 62 | 'ttymouse' |
| 63 | 'ttytype' |
| 64 | Warning: This may have a lot of side effects. |
| 65 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 66 | |
| 67 | *:set-args* *E487* *E521* |
| 68 | :se[t] {option}={value} or |
| 69 | :se[t] {option}:{value} |
| 70 | Set string or number option to {value}. |
| 71 | For numeric options the value can be given in decimal, |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 72 | hex (preceded with 0x) or octal (preceded with '0'). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 73 | The old value can be inserted by typing 'wildchar' (by |
| 74 | default this is a <Tab> or CTRL-E if 'compatible' is |
| 75 | set). See |cmdline-completion|. |
| 76 | White space between {option} and '=' is allowed and |
| 77 | will be ignored. White space between '=' and {value} |
| 78 | is not allowed. |
| 79 | See |option-backslash| for using white space and |
| 80 | backslashes in {value}. |
| 81 | |
| 82 | :se[t] {option}+={value} *:set+=* |
| 83 | Add the {value} to a number option, or append the |
| 84 | {value} to a string option. When the option is a |
| 85 | comma separated list, a comma is added, unless the |
| 86 | value was empty. |
| 87 | If the option is a list of flags, superfluous flags |
Bram Moolenaar | a5792f5 | 2005-11-23 21:25:05 +0000 | [diff] [blame] | 88 | are removed. When adding a flag that was already |
| 89 | present the option value doesn't change. |
Bram Moolenaar | 899dddf | 2006-03-26 21:06:50 +0000 | [diff] [blame] | 90 | Also see |:set-args| above. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 91 | {not in Vi} |
| 92 | |
| 93 | :se[t] {option}^={value} *:set^=* |
| 94 | Multiply the {value} to a number option, or prepend |
| 95 | the {value} to a string option. When the option is a |
| 96 | comma separated list, a comma is added, unless the |
| 97 | value was empty. |
| 98 | Also see |:set-args| above. |
| 99 | {not in Vi} |
| 100 | |
| 101 | :se[t] {option}-={value} *:set-=* |
| 102 | Subtract the {value} from a number option, or remove |
| 103 | the {value} from a string option, if it is there. |
| 104 | If the {value} is not found in a string option, there |
| 105 | is no error or warning. When the option is a comma |
| 106 | separated list, a comma is deleted, unless the option |
| 107 | becomes empty. |
| 108 | When the option is a list of flags, {value} must be |
| 109 | exactly as they appear in the option. Remove flags |
| 110 | one by one to avoid problems. |
| 111 | Also see |:set-args| above. |
| 112 | {not in Vi} |
| 113 | |
| 114 | The {option} arguments to ":set" may be repeated. For example: > |
| 115 | :set ai nosi sw=3 ts=3 |
| 116 | If you make an error in one of the arguments, an error message will be given |
| 117 | and the following arguments will be ignored. |
| 118 | |
| 119 | *:set-verbose* |
| 120 | When 'verbose' is non-zero, displaying an option value will also tell where it |
| 121 | was last set. Example: > |
| 122 | :verbose set shiftwidth cindent? |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 123 | < shiftwidth=4 ~ |
| 124 | Last set from modeline ~ |
| 125 | cindent ~ |
| 126 | Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~ |
| 127 | This is only done when specific option values are requested, not for ":verbose |
| 128 | set all" or ":verbose set" without an argument. |
| 129 | When the option was set by hand there is no "Last set" message. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 130 | When the option was set while executing a function, user command or |
| 131 | autocommand, the script in which it was defined is reported. |
| 132 | Note that an option may also have been set as a side effect of setting |
| 133 | 'compatible'. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 134 | A few special texts: |
| 135 | Last set from modeline ~ |
| 136 | Option was set in a |modeline|. |
| 137 | Last set from --cmd argument ~ |
| 138 | Option was set with command line argument |--cmd| or +. |
| 139 | Last set from -c argument ~ |
| 140 | Option was set with command line argument |-c|, +, |-S| or |
| 141 | |-q|. |
| 142 | Last set from environment variable ~ |
| 143 | Option was set from an environment variable, $VIMINIT, |
| 144 | $GVIMINIT or $EXINIT. |
| 145 | Last set from error handler ~ |
| 146 | Option was cleared when evaluating it resulted in an error. |
| 147 | |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 148 | {not available when compiled without the |+eval| feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 149 | |
| 150 | *:set-termcap* *E522* |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 151 | For {option} the form "t_xx" may be used to set a terminal option. This will |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 152 | override the value from the termcap. You can then use it in a mapping. If |
| 153 | the "xx" part contains special characters, use the <t_xx> form: > |
| 154 | :set <t_#4>=^[Ot |
| 155 | This can also be used to translate a special code for a normal key. For |
| 156 | example, if Alt-b produces <Esc>b, use this: > |
| 157 | :set <M-b>=^[b |
| 158 | (the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it) |
| 159 | The advantage over a mapping is that it works in all situations. |
| 160 | |
Bram Moolenaar | 0b2f94d | 2011-03-22 14:35:05 +0100 | [diff] [blame] | 161 | You can define any key codes, e.g.: > |
| 162 | :set t_xy=^[foo; |
| 163 | There is no warning for using a name that isn't recognized. You can map these |
| 164 | codes as you like: > |
| 165 | :map <t_xy> something |
| 166 | < *E846* |
| 167 | When a key code is not set, it's like it does not exist. Trying to get its |
| 168 | value will result in an error: > |
| 169 | :set t_kb= |
| 170 | :set t_kb |
| 171 | E846: Key code not set: t_kb |
| 172 | |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 173 | The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 174 | security reasons. |
| 175 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 176 | 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] | 177 | 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] | 178 | "set all" probably does not fit on the screen, causing Vim to give the |
| 179 | |more-prompt|. |
| 180 | |
| 181 | *option-backslash* |
| 182 | To include white space in a string option value it has to be preceded with a |
| 183 | backslash. To include a backslash you have to use two. Effectively this |
| 184 | means that the number of backslashes in an option value is halved (rounded |
| 185 | down). |
| 186 | A few examples: > |
| 187 | :set tags=tags\ /usr/tags results in "tags /usr/tags" |
| 188 | :set tags=tags\\,file results in "tags\,file" |
| 189 | :set tags=tags\\\ file results in "tags\ file" |
| 190 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 191 | The "|" character separates a ":set" command from a following command. To |
| 192 | include the "|" in the option value, use "\|" instead. This example sets the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 193 | 'titlestring' option to "hi|there": > |
| 194 | :set titlestring=hi\|there |
| 195 | This sets the 'titlestring' option to "hi" and 'iconstring' to "there": > |
| 196 | :set titlestring=hi|set iconstring=there |
| 197 | |
Bram Moolenaar | 7df351e | 2006-01-23 22:30:28 +0000 | [diff] [blame] | 198 | Similarly, the double quote character starts a comment. To include the '"' in |
| 199 | the option value, use '\"' instead. This example sets the 'titlestring' |
| 200 | option to 'hi "there"': > |
| 201 | :set titlestring=hi\ \"there\" |
| 202 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 203 | 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] | 204 | precise: For options that expect a file name (those where environment |
| 205 | variables are expanded) a backslash before a normal file name character is not |
| 206 | removed. But a backslash before a special character (space, backslash, comma, |
| 207 | etc.) is used like explained above. |
| 208 | There is one special situation, when the value starts with "\\": > |
| 209 | :set dir=\\machine\path results in "\\machine\path" |
| 210 | :set dir=\\\\machine\\path results in "\\machine\path" |
| 211 | :set dir=\\path\\file results in "\\path\file" (wrong!) |
| 212 | For the first one the start is kept, but for the second one the backslashes |
| 213 | 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] | 214 | 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] | 215 | result which is probably not what you want. Avoid it. |
| 216 | |
| 217 | *add-option-flags* *remove-option-flags* |
| 218 | *E539* *E550* *E551* *E552* |
| 219 | Some options are a list of flags. When you want to add a flag to such an |
| 220 | option, without changing the existing ones, you can do it like this: > |
| 221 | :set guioptions+=a |
| 222 | Remove a flag from an option like this: > |
| 223 | :set guioptions-=a |
| 224 | This removes the 'a' flag from 'guioptions'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 225 | 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] | 226 | the value "ab", using "set guioptions-=ba" won't work, because the string "ba" |
| 227 | doesn't appear. |
| 228 | |
| 229 | *:set_env* *expand-env* *expand-environment-var* |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 230 | Environment variables in specific string options will be expanded. If the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 231 | environment variable exists the '$' and the following environment variable |
| 232 | name is replaced with its value. If it does not exist the '$' and the name |
| 233 | are not modified. Any non-id character (not a letter, digit or '_') may |
| 234 | follow the environment variable name. That character and what follows is |
| 235 | appended to the value of the environment variable. Examples: > |
| 236 | :set term=$TERM.new |
| 237 | :set path=/usr/$INCLUDE,$HOME/include,. |
| 238 | When adding or removing a string from an option with ":set opt-=val" or ":set |
| 239 | opt+=val" the expansion is done before the adding or removing. |
| 240 | |
| 241 | |
| 242 | Handling of local options *local-options* |
| 243 | |
| 244 | Some of the options only apply to a window or buffer. Each window or buffer |
Bram Moolenaar | 5162822 | 2016-12-01 23:03:28 +0100 | [diff] [blame] | 245 | has its own copy of this option, thus each can have its own value. This |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 246 | allows you to set 'list' in one window but not in another. And set |
| 247 | 'shiftwidth' to 3 in one buffer and 4 in another. |
| 248 | |
| 249 | The following explains what happens to these local options in specific |
| 250 | situations. You don't really need to know all of this, since Vim mostly uses |
| 251 | the option values you would expect. Unfortunately, doing what the user |
| 252 | expects is a bit complicated... |
| 253 | |
| 254 | When splitting a window, the local options are copied to the new window. Thus |
| 255 | right after the split the contents of the two windows look the same. |
| 256 | |
| 257 | When editing a new buffer, its local option values must be initialized. Since |
| 258 | the local options of the current buffer might be specifically for that buffer, |
| 259 | these are not used. Instead, for each buffer-local option there also is a |
| 260 | global value, which is used for new buffers. With ":set" both the local and |
| 261 | global value is changed. With "setlocal" only the local value is changed, |
| 262 | thus this value is not used when editing a new buffer. |
| 263 | |
Bram Moolenaar | 95ec9d6 | 2016-08-12 18:29:59 +0200 | [diff] [blame] | 264 | When editing a buffer that has been edited before, the options from the window |
| 265 | that was last closed are used again. If this buffer has been edited in this |
| 266 | window, the values from back then are used. Otherwise the values from the |
| 267 | last closed window where the buffer was edited last are used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 268 | |
| 269 | It's possible to set a local window option specifically for a type of buffer. |
| 270 | When you edit another buffer in the same window, you don't want to keep |
| 271 | using these local window options. Therefore Vim keeps a global value of the |
| 272 | local window options, which is used when editing another buffer. Each window |
| 273 | has its own copy of these values. Thus these are local to the window, but |
| 274 | global to all buffers in the window. With this you can do: > |
| 275 | :e one |
| 276 | :set list |
| 277 | :e two |
| 278 | Now the 'list' option will also be set in "two", since with the ":set list" |
| 279 | command you have also set the global value. > |
| 280 | :set nolist |
| 281 | :e one |
| 282 | :setlocal list |
| 283 | :e two |
| 284 | Now the 'list' option is not set, because ":set nolist" resets the global |
| 285 | value, ":setlocal list" only changes the local value and ":e two" gets the |
| 286 | global value. Note that if you do this next: > |
| 287 | :e one |
Bram Moolenaar | 531da59 | 2013-05-06 05:58:55 +0200 | [diff] [blame] | 288 | You will get back the 'list' value as it was the last time you edited "one". |
| 289 | The options local to a window are remembered for each buffer. This also |
| 290 | happens when the buffer is not loaded, but they are lost when the buffer is |
| 291 | wiped out |:bwipe|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 292 | |
| 293 | *:setl* *:setlocal* |
| 294 | :setl[ocal] ... Like ":set" but set only the value local to the |
| 295 | current buffer or window. Not all options have a |
| 296 | local value. If the option does not have a local |
| 297 | value the global value is set. |
Bram Moolenaar | c330187 | 2010-07-25 20:53:06 +0200 | [diff] [blame] | 298 | With the "all" argument: display local values for all |
| 299 | local options. |
| 300 | Without argument: Display local values for all local |
| 301 | options which are different from the default. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 302 | When displaying a specific local option, show the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 303 | local value. For a global/local boolean option, when |
| 304 | the global value is being used, "--" is displayed |
| 305 | before the option name. |
| 306 | For a global option the global value is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 307 | shown (but that might change in the future). |
| 308 | {not in Vi} |
| 309 | |
Bram Moolenaar | 899dddf | 2006-03-26 21:06:50 +0000 | [diff] [blame] | 310 | :setl[ocal] {option}< Set the local value of {option} to its global value by |
| 311 | copying the value. |
| 312 | {not in Vi} |
| 313 | |
Bram Moolenaar | 6be7f87 | 2012-01-20 21:08:56 +0100 | [diff] [blame] | 314 | :se[t] {option}< For |global-local| options: Remove the local value of |
| 315 | {option}, so that the global value will be used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 316 | {not in Vi} |
| 317 | |
| 318 | *:setg* *:setglobal* |
| 319 | :setg[lobal] ... Like ":set" but set only the global value for a local |
| 320 | option without changing the local value. |
| 321 | When displaying an option, the global value is shown. |
Bram Moolenaar | c330187 | 2010-07-25 20:53:06 +0200 | [diff] [blame] | 322 | With the "all" argument: display global values for all |
| 323 | local options. |
| 324 | Without argument: display global values for all local |
| 325 | options which are different from the default. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 326 | {not in Vi} |
| 327 | |
| 328 | For buffer-local and window-local options: |
| 329 | Command global value local value ~ |
| 330 | :set option=value set set |
| 331 | :setlocal option=value - set |
| 332 | :setglobal option=value set - |
| 333 | :set option? - display |
| 334 | :setlocal option? - display |
| 335 | :setglobal option? display - |
| 336 | |
| 337 | |
| 338 | Global options with a local value *global-local* |
| 339 | |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 340 | Options are global when you mostly use one value for all buffers and windows. |
| 341 | For some global options it's useful to sometimes have a different local value. |
| 342 | You can set the local value with ":setlocal". That buffer or window will then |
| 343 | use the local value, while other buffers and windows continue using the global |
| 344 | value. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 345 | |
| 346 | For example, you have two windows, both on C source code. They use the global |
| 347 | 'makeprg' option. If you do this in one of the two windows: > |
| 348 | :set makeprg=gmake |
| 349 | then the other window will switch to the same value. There is no need to set |
| 350 | the 'makeprg' option in the other C source window too. |
| 351 | However, if you start editing a Perl file in a new window, you want to use |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 352 | another 'makeprg' for it, without changing the value used for the C source |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 353 | files. You use this command: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 354 | :setlocal makeprg=perlmake |
| 355 | You can switch back to using the global value by making the local value empty: > |
| 356 | :setlocal makeprg= |
| 357 | This only works for a string option. For a boolean option you need to use the |
| 358 | "<" flag, like this: > |
| 359 | :setlocal autoread< |
| 360 | Note that for non-boolean options using "<" copies the global value to the |
| 361 | local value, it doesn't switch back to using the global value (that matters |
Bram Moolenaar | 899dddf | 2006-03-26 21:06:50 +0000 | [diff] [blame] | 362 | when the global value changes later). You can also use: > |
| 363 | :set path< |
| 364 | This will make the local value of 'path' empty, so that the global value is |
| 365 | used. Thus it does the same as: > |
| 366 | :setlocal path= |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 367 | Note: In the future more global options can be made global-local. Using |
| 368 | ":setlocal" on a global option might work differently then. |
| 369 | |
| 370 | |
| 371 | Setting the filetype |
| 372 | |
Bram Moolenaar | 6aa8cea | 2017-06-05 14:44:35 +0200 | [diff] [blame] | 373 | :setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 374 | Set the 'filetype' option to {filetype}, but only if |
| 375 | not done yet in a sequence of (nested) autocommands. |
| 376 | This is short for: > |
| 377 | :if !did_filetype() |
| 378 | : setlocal filetype={filetype} |
| 379 | :endif |
| 380 | < This command is used in a filetype.vim file to avoid |
| 381 | setting the 'filetype' option twice, causing different |
| 382 | settings and syntax files to be loaded. |
Bram Moolenaar | 6aa8cea | 2017-06-05 14:44:35 +0200 | [diff] [blame] | 383 | |
| 384 | When the optional FALLBACK argument is present, a |
| 385 | later :setfiletype command will override the |
| 386 | 'filetype'. This is to used for filetype detections |
| 387 | that are just a guess. |did_filetype()| will return |
| 388 | false after this command. |
| 389 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 390 | {not in Vi} |
| 391 | |
Bram Moolenaar | d58e929 | 2011-02-09 17:07:58 +0100 | [diff] [blame] | 392 | *option-window* *optwin* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 393 | :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 394 | :opt[ions] Open a window for viewing and setting all options. |
| 395 | Options are grouped by function. |
| 396 | Offers short help for each option. Hit <CR> on the |
| 397 | short help to open a help window with more help for |
| 398 | the option. |
| 399 | Modify the value of the option and hit <CR> on the |
| 400 | "set" line to set the new value. For window and |
| 401 | buffer specific options, the last accessed window is |
| 402 | used to set the option value in, unless this is a help |
| 403 | window, in which case the window below help window is |
| 404 | used (skipping the option-window). |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 405 | {not available when compiled without the |+eval| |
| 406 | feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 407 | |
| 408 | *$HOME* |
| 409 | Using "~" is like using "$HOME", but it is only recognized at the start of an |
| 410 | option and after a space or comma. |
| 411 | |
| 412 | On Unix systems "~user" can be used too. It is replaced by the home directory |
| 413 | of user "user". Example: > |
| 414 | :set path=~mool/include,/usr/include,. |
| 415 | |
| 416 | On Unix systems the form "${HOME}" can be used too. The name between {} can |
| 417 | contain non-id characters then. Note that if you want to use this for the |
| 418 | "gf" command, you need to add the '{' and '}' characters to 'isfname'. |
| 419 | |
| 420 | NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 421 | command, not when assigning a value to an option with ":let". |
| 422 | |
Bram Moolenaar | c572da5 | 2017-08-27 16:52:01 +0200 | [diff] [blame] | 423 | *$HOME-windows* |
| 424 | On MS-Windows, if $HOME is not defined as an environment variable, then |
| 425 | at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 426 | If $HOMEDRIVE is not set then $USERPROFILE is used. |
| 427 | |
| 428 | This expanded value is not exported to the environment, this matters when |
| 429 | running an external command: > |
| 430 | :echo system('set | findstr ^HOME=') |
| 431 | and > |
| 432 | :echo luaeval('os.getenv("HOME")') |
| 433 | should echo nothing (an empty string) despite exists('$HOME') being true. |
| 434 | When setting $HOME to a non-empty string it will be exported to the |
| 435 | subprocesses. |
Bram Moolenaar | c572da5 | 2017-08-27 16:52:01 +0200 | [diff] [blame] | 436 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 437 | |
| 438 | Note the maximum length of an expanded option is limited. How much depends on |
| 439 | the system, mostly it is something like 256 or 1024 characters. |
| 440 | |
| 441 | *:fix* *:fixdel* |
| 442 | :fix[del] Set the value of 't_kD': |
| 443 | 't_kb' is 't_kD' becomes ~ |
| 444 | CTRL-? CTRL-H |
| 445 | not CTRL-? CTRL-? |
| 446 | |
| 447 | (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} |
| 448 | |
| 449 | If your delete key terminal code is wrong, but the |
| 450 | code for backspace is alright, you can put this in |
| 451 | your .vimrc: > |
| 452 | :fixdel |
| 453 | < This works no matter what the actual code for |
| 454 | backspace is. |
| 455 | |
| 456 | If the backspace key terminal code is wrong you can |
| 457 | use this: > |
| 458 | :if &term == "termname" |
| 459 | : set t_kb=^V<BS> |
| 460 | : fixdel |
| 461 | :endif |
| 462 | < Where "^V" is CTRL-V and "<BS>" is the backspace key |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 463 | (don't type four characters!). Replace "termname" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 464 | with your terminal name. |
| 465 | |
| 466 | If your <Delete> key sends a strange key sequence (not |
| 467 | CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > |
| 468 | :if &term == "termname" |
| 469 | : set t_kD=^V<Delete> |
| 470 | :endif |
| 471 | < Where "^V" is CTRL-V and "<Delete>" is the delete key |
| 472 | (don't type eight characters!). Replace "termname" |
| 473 | with your terminal name. |
| 474 | |
| 475 | *Linux-backspace* |
| 476 | Note about Linux: By default the backspace key |
| 477 | produces CTRL-?, which is wrong. You can fix it by |
| 478 | putting this line in your rc.local: > |
| 479 | echo "keycode 14 = BackSpace" | loadkeys |
| 480 | < |
| 481 | *NetBSD-backspace* |
| 482 | Note about NetBSD: If your backspace doesn't produce |
| 483 | the right code, try this: > |
| 484 | xmodmap -e "keycode 22 = BackSpace" |
| 485 | < If this works, add this in your .Xmodmap file: > |
| 486 | keysym 22 = BackSpace |
| 487 | < You need to restart for this to take effect. |
| 488 | |
| 489 | ============================================================================== |
| 490 | 2. Automatically setting options *auto-setting* |
| 491 | |
| 492 | Besides changing options with the ":set" command, there are three alternatives |
| 493 | to set options automatically for one or more files: |
| 494 | |
| 495 | 1. When starting Vim initializations are read from various places. See |
| 496 | |initialization|. Most of them are performed for all editing sessions, |
| 497 | and some of them depend on the directory where Vim is started. |
| 498 | You can create an initialization file with |:mkvimrc|, |:mkview| and |
| 499 | |:mksession|. |
| 500 | 2. If you start editing a new file, the automatic commands are executed. |
| 501 | This can be used to set options for files matching a particular pattern and |
| 502 | many other things. See |autocommand|. |
| 503 | 3. If you start editing a new file, and the 'modeline' option is on, a |
| 504 | number of lines at the beginning and end of the file are checked for |
| 505 | modelines. This is explained here. |
| 506 | |
| 507 | *modeline* *vim:* *vi:* *ex:* *E520* |
| 508 | There are two forms of modelines. The first form: |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 509 | [text]{white}{vi:|vim:|ex:}[white]{options} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 510 | |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 511 | [text] any text or empty |
| 512 | {white} at least one blank character (<Space> or <Tab>) |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 513 | {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 514 | [white] optional white space |
| 515 | {options} a list of option settings, separated with white space |
| 516 | or ':', where each part between ':' is the argument |
| 517 | for a ":set" command (can be empty) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 518 | |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 519 | Examples: |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 520 | vi:noai:sw=3 ts=6 ~ |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 521 | vim: tw=77 ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 522 | |
| 523 | The second form (this is compatible with some versions of Vi): |
| 524 | |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 525 | [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 526 | |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 527 | [text] any text or empty |
| 528 | {white} at least one blank character (<Space> or <Tab>) |
| 529 | {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:" |
| 530 | [white] optional white space |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 531 | se[t] the string "set " or "se " (note the space); When |
| 532 | "Vim" is used it must be "set". |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 533 | {options} a list of options, separated with white space, which |
| 534 | is the argument for a ":set" command |
| 535 | : a colon |
| 536 | [text] any text or empty |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 537 | |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 538 | Examples: |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 539 | /* vim: set ai tw=75: */ ~ |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 540 | /* Vim: set ai tw=75: */ ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 541 | |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 542 | The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the |
| 543 | chance that a normal word like "lex:" is caught. There is one exception: |
| 544 | "vi:" and "vim:" can also be at the start of the line (for compatibility with |
| 545 | version 3.0). Using "ex:" at the start of the line will be ignored (this |
| 546 | could be short for "example:"). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 547 | |
| 548 | *modeline-local* |
| 549 | 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] | 550 | buffer and window that contain the file. Although it's possible to set global |
| 551 | options from a modeline, this is unusual. If you have two windows open and |
| 552 | the files in it set the same global option to a different value, the result |
| 553 | depends on which one was opened last. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 554 | |
Bram Moolenaar | 15d0a8c | 2004-09-06 17:44:46 +0000 | [diff] [blame] | 555 | When editing a file that was already loaded, only the window-local options |
| 556 | from the modeline are used. Thus if you manually changed a buffer-local |
| 557 | option after opening the file, it won't be changed if you edit the same buffer |
| 558 | in another window. But window-local options will be set. |
| 559 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 560 | *modeline-version* |
| 561 | If the modeline is only to be used for some versions of Vim, the version |
Bram Moolenaar | 22dbc77 | 2013-06-28 18:44:48 +0200 | [diff] [blame] | 562 | number can be specified where "vim:" or "Vim:" is used: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 563 | vim{vers}: version {vers} or later |
| 564 | vim<{vers}: version before {vers} |
| 565 | vim={vers}: version {vers} |
| 566 | vim>{vers}: version after {vers} |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 567 | {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
| 568 | For example, to use a modeline only for Vim 7.0: |
| 569 | /* vim700: set foldmethod=marker */ ~ |
| 570 | To use a modeline for Vim after version 7.2: |
| 571 | /* vim>702: set cole=2: */ ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 572 | There can be no blanks between "vim" and the ":". |
| 573 | |
| 574 | |
| 575 | The number of lines that are checked can be set with the 'modelines' option. |
| 576 | If 'modeline' is off or 'modelines' is 0 no lines are checked. |
| 577 | |
| 578 | Note that for the first form all of the rest of the line is used, thus a line |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 579 | like: |
| 580 | /* vi:ts=4: */ ~ |
| 581 | will give an error message for the trailing "*/". This line is OK: |
| 582 | /* vi:set ts=4: */ ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 583 | |
| 584 | If an error is detected the rest of the line is skipped. |
| 585 | |
| 586 | If you want to include a ':' in a set command precede it with a '\'. The |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 587 | backslash in front of the ':' will be removed. Example: |
| 588 | /* vi:set dir=c\:\tmp: */ ~ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 589 | This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
| 590 | ':' is removed. Thus to include "\:" you have to specify "\\:". |
| 591 | |
| 592 | No other commands than "set" are supported, for security reasons (somebody |
Bram Moolenaar | 8243a79 | 2007-05-01 17:05:03 +0000 | [diff] [blame] | 593 | might create a Trojan horse text file with modelines). And not all options |
| 594 | can be set. For some options a flag is set, so that when it's used the |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 595 | |sandbox| is effective. Still, there is always a small risk that a modeline |
Bram Moolenaar | 8243a79 | 2007-05-01 17:05:03 +0000 | [diff] [blame] | 596 | causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines |
| 597 | are wrapped unexpectedly. So disable modelines before editing untrusted text. |
| 598 | The mail ftplugin does this, for example. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 599 | |
| 600 | Hint: If you would like to do something else than setting an option, you could |
| 601 | define an autocommand that checks the file for a specific string. For |
| 602 | example: > |
| 603 | au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif |
| 604 | And define a function SetVar() that does something with the line containing |
| 605 | "VAR". |
| 606 | |
| 607 | ============================================================================== |
| 608 | 3. Options summary *option-summary* |
| 609 | |
| 610 | In the list below all the options are mentioned with their full name and with |
| 611 | an abbreviation if there is one. Both forms may be used. |
| 612 | |
| 613 | In this document when a boolean option is "set" that means that ":set option" |
| 614 | is entered. When an option is "reset", ":set nooption" is used. |
| 615 | |
| 616 | For some options there are two default values: The "Vim default", which is |
| 617 | used when 'compatible' is not set, and the "Vi default", which is used when |
| 618 | 'compatible' is set. |
| 619 | |
| 620 | 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] | 621 | 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] | 622 | different value in each window. For example the 'list' option can be set in |
| 623 | one window and reset in another for the same text, giving both types of view |
| 624 | at the same time. There are a few options that are specific to a certain |
| 625 | file. These can have a different value for each file or buffer. For example |
| 626 | the 'textwidth' option can be 78 for a normal text file and 0 for a C |
| 627 | program. |
| 628 | |
| 629 | global one option for all buffers and windows |
| 630 | local to window each window has its own copy of this option |
| 631 | local to buffer each buffer has its own copy of this option |
| 632 | |
| 633 | When creating a new window the option values from the currently active window |
| 634 | are used as a default value for the window-specific options. For the |
| 635 | buffer-specific options this depends on the 's' and 'S' flags in the |
| 636 | 'cpoptions' option. If 's' is included (which is the default) the values for |
| 637 | 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] | 638 | first entered. If 'S' is present the options are copied each time the buffer |
| 639 | 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] | 640 | present, the options are copied from the currently active buffer when the |
| 641 | buffer is created. |
| 642 | |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 643 | Hidden options *hidden-options* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 644 | |
Bram Moolenaar | 578b49e | 2005-09-10 19:22:57 +0000 | [diff] [blame] | 645 | Not all options are supported in all versions. This depends on the supported |
| 646 | features and sometimes on the system. A remark about this is in curly braces |
| 647 | below. When an option is not supported it may still be set without getting an |
| 648 | error, this is called a hidden option. You can't get the value of a hidden |
| 649 | option though, it is not stored. |
| 650 | |
| 651 | To test if option "foo" can be used with ":set" use something like this: > |
| 652 | if exists('&foo') |
| 653 | This also returns true for a hidden option. To test if option "foo" is really |
| 654 | supported use something like this: > |
| 655 | if exists('+foo') |
| 656 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 657 | *E355* |
| 658 | A jump table for the options with a short description can be found at |Q_op|. |
| 659 | |
| 660 | *'aleph'* *'al'* *aleph* *Aleph* |
| 661 | 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) |
| 662 | global |
| 663 | {not in Vi} |
| 664 | {only available when compiled with the |+rightleft| |
| 665 | feature} |
| 666 | The ASCII code for the first letter of the Hebrew alphabet. The |
| 667 | routine that maps the keyboard in Hebrew mode, both in Insert mode |
| 668 | (when hkmap is set) and on the command-line (when hitting CTRL-_) |
| 669 | outputs the Hebrew characters in the range [aleph..aleph+26]. |
| 670 | aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. |
| 671 | See |rileft.txt|. |
| 672 | |
| 673 | *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* |
| 674 | 'allowrevins' 'ari' boolean (default off) |
| 675 | global |
| 676 | {not in Vi} |
| 677 | {only available when compiled with the |+rightleft| |
| 678 | feature} |
| 679 | Allow CTRL-_ in Insert and Command-line mode. This is default off, to |
| 680 | avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get |
| 681 | into reverse Insert mode, and don't know how to get out. See |
| 682 | 'revins'. |
| 683 | NOTE: This option is reset when 'compatible' is set. |
| 684 | |
| 685 | *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* |
| 686 | 'altkeymap' 'akm' boolean (default off) |
| 687 | global |
| 688 | {not in Vi} |
| 689 | {only available when compiled with the |+farsi| |
| 690 | feature} |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 691 | When on, the second language is Farsi. In editing mode CTRL-_ toggles |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 692 | the keyboard map between Farsi and English, when 'allowrevins' set. |
| 693 | |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 694 | When off, the keyboard map toggles between Hebrew and English. This |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 695 | is useful to start the Vim in native mode i.e. English (left-to-right |
| 696 | mode) and have default second language Farsi or Hebrew (right-to-left |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 697 | mode). See |farsi.txt|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 698 | |
| 699 | *'ambiwidth'* *'ambw'* |
| 700 | 'ambiwidth' 'ambw' string (default: "single") |
| 701 | global |
| 702 | {not in Vi} |
| 703 | {only available when compiled with the |+multi_byte| |
| 704 | feature} |
| 705 | Only effective when 'encoding' is "utf-8" or another Unicode encoding. |
| 706 | Tells Vim what to do with characters with East Asian Width Class |
| 707 | Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek |
| 708 | letters, Cyrillic letters). |
| 709 | |
| 710 | There are currently two possible values: |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 711 | "single": Use the same width as characters in US-ASCII. This is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 712 | expected by most users. |
| 713 | "double": Use twice the width of ASCII characters. |
Bram Moolenaar | 5c3bd0a | 2010-08-04 20:55:44 +0200 | [diff] [blame] | 714 | *E834* *E835* |
| 715 | The value "double" cannot be used if 'listchars' or 'fillchars' |
| 716 | contains a character that would be double width. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 717 | |
| 718 | There are a number of CJK fonts for which the width of glyphs for |
| 719 | those characters are solely based on how many octets they take in |
| 720 | legacy/traditional CJK encodings. In those encodings, Euro, |
| 721 | Registered sign, Greek/Cyrillic letters are represented by two octets, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 722 | therefore those fonts have "wide" glyphs for them. This is also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 723 | true of some line drawing characters used to make tables in text |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 724 | file. Therefore, when a CJK font is used for GUI Vim or |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 725 | Vim is running inside a terminal (emulators) that uses a CJK font |
| 726 | (or Vim is run inside an xterm invoked with "-cjkwidth" option.), |
| 727 | this option should be set to "double" to match the width perceived |
| 728 | by Vim with the width of glyphs in the font. Perhaps it also has |
| 729 | to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP |
| 730 | when the system locale is set to one of CJK locales. See Unicode |
| 731 | Standard Annex #11 (http://www.unicode.org/reports/tr11). |
| 732 | |
Bram Moolenaar | ac7bd63 | 2013-03-19 11:35:58 +0100 | [diff] [blame] | 733 | Vim may set this option automatically at startup time when Vim is |
| 734 | compiled with the |+termresponse| feature and if |t_u7| is set to the |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 735 | escape sequence to request cursor position report. The response can |
| 736 | be found in |v:termu7resp|. |
Bram Moolenaar | ac7bd63 | 2013-03-19 11:35:58 +0100 | [diff] [blame] | 737 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 738 | *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 739 | 'antialias' 'anti' boolean (default: off) |
| 740 | global |
| 741 | {not in Vi} |
| 742 | {only available when compiled with GUI enabled |
| 743 | on Mac OS X} |
| 744 | This option only has an effect in the GUI version of Vim on Mac OS X |
| 745 | v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, |
| 746 | which can be easier to read at certain sizes on certain displays. |
| 747 | Setting this option can sometimes cause problems if 'guifont' is set |
| 748 | to its default (empty string). |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 749 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 750 | |
| 751 | *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* |
| 752 | 'autochdir' 'acd' boolean (default off) |
| 753 | global |
| 754 | {not in Vi} |
Bram Moolenaar | 00a927d | 2010-05-14 23:24:24 +0200 | [diff] [blame] | 755 | {only available when compiled with it, use |
| 756 | exists("+autochdir") to check} |
Bram Moolenaar | d8c0087 | 2005-07-22 21:52:15 +0000 | [diff] [blame] | 757 | When on, Vim will change the current working directory whenever you |
| 758 | open a file, switch buffers, delete a buffer or open/close a window. |
| 759 | It will change to the directory containing the file which was opened |
| 760 | or selected. |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 761 | Note: When this option is on some plugins may not work. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 762 | |
| 763 | *'arabic'* *'arab'* *'noarabic'* *'noarab'* |
| 764 | 'arabic' 'arab' boolean (default off) |
| 765 | local to window |
| 766 | {not in Vi} |
| 767 | {only available when compiled with the |+arabic| |
| 768 | feature} |
| 769 | This option can be set to start editing Arabic text. |
| 770 | Setting this option will: |
| 771 | - Set the 'rightleft' option, unless 'termbidi' is set. |
| 772 | - Set the 'arabicshape' option, unless 'termbidi' is set. |
| 773 | - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles |
| 774 | between typing English and Arabic key mapping. |
| 775 | - Set the 'delcombine' option |
| 776 | Note that 'encoding' must be "utf-8" for working with Arabic text. |
| 777 | |
| 778 | Resetting this option will: |
| 779 | - Reset the 'rightleft' option. |
| 780 | - Disable the use of 'keymap' (without changing its value). |
| 781 | Note that 'arabicshape' and 'delcombine' are not reset (it is a global |
Bram Moolenaar | c873442 | 2012-06-01 22:38:45 +0200 | [diff] [blame] | 782 | option). |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 783 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 784 | Also see |arabic.txt|. |
| 785 | |
| 786 | *'arabicshape'* *'arshape'* |
| 787 | *'noarabicshape'* *'noarshape'* |
| 788 | 'arabicshape' 'arshape' boolean (default on) |
| 789 | global |
| 790 | {not in Vi} |
| 791 | {only available when compiled with the |+arabic| |
| 792 | feature} |
| 793 | When on and 'termbidi' is off, the required visual character |
| 794 | corrections that need to take place for displaying the Arabic language |
Bram Moolenaar | 3a0d809 | 2012-10-21 03:02:54 +0200 | [diff] [blame] | 795 | take effect. Shaping, in essence, gets enabled; the term is a broad |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 796 | one which encompasses: |
| 797 | a) the changing/morphing of characters based on their location |
| 798 | within a word (initial, medial, final and stand-alone). |
| 799 | b) the enabling of the ability to compose characters |
| 800 | c) the enabling of the required combining of some characters |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 801 | When disabled the display shows each character's true stand-alone |
| 802 | form. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 803 | Arabic is a complex language which requires other settings, for |
| 804 | further details see |arabic.txt|. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 805 | NOTE: This option is set when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 806 | |
| 807 | *'autoindent'* *'ai'* *'noautoindent'* *'noai'* |
| 808 | 'autoindent' 'ai' boolean (default off) |
| 809 | local to buffer |
| 810 | Copy indent from current line when starting a new line (typing <CR> |
| 811 | in Insert mode or when using the "o" or "O" command). If you do not |
| 812 | type anything on the new line except <BS> or CTRL-D and then type |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 813 | <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
| 814 | to another line has the same effect, unless the 'I' flag is included |
| 815 | in 'cpoptions'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 816 | When autoindent is on, formatting (with the "gq" command or when you |
| 817 | reach 'textwidth' in Insert mode) uses the indentation of the first |
| 818 | line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 819 | When 'smartindent' or 'cindent' is on the indent is changed in |
| 820 | a different way. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 821 | The 'autoindent' option is reset when the 'paste' option is set and |
| 822 | restored when 'paste' is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 823 | {small difference from Vi: After the indent is deleted when typing |
| 824 | <Esc> or <CR>, the cursor position when moving up or down is after the |
| 825 | deleted indent; Vi puts the cursor somewhere in the deleted indent}. |
| 826 | |
| 827 | *'autoread'* *'ar'* *'noautoread'* *'noar'* |
| 828 | 'autoread' 'ar' boolean (default off) |
| 829 | global or local to buffer |global-local| |
| 830 | {not in Vi} |
| 831 | When a file has been detected to have been changed outside of Vim and |
| 832 | it has not been changed inside of Vim, automatically read it again. |
| 833 | When the file has been deleted this is not done. |timestamp| |
| 834 | If this option has a local value, use this command to switch back to |
| 835 | using the global value: > |
| 836 | :set autoread< |
| 837 | < |
| 838 | *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* |
| 839 | 'autowrite' 'aw' boolean (default off) |
| 840 | global |
| 841 | Write the contents of the file, if it has been modified, on each |
| 842 | :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, |
Bram Moolenaar | 1471681 | 2006-05-04 21:54:08 +0000 | [diff] [blame] | 843 | :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 844 | '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
| 845 | Note that for some commands the 'autowrite' option is not used, see |
| 846 | 'autowriteall' for that. |
| 847 | |
| 848 | *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* |
| 849 | 'autowriteall' 'awa' boolean (default off) |
| 850 | global |
| 851 | {not in Vi} |
| 852 | Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", |
| 853 | ":qall", ":exit", ":xit", ":recover" and closing the Vim window. |
| 854 | Setting this option also implies that Vim behaves like 'autowrite' has |
| 855 | been set. |
| 856 | |
| 857 | *'background'* *'bg'* |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 858 | 'background' 'bg' string (default "dark" or "light", see below) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 859 | global |
| 860 | {not in Vi} |
| 861 | When set to "dark", Vim will try to use colors that look good on a |
| 862 | dark background. When set to "light", Vim will try to use colors that |
| 863 | look good on a light background. Any other value is illegal. |
| 864 | Vim tries to set the default value according to the terminal used. |
| 865 | This will not always be correct. |
| 866 | Setting this option does not change the background color, it tells Vim |
| 867 | what the background color looks like. For changing the background |
| 868 | color, see |:hi-normal|. |
| 869 | |
| 870 | When 'background' is set Vim will adjust the default color groups for |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 871 | the new value. But the colors used for syntax highlighting will not |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 872 | change. *g:colors_name* |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 873 | When a color scheme is loaded (the "g:colors_name" variable is set) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 874 | setting 'background' will cause the color scheme to be reloaded. If |
| 875 | the color scheme adjusts to the value of 'background' this will work. |
| 876 | However, if the color scheme sets 'background' itself the effect may |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 877 | be undone. First delete the "g:colors_name" variable when needed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 878 | |
| 879 | When setting 'background' to the default value with: > |
| 880 | :set background& |
| 881 | < Vim will guess the value. In the GUI this should work correctly, |
| 882 | in other cases Vim might not be able to guess the right value. |
| 883 | |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 884 | When the |t_RB| option is set, Vim will use it to request the background |
Bram Moolenaar | b4d6c3e | 2017-05-27 16:45:17 +0200 | [diff] [blame] | 885 | color from the terminal. If the returned RGB value is dark/light and |
| 886 | 'background' is not dark/light, 'background' will be set and the |
| 887 | screen is redrawn. This may have side effects, make t_BG empty in |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 888 | your .vimrc if you suspect this problem. The response to |t_RB| can |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 889 | be found in |v:termrbgresp|. |
Bram Moolenaar | b4d6c3e | 2017-05-27 16:45:17 +0200 | [diff] [blame] | 890 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 891 | When starting the GUI, the default value for 'background' will be |
| 892 | "light". When the value is not set in the .gvimrc, and Vim detects |
| 893 | that the background is actually quite dark, 'background' is set to |
| 894 | "dark". But this happens only AFTER the .gvimrc file has been read |
| 895 | (because the window needs to be opened to find the actual background |
| 896 | color). To get around this, force the GUI window to be opened by |
| 897 | putting a ":gui" command in the .gvimrc file, before where the value |
| 898 | of 'background' is used (e.g., before ":syntax on"). |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 899 | |
| 900 | For MS-DOS, Windows and OS/2 the default is "dark". |
| 901 | For other systems "dark" is used when 'term' is "linux", |
| 902 | "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark |
| 903 | background. Otherwise the default is "light". |
| 904 | |
Bram Moolenaar | c572da5 | 2017-08-27 16:52:01 +0200 | [diff] [blame] | 905 | The |:terminal| command and the |term_start()| function use the |
| 906 | 'background' value to decide whether the terminal window will start |
| 907 | with a white or black background. |
| 908 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 909 | Normally this option would be set in the .vimrc file. Possibly |
| 910 | depending on the terminal name. Example: > |
| 911 | :if &term == "pcterm" |
| 912 | : set background=dark |
| 913 | :endif |
| 914 | < When this option is set, the default settings for the highlight groups |
| 915 | will change. To use other settings, place ":highlight" commands AFTER |
| 916 | the setting of the 'background' option. |
| 917 | This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file |
| 918 | to select the colors for syntax highlighting. After changing this |
| 919 | option, you must load syntax.vim again to see the result. This can be |
| 920 | done with ":syntax on". |
| 921 | |
| 922 | *'backspace'* *'bs'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 923 | 'backspace' 'bs' string (default "", set to "indent,eol,start" |
| 924 | in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 925 | global |
| 926 | {not in Vi} |
| 927 | Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert |
| 928 | mode. This is a list of items, separated by commas. Each item allows |
| 929 | a way to backspace over something: |
| 930 | value effect ~ |
| 931 | indent allow backspacing over autoindent |
| 932 | eol allow backspacing over line breaks (join lines) |
| 933 | start allow backspacing over the start of insert; CTRL-W and CTRL-U |
| 934 | stop once at the start of insert. |
| 935 | |
| 936 | When the value is empty, Vi compatible backspacing is used. |
| 937 | |
| 938 | For backwards compatibility with version 5.4 and earlier: |
| 939 | value effect ~ |
| 940 | 0 same as ":set backspace=" (Vi compatible) |
| 941 | 1 same as ":set backspace=indent,eol" |
| 942 | 2 same as ":set backspace=indent,eol,start" |
| 943 | |
| 944 | See |:fixdel| if your <BS> or <Del> key does not do what you want. |
| 945 | NOTE: This option is set to "" when 'compatible' is set. |
| 946 | |
| 947 | *'backup'* *'bk'* *'nobackup'* *'nobk'* |
| 948 | 'backup' 'bk' boolean (default off) |
| 949 | global |
| 950 | {not in Vi} |
| 951 | Make a backup before overwriting a file. Leave it around after the |
| 952 | file has been successfully written. If you do not want to keep the |
| 953 | backup file, but you do want a backup while the file is being |
| 954 | written, reset this option and set the 'writebackup' option (this is |
| 955 | 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] | 956 | options (use this if your file system is almost full). See the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 957 | |backup-table| for more explanations. |
| 958 | When the 'backupskip' pattern matches, a backup is not made anyway. |
| 959 | When 'patchmode' is set, the backup may be renamed to become the |
| 960 | oldest version of a file. |
| 961 | NOTE: This option is reset when 'compatible' is set. |
| 962 | |
| 963 | *'backupcopy'* *'bkc'* |
| 964 | 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") |
Bram Moolenaar | b8ee25a | 2014-09-23 15:45:08 +0200 | [diff] [blame] | 965 | global or local to buffer |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 966 | {not in Vi} |
| 967 | When writing a file and a backup is made, this option tells how it's |
| 968 | done. This is a comma separated list of words. |
| 969 | |
| 970 | The main values are: |
| 971 | "yes" make a copy of the file and overwrite the original one |
| 972 | "no" rename the file and write a new one |
| 973 | "auto" one of the previous, what works best |
| 974 | |
| 975 | Extra values that can be combined with the ones above are: |
| 976 | "breaksymlink" always break symlinks when writing |
| 977 | "breakhardlink" always break hardlinks when writing |
| 978 | |
| 979 | Making a copy and overwriting the original file: |
| 980 | - Takes extra time to copy the file. |
| 981 | + When the file has special attributes, is a (hard/symbolic) link or |
| 982 | has a resource fork, all this is preserved. |
| 983 | - When the file is a link the backup will have the name of the link, |
| 984 | not of the real file. |
| 985 | |
| 986 | Renaming the file and writing a new one: |
| 987 | + It's fast. |
| 988 | - Sometimes not all attributes of the file can be copied to the new |
| 989 | file. |
| 990 | - When the file is a link the new file will not be a link. |
| 991 | |
| 992 | The "auto" value is the middle way: When Vim sees that renaming file |
| 993 | is possible without side effects (the attributes can be passed on and |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 994 | the file is not a link) that is used. When problems are expected, a |
| 995 | copy will be made. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 996 | |
| 997 | The "breaksymlink" and "breakhardlink" values can be used in |
| 998 | combination with any of "yes", "no" and "auto". When included, they |
| 999 | force Vim to always break either symbolic or hard links by doing |
| 1000 | exactly what the "no" option does, renaming the original file to |
| 1001 | become the backup and writing a new file in its place. This can be |
| 1002 | useful for example in source trees where all the files are symbolic or |
| 1003 | hard links and any changes should stay in the local source tree, not |
| 1004 | be propagated back to the original source. |
| 1005 | *crontab* |
| 1006 | One situation where "no" and "auto" will cause problems: A program |
| 1007 | that opens a file, invokes Vim to edit that file, and then tests if |
| 1008 | the open file was changed (through the file descriptor) will check the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1009 | backup file instead of the newly created file. "crontab -e" is an |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1010 | example. |
| 1011 | |
| 1012 | When a copy is made, the original file is truncated and then filled |
| 1013 | with the new text. This means that protection bits, owner and |
| 1014 | symbolic links of the original file are unmodified. The backup file |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 1015 | 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] | 1016 | group of the backup is set to the group of the original file. If this |
| 1017 | fails, the protection bits for the group are made the same as for |
| 1018 | others. |
| 1019 | |
| 1020 | When the file is renamed this is the other way around: The backup has |
| 1021 | the same attributes of the original file, and the newly written file |
| 1022 | is owned by the current user. When the file was a (hard/symbolic) |
| 1023 | link, the new file will not! That's why the "auto" value doesn't |
| 1024 | rename when the file is a link. The owner and group of the newly |
| 1025 | written file will be set to the same ones as the original file, but |
| 1026 | the system may refuse to do this. In that case the "auto" value will |
| 1027 | again not rename the file. |
| 1028 | |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1029 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 1030 | set and to the Vim default value when 'compatible' is reset. |
| 1031 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1032 | *'backupdir'* *'bdir'* |
| 1033 | 'backupdir' 'bdir' string (default for Amiga: ".,t:", |
Bram Moolenaar | dfb1841 | 2013-12-11 18:53:29 +0100 | [diff] [blame] | 1034 | for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1035 | for Unix: ".,~/tmp,~/") |
| 1036 | global |
| 1037 | {not in Vi} |
| 1038 | List of directories for the backup file, separated with commas. |
| 1039 | - The backup file will be created in the first directory in the list |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1040 | where this is possible. The directory must exist, Vim will not |
| 1041 | create it for you. |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 1042 | - Empty means that no backup file will be created ('patchmode' is |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1043 | impossible!). Writing may fail because of this. |
| 1044 | - A directory "." means to put the backup file in the same directory |
| 1045 | as the edited file. |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 1046 | - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1047 | put the backup file relative to where the edited file is. The |
| 1048 | leading "." is replaced with the path name of the edited file. |
| 1049 | ("." inside a directory name has no special meaning). |
| 1050 | - Spaces after the comma are ignored, other spaces are considered part |
| 1051 | of the directory name. To have a space at the start of a directory |
| 1052 | name, precede it with a backslash. |
| 1053 | - To include a comma in a directory name precede it with a backslash. |
| 1054 | - A directory name may end in an '/'. |
| 1055 | - Environment variables are expanded |:set_env|. |
| 1056 | - Careful with '\' characters, type one before a space, type two to |
| 1057 | get one in the option (see |option-backslash|), for example: > |
| 1058 | :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces |
| 1059 | < - For backwards compatibility with Vim version 3.0 a '>' at the start |
| 1060 | of the option is removed. |
| 1061 | See also 'backup' and 'writebackup' options. |
| 1062 | If you want to hide your backup files on Unix, consider this value: > |
| 1063 | :set backupdir=./.backup,~/.backup,.,/tmp |
| 1064 | < You must create a ".backup" directory in each directory and in your |
| 1065 | home directory for this to work properly. |
| 1066 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 1067 | directories from the list. This avoids problems when a future version |
| 1068 | uses another default. |
| 1069 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1070 | security reasons. |
| 1071 | |
| 1072 | *'backupext'* *'bex'* *E589* |
| 1073 | 'backupext' 'bex' string (default "~", for VMS: "_") |
| 1074 | global |
| 1075 | {not in Vi} |
| 1076 | String which is appended to a file name to make the name of the |
| 1077 | backup file. The default is quite unusual, because this avoids |
| 1078 | accidentally overwriting existing files with a backup file. You might |
| 1079 | prefer using ".bak", but make sure that you don't have files with |
| 1080 | ".bak" that you want to keep. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 1081 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1082 | |
Bram Moolenaar | 3fdfa4a | 2004-10-07 21:02:47 +0000 | [diff] [blame] | 1083 | If you like to keep a lot of backups, you could use a BufWritePre |
| 1084 | autocommand to change 'backupext' just before writing the file to |
| 1085 | include a timestamp. > |
| 1086 | :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' |
| 1087 | < Use 'backupdir' to put the backup in a different directory. |
| 1088 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1089 | *'backupskip'* *'bsk'* |
Bram Moolenaar | b8e22a0 | 2018-04-12 21:37:34 +0200 | [diff] [blame] | 1090 | 'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*" |
| 1091 | Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*" |
| 1092 | Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1093 | global |
| 1094 | {not in Vi} |
| 1095 | {not available when compiled without the |+wildignore| |
| 1096 | feature} |
| 1097 | A list of file patterns. When one of the patterns matches with the |
| 1098 | name of the file which is written, no backup file is created. Both |
| 1099 | the specified file name and the full path name of the file are used. |
| 1100 | The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 1101 | Watch out for special characters, see |option-backslash|. |
| 1102 | 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] | 1103 | default value. "/tmp/*" is only used for Unix. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1104 | |
Bram Moolenaar | 1aeaf8c | 2012-05-18 13:46:39 +0200 | [diff] [blame] | 1105 | WARNING: Not having a backup file means that when Vim fails to write |
| 1106 | your buffer correctly and then, for whatever reason, Vim exits, you |
| 1107 | lose both the original file and what you were writing. Only disable |
| 1108 | backups if you don't care about losing the file. |
| 1109 | |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1110 | Note that environment variables are not expanded. If you want to use |
| 1111 | $HOME you must expand it explicitly, e.g.: > |
Bram Moolenaar | 7c1c6db | 2016-04-03 22:08:05 +0200 | [diff] [blame] | 1112 | :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*' |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1113 | |
| 1114 | < Note that the default also makes sure that "crontab -e" works (when a |
Bram Moolenaar | a5792f5 | 2005-11-23 21:25:05 +0000 | [diff] [blame] | 1115 | backup would be made by renaming the original file crontab won't see |
| 1116 | the newly created file). Also see 'backupcopy' and |crontab|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1117 | |
| 1118 | *'balloondelay'* *'bdlay'* |
| 1119 | 'balloondelay' 'bdlay' number (default: 600) |
| 1120 | global |
| 1121 | {not in Vi} |
| 1122 | {only available when compiled with the |+balloon_eval| |
| 1123 | feature} |
| 1124 | Delay in milliseconds before a balloon may pop up. See |balloon-eval|. |
| 1125 | |
| 1126 | *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* |
| 1127 | 'ballooneval' 'beval' boolean (default off) |
| 1128 | global |
| 1129 | {not in Vi} |
| 1130 | {only available when compiled with the |+balloon_eval| |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1131 | feature} |
Bram Moolenaar | 51b0f37 | 2017-11-18 18:52:04 +0100 | [diff] [blame] | 1132 | Switch on the |balloon-eval| functionality for the GUI. |
| 1133 | |
| 1134 | *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'* |
| 1135 | *'nobevalterm'* |
| 1136 | 'balloonevalterm' 'bevalterm' boolean (default off) |
| 1137 | global |
| 1138 | {not in Vi} |
| 1139 | {only available when compiled with the |
| 1140 | |+balloon_eval_term| feature} |
| 1141 | Switch on the |balloon-eval| functionality for the terminal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1142 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1143 | *'balloonexpr'* *'bexpr'* |
| 1144 | 'balloonexpr' 'bexpr' string (default "") |
Bram Moolenaar | 9b2200a | 2006-03-20 21:55:45 +0000 | [diff] [blame] | 1145 | global or local to buffer |global-local| |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1146 | {not in Vi} |
| 1147 | {only available when compiled with the |+balloon_eval| |
| 1148 | feature} |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 1149 | Expression for text to show in evaluation balloon. It is only used |
| 1150 | when 'ballooneval' is on. These variables can be used: |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1151 | |
| 1152 | v:beval_bufnr number of the buffer in which balloon is going to show |
| 1153 | v:beval_winnr number of the window |
Bram Moolenaar | 82af871 | 2016-06-04 20:20:29 +0200 | [diff] [blame] | 1154 | v:beval_winid ID of the window |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1155 | v:beval_lnum line number |
| 1156 | v:beval_col column number (byte index) |
| 1157 | v:beval_text word under or after the mouse pointer |
| 1158 | |
| 1159 | The evaluation of the expression must not have side effects! |
| 1160 | Example: > |
| 1161 | function! MyBalloonExpr() |
Bram Moolenaar | 4536002 | 2005-07-21 21:08:21 +0000 | [diff] [blame] | 1162 | return 'Cursor is at line ' . v:beval_lnum . |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1163 | \', column ' . v:beval_col . |
| 1164 | \ ' of file ' . bufname(v:beval_bufnr) . |
| 1165 | \ ' on word "' . v:beval_text . '"' |
| 1166 | endfunction |
| 1167 | set bexpr=MyBalloonExpr() |
| 1168 | set ballooneval |
| 1169 | < |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1170 | Also see |balloon_show()|, can be used if the content of the balloon |
| 1171 | is to be fetched asynchronously. |
| 1172 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 1173 | NOTE: The balloon is displayed only if the cursor is on a text |
| 1174 | character. If the result of evaluating 'balloonexpr' is not empty, |
| 1175 | Vim does not try to send a message to an external debugger (Netbeans |
| 1176 | or Sun Workshop). |
| 1177 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 1178 | The expression will be evaluated in the |sandbox| when set from a |
| 1179 | modeline, see |sandbox-option|. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 1180 | |
| 1181 | It is not allowed to change text or jump to another window while |
| 1182 | evaluating 'balloonexpr' |textlock|. |
| 1183 | |
Bram Moolenaar | 87e25fd | 2005-07-27 21:13:01 +0000 | [diff] [blame] | 1184 | 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] | 1185 | if has("balloon_multiline") |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 1186 | < When they are supported "\n" characters will start a new line. If the |
| 1187 | expression evaluates to a |List| this is equal to using each List item |
| 1188 | as a string and putting "\n" in between them. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1189 | NOTE: This option is set to "" when 'compatible' is set. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 1190 | |
Bram Moolenaar | 165bc69 | 2015-07-21 17:53:25 +0200 | [diff] [blame] | 1191 | *'belloff'* *'bo'* |
| 1192 | 'belloff' 'bo' string (default "") |
| 1193 | global |
| 1194 | {not in Vi} |
| 1195 | Specifies for which events the bell will not be rung. It is a comma |
| 1196 | separated list of items. For each item that is present, the bell |
| 1197 | will be silenced. This is most useful to specify specific events in |
| 1198 | insert mode to be silenced. |
| 1199 | |
| 1200 | item meaning when present ~ |
| 1201 | all All events. |
| 1202 | backspace When hitting <BS> or <Del> and deleting results in an |
| 1203 | error. |
| 1204 | cursor Fail to move around using the cursor keys or |
| 1205 | <PageUp>/<PageDown> in |Insert-mode|. |
| 1206 | complete Error occurred when using |i_CTRL-X_CTRL-K| or |
| 1207 | |i_CTRL-X_CTRL-T|. |
| 1208 | copy Cannot copy char from insert mode using |i_CTRL-Y| or |
| 1209 | |i_CTRL-E|. |
| 1210 | ctrlg Unknown Char after <C-G> in Insert mode. |
| 1211 | error Other Error occurred (e.g. try to join last line) |
| 1212 | (mostly used in |Normal-mode| or |Cmdline-mode|). |
| 1213 | esc hitting <Esc> in |Normal-mode|. |
| 1214 | ex In |Visual-mode|, hitting |Q| results in an error. |
| 1215 | hangul Error occurred when using hangul input. |
| 1216 | insertmode Pressing <Esc> in 'insertmode'. |
| 1217 | lang Calling the beep module for Lua/Mzscheme/TCL. |
| 1218 | mess No output available for |g<|. |
| 1219 | showmatch Error occurred for 'showmatch' function. |
| 1220 | operator Empty region error |cpo-E|. |
| 1221 | register Unknown register after <C-R> in |Insert-mode|. |
| 1222 | shell Bell from shell output |:!|. |
| 1223 | spell Error happened on spell suggest. |
| 1224 | wildmode More matches in |cmdline-completion| available |
| 1225 | (depends on the 'wildmode' setting). |
| 1226 | |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1227 | This is most useful to fine tune when in Insert mode the bell should |
| 1228 | be rung. For Normal mode and Ex commands, the bell is often rung to |
Bram Moolenaar | 165bc69 | 2015-07-21 17:53:25 +0200 | [diff] [blame] | 1229 | indicate that an error occurred. It can be silenced by adding the |
| 1230 | "error" keyword. |
| 1231 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1232 | *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1233 | 'binary' 'bin' boolean (default off) |
| 1234 | local to buffer |
| 1235 | {not in Vi} |
| 1236 | This option should be set before editing a binary file. You can also |
| 1237 | use the |-b| Vim argument. When this option is switched on a few |
| 1238 | options will be changed (also when it already was on): |
| 1239 | 'textwidth' will be set to 0 |
| 1240 | 'wrapmargin' will be set to 0 |
| 1241 | 'modeline' will be off |
| 1242 | 'expandtab' will be off |
| 1243 | Also, 'fileformat' and 'fileformats' options will not be used, the |
| 1244 | file is read and written like 'fileformat' was "unix" (a single <NL> |
| 1245 | separates lines). |
| 1246 | The 'fileencoding' and 'fileencodings' options will not be used, the |
| 1247 | file is read without conversion. |
| 1248 | NOTE: When you start editing a(nother) file while the 'bin' option is |
| 1249 | on, settings from autocommands may change the settings again (e.g., |
| 1250 | 'textwidth'), causing trouble when editing. You might want to set |
| 1251 | 'bin' again when the file has been loaded. |
| 1252 | The previous values of these options are remembered and restored when |
| 1253 | 'bin' is switched from on to off. Each buffer has its own set of |
| 1254 | saved option values. |
| 1255 | To edit a file with 'binary' set you can use the |++bin| argument. |
| 1256 | This avoids you have to do ":set bin", which would have effect for all |
| 1257 | files you edit. |
| 1258 | When writing a file the <EOL> for the last line is only written if |
| 1259 | there was one in the original file (normally Vim appends an <EOL> to |
| 1260 | the last line if there is none; this would make the file longer). See |
| 1261 | the 'endofline' option. |
| 1262 | |
| 1263 | *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* |
| 1264 | 'bioskey' 'biosk' boolean (default on) |
| 1265 | global |
| 1266 | {not in Vi} {only for MS-DOS} |
Bram Moolenaar | f391327 | 2016-02-25 00:00:01 +0100 | [diff] [blame] | 1267 | This was for MS-DOS and is no longer supported. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1268 | |
| 1269 | *'bomb'* *'nobomb'* |
| 1270 | 'bomb' boolean (default off) |
| 1271 | local to buffer |
| 1272 | {not in Vi} |
| 1273 | {only available when compiled with the |+multi_byte| |
| 1274 | feature} |
| 1275 | When writing a file and the following conditions are met, a BOM (Byte |
| 1276 | Order Mark) is prepended to the file: |
| 1277 | - this option is on |
| 1278 | - the 'binary' option is off |
| 1279 | - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big |
| 1280 | endian variants. |
| 1281 | Some applications use the BOM to recognize the encoding of the file. |
| 1282 | Often used for UCS-2 files on MS-Windows. For other applications it |
| 1283 | causes trouble, for example: "cat file1 file2" makes the BOM of file2 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 1284 | appear halfway the resulting file. Gcc doesn't accept a BOM. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1285 | When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1286 | check for the presence of the BOM is done and 'bomb' set accordingly. |
| 1287 | Unless 'binary' is set, it is removed from the first line, so that you |
| 1288 | don't see it when editing. When you don't change the options, the BOM |
| 1289 | will be restored when writing the file. |
| 1290 | |
| 1291 | *'breakat'* *'brk'* |
| 1292 | 'breakat' 'brk' string (default " ^I!@*-+;:,./?") |
| 1293 | global |
| 1294 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 1295 | {not available when compiled without the |+linebreak| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1296 | feature} |
| 1297 | This option lets you choose which characters might cause a line |
Bram Moolenaar | ac6e65f | 2005-08-29 22:25:38 +0000 | [diff] [blame] | 1298 | break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
| 1299 | characters when 'encoding' is an 8-bit encoding. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1300 | |
Bram Moolenaar | 7c1c6db | 2016-04-03 22:08:05 +0200 | [diff] [blame] | 1301 | *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 1302 | 'breakindent' 'bri' boolean (default off) |
| 1303 | local to window |
| 1304 | {not in Vi} |
| 1305 | {not available when compiled without the |+linebreak| |
| 1306 | feature} |
| 1307 | Every wrapped line will continue visually indented (same amount of |
| 1308 | space as the beginning of that line), thus preserving horizontal blocks |
| 1309 | of text. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1310 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 1311 | |
| 1312 | *'breakindentopt'* *'briopt'* |
| 1313 | 'breakindentopt' 'briopt' string (default empty) |
| 1314 | local to window |
| 1315 | {not in Vi} |
| 1316 | {not available when compiled without the |+linebreak| |
| 1317 | feature} |
| 1318 | Settings for 'breakindent'. It can consist of the following optional |
Bram Moolenaar | 86b17e9 | 2014-07-02 20:00:47 +0200 | [diff] [blame] | 1319 | items and must be separated by a comma: |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 1320 | min:{n} Minimum text width that will be kept after |
| 1321 | applying 'breakindent', even if the resulting |
| 1322 | text should normally be narrower. This prevents |
| 1323 | text indented almost to the right window border |
| 1324 | occupying lot of vertical space when broken. |
Bram Moolenaar | 86b17e9 | 2014-07-02 20:00:47 +0200 | [diff] [blame] | 1325 | shift:{n} After applying 'breakindent', the wrapped line's |
| 1326 | beginning will be shifted by the given number of |
| 1327 | characters. It permits dynamic French paragraph |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 1328 | indentation (negative) or emphasizing the line |
| 1329 | continuation (positive). |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 1330 | sbr Display the 'showbreak' value before applying the |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 1331 | additional indent. |
| 1332 | The default value for min is 20 and shift is 0. |
| 1333 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1334 | *'browsedir'* *'bsdir'* |
Bram Moolenaar | 7b0294c | 2004-10-11 10:16:09 +0000 | [diff] [blame] | 1335 | 'browsedir' 'bsdir' string (default: "last") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1336 | global |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1337 | {not in Vi} {only for Motif, Athena, GTK, Mac and |
| 1338 | Win32 GUI} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1339 | Which directory to use for the file browser: |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1340 | last Use same directory as with last file browser, where a |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 1341 | file was opened or saved. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1342 | buffer Use the directory of the related buffer. |
| 1343 | current Use the current directory. |
| 1344 | {path} Use the specified directory |
| 1345 | |
| 1346 | *'bufhidden'* *'bh'* |
| 1347 | 'bufhidden' 'bh' string (default: "") |
| 1348 | local to buffer |
| 1349 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1350 | This option specifies what happens when a buffer is no longer |
| 1351 | displayed in a window: |
| 1352 | <empty> follow the global 'hidden' option |
| 1353 | hide hide the buffer (don't unload it), also when 'hidden' |
| 1354 | is not set |
| 1355 | unload unload the buffer, also when 'hidden' is set or using |
| 1356 | |:hide| |
| 1357 | delete delete the buffer from the buffer list, also when |
| 1358 | 'hidden' is set or using |:hide|, like using |
| 1359 | |:bdelete| |
| 1360 | wipe wipe out the buffer from the buffer list, also when |
| 1361 | 'hidden' is set or using |:hide|, like using |
| 1362 | |:bwipeout| |
| 1363 | |
Bram Moolenaar | a14de3d | 2005-01-07 21:48:26 +0000 | [diff] [blame] | 1364 | CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 1365 | are lost without a warning. Also, these values may break autocommands |
| 1366 | that switch between buffers temporarily. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1367 | This option is used together with 'buftype' and 'swapfile' to specify |
| 1368 | special kinds of buffers. See |special-buffers|. |
| 1369 | |
| 1370 | *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* |
| 1371 | 'buflisted' 'bl' boolean (default: on) |
| 1372 | local to buffer |
| 1373 | {not in Vi} |
| 1374 | When this option is set, the buffer shows up in the buffer list. If |
| 1375 | it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. |
| 1376 | This option is reset by Vim for buffers that are only used to remember |
| 1377 | a file name or marks. Vim sets it when starting to edit a buffer. |
| 1378 | But not when moving to a buffer with ":buffer". |
| 1379 | |
| 1380 | *'buftype'* *'bt'* *E382* |
| 1381 | 'buftype' 'bt' string (default: "") |
| 1382 | local to buffer |
| 1383 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1384 | The value of this option specifies the type of a buffer: |
| 1385 | <empty> normal buffer |
| 1386 | nofile buffer which is not related to a file and will not be |
| 1387 | written |
| 1388 | nowrite buffer which will not be written |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 1389 | acwrite buffer which will always be written with BufWriteCmd |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 1390 | autocommands. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1391 | quickfix quickfix buffer, contains list of errors |:cwindow| |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 1392 | or list of locations |:lwindow| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1393 | help help buffer (you are not supposed to set this |
| 1394 | manually) |
Bram Moolenaar | 1f2903c | 2017-07-23 19:51:01 +0200 | [diff] [blame] | 1395 | terminal buffer for a |terminal| (you are not supposed to set |
| 1396 | this manually) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1397 | |
| 1398 | This option is used together with 'bufhidden' and 'swapfile' to |
| 1399 | specify special kinds of buffers. See |special-buffers|. |
| 1400 | |
| 1401 | Be careful with changing this option, it can have many side effects! |
| 1402 | |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 1403 | A "quickfix" buffer is only used for the error list and the location |
| 1404 | list. This value is set by the |:cwindow| and |:lwindow| commands and |
| 1405 | you are not supposed to change it. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1406 | |
| 1407 | "nofile" and "nowrite" buffers are similar: |
| 1408 | both: The buffer is not to be written to disk, ":w" doesn't |
| 1409 | work (":w filename" does work though). |
| 1410 | both: The buffer is never considered to be |'modified'|. |
| 1411 | There is no warning when the changes will be lost, for |
| 1412 | example when you quit Vim. |
| 1413 | both: A swap file is only created when using too much memory |
| 1414 | (when 'swapfile' has been reset there is never a swap |
| 1415 | file). |
| 1416 | nofile only: The buffer name is fixed, it is not handled like a |
| 1417 | file name. It is not modified in response to a |:cd| |
| 1418 | command. |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 1419 | both: When using ":e bufname" and already editing "bufname" |
| 1420 | the buffer is made empty and autocommands are |
| 1421 | triggered as usual for |:edit|. |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 1422 | *E676* |
| 1423 | "acwrite" implies that the buffer name is not related to a file, like |
| 1424 | "nofile", but it will be written. Thus, in contrast to "nofile" and |
| 1425 | "nowrite", ":w" does work and a modified buffer can't be abandoned |
| 1426 | without saving. For writing there must be matching |BufWriteCmd|, |
| 1427 | |FileWriteCmd| or |FileAppendCmd| autocommands. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1428 | |
| 1429 | *'casemap'* *'cmp'* |
| 1430 | 'casemap' 'cmp' string (default: "internal,keepascii") |
| 1431 | global |
| 1432 | {not in Vi} |
Bram Moolenaar | 2217cae | 2006-03-25 21:55:52 +0000 | [diff] [blame] | 1433 | {only available when compiled with the |+multi_byte| |
| 1434 | feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1435 | Specifies details about changing the case of letters. It may contain |
| 1436 | these words, separated by a comma: |
| 1437 | internal Use internal case mapping functions, the current |
| 1438 | locale does not change the case mapping. This only |
Bram Moolenaar | 6f16eb8 | 2005-08-23 21:02:42 +0000 | [diff] [blame] | 1439 | matters when 'encoding' is a Unicode encoding, |
| 1440 | "latin1" or "iso-8859-15". When "internal" is |
| 1441 | omitted, the towupper() and towlower() system library |
| 1442 | functions are used when available. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1443 | keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1444 | case mapping, the current locale is not effective. |
| 1445 | This probably only matters for Turkish. |
| 1446 | |
| 1447 | *'cdpath'* *'cd'* *E344* *E346* |
| 1448 | 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") |
| 1449 | global |
| 1450 | {not in Vi} |
| 1451 | {not available when compiled without the |
| 1452 | |+file_in_path| feature} |
| 1453 | This is a list of directories which will be searched when using the |
| 1454 | |:cd| and |:lcd| commands, provided that the directory being searched |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 1455 | for has a relative path, not an absolute part starting with "/", "./" |
| 1456 | or "../", the 'cdpath' option is not used then. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1457 | The 'cdpath' option's value has the same form and semantics as |
| 1458 | |'path'|. Also see |file-searching|. |
| 1459 | The default value is taken from $CDPATH, with a "," prepended to look |
| 1460 | in the current directory first. |
| 1461 | If the default value taken from $CDPATH is not what you want, include |
| 1462 | a modified version of the following command in your vimrc file to |
| 1463 | override it: > |
| 1464 | :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') |
| 1465 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1466 | security reasons. |
| 1467 | (parts of 'cdpath' can be passed to the shell to expand file names). |
| 1468 | |
| 1469 | *'cedit'* |
| 1470 | 'cedit' string (Vi default: "", Vim default: CTRL-F) |
| 1471 | global |
| 1472 | {not in Vi} |
| 1473 | {not available when compiled without the |+vertsplit| |
| 1474 | feature} |
| 1475 | The key used in Command-line Mode to open the command-line window. |
| 1476 | The default is CTRL-F when 'compatible' is off. |
| 1477 | Only non-printable keys are allowed. |
| 1478 | The key can be specified as a single character, but it is difficult to |
| 1479 | type. The preferred way is to use the <> notation. Examples: > |
Bram Moolenaar | e18dbe8 | 2016-07-02 21:42:23 +0200 | [diff] [blame] | 1480 | :exe "set cedit=\<C-Y>" |
| 1481 | :exe "set cedit=\<Esc>" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1482 | < |Nvi| also has this option, but it only uses the first character. |
| 1483 | See |cmdwin|. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1484 | NOTE: This option is set to the Vim default value when 'compatible' |
| 1485 | is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1486 | |
| 1487 | *'charconvert'* *'ccv'* *E202* *E214* *E513* |
| 1488 | 'charconvert' 'ccv' string (default "") |
| 1489 | global |
| 1490 | {only available when compiled with the |+multi_byte| |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 1491 | and |+eval| features} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1492 | {not in Vi} |
| 1493 | An expression that is used for character encoding conversion. It is |
| 1494 | evaluated when a file that is to be read or has been written has a |
| 1495 | different encoding from what is desired. |
| 1496 | 'charconvert' is not used when the internal iconv() function is |
| 1497 | supported and is able to do the conversion. Using iconv() is |
| 1498 | preferred, because it is much faster. |
| 1499 | 'charconvert' is not used when reading stdin |--|, because there is no |
| 1500 | file to convert from. You will have to save the text in a file first. |
| 1501 | The expression must return zero or an empty string for success, |
| 1502 | non-zero for failure. |
| 1503 | The possible encoding names encountered are in 'encoding'. |
| 1504 | Additionally, names given in 'fileencodings' and 'fileencoding' are |
| 1505 | used. |
| 1506 | Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" |
| 1507 | is done internally by Vim, 'charconvert' is not used for this. |
| 1508 | 'charconvert' is also used to convert the viminfo file, if the 'c' |
| 1509 | flag is present in 'viminfo'. Also used for Unicode conversion. |
| 1510 | Example: > |
| 1511 | set charconvert=CharConvert() |
| 1512 | fun CharConvert() |
| 1513 | system("recode " |
| 1514 | \ . v:charconvert_from . ".." . v:charconvert_to |
| 1515 | \ . " <" . v:fname_in . " >" v:fname_out) |
| 1516 | return v:shell_error |
| 1517 | endfun |
| 1518 | < The related Vim variables are: |
| 1519 | v:charconvert_from name of the current encoding |
| 1520 | v:charconvert_to name of the desired encoding |
| 1521 | v:fname_in name of the input file |
| 1522 | v:fname_out name of the output file |
| 1523 | Note that v:fname_in and v:fname_out will never be the same. |
| 1524 | Note that v:charconvert_from and v:charconvert_to may be different |
| 1525 | from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. |
| 1526 | Encryption is not done by Vim when using 'charconvert'. If you want |
| 1527 | to encrypt the file after conversion, 'charconvert' should take care |
| 1528 | of this. |
| 1529 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1530 | security reasons. |
| 1531 | |
| 1532 | *'cindent'* *'cin'* *'nocindent'* *'nocin'* |
| 1533 | 'cindent' 'cin' boolean (default off) |
| 1534 | local to buffer |
| 1535 | {not in Vi} |
| 1536 | {not available when compiled without the |+cindent| |
| 1537 | feature} |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 1538 | Enables automatic C program indenting. See 'cinkeys' to set the keys |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1539 | that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1540 | preferred indent style. |
| 1541 | If 'indentexpr' is not empty, it overrules 'cindent'. |
| 1542 | If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, |
| 1543 | the "=" operator indents using this algorithm rather than calling an |
| 1544 | external program. |
| 1545 | See |C-indenting|. |
| 1546 | When you don't like the way 'cindent' works, try the 'smartindent' |
| 1547 | option or 'indentexpr'. |
| 1548 | This option is not used when 'paste' is set. |
| 1549 | NOTE: This option is reset when 'compatible' is set. |
| 1550 | |
| 1551 | *'cinkeys'* *'cink'* |
| 1552 | 'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") |
| 1553 | local to buffer |
| 1554 | {not in Vi} |
| 1555 | {not available when compiled without the |+cindent| |
| 1556 | feature} |
| 1557 | A list of keys that, when typed in Insert mode, cause reindenting of |
| 1558 | the current line. Only used if 'cindent' is on and 'indentexpr' is |
| 1559 | empty. |
| 1560 | For the format of this option see |cinkeys-format|. |
| 1561 | See |C-indenting|. |
| 1562 | |
| 1563 | *'cinoptions'* *'cino'* |
| 1564 | 'cinoptions' 'cino' string (default "") |
| 1565 | local to buffer |
| 1566 | {not in Vi} |
| 1567 | {not available when compiled without the |+cindent| |
| 1568 | feature} |
| 1569 | The 'cinoptions' affect the way 'cindent' reindents lines in a C |
| 1570 | program. See |cinoptions-values| for the values of this option, and |
| 1571 | |C-indenting| for info on C indenting in general. |
| 1572 | |
| 1573 | |
| 1574 | *'cinwords'* *'cinw'* |
| 1575 | 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") |
| 1576 | local to buffer |
| 1577 | {not in Vi} |
| 1578 | {not available when compiled without both the |
| 1579 | |+cindent| and the |+smartindent| features} |
| 1580 | These keywords start an extra indent in the next line when |
| 1581 | 'smartindent' or 'cindent' is set. For 'cindent' this is only done at |
| 1582 | an appropriate place (inside {}). |
| 1583 | Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't |
| 1584 | matter, include the keyword both the uppercase and lowercase: |
| 1585 | "if,If,IF". |
| 1586 | |
| 1587 | *'clipboard'* *'cb'* |
| 1588 | 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" |
| 1589 | for X-windows, "" otherwise) |
| 1590 | global |
| 1591 | {not in Vi} |
| 1592 | {only in GUI versions or when the |+xterm_clipboard| |
| 1593 | feature is included} |
| 1594 | This option is a list of comma separated names. |
| 1595 | These names are recognized: |
| 1596 | |
Bram Moolenaar | c0885aa | 2012-07-10 16:49:23 +0200 | [diff] [blame] | 1597 | *clipboard-unnamed* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1598 | unnamed When included, Vim will use the clipboard register '*' |
| 1599 | for all yank, delete, change and put operations which |
| 1600 | would normally go to the unnamed register. When a |
| 1601 | register is explicitly specified, it will always be |
| 1602 | used regardless of whether "unnamed" is in 'clipboard' |
| 1603 | or not. The clipboard register can always be |
| 1604 | explicitly accessed using the "* notation. Also see |
| 1605 | |gui-clipboard|. |
| 1606 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 1607 | *clipboard-unnamedplus* |
Bram Moolenaar | 0015450 | 2013-02-13 16:15:55 +0100 | [diff] [blame] | 1608 | unnamedplus A variant of the "unnamed" flag which uses the |
| 1609 | clipboard register '+' (|quoteplus|) instead of |
| 1610 | register '*' for all yank, delete, change and put |
| 1611 | operations which would normally go to the unnamed |
| 1612 | register. When "unnamed" is also included to the |
| 1613 | option, yank operations (but not delete, change or |
| 1614 | put) will additionally copy the text into register |
| 1615 | '*'. |
Bram Moolenaar | 81af925 | 2010-12-10 20:35:50 +0100 | [diff] [blame] | 1616 | Only available with the |+X11| feature. |
Bram Moolenaar | bf9680e | 2010-12-02 21:43:16 +0100 | [diff] [blame] | 1617 | Availability can be checked with: > |
| 1618 | if has('unnamedplus') |
| 1619 | < |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 1620 | *clipboard-autoselect* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1621 | autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1622 | then whenever Visual mode is started, or the Visual |
| 1623 | area extended, Vim tries to become the owner of the |
| 1624 | windowing system's global selection or put the |
| 1625 | selected text on the clipboard used by the selection |
| 1626 | register "*. See |guioptions_a| and |quotestar| for |
| 1627 | details. When the GUI is active, the 'a' flag in |
| 1628 | 'guioptions' is used, when the GUI is not active, this |
| 1629 | "autoselect" flag is used. |
| 1630 | Also applies to the modeless selection. |
| 1631 | |
Bram Moolenaar | c0885aa | 2012-07-10 16:49:23 +0200 | [diff] [blame] | 1632 | *clipboard-autoselectplus* |
| 1633 | autoselectplus Like "autoselect" but using the + register instead of |
| 1634 | the * register. Compare to the 'P' flag in |
| 1635 | 'guioptions'. |
| 1636 | |
| 1637 | *clipboard-autoselectml* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1638 | autoselectml Like "autoselect", but for the modeless selection |
| 1639 | only. Compare to the 'A' flag in 'guioptions'. |
| 1640 | |
Bram Moolenaar | c0885aa | 2012-07-10 16:49:23 +0200 | [diff] [blame] | 1641 | *clipboard-html* |
Bram Moolenaar | 3a6eaa5 | 2009-06-16 13:23:06 +0000 | [diff] [blame] | 1642 | html When the clipboard contains HTML, use this when |
| 1643 | pasting. When putting text on the clipboard, mark it |
| 1644 | as HTML. This works to copy rendered HTML from |
| 1645 | Firefox, paste it as raw HTML in Vim, select the HTML |
| 1646 | in Vim and paste it in a rich edit box in Firefox. |
Bram Moolenaar | 20a825a | 2010-05-31 21:27:30 +0200 | [diff] [blame] | 1647 | You probably want to add this only temporarily, |
| 1648 | possibly use BufEnter autocommands. |
Bram Moolenaar | 3a6eaa5 | 2009-06-16 13:23:06 +0000 | [diff] [blame] | 1649 | Only supported for GTK version 2 and later. |
| 1650 | Only available with the |+multi_byte| feature. |
| 1651 | |
Bram Moolenaar | c0885aa | 2012-07-10 16:49:23 +0200 | [diff] [blame] | 1652 | *clipboard-exclude* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1653 | exclude:{pattern} |
| 1654 | Defines a pattern that is matched against the name of |
| 1655 | the terminal 'term'. If there is a match, no |
| 1656 | connection will be made to the X server. This is |
| 1657 | useful in this situation: |
| 1658 | - Running Vim in a console. |
| 1659 | - $DISPLAY is set to start applications on another |
| 1660 | display. |
| 1661 | - You do not want to connect to the X server in the |
| 1662 | console, but do want this in a terminal emulator. |
| 1663 | To never connect to the X server use: > |
| 1664 | exclude:.* |
| 1665 | < This has the same effect as using the |-X| argument. |
| 1666 | Note that when there is no connection to the X server |
| 1667 | the window title won't be restored and the clipboard |
| 1668 | cannot be accessed. |
| 1669 | The value of 'magic' is ignored, {pattern} is |
| 1670 | interpreted as if 'magic' was on. |
| 1671 | The rest of the option value will be used for |
| 1672 | {pattern}, this must be the last entry. |
| 1673 | |
| 1674 | *'cmdheight'* *'ch'* |
| 1675 | 'cmdheight' 'ch' number (default 1) |
| 1676 | global |
| 1677 | {not in Vi} |
| 1678 | Number of screen lines to use for the command-line. Helps avoiding |
| 1679 | |hit-enter| prompts. |
Bram Moolenaar | c6fe919 | 2006-04-09 21:54:49 +0000 | [diff] [blame] | 1680 | The value of this option is stored with the tab page, so that each tab |
| 1681 | page can have a different value. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1682 | |
| 1683 | *'cmdwinheight'* *'cwh'* |
| 1684 | 'cmdwinheight' 'cwh' number (default 7) |
| 1685 | global |
| 1686 | {not in Vi} |
| 1687 | {not available when compiled without the |+vertsplit| |
| 1688 | feature} |
| 1689 | Number of screen lines to use for the command-line window. |cmdwin| |
| 1690 | |
Bram Moolenaar | 483c5d8 | 2010-10-20 18:45:33 +0200 | [diff] [blame] | 1691 | *'colorcolumn'* *'cc'* |
| 1692 | 'colorcolumn' 'cc' string (default "") |
| 1693 | local to window |
| 1694 | {not in Vi} |
| 1695 | {not available when compiled without the |+syntax| |
| 1696 | feature} |
| 1697 | 'colorcolumn' is a comma separated list of screen columns that are |
| 1698 | highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
| 1699 | text. Will make screen redrawing slower. |
| 1700 | The screen column can be an absolute number, or a number preceded with |
| 1701 | '+' or '-', which is added to or subtracted from 'textwidth'. > |
| 1702 | |
| 1703 | :set cc=+1 " highlight column after 'textwidth' |
| 1704 | :set cc=+1,+2,+3 " highlight three columns after 'textwidth' |
| 1705 | :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
| 1706 | < |
| 1707 | When 'textwidth' is zero then the items with '-' and '+' are not used. |
| 1708 | A maximum of 256 columns are highlighted. |
| 1709 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1710 | *'columns'* *'co'* *E594* |
| 1711 | 'columns' 'co' number (default 80 or terminal width) |
| 1712 | global |
| 1713 | {not in Vi} |
| 1714 | 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] | 1715 | initialization and does not have to be set by hand. Also see |
| 1716 | |posix-screen-size|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1717 | When Vim is running in the GUI or in a resizable window, setting this |
| 1718 | option will cause the window size to be changed. When you only want |
| 1719 | to use the size for the GUI, put the command in your |gvimrc| file. |
| 1720 | When you set this option and Vim is unable to change the physical |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1721 | number of columns of the display, the display may be messed up. For |
| 1722 | the GUI it is always possible and Vim limits the number of columns to |
| 1723 | what fits on the screen. You can use this command to get the widest |
| 1724 | window possible: > |
| 1725 | :set columns=9999 |
| 1726 | < Minimum value is 12, maximum value is 10000. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1727 | |
| 1728 | *'comments'* *'com'* *E524* *E525* |
| 1729 | 'comments' 'com' string (default |
| 1730 | "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") |
| 1731 | local to buffer |
| 1732 | {not in Vi} |
| 1733 | {not available when compiled without the |+comments| |
| 1734 | feature} |
| 1735 | A comma separated list of strings that can start a comment line. See |
| 1736 | |format-comments|. See |option-backslash| about using backslashes to |
| 1737 | insert a space. |
| 1738 | |
| 1739 | *'commentstring'* *'cms'* *E537* |
| 1740 | 'commentstring' 'cms' string (default "/*%s*/") |
| 1741 | local to buffer |
| 1742 | {not in Vi} |
| 1743 | {not available when compiled without the |+folding| |
| 1744 | feature} |
| 1745 | A template for a comment. The "%s" in the value is replaced with the |
| 1746 | comment text. Currently only used to add markers for folding, see |
| 1747 | |fold-marker|. |
| 1748 | |
| 1749 | *'compatible'* *'cp'* *'nocompatible'* *'nocp'* |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1750 | 'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc| |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 1751 | file is found, reset in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1752 | global |
| 1753 | {not in Vi} |
| 1754 | This option has the effect of making Vim either more Vi-compatible, or |
| 1755 | make Vim behave in a more useful way. |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1756 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1757 | This is a special kind of option, because when it's set or reset, |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1758 | other options are also changed as a side effect. |
| 1759 | NOTE: Setting or resetting this option can have a lot of unexpected |
| 1760 | effects: Mappings are interpreted in another way, undo behaves |
| 1761 | differently, etc. If you set this option in your vimrc file, you |
| 1762 | should probably put it at the very start. |
| 1763 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1764 | By default this option is on and the Vi defaults are used for the |
| 1765 | options. This default was chosen for those people who want to use Vim |
| 1766 | just like Vi, and don't even (want to) know about the 'compatible' |
| 1767 | option. |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1768 | When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
Bram Moolenaar | d042c56 | 2005-06-30 22:04:15 +0000 | [diff] [blame] | 1769 | this option is switched off, and all options that have not been |
| 1770 | modified will be set to the Vim defaults. Effectively, this means |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 1771 | that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
Bram Moolenaar | d042c56 | 2005-06-30 22:04:15 +0000 | [diff] [blame] | 1772 | defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1773 | happen for the system-wide vimrc or gvimrc file, nor for a file given |
| 1774 | with the |-u| argument). Also see |compatible-default| and |
| 1775 | |posix-compliance|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1776 | You can also set this option with the "-C" argument, and reset it with |
| 1777 | "-N". See |-C| and |-N|. |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1778 | See 'cpoptions' for more fine tuning of Vi compatibility. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1779 | |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1780 | When this option is set, numerous other options are set to make Vim as |
| 1781 | Vi-compatible as possible. When this option is unset, various options |
| 1782 | are set to make Vim more useful. The table below lists all the |
| 1783 | options affected. |
| 1784 | The {?} column indicates when the options are affected: |
| 1785 | + Means that the option is set to the value given in {set value} when |
| 1786 | 'compatible' is set. |
| 1787 | & Means that the option is set to the value given in {set value} when |
| 1788 | 'compatible' is set AND is set to its Vim default value when |
| 1789 | 'compatible' is unset. |
| 1790 | - Means the option is NOT changed when setting 'compatible' but IS |
| 1791 | set to its Vim default when 'compatible' is unset. |
| 1792 | The {effect} column summarises the change when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1793 | |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1794 | option ? set value effect ~ |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1795 | |
| 1796 | 'allowrevins' + off no CTRL-_ command |
| 1797 | 'antialias' + off don't use antialiased fonts |
| 1798 | 'arabic' + off reset arabic-related options |
| 1799 | 'arabicshape' + on correct character shapes |
| 1800 | 'backspace' + "" normal backspace |
| 1801 | 'backup' + off no backup file |
| 1802 | 'backupcopy' & Unix: "yes" backup file is a copy |
| 1803 | else: "auto" copy or rename backup file |
| 1804 | 'balloonexpr' + "" text to show in evaluation balloon |
| 1805 | 'breakindent' + off don't indent when wrapping lines |
| 1806 | 'cedit' - {unchanged} {set vim default only on resetting 'cp'} |
| 1807 | 'cindent' + off no C code indentation |
| 1808 | 'compatible' - {unchanged} {set vim default only on resetting 'cp'} |
| 1809 | 'copyindent' + off don't copy indent structure |
| 1810 | 'cpoptions' & (all flags) Vi-compatible flags |
| 1811 | 'cscopepathcomp'+ 0 don't show directories in tags list |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 1812 | 'cscoperelative'+ off don't use basename of path as prefix |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1813 | 'cscopetag' + off don't use cscope for ":tag" |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1814 | 'cscopetagorder'+ 0 see |cscopetagorder| |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1815 | 'cscopeverbose' + off see |cscopeverbose| |
| 1816 | 'delcombine' + off unicode: delete whole char combination |
| 1817 | 'digraph' + off no digraphs |
| 1818 | 'esckeys' & off no <Esc>-keys in Insert mode |
| 1819 | 'expandtab' + off tabs not expanded to spaces |
| 1820 | 'fileformats' & "" no automatic file format detection, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1821 | "dos,unix" except for DOS, Windows and OS/2 |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1822 | 'formatexpr' + "" use 'formatprg' for auto-formatting |
| 1823 | 'formatoptions' & "vt" Vi compatible formatting |
| 1824 | 'gdefault' + off no default 'g' flag for ":s" |
| 1825 | 'history' & 0 no commandline history |
| 1826 | 'hkmap' + off no Hebrew keyboard mapping |
| 1827 | 'hkmapp' + off no phonetic Hebrew keyboard mapping |
| 1828 | 'hlsearch' + off no highlighting of search matches |
| 1829 | 'incsearch' + off no incremental searching |
| 1830 | 'indentexpr' + "" no indenting by expression |
| 1831 | 'insertmode' + off do not start in Insert mode |
| 1832 | 'iskeyword' & "@,48-57,_" keywords contain alphanumeric |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1833 | characters and '_' |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1834 | 'joinspaces' + on insert 2 spaces after period |
| 1835 | 'modeline' & off no modelines |
| 1836 | 'more' & off no pauses in listings |
| 1837 | 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'} |
| 1838 | 'numberwidth' & 8 min number of columns for line number |
| 1839 | 'preserveindent'+ off don't preserve current indent structure |
| 1840 | when changing it |
| 1841 | 'revins' + off no reverse insert |
| 1842 | 'ruler' + off no ruler |
| 1843 | 'scrolljump' + 1 no jump scroll |
| 1844 | 'scrolloff' + 0 no scroll offset |
| 1845 | 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'} |
| 1846 | 'shiftround' + off indent not rounded to shiftwidth |
| 1847 | 'shortmess' & "" no shortening of messages |
| 1848 | 'showcmd' & off command characters not shown |
| 1849 | 'showmode' & off current mode not shown |
| 1850 | 'sidescrolloff' + 0 cursor moves to edge of screen in scroll |
| 1851 | 'smartcase' + off no automatic ignore case switch |
| 1852 | 'smartindent' + off no smart indentation |
| 1853 | 'smarttab' + off no smart tab size |
| 1854 | 'softtabstop' + 0 tabs are always 'tabstop' positions |
| 1855 | 'startofline' + on goto startofline with some commands |
| 1856 | 'tagcase' & "followic" 'ignorecase' when searching tags file |
| 1857 | 'tagrelative' & off tag file names are not relative |
| 1858 | 'termguicolors' + off don't use highlight-(guifg|guibg) |
| 1859 | 'textauto' & off no automatic textmode detection |
| 1860 | 'textwidth' + 0 no automatic line wrap |
| 1861 | 'tildeop' + off tilde is not an operator |
| 1862 | 'ttimeout' + off no terminal timeout |
| 1863 | 'undofile' + off don't use an undo file |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 1864 | 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'} |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1865 | 'virtualedit' + "" cursor can only be placed on characters |
| 1866 | 'whichwrap' & "" left-right movements don't wrap |
| 1867 | 'wildchar' & CTRL-E only when the current value is <Tab> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1868 | use CTRL-E for cmdline completion |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 1869 | 'writebackup' + on or off depends on the |+writebackup| feature |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1870 | |
| 1871 | *'complete'* *'cpt'* *E535* |
| 1872 | 'complete' 'cpt' string (default: ".,w,b,u,t,i") |
| 1873 | local to buffer |
| 1874 | {not in Vi} |
| 1875 | This option specifies how keyword completion |ins-completion| works |
| 1876 | when CTRL-P or CTRL-N are used. It is also used for whole-line |
| 1877 | completion |i_CTRL-X_CTRL-L|. It indicates the type of completion |
| 1878 | and the places to scan. It is a comma separated list of flags: |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 1879 | . scan the current buffer ('wrapscan' is ignored) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1880 | w scan buffers from other windows |
| 1881 | b scan other loaded buffers that are in the buffer list |
| 1882 | u scan the unloaded buffers that are in the buffer list |
| 1883 | U scan the buffers that are not in the buffer list |
| 1884 | k scan the files given with the 'dictionary' option |
Bram Moolenaar | 0b23879 | 2006-03-02 22:49:12 +0000 | [diff] [blame] | 1885 | kspell use the currently active spell checking |spell| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1886 | k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1887 | patterns are valid too. For example: > |
| 1888 | :set cpt=k/usr/dict/*,k~/spanish |
| 1889 | < s scan the files given with the 'thesaurus' option |
| 1890 | s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns |
| 1891 | are valid too. |
| 1892 | i scan current and included files |
| 1893 | d scan current and included files for defined name or macro |
| 1894 | |i_CTRL-X_CTRL-D| |
| 1895 | ] tag completion |
| 1896 | t same as "]" |
| 1897 | |
| 1898 | Unloaded buffers are not loaded, thus their autocmds |:autocmd| are |
| 1899 | not executed, this may lead to unexpected completions from some files |
| 1900 | (gzipped files for example). Unloaded buffers are not scanned for |
| 1901 | whole-line completion. |
| 1902 | |
| 1903 | The default is ".,w,b,u,t,i", which means to scan: |
| 1904 | 1. the current buffer |
| 1905 | 2. buffers in other windows |
| 1906 | 3. other loaded buffers |
| 1907 | 4. unloaded buffers |
| 1908 | 5. tags |
| 1909 | 6. included files |
| 1910 | |
| 1911 | 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] | 1912 | based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 1913 | |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] | 1914 | |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 1915 | *'completefunc'* *'cfu'* |
| 1916 | 'completefunc' 'cfu' string (default: empty) |
| 1917 | local to buffer |
| 1918 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 1919 | {not available when compiled without the |+eval| |
| 1920 | or |+insert_expand| features} |
Bram Moolenaar | c7486e0 | 2005-12-29 22:48:26 +0000 | [diff] [blame] | 1921 | This option specifies a function to be used for Insert mode completion |
| 1922 | with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 1923 | See |complete-functions| for an explanation of how the function is |
| 1924 | invoked and what it should return. |
Bram Moolenaar | 166af9b | 2010-11-16 20:34:40 +0100 | [diff] [blame] | 1925 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1926 | security reasons. |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 1927 | |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 1928 | *'completeopt'* *'cot'* |
Bram Moolenaar | 96d2c5b | 2006-03-11 21:27:59 +0000 | [diff] [blame] | 1929 | 'completeopt' 'cot' string (default: "menu,preview") |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 1930 | global |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 1931 | {not available when compiled without the |
| 1932 | |+insert_expand| feature} |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 1933 | {not in Vi} |
Bram Moolenaar | c7453f5 | 2006-02-10 23:20:28 +0000 | [diff] [blame] | 1934 | A comma separated list of options for Insert mode completion |
| 1935 | |ins-completion|. The supported values are: |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 1936 | |
| 1937 | menu Use a popup menu to show the possible completions. The |
| 1938 | menu is only shown when there is more than one match and |
| 1939 | sufficient colors are available. |ins-completion-menu| |
| 1940 | |
Bram Moolenaar | 65c923a | 2006-03-03 22:56:30 +0000 | [diff] [blame] | 1941 | menuone Use the popup menu also when there is only one match. |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 1942 | Useful when there is additional information about the |
Bram Moolenaar | 65c923a | 2006-03-03 22:56:30 +0000 | [diff] [blame] | 1943 | match, e.g., what file it comes from. |
| 1944 | |
Bram Moolenaar | c1e3790 | 2006-04-18 21:55:01 +0000 | [diff] [blame] | 1945 | longest Only insert the longest common text of the matches. If |
| 1946 | the menu is displayed you can use CTRL-L to add more |
| 1947 | characters. Whether case is ignored depends on the kind |
| 1948 | of completion. For buffer text the 'ignorecase' option is |
| 1949 | used. |
Bram Moolenaar | c7453f5 | 2006-02-10 23:20:28 +0000 | [diff] [blame] | 1950 | |
Bram Moolenaar | 96d2c5b | 2006-03-11 21:27:59 +0000 | [diff] [blame] | 1951 | preview Show extra information about the currently selected |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 1952 | completion in the preview window. Only works in |
| 1953 | combination with "menu" or "menuone". |
| 1954 | |
Bram Moolenaar | b6be1e2 | 2015-07-10 18:18:40 +0200 | [diff] [blame] | 1955 | noinsert Do not insert any text for a match until the user selects |
| 1956 | a match from the menu. Only works in combination with |
| 1957 | "menu" or "menuone". No effect if "longest" is present. |
| 1958 | |
| 1959 | noselect Do not select a match in the menu, force the user to |
| 1960 | select one from the menu. Only works in combination with |
| 1961 | "menu" or "menuone". |
| 1962 | |
Bram Moolenaar | 96d2c5b | 2006-03-11 21:27:59 +0000 | [diff] [blame] | 1963 | |
Bram Moolenaar | f5963f7 | 2010-07-23 22:10:27 +0200 | [diff] [blame] | 1964 | *'concealcursor'* *'cocu'* |
| 1965 | 'concealcursor' 'cocu' string (default: "") |
| 1966 | local to window |
| 1967 | {not in Vi} |
| 1968 | {not available when compiled without the |+conceal| |
| 1969 | feature} |
| 1970 | Sets the modes in which text in the cursor line can also be concealed. |
| 1971 | When the current mode is listed then concealing happens just like in |
| 1972 | other lines. |
| 1973 | n Normal mode |
| 1974 | v Visual mode |
| 1975 | i Insert mode |
Bram Moolenaar | ca8c986 | 2010-07-24 15:00:38 +0200 | [diff] [blame] | 1976 | c Command line editing, for 'incsearch' |
Bram Moolenaar | f5963f7 | 2010-07-23 22:10:27 +0200 | [diff] [blame] | 1977 | |
Bram Moolenaar | e6dc573 | 2010-07-24 23:52:26 +0200 | [diff] [blame] | 1978 | 'v' applies to all lines in the Visual area, not only the cursor. |
Bram Moolenaar | ca8c986 | 2010-07-24 15:00:38 +0200 | [diff] [blame] | 1979 | A useful value is "nc". This is used in help files. So long as you |
Bram Moolenaar | f5963f7 | 2010-07-23 22:10:27 +0200 | [diff] [blame] | 1980 | are moving around text is concealed, but when starting to insert text |
| 1981 | or selecting a Visual area the concealed text is displayed, so that |
| 1982 | you can see what you are doing. |
Bram Moolenaar | f70e3d6 | 2010-07-24 13:15:07 +0200 | [diff] [blame] | 1983 | Keep in mind that the cursor position is not always where it's |
| 1984 | displayed. E.g., when moving vertically it may change column. |
Bram Moolenaar | f5963f7 | 2010-07-23 22:10:27 +0200 | [diff] [blame] | 1985 | |
| 1986 | |
| 1987 | 'conceallevel' 'cole' *'conceallevel'* *'cole'* |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 1988 | number (default 0) |
| 1989 | local to window |
| 1990 | {not in Vi} |
| 1991 | {not available when compiled without the |+conceal| |
| 1992 | feature} |
Bram Moolenaar | 6df6f47 | 2010-07-18 18:04:50 +0200 | [diff] [blame] | 1993 | Determine how text with the "conceal" syntax attribute |:syn-conceal| |
| 1994 | is shown: |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 1995 | |
Bram Moolenaar | 6df6f47 | 2010-07-18 18:04:50 +0200 | [diff] [blame] | 1996 | Value Effect ~ |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 1997 | 0 Text is shown normally |
Bram Moolenaar | 477db06 | 2010-07-28 18:17:41 +0200 | [diff] [blame] | 1998 | 1 Each block of concealed text is replaced with one |
| 1999 | character. If the syntax item does not have a custom |
| 2000 | replacement character defined (see |:syn-cchar|) the |
| 2001 | character defined in 'listchars' is used (default is a |
| 2002 | space). |
| 2003 | It is highlighted with the "Conceal" highlight group. |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2004 | 2 Concealed text is completely hidden unless it has a |
| 2005 | custom replacement character defined (see |
Bram Moolenaar | 477db06 | 2010-07-28 18:17:41 +0200 | [diff] [blame] | 2006 | |:syn-cchar|). |
Bram Moolenaar | a7781e0 | 2010-07-19 20:13:22 +0200 | [diff] [blame] | 2007 | 3 Concealed text is completely hidden. |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2008 | |
Bram Moolenaar | a7781e0 | 2010-07-19 20:13:22 +0200 | [diff] [blame] | 2009 | Note: in the cursor line concealed text is not hidden, so that you can |
Bram Moolenaar | f5963f7 | 2010-07-23 22:10:27 +0200 | [diff] [blame] | 2010 | edit and copy the text. This can be changed with the 'concealcursor' |
| 2011 | option. |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2012 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2013 | *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 2014 | 'confirm' 'cf' boolean (default off) |
| 2015 | global |
| 2016 | {not in Vi} |
| 2017 | When 'confirm' is on, certain operations that would normally |
| 2018 | fail because of unsaved changes to a buffer, e.g. ":q" and ":e", |
| 2019 | instead raise a |dialog| asking if you wish to save the current |
| 2020 | file(s). You can still use a ! to unconditionally |abandon| a buffer. |
| 2021 | If 'confirm' is off you can still activate confirmation for one |
| 2022 | command only (this is most useful in mappings) with the |:confirm| |
| 2023 | command. |
| 2024 | Also see the |confirm()| function and the 'v' flag in 'guioptions'. |
| 2025 | |
| 2026 | *'conskey'* *'consk'* *'noconskey'* *'noconsk'* |
| 2027 | 'conskey' 'consk' boolean (default off) |
| 2028 | global |
| 2029 | {not in Vi} {only for MS-DOS} |
Bram Moolenaar | f391327 | 2016-02-25 00:00:01 +0100 | [diff] [blame] | 2030 | This was for MS-DOS and is no longer supported. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2031 | |
| 2032 | *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* |
| 2033 | 'copyindent' 'ci' boolean (default off) |
| 2034 | local to buffer |
| 2035 | {not in Vi} |
| 2036 | Copy the structure of the existing lines indent when autoindenting a |
| 2037 | new line. Normally the new indent is reconstructed by a series of |
| 2038 | tabs followed by spaces as required (unless |'expandtab'| is enabled, |
| 2039 | in which case only spaces are used). Enabling this option makes the |
| 2040 | new line copy whatever characters were used for indenting on the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2041 | existing line. 'expandtab' has no effect on these characters, a Tab |
| 2042 | remains a Tab. If the new indent is greater than on the existing |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2043 | line, the remaining space is filled in the normal manner. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 2044 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2045 | Also see 'preserveindent'. |
| 2046 | |
Bram Moolenaar | e0fa374 | 2016-02-20 15:47:01 +0100 | [diff] [blame] | 2047 | *'cpoptions'* *'cpo'* *cpo* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2048 | 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 2049 | Vi default: all flags) |
| 2050 | global |
| 2051 | {not in Vi} |
| 2052 | A sequence of single character flags. When a character is present |
Bram Moolenaar | 7cba6c0 | 2013-09-05 22:13:31 +0200 | [diff] [blame] | 2053 | this indicates Vi-compatible behavior. This is used for things where |
| 2054 | not being Vi-compatible is mostly or sometimes preferred. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2055 | 'cpoptions' stands for "compatible-options". |
| 2056 | Commas can be added for readability. |
| 2057 | To avoid problems with flags that are added in the future, use the |
| 2058 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 2059 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 2060 | set and to the Vim default value when 'compatible' is reset. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2061 | NOTE: This option is set to the POSIX default value at startup when |
| 2062 | the Vi default value would be used and the $VIM_POSIX environment |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2063 | variable exists |posix|. This means Vim tries to behave like the |
| 2064 | POSIX specification. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2065 | |
| 2066 | contains behavior ~ |
| 2067 | *cpo-a* |
| 2068 | a When included, a ":read" command with a file name |
| 2069 | argument will set the alternate file name for the |
| 2070 | current window. |
| 2071 | *cpo-A* |
| 2072 | A When included, a ":write" command with a file name |
| 2073 | argument will set the alternate file name for the |
| 2074 | current window. |
| 2075 | *cpo-b* |
| 2076 | b "\|" in a ":map" command is recognized as the end of |
| 2077 | the map command. The '\' is included in the mapping, |
| 2078 | the text after the '|' is interpreted as the next |
| 2079 | command. Use a CTRL-V instead of a backslash to |
| 2080 | include the '|' in the mapping. Applies to all |
| 2081 | mapping, abbreviation, menu and autocmd commands. |
| 2082 | See also |map_bar|. |
| 2083 | *cpo-B* |
| 2084 | B A backslash has no special meaning in mappings, |
| 2085 | abbreviations and the "to" part of the menu commands. |
| 2086 | Remove this flag to be able to use a backslash like a |
| 2087 | CTRL-V. For example, the command ":map X \<Esc>" |
| 2088 | results in X being mapped to: |
| 2089 | 'B' included: "\^[" (^[ is a real <Esc>) |
| 2090 | 'B' excluded: "<Esc>" (5 characters) |
| 2091 | ('<' excluded in both cases) |
| 2092 | *cpo-c* |
| 2093 | c Searching continues at the end of any match at the |
| 2094 | cursor position, but not further than the start of the |
| 2095 | next line. When not present searching continues |
| 2096 | one character from the cursor position. With 'c' |
| 2097 | "abababababab" only gets three matches when repeating |
| 2098 | "/abab", without 'c' there are five matches. |
| 2099 | *cpo-C* |
| 2100 | C Do not concatenate sourced lines that start with a |
| 2101 | backslash. See |line-continuation|. |
| 2102 | *cpo-d* |
| 2103 | d Using "./" in the 'tags' option doesn't mean to use |
| 2104 | the tags file relative to the current file, but the |
| 2105 | tags file in the current directory. |
| 2106 | *cpo-D* |
| 2107 | D Can't use CTRL-K to enter a digraph after Normal mode |
| 2108 | commands with a character argument, like |r|, |f| and |
| 2109 | |t|. |
| 2110 | *cpo-e* |
| 2111 | e When executing a register with ":@r", always add a |
| 2112 | <CR> to the last line, also when the register is not |
| 2113 | linewise. If this flag is not present, the register |
| 2114 | is not linewise and the last line does not end in a |
| 2115 | <CR>, then the last line is put on the command-line |
| 2116 | and can be edited before hitting <CR>. |
| 2117 | *cpo-E* |
| 2118 | E It is an error when using "y", "d", "c", "g~", "gu" or |
| 2119 | "gU" on an Empty region. The operators only work when |
| 2120 | at least one character is to be operate on. Example: |
| 2121 | This makes "y0" fail in the first column. |
| 2122 | *cpo-f* |
| 2123 | f When included, a ":read" command with a file name |
| 2124 | argument will set the file name for the current buffer, |
| 2125 | if the current buffer doesn't have a file name yet. |
| 2126 | *cpo-F* |
| 2127 | F When included, a ":write" command with a file name |
| 2128 | argument will set the file name for the current |
| 2129 | buffer, if the current buffer doesn't have a file name |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2130 | yet. Also see |cpo-P|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2131 | *cpo-g* |
| 2132 | g Goto line 1 when using ":edit" without argument. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2133 | *cpo-H* |
| 2134 | H When using "I" on a line with only blanks, insert |
| 2135 | before the last blank. Without this flag insert after |
| 2136 | the last blank. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2137 | *cpo-i* |
| 2138 | i When included, interrupting the reading of a file will |
| 2139 | leave it modified. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2140 | *cpo-I* |
| 2141 | I When moving the cursor up or down just after inserting |
| 2142 | indent for 'autoindent', do not delete the indent. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2143 | *cpo-j* |
| 2144 | j When joining lines, only add two spaces after a '.', |
| 2145 | not after '!' or '?'. Also see 'joinspaces'. |
| 2146 | *cpo-J* |
| 2147 | J A |sentence| has to be followed by two spaces after |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 2148 | the '.', '!' or '?'. A <Tab> is not recognized as |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2149 | white space. |
| 2150 | *cpo-k* |
| 2151 | k Disable the recognition of raw key codes in |
| 2152 | mappings, abbreviations, and the "to" part of menu |
| 2153 | commands. For example, if <Key> sends ^[OA (where ^[ |
| 2154 | is <Esc>), the command ":map X ^[OA" results in X |
| 2155 | being mapped to: |
| 2156 | 'k' included: "^[OA" (3 characters) |
| 2157 | 'k' excluded: "<Key>" (one key code) |
| 2158 | Also see the '<' flag below. |
| 2159 | *cpo-K* |
| 2160 | K Don't wait for a key code to complete when it is |
| 2161 | halfway a mapping. This breaks mapping <F1><F1> when |
| 2162 | only part of the second <F1> has been read. It |
| 2163 | enables cancelling the mapping by typing <F1><Esc>. |
| 2164 | *cpo-l* |
| 2165 | l Backslash in a [] range in a search pattern is taken |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2166 | literally, only "\]", "\^", "\-" and "\\" are special. |
| 2167 | See |/[]| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2168 | 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 2169 | 'l' excluded: "/[ \t]" finds <Space> and <Tab> |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2170 | Also see |cpo-\|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2171 | *cpo-L* |
| 2172 | L When the 'list' option is set, 'wrapmargin', |
| 2173 | 'textwidth', 'softtabstop' and Virtual Replace mode |
| 2174 | (see |gR|) count a <Tab> as two characters, instead of |
| 2175 | the normal behavior of a <Tab>. |
| 2176 | *cpo-m* |
| 2177 | m When included, a showmatch will always wait half a |
| 2178 | second. When not included, a showmatch will wait half |
| 2179 | a second or until a character is typed. |'showmatch'| |
| 2180 | *cpo-M* |
| 2181 | M When excluded, "%" matching will take backslashes into |
| 2182 | account. Thus in "( \( )" and "\( ( \)" the outer |
| 2183 | parenthesis match. When included "%" ignores |
| 2184 | backslashes, which is Vi compatible. |
| 2185 | *cpo-n* |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 2186 | n When included, the column used for 'number' and |
| 2187 | 'relativenumber' will also be used for text of wrapped |
| 2188 | lines. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2189 | *cpo-o* |
| 2190 | o Line offset to search command is not remembered for |
| 2191 | next search. |
| 2192 | *cpo-O* |
| 2193 | O Don't complain if a file is being overwritten, even |
| 2194 | when it didn't exist when editing it. This is a |
| 2195 | protection against a file unexpectedly created by |
| 2196 | someone else. Vi didn't complain about this. |
| 2197 | *cpo-p* |
| 2198 | p Vi compatible Lisp indenting. When not present, a |
| 2199 | slightly better algorithm is used. |
Bram Moolenaar | b348038 | 2005-12-11 21:33:32 +0000 | [diff] [blame] | 2200 | *cpo-P* |
| 2201 | P When included, a ":write" command that appends to a |
| 2202 | file will set the file name for the current buffer, if |
| 2203 | the current buffer doesn't have a file name yet and |
| 2204 | the 'F' flag is also included |cpo-F|. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2205 | *cpo-q* |
| 2206 | q When joining multiple lines leave the cursor at the |
| 2207 | position where it would be when joining two lines. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2208 | *cpo-r* |
| 2209 | r Redo ("." command) uses "/" to repeat a search |
| 2210 | command, instead of the actually used search string. |
| 2211 | *cpo-R* |
| 2212 | R Remove marks from filtered lines. Without this flag |
| 2213 | marks are kept like |:keepmarks| was used. |
| 2214 | *cpo-s* |
| 2215 | s Set buffer options when entering the buffer for the |
| 2216 | first time. This is like it is in Vim version 3.0. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2217 | And it is the default. If not present the options are |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2218 | set when the buffer is created. |
| 2219 | *cpo-S* |
| 2220 | S Set buffer options always when entering a buffer |
| 2221 | (except 'readonly', 'fileformat', 'filetype' and |
| 2222 | 'syntax'). This is the (most) Vi compatible setting. |
| 2223 | The options are set to the values in the current |
| 2224 | buffer. When you change an option and go to another |
| 2225 | buffer, the value is copied. Effectively makes the |
| 2226 | buffer options global to all buffers. |
| 2227 | |
| 2228 | 's' 'S' copy buffer options |
| 2229 | no no when buffer created |
| 2230 | yes no when buffer first entered (default) |
| 2231 | X yes each time when buffer entered (vi comp.) |
| 2232 | *cpo-t* |
| 2233 | t Search pattern for the tag command is remembered for |
| 2234 | "n" command. Otherwise Vim only puts the pattern in |
| 2235 | the history for search pattern, but doesn't change the |
| 2236 | last used search pattern. |
| 2237 | *cpo-u* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2238 | u Undo is Vi compatible. See |undo-two-ways|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2239 | *cpo-v* |
| 2240 | v Backspaced characters remain visible on the screen in |
| 2241 | Insert mode. Without this flag the characters are |
| 2242 | erased from the screen right away. With this flag the |
| 2243 | screen newly typed text overwrites backspaced |
| 2244 | characters. |
| 2245 | *cpo-w* |
| 2246 | w When using "cw" on a blank character, only change one |
| 2247 | character and not all blanks until the start of the |
| 2248 | next word. |
| 2249 | *cpo-W* |
| 2250 | W Don't overwrite a readonly file. When omitted, ":w!" |
| 2251 | overwrites a readonly file, if possible. |
| 2252 | *cpo-x* |
| 2253 | x <Esc> on the command-line executes the command-line. |
| 2254 | The default in Vim is to abandon the command-line, |
| 2255 | because <Esc> normally aborts a command. |c_<Esc>| |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2256 | *cpo-X* |
| 2257 | X When using a count with "R" the replaced text is |
| 2258 | deleted only once. Also when repeating "R" with "." |
| 2259 | and a count. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2260 | *cpo-y* |
| 2261 | y A yank command can be redone with ".". |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2262 | *cpo-Z* |
| 2263 | Z When using "w!" while the 'readonly' option is set, |
| 2264 | don't reset 'readonly'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2265 | *cpo-!* |
| 2266 | ! When redoing a filter command, use the last used |
| 2267 | external command, whatever it was. Otherwise the last |
| 2268 | used -filter- command is used. |
| 2269 | *cpo-$* |
| 2270 | $ When making a change to one line, don't redisplay the |
| 2271 | line, but put a '$' at the end of the changed text. |
| 2272 | The changed text will be overwritten when you type the |
| 2273 | new text. The line is redisplayed if you type any |
| 2274 | command that moves the cursor from the insertion |
| 2275 | point. |
| 2276 | *cpo-%* |
| 2277 | % Vi-compatible matching is done for the "%" command. |
| 2278 | Does not recognize "#if", "#endif", etc. |
| 2279 | Does not recognize "/*" and "*/". |
| 2280 | Parens inside single and double quotes are also |
| 2281 | counted, causing a string that contains a paren to |
| 2282 | disturb the matching. For example, in a line like |
| 2283 | "if (strcmp("foo(", s))" the first paren does not |
| 2284 | match the last one. When this flag is not included, |
| 2285 | parens inside single and double quotes are treated |
| 2286 | specially. When matching a paren outside of quotes, |
| 2287 | everything inside quotes is ignored. When matching a |
| 2288 | paren inside quotes, it will find the matching one (if |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2289 | there is one). This works very well for C programs. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 2290 | This flag is also used for other features, such as |
| 2291 | C-indenting. |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2292 | *cpo--* |
| 2293 | - When included, a vertical movement command fails when |
Bram Moolenaar | 8ada17c | 2006-01-19 22:16:24 +0000 | [diff] [blame] | 2294 | it would go above the first line or below the last |
| 2295 | line. Without it the cursor moves to the first or |
| 2296 | last line, unless it already was in that line. |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 2297 | Applies to the commands "-", "k", CTRL-P, "+", "j", |
Bram Moolenaar | 8ada17c | 2006-01-19 22:16:24 +0000 | [diff] [blame] | 2298 | CTRL-N, CTRL-J and ":1234". |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 2299 | *cpo-+* |
| 2300 | + When included, a ":write file" command will reset the |
| 2301 | 'modified' flag of the buffer, even though the buffer |
| 2302 | itself may still be different from its file. |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 2303 | *cpo-star* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2304 | * Use ":*" in the same way as ":@". When not included, |
| 2305 | ":*" is an alias for ":'<,'>", select the Visual area. |
| 2306 | *cpo-<* |
| 2307 | < Disable the recognition of special key codes in |<>| |
| 2308 | form in mappings, abbreviations, and the "to" part of |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2309 | menu commands. For example, the command |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2310 | ":map X <Tab>" results in X being mapped to: |
| 2311 | '<' included: "<Tab>" (5 characters) |
| 2312 | '<' excluded: "^I" (^I is a real <Tab>) |
| 2313 | Also see the 'k' flag above. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2314 | *cpo->* |
| 2315 | > When appending to a register, put a line break before |
| 2316 | the appended text. |
Bram Moolenaar | 8b3e033 | 2011-06-26 05:36:34 +0200 | [diff] [blame] | 2317 | *cpo-;* |
| 2318 | ; When using |,| or |;| to repeat the last |t| search |
| 2319 | and the cursor is right in front of the searched |
| 2320 | character, the cursor won't move. When not included, |
| 2321 | the cursor would skip over it and jump to the |
Bram Moolenaar | c873442 | 2012-06-01 22:38:45 +0200 | [diff] [blame] | 2322 | following occurrence. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2323 | |
| 2324 | POSIX flags. These are not included in the Vi default value, except |
| 2325 | when $VIM_POSIX was set on startup. |posix| |
| 2326 | |
| 2327 | contains behavior ~ |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 2328 | *cpo-#* |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2329 | # A count before "D", "o" and "O" has no effect. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2330 | *cpo-&* |
| 2331 | & When ":preserve" was used keep the swap file when |
| 2332 | exiting normally while this buffer is still loaded. |
| 2333 | This flag is tested when exiting. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2334 | *cpo-\* |
| 2335 | \ Backslash in a [] range in a search pattern is taken |
| 2336 | literally, only "\]" is special See |/[]| |
Bram Moolenaar | 90915b5 | 2005-08-21 22:17:52 +0000 | [diff] [blame] | 2337 | '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 2338 | '\' excluded: "/[ \-]" finds <Space> and '-' |
| 2339 | Also see |cpo-l|. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2340 | *cpo-/* |
| 2341 | / When "%" is used as the replacement string in a |:s| |
| 2342 | command, use the previous replacement string. |:s%| |
| 2343 | *cpo-{* |
| 2344 | { The |{| and |}| commands also stop at a "{" character |
| 2345 | at the start of a line. |
| 2346 | *cpo-.* |
| 2347 | . The ":chdir" and ":cd" commands fail if the current |
| 2348 | buffer is modified, unless ! is used. Vim doesn't |
| 2349 | need this, since it remembers the full path of an |
| 2350 | opened file. |
| 2351 | *cpo-bar* |
| 2352 | | The value of the $LINES and $COLUMNS environment |
| 2353 | variables overrule the terminal size values obtained |
| 2354 | with system specific functions. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 2355 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2356 | |
Bram Moolenaar | 40e6a71 | 2010-05-16 22:32:54 +0200 | [diff] [blame] | 2357 | *'cryptmethod'* *'cm'* |
Bram Moolenaar | 32efaf6 | 2014-11-05 17:02:17 +0100 | [diff] [blame] | 2358 | 'cryptmethod' 'cm' string (default "zip") |
Bram Moolenaar | 49771f4 | 2010-07-20 17:32:38 +0200 | [diff] [blame] | 2359 | global or local to buffer |global-local| |
Bram Moolenaar | 40e6a71 | 2010-05-16 22:32:54 +0200 | [diff] [blame] | 2360 | {not in Vi} |
| 2361 | Method used for encryption when the buffer is written to a file: |
Bram Moolenaar | 0bbabe8 | 2010-05-17 20:32:55 +0200 | [diff] [blame] | 2362 | *pkzip* |
Bram Moolenaar | 49771f4 | 2010-07-20 17:32:38 +0200 | [diff] [blame] | 2363 | zip PkZip compatible method. A weak kind of encryption. |
Bram Moolenaar | f50a253 | 2010-05-21 15:36:08 +0200 | [diff] [blame] | 2364 | Backwards compatible with Vim 7.2 and older. |
Bram Moolenaar | 0bbabe8 | 2010-05-17 20:32:55 +0200 | [diff] [blame] | 2365 | *blowfish* |
Bram Moolenaar | 8f4ac01 | 2014-08-10 13:38:34 +0200 | [diff] [blame] | 2366 | blowfish Blowfish method. Medium strong encryption but it has |
| 2367 | an implementation flaw. Requires Vim 7.3 or later, |
| 2368 | files can NOT be read by Vim 7.2 and older. This adds |
| 2369 | a "seed" to the file, every time you write the file |
| 2370 | the encrypted bytes will be different. |
| 2371 | *blowfish2* |
| 2372 | blowfish2 Blowfish method. Medium strong encryption. Requires |
Bram Moolenaar | 5e9b2fa | 2016-02-01 22:37:05 +0100 | [diff] [blame] | 2373 | Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
Bram Moolenaar | 8f4ac01 | 2014-08-10 13:38:34 +0200 | [diff] [blame] | 2374 | and older. This adds a "seed" to the file, every time |
| 2375 | you write the file the encrypted bytes will be |
| 2376 | different. The whole undo file is encrypted, not just |
| 2377 | the pieces of text. |
Bram Moolenaar | f50a253 | 2010-05-21 15:36:08 +0200 | [diff] [blame] | 2378 | |
Bram Moolenaar | 4f3f668 | 2016-03-26 23:01:59 +0100 | [diff] [blame] | 2379 | You should use "blowfish2", also to re-encrypt older files. |
| 2380 | |
Bram Moolenaar | 40e6a71 | 2010-05-16 22:32:54 +0200 | [diff] [blame] | 2381 | When reading an encrypted file 'cryptmethod' will be set automatically |
Bram Moolenaar | f50a253 | 2010-05-21 15:36:08 +0200 | [diff] [blame] | 2382 | to the detected method of the file being read. Thus if you write it |
| 2383 | without changing 'cryptmethod' the same method will be used. |
| 2384 | Changing 'cryptmethod' does not mark the file as modified, you have to |
Bram Moolenaar | 49771f4 | 2010-07-20 17:32:38 +0200 | [diff] [blame] | 2385 | explicitly write it, you don't get a warning unless there are other |
| 2386 | modifications. Also see |:X|. |
| 2387 | |
| 2388 | When setting the global value to an empty string, it will end up with |
| 2389 | the value "zip". When setting the local value to an empty string the |
| 2390 | buffer will use the global value. |
| 2391 | |
Bram Moolenaar | f50a253 | 2010-05-21 15:36:08 +0200 | [diff] [blame] | 2392 | When a new encryption method is added in a later version of Vim, and |
| 2393 | the current version does not recognize it, you will get *E821* . |
Bram Moolenaar | 49771f4 | 2010-07-20 17:32:38 +0200 | [diff] [blame] | 2394 | You need to edit this file with the later version of Vim. |
Bram Moolenaar | 40e6a71 | 2010-05-16 22:32:54 +0200 | [diff] [blame] | 2395 | |
| 2396 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2397 | *'cscopepathcomp'* *'cspc'* |
| 2398 | 'cscopepathcomp' 'cspc' number (default 0) |
| 2399 | global |
| 2400 | {not available when compiled without the |+cscope| |
| 2401 | feature} |
| 2402 | {not in Vi} |
| 2403 | Determines how many components of the path to show in a list of tags. |
| 2404 | See |cscopepathcomp|. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 2405 | NOTE: This option is set to 0 when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2406 | |
| 2407 | *'cscopeprg'* *'csprg'* |
| 2408 | 'cscopeprg' 'csprg' string (default "cscope") |
| 2409 | global |
| 2410 | {not available when compiled without the |+cscope| |
| 2411 | feature} |
| 2412 | {not in Vi} |
| 2413 | Specifies the command to execute cscope. See |cscopeprg|. |
| 2414 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2415 | security reasons. |
| 2416 | |
| 2417 | *'cscopequickfix'* *'csqf'* |
| 2418 | 'cscopequickfix' 'csqf' string (default "") |
| 2419 | global |
| 2420 | {not available when compiled without the |+cscope| |
| 2421 | or |+quickfix| features} |
| 2422 | {not in Vi} |
| 2423 | Specifies whether to use quickfix window to show cscope results. |
| 2424 | See |cscopequickfix|. |
| 2425 | |
Bram Moolenaar | ec7944a | 2013-06-12 21:29:15 +0200 | [diff] [blame] | 2426 | *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
Bram Moolenaar | 2f982e4 | 2011-06-12 20:42:22 +0200 | [diff] [blame] | 2427 | 'cscoperelative' 'csre' boolean (default off) |
| 2428 | global |
| 2429 | {not available when compiled without the |+cscope| |
| 2430 | feature} |
| 2431 | {not in Vi} |
| 2432 | In the absence of a prefix (-P) for cscope. setting this option enables |
| 2433 | to use the basename of cscope.out path as the prefix. |
| 2434 | See |cscoperelative|. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 2435 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 2f982e4 | 2011-06-12 20:42:22 +0200 | [diff] [blame] | 2436 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2437 | *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2438 | 'cscopetag' 'cst' boolean (default off) |
| 2439 | global |
| 2440 | {not available when compiled without the |+cscope| |
| 2441 | feature} |
| 2442 | {not in Vi} |
| 2443 | Use cscope for tag commands. See |cscope-options|. |
| 2444 | NOTE: This option is reset when 'compatible' is set. |
| 2445 | |
| 2446 | *'cscopetagorder'* *'csto'* |
| 2447 | 'cscopetagorder' 'csto' number (default 0) |
| 2448 | global |
| 2449 | {not available when compiled without the |+cscope| |
| 2450 | feature} |
| 2451 | {not in Vi} |
| 2452 | Determines the order in which ":cstag" performs a search. See |
| 2453 | |cscopetagorder|. |
| 2454 | NOTE: This option is set to 0 when 'compatible' is set. |
| 2455 | |
| 2456 | *'cscopeverbose'* *'csverb'* |
| 2457 | *'nocscopeverbose'* *'nocsverb'* |
| 2458 | 'cscopeverbose' 'csverb' boolean (default off) |
| 2459 | global |
| 2460 | {not available when compiled without the |+cscope| |
| 2461 | feature} |
| 2462 | {not in Vi} |
| 2463 | Give messages when adding a cscope database. See |cscopeverbose|. |
| 2464 | NOTE: This option is reset when 'compatible' is set. |
| 2465 | |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2466 | *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
| 2467 | 'cursorbind' 'crb' boolean (default off) |
| 2468 | local to window |
| 2469 | {not in Vi} |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2470 | When this option is set, as the cursor in the current |
| 2471 | window moves other cursorbound windows (windows that also have |
| 2472 | this option set) move their cursors to the corresponding line and |
| 2473 | column. This option is useful for viewing the |
| 2474 | differences between two versions of a file (see 'diff'); in diff mode, |
| 2475 | inserted and deleted lines (though not characters within a line) are |
Bram Moolenaar | 1a38442 | 2010-07-14 19:53:30 +0200 | [diff] [blame] | 2476 | taken into account. |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 2477 | |
Bram Moolenaar | 600dddc | 2006-03-12 22:05:10 +0000 | [diff] [blame] | 2478 | |
| 2479 | *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* |
| 2480 | 'cursorcolumn' 'cuc' boolean (default off) |
| 2481 | local to window |
| 2482 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 2483 | {not available when compiled without the |+syntax| |
Bram Moolenaar | 600dddc | 2006-03-12 22:05:10 +0000 | [diff] [blame] | 2484 | feature} |
| 2485 | Highlight the screen column of the cursor with CursorColumn |
| 2486 | |hl-CursorColumn|. Useful to align text. Will make screen redrawing |
| 2487 | slower. |
Bram Moolenaar | 4c3f536 | 2006-04-11 21:38:50 +0000 | [diff] [blame] | 2488 | If you only want the highlighting in the current window you can use |
| 2489 | these autocommands: > |
| 2490 | au WinLeave * set nocursorline nocursorcolumn |
| 2491 | au WinEnter * set cursorline cursorcolumn |
| 2492 | < |
Bram Moolenaar | 600dddc | 2006-03-12 22:05:10 +0000 | [diff] [blame] | 2493 | |
| 2494 | *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* |
| 2495 | 'cursorline' 'cul' boolean (default off) |
| 2496 | local to window |
| 2497 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 2498 | {not available when compiled without the |+syntax| |
Bram Moolenaar | 600dddc | 2006-03-12 22:05:10 +0000 | [diff] [blame] | 2499 | feature} |
| 2500 | Highlight the screen line of the cursor with CursorLine |
| 2501 | |hl-CursorLine|. Useful to easily spot the cursor. Will make screen |
| 2502 | redrawing slower. |
Bram Moolenaar | e2f98b9 | 2006-03-29 21:18:24 +0000 | [diff] [blame] | 2503 | When Visual mode is active the highlighting isn't used to make it |
Bram Moolenaar | 779b74b | 2006-04-10 14:55:34 +0000 | [diff] [blame] | 2504 | easier to see the selected text. |
Bram Moolenaar | 600dddc | 2006-03-12 22:05:10 +0000 | [diff] [blame] | 2505 | |
| 2506 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2507 | *'debug'* |
| 2508 | 'debug' string (default "") |
| 2509 | global |
| 2510 | {not in Vi} |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 2511 | These values can be used: |
| 2512 | msg Error messages that would otherwise be omitted will be given |
| 2513 | anyway. |
| 2514 | throw Error messages that would otherwise be omitted will be given |
| 2515 | anyway and also throw an exception and set |v:errmsg|. |
| 2516 | beep A message will be given when otherwise only a beep would be |
| 2517 | produced. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 2518 | The values can be combined, separated by a comma. |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 2519 | "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
| 2520 | 'indentexpr'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2521 | |
| 2522 | *'define'* *'def'* |
| 2523 | 'define' 'def' string (default "^\s*#\s*define") |
| 2524 | global or local to buffer |global-local| |
| 2525 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2526 | 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] | 2527 | pattern, just like for the "/" command. This option is used for the |
| 2528 | commands like "[i" and "[d" |include-search|. The 'isident' option is |
| 2529 | used to recognize the defined name after the match: |
| 2530 | {match with 'define'}{non-ID chars}{defined name}{non-ID char} |
| 2531 | See |option-backslash| about inserting backslashes to include a space |
| 2532 | or backslash. |
| 2533 | The default value is for C programs. For C++ this value would be |
| 2534 | useful, to include const type declarations: > |
| 2535 | ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) |
| 2536 | < When using the ":set" command, you need to double the backslashes! |
| 2537 | |
| 2538 | *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* |
| 2539 | 'delcombine' 'deco' boolean (default off) |
| 2540 | global |
| 2541 | {not in Vi} |
| 2542 | {only available when compiled with the |+multi_byte| |
| 2543 | feature} |
| 2544 | If editing Unicode and this option is set, backspace and Normal mode |
| 2545 | "x" delete each combining character on its own. When it is off (the |
| 2546 | default) the character along with its combining characters are |
| 2547 | deleted. |
| 2548 | Note: When 'delcombine' is set "xx" may work different from "2x"! |
| 2549 | |
| 2550 | This is useful for Arabic, Hebrew and many other languages where one |
| 2551 | may have combining characters overtop of base characters, and want |
| 2552 | to remove only the combining ones. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 2553 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2554 | |
| 2555 | *'dictionary'* *'dict'* |
| 2556 | 'dictionary' 'dict' string (default "") |
| 2557 | global or local to buffer |global-local| |
| 2558 | {not in Vi} |
| 2559 | List of file names, separated by commas, that are used to lookup words |
| 2560 | for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should |
| 2561 | contain a list of words. This can be one word per line, or several |
| 2562 | words per line, separated by non-keyword characters (white space is |
| 2563 | preferred). Maximum line length is 510 bytes. |
Bram Moolenaar | 0b23879 | 2006-03-02 22:49:12 +0000 | [diff] [blame] | 2564 | When this option is empty, or an entry "spell" is present, spell |
| 2565 | checking is enabled the currently active spelling is used. |spell| |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2566 | 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] | 2567 | after a comma are ignored, otherwise spaces are included in the file |
| 2568 | name. See |option-backslash| about using backslashes. |
Bram Moolenaar | d8b0273 | 2005-01-14 21:48:43 +0000 | [diff] [blame] | 2569 | This has nothing to do with the |Dictionary| variable type. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2570 | Where to find a list of words? |
| 2571 | - On FreeBSD, there is the file "/usr/share/dict/words". |
| 2572 | - In the Simtel archive, look in the "msdos/linguist" directory. |
| 2573 | - In "miscfiles" of the GNU collection. |
| 2574 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2575 | directories from the list. This avoids problems when a future version |
| 2576 | uses another default. |
| 2577 | Backticks cannot be used in this option for security reasons. |
| 2578 | |
| 2579 | *'diff'* *'nodiff'* |
| 2580 | 'diff' boolean (default off) |
| 2581 | local to window |
| 2582 | {not in Vi} |
| 2583 | {not available when compiled without the |+diff| |
| 2584 | feature} |
| 2585 | Join the current window in the group of windows that shows differences |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2586 | between files. See |vimdiff|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2587 | |
| 2588 | *'dex'* *'diffexpr'* |
| 2589 | 'diffexpr' 'dex' string (default "") |
| 2590 | global |
| 2591 | {not in Vi} |
| 2592 | {not available when compiled without the |+diff| |
| 2593 | feature} |
| 2594 | Expression which is evaluated to obtain an ed-style diff file from two |
| 2595 | versions of a file. See |diff-diffexpr|. |
| 2596 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2597 | security reasons. |
| 2598 | |
| 2599 | *'dip'* *'diffopt'* |
| 2600 | 'diffopt' 'dip' string (default "filler") |
| 2601 | global |
| 2602 | {not in Vi} |
| 2603 | {not available when compiled without the |+diff| |
| 2604 | feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2605 | Option settings for diff mode. It can consist of the following items. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2606 | All are optional. Items must be separated by a comma. |
| 2607 | |
| 2608 | filler Show filler lines, to keep the text |
| 2609 | synchronized with a window that has inserted |
| 2610 | lines at the same position. Mostly useful |
| 2611 | when windows are side-by-side and 'scrollbind' |
| 2612 | is set. |
| 2613 | |
| 2614 | context:{n} Use a context of {n} lines between a change |
| 2615 | and a fold that contains unchanged lines. |
| 2616 | When omitted a context of six lines is used. |
| 2617 | See |fold-diff|. |
| 2618 | |
| 2619 | icase Ignore changes in case of text. "a" and "A" |
| 2620 | are considered the same. Adds the "-i" flag |
| 2621 | to the "diff" command if 'diffexpr' is empty. |
| 2622 | |
| 2623 | iwhite Ignore changes in amount of white space. Adds |
| 2624 | the "-b" flag to the "diff" command if |
| 2625 | 'diffexpr' is empty. Check the documentation |
| 2626 | of the "diff" command for what this does |
| 2627 | exactly. It should ignore adding trailing |
| 2628 | white space, but not leading white space. |
| 2629 | |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 2630 | horizontal Start diff mode with horizontal splits (unless |
| 2631 | explicitly specified otherwise). |
| 2632 | |
| 2633 | vertical Start diff mode with vertical splits (unless |
| 2634 | explicitly specified otherwise). |
| 2635 | |
Bram Moolenaar | 97ce419 | 2017-12-01 20:35:58 +0100 | [diff] [blame] | 2636 | hiddenoff Do not use diff mode for a buffer when it |
| 2637 | becomes hidden. |
| 2638 | |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 2639 | foldcolumn:{n} Set the 'foldcolumn' option to {n} when |
| 2640 | starting diff mode. Without this 2 is used. |
| 2641 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2642 | Examples: > |
| 2643 | |
| 2644 | :set diffopt=filler,context:4 |
| 2645 | :set diffopt= |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 2646 | :set diffopt=filler,foldcolumn:3 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2647 | < |
| 2648 | *'digraph'* *'dg'* *'nodigraph'* *'nodg'* |
| 2649 | 'digraph' 'dg' boolean (default off) |
| 2650 | global |
| 2651 | {not in Vi} |
| 2652 | {not available when compiled without the |+digraphs| |
| 2653 | feature} |
| 2654 | Enable the entering of digraphs in Insert mode with {char1} <BS> |
| 2655 | {char2}. See |digraphs|. |
| 2656 | NOTE: This option is reset when 'compatible' is set. |
| 2657 | |
| 2658 | *'directory'* *'dir'* |
| 2659 | 'directory' 'dir' string (default for Amiga: ".,t:", |
Bram Moolenaar | dfb1841 | 2013-12-11 18:53:29 +0100 | [diff] [blame] | 2660 | for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2661 | for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2662 | global |
| 2663 | List of directory names for the swap file, separated with commas. |
| 2664 | - The swap file will be created in the first directory where this is |
| 2665 | possible. |
| 2666 | - Empty means that no swap file will be used (recovery is |
| 2667 | impossible!). |
| 2668 | - A directory "." means to put the swap file in the same directory as |
| 2669 | the edited file. On Unix, a dot is prepended to the file name, so |
| 2670 | it doesn't show in a directory listing. On MS-Windows the "hidden" |
| 2671 | attribute is set and a dot prepended if possible. |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 2672 | - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2673 | put the swap file relative to where the edited file is. The leading |
| 2674 | "." is replaced with the path name of the edited file. |
Bram Moolenaar | 83bab71 | 2005-08-01 21:58:57 +0000 | [diff] [blame] | 2675 | - For Unix and Win32, if a directory ends in two path separators "//" |
| 2676 | or "\\", the swap file name will be built from the complete path to |
| 2677 | the file with all path separators substituted to percent '%' signs. |
| 2678 | This will ensure file name uniqueness in the preserve directory. |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 2679 | On Win32, when a separating comma is following, you must use "//", |
| 2680 | since "\\" will include the comma in the file name. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2681 | - Spaces after the comma are ignored, other spaces are considered part |
| 2682 | of the directory name. To have a space at the start of a directory |
| 2683 | name, precede it with a backslash. |
| 2684 | - To include a comma in a directory name precede it with a backslash. |
| 2685 | - A directory name may end in an ':' or '/'. |
| 2686 | - Environment variables are expanded |:set_env|. |
| 2687 | - Careful with '\' characters, type one before a space, type two to |
| 2688 | get one in the option (see |option-backslash|), for example: > |
| 2689 | :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces |
| 2690 | < - For backwards compatibility with Vim version 3.0 a '>' at the start |
| 2691 | of the option is removed. |
| 2692 | Using "." first in the list is recommended. This means that editing |
| 2693 | the same file twice will result in a warning. Using "/tmp" on Unix is |
| 2694 | discouraged: When the system crashes you lose the swap file. |
| 2695 | "/var/tmp" is often not cleared when rebooting, thus is a better |
| 2696 | choice than "/tmp". But it can contain a lot of files, your swap |
| 2697 | files get lost in the crowd. That is why a "tmp" directory in your |
| 2698 | home directory is tried first. |
| 2699 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 2700 | directories from the list. This avoids problems when a future version |
| 2701 | uses another default. |
| 2702 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2703 | security reasons. |
| 2704 | {Vi: directory to put temp file in, defaults to "/tmp"} |
| 2705 | |
| 2706 | *'display'* *'dy'* |
Bram Moolenaar | bc8801c | 2016-08-02 21:04:33 +0200 | [diff] [blame] | 2707 | 'display' 'dy' string (default "", set to "truncate" in |
| 2708 | |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2709 | global |
| 2710 | {not in Vi} |
| 2711 | Change the way text is displayed. This is comma separated list of |
| 2712 | flags: |
| 2713 | lastline When included, as much as possible of the last line |
Bram Moolenaar | ad9c2a0 | 2016-07-27 23:26:04 +0200 | [diff] [blame] | 2714 | in a window will be displayed. "@@@" is put in the |
| 2715 | last columns of the last screen line to indicate the |
| 2716 | rest of the line is not displayed. |
| 2717 | truncate Like "lastline", but "@@@" is displayed in the first |
| 2718 | column of the last screen line. Overrules "lastline". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2719 | uhex Show unprintable characters hexadecimal as <xx> |
| 2720 | instead of using ^C and ~C. |
| 2721 | |
Bram Moolenaar | d079690 | 2016-09-16 20:02:31 +0200 | [diff] [blame] | 2722 | When neither "lastline" nor "truncate" is included, a last line that |
Bram Moolenaar | ad9c2a0 | 2016-07-27 23:26:04 +0200 | [diff] [blame] | 2723 | doesn't fit is replaced with "@" lines. |
| 2724 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2725 | *'eadirection'* *'ead'* |
| 2726 | 'eadirection' 'ead' string (default "both") |
| 2727 | global |
| 2728 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 2729 | {not available when compiled without the |+vertsplit| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2730 | feature} |
| 2731 | Tells when the 'equalalways' option applies: |
| 2732 | ver vertically, width of windows is not affected |
| 2733 | hor horizontally, height of windows is not affected |
| 2734 | both width and height of windows is affected |
| 2735 | |
| 2736 | *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* |
| 2737 | 'edcompatible' 'ed' boolean (default off) |
| 2738 | global |
| 2739 | Makes the 'g' and 'c' flags of the ":substitute" command to be |
| 2740 | toggled each time the flag is given. See |complex-change|. See |
| 2741 | also 'gdefault' option. |
Bram Moolenaar | b4d6c3e | 2017-05-27 16:45:17 +0200 | [diff] [blame] | 2742 | Switching this option on may break plugins! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2743 | |
Bram Moolenaar | 03413f4 | 2016-04-12 21:07:15 +0200 | [diff] [blame] | 2744 | *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 2745 | 'emoji' 'emo' boolean (default: on) |
| 2746 | global |
| 2747 | {not in Vi} |
| 2748 | {only available when compiled with the |+multi_byte| |
| 2749 | feature} |
| 2750 | When on all Unicode emoji characters are considered to be full width. |
| 2751 | |
| 2752 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2753 | *'encoding'* *'enc'* *E543* |
| 2754 | 'encoding' 'enc' string (default: "latin1" or value from $LANG) |
| 2755 | global |
| 2756 | {only available when compiled with the |+multi_byte| |
| 2757 | feature} |
| 2758 | {not in Vi} |
| 2759 | Sets the character encoding used inside Vim. It applies to text in |
| 2760 | the buffers, registers, Strings in expressions, text stored in the |
| 2761 | viminfo file, etc. It sets the kind of characters which Vim can work |
| 2762 | with. See |encoding-names| for the possible values. |
| 2763 | |
| 2764 | NOTE: Changing this option will not change the encoding of the |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 2765 | 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] | 2766 | It should normally be kept at its default value, or set when Vim |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 2767 | starts up. See |multibyte|. To reload the menus see |:menutrans|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2768 | |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2769 | This option cannot be set from a |modeline|. It would most likely |
| 2770 | corrupt the text. |
| 2771 | |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 2772 | NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding' |
| 2773 | to "utf-8". Although care has been taken to allow different values of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2774 | 'encoding', "utf-8" is the natural choice for the environment and |
| 2775 | avoids unnecessary conversion overhead. "utf-8" has not been made |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2776 | the default to prevent different behavior of the GUI and terminal |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2777 | versions, and to avoid changing the encoding of newly created files |
| 2778 | without your knowledge (in case 'fileencodings' is empty). |
| 2779 | |
| 2780 | The character encoding of files can be different from 'encoding'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2781 | This is specified with 'fileencoding'. The conversion is done with |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2782 | iconv() or as specified with 'charconvert'. |
| 2783 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2784 | If you need to know whether 'encoding' is a multi-byte encoding, you |
| 2785 | can use: > |
| 2786 | if has("multi_byte_encoding") |
| 2787 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2788 | Normally 'encoding' will be equal to your current locale. This will |
| 2789 | be the default if Vim recognizes your environment settings. If |
| 2790 | 'encoding' is not set to the current locale, 'termencoding' must be |
| 2791 | set to convert typed and displayed text. See |encoding-table|. |
| 2792 | |
| 2793 | When you set this option, it fires the |EncodingChanged| autocommand |
| 2794 | event so that you can set up fonts if necessary. |
| 2795 | |
| 2796 | When the option is set, the value is converted to lowercase. Thus |
| 2797 | you can set it with uppercase values too. Underscores are translated |
| 2798 | to '-' signs. |
| 2799 | When the encoding is recognized, it is changed to the standard name. |
| 2800 | For example "Latin-1" becomes "latin1", "ISO_88592" becomes |
| 2801 | "iso-8859-2" and "utf8" becomes "utf-8". |
| 2802 | |
| 2803 | Note: "latin1" is also used when the encoding could not be detected. |
| 2804 | This only works when editing files in the same encoding! When the |
| 2805 | actual character set is not latin1, make sure 'fileencoding' and |
| 2806 | 'fileencodings' are empty. When conversion is needed, switch to using |
| 2807 | utf-8. |
| 2808 | |
| 2809 | When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. |
| 2810 | You don't notice this while editing, but it does matter for the |
| 2811 | |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus |
| 2812 | setting 'encoding' to one of these values instead of utf-8 only has |
| 2813 | effect for encoding used for files when 'fileencoding' is empty. |
| 2814 | |
Bram Moolenaar | 661b182 | 2005-07-28 22:36:45 +0000 | [diff] [blame] | 2815 | When 'encoding' is set to a Unicode encoding, and 'fileencodings' was |
| 2816 | not set yet, the default for 'fileencodings' is changed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2817 | |
| 2818 | *'endofline'* *'eol'* *'noendofline'* *'noeol'* |
| 2819 | 'endofline' 'eol' boolean (default on) |
| 2820 | local to buffer |
| 2821 | {not in Vi} |
| 2822 | When writing a file and this option is off and the 'binary' option |
Bram Moolenaar | 34d72d4 | 2015-07-17 14:18:08 +0200 | [diff] [blame] | 2823 | is on, or 'fixeol' option is off, no <EOL> will be written for the |
| 2824 | last line in the file. This option is automatically set or reset when |
| 2825 | starting to edit a new file, depending on whether file has an <EOL> |
| 2826 | for the last line in the file. Normally you don't have to set or |
| 2827 | reset this option. |
| 2828 | When 'binary' is off and 'fixeol' is on the value is not used when |
| 2829 | writing the file. When 'binary' is on or 'fixeol' is off it is used |
| 2830 | to remember the presence of a <EOL> for the last line in the file, so |
| 2831 | that when you write the file the situation from the original file can |
| 2832 | be kept. But you can change it if you want to. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2833 | |
| 2834 | *'equalalways'* *'ea'* *'noequalalways'* *'noea'* |
| 2835 | 'equalalways' 'ea' boolean (default on) |
| 2836 | global |
| 2837 | {not in Vi} |
| 2838 | When on, all the windows are automatically made the same size after |
Bram Moolenaar | 009b259 | 2004-10-24 19:18:58 +0000 | [diff] [blame] | 2839 | splitting or closing a window. This also happens the moment the |
| 2840 | option is switched on. When off, splitting a window will reduce the |
| 2841 | size of the current window and leave the other windows the same. When |
| 2842 | closing a window the extra lines are given to the window next to it |
| 2843 | (depending on 'splitbelow' and 'splitright'). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2844 | When mixing vertically and horizontally split windows, a minimal size |
| 2845 | is computed and some windows may be larger if there is room. The |
| 2846 | 'eadirection' option tells in which direction the size is affected. |
Bram Moolenaar | 67f7131 | 2007-08-12 14:55:56 +0000 | [diff] [blame] | 2847 | Changing the height and width of a window can be avoided by setting |
| 2848 | 'winfixheight' and 'winfixwidth', respectively. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2849 | If a window size is specified when creating a new window sizes are |
| 2850 | currently not equalized (it's complicated, but may be implemented in |
| 2851 | the future). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2852 | |
| 2853 | *'equalprg'* *'ep'* |
| 2854 | 'equalprg' 'ep' string (default "") |
| 2855 | global or local to buffer |global-local| |
| 2856 | {not in Vi} |
| 2857 | External program to use for "=" command. When this option is empty |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 2858 | the internal formatting functions are used; either 'lisp', 'cindent' |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2859 | or 'indentexpr'. When Vim was compiled without internal formatting, |
| 2860 | the "indent" program is used. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2861 | Environment variables are expanded |:set_env|. See |option-backslash| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2862 | about including spaces and backslashes. |
| 2863 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2864 | security reasons. |
| 2865 | |
| 2866 | *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* |
| 2867 | 'errorbells' 'eb' boolean (default off) |
| 2868 | global |
| 2869 | Ring the bell (beep or screen flash) for error messages. This only |
| 2870 | makes a difference for error messages, the bell will be used always |
| 2871 | 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] | 2872 | mode). See 'visualbell' on how to make the bell behave like a beep, |
Bram Moolenaar | 165bc69 | 2015-07-21 17:53:25 +0200 | [diff] [blame] | 2873 | screen flash or do nothing. See 'belloff' to finetune when to ring the |
| 2874 | bell. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2875 | |
| 2876 | *'errorfile'* *'ef'* |
| 2877 | 'errorfile' 'ef' string (Amiga default: "AztecC.Err", |
| 2878 | others: "errors.err") |
| 2879 | global |
| 2880 | {not in Vi} |
| 2881 | {not available when compiled without the |+quickfix| |
| 2882 | feature} |
| 2883 | Name of the errorfile for the QuickFix mode (see |:cf|). |
| 2884 | When the "-q" command-line argument is used, 'errorfile' is set to the |
| 2885 | following argument. See |-q|. |
| 2886 | NOT used for the ":make" command. See 'makeef' for that. |
| 2887 | Environment variables are expanded |:set_env|. |
| 2888 | See |option-backslash| about including spaces and backslashes. |
| 2889 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2890 | security reasons. |
| 2891 | |
| 2892 | *'errorformat'* *'efm'* |
| 2893 | 'errorformat' 'efm' string (default is very long) |
| 2894 | global or local to buffer |global-local| |
| 2895 | {not in Vi} |
| 2896 | {not available when compiled without the |+quickfix| |
| 2897 | feature} |
| 2898 | Scanf-like description of the format for the lines in the error file |
| 2899 | (see |errorformat|). |
| 2900 | |
| 2901 | *'esckeys'* *'ek'* *'noesckeys'* *'noek'* |
| 2902 | 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) |
| 2903 | global |
| 2904 | {not in Vi} |
| 2905 | Function keys that start with an <Esc> are recognized in Insert |
| 2906 | mode. When this option is off, the cursor and function keys cannot be |
| 2907 | used in Insert mode if they start with an <Esc>. The advantage of |
| 2908 | this is that the single <Esc> is recognized immediately, instead of |
| 2909 | after one second. Instead of resetting this option, you might want to |
| 2910 | try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that |
| 2911 | when 'esckeys' is off, you can still map anything, but the cursor keys |
| 2912 | won't work by default. |
| 2913 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 2914 | set and to the Vim default value when 'compatible' is reset. |
| 2915 | |
| 2916 | *'eventignore'* *'ei'* |
| 2917 | 'eventignore' 'ei' string (default "") |
| 2918 | global |
| 2919 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2920 | A list of autocommand event names, which are to be ignored. |
Bram Moolenaar | f193fff | 2006-04-27 00:02:13 +0000 | [diff] [blame] | 2921 | When set to "all" or when "all" is one of the items, all autocommand |
| 2922 | events are ignored, autocommands will not be executed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2923 | Otherwise this is a comma separated list of event names. Example: > |
| 2924 | :set ei=WinEnter,WinLeave |
| 2925 | < |
| 2926 | *'expandtab'* *'et'* *'noexpandtab'* *'noet'* |
| 2927 | 'expandtab' 'et' boolean (default off) |
| 2928 | local to buffer |
| 2929 | {not in Vi} |
| 2930 | In Insert mode: Use the appropriate number of spaces to insert a |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 2931 | <Tab>. Spaces are used in indents with the '>' and '<' commands and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2932 | when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 2933 | on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 2934 | This option is reset when the 'paste' option is set and restored when |
| 2935 | the 'paste' option is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2936 | NOTE: This option is reset when 'compatible' is set. |
| 2937 | |
| 2938 | *'exrc'* *'ex'* *'noexrc'* *'noex'* |
| 2939 | 'exrc' 'ex' boolean (default off) |
| 2940 | global |
| 2941 | {not in Vi} |
| 2942 | Enables the reading of .vimrc, .exrc and .gvimrc in the current |
Bram Moolenaar | 36f44c2 | 2016-08-28 18:17:20 +0200 | [diff] [blame] | 2943 | directory. |
| 2944 | |
| 2945 | Setting this option is a potential security leak. E.g., consider |
| 2946 | unpacking a package or fetching files from github, a .vimrc in there |
| 2947 | might be a trojan horse. BETTER NOT SET THIS OPTION! |
| 2948 | Instead, define an autocommand in your .vimrc to set options for a |
| 2949 | matching directory. |
| 2950 | |
| 2951 | If you do switch this option on you should also consider setting the |
| 2952 | 'secure' option (see |initialization|). |
| 2953 | Also see |.vimrc| and |gui-init|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2954 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2955 | security reasons. |
| 2956 | |
| 2957 | *'fileencoding'* *'fenc'* *E213* |
| 2958 | 'fileencoding' 'fenc' string (default: "") |
| 2959 | local to buffer |
| 2960 | {only available when compiled with the |+multi_byte| |
| 2961 | feature} |
| 2962 | {not in Vi} |
| 2963 | Sets the character encoding for the file of this buffer. |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2964 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2965 | When 'fileencoding' is different from 'encoding', conversion will be |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2966 | done when writing the file. For reading see below. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2967 | When 'fileencoding' is empty, the same value as 'encoding' will be |
| 2968 | used (no conversion when reading or writing a file). |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 2969 | No error will be given when the value is set, only when it is used, |
| 2970 | only when writing a file. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2971 | Conversion will also be done when 'encoding' and 'fileencoding' are |
| 2972 | both a Unicode encoding and 'fileencoding' is not utf-8. That's |
| 2973 | because internally Unicode is always stored as utf-8. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2974 | WARNING: Conversion can cause loss of information! When |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 2975 | 'encoding' is "utf-8" or another Unicode encoding, conversion |
| 2976 | is most likely done in a way that the reverse conversion |
| 2977 | results in the same text. When 'encoding' is not "utf-8" some |
| 2978 | characters may be lost! |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2979 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2980 | See 'encoding' for the possible values. Additionally, values may be |
| 2981 | specified that can be handled by the converter, see |
| 2982 | |mbyte-conversion|. |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2983 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2984 | When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 2985 | To read a file in a certain encoding it won't work by setting |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 2986 | 'fileencoding', use the |++enc| argument. One exception: when |
| 2987 | 'fileencodings' is empty the value of 'fileencoding' is used. |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 2988 | For a new file the global value of 'fileencoding' is used. |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2989 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2990 | Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 2991 | When the option is set, the value is converted to lowercase. Thus |
| 2992 | you can set it with uppercase values too. '_' characters are |
| 2993 | replaced with '-'. If a name is recognized from the list for |
| 2994 | 'encoding', it is replaced by the standard name. For example |
| 2995 | "ISO8859-2" becomes "iso-8859-2". |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2996 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 2997 | When this option is set, after starting to edit a file, the 'modified' |
| 2998 | option is set, because the file would be different when written. |
Bram Moolenaar | 865242e | 2010-07-14 21:12:05 +0200 | [diff] [blame] | 2999 | |
| 3000 | Keep in mind that changing 'fenc' from a modeline happens |
| 3001 | AFTER the text has been read, thus it applies to when the file will be |
| 3002 | written. If you do set 'fenc' in a modeline, you might want to set |
| 3003 | 'nomodified' to avoid not being able to ":q". |
| 3004 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3005 | This option can not be changed when 'modifiable' is off. |
| 3006 | |
| 3007 | *'fe'* |
| 3008 | NOTE: Before version 6.0 this option specified the encoding for the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3009 | whole of Vim, this was a mistake. Now use 'encoding' instead. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3010 | old short name was 'fe', which is no longer used. |
| 3011 | |
| 3012 | *'fileencodings'* *'fencs'* |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 3013 | 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 3014 | "ucs-bom,utf-8,default,latin1" when |
| 3015 | 'encoding' is set to a Unicode value) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3016 | global |
| 3017 | {only available when compiled with the |+multi_byte| |
| 3018 | feature} |
| 3019 | {not in Vi} |
| 3020 | This is a list of character encodings considered when starting to edit |
| 3021 | an existing file. When a file is read, Vim tries to use the first |
| 3022 | mentioned character encoding. If an error is detected, the next one |
| 3023 | in the list is tried. When an encoding is found that works, |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3024 | 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3025 | an empty string, which means the value of 'encoding' is used. |
| 3026 | WARNING: Conversion can cause loss of information! When |
| 3027 | 'encoding' is "utf-8" (or one of the other Unicode variants) |
| 3028 | conversion is most likely done in a way that the reverse |
| 3029 | conversion results in the same text. When 'encoding' is not |
Bram Moolenaar | c6d8db7 | 2005-12-13 20:04:55 +0000 | [diff] [blame] | 3030 | "utf-8" some non-ASCII characters may be lost! You can use |
| 3031 | the |++bad| argument to specify what is done with characters |
| 3032 | that can't be converted. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3033 | For an empty file or a file with only ASCII characters most encodings |
| 3034 | will work and the first entry of 'fileencodings' will be used (except |
| 3035 | "ucs-bom", which requires the BOM to be present). If you prefer |
| 3036 | another encoding use an BufReadPost autocommand event to test if your |
| 3037 | preferred encoding is to be used. Example: > |
| 3038 | au BufReadPost * if search('\S', 'w') == 0 | |
| 3039 | \ set fenc=iso-2022-jp | endif |
| 3040 | < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain |
| 3041 | non-blank characters. |
Bram Moolenaar | c6d8db7 | 2005-12-13 20:04:55 +0000 | [diff] [blame] | 3042 | When the |++enc| argument is used then the value of 'fileencodings' is |
| 3043 | not used. |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 3044 | Note that 'fileencodings' is not used for a new file, the global value |
| 3045 | of 'fileencoding' is used instead. You can set it with: > |
| 3046 | :setglobal fenc=iso-8859-2 |
| 3047 | < This means that a non-existing file may get a different encoding than |
| 3048 | an empty file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3049 | The special value "ucs-bom" can be used to check for a Unicode BOM |
| 3050 | (Byte Order Mark) at the start of the file. It must not be preceded |
| 3051 | by "utf-8" or another Unicode encoding for this to work properly. |
| 3052 | An entry for an 8-bit encoding (e.g., "latin1") should be the last, |
| 3053 | because Vim cannot detect an error, thus the encoding is always |
| 3054 | accepted. |
Bram Moolenaar | 1cd871b | 2004-12-19 22:46:22 +0000 | [diff] [blame] | 3055 | The special value "default" can be used for the encoding from the |
| 3056 | environment. This is the default value for 'encoding'. It is useful |
| 3057 | when 'encoding' is set to "utf-8" and your environment uses a |
| 3058 | non-latin1 encoding, such as Russian. |
Bram Moolenaar | ca003e1 | 2006-03-17 23:19:38 +0000 | [diff] [blame] | 3059 | When 'encoding' is "utf-8" and a file contains an illegal byte |
| 3060 | sequence it won't be recognized as UTF-8. You can use the |8g8| |
| 3061 | command to find the illegal byte sequence. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3062 | WRONG VALUES: WHAT'S WRONG: |
| 3063 | latin1,utf-8 "latin1" will always be used |
| 3064 | utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 |
| 3065 | file |
| 3066 | cp1250,latin1 "cp1250" will always be used |
| 3067 | If 'fileencodings' is empty, 'fileencoding' is not modified. |
| 3068 | See 'fileencoding' for the possible values. |
| 3069 | Setting this option does not have an effect until the next time a file |
| 3070 | is read. |
| 3071 | |
| 3072 | *'fileformat'* *'ff'* |
| 3073 | 'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", |
| 3074 | Unix default: "unix", |
| 3075 | Macintosh default: "mac") |
| 3076 | local to buffer |
| 3077 | {not in Vi} |
| 3078 | This gives the <EOL> of the current buffer, which is used for |
| 3079 | reading/writing the buffer from/to a file: |
| 3080 | dos <CR> <NL> |
| 3081 | unix <NL> |
| 3082 | mac <CR> |
| 3083 | When "dos" is used, CTRL-Z at the end of a file is ignored. |
| 3084 | See |file-formats| and |file-read|. |
| 3085 | For the character encoding of the file see 'fileencoding'. |
| 3086 | When 'binary' is set, the value of 'fileformat' is ignored, file I/O |
Bram Moolenaar | bf88493 | 2013-04-05 22:26:15 +0200 | [diff] [blame] | 3087 | works like it was set to "unix". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3088 | This option is set automatically when starting to edit a file and |
| 3089 | 'fileformats' is not empty and 'binary' is off. |
| 3090 | When this option is set, after starting to edit a file, the 'modified' |
| 3091 | option is set, because the file would be different when written. |
| 3092 | This option can not be changed when 'modifiable' is off. |
| 3093 | For backwards compatibility: When this option is set to "dos", |
| 3094 | 'textmode' is set, otherwise 'textmode' is reset. |
| 3095 | |
| 3096 | *'fileformats'* *'ffs'* |
| 3097 | 'fileformats' 'ffs' string (default: |
| 3098 | Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", |
| 3099 | Vim Unix: "unix,dos", |
| 3100 | Vim Mac: "mac,unix,dos", |
| 3101 | Vi Cygwin: "unix,dos", |
| 3102 | Vi others: "") |
| 3103 | global |
| 3104 | {not in Vi} |
| 3105 | This gives the end-of-line (<EOL>) formats that will be tried when |
| 3106 | starting to edit a new buffer and when reading a file into an existing |
| 3107 | buffer: |
| 3108 | - When empty, the format defined with 'fileformat' will be used |
| 3109 | always. It is not set automatically. |
| 3110 | - 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] | 3111 | is opened. 'fileformat' is set accordingly for that buffer. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3112 | 'fileformats' name will be used when a file is read into an existing |
| 3113 | buffer, no matter what 'fileformat' for that buffer is set to. |
| 3114 | - When more than one name is present, separated by commas, automatic |
| 3115 | <EOL> detection will be done when reading a file. When starting to |
| 3116 | edit a file, a check is done for the <EOL>: |
| 3117 | 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", |
| 3118 | 'fileformat' is set to "dos". |
| 3119 | 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3120 | 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] | 3121 | preceding <CR>, "unix" is preferred over "dos". |
Bram Moolenaar | 2b8388b | 2015-02-28 13:11:45 +0100 | [diff] [blame] | 3122 | 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
| 3123 | if 'fileformats' includes "mac", 'fileformat' is set to "mac". |
Bram Moolenaar | 0065906 | 2010-09-21 22:34:02 +0200 | [diff] [blame] | 3124 | This means that "mac" is only chosen when: |
| 3125 | "unix" is not present or no <NL> is found in the file, and |
| 3126 | "dos" is not present or no <CR><NL> is found in the file. |
| 3127 | Except: if "unix" was chosen, but there is a <CR> before |
| 3128 | the first <NL>, and there appear to be more <CR>s than <NL>s in |
Bram Moolenaar | 166af9b | 2010-11-16 20:34:40 +0100 | [diff] [blame] | 3129 | the first few lines, "mac" is used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3130 | 4. If 'fileformat' is still not set, the first name from |
| 3131 | 'fileformats' is used. |
| 3132 | When reading a file into an existing buffer, the same is done, but |
| 3133 | this happens like 'fileformat' has been set appropriately for that |
| 3134 | file only, the option is not changed. |
| 3135 | When 'binary' is set, the value of 'fileformats' is not used. |
| 3136 | |
Bram Moolenaar | 4f3f668 | 2016-03-26 23:01:59 +0100 | [diff] [blame] | 3137 | When Vim starts up with an empty buffer the first item is used. You |
| 3138 | can overrule this by setting 'fileformat' in your .vimrc. |
Bram Moolenaar | 81af925 | 2010-12-10 20:35:50 +0100 | [diff] [blame] | 3139 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3140 | For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 3141 | are ":source"ed and for vimrc files, automatic <EOL> detection may be |
| 3142 | done: |
| 3143 | - When 'fileformats' is empty, there is no automatic detection. Dos |
| 3144 | format will be used. |
| 3145 | - When 'fileformats' is set to one or more names, automatic detection |
| 3146 | is done. This is based on the first <NL> in the file: If there is a |
| 3147 | <CR> in front of it, Dos format is used, otherwise Unix format is |
| 3148 | used. |
| 3149 | Also see |file-formats|. |
| 3150 | For backwards compatibility: When this option is set to an empty |
| 3151 | string or one format (no comma is included), 'textauto' is reset, |
| 3152 | otherwise 'textauto' is set. |
| 3153 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 3154 | set and to the Vim default value when 'compatible' is reset. |
| 3155 | |
Bram Moolenaar | bf88493 | 2013-04-05 22:26:15 +0200 | [diff] [blame] | 3156 | *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
| 3157 | 'fileignorecase' 'fic' boolean (default on for systems where case in file |
| 3158 | names is normally ignored) |
Bram Moolenaar | 71afbfe | 2013-03-19 16:49:16 +0100 | [diff] [blame] | 3159 | global |
| 3160 | {not in Vi} |
| 3161 | When set case is ignored when using file names and directories. |
| 3162 | See 'wildignorecase' for only ignoring case when doing completion. |
| 3163 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3164 | *'filetype'* *'ft'* |
| 3165 | 'filetype' 'ft' string (default: "") |
| 3166 | local to buffer |
| 3167 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3168 | When this option is set, the FileType autocommand event is triggered. |
| 3169 | All autocommands that match with the value of this option will be |
| 3170 | executed. Thus the value of 'filetype' is used in place of the file |
| 3171 | name. |
| 3172 | Otherwise this option does not always reflect the current file type. |
| 3173 | This option is normally set when the file type is detected. To enable |
| 3174 | this use the ":filetype on" command. |:filetype| |
| 3175 | Setting this option to a different value is most useful in a modeline, |
| 3176 | for a file for which the file type is not automatically recognized. |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 3177 | Example, for in an IDL file: |
| 3178 | /* vim: set filetype=idl : */ ~ |
| 3179 | |FileType| |filetypes| |
| 3180 | When a dot appears in the value then this separates two filetype |
| 3181 | names. Example: |
| 3182 | /* vim: set filetype=c.doxygen : */ ~ |
| 3183 | This will use the "c" filetype first, then the "doxygen" filetype. |
| 3184 | This works both for filetype plugins and for syntax files. More than |
| 3185 | one dot may appear. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3186 | This option is not copied to another buffer, independent of the 's' or |
| 3187 | 'S' flag in 'cpoptions'. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3188 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3189 | |
| 3190 | *'fillchars'* *'fcs'* |
| 3191 | 'fillchars' 'fcs' string (default "vert:|,fold:-") |
| 3192 | global |
| 3193 | {not in Vi} |
| 3194 | {not available when compiled without the |+windows| |
| 3195 | and |+folding| features} |
| 3196 | Characters to fill the statuslines and vertical separators. |
| 3197 | It is a comma separated list of items: |
| 3198 | |
| 3199 | item default Used for ~ |
| 3200 | stl:c ' ' or '^' statusline of the current window |
Bram Moolenaar | 38a5563 | 2016-02-15 22:07:32 +0100 | [diff] [blame] | 3201 | stlnc:c ' ' or '=' statusline of the non-current windows |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3202 | vert:c '|' vertical separators |:vsplit| |
| 3203 | fold:c '-' filling 'foldtext' |
| 3204 | diff:c '-' deleted lines of the 'diff' option |
| 3205 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3206 | Any one that is omitted will fall back to the default. For "stl" and |
Bram Moolenaar | 38a5563 | 2016-02-15 22:07:32 +0100 | [diff] [blame] | 3207 | "stlnc" the space will be used when there is highlighting, '^' or '=' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3208 | otherwise. |
| 3209 | |
| 3210 | Example: > |
Bram Moolenaar | 38a5563 | 2016-02-15 22:07:32 +0100 | [diff] [blame] | 3211 | :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3212 | < This is similar to the default, except that these characters will also |
| 3213 | be used when there is highlighting. |
| 3214 | |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3215 | for "stl" and "stlnc" only single-byte values are supported. |
| 3216 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3217 | The highlighting used for these items: |
| 3218 | item highlight group ~ |
| 3219 | stl:c StatusLine |hl-StatusLine| |
| 3220 | stlnc:c StatusLineNC |hl-StatusLineNC| |
| 3221 | vert:c VertSplit |hl-VertSplit| |
| 3222 | fold:c Folded |hl-Folded| |
| 3223 | diff:c DiffDelete |hl-DiffDelete| |
| 3224 | |
Bram Moolenaar | 34d72d4 | 2015-07-17 14:18:08 +0200 | [diff] [blame] | 3225 | *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
| 3226 | 'fixendofline' 'fixeol' boolean (default on) |
| 3227 | local to buffer |
| 3228 | {not in Vi} |
| 3229 | When writing a file and this option is on, <EOL> at the end of file |
| 3230 | will be restored if missing. Turn this option off if you want to |
| 3231 | preserve the situation from the original file. |
| 3232 | When the 'binary' option is set the value of this option doesn't |
| 3233 | matter. |
| 3234 | See the 'endofline' option. |
| 3235 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3236 | *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 3237 | 'fkmap' 'fk' boolean (default off) *E198* |
| 3238 | global |
| 3239 | {not in Vi} |
| 3240 | {only available when compiled with the |+rightleft| |
| 3241 | feature} |
| 3242 | When on, the keyboard is mapped for the Farsi character set. |
| 3243 | Normally you would set 'allowrevins' and use CTRL-_ in insert mode to |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3244 | toggle this option |i_CTRL-_|. See |farsi.txt|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3245 | |
| 3246 | *'foldclose'* *'fcl'* |
| 3247 | 'foldclose' 'fcl' string (default "") |
| 3248 | global |
| 3249 | {not in Vi} |
| 3250 | {not available when compiled without the |+folding| |
| 3251 | feature} |
| 3252 | When set to "all", a fold is closed when the cursor isn't in it and |
| 3253 | its level is higher than 'foldlevel'. Useful if you want folds to |
| 3254 | automatically close when moving out of them. |
| 3255 | |
| 3256 | *'foldcolumn'* *'fdc'* |
| 3257 | 'foldcolumn' 'fdc' number (default 0) |
| 3258 | local to window |
| 3259 | {not in Vi} |
| 3260 | {not available when compiled without the |+folding| |
| 3261 | feature} |
| 3262 | When non-zero, a column with the specified width is shown at the side |
| 3263 | of the window which indicates open and closed folds. The maximum |
| 3264 | value is 12. |
| 3265 | See |folding|. |
| 3266 | |
| 3267 | *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* |
| 3268 | 'foldenable' 'fen' boolean (default on) |
| 3269 | local to window |
| 3270 | {not in Vi} |
| 3271 | {not available when compiled without the |+folding| |
| 3272 | feature} |
| 3273 | When off, all folds are open. This option can be used to quickly |
| 3274 | switch between showing all text unfolded and viewing the text with |
| 3275 | folds (including manually opened or closed folds). It can be toggled |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3276 | with the |zi| command. The 'foldcolumn' will remain blank when |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3277 | 'foldenable' is off. |
| 3278 | This option is set by commands that create a new fold or close a fold. |
| 3279 | See |folding|. |
| 3280 | |
| 3281 | *'foldexpr'* *'fde'* |
| 3282 | 'foldexpr' 'fde' string (default: "0") |
| 3283 | local to window |
| 3284 | {not in Vi} |
| 3285 | {not available when compiled without the |+folding| |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 3286 | or |+eval| features} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3287 | The expression used for when 'foldmethod' is "expr". It is evaluated |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 3288 | for each line to obtain its fold level. See |fold-expr|. |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 3289 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 3290 | The expression will be evaluated in the |sandbox| if set from a |
| 3291 | modeline, see |sandbox-option|. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3292 | This option can't be set from a |modeline| when the 'diff' option is |
| 3293 | on. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 3294 | |
| 3295 | It is not allowed to change text or jump to another window while |
| 3296 | evaluating 'foldexpr' |textlock|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3297 | |
| 3298 | *'foldignore'* *'fdi'* |
| 3299 | 'foldignore' 'fdi' string (default: "#") |
| 3300 | local to window |
| 3301 | {not in Vi} |
| 3302 | {not available when compiled without the |+folding| |
| 3303 | feature} |
| 3304 | Used only when 'foldmethod' is "indent". Lines starting with |
| 3305 | characters in 'foldignore' will get their fold level from surrounding |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3306 | lines. White space is skipped before checking for this character. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3307 | The default "#" works well for C programs. See |fold-indent|. |
| 3308 | |
| 3309 | *'foldlevel'* *'fdl'* |
| 3310 | 'foldlevel' 'fdl' number (default: 0) |
| 3311 | local to window |
| 3312 | {not in Vi} |
| 3313 | {not available when compiled without the |+folding| |
| 3314 | feature} |
| 3315 | Sets the fold level: Folds with a higher level will be closed. |
| 3316 | Setting this option to zero will close all folds. Higher numbers will |
| 3317 | close fewer folds. |
| 3318 | This option is set by commands like |zm|, |zM| and |zR|. |
| 3319 | See |fold-foldlevel|. |
| 3320 | |
| 3321 | *'foldlevelstart'* *'fdls'* |
| 3322 | 'foldlevelstart' 'fdls' number (default: -1) |
| 3323 | global |
| 3324 | {not in Vi} |
| 3325 | {not available when compiled without the |+folding| |
| 3326 | feature} |
| 3327 | Sets 'foldlevel' when starting to edit another buffer in a window. |
| 3328 | Useful to always start editing with all folds closed (value zero), |
| 3329 | some folds closed (one) or no folds closed (99). |
| 3330 | 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] | 3331 | overrules this option. Starting to edit a file for |diff-mode| also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3332 | ignores this option and closes all folds. |
| 3333 | It is also done before BufReadPre autocommands, to allow an autocmd to |
| 3334 | overrule the 'foldlevel' value for specific files. |
| 3335 | When the value is negative, it is not used. |
| 3336 | |
| 3337 | *'foldmarker'* *'fmr'* *E536* |
| 3338 | 'foldmarker' 'fmr' string (default: "{{{,}}}") |
| 3339 | local to window |
| 3340 | {not in Vi} |
| 3341 | {not available when compiled without the |+folding| |
| 3342 | feature} |
| 3343 | The start and end marker used when 'foldmethod' is "marker". There |
| 3344 | must be one comma, which separates the start and end marker. The |
| 3345 | marker is a literal string (a regular expression would be too slow). |
| 3346 | See |fold-marker|. |
| 3347 | |
| 3348 | *'foldmethod'* *'fdm'* |
| 3349 | 'foldmethod' 'fdm' string (default: "manual") |
| 3350 | local to window |
| 3351 | {not in Vi} |
| 3352 | {not available when compiled without the |+folding| |
| 3353 | feature} |
| 3354 | The kind of folding used for the current window. Possible values: |
| 3355 | |fold-manual| manual Folds are created manually. |
| 3356 | |fold-indent| indent Lines with equal indent form a fold. |
| 3357 | |fold-expr| expr 'foldexpr' gives the fold level of a line. |
| 3358 | |fold-marker| marker Markers are used to specify folds. |
| 3359 | |fold-syntax| syntax Syntax highlighting items specify folds. |
| 3360 | |fold-diff| diff Fold text that is not changed. |
| 3361 | |
| 3362 | *'foldminlines'* *'fml'* |
| 3363 | 'foldminlines' 'fml' number (default: 1) |
| 3364 | local to window |
| 3365 | {not in Vi} |
| 3366 | {not available when compiled without the |+folding| |
| 3367 | feature} |
Bram Moolenaar | 0065402 | 2011-02-25 14:42:19 +0100 | [diff] [blame] | 3368 | Sets the number of screen lines above which a fold can be displayed |
| 3369 | closed. Also for manually closed folds. With the default value of |
| 3370 | one a fold can only be closed if it takes up two or more screen lines. |
| 3371 | Set to zero to be able to close folds of just one screen line. |
Bram Moolenaar | 446beb4 | 2011-05-10 17:18:44 +0200 | [diff] [blame] | 3372 | Note that this only has an effect on what is displayed. After using |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3373 | "zc" to close a fold, which is displayed open because it's smaller |
| 3374 | than 'foldminlines', a following "zc" may close a containing fold. |
| 3375 | |
| 3376 | *'foldnestmax'* *'fdn'* |
| 3377 | 'foldnestmax' 'fdn' number (default: 20) |
| 3378 | local to window |
| 3379 | {not in Vi} |
| 3380 | {not available when compiled without the |+folding| |
| 3381 | feature} |
| 3382 | Sets the maximum nesting of folds for the "indent" and "syntax" |
| 3383 | methods. This avoids that too many folds will be created. Using more |
| 3384 | than 20 doesn't work, because the internal limit is 20. |
| 3385 | |
| 3386 | *'foldopen'* *'fdo'* |
| 3387 | 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, |
| 3388 | search,tag,undo") |
| 3389 | global |
| 3390 | {not in Vi} |
| 3391 | {not available when compiled without the |+folding| |
| 3392 | feature} |
| 3393 | Specifies for which type of commands folds will be opened, if the |
| 3394 | command moves the cursor into a closed fold. It is a comma separated |
| 3395 | list of items. |
Bram Moolenaar | 0536570 | 2010-10-27 18:34:44 +0200 | [diff] [blame] | 3396 | NOTE: When the command is part of a mapping this option is not used. |
| 3397 | Add the |zv| command to the mapping to get the same effect. |
| 3398 | (rationale: the mapping may want to control opening folds itself) |
| 3399 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3400 | item commands ~ |
| 3401 | all any |
| 3402 | block "(", "{", "[[", "[{", etc. |
| 3403 | hor horizontal movements: "l", "w", "fx", etc. |
| 3404 | insert any command in Insert mode |
| 3405 | jump far jumps: "G", "gg", etc. |
| 3406 | mark jumping to a mark: "'m", CTRL-O, etc. |
| 3407 | percent "%" |
| 3408 | quickfix ":cn", ":crew", ":make", etc. |
| 3409 | search search for a pattern: "/", "n", "*", "gd", etc. |
| 3410 | (not for a search pattern in a ":" command) |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3411 | Also for |[s| and |]s|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3412 | tag jumping to a tag: ":ta", CTRL-T, etc. |
| 3413 | undo undo or redo: "u" and CTRL-R |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3414 | When a movement command is used for an operator (e.g., "dl" or "y%") |
| 3415 | this option is not used. This means the operator will include the |
| 3416 | whole closed fold. |
| 3417 | Note that vertical movements are not here, because it would make it |
| 3418 | very difficult to move onto a closed fold. |
| 3419 | In insert mode the folds containing the cursor will always be open |
| 3420 | when text is inserted. |
| 3421 | To close folds you can re-apply 'foldlevel' with the |zx| command or |
| 3422 | set the 'foldclose' option to "all". |
| 3423 | |
| 3424 | *'foldtext'* *'fdt'* |
| 3425 | 'foldtext' 'fdt' string (default: "foldtext()") |
| 3426 | local to window |
| 3427 | {not in Vi} |
| 3428 | {not available when compiled without the |+folding| |
| 3429 | feature} |
| 3430 | An expression which is used to specify the text displayed for a closed |
| 3431 | fold. See |fold-foldtext|. |
| 3432 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 3433 | The expression will be evaluated in the |sandbox| if set from a |
| 3434 | modeline, see |sandbox-option|. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 3435 | |
| 3436 | It is not allowed to change text or jump to another window while |
| 3437 | evaluating 'foldtext' |textlock|. |
| 3438 | |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 3439 | *'formatexpr'* *'fex'* |
| 3440 | 'formatexpr' 'fex' string (default "") |
| 3441 | local to buffer |
| 3442 | {not in Vi} |
| 3443 | {not available when compiled without the |+eval| |
| 3444 | feature} |
| 3445 | Expression which is evaluated to format a range of lines for the |gq| |
| 3446 | operator or automatic formatting (see 'formatoptions'). When this |
| 3447 | option is empty 'formatprg' is used. |
| 3448 | |
| 3449 | The |v:lnum| variable holds the first line to be formatted. |
| 3450 | The |v:count| variable holds the number of lines to be formatted. |
| 3451 | The |v:char| variable holds the character that is going to be |
| 3452 | inserted if the expression is being evaluated due to |
| 3453 | automatic formatting. This can be empty. Don't insert |
| 3454 | it yet! |
| 3455 | |
| 3456 | Example: > |
| 3457 | :set formatexpr=mylang#Format() |
| 3458 | < This will invoke the mylang#Format() function in the |
| 3459 | autoload/mylang.vim file in 'runtimepath'. |autoload| |
| 3460 | |
| 3461 | The expression is also evaluated when 'textwidth' is set and adding |
| 3462 | text beyond that limit. This happens under the same conditions as |
| 3463 | when internal formatting is used. Make sure the cursor is kept in the |
| 3464 | same spot relative to the text then! The |mode()| function will |
| 3465 | return "i" or "R" in this situation. |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 3466 | |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 3467 | When the expression evaluates to non-zero Vim will fall back to using |
| 3468 | the internal format mechanism. |
| 3469 | |
| 3470 | The expression will be evaluated in the |sandbox| when set from a |
| 3471 | modeline, see |sandbox-option|. That stops the option from working, |
| 3472 | since changing the buffer text is not allowed. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 3473 | NOTE: This option is set to "" when 'compatible' is set. |
Bram Moolenaar | c95a302 | 2016-06-12 23:01:46 +0200 | [diff] [blame] | 3474 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3475 | *'formatoptions'* *'fo'* |
| 3476 | 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") |
| 3477 | local to buffer |
| 3478 | {not in Vi} |
| 3479 | This is a sequence of letters which describes how automatic |
| 3480 | formatting is to be done. See |fo-table|. When the 'paste' option is |
| 3481 | on, no formatting is done (like 'formatoptions' is empty). Commas can |
| 3482 | be inserted for readability. |
| 3483 | To avoid problems with flags that are added in the future, use the |
| 3484 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 3485 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 3486 | set and to the Vim default value when 'compatible' is reset. |
| 3487 | |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 3488 | *'formatlistpat'* *'flp'* |
| 3489 | 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") |
| 3490 | local to buffer |
| 3491 | {not in Vi} |
| 3492 | A pattern that is used to recognize a list header. This is used for |
| 3493 | the "n" flag in 'formatoptions'. |
| 3494 | 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] | 3495 | 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] | 3496 | while still checking more characters. There must be a character |
| 3497 | following the pattern, when it matches the whole line it is handled |
| 3498 | like there is no match. |
| 3499 | The default recognizes a number, followed by an optional punctuation |
| 3500 | character and white space. |
| 3501 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3502 | *'formatprg'* *'fp'* |
| 3503 | 'formatprg' 'fp' string (default "") |
Bram Moolenaar | 9be7c04 | 2017-01-14 14:28:30 +0100 | [diff] [blame] | 3504 | global or local to buffer |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3505 | {not in Vi} |
| 3506 | The name of an external program that will be used to format the lines |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 3507 | selected with the |gq| operator. The program must take the input on |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3508 | stdin and produce the output on stdout. The Unix program "fmt" is |
Bram Moolenaar | a5792f5 | 2005-11-23 21:25:05 +0000 | [diff] [blame] | 3509 | such a program. |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 3510 | If the 'formatexpr' option is not empty it will be used instead. |
| 3511 | Otherwise, if 'formatprg' option is an empty string, the internal |
| 3512 | format function will be used |C-indenting|. |
Bram Moolenaar | a5792f5 | 2005-11-23 21:25:05 +0000 | [diff] [blame] | 3513 | Environment variables are expanded |:set_env|. See |option-backslash| |
| 3514 | about including spaces and backslashes. |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 3515 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3516 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3517 | |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 3518 | *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3519 | 'fsync' 'fs' boolean (default on) |
| 3520 | global |
| 3521 | {not in Vi} |
| 3522 | When on, the library function fsync() will be called after writing a |
| 3523 | file. This will flush a file to disk, ensuring that it is safely |
| 3524 | written even on filesystems which do metadata-only journaling. This |
| 3525 | will force the harddrive to spin up on Linux systems running in laptop |
| 3526 | mode, so it may be undesirable in some situations. Be warned that |
| 3527 | turning this off increases the chances of data loss after a crash. On |
| 3528 | systems without an fsync() implementation, this variable is always |
| 3529 | off. |
| 3530 | Also see 'swapsync' for controlling fsync() on swap files. |
Bram Moolenaar | 51b0f37 | 2017-11-18 18:52:04 +0100 | [diff] [blame] | 3531 | 'fsync' also applies to |writefile()|, unless a flag is used to |
| 3532 | overrule it. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 3533 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3534 | *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 3535 | 'gdefault' 'gd' boolean (default off) |
| 3536 | global |
| 3537 | {not in Vi} |
| 3538 | When on, the ":substitute" flag 'g' is default on. This means that |
| 3539 | all matches in a line are substituted instead of one. When a 'g' flag |
| 3540 | is given to a ":substitute" command, this will toggle the substitution |
| 3541 | of all or one match. See |complex-change|. |
| 3542 | |
| 3543 | command 'gdefault' on 'gdefault' off ~ |
| 3544 | :s/// subst. all subst. one |
| 3545 | :s///g subst. one subst. all |
| 3546 | :s///gg subst. all subst. one |
| 3547 | |
| 3548 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 2102035 | 2017-06-13 17:21:04 +0200 | [diff] [blame] | 3549 | DEPRECATED: Setting this option may break plugins that are not aware |
| 3550 | of this option. Also, many users get confused that adding the /g flag |
| 3551 | has the opposite effect of that it normally does. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3552 | |
| 3553 | *'grepformat'* *'gfm'* |
Bram Moolenaar | 6e93246 | 2014-09-09 18:48:09 +0200 | [diff] [blame] | 3554 | 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3555 | global |
| 3556 | {not in Vi} |
| 3557 | Format to recognize for the ":grep" command output. |
| 3558 | This is a scanf-like string that uses the same format as the |
| 3559 | 'errorformat' option: see |errorformat|. |
| 3560 | |
| 3561 | *'grepprg'* *'gp'* |
| 3562 | 'grepprg' 'gp' string (default "grep -n ", |
| 3563 | Unix: "grep -n $* /dev/null", |
| 3564 | Win32: "findstr /n" or "grep -n", |
| 3565 | VMS: "SEARCH/NUMBERS ") |
| 3566 | global or local to buffer |global-local| |
| 3567 | {not in Vi} |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3568 | Program to use for the |:grep| command. This option may contain '%' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3569 | and '#' characters, which are expanded like when used in a command- |
| 3570 | line. The placeholder "$*" is allowed to specify where the arguments |
| 3571 | will be included. Environment variables are expanded |:set_env|. See |
| 3572 | |option-backslash| about including spaces and backslashes. |
| 3573 | When your "grep" accepts the "-H" argument, use this to make ":grep" |
| 3574 | also work well with a single file: > |
| 3575 | :set grepprg=grep\ -nH |
Bram Moolenaar | 7c62692 | 2005-02-07 22:01:03 +0000 | [diff] [blame] | 3576 | < Special value: When 'grepprg' is set to "internal" the |:grep| command |
Bram Moolenaar | a655760 | 2006-02-04 22:43:20 +0000 | [diff] [blame] | 3577 | works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
| 3578 | |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. |
Bram Moolenaar | 86b6835 | 2004-12-27 21:59:20 +0000 | [diff] [blame] | 3579 | See also the section |:make_makeprg|, since most of the comments there |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3580 | apply equally to 'grepprg'. |
| 3581 | For Win32, the default is "findstr /n" if "findstr.exe" can be found, |
| 3582 | otherwise it's "grep -n". |
| 3583 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3584 | security reasons. |
| 3585 | |
| 3586 | *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* |
| 3587 | 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, |
| 3588 | ve:ver35-Cursor, |
| 3589 | o:hor50-Cursor, |
| 3590 | i-ci:ver25-Cursor/lCursor, |
| 3591 | r-cr:hor20-Cursor/lCursor, |
| 3592 | sm:block-Cursor |
| 3593 | -blinkwait175-blinkoff150-blinkon175", |
| 3594 | for MS-DOS and Win32 console: |
| 3595 | "n-v-c:block,o:hor50,i-ci:hor15, |
| 3596 | r-cr:hor30,sm:block") |
| 3597 | global |
| 3598 | {not in Vi} |
| 3599 | {only available when compiled with GUI enabled, and |
| 3600 | for MS-DOS and Win32 console} |
| 3601 | This option tells Vim what the cursor should look like in different |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3602 | 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] | 3603 | the height of the cursor can be changed. This can be done by |
| 3604 | specifying a block cursor, or a percentage for a vertical or |
| 3605 | horizontal cursor. |
Bram Moolenaar | 1e7813a | 2015-03-31 18:31:03 +0200 | [diff] [blame] | 3606 | For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
| 3607 | used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3608 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3609 | 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] | 3610 | mode-list and an argument-list: |
| 3611 | mode-list:argument-list,mode-list:argument-list,.. |
| 3612 | The mode-list is a dash separated list of these modes: |
| 3613 | n Normal mode |
| 3614 | v Visual mode |
| 3615 | ve Visual mode with 'selection' "exclusive" (same as 'v', |
| 3616 | if not specified) |
| 3617 | o Operator-pending mode |
| 3618 | i Insert mode |
| 3619 | r Replace mode |
| 3620 | c Command-line Normal (append) mode |
| 3621 | ci Command-line Insert mode |
| 3622 | cr Command-line Replace mode |
| 3623 | sm showmatch in Insert mode |
| 3624 | a all modes |
| 3625 | The argument-list is a dash separated list of these arguments: |
| 3626 | hor{N} horizontal bar, {N} percent of the character height |
| 3627 | ver{N} vertical bar, {N} percent of the character width |
| 3628 | block block cursor, fills the whole character |
| 3629 | [only one of the above three should be present] |
| 3630 | blinkwait{N} *cursor-blinking* |
| 3631 | blinkon{N} |
| 3632 | blinkoff{N} |
| 3633 | blink times for cursor: blinkwait is the delay before |
| 3634 | the cursor starts blinking, blinkon is the time that |
| 3635 | the cursor is shown and blinkoff is the time that the |
| 3636 | cursor is not shown. The times are in msec. When one |
| 3637 | of the numbers is zero, there is no blinking. The |
| 3638 | default is: "blinkwait700-blinkon400-blinkoff250". |
| 3639 | These numbers are used for a missing entry. This |
| 3640 | means that blinking is enabled by default. To switch |
| 3641 | blinking off you can use "blinkon0". The cursor only |
| 3642 | blinks when Vim is waiting for input, not while |
| 3643 | executing a command. |
| 3644 | To make the cursor blink in an xterm, see |
| 3645 | |xterm-blink|. |
| 3646 | {group-name} |
| 3647 | a highlight group name, that sets the color and font |
| 3648 | for the cursor |
| 3649 | {group-name}/{group-name} |
| 3650 | Two highlight group names, the first is used when |
| 3651 | no language mappings are used, the other when they |
| 3652 | are. |language-mapping| |
| 3653 | |
| 3654 | Examples of parts: |
| 3655 | n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a |
| 3656 | block cursor with colors from the "nCursor" |
| 3657 | highlight group |
| 3658 | i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 |
| 3659 | In Insert and Command-line Insert mode, use a |
| 3660 | 30% vertical bar cursor with colors from the |
| 3661 | "iCursor" highlight group. Blink a bit |
| 3662 | faster. |
| 3663 | |
| 3664 | The 'a' mode is different. It will set the given argument-list for |
| 3665 | all modes. It does not reset anything to defaults. This can be used |
| 3666 | to do a common setting for all modes. For example, to switch off |
| 3667 | blinking: "a:blinkon0" |
| 3668 | |
| 3669 | Examples of cursor highlighting: > |
| 3670 | :highlight Cursor gui=reverse guifg=NONE guibg=NONE |
| 3671 | :highlight Cursor gui=NONE guifg=bg guibg=fg |
| 3672 | < |
| 3673 | *'guifont'* *'gfn'* |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 3674 | *E235* *E596* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3675 | 'guifont' 'gfn' string (default "") |
| 3676 | global |
| 3677 | {not in Vi} |
| 3678 | {only available when compiled with GUI enabled} |
| 3679 | This is a list of fonts which will be used for the GUI version of Vim. |
| 3680 | In its simplest form the value is just one font name. When |
| 3681 | the font cannot be found you will get an error message. To try other |
| 3682 | font names a list can be specified, font names separated with commas. |
| 3683 | The first valid font is used. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3684 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 3685 | On systems where 'guifontset' is supported (X11) and 'guifontset' is |
| 3686 | not empty, then 'guifont' is not used. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3687 | |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3688 | Note: As to the GTK GUIs, no error is given against any invalid names, |
| 3689 | and the first element of the list is always picked up and made use of. |
| 3690 | This is because, instead of identifying a given name with a font, the |
| 3691 | GTK GUIs use it to construct a pattern and try to look up a font which |
| 3692 | best matches the pattern among available fonts, and this way, the |
| 3693 | matching never fails. An invalid name doesn't matter because a number |
| 3694 | of font properties other than name will do to get the matching done. |
| 3695 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3696 | Spaces after a comma are ignored. To include a comma in a font name |
| 3697 | precede it with a backslash. Setting an option requires an extra |
| 3698 | backslash before a space and a backslash. See also |
| 3699 | |option-backslash|. For example: > |
| 3700 | :set guifont=Screen15,\ 7x13,font\\,with\\,commas |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3701 | < 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] | 3702 | will try to use "7x13" and then "font,with,commas" instead. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3703 | |
| 3704 | If none of the fonts can be loaded, Vim will keep the current setting. |
| 3705 | If an empty font list is given, Vim will try using other resource |
| 3706 | settings (for X, it will use the Vim.font resource), and finally it |
| 3707 | will try some builtin default which should always be there ("7x13" in |
| 3708 | the case of X). The font names given should be "normal" fonts. Vim |
| 3709 | will try to find the related bold and italic fonts. |
| 3710 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3711 | For Win32, GTK, Motif, Mac OS and Photon: > |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3712 | :set guifont=* |
| 3713 | < will bring up a font requester, where you can pick the font you want. |
| 3714 | |
| 3715 | The font name depends on the GUI used. See |setting-guifont| for a |
| 3716 | way to set 'guifont' for various systems. |
| 3717 | |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3718 | For the GTK+ 2 and 3 GUIs, the font name looks like this: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3719 | :set guifont=Andale\ Mono\ 11 |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 3720 | < That's all. XLFDs are not used. For Chinese this is reported to work |
| 3721 | well: > |
| 3722 | if has("gui_gtk2") |
| 3723 | set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12 |
| 3724 | set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12 |
| 3725 | endif |
| 3726 | < |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3727 | (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI) |
| 3728 | |
Bram Moolenaar | 05159a0 | 2005-02-26 23:04:13 +0000 | [diff] [blame] | 3729 | For Mac OSX you can use something like this: > |
| 3730 | :set guifont=Monaco:h10 |
Bram Moolenaar | 06a89a5 | 2006-04-29 22:01:03 +0000 | [diff] [blame] | 3731 | < Also see 'macatsui', it can help fix display problems. |
| 3732 | *E236* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3733 | Note that the fonts must be mono-spaced (all characters have the same |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3734 | width). An exception is GTK: all fonts are accepted, but mono-spaced |
| 3735 | fonts look best. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3736 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3737 | To preview a font on X11, you might be able to use the "xfontsel" |
| 3738 | program. The "xlsfonts" program gives a list of all available fonts. |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3739 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3740 | For the Win32 GUI *E244* *E245* |
| 3741 | - takes these options in the font name: |
| 3742 | hXX - height is XX (points, can be floating-point) |
| 3743 | wXX - width is XX (points, can be floating-point) |
| 3744 | b - bold |
| 3745 | i - italic |
| 3746 | u - underline |
| 3747 | s - strikeout |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 3748 | cXX - character set XX. Valid charsets are: ANSI, ARABIC, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3749 | BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, |
| 3750 | HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, |
| 3751 | SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 3752 | Normally you would use "cDEFAULT". |
Bram Moolenaar | 03413f4 | 2016-04-12 21:07:15 +0200 | [diff] [blame] | 3753 | qXX - quality XX. Valid quality names are: PROOF, DRAFT, |
Bram Moolenaar | 06d2d38 | 2016-05-20 17:24:11 +0200 | [diff] [blame] | 3754 | ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT. |
Bram Moolenaar | 7c1c6db | 2016-04-03 22:08:05 +0200 | [diff] [blame] | 3755 | Normally you would use "qDEFAULT". |
Bram Moolenaar | dc1f164 | 2016-08-16 18:33:43 +0200 | [diff] [blame] | 3756 | Some quality values are not supported in legacy OSs. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3757 | |
| 3758 | Use a ':' to separate the options. |
| 3759 | - A '_' can be used in the place of a space, so you don't need to use |
| 3760 | backslashes to escape the spaces. |
| 3761 | - Examples: > |
| 3762 | :set guifont=courier_new:h12:w5:b:cRUSSIAN |
| 3763 | :set guifont=Andale_Mono:h7.5:w4.5 |
| 3764 | < See also |font-sizes|. |
| 3765 | |
| 3766 | *'guifontset'* *'gfs'* |
| 3767 | *E250* *E252* *E234* *E597* *E598* |
| 3768 | 'guifontset' 'gfs' string (default "") |
| 3769 | global |
| 3770 | {not in Vi} |
| 3771 | {only available when compiled with GUI enabled and |
| 3772 | with the |+xfontset| feature} |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3773 | {not available in the GTK+ GUI} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3774 | When not empty, specifies two (or more) fonts to be used. The first |
| 3775 | one for normal English, the second one for your special language. See |
| 3776 | |xfontset|. |
| 3777 | Setting this option also means that all font names will be handled as |
| 3778 | a fontset name. Also the ones used for the "font" argument of the |
| 3779 | |:highlight| command. |
| 3780 | The fonts must match with the current locale. If fonts for the |
| 3781 | character sets that the current locale uses are not included, setting |
| 3782 | 'guifontset' will fail. |
| 3783 | Note the difference between 'guifont' and 'guifontset': In 'guifont' |
| 3784 | the comma-separated names are alternative names, one of which will be |
| 3785 | used. In 'guifontset' the whole string is one fontset name, |
| 3786 | including the commas. It is not possible to specify alternative |
| 3787 | fontset names. |
| 3788 | This example works on many X11 systems: > |
| 3789 | :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* |
| 3790 | < |
| 3791 | *'guifontwide'* *'gfw'* *E231* *E533* *E534* |
| 3792 | 'guifontwide' 'gfw' string (default "") |
| 3793 | global |
| 3794 | {not in Vi} |
| 3795 | {only available when compiled with GUI enabled} |
| 3796 | When not empty, specifies a comma-separated list of fonts to be used |
| 3797 | for double-width characters. The first font that can be loaded is |
| 3798 | used. |
| 3799 | Note: The size of these fonts must be exactly twice as wide as the one |
| 3800 | specified with 'guifont' and the same height. |
| 3801 | |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3802 | All GUI versions but GTK+: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3803 | |
| 3804 | 'guifontwide' is only used when 'encoding' is set to "utf-8" and |
| 3805 | 'guifontset' is empty or invalid. |
| 3806 | When 'guifont' is set and a valid font is found in it and |
| 3807 | 'guifontwide' is empty Vim will attempt to find a matching |
| 3808 | double-width font and set 'guifontwide' to it. |
| 3809 | |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 3810 | GTK+ GUI only: *guifontwide_gtk* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3811 | |
| 3812 | If set and valid, 'guifontwide' is always used for double width |
| 3813 | characters, even if 'encoding' is not set to "utf-8". |
| 3814 | Vim does not attempt to find an appropriate value for 'guifontwide' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3815 | automatically. If 'guifontwide' is empty Pango/Xft will choose the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3816 | font for characters not available in 'guifont'. Thus you do not need |
| 3817 | to set 'guifontwide' at all unless you want to override the choice |
| 3818 | made by Pango/Xft. |
| 3819 | |
Bram Moolenaar | 0f27212 | 2013-01-23 18:37:40 +0100 | [diff] [blame] | 3820 | Windows +multibyte only: *guifontwide_win_mbyte* |
| 3821 | |
Bram Moolenaar | a3e6bc9 | 2013-01-30 14:18:00 +0100 | [diff] [blame] | 3822 | If set and valid, 'guifontwide' is used for IME instead of 'guifont'. |
Bram Moolenaar | 0f27212 | 2013-01-23 18:37:40 +0100 | [diff] [blame] | 3823 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3824 | *'guiheadroom'* *'ghr'* |
| 3825 | 'guiheadroom' 'ghr' number (default 50) |
| 3826 | global |
| 3827 | {not in Vi} {only for GTK and X11 GUI} |
| 3828 | The number of pixels subtracted from the screen height when fitting |
| 3829 | the GUI window on the screen. Set this before the GUI is started, |
| 3830 | 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] | 3831 | be used by the window. When positive, the specified number of pixel |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3832 | lines will be left for window decorations and other items on the |
| 3833 | screen. Set it to a negative value to allow windows taller than the |
| 3834 | screen. |
| 3835 | |
| 3836 | *'guioptions'* *'go'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 3837 | 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is |
| 3838 | removed in |defaults.vim|), |
| 3839 | "aegimrLtT" (GTK, Motif and Athena), |
| 3840 | ) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3841 | global |
| 3842 | {not in Vi} |
| 3843 | {only available when compiled with GUI enabled} |
Bram Moolenaar | ed20346 | 2004-06-16 11:19:22 +0000 | [diff] [blame] | 3844 | 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] | 3845 | sequence of letters which describes what components and options of the |
| 3846 | GUI should be used. |
| 3847 | To avoid problems with flags that are added in the future, use the |
| 3848 | "+=" and "-=" feature of ":set" |add-option-flags|. |
| 3849 | |
Bram Moolenaar | 1356825 | 2018-03-16 20:46:58 +0100 | [diff] [blame] | 3850 | Valid characters are as follows: |
| 3851 | *'go-!'* |
| 3852 | '!' External commands are executed in a terminal window. Without |
| 3853 | this flag the MS-Windows GUI will open a console window to |
| 3854 | execute the command. The Unix GUI will simulate a dumb |
| 3855 | terminal to list the command output. |
| 3856 | The terminal window will be positioned at the bottom, and grow |
| 3857 | upwards as needed. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3858 | *guioptions_a* *'go-a'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3859 | 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3860 | or the Visual area extended, Vim tries to become the owner of |
| 3861 | the windowing system's global selection. This means that the |
| 3862 | Visually highlighted text is available for pasting into other |
| 3863 | applications as well as into Vim itself. When the Visual mode |
| 3864 | ends, possibly due to an operation on the text, or when an |
| 3865 | application wants to paste the selection, the highlighted text |
| 3866 | is automatically yanked into the "* selection register. |
| 3867 | Thus the selection is still available for pasting into other |
| 3868 | applications after the VISUAL mode has ended. |
| 3869 | If not present, then Vim won't become the owner of the |
| 3870 | windowing system's global selection unless explicitly told to |
| 3871 | by a yank or delete operation for the "* register. |
| 3872 | The same applies to the modeless selection. |
Bram Moolenaar | c0885aa | 2012-07-10 16:49:23 +0200 | [diff] [blame] | 3873 | *'go-P'* |
| 3874 | 'P' Like autoselect but using the "+ register instead of the "* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 3875 | register. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3876 | *'go-A'* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3877 | 'A' Autoselect for the modeless selection. Like 'a', but only |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3878 | applies to the modeless selection. |
| 3879 | |
| 3880 | 'guioptions' autoselect Visual autoselect modeless ~ |
| 3881 | "" - - |
| 3882 | "a" yes yes |
| 3883 | "A" - yes |
| 3884 | "aA" yes yes |
| 3885 | |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3886 | *'go-c'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3887 | 'c' Use console dialogs instead of popup dialogs for simple |
| 3888 | choices. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3889 | *'go-e'* |
Bram Moolenaar | e224ffa | 2006-03-01 00:01:28 +0000 | [diff] [blame] | 3890 | 'e' Add tab pages when indicated with 'showtabline'. |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 3891 | 'guitablabel' can be used to change the text in the labels. |
| 3892 | When 'e' is missing a non-GUI tab pages line may be used. |
Bram Moolenaar | d68071d | 2006-05-02 22:08:30 +0000 | [diff] [blame] | 3893 | The GUI tabs are only supported on some systems, currently |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 3894 | GTK, Motif, Mac OS/X and MS-Windows. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3895 | *'go-f'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3896 | 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 3897 | where it was started. Use this for programs that wait for the |
| 3898 | editor to finish (e.g., an e-mail program). Alternatively you |
| 3899 | can use "gvim -f" or ":gui -f" to start the GUI in the |
| 3900 | foreground. |gui-fork| |
| 3901 | Note: Set this option in the vimrc file. The forking may have |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3902 | happened already when the |gvimrc| file is read. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3903 | *'go-i'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3904 | 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 3905 | corner of the window. It's black&white on non-GTK, because of |
| 3906 | limitations of X11. For a color icon, see |X11-icon|. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3907 | *'go-m'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3908 | 'm' Menu bar is present. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3909 | *'go-M'* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3910 | 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3911 | that this flag must be added in the .vimrc file, before |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3912 | switching on syntax or filetype recognition (when the |gvimrc| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3913 | file is sourced the system menu has already been loaded; the |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 3914 | `:syntax on` and `:filetype on` commands load the menu too). |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3915 | *'go-g'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3916 | 'g' Grey menu items: Make menu items that are not active grey. If |
| 3917 | 'g' is not included inactive menu items are not shown at all. |
| 3918 | Exception: Athena will always use grey menu items. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3919 | *'go-t'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3920 | 't' Include tearoff menu items. Currently only works for Win32, |
| 3921 | GTK+, and Motif 1.2 GUI. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3922 | *'go-T'* |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 3923 | 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 3924 | and Athena GUIs. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3925 | *'go-r'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3926 | 'r' Right-hand scrollbar is always present. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3927 | *'go-R'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3928 | 'R' Right-hand scrollbar is present when there is a vertically |
| 3929 | split window. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3930 | *'go-l'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3931 | 'l' Left-hand scrollbar is always present. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3932 | *'go-L'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3933 | 'L' Left-hand scrollbar is present when there is a vertically |
| 3934 | split window. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3935 | *'go-b'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3936 | 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 3937 | the longest visible line, or on the cursor line if the 'h' |
| 3938 | flag is included. |gui-horiz-scroll| |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3939 | *'go-h'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3940 | 'h' Limit horizontal scrollbar size to the length of the cursor |
| 3941 | line. Reduces computations. |gui-horiz-scroll| |
| 3942 | |
| 3943 | And yes, you may even have scrollbars on the left AND the right if |
| 3944 | you really want to :-). See |gui-scrollbars| for more information. |
| 3945 | |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3946 | *'go-v'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3947 | 'v' Use a vertical button layout for dialogs. When not included, |
| 3948 | a horizontal layout is preferred, but when it doesn't fit a |
| 3949 | vertical layout is used anyway. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3950 | *'go-p'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3951 | 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 3952 | window managers. If the cursor is not blinking or hollow at |
| 3953 | the right moment, try adding this flag. This must be done |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 3954 | before starting the GUI. Set it in your |gvimrc|. Adding or |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3955 | removing it after the GUI has started has no effect. |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 3956 | *'go-F'* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 3957 | 'F' Add a footer. Only for Motif. See |gui-footer|. |
Bram Moolenaar | 8ac4415 | 2017-11-09 18:33:29 +0100 | [diff] [blame] | 3958 | *'go-k'* |
| 3959 | 'k' Keep the GUI window size when adding/removing a scrollbar, or |
| 3960 | toolbar, tabline, etc. Instead, the behavior is similar to |
| 3961 | when the window is maximized and will adjust 'lines' and |
| 3962 | 'columns' to fit to the window. Without the 'k' flag Vim will |
Bram Moolenaar | 51b0f37 | 2017-11-18 18:52:04 +0100 | [diff] [blame] | 3963 | try to keep 'lines' and 'columns' the same when adding and |
Bram Moolenaar | 8ac4415 | 2017-11-09 18:33:29 +0100 | [diff] [blame] | 3964 | removing GUI components. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 3965 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 3966 | *'guipty'* *'noguipty'* |
| 3967 | 'guipty' boolean (default on) |
| 3968 | global |
| 3969 | {not in Vi} |
| 3970 | {only available when compiled with GUI enabled} |
| 3971 | Only in the GUI: If on, an attempt is made to open a pseudo-tty for |
| 3972 | I/O to/from shell commands. See |gui-pty|. |
| 3973 | |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 3974 | *'guitablabel'* *'gtl'* |
| 3975 | 'guitablabel' 'gtl' string (default empty) |
| 3976 | global |
| 3977 | {not in Vi} |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 3978 | {only available when compiled with GUI enabled and |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 3979 | with the |+windows| feature} |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 3980 | When nonempty describes the text to use in a label of the GUI tab |
Bram Moolenaar | d68071d | 2006-05-02 22:08:30 +0000 | [diff] [blame] | 3981 | pages line. When empty and when the result is empty Vim will use a |
| 3982 | default label. See |setting-guitablabel| for more info. |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 3983 | |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 3984 | The format of this option is like that of 'statusline'. |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 3985 | 'guitabtooltip' is used for the tooltip, see below. |
Bram Moolenaar | 5162822 | 2016-12-01 23:03:28 +0100 | [diff] [blame] | 3986 | The expression will be evaluated in the |sandbox| when set from a |
| 3987 | modeline, see |sandbox-option|. |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 3988 | |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 3989 | Only used when the GUI tab pages line is displayed. 'e' must be |
| 3990 | present in 'guioptions'. For the non-GUI tab pages line 'tabline' is |
| 3991 | used. |
| 3992 | |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 3993 | *'guitabtooltip'* *'gtt'* |
| 3994 | 'guitabtooltip' 'gtt' string (default empty) |
| 3995 | global |
| 3996 | {not in Vi} |
| 3997 | {only available when compiled with GUI enabled and |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 3998 | with the |+windows| feature} |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 3999 | When nonempty describes the text to use in a tooltip for the GUI tab |
| 4000 | pages line. When empty Vim will use a default tooltip. |
| 4001 | This option is otherwise just like 'guitablabel' above. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4002 | You can include a line break. Simplest method is to use |:let|: > |
| 4003 | :let &guitabtooltip = "line one\nline two" |
| 4004 | < |
Bram Moolenaar | 57657d8 | 2006-04-21 22:12:41 +0000 | [diff] [blame] | 4005 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4006 | *'helpfile'* *'hf'* |
| 4007 | 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" |
| 4008 | (others) "$VIMRUNTIME/doc/help.txt") |
| 4009 | global |
| 4010 | {not in Vi} |
| 4011 | Name of the main help file. All distributed help files should be |
| 4012 | placed together in one directory. Additionally, all "doc" directories |
| 4013 | in 'runtimepath' will be used. |
| 4014 | Environment variables are expanded |:set_env|. For example: |
| 4015 | "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4016 | tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4017 | spaces and backslashes. |
| 4018 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4019 | security reasons. |
| 4020 | |
| 4021 | *'helpheight'* *'hh'* |
| 4022 | 'helpheight' 'hh' number (default 20) |
| 4023 | global |
| 4024 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 4025 | {not available when compiled without the |+windows| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4026 | feature} |
| 4027 | Minimal initial height of the help window when it is opened with the |
| 4028 | ":help" command. The initial height of the help window is half of the |
| 4029 | current window, or (when the 'ea' option is on) the same as other |
| 4030 | windows. When the height is less than 'helpheight', the height is |
| 4031 | set to 'helpheight'. Set to zero to disable. |
| 4032 | |
| 4033 | *'helplang'* *'hlg'* |
| 4034 | 'helplang' 'hlg' string (default: messages language or empty) |
| 4035 | global |
| 4036 | {only available when compiled with the |+multi_lang| |
| 4037 | feature} |
| 4038 | {not in Vi} |
| 4039 | Comma separated list of languages. Vim will use the first language |
| 4040 | for which the desired help can be found. The English help will always |
| 4041 | be used as a last resort. You can add "en" to prefer English over |
| 4042 | another language, but that will only find tags that exist in that |
| 4043 | language and not in the English help. |
| 4044 | Example: > |
| 4045 | :set helplang=de,it |
| 4046 | < This will first search German, then Italian and finally English help |
| 4047 | files. |
| 4048 | When using |CTRL-]| and ":help!" in a non-English help file Vim will |
| 4049 | try to find the tag in the current language before using this option. |
| 4050 | See |help-translated|. |
| 4051 | |
| 4052 | *'hidden'* *'hid'* *'nohidden'* *'nohid'* |
| 4053 | 'hidden' 'hid' boolean (default off) |
| 4054 | global |
| 4055 | {not in Vi} |
| 4056 | When off a buffer is unloaded when it is |abandon|ed. When on a |
| 4057 | buffer becomes hidden when it is |abandon|ed. If the buffer is still |
| 4058 | displayed in another window, it does not become hidden, of course. |
| 4059 | The commands that move through the buffer list sometimes make a buffer |
| 4060 | hidden although the 'hidden' option is off: When the buffer is |
| 4061 | modified, 'autowrite' is off or writing is not possible, and the '!' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4062 | flag was used. See also |windows.txt|. |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 4063 | To only make one buffer hidden use the 'bufhidden' option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4064 | This option is set for one command with ":hide {command}" |:hide|. |
| 4065 | WARNING: It's easy to forget that you have changes in hidden buffers. |
| 4066 | Think twice when using ":q!" or ":qa!". |
| 4067 | |
| 4068 | *'highlight'* *'hl'* |
| 4069 | 'highlight' 'hl' string (default (as a single string): |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4070 | "8:SpecialKey,~:EndOfBuffer,@:NonText, |
| 4071 | d:Directory,e:ErrorMsg,i:IncSearch, |
| 4072 | l:Search,m:MoreMsg,M:ModeMsg,n:LineNr, |
| 4073 | N:CursorLineNr,r:Question,s:StatusLine, |
| 4074 | S:StatusLineNC,c:VertSplit,t:Title, |
| 4075 | v:Visual,w:WarningMsg,W:WildMenu,f:Folded, |
| 4076 | F:FoldColumn,A:DiffAdd,C:DiffChange, |
| 4077 | D:DiffDelete,T:DiffText,>:SignColumn, |
| 4078 | B:SpellBad,P:SpellCap,R:SpellRare, |
| 4079 | L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel, |
Bram Moolenaar | 2102035 | 2017-06-13 17:21:04 +0200 | [diff] [blame] | 4080 | x:PmenuSbar,X:PmenuThumb,*:TabLine, |
| 4081 | #:TabLineSel,_:TabLineFill,!:CursorColumn, |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 4082 | .:CursorLine,o:ColorColumn,q:QuickFixLine, |
Bram Moolenaar | c572da5 | 2017-08-27 16:52:01 +0200 | [diff] [blame] | 4083 | z:StatusLineTerm,Z:StatusLineTermNC") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4084 | global |
| 4085 | {not in Vi} |
| 4086 | This option can be used to set highlighting mode for various |
| 4087 | occasions. It is a comma separated list of character pairs. The |
| 4088 | 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] | 4089 | use for that occasion. The occasions are: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4090 | |hl-SpecialKey| 8 Meta and special keys listed with ":map" |
Bram Moolenaar | 58b8534 | 2016-08-14 19:54:54 +0200 | [diff] [blame] | 4091 | |hl-EndOfBuffer| ~ lines after the last line in the buffer |
| 4092 | |hl-NonText| @ '@' at the end of the window and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4093 | characters from 'showbreak' |
| 4094 | |hl-Directory| d directories in CTRL-D listing and other special |
| 4095 | things in listings |
| 4096 | |hl-ErrorMsg| e error messages |
| 4097 | h (obsolete, ignored) |
| 4098 | |hl-IncSearch| i 'incsearch' highlighting |
| 4099 | |hl-Search| l last search pattern highlighting (see 'hlsearch') |
| 4100 | |hl-MoreMsg| m |more-prompt| |
| 4101 | |hl-ModeMsg| M Mode (e.g., "-- INSERT --") |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 4102 | |hl-LineNr| n line number for ":number" and ":#" commands, and |
| 4103 | when 'number' or 'relativenumber' option is set. |
Bram Moolenaar | a3e6bc9 | 2013-01-30 14:18:00 +0100 | [diff] [blame] | 4104 | |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
| 4105 | set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4106 | |hl-Question| r |hit-enter| prompt and yes/no questions |
| 4107 | |hl-StatusLine| s status line of current window |status-line| |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 4108 | |hl-StatusLineNC| S status lines of not-current windows |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4109 | |hl-Title| t Titles for output from ":set all", ":autocmd" etc. |
| 4110 | |hl-VertSplit| c column used to separate vertically split windows |
| 4111 | |hl-Visual| v Visual mode |
| 4112 | |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the |
| 4113 | Selection" Only X11 Gui's |gui-x11| and |
| 4114 | |xterm-clipboard|. |
| 4115 | |hl-WarningMsg| w warning messages |
| 4116 | |hl-WildMenu| W wildcard matches displayed for 'wildmenu' |
| 4117 | |hl-Folded| f line used for closed folds |
| 4118 | |hl-FoldColumn| F 'foldcolumn' |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 4119 | |hl-DiffAdd| A added line in diff mode |
| 4120 | |hl-DiffChange| C changed line in diff mode |
| 4121 | |hl-DiffDelete| D deleted line in diff mode |
| 4122 | |hl-DiffText| T inserted text in diff mode |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4123 | |hl-SignColumn| > column used for |signs| |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 4124 | |hl-SpellBad| B misspelled word |spell| |
Bram Moolenaar | 9855d6b | 2010-07-18 14:34:51 +0200 | [diff] [blame] | 4125 | |hl-SpellCap| P word that should start with capital |spell| |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 4126 | |hl-SpellRare| R rare word |spell| |
| 4127 | |hl-SpellLocal| L word from other region |spell| |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 4128 | |hl-Conceal| - the placeholders used for concealed characters |
| 4129 | (see 'conceallevel') |
Bram Moolenaar | 1c7715d | 2005-10-03 22:02:18 +0000 | [diff] [blame] | 4130 | |hl-Pmenu| + popup menu normal line |
| 4131 | |hl-PmenuSel| = popup menu normal line |
| 4132 | |hl-PmenuSbar| x popup menu scrollbar |
| 4133 | |hl-PmenuThumb| X popup menu scrollbar thumb |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4134 | |
| 4135 | The display modes are: |
| 4136 | r reverse (termcap entry "mr" and "me") |
| 4137 | i italic (termcap entry "ZH" and "ZR") |
| 4138 | b bold (termcap entry "md" and "me") |
| 4139 | s standout (termcap entry "so" and "se") |
| 4140 | u underline (termcap entry "us" and "ue") |
Bram Moolenaar | e2cc970 | 2005-03-15 22:43:58 +0000 | [diff] [blame] | 4141 | c undercurl (termcap entry "Cs" and "Ce") |
Bram Moolenaar | cf4b00c | 2017-09-02 18:33:56 +0200 | [diff] [blame] | 4142 | t strikethrough (termcap entry "Ts" and "Te") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4143 | n no highlighting |
| 4144 | - no highlighting |
| 4145 | : use a highlight group |
| 4146 | The default is used for occasions that are not included. |
| 4147 | If you want to change what the display modes do, see |dos-colors| |
| 4148 | for an example. |
| 4149 | When using the ':' display mode, this must be followed by the name of |
| 4150 | a highlight group. A highlight group can be used to define any type |
| 4151 | of highlighting, including using color. See |:highlight| on how to |
| 4152 | define one. The default uses a different group for each occasion. |
| 4153 | See |highlight-default| for the default highlight groups. |
| 4154 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4155 | *'history'* *'hi'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 4156 | 'history' 'hi' number (Vim default: 50, Vi default: 0, |
| 4157 | set to 200 in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4158 | global |
| 4159 | {not in Vi} |
| 4160 | A history of ":" commands, and a history of previous search patterns |
Bram Moolenaar | 78159bb | 2014-06-25 11:48:54 +0200 | [diff] [blame] | 4161 | is remembered. This option decides how many entries may be stored in |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4162 | each of these histories (see |cmdline-editing|). |
Bram Moolenaar | 78159bb | 2014-06-25 11:48:54 +0200 | [diff] [blame] | 4163 | The maximum value is 10000. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4164 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 4165 | set and to the Vim default value when 'compatible' is reset. |
| 4166 | |
| 4167 | *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* |
| 4168 | 'hkmap' 'hk' boolean (default off) |
| 4169 | global |
| 4170 | {not in Vi} |
| 4171 | {only available when compiled with the |+rightleft| |
| 4172 | feature} |
| 4173 | When on, the keyboard is mapped for the Hebrew character set. |
| 4174 | Normally you would set 'allowrevins' and use CTRL-_ in insert mode to |
| 4175 | toggle this option. See |rileft.txt|. |
| 4176 | NOTE: This option is reset when 'compatible' is set. |
| 4177 | |
| 4178 | *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* |
| 4179 | 'hkmapp' 'hkp' boolean (default off) |
| 4180 | global |
| 4181 | {not in Vi} |
| 4182 | {only available when compiled with the |+rightleft| |
| 4183 | feature} |
| 4184 | When on, phonetic keyboard mapping is used. 'hkmap' must also be on. |
| 4185 | This is useful if you have a non-Hebrew keyboard. |
| 4186 | See |rileft.txt|. |
| 4187 | NOTE: This option is reset when 'compatible' is set. |
| 4188 | |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 4189 | *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* |
| 4190 | 'hlsearch' 'hls' boolean (default off) |
| 4191 | global |
| 4192 | {not in Vi} |
| 4193 | {not available when compiled without the |
| 4194 | |+extra_search| feature} |
| 4195 | When there is a previous search pattern, highlight all its matches. |
| 4196 | The type of highlighting used can be set with the 'l' occasion in the |
| 4197 | 'highlight' option. This uses the "Search" highlight group by |
| 4198 | default. Note that only the matching text is highlighted, any offsets |
| 4199 | are not applied. |
| 4200 | See also: 'incsearch' and |:match|. |
| 4201 | When you get bored looking at the highlighted matches, you can turn it |
| 4202 | off with |:nohlsearch|. This does not change the option value, as |
| 4203 | soon as you use a search command, the highlighting comes back. |
| 4204 | 'redrawtime' specifies the maximum time spent on finding matches. |
| 4205 | When the search pattern can match an end-of-line, Vim will try to |
| 4206 | highlight all of the matched text. However, this depends on where the |
| 4207 | search starts. This will be the first line in the window or the first |
| 4208 | line below a closed fold. A match in a previous line which is not |
| 4209 | drawn may not continue in a newly drawn line. |
| 4210 | You can specify whether the highlight status is restored on startup |
| 4211 | with the 'h' flag in 'viminfo' |viminfo-h|. |
| 4212 | NOTE: This option is reset when 'compatible' is set. |
| 4213 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4214 | *'icon'* *'noicon'* |
| 4215 | 'icon' boolean (default off, on when title can be restored) |
| 4216 | global |
| 4217 | {not in Vi} |
| 4218 | {not available when compiled without the |+title| |
| 4219 | feature} |
| 4220 | When on, the icon text of the window will be set to the value of |
| 4221 | 'iconstring' (if it is not empty), or to the name of the file |
| 4222 | currently being edited. Only the last part of the name is used. |
| 4223 | Overridden by the 'iconstring' option. |
| 4224 | Only works if the terminal supports setting window icons (currently |
| 4225 | only X11 GUI and terminals with a non-empty 't_IS' option - these are |
| 4226 | Unix xterm and iris-ansi by default, where 't_IS' is taken from the |
| 4227 | builtin termcap). |
| 4228 | 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] | 4229 | restored if possible |X11|. See |X11-icon| for changing the icon on |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4230 | X11. |
Bram Moolenaar | 3a991dd | 2014-10-02 01:41:41 +0200 | [diff] [blame] | 4231 | For MS-Windows the icon can be changed, see |windows-icon|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4232 | |
| 4233 | *'iconstring'* |
| 4234 | 'iconstring' string (default "") |
| 4235 | global |
| 4236 | {not in Vi} |
| 4237 | {not available when compiled without the |+title| |
| 4238 | feature} |
| 4239 | When this option is not empty, it will be used for the icon text of |
| 4240 | the window. This happens only when the 'icon' option is on. |
| 4241 | Only works if the terminal supports setting window icon text |
| 4242 | (currently only X11 GUI and terminals with a non-empty 't_IS' option). |
| 4243 | Does not work for MS Windows. |
| 4244 | When Vim was compiled with HAVE_X11 defined, the original icon will be |
| 4245 | restored if possible |X11|. |
| 4246 | When this option contains printf-style '%' items, they will be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4247 | expanded according to the rules used for 'statusline'. See |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4248 | 'titlestring' for example settings. |
| 4249 | {not available when compiled without the |+statusline| feature} |
| 4250 | |
| 4251 | *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* |
| 4252 | 'ignorecase' 'ic' boolean (default off) |
| 4253 | global |
| 4254 | Ignore case in search patterns. Also used when searching in the tags |
| 4255 | file. |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 4256 | Also see 'smartcase' and 'tagcase'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4257 | Can be overruled by using "\c" or "\C" in the pattern, see |
| 4258 | |/ignorecase|. |
| 4259 | |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4260 | *'imactivatefunc'* *'imaf'* |
| 4261 | 'imactivatefunc' 'imaf' string (default "") |
| 4262 | global |
| 4263 | {not in Vi} |
Bram Moolenaar | 6315a9a | 2017-11-25 15:20:02 +0100 | [diff] [blame] | 4264 | {only available when compiled with |+mbyte|} |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4265 | This option specifies a function that will be called to |
Bram Moolenaar | 2877d33 | 2017-11-26 14:56:16 +0100 | [diff] [blame] | 4266 | activate or deactivate the Input Method. |
| 4267 | It is not used in the GUI. |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4268 | |
| 4269 | Example: > |
| 4270 | function ImActivateFunc(active) |
| 4271 | if a:active |
| 4272 | ... do something |
| 4273 | else |
| 4274 | ... do something |
| 4275 | endif |
| 4276 | " return value is not used |
| 4277 | endfunction |
| 4278 | set imactivatefunc=ImActivateFunc |
| 4279 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4280 | *'imactivatekey'* *'imak'* |
| 4281 | 'imactivatekey' 'imak' string (default "") |
| 4282 | global |
| 4283 | {not in Vi} |
| 4284 | {only available when compiled with |+xim| and |
Bram Moolenaar | 67c5384 | 2010-05-22 18:28:27 +0200 | [diff] [blame] | 4285 | |+GUI_GTK|} *E599* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4286 | Specifies the key that your Input Method in X-Windows uses for |
| 4287 | activation. When this is specified correctly, vim can fully control |
| 4288 | IM with 'imcmdline', 'iminsert' and 'imsearch'. |
| 4289 | You can't use this option to change the activation key, the option |
| 4290 | tells Vim what the key is. |
| 4291 | Format: |
| 4292 | [MODIFIER_FLAG-]KEY_STRING |
| 4293 | |
| 4294 | These characters can be used for MODIFIER_FLAG (case is ignored): |
| 4295 | S Shift key |
| 4296 | L Lock key |
| 4297 | C Control key |
| 4298 | 1 Mod1 key |
| 4299 | 2 Mod2 key |
| 4300 | 3 Mod3 key |
| 4301 | 4 Mod4 key |
| 4302 | 5 Mod5 key |
| 4303 | Combinations are allowed, for example "S-C-space" or "SC-space" are |
| 4304 | both shift+ctrl+space. |
| 4305 | See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. |
| 4306 | |
| 4307 | Example: > |
| 4308 | :set imactivatekey=S-space |
| 4309 | < "S-space" means shift+space. This is the activation key for kinput2 + |
| 4310 | canna (Japanese), and ami (Korean). |
| 4311 | |
| 4312 | *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* |
| 4313 | 'imcmdline' 'imc' boolean (default off) |
| 4314 | global |
| 4315 | {not in Vi} |
Bram Moolenaar | 6315a9a | 2017-11-25 15:20:02 +0100 | [diff] [blame] | 4316 | {only available when compiled with |+mbyte|} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4317 | When set the Input Method is always on when starting to edit a command |
| 4318 | line, unless entering a search pattern (see 'imsearch' for that). |
| 4319 | Setting this option is useful when your input method allows entering |
| 4320 | English characters directly, e.g., when it's used to type accented |
| 4321 | characters with dead keys. |
| 4322 | |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4323 | *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4324 | 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 4325 | global |
| 4326 | {not in Vi} |
Bram Moolenaar | 6315a9a | 2017-11-25 15:20:02 +0100 | [diff] [blame] | 4327 | {only available when compiled with |+mbyte|} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4328 | When set the Input Method is never used. This is useful to disable |
| 4329 | the IM when it doesn't work properly. |
| 4330 | Currently this option is on by default for SGI/IRIX machines. This |
| 4331 | may change in later releases. |
| 4332 | |
| 4333 | *'iminsert'* *'imi'* |
Bram Moolenaar | 4cf56bb | 2017-09-16 15:50:32 +0200 | [diff] [blame] | 4334 | 'iminsert' 'imi' number (default 0) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4335 | local to buffer |
| 4336 | {not in Vi} |
| 4337 | Specifies whether :lmap or an Input Method (IM) is to be used in |
| 4338 | Insert mode. Valid values: |
| 4339 | 0 :lmap is off and IM is off |
| 4340 | 1 :lmap is ON and IM is off |
| 4341 | 2 :lmap is off and IM is ON |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4342 | To always reset the option to zero when leaving Insert mode with <Esc> |
| 4343 | this can be used: > |
| 4344 | :inoremap <ESC> <ESC>:set iminsert=0<CR> |
| 4345 | < This makes :lmap and IM turn off automatically when leaving Insert |
| 4346 | mode. |
| 4347 | Note that this option changes when using CTRL-^ in Insert mode |
| 4348 | |i_CTRL-^|. |
| 4349 | The value is set to 1 when setting 'keymap' to a valid keymap name. |
| 4350 | It is also used for the argument of commands like "r" and "f". |
| 4351 | The value 0 may not work correctly with Athena and Motif with some XIM |
| 4352 | methods. Use 'imdisable' to disable XIM then. |
| 4353 | |
Bram Moolenaar | 6315a9a | 2017-11-25 15:20:02 +0100 | [diff] [blame] | 4354 | You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM |
| 4355 | via external command if vim is not compiled with the |+xim|, |
| 4356 | |+multi_byte_ime| or |global-ime|. |
| 4357 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4358 | *'imsearch'* *'ims'* |
Bram Moolenaar | 4cf56bb | 2017-09-16 15:50:32 +0200 | [diff] [blame] | 4359 | 'imsearch' 'ims' number (default -1) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4360 | local to buffer |
| 4361 | {not in Vi} |
| 4362 | Specifies whether :lmap or an Input Method (IM) is to be used when |
| 4363 | entering a search pattern. Valid values: |
| 4364 | -1 the value of 'iminsert' is used, makes it look like |
| 4365 | 'iminsert' is also used when typing a search pattern |
| 4366 | 0 :lmap is off and IM is off |
| 4367 | 1 :lmap is ON and IM is off |
| 4368 | 2 :lmap is off and IM is ON |
| 4369 | Note that this option changes when using CTRL-^ in Command-line mode |
| 4370 | |c_CTRL-^|. |
| 4371 | The value is set to 1 when it is not -1 and setting the 'keymap' |
| 4372 | option to a valid keymap name. |
| 4373 | The value 0 may not work correctly with Athena and Motif with some XIM |
| 4374 | methods. Use 'imdisable' to disable XIM then. |
| 4375 | |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4376 | *'imstatusfunc'* *'imsf'* |
| 4377 | 'imstatusfunc' 'imsf' string (default "") |
| 4378 | global |
| 4379 | {not in Vi} |
Bram Moolenaar | 6315a9a | 2017-11-25 15:20:02 +0100 | [diff] [blame] | 4380 | {only available when compiled with |+mbyte|} |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4381 | This option specifies a function that is called to obtain the status |
| 4382 | of Input Method. It must return a positive number when IME is active. |
Bram Moolenaar | 2877d33 | 2017-11-26 14:56:16 +0100 | [diff] [blame] | 4383 | It is not used in the GUI. |
Bram Moolenaar | abab85a | 2013-06-26 19:18:05 +0200 | [diff] [blame] | 4384 | |
| 4385 | Example: > |
| 4386 | function ImStatusFunc() |
| 4387 | let is_active = ...do something |
| 4388 | return is_active ? 1 : 0 |
| 4389 | endfunction |
| 4390 | set imstatusfunc=ImStatusFunc |
| 4391 | < |
| 4392 | NOTE: This function is invoked very often. Keep it fast. |
| 4393 | |
Bram Moolenaar | 5c6dbcb | 2017-08-30 22:00:20 +0200 | [diff] [blame] | 4394 | *'imstyle'* *'imst'* |
| 4395 | 'imstyle' 'imst' number (default 1) |
| 4396 | global |
| 4397 | {not in Vi} |
| 4398 | {only available when compiled with |+xim| and |
| 4399 | |+GUI_GTK|} |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 4400 | This option specifies the input style of Input Method: |
| 4401 | 0 use on-the-spot style |
| 4402 | 1 over-the-spot style |
Bram Moolenaar | 5c6dbcb | 2017-08-30 22:00:20 +0200 | [diff] [blame] | 4403 | See: |xim-input-style| |
| 4404 | |
Bram Moolenaar | 24a98a0 | 2017-09-27 22:23:55 +0200 | [diff] [blame] | 4405 | For a long time on-the-spot style had been used in the GTK version of |
| 4406 | vim, however, it is known that it causes troubles when using mappings, |
Bram Moolenaar | 5c6dbcb | 2017-08-30 22:00:20 +0200 | [diff] [blame] | 4407 | |single-repeat|, etc. Therefore over-the-spot style becomes the |
| 4408 | default now. This should work fine for most people, however if you |
| 4409 | have any problem with it, try using on-the-spot style. |
| 4410 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4411 | *'include'* *'inc'* |
| 4412 | 'include' 'inc' string (default "^\s*#\s*include") |
| 4413 | global or local to buffer |global-local| |
| 4414 | {not in Vi} |
| 4415 | {not available when compiled without the |
| 4416 | |+find_in_path| feature} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4417 | 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] | 4418 | pattern, just like for the "/" command (See |pattern|). The default |
| 4419 | value is for C programs. This option is used for the commands "[i", |
Bram Moolenaar | 1e01546 | 2005-09-25 22:16:38 +0000 | [diff] [blame] | 4420 | "]I", "[d", etc. |
| 4421 | Normally the 'isfname' option is used to recognize the file name that |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 4422 | comes after the matched pattern. But if "\zs" appears in the pattern |
| 4423 | then the text matched from "\zs" to the end, or until "\ze" if it |
| 4424 | appears, is used as the file name. Use this to include characters |
| 4425 | that are not in 'isfname', such as a space. You can then use |
| 4426 | 'includeexpr' to process the matched text. |
Bram Moolenaar | 1e01546 | 2005-09-25 22:16:38 +0000 | [diff] [blame] | 4427 | See |option-backslash| about including spaces and backslashes. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4428 | |
| 4429 | *'includeexpr'* *'inex'* |
| 4430 | 'includeexpr' 'inex' string (default "") |
| 4431 | local to buffer |
| 4432 | {not in Vi} |
| 4433 | {not available when compiled without the |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 4434 | |+find_in_path| or |+eval| features} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4435 | Expression to be used to transform the string found with the 'include' |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4436 | option to a file name. Mostly useful to change "." to "/" for Java: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4437 | :set includeexpr=substitute(v:fname,'\\.','/','g') |
| 4438 | < The "v:fname" variable will be set to the file name that was detected. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 4439 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4440 | 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] | 4441 | found. Allows doing "gf" on the name after an 'include' statement. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4442 | Also used for |<cfile>|. |
| 4443 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 4444 | The expression will be evaluated in the |sandbox| when set from a |
| 4445 | modeline, see |sandbox-option|. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 4446 | |
| 4447 | It is not allowed to change text or jump to another window while |
| 4448 | evaluating 'includeexpr' |textlock|. |
| 4449 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4450 | *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 4451 | 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
| 4452 | +reltime feature is supported) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4453 | global |
| 4454 | {not in Vi} |
| 4455 | {not available when compiled without the |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 4456 | |+extra_search| features} |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 4457 | While typing a search command, show where the pattern, as it was typed |
| 4458 | so far, matches. The matched string is highlighted. If the pattern |
| 4459 | is invalid or not found, nothing is shown. The screen will be updated |
| 4460 | often, this is only useful on fast terminals. |
| 4461 | Note that the match will be shown, but the cursor will return to its |
| 4462 | original position when no match is found and when pressing <Esc>. You |
| 4463 | still need to finish the search command with <Enter> to move the |
| 4464 | cursor to the match. |
Bram Moolenaar | dc08328 | 2016-10-11 08:57:33 +0200 | [diff] [blame] | 4465 | You can use the CTRL-G and CTRL-T keys to move to the next and |
| 4466 | previous match. |c_CTRL-G| |c_CTRL-T| |
Bram Moolenaar | 91a4e82 | 2008-01-19 14:59:58 +0000 | [diff] [blame] | 4467 | When compiled with the |+reltime| feature Vim only searches for about |
| 4468 | half a second. With a complicated pattern and/or a lot of text the |
| 4469 | match may not be found. This is to avoid that Vim hangs while you |
| 4470 | are typing the pattern. |
Bram Moolenaar | 21cf823 | 2004-07-16 20:18:37 +0000 | [diff] [blame] | 4471 | The highlighting can be set with the 'i' flag in 'highlight'. |
Bram Moolenaar | 2f05849 | 2017-11-30 20:27:52 +0100 | [diff] [blame] | 4472 | When 'hlsearch' is on, all matched strings are highlighted too while |
| 4473 | typing a search command. See also: 'hlsearch'. |
Bram Moolenaar | 2e51d9a | 2017-10-29 16:40:30 +0100 | [diff] [blame] | 4474 | If you don't want turn 'hlsearch' on, but want to highlight all matches |
| 4475 | while searching, you can turn on and off 'hlsearch' with autocmd. |
| 4476 | Example: > |
| 4477 | augroup vimrc-incsearch-highlight |
| 4478 | autocmd! |
Bram Moolenaar | f8f8b2e | 2017-11-02 19:08:48 +0100 | [diff] [blame] | 4479 | autocmd CmdlineEnter /,\? :set hlsearch |
| 4480 | autocmd CmdlineLeave /,\? :set nohlsearch |
Bram Moolenaar | 2e51d9a | 2017-10-29 16:40:30 +0100 | [diff] [blame] | 4481 | augroup END |
| 4482 | < |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 4483 | CTRL-L can be used to add one character from after the current match |
Bram Moolenaar | a9dc375 | 2010-07-11 20:46:53 +0200 | [diff] [blame] | 4484 | to the command line. If 'ignorecase' and 'smartcase' are set and the |
| 4485 | command line has no uppercase characters, the added character is |
| 4486 | converted to lowercase. |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 4487 | CTRL-R CTRL-W can be used to add the word at the end of the current |
| 4488 | match, excluding the characters that were already typed. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4489 | NOTE: This option is reset when 'compatible' is set. |
| 4490 | |
| 4491 | *'indentexpr'* *'inde'* |
| 4492 | 'indentexpr' 'inde' string (default "") |
| 4493 | local to buffer |
| 4494 | {not in Vi} |
| 4495 | {not available when compiled without the |+cindent| |
| 4496 | or |+eval| features} |
| 4497 | Expression which is evaluated to obtain the proper indent for a line. |
| 4498 | It is used when a new line is created, for the |=| operator and |
| 4499 | in Insert mode as specified with the 'indentkeys' option. |
| 4500 | When this option is not empty, it overrules the 'cindent' and |
Bram Moolenaar | 20f90cf | 2011-05-19 12:22:51 +0200 | [diff] [blame] | 4501 | 'smartindent' indenting. When 'lisp' is set, this option is |
| 4502 | overridden by the Lisp indentation algorithm. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4503 | When 'paste' is set this option is not used for indenting. |
| 4504 | The expression is evaluated with |v:lnum| set to the line number for |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 4505 | which the indent is to be computed. The cursor is also in this line |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4506 | when the expression is evaluated (but it may be moved around). |
| 4507 | The expression must return the number of spaces worth of indent. It |
| 4508 | can return "-1" to keep the current indent (this means 'autoindent' is |
| 4509 | used for the indent). |
| 4510 | Functions useful for computing the indent are |indent()|, |cindent()| |
| 4511 | and |lispindent()|. |
| 4512 | The evaluation of the expression must not have side effects! It must |
| 4513 | not change the text, jump to another window, etc. Afterwards the |
| 4514 | cursor position is always restored, thus the cursor may be moved. |
| 4515 | Normally this option would be set to call a function: > |
| 4516 | :set indentexpr=GetMyIndent() |
| 4517 | < Error messages will be suppressed, unless the 'debug' option contains |
| 4518 | "msg". |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 4519 | See |indent-expression|. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 4520 | NOTE: This option is set to "" when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4521 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 4522 | The expression will be evaluated in the |sandbox| when set from a |
| 4523 | modeline, see |sandbox-option|. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 4524 | |
| 4525 | It is not allowed to change text or jump to another window while |
| 4526 | evaluating 'indentexpr' |textlock|. |
| 4527 | |
| 4528 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4529 | *'indentkeys'* *'indk'* |
| 4530 | 'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") |
| 4531 | local to buffer |
| 4532 | {not in Vi} |
| 4533 | {not available when compiled without the |+cindent| |
| 4534 | feature} |
| 4535 | A list of keys that, when typed in Insert mode, cause reindenting of |
| 4536 | the current line. Only happens if 'indentexpr' isn't empty. |
| 4537 | The format is identical to 'cinkeys', see |indentkeys-format|. |
| 4538 | See |C-indenting| and |indent-expression|. |
| 4539 | |
| 4540 | *'infercase'* *'inf'* *'noinfercase'* *'noinf'* |
| 4541 | 'infercase' 'inf' boolean (default off) |
| 4542 | local to buffer |
| 4543 | {not in Vi} |
| 4544 | When doing keyword completion in insert mode |ins-completion|, and |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4545 | 'ignorecase' is also on, the case of the match is adjusted depending |
| 4546 | on the typed text. If the typed text contains a lowercase letter |
| 4547 | where the match has an upper case letter, the completed part is made |
| 4548 | lowercase. If the typed text has no lowercase letters and the match |
| 4549 | has a lowercase letter where the typed text has an uppercase letter, |
| 4550 | and there is a letter before it, the completed part is made uppercase. |
| 4551 | With 'noinfercase' the match is used as-is. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4552 | |
| 4553 | *'insertmode'* *'im'* *'noinsertmode'* *'noim'* |
| 4554 | 'insertmode' 'im' boolean (default off) |
| 4555 | global |
| 4556 | {not in Vi} |
| 4557 | Makes Vim work in a way that Insert mode is the default mode. Useful |
| 4558 | if you want to use Vim as a modeless editor. Used for |evim|. |
| 4559 | These Insert mode commands will be useful: |
| 4560 | - Use the cursor keys to move around. |
Bram Moolenaar | dc1f164 | 2016-08-16 18:33:43 +0200 | [diff] [blame] | 4561 | - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4562 | this is a mapping, it is executed as if 'insertmode' was off. |
| 4563 | Normal mode remains active until the mapping is finished. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4564 | - 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] | 4565 | <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 4566 | left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4567 | |
| 4568 | These items change when 'insertmode' is set: |
| 4569 | - when starting to edit of a file, Vim goes to Insert mode. |
| 4570 | - <Esc> in Insert mode is a no-op and beeps. |
| 4571 | - <Esc> in Normal mode makes Vim go to Insert mode. |
| 4572 | - CTRL-L in Insert mode is a command, it is not inserted. |
| 4573 | - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* |
| 4574 | However, when <Esc> is used inside a mapping, it behaves like |
| 4575 | 'insertmode' was not set. This was done to be able to use the same |
| 4576 | mappings with 'insertmode' set or not set. |
| 4577 | When executing commands with |:normal| 'insertmode' is not used. |
| 4578 | |
| 4579 | NOTE: This option is reset when 'compatible' is set. |
| 4580 | |
| 4581 | *'isfname'* *'isf'* |
| 4582 | 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: |
| 4583 | "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" |
| 4584 | for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" |
| 4585 | for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" |
| 4586 | for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" |
| 4587 | otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") |
| 4588 | global |
| 4589 | {not in Vi} |
| 4590 | The characters specified by this option are included in file names and |
| 4591 | path names. Filenames are used for commands like "gf", "[i" and in |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4592 | the tags file. It is also used for "\f" in a |pattern|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4593 | Multi-byte characters 256 and above are always included, only the |
| 4594 | characters up to 255 are specified with this option. |
| 4595 | For UTF-8 the characters 0xa0 to 0xff are included as well. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4596 | Think twice before adding white space to this option. Although a |
| 4597 | space may appear inside a file name, the effect will be that Vim |
| 4598 | doesn't know where a file name starts or ends when doing completion. |
| 4599 | It most likely works better without a space in 'isfname'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4600 | |
| 4601 | Note that on systems using a backslash as path separator, Vim tries to |
| 4602 | do its best to make it work as you would expect. That is a bit |
| 4603 | tricky, since Vi originally used the backslash to escape special |
| 4604 | characters. Vim will not remove a backslash in front of a normal file |
| 4605 | name character on these systems, but it will on Unix and alikes. The |
| 4606 | '&' and '^' are not included by default, because these are special for |
| 4607 | cmd.exe. |
| 4608 | |
| 4609 | 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] | 4610 | Each part can be a single character number or a range. A range is two |
| 4611 | character numbers with '-' in between. A character number can be a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4612 | decimal number between 0 and 255 or the ASCII character itself (does |
| 4613 | not work for digits). Example: |
| 4614 | "_,-,128-140,#-43" (include '_' and '-' and the range |
| 4615 | 128 to 140 and '#' to 43) |
| 4616 | If a part starts with '^', the following character number or range |
| 4617 | will be excluded from the option. The option is interpreted from left |
| 4618 | to right. Put the excluded character after the range where it is |
| 4619 | included. To include '^' itself use it as the last character of the |
| 4620 | option or the end of a range. Example: |
| 4621 | "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') |
| 4622 | If the character is '@', all characters where isalpha() returns TRUE |
| 4623 | are included. Normally these are the characters a to z and A to Z, |
| 4624 | plus accented characters. To include '@' itself use "@-@". Examples: |
| 4625 | "@,^a-z" All alphabetic characters, excluding lower |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 4626 | case ASCII letters. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4627 | "a-z,A-Z,@-@" All letters plus the '@' character. |
| 4628 | A comma can be included by using it where a character number is |
| 4629 | expected. Example: |
| 4630 | "48-57,,,_" Digits, comma and underscore. |
| 4631 | A comma can be excluded by prepending a '^'. Example: |
| 4632 | " -~,^,,9" All characters from space to '~', excluding |
| 4633 | comma, plus <Tab>. |
| 4634 | See |option-backslash| about including spaces and backslashes. |
| 4635 | |
| 4636 | *'isident'* *'isi'* |
| 4637 | 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: |
| 4638 | "@,48-57,_,128-167,224-235" |
| 4639 | otherwise: "@,48-57,_,192-255") |
| 4640 | global |
| 4641 | {not in Vi} |
| 4642 | The characters given by this option are included in identifiers. |
| 4643 | Identifiers are used in recognizing environment variables and after a |
| 4644 | 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] | 4645 | |pattern|. See 'isfname' for a description of the format of this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4646 | option. |
| 4647 | Careful: If you change this option, it might break expanding |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4648 | environment variables. E.g., when '/' is included and Vim tries to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4649 | expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 4650 | |
| 4651 | *'iskeyword'* *'isk'* |
| 4652 | 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: |
| 4653 | "@,48-57,_,128-167,224-235" |
| 4654 | otherwise: "@,48-57,_,192-255" |
| 4655 | Vi default: "@,48-57,_") |
| 4656 | local to buffer |
| 4657 | {not in Vi} |
| 4658 | Keywords are used in searching and recognizing with many commands: |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4659 | "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] | 4660 | 'isfname' for a description of the format of this option. For C |
| 4661 | programs you could use "a-z,A-Z,48-57,_,.,-,>". |
| 4662 | For a help file it is set to all non-blank printable characters except |
| 4663 | '*', '"' and '|' (so that CTRL-] on a command finds the help for that |
| 4664 | command). |
| 4665 | When the 'lisp' option is on the '-' character is always included. |
Bram Moolenaar | b8060fe | 2016-01-19 22:29:28 +0100 | [diff] [blame] | 4666 | This option also influences syntax highlighting, unless the syntax |
| 4667 | uses |:syn-iskeyword|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4668 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 4669 | set and to the Vim default value when 'compatible' is reset. |
| 4670 | |
| 4671 | *'isprint'* *'isp'* |
| 4672 | 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: |
| 4673 | "@,~-255"; otherwise: "@,161-255") |
| 4674 | global |
| 4675 | {not in Vi} |
| 4676 | The characters given by this option are displayed directly on the |
| 4677 | screen. It is also used for "\p" in a |pattern|. The characters from |
| 4678 | space (ASCII 32) to '~' (ASCII 126) are always displayed directly, |
| 4679 | even when they are not included in 'isprint' or excluded. See |
| 4680 | 'isfname' for a description of the format of this option. |
| 4681 | |
| 4682 | Non-printable characters are displayed with two characters: |
| 4683 | 0 - 31 "^@" - "^_" |
| 4684 | 32 - 126 always single characters |
| 4685 | 127 "^?" |
| 4686 | 128 - 159 "~@" - "~_" |
| 4687 | 160 - 254 "| " - "|~" |
| 4688 | 255 "~?" |
| 4689 | When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are |
| 4690 | displayed as <xx>, with the hexadecimal value of the byte. |
| 4691 | When 'display' contains "uhex" all unprintable characters are |
| 4692 | displayed as <xx>. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4693 | The SpecialKey highlighting will be used for unprintable characters. |
| 4694 | |hl-SpecialKey| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4695 | |
| 4696 | Multi-byte characters 256 and above are always included, only the |
| 4697 | characters up to 255 are specified with this option. When a character |
| 4698 | is printable but it is not available in the current font, a |
| 4699 | replacement character will be shown. |
| 4700 | Unprintable and zero-width Unicode characters are displayed as <xxxx>. |
| 4701 | There is no option to specify these characters. |
| 4702 | |
| 4703 | *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* |
| 4704 | 'joinspaces' 'js' boolean (default on) |
| 4705 | global |
| 4706 | {not in Vi} |
| 4707 | Insert two spaces after a '.', '?' and '!' with a join command. |
| 4708 | When 'cpoptions' includes the 'j' flag, only do this after a '.'. |
| 4709 | Otherwise only one space is inserted. |
| 4710 | NOTE: This option is set when 'compatible' is set. |
| 4711 | |
| 4712 | *'key'* |
| 4713 | 'key' string (default "") |
| 4714 | local to buffer |
| 4715 | {not in Vi} |
Bram Moolenaar | 996343d | 2010-07-04 22:20:21 +0200 | [diff] [blame] | 4716 | {only available when compiled with the |+cryptv| |
| 4717 | feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4718 | The key that is used for encrypting and decrypting the current buffer. |
Bram Moolenaar | 40e6a71 | 2010-05-16 22:32:54 +0200 | [diff] [blame] | 4719 | See |encryption| and 'cryptmethod'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4720 | Careful: Do not set the key value by hand, someone might see the typed |
| 4721 | key. Use the |:X| command. But you can make 'key' empty: > |
| 4722 | :set key= |
| 4723 | < It is not possible to get the value of this option with ":set key" or |
| 4724 | "echo &key". This is to avoid showing it to someone who shouldn't |
| 4725 | know. It also means you cannot see it yourself once you have set it, |
| 4726 | be careful not to make a typing error! |
Bram Moolenaar | d58e929 | 2011-02-09 17:07:58 +0100 | [diff] [blame] | 4727 | You can use "&key" in an expression to detect whether encryption is |
| 4728 | enabled. When 'key' is set it returns "*****" (five stars). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4729 | |
| 4730 | *'keymap'* *'kmp'* *E544* |
| 4731 | 'keymap' 'kmp' string (default "") |
| 4732 | local to buffer |
| 4733 | {not in Vi} |
| 4734 | {only available when compiled with the |+keymap| |
| 4735 | feature} |
| 4736 | Name of a keyboard mapping. See |mbyte-keymap|. |
| 4737 | Setting this option to a valid keymap name has the side effect of |
| 4738 | setting 'iminsert' to one, so that the keymap becomes effective. |
| 4739 | 'imsearch' is also set to one, unless it was -1 |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 4740 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4741 | |
| 4742 | *'keymodel'* *'km'* |
| 4743 | 'keymodel' 'km' string (default "") |
| 4744 | global |
| 4745 | {not in Vi} |
| 4746 | List of comma separated words, which enable special things that keys |
| 4747 | can do. These values can be used: |
| 4748 | startsel Using a shifted special key starts selection (either |
| 4749 | Select mode or Visual mode, depending on "key" being |
| 4750 | present in 'selectmode'). |
| 4751 | stopsel Using a not-shifted special key stops selection. |
| 4752 | Special keys in this context are the cursor keys, <End>, <Home>, |
| 4753 | <PageUp> and <PageDown>. |
| 4754 | The 'keymodel' option is set by the |:behave| command. |
| 4755 | |
| 4756 | *'keywordprg'* *'kp'* |
| 4757 | 'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help", |
Bram Moolenaar | 2ff8b64 | 2016-05-24 10:46:45 +0200 | [diff] [blame] | 4758 | VMS: "help") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4759 | global or local to buffer |global-local| |
| 4760 | {not in Vi} |
| 4761 | Program to use for the |K| command. Environment variables are |
| 4762 | expanded |:set_env|. ":help" may be used to access the Vim internal |
| 4763 | help. (Note that previously setting the global option to the empty |
| 4764 | value did this, which is now deprecated.) |
Bram Moolenaar | 2ff8b64 | 2016-05-24 10:46:45 +0200 | [diff] [blame] | 4765 | When the first character is ":", the command is invoked as a Vim |
| 4766 | Ex command prefixed with [count]. |
| 4767 | When "man", "man -s" or an Ex command is used, Vim will automatically |
| 4768 | translate a count for the "K" command and pass it as the first |
| 4769 | argument. For "man -s" the "-s" is removed when there is no count. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4770 | See |option-backslash| about including spaces and backslashes. |
| 4771 | Example: > |
| 4772 | :set keywordprg=man\ -s |
| 4773 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4774 | security reasons. |
| 4775 | |
| 4776 | *'langmap'* *'lmap'* *E357* *E358* |
| 4777 | 'langmap' 'lmap' string (default "") |
| 4778 | global |
| 4779 | {not in Vi} |
| 4780 | {only available when compiled with the |+langmap| |
| 4781 | feature} |
| 4782 | This option allows switching your keyboard into a special language |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4783 | mode. When you are typing text in Insert mode the characters are |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 4784 | inserted directly. When in Normal mode the 'langmap' option takes |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4785 | care of translating these special characters to the original meaning |
| 4786 | of the key. This means you don't have to change the keyboard mode to |
| 4787 | be able to execute Normal mode commands. |
| 4788 | This is the opposite of the 'keymap' option, where characters are |
| 4789 | mapped in Insert mode. |
Bram Moolenaar | e4a3bcf | 2016-08-26 19:52:37 +0200 | [diff] [blame] | 4790 | Also consider resetting 'langremap' to avoid 'langmap' applies to |
Bram Moolenaar | c229967 | 2014-11-13 14:25:38 +0100 | [diff] [blame] | 4791 | characters resulting from a mapping. |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 4792 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4793 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4794 | |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 4795 | Example (for Greek, in UTF-8): *greek* > |
| 4796 | :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4797 | < Example (exchanges meaning of z and y for commands): > |
| 4798 | :set langmap=zy,yz,ZY,YZ |
| 4799 | < |
| 4800 | The 'langmap' option is a list of parts, separated with commas. Each |
| 4801 | part can be in one of two forms: |
| 4802 | 1. A list of pairs. Each pair is a "from" character immediately |
| 4803 | followed by the "to" character. Examples: "aA", "aAbBcC". |
| 4804 | 2. A list of "from" characters, a semi-colon and a list of "to" |
| 4805 | characters. Example: "abc;ABC" |
| 4806 | Example: "aA,fgh;FGH,cCdDeE" |
| 4807 | Special characters need to be preceded with a backslash. These are |
| 4808 | ";", ',' and backslash itself. |
| 4809 | |
| 4810 | This will allow you to activate vim actions without having to switch |
| 4811 | back and forth between the languages. Your language characters will |
| 4812 | be understood as normal vim English characters (according to the |
| 4813 | langmap mappings) in the following cases: |
| 4814 | o Normal/Visual mode (commands, buffer/register names, user mappings) |
| 4815 | o Insert/Replace Mode: Register names after CTRL-R |
| 4816 | o Insert/Replace Mode: Mappings |
| 4817 | Characters entered in Command-line mode will NOT be affected by |
| 4818 | this option. Note that this option can be changed at any time |
| 4819 | allowing to switch between mappings for different languages/encodings. |
| 4820 | Use a mapping to avoid having to type it each time! |
| 4821 | |
| 4822 | *'langmenu'* *'lm'* |
| 4823 | 'langmenu' 'lm' string (default "") |
| 4824 | global |
| 4825 | {not in Vi} |
| 4826 | {only available when compiled with the |+menu| and |
| 4827 | |+multi_lang| features} |
| 4828 | Language to use for menu translation. Tells which file is loaded |
| 4829 | from the "lang" directory in 'runtimepath': > |
| 4830 | "lang/menu_" . &langmenu . ".vim" |
| 4831 | < (without the spaces). For example, to always use the Dutch menus, no |
| 4832 | matter what $LANG is set to: > |
| 4833 | :set langmenu=nl_NL.ISO_8859-1 |
| 4834 | < When 'langmenu' is empty, |v:lang| is used. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 4835 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4836 | If your $LANG is set to a non-English language but you do want to use |
| 4837 | the English menus: > |
| 4838 | :set langmenu=none |
| 4839 | < This option must be set before loading menus, switching on filetype |
| 4840 | detection or syntax highlighting. Once the menus are defined setting |
| 4841 | this option has no effect. But you could do this: > |
| 4842 | :source $VIMRUNTIME/delmenu.vim |
| 4843 | :set langmenu=de_DE.ISO_8859-1 |
| 4844 | :source $VIMRUNTIME/menu.vim |
| 4845 | < Warning: This deletes all menus that you defined yourself! |
| 4846 | |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 4847 | *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 4848 | 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
Bram Moolenaar | 4391cf9 | 2014-11-05 17:44:52 +0100 | [diff] [blame] | 4849 | global |
| 4850 | {not in Vi} |
| 4851 | {only available when compiled with the |+langmap| |
| 4852 | feature} |
Bram Moolenaar | e4a3bcf | 2016-08-26 19:52:37 +0200 | [diff] [blame] | 4853 | This is just like 'langremap' but with the value inverted. It only |
| 4854 | exists for backwards compatibility. When setting 'langremap' then |
| 4855 | 'langnoremap' is set to the inverted value, and the other way around. |
| 4856 | |
| 4857 | *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
| 4858 | 'langremap' 'lrm' boolean (default on, reset in |defaults.vim|) |
| 4859 | global |
| 4860 | {not in Vi} |
| 4861 | {only available when compiled with the |+langmap| |
| 4862 | feature} |
| 4863 | When off, setting 'langmap' does not apply to characters resulting from |
Bram Moolenaar | 4391cf9 | 2014-11-05 17:44:52 +0100 | [diff] [blame] | 4864 | a mapping. This basically means, if you noticed that setting |
Bram Moolenaar | e4a3bcf | 2016-08-26 19:52:37 +0200 | [diff] [blame] | 4865 | 'langmap' disables some of your mappings, try resetting this option. |
| 4866 | This option defaults to on for backwards compatibility. Set it off if |
Bram Moolenaar | 4391cf9 | 2014-11-05 17:44:52 +0100 | [diff] [blame] | 4867 | that works for you to avoid mappings to break. |
| 4868 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4869 | *'laststatus'* *'ls'* |
| 4870 | 'laststatus' 'ls' number (default 1) |
| 4871 | global |
| 4872 | {not in Vi} |
| 4873 | The value of this option influences when the last window will have a |
| 4874 | status line: |
| 4875 | 0: never |
| 4876 | 1: only if there are at least two windows |
| 4877 | 2: always |
| 4878 | The screen looks nicer with a status line if you have several |
| 4879 | windows, but it takes another screen line. |status-line| |
| 4880 | |
| 4881 | *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* |
| 4882 | 'lazyredraw' 'lz' boolean (default off) |
| 4883 | global |
| 4884 | {not in Vi} |
| 4885 | When this option is set, the screen will not be redrawn while |
| 4886 | executing macros, registers and other commands that have not been |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4887 | typed. Also, updating the window title is postponed. To force an |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4888 | update use |:redraw|. |
| 4889 | |
| 4890 | *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* |
| 4891 | 'linebreak' 'lbr' boolean (default off) |
| 4892 | local to window |
| 4893 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 4894 | {not available when compiled without the |+linebreak| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4895 | feature} |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 4896 | If on, Vim will wrap long lines at a character in 'breakat' rather |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4897 | than at the last character that fits on the screen. Unlike |
| 4898 | 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, |
Bram Moolenaar | 946e27a | 2014-06-25 18:50:27 +0200 | [diff] [blame] | 4899 | it only affects the way the file is displayed, not its contents. |
| 4900 | If 'breakindent' is set, line is visually indented. Then, the value |
| 4901 | of 'showbreak' is used to put in front of wrapped lines. This option |
Bram Moolenaar | 86b17e9 | 2014-07-02 20:00:47 +0200 | [diff] [blame] | 4902 | is not used when the 'wrap' option is off. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4903 | Note that <Tab> characters after an <EOL> are mostly not displayed |
| 4904 | with the right amount of white space. |
| 4905 | |
| 4906 | *'lines'* *E593* |
| 4907 | 'lines' number (default 24 or terminal height) |
| 4908 | global |
| 4909 | Number of lines of the Vim window. |
| 4910 | 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] | 4911 | terminal initialization code. Also see |posix-screen-size|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4912 | When Vim is running in the GUI or in a resizable window, setting this |
| 4913 | option will cause the window size to be changed. When you only want |
| 4914 | to use the size for the GUI, put the command in your |gvimrc| file. |
| 4915 | Vim limits the number of lines to what fits on the screen. You can |
| 4916 | use this command to get the tallest window possible: > |
| 4917 | :set lines=999 |
Bram Moolenaar | f4d1145 | 2005-12-02 00:46:37 +0000 | [diff] [blame] | 4918 | < Minimum value is 2, maximum value is 1000. |
Bram Moolenaar | dc1f164 | 2016-08-16 18:33:43 +0200 | [diff] [blame] | 4919 | If you get fewer lines than expected, check the 'guiheadroom' option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4920 | When you set this option and Vim is unable to change the physical |
| 4921 | number of lines of the display, the display may be messed up. |
| 4922 | |
| 4923 | *'linespace'* *'lsp'* |
| 4924 | 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) |
| 4925 | global |
| 4926 | {not in Vi} |
| 4927 | {only in the GUI} |
| 4928 | Number of pixel lines inserted between characters. Useful if the font |
| 4929 | uses the full character cell height, making lines touch each other. |
| 4930 | When non-zero there is room for underlining. |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 4931 | With some fonts there can be too much room between lines (to have |
| 4932 | space for ascents and descents). Then it makes sense to set |
| 4933 | 'linespace' to a negative value. This may cause display problems |
| 4934 | though! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4935 | |
| 4936 | *'lisp'* *'nolisp'* |
| 4937 | 'lisp' boolean (default off) |
| 4938 | local to buffer |
| 4939 | {not available when compiled without the |+lispindent| |
| 4940 | feature} |
| 4941 | Lisp mode: When <Enter> is typed in insert mode set the indent for |
| 4942 | the next line to Lisp standards (well, sort of). Also happens with |
| 4943 | "cc" or "S". 'autoindent' must also be on for this to work. The 'p' |
| 4944 | flag in 'cpoptions' changes the method of indenting: Vi compatible or |
| 4945 | better. Also see 'lispwords'. |
| 4946 | The '-' character is included in keyword characters. Redefines the |
| 4947 | "=" operator to use this same indentation algorithm rather than |
| 4948 | calling an external program if 'equalprg' is empty. |
| 4949 | This option is not used when 'paste' is set. |
| 4950 | {Vi: Does it a little bit differently} |
| 4951 | |
| 4952 | *'lispwords'* *'lw'* |
| 4953 | 'lispwords' 'lw' string (default is very long) |
Bram Moolenaar | af6c131 | 2014-03-12 18:55:58 +0100 | [diff] [blame] | 4954 | global or local to buffer |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4955 | {not in Vi} |
| 4956 | {not available when compiled without the |+lispindent| |
| 4957 | feature} |
| 4958 | Comma separated list of words that influence the Lisp indenting. |
| 4959 | |'lisp'| |
| 4960 | |
| 4961 | *'list'* *'nolist'* |
| 4962 | 'list' boolean (default off) |
| 4963 | local to window |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4964 | List mode: Show tabs as CTRL-I is displayed, display $ after end of |
| 4965 | line. Useful to see the difference between tabs and spaces and for |
| 4966 | trailing blanks. Further changed by the 'listchars' option. |
| 4967 | |
| 4968 | The cursor is displayed at the start of the space a Tab character |
| 4969 | occupies, not at the end as usual in Normal mode. To get this cursor |
| 4970 | position while displaying Tabs with spaces, use: > |
Bram Moolenaar | dd007ed | 2013-07-09 15:44:17 +0200 | [diff] [blame] | 4971 | :set list lcs=tab:\ \ |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 4972 | < |
| 4973 | Note that list mode will also affect formatting (set with 'textwidth' |
| 4974 | or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4975 | changing the way tabs are displayed. |
| 4976 | |
| 4977 | *'listchars'* *'lcs'* |
| 4978 | 'listchars' 'lcs' string (default "eol:$") |
| 4979 | global |
| 4980 | {not in Vi} |
Bram Moolenaar | f9d5ca1 | 2010-08-01 16:13:51 +0200 | [diff] [blame] | 4981 | Strings to use in 'list' mode and for the |:list| command. It is a |
| 4982 | comma separated list of string settings. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 4983 | *lcs-eol* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4984 | eol:c Character to show at the end of each line. When |
| 4985 | omitted, there is no extra character at the end of the |
| 4986 | line. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 4987 | *lcs-tab* |
Bram Moolenaar | ebcbd02 | 2007-05-12 14:28:25 +0000 | [diff] [blame] | 4988 | tab:xy Two characters to be used to show a tab. The first |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 4989 | char is used once. The second char is repeated to |
Bram Moolenaar | ebcbd02 | 2007-05-12 14:28:25 +0000 | [diff] [blame] | 4990 | fill the space that the tab normally occupies. |
| 4991 | "tab:>-" will show a tab that takes four spaces as |
| 4992 | ">---". When omitted, a tab is show as ^I. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 4993 | *lcs-space* |
| 4994 | space:c Character to show for a space. When omitted, spaces |
| 4995 | are left blank. |
| 4996 | *lcs-trail* |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 4997 | trail:c Character to show for trailing spaces. When omitted, |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 4998 | trailing spaces are blank. Overrides the "space" |
| 4999 | setting for trailing spaces. |
| 5000 | *lcs-extends* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5001 | extends:c Character to show in the last column, when 'wrap' is |
| 5002 | off and the line continues beyond the right of the |
| 5003 | screen. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 5004 | *lcs-precedes* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5005 | precedes:c Character to show in the first column, when 'wrap' |
| 5006 | is off and there is text preceding the character |
| 5007 | visible in the first column. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 5008 | *lcs-conceal* |
Bram Moolenaar | 860cae1 | 2010-06-05 23:22:07 +0200 | [diff] [blame] | 5009 | conceal:c Character to show in place of concealed text, when |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 5010 | 'conceallevel' is set to 1. |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 5011 | *lcs-nbsp* |
Bram Moolenaar | 73284b9 | 2015-05-04 17:28:22 +0200 | [diff] [blame] | 5012 | nbsp:c Character to show for a non-breakable space character |
| 5013 | (0xA0 (160 decimal) and U+202F). Left blank when |
| 5014 | omitted. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5015 | |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5016 | The characters ':' and ',' should not be used. UTF-8 characters can |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5017 | be used when 'encoding' is "utf-8", otherwise only printable |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 5018 | characters are allowed. All characters must be single width. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5019 | |
| 5020 | Examples: > |
| 5021 | :set lcs=tab:>-,trail:- |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 5022 | :set lcs=tab:>-,eol:<,nbsp:% |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5023 | :set lcs=extends:>,precedes:< |
| 5024 | < The "NonText" highlighting will be used for "eol", "extends" and |
Bram Moolenaar | 7927836 | 2015-04-21 18:33:48 +0200 | [diff] [blame] | 5025 | "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail". |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5026 | |hl-NonText| |hl-SpecialKey| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5027 | |
| 5028 | *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* |
| 5029 | 'loadplugins' 'lpl' boolean (default on) |
| 5030 | global |
| 5031 | {not in Vi} |
| 5032 | When on the plugin scripts are loaded when starting up |load-plugins|. |
| 5033 | This option can be reset in your |vimrc| file to disable the loading |
| 5034 | of plugins. |
Bram Moolenaar | c4da113 | 2017-07-15 19:39:43 +0200 | [diff] [blame] | 5035 | Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command |
| 5036 | line arguments reset this option. See |-u| and |--noplugin|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5037 | |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5038 | *'luadll'* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 5039 | 'luadll' string (default depends on the build) |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5040 | global |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 5041 | {not in Vi} |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5042 | {only available when compiled with the |+lua/dyn| |
| 5043 | feature} |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 5044 | Specifies the name of the Lua shared library. The default is |
| 5045 | DYNAMIC_LUA_DLL, which was specified at compile time. |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 5046 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5047 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5048 | security reasons. |
| 5049 | |
Bram Moolenaar | f9393ef | 2006-04-24 19:47:27 +0000 | [diff] [blame] | 5050 | *'macatsui'* *'nomacatsui'* |
| 5051 | 'macatsui' boolean (default on) |
| 5052 | global |
| 5053 | {only available in Mac GUI version} |
| 5054 | This is a workaround for when drawing doesn't work properly. When set |
| 5055 | and compiled with multi-byte support ATSUI text drawing is used. When |
| 5056 | not set ATSUI text drawing is not used. Switch this option off when |
| 5057 | you experience drawing problems. In a future version the problems may |
| 5058 | be solved and this option becomes obsolete. Therefore use this method |
| 5059 | to unset it: > |
| 5060 | if exists('&macatsui') |
| 5061 | set nomacatsui |
| 5062 | endif |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5063 | < Another option to check if you have drawing problems is |
| 5064 | 'termencoding'. |
| 5065 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5066 | *'magic'* *'nomagic'* |
| 5067 | 'magic' boolean (default on) |
| 5068 | global |
| 5069 | Changes the special characters that can be used in search patterns. |
| 5070 | See |pattern|. |
Bram Moolenaar | 64d8e25 | 2016-09-06 22:12:34 +0200 | [diff] [blame] | 5071 | WARNING: Switching this option off most likely breaks plugins! That |
| 5072 | is because many patterns assume it's on and will fail when it's off. |
| 5073 | Only switch it off when working with old Vi scripts. In any other |
| 5074 | situation write patterns that work when 'magic' is on. Include "\M" |
| 5075 | when you want to |/\M|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5076 | |
| 5077 | *'makeef'* *'mef'* |
| 5078 | 'makeef' 'mef' string (default: "") |
| 5079 | global |
| 5080 | {not in Vi} |
| 5081 | {not available when compiled without the |+quickfix| |
| 5082 | feature} |
| 5083 | Name of the errorfile for the |:make| command (see |:make_makeprg|) |
| 5084 | and the |:grep| command. |
| 5085 | When it is empty, an internally generated temp file will be used. |
| 5086 | When "##" is included, it is replaced by a number to make the name |
| 5087 | unique. This makes sure that the ":make" command doesn't overwrite an |
| 5088 | existing file. |
| 5089 | NOT used for the ":cf" command. See 'errorfile' for that. |
| 5090 | Environment variables are expanded |:set_env|. |
| 5091 | See |option-backslash| about including spaces and backslashes. |
| 5092 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5093 | security reasons. |
| 5094 | |
Bram Moolenaar | 2c7292d | 2017-03-05 17:43:31 +0100 | [diff] [blame] | 5095 | *'makeencoding'* *'menc'* |
| 5096 | 'makeencoding' 'menc' string (default "") |
| 5097 | global or local to buffer |global-local| |
| 5098 | {only available when compiled with the |+multi_byte| |
| 5099 | feature} |
| 5100 | {not in Vi} |
| 5101 | Encoding used for reading the output of external commands. When empty, |
| 5102 | encoding is not converted. |
| 5103 | This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`, |
| 5104 | `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`, |
| 5105 | and `:laddfile`. |
| 5106 | |
| 5107 | This would be mostly useful when you use MS-Windows and set 'encoding' |
| 5108 | to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting |
| 5109 | 'makeencoding' to "char" has the same effect as setting to the system |
| 5110 | locale encoding. Example: > |
| 5111 | :set encoding=utf-8 |
| 5112 | :set makeencoding=char " system locale is used |
| 5113 | < |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5114 | *'makeprg'* *'mp'* |
| 5115 | 'makeprg' 'mp' string (default "make", VMS: "MMS") |
| 5116 | global or local to buffer |global-local| |
| 5117 | {not in Vi} |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5118 | Program to use for the ":make" command. See |:make_makeprg|. |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 5119 | This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
| 5120 | which are expanded to the current and alternate file name. Use |::S| |
Bram Moolenaar | 26df092 | 2014-02-23 23:39:13 +0100 | [diff] [blame] | 5121 | to escape file names in case they contain special characters. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5122 | Environment variables are expanded |:set_env|. See |option-backslash| |
| 5123 | about including spaces and backslashes. |
| 5124 | Note that a '|' must be escaped twice: once for ":set" and once for |
| 5125 | the interpretation of a command. When you use a filter called |
| 5126 | "myfilter" do it like this: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5127 | :set makeprg=gmake\ \\\|\ myfilter |
| 5128 | < The placeholder "$*" can be given (even multiple times) to specify |
| 5129 | where the arguments will be included, for example: > |
| 5130 | :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} |
| 5131 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5132 | security reasons. |
| 5133 | |
| 5134 | *'matchpairs'* *'mps'* |
| 5135 | 'matchpairs' 'mps' string (default "(:),{:},[:]") |
| 5136 | local to buffer |
| 5137 | {not in Vi} |
| 5138 | Characters that form pairs. The |%| command jumps from one to the |
Bram Moolenaar | a3e6bc9 | 2013-01-30 14:18:00 +0100 | [diff] [blame] | 5139 | other. |
| 5140 | Only character pairs are allowed that are different, thus you cannot |
| 5141 | jump between two double quotes. |
| 5142 | The characters must be separated by a colon. |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5143 | The pairs must be separated by a comma. Example for including '<' and |
| 5144 | '>' (HTML): > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5145 | :set mps+=<:> |
| 5146 | |
| 5147 | < A more exotic example, to jump between the '=' and ';' in an |
| 5148 | assignment, useful for languages like C and Java: > |
| 5149 | :au FileType c,cpp,java set mps+==:; |
| 5150 | |
| 5151 | < For a more advanced way of using "%", see the matchit.vim plugin in |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 5152 | the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5153 | |
| 5154 | *'matchtime'* *'mat'* |
| 5155 | 'matchtime' 'mat' number (default 5) |
| 5156 | global |
| 5157 | {not in Vi}{in Nvi} |
| 5158 | Tenths of a second to show the matching paren, when 'showmatch' is |
| 5159 | set. Note that this is not in milliseconds, like other options that |
| 5160 | set a time. This is to be compatible with Nvi. |
| 5161 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 5162 | *'maxcombine'* *'mco'* |
| 5163 | 'maxcombine' 'mco' number (default 2) |
| 5164 | global |
| 5165 | {not in Vi} |
| 5166 | {only available when compiled with the |+multi_byte| |
| 5167 | feature} |
| 5168 | The maximum number of combining characters supported for displaying. |
| 5169 | Only used when 'encoding' is "utf-8". |
| 5170 | The default is OK for most languages. Hebrew may require 4. |
| 5171 | Maximum value is 6. |
| 5172 | Even when this option is set to 2 you can still edit text with more |
| 5173 | combining characters, you just can't see them. Use |g8| or |ga|. |
| 5174 | See |mbyte-combining|. |
| 5175 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5176 | *'maxfuncdepth'* *'mfd'* |
| 5177 | 'maxfuncdepth' 'mfd' number (default 100) |
| 5178 | global |
| 5179 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 5180 | {not available when compiled without the |+eval| |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5181 | feature} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5182 | Maximum depth of function calls for user functions. This normally |
| 5183 | catches endless recursion. When using a recursive function with |
| 5184 | more depth, set 'maxfuncdepth' to a bigger number. But this will use |
| 5185 | more memory, there is the danger of failing when memory is exhausted. |
Bram Moolenaar | bc2eada | 2017-01-02 21:27:47 +0100 | [diff] [blame] | 5186 | Increasing this limit above 200 also changes the maximum for Ex |
| 5187 | command resursion, see |E169|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5188 | See also |:function|. |
| 5189 | |
| 5190 | *'maxmapdepth'* *'mmd'* *E223* |
| 5191 | 'maxmapdepth' 'mmd' number (default 1000) |
| 5192 | global |
| 5193 | {not in Vi} |
| 5194 | Maximum number of times a mapping is done without resulting in a |
| 5195 | character to be used. This normally catches endless mappings, like |
| 5196 | ":map x y" with ":map y x". It still does not catch ":map g wg", |
| 5197 | because the 'w' is used before the next mapping is done. See also |
| 5198 | |key-mapping|. |
| 5199 | |
| 5200 | *'maxmem'* *'mm'* |
| 5201 | 'maxmem' 'mm' number (default between 256 to 5120 (system |
| 5202 | dependent) or half the amount of memory |
| 5203 | available) |
| 5204 | global |
| 5205 | {not in Vi} |
| 5206 | Maximum amount of memory (in Kbyte) to use for one buffer. When this |
| 5207 | limit is reached allocating extra memory for a buffer will cause |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 5208 | other memory to be freed. |
| 5209 | The maximum usable value is about 2000000. Use this to work without a |
| 5210 | limit. |
| 5211 | The value is ignored when 'swapfile' is off. |
| 5212 | Also see 'maxmemtot'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5213 | |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 5214 | *'maxmempattern'* *'mmp'* |
| 5215 | 'maxmempattern' 'mmp' number (default 1000) |
| 5216 | global |
| 5217 | {not in Vi} |
| 5218 | Maximum amount of memory (in Kbyte) to use for pattern matching. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 5219 | The maximum value is about 2000000. Use this to work without a limit. |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 5220 | *E363* |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5221 | When Vim runs into the limit it gives an error message and mostly |
| 5222 | behaves like CTRL-C was typed. |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 5223 | Running into the limit often means that the pattern is very |
| 5224 | inefficient or too complex. This may already happen with the pattern |
| 5225 | "\(.\)*" on a very long line. ".*" works much better. |
| 5226 | Vim may run out of memory before hitting the 'maxmempattern' limit. |
| 5227 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5228 | *'maxmemtot'* *'mmt'* |
| 5229 | 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system |
| 5230 | dependent) or half the amount of memory |
| 5231 | available) |
| 5232 | global |
| 5233 | {not in Vi} |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 5234 | Maximum amount of memory in Kbyte to use for all buffers together. |
| 5235 | The maximum usable value is about 2000000 (2 Gbyte). Use this to work |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 5236 | without a limit. |
| 5237 | On 64 bit machines higher values might work. But hey, do you really |
| 5238 | need more than 2 Gbyte for text editing? Keep in mind that text is |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 5239 | stored in the swap file, one can edit files > 2 Gbyte anyway. We do |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 5240 | need the memory to store undo info. |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 5241 | Buffers with 'swapfile' off still count to the total amount of memory |
| 5242 | used. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 5243 | Also see 'maxmem'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5244 | |
| 5245 | *'menuitems'* *'mis'* |
| 5246 | 'menuitems' 'mis' number (default 25) |
| 5247 | global |
| 5248 | {not in Vi} |
| 5249 | {not available when compiled without the |+menu| |
| 5250 | feature} |
| 5251 | Maximum number of items to use in a menu. Used for menus that are |
| 5252 | generated from a list of items, e.g., the Buffers menu. Changing this |
| 5253 | option has no direct effect, the menu must be refreshed first. |
| 5254 | |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 5255 | *'mkspellmem'* *'msm'* |
| 5256 | 'mkspellmem' 'msm' string (default "460000,2000,500") |
| 5257 | global |
| 5258 | {not in Vi} |
| 5259 | {not available when compiled without the |+syntax| |
| 5260 | feature} |
| 5261 | Parameters for |:mkspell|. This tunes when to start compressing the |
| 5262 | word tree. Compression can be slow when there are many words, but |
| 5263 | it's needed to avoid running out of memory. The amount of memory used |
| 5264 | per word depends very much on how similar the words are, that's why |
| 5265 | this tuning is complicated. |
| 5266 | |
| 5267 | There are three numbers, separated by commas: |
| 5268 | {start},{inc},{added} |
| 5269 | |
| 5270 | For most languages the uncompressed word tree fits in memory. {start} |
| 5271 | gives the amount of memory in Kbyte that can be used before any |
| 5272 | compression is done. It should be a bit smaller than the amount of |
| 5273 | memory that is available to Vim. |
| 5274 | |
| 5275 | When going over the {start} limit the {inc} number specifies the |
| 5276 | amount of memory in Kbyte that can be allocated before another |
| 5277 | compression is done. A low number means compression is done after |
| 5278 | less words are added, which is slow. A high number means more memory |
| 5279 | will be allocated. |
| 5280 | |
| 5281 | After doing compression, {added} times 1024 words can be added before |
| 5282 | the {inc} limit is ignored and compression is done when any extra |
| 5283 | amount of memory is needed. A low number means there is a smaller |
| 5284 | chance of hitting the {inc} limit, less memory is used but it's |
| 5285 | slower. |
| 5286 | |
| 5287 | The languages for which these numbers are important are Italian and |
| 5288 | Hungarian. The default works for when you have about 512 Mbyte. If |
| 5289 | you have 1 Gbyte you could use: > |
| 5290 | :set mkspellmem=900000,3000,800 |
| 5291 | < If you have less than 512 Mbyte |:mkspell| may fail for some |
| 5292 | languages, no matter what you set 'mkspellmem' to. |
| 5293 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5294 | *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
Bram Moolenaar | 8243a79 | 2007-05-01 17:05:03 +0000 | [diff] [blame] | 5295 | 'modeline' 'ml' boolean (Vim default: on (off for root), |
| 5296 | Vi default: off) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5297 | local to buffer |
| 5298 | *'modelines'* *'mls'* |
| 5299 | 'modelines' 'mls' number (default 5) |
| 5300 | global |
| 5301 | {not in Vi} |
| 5302 | If 'modeline' is on 'modelines' gives the number of lines that is |
| 5303 | checked for set commands. If 'modeline' is off or 'modelines' is zero |
| 5304 | no lines are checked. See |modeline|. |
| 5305 | NOTE: 'modeline' is set to the Vi default value when 'compatible' is |
| 5306 | set and to the Vim default value when 'compatible' is reset. |
| 5307 | |
| 5308 | *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* |
| 5309 | 'modifiable' 'ma' boolean (default on) |
| 5310 | local to buffer |
| 5311 | {not in Vi} *E21* |
| 5312 | When off the buffer contents cannot be changed. The 'fileformat' and |
| 5313 | 'fileencoding' options also can't be changed. |
Bram Moolenaar | 369b6f5 | 2017-01-17 12:22:32 +0100 | [diff] [blame] | 5314 | Can be reset on startup with the |-M| command line argument. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5315 | |
| 5316 | *'modified'* *'mod'* *'nomodified'* *'nomod'* |
| 5317 | 'modified' 'mod' boolean (default off) |
| 5318 | local to buffer |
| 5319 | {not in Vi} |
| 5320 | When on, the buffer is considered to be modified. This option is set |
| 5321 | when: |
| 5322 | 1. A change was made to the text since it was last written. Using the |
| 5323 | |undo| command to go back to the original text will reset the |
| 5324 | option. But undoing changes that were made before writing the |
| 5325 | buffer will set the option again, since the text is different from |
| 5326 | when it was written. |
| 5327 | 2. 'fileformat' or 'fileencoding' is different from its original |
| 5328 | value. The original value is set when the buffer is read or |
| 5329 | written. A ":set nomodified" command also resets the original |
| 5330 | values to the current values and the 'modified' option will be |
| 5331 | reset. |
Bram Moolenaar | 4f3f668 | 2016-03-26 23:01:59 +0100 | [diff] [blame] | 5332 | Similarly for 'eol' and 'bomb'. |
Bram Moolenaar | 5302d9e | 2011-09-14 17:55:08 +0200 | [diff] [blame] | 5333 | This option is not set when a change is made to the buffer as the |
| 5334 | result of a BufNewFile, BufRead/BufReadPost, BufWritePost, |
| 5335 | FileAppendPost or VimLeave autocommand event. See |gzip-example| for |
| 5336 | an explanation. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5337 | When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 5338 | will be ignored. |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 5339 | Note that the text may actually be the same, e.g. 'modified' is set |
| 5340 | when using "rA" on an "A". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5341 | |
| 5342 | *'more'* *'nomore'* |
| 5343 | 'more' boolean (Vim default: on, Vi default: off) |
| 5344 | global |
| 5345 | {not in Vi} |
| 5346 | When on, listings pause when the whole screen is filled. You will get |
| 5347 | the |more-prompt|. When this option is off there are no pauses, the |
| 5348 | listing continues until finished. |
| 5349 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 5350 | set and to the Vim default value when 'compatible' is reset. |
| 5351 | |
| 5352 | *'mouse'* *E538* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 5353 | 'mouse' string (default "", "a" for GUI, MS-DOS and Win32, |
| 5354 | set to "a" in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5355 | global |
| 5356 | {not in Vi} |
| 5357 | Enable the use of the mouse. Only works for certain terminals |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 5358 | (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with |
| 5359 | sysmouse and Linux console with gpm). For using the mouse in the |
| 5360 | GUI, see |gui-mouse|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5361 | The mouse can be enabled for different modes: |
Bram Moolenaar | 7f2e9d7 | 2017-11-11 20:58:53 +0100 | [diff] [blame] | 5362 | n Normal mode and Terminal modes |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5363 | v Visual mode |
| 5364 | i Insert mode |
| 5365 | c Command-line mode |
| 5366 | h all previous modes when editing a help file |
| 5367 | a all previous modes |
| 5368 | r for |hit-enter| and |more-prompt| prompt |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5369 | Normally you would enable the mouse in all four modes with: > |
| 5370 | :set mouse=a |
| 5371 | < When the mouse is not enabled, the GUI will still use the mouse for |
| 5372 | modeless selection. This doesn't move the text cursor. |
| 5373 | |
| 5374 | See |mouse-using|. Also see |'clipboard'|. |
| 5375 | |
| 5376 | 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] | 5377 | "* 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] | 5378 | the mouse buttons can still be used by keeping the shift key pressed. |
| 5379 | Also see the 'clipboard' option. |
| 5380 | |
| 5381 | *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* |
| 5382 | 'mousefocus' 'mousef' boolean (default off) |
| 5383 | global |
| 5384 | {not in Vi} |
| 5385 | {only works in the GUI} |
| 5386 | The window that the mouse pointer is on is automatically activated. |
| 5387 | When changing the window layout or window focus in another way, the |
| 5388 | mouse pointer is moved to the window with keyboard focus. Off is the |
| 5389 | default because it makes using the pull down menus a little goofy, as |
| 5390 | a pointer transit may activate a window unintentionally. |
| 5391 | |
| 5392 | *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* |
| 5393 | 'mousehide' 'mh' boolean (default on) |
| 5394 | global |
| 5395 | {not in Vi} |
| 5396 | {only works in the GUI} |
| 5397 | When on, the mouse pointer is hidden when characters are typed. |
| 5398 | The mouse pointer is restored when the mouse is moved. |
| 5399 | |
| 5400 | *'mousemodel'* *'mousem'* |
| 5401 | 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) |
| 5402 | global |
| 5403 | {not in Vi} |
| 5404 | Sets the model to use for the mouse. The name mostly specifies what |
| 5405 | the right mouse button is used for: |
| 5406 | extend Right mouse button extends a selection. This works |
| 5407 | like in an xterm. |
| 5408 | popup Right mouse button pops up a menu. The shifted left |
| 5409 | mouse button extends a selection. This works like |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5410 | with Microsoft Windows. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5411 | popup_setpos Like "popup", but the cursor will be moved to the |
| 5412 | position where the mouse was clicked, and thus the |
| 5413 | selected operation will act upon the clicked object. |
| 5414 | If clicking inside a selection, that selection will |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5415 | be acted upon, i.e. no cursor move. This implies of |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5416 | course, that right clicking outside a selection will |
| 5417 | end Visual mode. |
| 5418 | Overview of what button does what for each model: |
| 5419 | mouse extend popup(_setpos) ~ |
| 5420 | left click place cursor place cursor |
| 5421 | left drag start selection start selection |
| 5422 | shift-left search word extend selection |
| 5423 | right click extend selection popup menu (place cursor) |
| 5424 | right drag extend selection - |
| 5425 | middle click paste paste |
| 5426 | |
| 5427 | In the "popup" model the right mouse button produces a pop-up menu. |
| 5428 | You need to define this first, see |popup-menu|. |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 5429 | In a terminal the popup menu works if Vim is compiled with the |
| 5430 | |+insert_expand| option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5431 | |
| 5432 | Note that you can further refine the meaning of buttons with mappings. |
| 5433 | See |gui-mouse-mapping|. But mappings are NOT used for modeless |
| 5434 | selection (because that's handled in the GUI code directly). |
| 5435 | |
| 5436 | The 'mousemodel' option is set by the |:behave| command. |
| 5437 | |
| 5438 | *'mouseshape'* *'mouses'* *E547* |
| 5439 | 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 5440 | m:no,ml:up-arrow,v:rightup-arrow") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5441 | global |
| 5442 | {not in Vi} |
| 5443 | {only available when compiled with the |+mouseshape| |
| 5444 | feature} |
| 5445 | This option tells Vim what the mouse pointer should look like in |
| 5446 | different modes. The option is a comma separated list of parts, much |
| 5447 | like used for 'guicursor'. Each part consist of a mode/location-list |
| 5448 | and an argument-list: |
| 5449 | mode-list:shape,mode-list:shape,.. |
| 5450 | The mode-list is a dash separated list of these modes/locations: |
| 5451 | In a normal window: ~ |
| 5452 | n Normal mode |
| 5453 | v Visual mode |
| 5454 | ve Visual mode with 'selection' "exclusive" (same as 'v', |
| 5455 | if not specified) |
| 5456 | o Operator-pending mode |
| 5457 | i Insert mode |
| 5458 | r Replace mode |
| 5459 | |
| 5460 | Others: ~ |
| 5461 | c appending to the command-line |
| 5462 | ci inserting in the command-line |
| 5463 | cr replacing in the command-line |
| 5464 | m at the 'Hit ENTER' or 'More' prompts |
| 5465 | ml idem, but cursor in the last line |
| 5466 | e any mode, pointer below last window |
| 5467 | s any mode, pointer on a status line |
| 5468 | sd any mode, while dragging a status line |
| 5469 | vs any mode, pointer on a vertical separator line |
| 5470 | vd any mode, while dragging a vertical separator line |
| 5471 | a everywhere |
| 5472 | |
| 5473 | The shape is one of the following: |
| 5474 | avail name looks like ~ |
| 5475 | w x arrow Normal mouse pointer |
| 5476 | w x blank no pointer at all (use with care!) |
| 5477 | w x beam I-beam |
| 5478 | w x updown up-down sizing arrows |
| 5479 | w x leftright left-right sizing arrows |
| 5480 | w x busy The system's usual busy pointer |
| 5481 | w x no The system's usual 'no input' pointer |
| 5482 | x udsizing indicates up-down resizing |
| 5483 | x lrsizing indicates left-right resizing |
| 5484 | x crosshair like a big thin + |
| 5485 | x hand1 black hand |
| 5486 | x hand2 white hand |
| 5487 | x pencil what you write with |
| 5488 | x question big ? |
| 5489 | x rightup-arrow arrow pointing right-up |
| 5490 | w x up-arrow arrow pointing up |
| 5491 | x <number> any X11 pointer number (see X11/cursorfont.h) |
| 5492 | |
| 5493 | The "avail" column contains a 'w' if the shape is available for Win32, |
| 5494 | x for X11. |
| 5495 | Any modes not specified or shapes not available use the normal mouse |
| 5496 | pointer. |
| 5497 | |
| 5498 | Example: > |
| 5499 | :set mouseshape=s:udsizing,m:no |
| 5500 | < will make the mouse turn to a sizing arrow over the status lines and |
| 5501 | indicate no input when the hit-enter prompt is displayed (since |
| 5502 | clicking the mouse has no effect in this state.) |
| 5503 | |
| 5504 | *'mousetime'* *'mouset'* |
| 5505 | 'mousetime' 'mouset' number (default 500) |
| 5506 | global |
| 5507 | {not in Vi} |
| 5508 | Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum |
| 5509 | time in msec between two mouse clicks for the second click to be |
| 5510 | recognized as a multi click. |
| 5511 | |
Bram Moolenaar | 0ab35b2 | 2017-10-08 17:41:37 +0200 | [diff] [blame] | 5512 | *'mzschemedll'* |
| 5513 | 'mzschemedll' string (default depends on the build) |
| 5514 | global |
| 5515 | {not in Vi} |
| 5516 | {only available when compiled with the |+mzscheme/dyn| |
| 5517 | feature} |
| 5518 | Specifies the name of the MzScheme shared library. The default is |
| 5519 | DYNAMIC_MZSCH_DLL which was specified at compile time. |
| 5520 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | b0d45e7 | 2017-11-05 18:19:24 +0100 | [diff] [blame] | 5521 | The value must be set in the |vimrc| script or earlier. In the |
Bram Moolenaar | 01164a6 | 2017-11-02 22:58:42 +0100 | [diff] [blame] | 5522 | startup, before the |load-plugins| step. |
Bram Moolenaar | 0ab35b2 | 2017-10-08 17:41:37 +0200 | [diff] [blame] | 5523 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5524 | security reasons. |
| 5525 | |
| 5526 | *'mzschemegcdll'* |
| 5527 | 'mzschemegcdll' string (default depends on the build) |
| 5528 | global |
| 5529 | {not in Vi} |
| 5530 | {only available when compiled with the |+mzscheme/dyn| |
| 5531 | feature} |
| 5532 | Specifies the name of the MzScheme GC shared library. The default is |
| 5533 | DYNAMIC_MZGC_DLL which was specified at compile time. |
| 5534 | The value can be equal to 'mzschemedll' if it includes the GC code. |
| 5535 | Environment variables are expanded |:set_env|. |
| 5536 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5537 | security reasons. |
| 5538 | |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 5539 | *'mzquantum'* *'mzq'* |
| 5540 | 'mzquantum' 'mzq' number (default 100) |
| 5541 | global |
| 5542 | {not in Vi} |
| 5543 | {not available when compiled without the |+mzscheme| |
| 5544 | feature} |
| 5545 | The number of milliseconds between polls for MzScheme threads. |
| 5546 | Negative or zero value means no thread scheduling. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 5547 | NOTE: This option is set to the Vim default value when 'compatible' |
| 5548 | is reset. |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 5549 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5550 | *'nrformats'* *'nf'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 5551 | 'nrformats' 'nf' string (default "bin,octal,hex", |
| 5552 | set to "bin,hex" in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5553 | local to buffer |
| 5554 | {not in Vi} |
| 5555 | This defines what bases Vim will consider for numbers when using the |
| 5556 | CTRL-A and CTRL-X commands for adding to and subtracting from a number |
| 5557 | respectively; see |CTRL-A| for more info on these commands. |
Bram Moolenaar | 4770d09 | 2006-01-12 23:22:24 +0000 | [diff] [blame] | 5558 | alpha If included, single alphabetical characters will be |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5559 | incremented or decremented. This is useful for a list with a |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 5560 | letter index a), b), etc. *octal-nrformats* |
Bram Moolenaar | 4770d09 | 2006-01-12 23:22:24 +0000 | [diff] [blame] | 5561 | octal If included, numbers that start with a zero will be considered |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5562 | to be octal. Example: Using CTRL-A on "007" results in "010". |
Bram Moolenaar | 4770d09 | 2006-01-12 23:22:24 +0000 | [diff] [blame] | 5563 | hex If included, numbers starting with "0x" or "0X" will be |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5564 | considered to be hexadecimal. Example: Using CTRL-X on |
| 5565 | "0x100" results in "0x0ff". |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 5566 | bin If included, numbers starting with "0b" or "0B" will be |
| 5567 | considered to be binary. Example: Using CTRL-X on |
| 5568 | "0b1000" subtracts one, resulting in "0b0111". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5569 | Numbers which simply begin with a digit in the range 1-9 are always |
| 5570 | considered decimal. This also happens for numbers that are not |
| 5571 | recognized as octal or hex. |
| 5572 | |
| 5573 | *'number'* *'nu'* *'nonumber'* *'nonu'* |
| 5574 | 'number' 'nu' boolean (default off) |
| 5575 | local to window |
| 5576 | Print the line number in front of each line. When the 'n' option is |
| 5577 | excluded from 'cpoptions' a wrapped line will not use the column of |
| 5578 | line numbers (this is the default when 'compatible' isn't set). |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5579 | The 'numberwidth' option can be used to set the room used for the line |
| 5580 | number. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5581 | When a long, wrapped line doesn't start with the first character, '-' |
| 5582 | characters are put before the number. |
Bram Moolenaar | 61d35bd | 2012-03-28 20:51:51 +0200 | [diff] [blame] | 5583 | See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 5584 | the number. |
Bram Moolenaar | 203d04d | 2013-06-06 21:36:40 +0200 | [diff] [blame] | 5585 | *number_relativenumber* |
| 5586 | The 'relativenumber' option changes the displayed number to be |
| 5587 | relative to the cursor. Together with 'number' there are these |
| 5588 | four combinations (cursor in line 3): |
| 5589 | |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 5590 | 'nonu' 'nu' 'nonu' 'nu' |
Bram Moolenaar | 203d04d | 2013-06-06 21:36:40 +0200 | [diff] [blame] | 5591 | 'nornu' 'nornu' 'rnu' 'rnu' |
| 5592 | |
| 5593 | |apple | 1 apple | 2 apple | 2 apple |
| 5594 | |pear | 2 pear | 1 pear | 1 pear |
| 5595 | |nobody | 3 nobody | 0 nobody |3 nobody |
| 5596 | |there | 4 there | 1 there | 1 there |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5597 | |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5598 | *'numberwidth'* *'nuw'* |
| 5599 | 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) |
| 5600 | local to window |
Bram Moolenaar | 325b7a2 | 2004-07-05 15:58:32 +0000 | [diff] [blame] | 5601 | {not in Vi} |
| 5602 | {only available when compiled with the |+linebreak| |
| 5603 | feature} |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5604 | Minimal number of columns to use for the line number. Only relevant |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 5605 | when the 'number' or 'relativenumber' option is set or printing lines |
| 5606 | with a line number. Since one space is always between the number and |
| 5607 | the text, there is one less character for the number itself. |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5608 | The value is the minimum width. A bigger width is used when needed to |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 5609 | fit the highest line number in the buffer respectively the number of |
| 5610 | rows in the window, depending on whether 'number' or 'relativenumber' |
| 5611 | is set. Thus with the Vim default of 4 there is room for a line number |
| 5612 | up to 999. When the buffer has 1000 lines five columns will be used. |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5613 | The minimum value is 1, the maximum value is 10. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 5614 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 5615 | set and to the Vim default value when 'compatible' is reset. |
Bram Moolenaar | 592e0a2 | 2004-07-03 16:05:59 +0000 | [diff] [blame] | 5616 | |
Bram Moolenaar | f75a963 | 2005-09-13 21:20:47 +0000 | [diff] [blame] | 5617 | *'omnifunc'* *'ofu'* |
| 5618 | 'omnifunc' 'ofu' string (default: empty) |
Bram Moolenaar | e344bea | 2005-09-01 20:46:49 +0000 | [diff] [blame] | 5619 | local to buffer |
| 5620 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 5621 | {not available when compiled without the |+eval| |
| 5622 | or |+insert_expand| features} |
Bram Moolenaar | c7486e0 | 2005-12-29 22:48:26 +0000 | [diff] [blame] | 5623 | This option specifies a function to be used for Insert mode omni |
| 5624 | completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 5625 | See |complete-functions| for an explanation of how the function is |
| 5626 | invoked and what it should return. |
Bram Moolenaar | 043545e | 2006-10-10 16:44:07 +0000 | [diff] [blame] | 5627 | This option is usually set by a filetype plugin: |
Bram Moolenaar | 9c10238 | 2006-05-03 21:26:49 +0000 | [diff] [blame] | 5628 | |:filetype-plugin-on| |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 5629 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5630 | security reasons. |
Bram Moolenaar | e344bea | 2005-09-01 20:46:49 +0000 | [diff] [blame] | 5631 | |
| 5632 | |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 5633 | *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
Bram Moolenaar | 043545e | 2006-10-10 16:44:07 +0000 | [diff] [blame] | 5634 | 'opendevice' 'odev' boolean (default off) |
| 5635 | global |
| 5636 | {not in Vi} |
| 5637 | {only for MS-DOS, MS-Windows and OS/2} |
| 5638 | Enable reading and writing from devices. This may get Vim stuck on a |
| 5639 | device that can be opened but doesn't actually do the I/O. Therefore |
| 5640 | it is off by default. |
| 5641 | Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also |
| 5642 | result in editing a device. |
| 5643 | |
| 5644 | |
Bram Moolenaar | 2c7a29c | 2005-12-12 22:02:31 +0000 | [diff] [blame] | 5645 | *'operatorfunc'* *'opfunc'* |
| 5646 | 'operatorfunc' 'opfunc' string (default: empty) |
| 5647 | global |
| 5648 | {not in Vi} |
| 5649 | This option specifies a function to be called by the |g@| operator. |
| 5650 | See |:map-operator| for more info and an example. |
| 5651 | |
| 5652 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5653 | security reasons. |
| 5654 | |
| 5655 | |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 5656 | *'osfiletype'* *'oft'* |
| 5657 | 'osfiletype' 'oft' string (default: "") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5658 | local to buffer |
| 5659 | {not in Vi} |
Bram Moolenaar | 251e191 | 2011-06-19 05:09:16 +0200 | [diff] [blame] | 5660 | This option was supported on RISC OS, which has been removed. |
| 5661 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5662 | |
Bram Moolenaar | f6fee0e | 2016-02-21 23:02:49 +0100 | [diff] [blame] | 5663 | *'packpath'* *'pp'* |
| 5664 | 'packpath' 'pp' string (default: see 'runtimepath') |
| 5665 | {not in Vi} |
Bram Moolenaar | f6fee0e | 2016-02-21 23:02:49 +0100 | [diff] [blame] | 5666 | Directories used to find packages. See |packages|. |
| 5667 | |
| 5668 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5669 | *'paragraphs'* *'para'* |
Bram Moolenaar | 57e4846 | 2008-03-12 16:38:55 +0000 | [diff] [blame] | 5670 | 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5671 | global |
| 5672 | Specifies the nroff macros that separate paragraphs. These are pairs |
| 5673 | of two letters (see |object-motions|). |
| 5674 | |
| 5675 | *'paste'* *'nopaste'* |
| 5676 | 'paste' boolean (default off) |
| 5677 | global |
| 5678 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5679 | Put Vim in Paste mode. This is useful if you want to cut or copy |
| 5680 | 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] | 5681 | unexpected effects. |
| 5682 | 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] | 5683 | cannot distinguish between typed text and pasted text. In the GUI, Vim |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5684 | knows about pasting and will mostly do the right thing without 'paste' |
| 5685 | being set. The same is true for a terminal where Vim handles the |
| 5686 | mouse clicks itself. |
Bram Moolenaar | 2ce06f6 | 2005-01-31 19:19:04 +0000 | [diff] [blame] | 5687 | This option is reset when starting the GUI. Thus if you set it in |
| 5688 | your .vimrc it will work in a terminal, but not in the GUI. Setting |
| 5689 | 'paste' in the GUI has side effects: e.g., the Paste toolbar button |
| 5690 | will no longer work in Insert mode, because it uses a mapping. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5691 | When the 'paste' option is switched on (also when it was already on): |
| 5692 | - mapping in Insert mode and Command-line mode is disabled |
| 5693 | - abbreviations are disabled |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5694 | - 'autoindent' is reset |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 5695 | - 'expandtab' is reset |
| 5696 | - 'formatoptions' is used like it is empty |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5697 | - 'revins' is reset |
| 5698 | - 'ruler' is reset |
| 5699 | - 'showmatch' is reset |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 5700 | - 'smartindent' is reset |
| 5701 | - 'smarttab' is reset |
| 5702 | - 'softtabstop' is set to 0 |
| 5703 | - 'textwidth' is set to 0 |
| 5704 | - 'wrapmargin' is set to 0 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5705 | These options keep their value, but their effect is disabled: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5706 | - 'cindent' |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 5707 | - 'indentexpr' |
| 5708 | - 'lisp' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5709 | NOTE: When you start editing another file while the 'paste' option is |
| 5710 | on, settings from the modelines or autocommands may change the |
| 5711 | settings again, causing trouble when pasting text. You might want to |
| 5712 | set the 'paste' option again. |
| 5713 | When the 'paste' option is reset the mentioned options are restored to |
| 5714 | the value before the moment 'paste' was switched from off to on. |
| 5715 | Resetting 'paste' before ever setting it does not have any effect. |
| 5716 | Since mapping doesn't work while 'paste' is active, you need to use |
| 5717 | the 'pastetoggle' option to toggle the 'paste' option with some key. |
| 5718 | |
| 5719 | *'pastetoggle'* *'pt'* |
| 5720 | 'pastetoggle' 'pt' string (default "") |
| 5721 | global |
| 5722 | {not in Vi} |
| 5723 | When non-empty, specifies the key sequence that toggles the 'paste' |
| 5724 | option. This is like specifying a mapping: > |
| 5725 | :map {keys} :set invpaste<CR> |
| 5726 | < Where {keys} is the value of 'pastetoggle'. |
| 5727 | The difference is that it will work even when 'paste' is set. |
| 5728 | 'pastetoggle' works in Insert mode and Normal mode, but not in |
| 5729 | Command-line mode. |
| 5730 | Mappings are checked first, thus overrule 'pastetoggle'. However, |
| 5731 | when 'paste' is on mappings are ignored in Insert mode, thus you can do |
| 5732 | this: > |
| 5733 | :map <F10> :set paste<CR> |
| 5734 | :map <F11> :set nopaste<CR> |
| 5735 | :imap <F10> <C-O>:set paste<CR> |
| 5736 | :imap <F11> <nop> |
| 5737 | :set pastetoggle=<F11> |
| 5738 | < This will make <F10> start paste mode and <F11> stop paste mode. |
| 5739 | Note that typing <F10> in paste mode inserts "<F10>", since in paste |
| 5740 | mode everything is inserted literally, except the 'pastetoggle' key |
| 5741 | sequence. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 5742 | When the value has several bytes 'ttimeoutlen' applies. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5743 | |
| 5744 | *'pex'* *'patchexpr'* |
| 5745 | 'patchexpr' 'pex' string (default "") |
| 5746 | global |
| 5747 | {not in Vi} |
| 5748 | {not available when compiled without the |+diff| |
| 5749 | feature} |
| 5750 | 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] | 5751 | the resulting new version of the file. See |diff-patchexpr|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5752 | |
Bram Moolenaar | dbc2802 | 2014-07-26 13:40:44 +0200 | [diff] [blame] | 5753 | *'patchmode'* *'pm'* *E205* *E206* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5754 | 'patchmode' 'pm' string (default "") |
| 5755 | global |
| 5756 | {not in Vi} |
| 5757 | When non-empty the oldest version of a file is kept. This can be used |
| 5758 | to keep the original version of a file if you are changing files in a |
| 5759 | source distribution. Only the first time that a file is written a |
| 5760 | copy of the original file will be kept. The name of the copy is the |
| 5761 | name of the original file with the string in the 'patchmode' option |
| 5762 | appended. This option should start with a dot. Use a string like |
Bram Moolenaar | df980db | 2017-12-24 13:22:00 +0100 | [diff] [blame] | 5763 | ".orig" or ".org". 'backupdir' must not be empty for this to work |
| 5764 | (Detail: The backup file is renamed to the patchmode file after the |
| 5765 | new file has been successfully written, that's why it must be possible |
| 5766 | to write a backup file). If there was no file to be backed up, an |
| 5767 | empty file is created. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5768 | When the 'backupskip' pattern matches, a patchmode file is not made. |
| 5769 | Using 'patchmode' for compressed files appends the extension at the |
| 5770 | end (e.g., "file.gz.orig"), thus the resulting name isn't always |
| 5771 | recognized as a compressed file. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 5772 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5773 | |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 5774 | *'path'* *'pa'* *E343* *E345* *E347* *E854* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5775 | 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 5776 | on OS/2: ".,/emx/include,," |
| 5777 | other systems: ".,,") |
| 5778 | global or local to buffer |global-local| |
| 5779 | {not in Vi} |
| 5780 | This is a list of directories which will be searched when using the |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 5781 | |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
| 5782 | provided that the file being searched for has a relative path (not |
| 5783 | starting with "/", "./" or "../"). The directories in the 'path' |
| 5784 | option may be relative or absolute. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5785 | - Use commas to separate directory names: > |
| 5786 | :set path=.,/usr/local/include,/usr/include |
| 5787 | < - Spaces can also be used to separate directory names (for backwards |
| 5788 | compatibility with version 3.0). To have a space in a directory |
| 5789 | name, precede it with an extra backslash, and escape the space: > |
| 5790 | :set path=.,/dir/with\\\ space |
| 5791 | < - To include a comma in a directory name precede it with an extra |
| 5792 | backslash: > |
| 5793 | :set path=.,/dir/with\\,comma |
| 5794 | < - To search relative to the directory of the current file, use: > |
| 5795 | :set path=. |
| 5796 | < - To search in the current directory use an empty string between two |
| 5797 | commas: > |
| 5798 | :set path=,, |
| 5799 | < - A directory name may end in a ':' or '/'. |
| 5800 | - Environment variables are expanded |:set_env|. |
| 5801 | - When using |netrw.vim| URLs can be used. For example, adding |
| 5802 | "http://www.vim.org" will make ":find index.html" work. |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 5803 | - Search upwards and downwards in a directory tree using "*", "**" and |
| 5804 | ";". See |file-searching| for info and syntax. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5805 | {not available when compiled without the |+path_extra| feature} |
| 5806 | - Careful with '\' characters, type two to get one in the option: > |
| 5807 | :set path=.,c:\\include |
| 5808 | < Or just use '/' instead: > |
| 5809 | :set path=.,c:/include |
| 5810 | < Don't forget "." or files won't even be found in the same directory as |
| 5811 | the file! |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5812 | The maximum length is limited. How much depends on the system, mostly |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5813 | it is something like 256 or 1024 characters. |
| 5814 | You can check if all the include files are found, using the value of |
| 5815 | 'path', see |:checkpath|. |
| 5816 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 5817 | directories from the list. This avoids problems when a future version |
| 5818 | uses another default. To remove the current directory use: > |
| 5819 | :set path-= |
| 5820 | < To add the current directory use: > |
| 5821 | :set path+= |
| 5822 | < To use an environment variable, you probably need to replace the |
| 5823 | separator. Here is an example to append $INCL, in which directory |
| 5824 | names are separated with a semi-colon: > |
| 5825 | :let &path = &path . "," . substitute($INCL, ';', ',', 'g') |
| 5826 | < Replace the ';' with a ':' or whatever separator is used. Note that |
| 5827 | this doesn't work when $INCL contains a comma or white space. |
| 5828 | |
Bram Moolenaar | 37c64c7 | 2017-09-19 22:06:03 +0200 | [diff] [blame] | 5829 | *'perldll'* |
| 5830 | 'perldll' string (default depends on the build) |
| 5831 | global |
| 5832 | {not in Vi} |
| 5833 | {only available when compiled with the |+perl/dyn| |
| 5834 | feature} |
| 5835 | Specifies the name of the Perl shared library. The default is |
| 5836 | DYNAMIC_PERL_DLL, which was specified at compile time. |
| 5837 | Environment variables are expanded |:set_env|. |
| 5838 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5839 | security reasons. |
| 5840 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5841 | *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 5842 | 'preserveindent' 'pi' boolean (default off) |
| 5843 | local to buffer |
| 5844 | {not in Vi} |
| 5845 | When changing the indent of the current line, preserve as much of the |
| 5846 | indent structure as possible. Normally the indent is replaced by a |
| 5847 | series of tabs followed by spaces as required (unless |'expandtab'| is |
| 5848 | enabled, in which case only spaces are used). Enabling this option |
| 5849 | means the indent will preserve as many existing characters as possible |
| 5850 | for indenting, and only add additional tabs or spaces as required. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 5851 | 'expandtab' does not apply to the preserved white space, a Tab remains |
| 5852 | a Tab. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5853 | NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 5854 | tabs and spaces. You might not like this. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 5855 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5856 | Also see 'copyindent'. |
| 5857 | Use |:retab| to clean up white space. |
| 5858 | |
| 5859 | *'previewheight'* *'pvh'* |
| 5860 | 'previewheight' 'pvh' number (default 12) |
| 5861 | global |
| 5862 | {not in Vi} |
| 5863 | {not available when compiled without the |+windows| or |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 5864 | |+quickfix| features} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5865 | Default height for a preview window. Used for |:ptag| and associated |
| 5866 | commands. Used for |CTRL-W_}| when no count is given. |
| 5867 | |
| 5868 | *'previewwindow'* *'nopreviewwindow'* |
| 5869 | *'pvw'* *'nopvw'* *E590* |
| 5870 | 'previewwindow' 'pvw' boolean (default off) |
| 5871 | local to window |
| 5872 | {not in Vi} |
| 5873 | {not available when compiled without the |+windows| or |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 5874 | |+quickfix| features} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 5875 | Identifies the preview window. Only one window can have this option |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5876 | set. It's normally not set directly, but by using one of the commands |
| 5877 | |:ptag|, |:pedit|, etc. |
| 5878 | |
| 5879 | *'printdevice'* *'pdev'* |
| 5880 | 'printdevice' 'pdev' string (default empty) |
| 5881 | global |
| 5882 | {not in Vi} |
| 5883 | {only available when compiled with the |+printer| |
| 5884 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5885 | The name of the printer to be used for |:hardcopy|. |
| 5886 | See |pdev-option|. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 5887 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5888 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5889 | |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5890 | *'printencoding'* *'penc'* |
| 5891 | 'printencoding' 'penc' String (default empty, except for some systems) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5892 | global |
| 5893 | {not in Vi} |
| 5894 | {only available when compiled with the |+printer| |
| 5895 | and |+postscript| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5896 | Sets the character encoding used when printing. |
| 5897 | See |penc-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5898 | |
| 5899 | *'printexpr'* *'pexpr'* |
| 5900 | 'printexpr' 'pexpr' String (default: see below) |
| 5901 | global |
| 5902 | {not in Vi} |
| 5903 | {only available when compiled with the |+printer| |
| 5904 | and |+postscript| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5905 | Expression used to print the PostScript produced with |:hardcopy|. |
| 5906 | See |pexpr-option|. |
Bram Moolenaar | 5162822 | 2016-12-01 23:03:28 +0100 | [diff] [blame] | 5907 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5908 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5909 | |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5910 | *'printfont'* *'pfn'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5911 | 'printfont' 'pfn' string (default "courier") |
| 5912 | global |
| 5913 | {not in Vi} |
| 5914 | {only available when compiled with the |+printer| |
| 5915 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5916 | The name of the font that will be used for |:hardcopy|. |
| 5917 | See |pfn-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5918 | |
| 5919 | *'printheader'* *'pheader'* |
| 5920 | 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") |
| 5921 | global |
| 5922 | {not in Vi} |
| 5923 | {only available when compiled with the |+printer| |
| 5924 | feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5925 | The format of the header produced in |:hardcopy| output. |
| 5926 | See |pheader-option|. |
| 5927 | |
| 5928 | *'printmbcharset'* *'pmbcs'* |
| 5929 | 'printmbcharset' 'pmbcs' string (default "") |
| 5930 | global |
| 5931 | {not in Vi} |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 5932 | {only available when compiled with the |+printer|, |
| 5933 | |+postscript| and |+multi_byte| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5934 | The CJK character set to be used for CJK output from |:hardcopy|. |
| 5935 | See |pmbcs-option|. |
| 5936 | |
| 5937 | *'printmbfont'* *'pmbfn'* |
| 5938 | 'printmbfont' 'pmbfn' string (default "") |
| 5939 | global |
| 5940 | {not in Vi} |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 5941 | {only available when compiled with the |+printer|, |
| 5942 | |+postscript| and |+multi_byte| features} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5943 | List of font names to be used for CJK output from |:hardcopy|. |
| 5944 | See |pmbfn-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5945 | |
| 5946 | *'printoptions'* *'popt'* |
| 5947 | 'printoptions' 'popt' string (default "") |
| 5948 | global |
| 5949 | {not in Vi} |
| 5950 | {only available when compiled with |+printer| feature} |
Bram Moolenaar | 8299df9 | 2004-07-10 09:47:34 +0000 | [diff] [blame] | 5951 | List of items that control the format of the output of |:hardcopy|. |
| 5952 | See |popt-option|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 5953 | |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 5954 | *'prompt'* *'noprompt'* |
| 5955 | 'prompt' boolean (default on) |
| 5956 | global |
| 5957 | When on a ":" prompt is used in Ex mode. |
| 5958 | |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 5959 | *'pumheight'* *'ph'* |
| 5960 | 'pumheight' 'ph' number (default 0) |
| 5961 | global |
| 5962 | {not available when compiled without the |
| 5963 | |+insert_expand| feature} |
| 5964 | {not in Vi} |
Bram Moolenaar | 06a89a5 | 2006-04-29 22:01:03 +0000 | [diff] [blame] | 5965 | Determines the maximum number of items to show in the popup menu for |
| 5966 | Insert mode completion. When zero as much space as available is used. |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 5967 | |ins-completion-menu|. |
| 5968 | |
Bram Moolenaar | a8f04aa | 2018-02-10 15:36:55 +0100 | [diff] [blame] | 5969 | *'pumwidth'* *'pw'* |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 5970 | 'pumwidth' 'pw' number (default 15) |
Bram Moolenaar | a8f04aa | 2018-02-10 15:36:55 +0100 | [diff] [blame] | 5971 | global |
| 5972 | {not available when compiled without the |
| 5973 | |+insert_expand| feature} |
| 5974 | {not in Vi} |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 5975 | Determines the minimum width to use for the popup menu for Insert mode |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 5976 | completion. |ins-completion-menu|. |
Bram Moolenaar | a8f04aa | 2018-02-10 15:36:55 +0100 | [diff] [blame] | 5977 | |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5978 | *'pythondll'* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 5979 | 'pythondll' string (default depends on the build) |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5980 | global |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 5981 | {not in Vi} |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5982 | {only available when compiled with the |+python/dyn| |
| 5983 | feature} |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 5984 | Specifies the name of the Python 2.x shared library. The default is |
| 5985 | DYNAMIC_PYTHON_DLL, which was specified at compile time. |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 5986 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 5987 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5988 | security reasons. |
Bram Moolenaar | 7d47b6e | 2006-03-15 22:59:18 +0000 | [diff] [blame] | 5989 | |
Bram Moolenaar | 9407316 | 2018-01-31 21:49:05 +0100 | [diff] [blame] | 5990 | *'pythonhome'* |
| 5991 | 'pythonhome' string (default "") |
| 5992 | global |
| 5993 | {not in Vi} |
| 5994 | {only available when compiled with the |+python/dyn| |
| 5995 | feature} |
| 5996 | Specifies the name of the Python 2.x home directory. When 'pythonhome' |
| 5997 | and the PYTHONHOME environment variable are not set, PYTHON_HOME, |
| 5998 | which was specified at compile time, will be used for the Python 2.x |
| 5999 | home directory. |
| 6000 | Environment variables are expanded |:set_env|. |
| 6001 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6002 | security reasons. |
| 6003 | |
Bram Moolenaar | b4ff518 | 2015-11-10 21:15:48 +0100 | [diff] [blame] | 6004 | *'pythonthreedll'* |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 6005 | 'pythonthreedll' string (default depends on the build) |
Bram Moolenaar | b4ff518 | 2015-11-10 21:15:48 +0100 | [diff] [blame] | 6006 | global |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 6007 | {not in Vi} |
Bram Moolenaar | b4ff518 | 2015-11-10 21:15:48 +0100 | [diff] [blame] | 6008 | {only available when compiled with the |+python3/dyn| |
| 6009 | feature} |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 6010 | Specifies the name of the Python 3 shared library. The default is |
| 6011 | DYNAMIC_PYTHON3_DLL, which was specified at compile time. |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 6012 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | b4ff518 | 2015-11-10 21:15:48 +0100 | [diff] [blame] | 6013 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6014 | security reasons. |
| 6015 | |
Bram Moolenaar | 9407316 | 2018-01-31 21:49:05 +0100 | [diff] [blame] | 6016 | *'pythonthreehome'* |
| 6017 | 'pythonthreehome' string (default "") |
| 6018 | global |
| 6019 | {not in Vi} |
| 6020 | {only available when compiled with the |+python3/dyn| |
| 6021 | feature} |
| 6022 | Specifies the name of the Python 3 home directory. When |
| 6023 | 'pythonthreehome' and the PYTHONHOME environment variable are not set, |
| 6024 | PYTHON3_HOME, which was specified at compile time, will be used for |
| 6025 | the Python 3 home directory. |
| 6026 | Environment variables are expanded |:set_env|. |
| 6027 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6028 | security reasons. |
| 6029 | |
Bram Moolenaar | f42dd3c | 2017-01-28 16:06:38 +0100 | [diff] [blame] | 6030 | *'pyxversion'* *'pyx'* |
| 6031 | 'pyxversion' 'pyx' number (default depends on the build) |
| 6032 | global |
| 6033 | {not in Vi} |
| 6034 | {only available when compiled with the |+python| or |
| 6035 | the |+python3| feature} |
| 6036 | Specifies the python version used for pyx* functions and commands |
| 6037 | |python_x|. The default value is as follows: |
| 6038 | |
| 6039 | Compiled with Default ~ |
| 6040 | |+python| and |+python3| 0 |
| 6041 | only |+python| 2 |
| 6042 | only |+python3| 3 |
| 6043 | |
| 6044 | Available values are 0, 2 and 3. |
| 6045 | If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of |
| 6046 | any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3` |
| 6047 | sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets |
| 6048 | to 2 if Python 2 is available. |
| 6049 | See also: |has-pythonx| |
| 6050 | |
| 6051 | If Vim is compiled with only |+python| or |+python3| setting |
| 6052 | 'pyxversion' has no effect. The pyx* functions and commands are |
| 6053 | always the same as the compiled version. |
| 6054 | |
| 6055 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6056 | security reasons. |
| 6057 | |
Bram Moolenaar | 677ee68 | 2005-01-27 14:41:15 +0000 | [diff] [blame] | 6058 | *'quoteescape'* *'qe'* |
Bram Moolenaar | cfbc5ee | 2004-07-02 15:38:35 +0000 | [diff] [blame] | 6059 | 'quoteescape' 'qe' string (default "\") |
| 6060 | local to buffer |
| 6061 | {not in Vi} |
| 6062 | The characters that are used to escape quotes in a string. Used for |
| 6063 | objects like a', a" and a` |a'|. |
| 6064 | When one of the characters in this option is found inside a string, |
| 6065 | the following character will be skipped. The default value makes the |
| 6066 | text "foo\"bar\\" considered to be one string. |
| 6067 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6068 | *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 6069 | 'readonly' 'ro' boolean (default off) |
| 6070 | local to buffer |
| 6071 | If on, writes fail unless you use a '!'. Protects you from |
| 6072 | accidentally overwriting a file. Default on when Vim is started |
| 6073 | 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] | 6074 | When using ":w!" the 'readonly' option is reset for the current |
| 6075 | buffer, unless the 'Z' flag is in 'cpoptions'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6076 | {not in Vi:} When using the ":view" command the 'readonly' option is |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 6077 | set for the newly edited buffer. |
Bram Moolenaar | 369b6f5 | 2017-01-17 12:22:32 +0100 | [diff] [blame] | 6078 | See 'modifiable' for disallowing changes to the buffer. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6079 | |
Bram Moolenaar | 91a4e82 | 2008-01-19 14:59:58 +0000 | [diff] [blame] | 6080 | *'redrawtime'* *'rdt'* |
| 6081 | 'redrawtime' 'rdt' number (default 2000) |
| 6082 | global |
| 6083 | {not in Vi} |
| 6084 | {only available when compiled with the |+reltime| |
| 6085 | feature} |
| 6086 | The time in milliseconds for redrawing the display. This applies to |
Bram Moolenaar | 06f1ed2 | 2017-06-18 22:41:03 +0200 | [diff] [blame] | 6087 | searching for patterns for 'hlsearch', |:match| highlighting an syntax |
| 6088 | highlighting. |
Bram Moolenaar | 91a4e82 | 2008-01-19 14:59:58 +0000 | [diff] [blame] | 6089 | When redrawing takes more than this many milliseconds no further |
Bram Moolenaar | 06f1ed2 | 2017-06-18 22:41:03 +0200 | [diff] [blame] | 6090 | matches will be highlighted. |
| 6091 | For syntax highlighting the time applies per window. When over the |
| 6092 | limit syntax highlighting is disabled until |CTRL-L| is used. |
| 6093 | This is used to avoid that Vim hangs when using a very complicated |
| 6094 | pattern. |
Bram Moolenaar | 91a4e82 | 2008-01-19 14:59:58 +0000 | [diff] [blame] | 6095 | |
Bram Moolenaar | 543b7ef | 2013-06-01 14:50:56 +0200 | [diff] [blame] | 6096 | *'regexpengine'* *'re'* |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 6097 | 'regexpengine' 're' number (default 0) |
| 6098 | global |
| 6099 | {not in Vi} |
| 6100 | This selects the default regexp engine. |two-engines| |
| 6101 | The possible values are: |
| 6102 | 0 automatic selection |
| 6103 | 1 old engine |
| 6104 | 2 NFA engine |
| 6105 | Note that when using the NFA engine and the pattern contains something |
| 6106 | that is not supported the pattern will not match. This is only useful |
| 6107 | for debugging the regexp engine. |
Bram Moolenaar | fda3729 | 2014-11-05 14:27:36 +0100 | [diff] [blame] | 6108 | Using automatic selection enables Vim to switch the engine, if the |
| 6109 | default engine becomes too costly. E.g., when the NFA engine uses too |
| 6110 | many states. This should prevent Vim from hanging on a combination of |
| 6111 | a complex pattern with long text. |
Bram Moolenaar | e6ae622 | 2013-05-21 21:01:10 +0200 | [diff] [blame] | 6112 | |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 6113 | *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
| 6114 | 'relativenumber' 'rnu' boolean (default off) |
| 6115 | local to window |
| 6116 | {not in Vi} |
| 6117 | Show the line number relative to the line with the cursor in front of |
Bram Moolenaar | 06b5d51 | 2010-05-22 15:37:44 +0200 | [diff] [blame] | 6118 | each line. Relative line numbers help you use the |count| you can |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 6119 | precede some vertical motion commands (e.g. j k + -) with, without |
| 6120 | having to calculate it yourself. Especially useful in combination with |
| 6121 | other commands (e.g. y d c < > gq gw =). |
| 6122 | When the 'n' option is excluded from 'cpoptions' a wrapped |
| 6123 | line will not use the column of line numbers (this is the default when |
| 6124 | 'compatible' isn't set). |
| 6125 | The 'numberwidth' option can be used to set the room used for the line |
| 6126 | number. |
| 6127 | When a long, wrapped line doesn't start with the first character, '-' |
| 6128 | characters are put before the number. |
Bram Moolenaar | 61d35bd | 2012-03-28 20:51:51 +0200 | [diff] [blame] | 6129 | See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 6130 | the number. |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 6131 | |
Bram Moolenaar | 203d04d | 2013-06-06 21:36:40 +0200 | [diff] [blame] | 6132 | The number in front of the cursor line also depends on the value of |
| 6133 | 'number', see |number_relativenumber| for all combinations of the two |
| 6134 | options. |
Bram Moolenaar | 6448667 | 2010-05-16 15:46:46 +0200 | [diff] [blame] | 6135 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6136 | *'remap'* *'noremap'* |
| 6137 | 'remap' boolean (default on) |
| 6138 | global |
| 6139 | Allows for mappings to work recursively. If you do not want this for |
| 6140 | a single entry, use the :noremap[!] command. |
Bram Moolenaar | a3227e2 | 2006-03-08 21:32:40 +0000 | [diff] [blame] | 6141 | NOTE: To avoid portability problems with Vim scripts, always keep |
| 6142 | this option at the default "on". Only switch it off when working with |
| 6143 | old Vi scripts. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6144 | |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6145 | *'renderoptions'* *'rop'* |
| 6146 | 'renderoptions' 'rop' string (default: empty) |
| 6147 | global |
| 6148 | {not in Vi} |
| 6149 | {only available when compiled with GUI and DIRECTX on |
| 6150 | MS-Windows} |
| 6151 | Select a text renderer and set its options. The options depend on the |
| 6152 | renderer. |
| 6153 | |
| 6154 | Syntax: > |
| 6155 | set rop=type:{renderer}(,{name}:{value})* |
| 6156 | < |
| 6157 | Currently, only one optional renderer is available. |
| 6158 | |
| 6159 | render behavior ~ |
| 6160 | directx Vim will draw text using DirectX (DirectWrite). It makes |
| 6161 | drawn glyphs more beautiful than default GDI. |
| 6162 | It requires 'encoding' is "utf-8", and only works on |
| 6163 | MS-Windows Vista or newer version. |
| 6164 | |
| 6165 | Options: |
| 6166 | name meaning type value ~ |
| 6167 | gamma gamma float 1.0 - 2.2 (maybe) |
| 6168 | contrast enhancedContrast float (unknown) |
| 6169 | level clearTypeLevel float (unknown) |
| 6170 | geom pixelGeometry int 0 - 2 (see below) |
| 6171 | renmode renderingMode int 0 - 6 (see below) |
| 6172 | taamode textAntialiasMode int 0 - 3 (see below) |
Bram Moolenaar | a338adc | 2018-01-31 20:51:47 +0100 | [diff] [blame] | 6173 | scrlines Scroll Lines int (deprecated) |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6174 | |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6175 | See this URL for detail (except for scrlines): |
| 6176 | https://msdn.microsoft.com/en-us/library/dd368190.aspx |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6177 | |
| 6178 | For geom: structure of a device pixel. |
| 6179 | 0 - DWRITE_PIXEL_GEOMETRY_FLAT |
| 6180 | 1 - DWRITE_PIXEL_GEOMETRY_RGB |
| 6181 | 2 - DWRITE_PIXEL_GEOMETRY_BGR |
| 6182 | |
| 6183 | See this URL for detail: |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6184 | https://msdn.microsoft.com/en-us/library/dd368114.aspx |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6185 | |
| 6186 | For renmode: method of rendering glyphs. |
| 6187 | 0 - DWRITE_RENDERING_MODE_DEFAULT |
| 6188 | 1 - DWRITE_RENDERING_MODE_ALIASED |
| 6189 | 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC |
| 6190 | 3 - DWRITE_RENDERING_MODE_GDI_NATURAL |
| 6191 | 4 - DWRITE_RENDERING_MODE_NATURAL |
| 6192 | 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC |
| 6193 | 6 - DWRITE_RENDERING_MODE_OUTLINE |
| 6194 | |
| 6195 | See this URL for detail: |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6196 | https://msdn.microsoft.com/en-us/library/dd368118.aspx |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6197 | |
| 6198 | For taamode: antialiasing mode used for drawing text. |
| 6199 | 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT |
| 6200 | 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE |
| 6201 | 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE |
| 6202 | 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED |
| 6203 | |
| 6204 | See this URL for detail: |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6205 | https://msdn.microsoft.com/en-us/library/dd368170.aspx |
| 6206 | |
Bram Moolenaar | a338adc | 2018-01-31 20:51:47 +0100 | [diff] [blame] | 6207 | For scrlines: |
| 6208 | This was used for optimizing scrolling behavior, however this |
| 6209 | is now deprecated. If specified, it is simply ignored. |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6210 | |
| 6211 | Example: > |
| 6212 | set encoding=utf-8 |
Bram Moolenaar | d7ccc4d | 2017-11-26 14:29:32 +0100 | [diff] [blame] | 6213 | set gfn=Ricty_Diminished:h12 |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6214 | set rop=type:directx |
| 6215 | < |
Bram Moolenaar | d7ccc4d | 2017-11-26 14:29:32 +0100 | [diff] [blame] | 6216 | If select a raster font (Courier, Terminal or FixedSys which |
| 6217 | have ".fon" extension in file name) to 'guifont', it will be |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6218 | drawn by GDI as a fallback. |
Bram Moolenaar | d7ccc4d | 2017-11-26 14:29:32 +0100 | [diff] [blame] | 6219 | |
| 6220 | NOTE: It is known that some fonts and options combination |
| 6221 | causes trouble on drawing glyphs. |
| 6222 | |
Bram Moolenaar | 92467d3 | 2017-12-05 13:22:16 +0100 | [diff] [blame] | 6223 | - 'renmode:5' and 'renmode:6' will not work with some |
Bram Moolenaar | d7ccc4d | 2017-11-26 14:29:32 +0100 | [diff] [blame] | 6224 | special made fonts (True-Type fonts which includes only |
| 6225 | bitmap glyphs). |
| 6226 | - 'taamode:3' will not work with some vector fonts. |
| 6227 | |
| 6228 | NOTE: With this option, you can display colored emoji |
| 6229 | (emoticon) in Windows 8.1 or later. To display colored emoji, |
| 6230 | there are some conditions which you should notice. |
| 6231 | |
| 6232 | - If your font includes non-colored emoji already, it will |
| 6233 | be used. |
| 6234 | - If your font doesn't have emoji, the system chooses an |
| 6235 | alternative symbol font. On Windows 10, "Segoe UI Emoji" |
| 6236 | will be used. |
| 6237 | - When this alternative font didn't have fixed width glyph, |
| 6238 | emoji might be rendered beyond the bounding box of drawing |
| 6239 | cell. |
Bram Moolenaar | b5a7a8b | 2014-08-06 14:52:30 +0200 | [diff] [blame] | 6240 | |
| 6241 | Other render types are currently not supported. |
| 6242 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6243 | *'report'* |
| 6244 | 'report' number (default 2) |
| 6245 | global |
| 6246 | Threshold for reporting number of lines changed. When the number of |
| 6247 | changed lines is more than 'report' a message will be given for most |
| 6248 | ":" commands. If you want it always, set 'report' to 0. |
| 6249 | For the ":substitute" command the number of substitutions is used |
| 6250 | instead of the number of lines. |
| 6251 | |
| 6252 | *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* |
| 6253 | 'restorescreen' 'rs' boolean (default on) |
| 6254 | global |
| 6255 | {not in Vi} {only in Windows 95/NT console version} |
| 6256 | When set, the screen contents is restored when exiting Vim. This also |
| 6257 | happens when executing external commands. |
| 6258 | |
| 6259 | For non-Windows Vim: You can set or reset the 't_ti' and 't_te' |
| 6260 | options in your .vimrc. To disable restoring: |
| 6261 | set t_ti= t_te= |
| 6262 | To enable restoring (for an xterm): |
| 6263 | set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 |
| 6264 | (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) |
| 6265 | |
| 6266 | *'revins'* *'ri'* *'norevins'* *'nori'* |
| 6267 | 'revins' 'ri' boolean (default off) |
| 6268 | global |
| 6269 | {not in Vi} |
| 6270 | {only available when compiled with the |+rightleft| |
| 6271 | feature} |
| 6272 | Inserting characters in Insert mode will work backwards. See "typing |
| 6273 | backwards" |ins-reverse|. This option can be toggled with the CTRL-_ |
| 6274 | command in Insert mode, when 'allowrevins' is set. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 6275 | NOTE: This option is reset when 'compatible' is set. |
| 6276 | This option is reset when 'paste' is set and restored when 'paste' is |
| 6277 | reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6278 | |
| 6279 | *'rightleft'* *'rl'* *'norightleft'* *'norl'* |
| 6280 | 'rightleft' 'rl' boolean (default off) |
| 6281 | local to window |
| 6282 | {not in Vi} |
| 6283 | {only available when compiled with the |+rightleft| |
| 6284 | feature} |
| 6285 | When on, display orientation becomes right-to-left, i.e., characters |
| 6286 | that are stored in the file appear from the right to the left. |
| 6287 | Using this option, it is possible to edit files for languages that |
| 6288 | are written from the right to the left such as Hebrew and Arabic. |
| 6289 | This option is per window, so it is possible to edit mixed files |
| 6290 | simultaneously, or to view the same file in both ways (this is |
| 6291 | useful whenever you have a mixed text file with both right-to-left |
| 6292 | and left-to-right strings so that both sets are displayed properly |
| 6293 | in different windows). Also see |rileft.txt|. |
| 6294 | |
Bram Moolenaar | 607cc1e | 2010-07-18 18:47:44 +0200 | [diff] [blame] | 6295 | *'rightleftcmd'* *'rlc'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6296 | 'rightleftcmd' 'rlc' string (default "search") |
| 6297 | local to window |
| 6298 | {not in Vi} |
| 6299 | {only available when compiled with the |+rightleft| |
| 6300 | feature} |
| 6301 | Each word in this option enables the command line editing to work in |
| 6302 | right-to-left mode for a group of commands: |
| 6303 | |
| 6304 | search "/" and "?" commands |
| 6305 | |
| 6306 | This is useful for languages such as Hebrew, Arabic and Farsi. |
| 6307 | The 'rightleft' option must be set for 'rightleftcmd' to take effect. |
| 6308 | |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 6309 | *'rubydll'* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 6310 | 'rubydll' string (default: depends on the build) |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 6311 | global |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 6312 | {not in Vi} |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 6313 | {only available when compiled with the |+ruby/dyn| |
| 6314 | feature} |
Bram Moolenaar | 25e4fcd | 2016-01-09 14:57:47 +0100 | [diff] [blame] | 6315 | Specifies the name of the Ruby shared library. The default is |
| 6316 | DYNAMIC_RUBY_DLL, which was specified at compile time. |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 6317 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | d94464e | 2015-11-02 15:28:18 +0100 | [diff] [blame] | 6318 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6319 | security reasons. |
| 6320 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6321 | *'ruler'* *'ru'* *'noruler'* *'noru'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 6322 | 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6323 | global |
| 6324 | {not in Vi} |
| 6325 | {not available when compiled without the |
| 6326 | |+cmdline_info| feature} |
| 6327 | 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] | 6328 | comma. When there is room, the relative position of the displayed |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6329 | text in the file is shown on the far right: |
| 6330 | Top first line is visible |
| 6331 | Bot last line is visible |
| 6332 | All first and last line are visible |
| 6333 | 45% relative position in the file |
| 6334 | If 'rulerformat' is set, it will determine the contents of the ruler. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6335 | 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] | 6336 | 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] | 6337 | screen. If the statusline is given by 'statusline' (i.e. not empty), |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6338 | this option takes precedence over 'ruler' and 'rulerformat' |
| 6339 | If the number of characters displayed is different from the number of |
| 6340 | bytes in the text (e.g., for a TAB or a multi-byte character), both |
| 6341 | the text column (byte number) and the screen column are shown, |
| 6342 | separated with a dash. |
| 6343 | For an empty line "0-1" is shown. |
| 6344 | For an empty buffer the line number will also be zero: "0,0-1". |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 6345 | This option is reset when 'paste' is set and restored when 'paste' is |
| 6346 | reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6347 | If you don't want to see the ruler all the time but want to know where |
| 6348 | you are, use "g CTRL-G" |g_CTRL-G|. |
| 6349 | NOTE: This option is reset when 'compatible' is set. |
| 6350 | |
| 6351 | *'rulerformat'* *'ruf'* |
| 6352 | 'rulerformat' 'ruf' string (default empty) |
| 6353 | global |
| 6354 | {not in Vi} |
| 6355 | {not available when compiled without the |+statusline| |
| 6356 | feature} |
| 6357 | When this option is not empty, it determines the content of the ruler |
| 6358 | string, as displayed for the 'ruler' option. |
Bram Moolenaar | a23ccb8 | 2006-02-27 00:08:02 +0000 | [diff] [blame] | 6359 | The format of this option is like that of 'statusline'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6360 | The default ruler width is 17 characters. To make the ruler 15 |
| 6361 | characters wide, put "%15(" at the start and "%)" at the end. |
| 6362 | Example: > |
| 6363 | :set rulerformat=%15(%c%V\ %p%%%) |
| 6364 | < |
| 6365 | *'runtimepath'* *'rtp'* *vimfiles* |
| 6366 | 'runtimepath' 'rtp' string (default: |
| 6367 | Unix: "$HOME/.vim, |
| 6368 | $VIM/vimfiles, |
| 6369 | $VIMRUNTIME, |
| 6370 | $VIM/vimfiles/after, |
| 6371 | $HOME/.vim/after" |
| 6372 | Amiga: "home:vimfiles, |
| 6373 | $VIM/vimfiles, |
| 6374 | $VIMRUNTIME, |
| 6375 | $VIM/vimfiles/after, |
| 6376 | home:vimfiles/after" |
| 6377 | PC, OS/2: "$HOME/vimfiles, |
| 6378 | $VIM/vimfiles, |
| 6379 | $VIMRUNTIME, |
| 6380 | $VIM/vimfiles/after, |
| 6381 | $HOME/vimfiles/after" |
| 6382 | Macintosh: "$VIM:vimfiles, |
| 6383 | $VIMRUNTIME, |
| 6384 | $VIM:vimfiles:after" |
| 6385 | RISC-OS: "Choices:vimfiles, |
| 6386 | $VIMRUNTIME, |
| 6387 | Choices:vimfiles/after" |
| 6388 | VMS: "sys$login:vimfiles, |
| 6389 | $VIM/vimfiles, |
| 6390 | $VIMRUNTIME, |
| 6391 | $VIM/vimfiles/after, |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 6392 | sys$login:vimfiles/after") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6393 | global |
| 6394 | {not in Vi} |
| 6395 | This is a list of directories which will be searched for runtime |
| 6396 | files: |
| 6397 | filetype.vim filetypes by file name |new-filetype| |
| 6398 | scripts.vim filetypes by file contents |new-filetype-scripts| |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 6399 | autoload/ automatically loaded scripts |autoload-functions| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6400 | colors/ color scheme files |:colorscheme| |
| 6401 | compiler/ compiler files |:compiler| |
| 6402 | doc/ documentation |write-local-help| |
| 6403 | ftplugin/ filetype plugins |write-filetype-plugin| |
| 6404 | indent/ indent scripts |indent-expression| |
| 6405 | keymap/ key mapping files |mbyte-keymap| |
| 6406 | lang/ menu translations |:menutrans| |
| 6407 | menu.vim GUI menus |menu.vim| |
Bram Moolenaar | 2685212 | 2016-05-24 20:02:38 +0200 | [diff] [blame] | 6408 | pack/ packages |:packadd| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6409 | plugin/ plugin scripts |write-plugin| |
| 6410 | print/ files for printing |postscript-print-encoding| |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 6411 | spell/ spell checking files |spell| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6412 | syntax/ syntax files |mysyntaxfile| |
| 6413 | tutor/ files for vimtutor |tutor| |
| 6414 | |
| 6415 | And any other file searched for with the |:runtime| command. |
| 6416 | |
| 6417 | The defaults for most systems are setup to search five locations: |
| 6418 | 1. In your home directory, for your personal preferences. |
| 6419 | 2. In a system-wide Vim directory, for preferences from the system |
| 6420 | administrator. |
| 6421 | 3. In $VIMRUNTIME, for files distributed with Vim. |
| 6422 | *after-directory* |
| 6423 | 4. In the "after" directory in the system-wide Vim directory. This is |
| 6424 | for the system administrator to overrule or add to the distributed |
| 6425 | defaults (rarely needed) |
| 6426 | 5. In the "after" directory in your home directory. This is for |
| 6427 | personal preferences to overrule or add to the distributed defaults |
| 6428 | or system-wide settings (rarely needed). |
| 6429 | |
Bram Moolenaar | d079690 | 2016-09-16 20:02:31 +0200 | [diff] [blame] | 6430 | More entries are added when using |packages|. If it gets very long |
| 6431 | then `:set rtp` will be truncated, use `:echo &rtp` to see the full |
| 6432 | string. |
Bram Moolenaar | 2685212 | 2016-05-24 20:02:38 +0200 | [diff] [blame] | 6433 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6434 | Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 6435 | wildcards are allowed, but can significantly slow down searching for |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6436 | runtime files. For speed, use as few items as possible and avoid |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6437 | wildcards. |
| 6438 | See |:runtime|. |
| 6439 | Example: > |
| 6440 | :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME |
| 6441 | < This will use the directory "~/vimruntime" first (containing your |
| 6442 | personal Vim runtime files), then "/mygroup/vim" (shared between a |
| 6443 | group of people) and finally "$VIMRUNTIME" (the distributed runtime |
| 6444 | files). |
| 6445 | You probably should always include $VIMRUNTIME somewhere, to use the |
| 6446 | distributed runtime files. You can put a directory before $VIMRUNTIME |
| 6447 | to find files which replace a distributed runtime files. You can put |
| 6448 | a directory after $VIMRUNTIME to find files which add to distributed |
| 6449 | runtime files. |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 6450 | When Vim is started with |--clean| the home directory entries are not |
| 6451 | included. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6452 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6453 | security reasons. |
| 6454 | |
| 6455 | *'scroll'* *'scr'* |
| 6456 | 'scroll' 'scr' number (default: half the window height) |
| 6457 | local to window |
| 6458 | Number of lines to scroll with CTRL-U and CTRL-D commands. Will be |
| 6459 | set to half the number of lines in the window when the window size |
| 6460 | 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] | 6461 | 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] | 6462 | height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
| 6463 | the number of screen lines instead of file lines, makes a difference |
| 6464 | when lines wrap} |
| 6465 | |
| 6466 | *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* |
| 6467 | 'scrollbind' 'scb' boolean (default off) |
| 6468 | local to window |
| 6469 | {not in Vi} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6470 | See also |scroll-binding|. When this option is set, the current |
| 6471 | window scrolls as other scrollbind windows (windows that also have |
| 6472 | this option set) scroll. This option is useful for viewing the |
| 6473 | differences between two versions of a file, see 'diff'. |
| 6474 | See |'scrollopt'| for options that determine how this option should be |
| 6475 | interpreted. |
| 6476 | This option is mostly reset when splitting a window to edit another |
| 6477 | file. This means that ":split | edit file" results in two windows |
| 6478 | with scroll-binding, but ":split file" does not. |
| 6479 | |
| 6480 | *'scrolljump'* *'sj'* |
| 6481 | 'scrolljump' 'sj' number (default 1) |
| 6482 | global |
| 6483 | {not in Vi} |
| 6484 | Minimal number of lines to scroll when the cursor gets off the |
| 6485 | screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, |
| 6486 | CTRL-D). Useful if your terminal scrolls very slowly. |
Bram Moolenaar | 1e01546 | 2005-09-25 22:16:38 +0000 | [diff] [blame] | 6487 | When set to a negative number from -1 to -100 this is used as the |
| 6488 | percentage of the window height. Thus -50 scrolls half the window |
| 6489 | height. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6490 | NOTE: This option is set to 1 when 'compatible' is set. |
| 6491 | |
| 6492 | *'scrolloff'* *'so'* |
Bram Moolenaar | 50ba526 | 2016-09-22 22:33:02 +0200 | [diff] [blame] | 6493 | 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6494 | global |
| 6495 | {not in Vi} |
| 6496 | Minimal number of screen lines to keep above and below the cursor. |
| 6497 | This will make some context visible around where you are working. If |
| 6498 | you set it to a very large value (999) the cursor line will always be |
| 6499 | in the middle of the window (except at the start or end of the file or |
| 6500 | when long lines wrap). |
| 6501 | For scrolling horizontally see 'sidescrolloff'. |
| 6502 | NOTE: This option is set to 0 when 'compatible' is set. |
| 6503 | |
| 6504 | *'scrollopt'* *'sbo'* |
| 6505 | 'scrollopt' 'sbo' string (default "ver,jump") |
| 6506 | global |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6507 | {not in Vi} |
| 6508 | This is a comma-separated list of words that specifies how |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 6509 | 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 6510 | Options. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6511 | The following words are available: |
| 6512 | ver Bind vertical scrolling for 'scrollbind' windows |
| 6513 | hor Bind horizontal scrolling for 'scrollbind' windows |
| 6514 | jump Applies to the offset between two windows for vertical |
| 6515 | scrolling. This offset is the difference in the first |
| 6516 | displayed line of the bound windows. When moving |
| 6517 | around in a window, another 'scrollbind' window may |
| 6518 | reach a position before the start or after the end of |
| 6519 | the buffer. The offset is not changed though, when |
| 6520 | moving back the 'scrollbind' window will try to scroll |
| 6521 | to the desired position when possible. |
| 6522 | When now making that window the current one, two |
| 6523 | things can be done with the relative offset: |
| 6524 | 1. When "jump" is not included, the relative offset is |
| 6525 | adjusted for the scroll position in the new current |
| 6526 | window. When going back to the other window, the |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 6527 | new relative offset will be used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6528 | 2. When "jump" is included, the other windows are |
| 6529 | scrolled to keep the same relative offset. When |
| 6530 | going back to the other window, it still uses the |
| 6531 | same relative offset. |
| 6532 | Also see |scroll-binding|. |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 6533 | When 'diff' mode is active there always is vertical scroll binding, |
| 6534 | even when "ver" isn't there. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6535 | |
| 6536 | *'sections'* *'sect'* |
| 6537 | 'sections' 'sect' string (default "SHNHH HUnhsh") |
| 6538 | global |
| 6539 | Specifies the nroff macros that separate sections. These are pairs of |
| 6540 | two letters (See |object-motions|). The default makes a section start |
| 6541 | at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". |
| 6542 | |
| 6543 | *'secure'* *'nosecure'* *E523* |
| 6544 | 'secure' boolean (default off) |
| 6545 | global |
| 6546 | {not in Vi} |
| 6547 | When on, ":autocmd", shell and write commands are not allowed in |
| 6548 | ".vimrc" and ".exrc" in the current directory and map commands are |
| 6549 | displayed. Switch it off only if you know that you will not run into |
| 6550 | problems, or when the 'exrc' option is off. On Unix this option is |
| 6551 | 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] | 6552 | 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] | 6553 | 'secure' at the end of your ~/.vimrc then. |
| 6554 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6555 | security reasons. |
| 6556 | |
| 6557 | *'selection'* *'sel'* |
| 6558 | 'selection' 'sel' string (default "inclusive") |
| 6559 | global |
| 6560 | {not in Vi} |
| 6561 | This option defines the behavior of the selection. It is only used |
| 6562 | in Visual and Select mode. |
| 6563 | Possible values: |
| 6564 | value past line inclusive ~ |
| 6565 | old no yes |
| 6566 | inclusive yes yes |
| 6567 | exclusive yes no |
| 6568 | "past line" means that the cursor is allowed to be positioned one |
| 6569 | character past the line. |
| 6570 | "inclusive" means that the last character of the selection is included |
| 6571 | in an operation. For example, when "x" is used to delete the |
| 6572 | selection. |
Bram Moolenaar | e4a3bcf | 2016-08-26 19:52:37 +0200 | [diff] [blame] | 6573 | When "old" is used and 'virtualedit' allows the cursor to move past |
| 6574 | the end of line the line break still isn't included. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6575 | Note that when "exclusive" is used and selecting from the end |
| 6576 | backwards, you cannot include the last character of a line, when |
| 6577 | starting in Normal mode and 'virtualedit' empty. |
| 6578 | |
| 6579 | The 'selection' option is set by the |:behave| command. |
| 6580 | |
| 6581 | *'selectmode'* *'slm'* |
| 6582 | 'selectmode' 'slm' string (default "") |
| 6583 | global |
| 6584 | {not in Vi} |
| 6585 | This is a comma separated list of words, which specifies when to start |
| 6586 | Select mode instead of Visual mode, when a selection is started. |
| 6587 | Possible values: |
| 6588 | mouse when using the mouse |
| 6589 | key when using shifted special keys |
| 6590 | cmd when using "v", "V" or CTRL-V |
| 6591 | See |Select-mode|. |
| 6592 | The 'selectmode' option is set by the |:behave| command. |
| 6593 | |
| 6594 | *'sessionoptions'* *'ssop'* |
| 6595 | 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 6596 | help,options,tabpages,winsize,terminal") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6597 | global |
| 6598 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 6599 | {not available when compiled without the |+mksession| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6600 | feature} |
| 6601 | Changes the effect of the |:mksession| command. It is a comma |
| 6602 | separated list of words. Each word enables saving and restoring |
| 6603 | something: |
| 6604 | word save and restore ~ |
| 6605 | blank empty windows |
| 6606 | buffers hidden and unloaded buffers, not just those in windows |
| 6607 | curdir the current directory |
| 6608 | folds manually created folds, opened/closed folds and local |
| 6609 | fold options |
| 6610 | globals global variables that start with an uppercase letter |
Bram Moolenaar | 1280586 | 2005-01-05 22:16:17 +0000 | [diff] [blame] | 6611 | and contain at least one lowercase letter. Only |
| 6612 | String and Number types are stored. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6613 | help the help window |
| 6614 | localoptions options and mappings local to a window or buffer (not |
| 6615 | global values for local options) |
| 6616 | options all options and mappings (also global values for local |
| 6617 | options) |
| 6618 | resize size of the Vim window: 'lines' and 'columns' |
| 6619 | sesdir the directory in which the session file is located |
| 6620 | will become the current directory (useful with |
| 6621 | projects accessed over a network from different |
| 6622 | systems) |
| 6623 | slash backslashes in file names replaced with forward |
| 6624 | slashes |
Bram Moolenaar | 18144c8 | 2006-04-12 21:52:12 +0000 | [diff] [blame] | 6625 | tabpages all tab pages; without this only the current tab page |
| 6626 | is restored, so that you can make a session for each |
| 6627 | tab page separately |
Bram Moolenaar | b5b7562 | 2018-03-09 22:22:21 +0100 | [diff] [blame] | 6628 | terminal include terminal windows where the command can be restored |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6629 | unix with Unix end-of-line format (single <NL>), even when |
| 6630 | on Windows or DOS |
| 6631 | winpos position of the whole Vim window |
| 6632 | winsize window sizes |
| 6633 | |
| 6634 | Don't include both "curdir" and "sesdir". |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 6635 | When neither "curdir" nor "sesdir" is included, file names are stored |
| 6636 | with absolute paths. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6637 | "slash" and "unix" are useful on Windows when sharing session files |
| 6638 | with Unix. The Unix version of Vim cannot source dos format scripts, |
| 6639 | but the Windows version of Vim can source unix format scripts. |
| 6640 | |
| 6641 | *'shell'* *'sh'* *E91* |
| 6642 | 'shell' 'sh' string (default $SHELL or "sh", |
| 6643 | MS-DOS and Win32: "command.com" or |
| 6644 | "cmd.exe", OS/2: "cmd") |
| 6645 | global |
| 6646 | Name of the shell to use for ! and :! commands. When changing the |
| 6647 | value also check these options: 'shelltype', 'shellpipe', 'shellslash' |
| 6648 | 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6649 | 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] | 6650 | See |option-backslash| about including spaces and backslashes. |
| 6651 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | 4bfa8af | 2018-02-03 15:14:46 +0100 | [diff] [blame] | 6652 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6653 | If the name of the shell contains a space, you might need to enclose |
Bram Moolenaar | 4bfa8af | 2018-02-03 15:14:46 +0100 | [diff] [blame] | 6654 | it in quotes or escape the space. Example with quotes: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6655 | :set shell=\"c:\program\ files\unix\sh.exe\"\ -f |
| 6656 | < Note the backslash before each quote (to avoid starting a comment) and |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6657 | each space (to avoid ending the option value). Also note that the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6658 | "-f" is not inside the quotes, because it is not part of the command |
Bram Moolenaar | 4bfa8af | 2018-02-03 15:14:46 +0100 | [diff] [blame] | 6659 | name. Vim automagically recognizes the backslashes that are path |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6660 | separators. |
Bram Moolenaar | 4bfa8af | 2018-02-03 15:14:46 +0100 | [diff] [blame] | 6661 | Example with escaped space (Vim will do this when initializing the |
| 6662 | option from $SHELL): > |
| 6663 | :set shell=/bin/with\\\ space/sh |
| 6664 | < The resulting value of 'shell' is "/bin/with\ space/sh", two |
| 6665 | backslashes are consumed by `:set`. |
| 6666 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6667 | Under MS-Windows, when the executable ends in ".com" it must be |
| 6668 | included. Thus setting the shell to "command.com" or "4dos.com" |
| 6669 | works, but "command" and "4dos" do not work for all commands (e.g., |
| 6670 | filtering). |
| 6671 | For unknown reasons, when using "4dos.com" the current directory is |
| 6672 | changed to "C:\". To avoid this set 'shell' like this: > |
| 6673 | :set shell=command.com\ /c\ 4dos |
| 6674 | < This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6675 | security reasons. |
| 6676 | |
| 6677 | *'shellcmdflag'* *'shcf'* |
Bram Moolenaar | 5dc6252 | 2012-02-13 00:05:22 +0100 | [diff] [blame] | 6678 | 'shellcmdflag' 'shcf' string (default: "-c"; |
Bram Moolenaar | db7207e | 2012-02-22 17:30:19 +0100 | [diff] [blame] | 6679 | MS-DOS and Win32, when 'shell' does not |
| 6680 | contain "sh" somewhere: "/c") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6681 | global |
| 6682 | {not in Vi} |
| 6683 | Flag passed to the shell to execute "!" and ":!" commands; e.g., |
| 6684 | "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like |
| 6685 | systems, the default is set according to the value of 'shell', to |
Bram Moolenaar | e0720cb | 2017-03-29 13:48:40 +0200 | [diff] [blame] | 6686 | reduce the need to set this option by the user. |
Bram Moolenaar | 5302d9e | 2011-09-14 17:55:08 +0200 | [diff] [blame] | 6687 | On Unix it can have more than one flag. Each white space separated |
| 6688 | part is passed as an argument to the shell command. |
| 6689 | See |option-backslash| about including spaces and backslashes. |
| 6690 | Also see |dos-shell| for MS-DOS and MS-Windows. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6691 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6692 | security reasons. |
| 6693 | |
| 6694 | *'shellpipe'* *'sp'* |
| 6695 | 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") |
| 6696 | global |
| 6697 | {not in Vi} |
| 6698 | {not available when compiled without the |+quickfix| |
| 6699 | feature} |
| 6700 | 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] | 6701 | error file. See also |:make_makeprg|. See |option-backslash| about |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6702 | including spaces and backslashes. |
| 6703 | The name of the temporary file can be represented by "%s" if necessary |
| 6704 | (the file name is appended automatically if no %s appears in the value |
| 6705 | of this option). |
| 6706 | For the Amiga and MS-DOS the default is ">". The output is directly |
| 6707 | saved in a file and not echoed to the screen. |
| 6708 | For Unix the default it "| tee". The stdout of the compiler is saved |
| 6709 | in a file and echoed to the screen. If the 'shell' option is "csh" or |
| 6710 | "tcsh" after initializations, the default becomes "|& tee". If the |
Bram Moolenaar | 8e5af3e | 2011-04-28 19:02:44 +0200 | [diff] [blame] | 6711 | 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the |
| 6712 | default becomes "2>&1| tee". This means that stderr is also included. |
| 6713 | Before using the 'shell' option a path is removed, thus "/bin/sh" uses |
| 6714 | "sh". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6715 | The initialization of this option is done after reading the ".vimrc" |
| 6716 | and the other initializations, so that when the 'shell' option is set |
| 6717 | there, the 'shellpipe' option changes automatically, unless it was |
| 6718 | explicitly set before. |
| 6719 | When 'shellpipe' is set to an empty string, no redirection of the |
| 6720 | ":make" output will be done. This is useful if you use a 'makeprg' |
| 6721 | that writes to 'makeef' by itself. If you want no piping, but do |
| 6722 | want to include the 'makeef', set 'shellpipe' to a single space. |
| 6723 | Don't forget to precede the space with a backslash: ":set sp=\ ". |
| 6724 | In the future pipes may be used for filtering and this option will |
| 6725 | become obsolete (at least for Unix). |
| 6726 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6727 | security reasons. |
| 6728 | |
| 6729 | *'shellquote'* *'shq'* |
| 6730 | 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' |
| 6731 | contains "sh" somewhere: "\"") |
| 6732 | global |
| 6733 | {not in Vi} |
| 6734 | Quoting character(s), put around the command passed to the shell, for |
| 6735 | the "!" and ":!" commands. The redirection is kept outside of the |
| 6736 | quoting. See 'shellxquote' to include the redirection. It's |
| 6737 | probably not useful to set both options. |
| 6738 | This is an empty string by default. Only known to be useful for |
| 6739 | third-party shells on MS-DOS-like systems, such as the MKS Korn Shell |
| 6740 | or bash, where it should be "\"". The default is adjusted according |
| 6741 | the value of 'shell', to reduce the need to set this option by the |
| 6742 | user. See |dos-shell|. |
| 6743 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6744 | security reasons. |
| 6745 | |
| 6746 | *'shellredir'* *'srr'* |
| 6747 | 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") |
| 6748 | global |
| 6749 | {not in Vi} |
| 6750 | String to be used to put the output of a filter command in a temporary |
| 6751 | file. See also |:!|. See |option-backslash| about including spaces |
| 6752 | and backslashes. |
| 6753 | The name of the temporary file can be represented by "%s" if necessary |
| 6754 | (the file name is appended automatically if no %s appears in the value |
| 6755 | of this option). |
| 6756 | The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" |
| 6757 | or "zsh" during initializations, the default becomes ">&". If the |
| 6758 | 'shell' option is "sh", "ksh" or "bash" the default becomes |
| 6759 | ">%s 2>&1". This means that stderr is also included. |
| 6760 | For Win32, the Unix checks are done and additionally "cmd" is checked |
| 6761 | for, which makes the default ">%s 2>&1". Also, the same names with |
| 6762 | ".exe" appended are checked for. |
| 6763 | The initialization of this option is done after reading the ".vimrc" |
| 6764 | and the other initializations, so that when the 'shell' option is set |
| 6765 | there, the 'shellredir' option changes automatically unless it was |
| 6766 | explicitly set before. |
| 6767 | In the future pipes may be used for filtering and this option will |
| 6768 | become obsolete (at least for Unix). |
| 6769 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6770 | security reasons. |
| 6771 | |
| 6772 | *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* |
| 6773 | 'shellslash' 'ssl' boolean (default off) |
| 6774 | global |
| 6775 | {not in Vi} {only for MSDOS, MS-Windows and OS/2} |
| 6776 | When set, a forward slash is used when expanding file names. This is |
| 6777 | useful when a Unix-like shell is used instead of command.com or |
| 6778 | cmd.exe. Backward slashes can still be typed, but they are changed to |
| 6779 | forward slashes by Vim. |
| 6780 | Note that setting or resetting this option has no effect for some |
| 6781 | existing file names, thus this option needs to be set before opening |
| 6782 | any file for best results. This might change in the future. |
| 6783 | 'shellslash' only works when a backslash can be used as a path |
| 6784 | separator. To test if this is so use: > |
| 6785 | if exists('+shellslash') |
| 6786 | < |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 6787 | *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 6788 | 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) |
| 6789 | global |
| 6790 | {not in Vi} |
| 6791 | When on, use temp files for shell commands. When off use a pipe. |
| 6792 | When using a pipe is not possible temp files are used anyway. |
Bram Moolenaar | 9729301 | 2011-07-18 19:40:27 +0200 | [diff] [blame] | 6793 | Currently a pipe is only supported on Unix and MS-Windows 2K and |
| 6794 | later. You can check it with: > |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 6795 | :if has("filterpipe") |
| 6796 | < The advantage of using a pipe is that nobody can read the temp file |
| 6797 | and the 'shell' command does not need to support redirection. |
| 6798 | The advantage of using a temp file is that the file type and encoding |
| 6799 | can be detected. |
| 6800 | The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, |
| 6801 | |FilterWritePost| autocommands event are not triggered when |
| 6802 | 'shelltemp' is off. |
Bram Moolenaar | 269f595 | 2016-07-15 22:54:41 +0200 | [diff] [blame] | 6803 | The `system()` function does not respect this option and always uses |
| 6804 | temp files. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 6805 | NOTE: This option is set to the Vim default value when 'compatible' |
| 6806 | is reset. |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 6807 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6808 | *'shelltype'* *'st'* |
| 6809 | 'shelltype' 'st' number (default 0) |
| 6810 | global |
| 6811 | {not in Vi} {only for the Amiga} |
| 6812 | On the Amiga this option influences the way how the commands work |
| 6813 | which use a shell. |
| 6814 | 0 and 1: always use the shell |
| 6815 | 2 and 3: use the shell only to filter lines |
| 6816 | 4 and 5: use shell only for ':sh' command |
| 6817 | When not using the shell, the command is executed directly. |
| 6818 | |
| 6819 | 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands |
| 6820 | 1 and 3: use "shell cmd" to start external commands |
| 6821 | |
Bram Moolenaar | db7207e | 2012-02-22 17:30:19 +0100 | [diff] [blame] | 6822 | *'shellxescape'* *'sxe'* |
| 6823 | 'shellxescape' 'sxe' string (default: ""; |
| 6824 | for MS-DOS and MS-Windows: "\"&|<>()@^") |
| 6825 | global |
| 6826 | {not in Vi} |
| 6827 | When 'shellxquote' is set to "(" then the characters listed in this |
| 6828 | option will be escaped with a '^' character. This makes it possible |
| 6829 | to execute most external commands with cmd.exe. |
| 6830 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6831 | *'shellxquote'* *'sxq'* |
| 6832 | 'shellxquote' 'sxq' string (default: ""; |
Bram Moolenaar | f66b3fc | 2012-02-20 22:18:30 +0100 | [diff] [blame] | 6833 | for Win32, when 'shell' is cmd.exe: "(" |
| 6834 | for Win32, when 'shell' contains "sh" |
| 6835 | somewhere: "\"" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6836 | for Unix, when using system(): "\"") |
| 6837 | global |
| 6838 | {not in Vi} |
| 6839 | Quoting character(s), put around the command passed to the shell, for |
| 6840 | the "!" and ":!" commands. Includes the redirection. See |
| 6841 | 'shellquote' to exclude the redirection. It's probably not useful |
| 6842 | to set both options. |
Bram Moolenaar | f66b3fc | 2012-02-20 22:18:30 +0100 | [diff] [blame] | 6843 | When the value is '(' then ')' is appended. When the value is '"(' |
| 6844 | then ')"' is appended. |
| 6845 | When the value is '(' then also see 'shellxescape'. |
Bram Moolenaar | a64ba22 | 2012-02-12 23:23:31 +0100 | [diff] [blame] | 6846 | This is an empty string by default on most systems, but is known to be |
| 6847 | useful for on Win32 version, either for cmd.exe which automatically |
| 6848 | strips off the first and last quote on a command, or 3rd-party shells |
| 6849 | such as the MKS Korn Shell or bash, where it should be "\"". The |
| 6850 | default is adjusted according the value of 'shell', to reduce the need |
| 6851 | to set this option by the user. See |dos-shell|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6852 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6853 | security reasons. |
| 6854 | |
| 6855 | *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* |
| 6856 | 'shiftround' 'sr' boolean (default off) |
| 6857 | global |
| 6858 | {not in Vi} |
| 6859 | Round indent to multiple of 'shiftwidth'. Applies to > and < |
| 6860 | commands. CTRL-T and CTRL-D in Insert mode always round the indent to |
| 6861 | a multiple of 'shiftwidth' (this is Vi compatible). |
| 6862 | NOTE: This option is reset when 'compatible' is set. |
| 6863 | |
| 6864 | *'shiftwidth'* *'sw'* |
| 6865 | 'shiftwidth' 'sw' number (default 8) |
| 6866 | local to buffer |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 6867 | 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] | 6868 | |'cindent'|, |>>|, |<<|, etc. |
Bram Moolenaar | 3a0d809 | 2012-10-21 03:02:54 +0200 | [diff] [blame] | 6869 | When zero the 'ts' value will be used. Use the |shiftwidth()| |
| 6870 | function to get the effective shiftwidth value. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6871 | |
| 6872 | *'shortmess'* *'shm'* |
Bram Moolenaar | 26a60b4 | 2005-02-22 08:49:11 +0000 | [diff] [blame] | 6873 | 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "", |
| 6874 | POSIX default: "A") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6875 | global |
| 6876 | {not in Vi} |
| 6877 | This option helps to avoid all the |hit-enter| prompts caused by file |
| 6878 | messages, for example with CTRL-G, and to avoid some other messages. |
| 6879 | It is a list of flags: |
| 6880 | flag meaning when present ~ |
| 6881 | f use "(3 of 5)" instead of "(file 3 of 5)" |
| 6882 | i use "[noeol]" instead of "[Incomplete last line]" |
| 6883 | l use "999L, 888C" instead of "999 lines, 888 characters" |
| 6884 | m use "[+]" instead of "[Modified]" |
| 6885 | n use "[New]" instead of "[New File]" |
| 6886 | r use "[RO]" instead of "[readonly]" |
| 6887 | w use "[w]" instead of "written" for file write message |
| 6888 | and "[a]" instead of "appended" for ':w >> file' command |
| 6889 | x use "[dos]" instead of "[dos format]", "[unix]" instead of |
| 6890 | "[unix format]" and "[mac]" instead of "[mac format]". |
| 6891 | a all of the above abbreviations |
| 6892 | |
| 6893 | o overwrite message for writing a file with subsequent message |
| 6894 | for reading a file (useful for ":wn" or when 'autowrite' on) |
| 6895 | O message for reading a file overwrites any previous message. |
| 6896 | Also for quickfix message (e.g., ":cn"). |
| 6897 | s don't give "search hit BOTTOM, continuing at TOP" or "search |
| 6898 | hit TOP, continuing at BOTTOM" messages |
| 6899 | t truncate file message at the start if it is too long to fit |
| 6900 | on the command-line, "<" will appear in the left most column. |
| 6901 | Ignored in Ex mode. |
| 6902 | 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] | 6903 | fit on the command line. "..." will appear in the middle. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6904 | Ignored in Ex mode. |
| 6905 | W don't give "written" or "[w]" when writing a file |
| 6906 | A don't give the "ATTENTION" message when an existing swap file |
| 6907 | is found. |
| 6908 | I don't give the intro message when starting Vim |:intro|. |
Bram Moolenaar | ea389e9 | 2014-05-28 21:40:52 +0200 | [diff] [blame] | 6909 | c don't give |ins-completion-menu| messages. For example, |
| 6910 | "-- XXX completion (YYY)", "match 1 of 2", "The only match", |
| 6911 | "Pattern not found", "Back at original", etc. |
Bram Moolenaar | 426dd02 | 2016-03-15 15:09:29 +0100 | [diff] [blame] | 6912 | q use "recording" instead of "recording @a" |
| 6913 | F don't give the file info when editing a file, like `:silent` |
| 6914 | was used for the command |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6915 | |
| 6916 | This gives you the opportunity to avoid that a change between buffers |
| 6917 | requires you to hit <Enter>, but still gives as useful a message as |
| 6918 | possible for the space available. To get the whole message that you |
| 6919 | would have got with 'shm' empty, use ":file!" |
| 6920 | Useful values: |
| 6921 | shm= No abbreviation of message. |
| 6922 | shm=a Abbreviation, but no loss of information. |
| 6923 | shm=at Abbreviation, and truncate message when necessary. |
| 6924 | |
| 6925 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 6926 | set and to the Vim default value when 'compatible' is reset. |
| 6927 | |
| 6928 | *'shortname'* *'sn'* *'noshortname'* *'nosn'* |
| 6929 | 'shortname' 'sn' boolean (default off) |
| 6930 | local to buffer |
| 6931 | {not in Vi, not in MS-DOS versions} |
| 6932 | Filenames are assumed to be 8 characters plus one extension of 3 |
| 6933 | characters. Multiple dots in file names are not allowed. When this |
| 6934 | option is on, dots in file names are replaced with underscores when |
| 6935 | adding an extension (".~" or ".swp"). This option is not available |
| 6936 | for MS-DOS, because then it would always be on. This option is useful |
| 6937 | when editing files on an MS-DOS compatible filesystem, e.g., messydos |
| 6938 | or crossdos. When running the Win32 GUI version under Win32s, this |
| 6939 | option is always on by default. |
| 6940 | |
| 6941 | *'showbreak'* *'sbr'* *E595* |
| 6942 | 'showbreak' 'sbr' string (default "") |
| 6943 | global |
| 6944 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 6945 | {not available when compiled without the |+linebreak| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6946 | feature} |
| 6947 | String to put at the start of lines that have been wrapped. Useful |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 6948 | values are "> " or "+++ ": > |
| 6949 | :set showbreak=>\ |
| 6950 | < Note the backslash to escape the trailing space. It's easier like |
| 6951 | this: > |
Bram Moolenaar | 1a38442 | 2010-07-14 19:53:30 +0200 | [diff] [blame] | 6952 | :let &showbreak = '+++ ' |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 6953 | < Only printable single-cell characters are allowed, excluding <Tab> and |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6954 | comma (in a future version the comma might be used to separate the |
| 6955 | part that is shown at the end and at the start of a line). |
| 6956 | The characters are highlighted according to the '@' flag in |
| 6957 | 'highlight'. |
| 6958 | Note that tabs after the showbreak will be displayed differently. |
| 6959 | If you want the 'showbreak' to appear in between line numbers, add the |
| 6960 | "n" flag to 'cpoptions'. |
| 6961 | |
| 6962 | *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 6963 | 'showcmd' 'sc' boolean (Vim default: on, off for Unix, |
| 6964 | Vi default: off, set in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6965 | global |
| 6966 | {not in Vi} |
| 6967 | {not available when compiled without the |
| 6968 | |+cmdline_info| feature} |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 6969 | Show (partial) command in the last line of the screen. Set this |
| 6970 | option off if your terminal is slow. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6971 | In Visual mode the size of the selected area is shown: |
| 6972 | - When selecting characters within a line, the number of characters. |
Bram Moolenaar | f91787c | 2010-07-17 12:47:16 +0200 | [diff] [blame] | 6973 | If the number of bytes is different it is also displayed: "2-6" |
| 6974 | means two characters and six bytes. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6975 | - When selecting more than one line, the number of lines. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 6976 | - When selecting a block, the size in screen characters: |
| 6977 | {lines}x{columns}. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6978 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 6979 | set and to the Vim default value when 'compatible' is reset. |
| 6980 | |
| 6981 | *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* |
| 6982 | 'showfulltag' 'sft' boolean (default off) |
| 6983 | global |
| 6984 | {not in Vi} |
| 6985 | When completing a word in insert mode (see |ins-completion|) from the |
| 6986 | 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] | 6987 | pattern (if there is one) as possible matches. Thus, if you have |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6988 | matched a C function, you can see a template for what arguments are |
| 6989 | required (coding style permitting). |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 6990 | Note that this doesn't work well together with having "longest" in |
| 6991 | 'completeopt', because the completion from the search pattern may not |
| 6992 | match the typed text. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 6993 | |
| 6994 | *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* |
| 6995 | 'showmatch' 'sm' boolean (default off) |
| 6996 | global |
| 6997 | When a bracket is inserted, briefly jump to the matching one. The |
| 6998 | jump is only done if the match can be seen on the screen. The time to |
| 6999 | show the match can be set with 'matchtime'. |
| 7000 | A Beep is given if there is no match (no matter if the match can be |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 7001 | seen or not). |
| 7002 | This option is reset when 'paste' is set and restored when 'paste' is |
| 7003 | reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7004 | When the 'm' flag is not included in 'cpoptions', typing a character |
| 7005 | will immediately move the cursor back to where it belongs. |
| 7006 | See the "sm" field in 'guicursor' for setting the cursor shape and |
| 7007 | blinking when showing the match. |
| 7008 | The 'matchpairs' option can be used to specify the characters to show |
| 7009 | matches for. 'rightleft' and 'revins' are used to look for opposite |
| 7010 | matches. |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 7011 | Also see the matchparen plugin for highlighting the match when moving |
| 7012 | around |pi_paren.txt|. |
| 7013 | Note: Use of the short form is rated PG. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7014 | |
| 7015 | *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* |
| 7016 | 'showmode' 'smd' boolean (Vim default: on, Vi default: off) |
| 7017 | global |
| 7018 | If in Insert, Replace or Visual mode put a message on the last line. |
| 7019 | Use the 'M' flag in 'highlight' to set the type of highlighting for |
| 7020 | this message. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7021 | When |XIM| may be used the message will include "XIM". But this |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7022 | doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 7023 | not set. |
| 7024 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 7025 | set and to the Vim default value when 'compatible' is reset. |
| 7026 | |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7027 | *'showtabline'* *'stal'* |
| 7028 | 'showtabline' 'stal' number (default 1) |
| 7029 | global |
| 7030 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 7031 | {not available when compiled without the |+windows| |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7032 | feature} |
| 7033 | The value of this option specifies when the line with tab page labels |
| 7034 | will be displayed: |
| 7035 | 0: never |
| 7036 | 1: only if there are at least two tab pages |
| 7037 | 2: always |
| 7038 | This is both for the GUI and non-GUI implementation of the tab pages |
| 7039 | line. |
| 7040 | See |tab-page| for more information about tab pages. |
| 7041 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7042 | *'sidescroll'* *'ss'* |
| 7043 | 'sidescroll' 'ss' number (default 0) |
| 7044 | global |
| 7045 | {not in Vi} |
| 7046 | The minimal number of columns to scroll horizontally. Used only when |
| 7047 | the 'wrap' option is off and the cursor is moved off of the screen. |
| 7048 | When it is zero the cursor will be put in the middle of the screen. |
| 7049 | When using a slow terminal set it to a large number or 0. When using |
| 7050 | a fast terminal use a small number or 1. Not used for "zh" and "zl" |
| 7051 | commands. |
| 7052 | |
| 7053 | *'sidescrolloff'* *'siso'* |
| 7054 | 'sidescrolloff' 'siso' number (default 0) |
| 7055 | global |
| 7056 | {not in Vi} |
| 7057 | The minimal number of screen columns to keep to the left and to the |
Bram Moolenaar | 482aaeb | 2005-09-29 18:26:07 +0000 | [diff] [blame] | 7058 | right of the cursor if 'nowrap' is set. Setting this option to a |
| 7059 | value greater than 0 while having |'sidescroll'| also at a non-zero |
| 7060 | value makes some context visible in the line you are scrolling in |
| 7061 | horizontally (except at beginning of the line). Setting this option |
| 7062 | to a large value (like 999) has the effect of keeping the cursor |
| 7063 | horizontally centered in the window, as long as one does not come too |
| 7064 | close to the beginning of the line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7065 | NOTE: This option is set to 0 when 'compatible' is set. |
| 7066 | |
| 7067 | Example: Try this together with 'sidescroll' and 'listchars' as |
| 7068 | in the following example to never allow the cursor to move |
Bram Moolenaar | 95ec9d6 | 2016-08-12 18:29:59 +0200 | [diff] [blame] | 7069 | onto the "extends" character: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7070 | |
| 7071 | :set nowrap sidescroll=1 listchars=extends:>,precedes:< |
| 7072 | :set sidescrolloff=1 |
Bram Moolenaar | 95ec9d6 | 2016-08-12 18:29:59 +0200 | [diff] [blame] | 7073 | < |
| 7074 | *'signcolumn'* *'scl'* |
| 7075 | 'signcolumn' 'scl' string (default "auto") |
| 7076 | local to window |
| 7077 | {not in Vi} |
| 7078 | {not available when compiled without the |+signs| |
| 7079 | feature} |
Bram Moolenaar | 0952131 | 2016-08-12 22:54:35 +0200 | [diff] [blame] | 7080 | Whether or not to draw the signcolumn. Valid values are: |
| 7081 | "auto" only when there is a sign to display |
| 7082 | "no" never |
| 7083 | "yes" always |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7084 | |
| 7085 | |
| 7086 | *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* |
| 7087 | 'smartcase' 'scs' boolean (default off) |
| 7088 | global |
| 7089 | {not in Vi} |
| 7090 | Override the 'ignorecase' option if the search pattern contains upper |
| 7091 | case characters. Only used when the search pattern is typed and |
| 7092 | 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", |
Bram Moolenaar | c873442 | 2012-06-01 22:38:45 +0200 | [diff] [blame] | 7093 | ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7094 | "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 7095 | recalling the search pattern from history and hitting <Enter>. |
| 7096 | NOTE: This option is reset when 'compatible' is set. |
| 7097 | |
| 7098 | *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* |
| 7099 | 'smartindent' 'si' boolean (default off) |
| 7100 | local to buffer |
| 7101 | {not in Vi} |
| 7102 | {not available when compiled without the |
| 7103 | |+smartindent| feature} |
| 7104 | Do smart autoindenting when starting a new line. Works for C-like |
| 7105 | programs, but can also be used for other languages. 'cindent' does |
| 7106 | something like this, works better in most cases, but is more strict, |
Bram Moolenaar | 81af925 | 2010-12-10 20:35:50 +0100 | [diff] [blame] | 7107 | see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
Bram Moolenaar | 166af9b | 2010-11-16 20:34:40 +0100 | [diff] [blame] | 7108 | setting 'si' has no effect. 'indentexpr' is a more advanced |
| 7109 | alternative. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7110 | Normally 'autoindent' should also be on when using 'smartindent'. |
| 7111 | An indent is automatically inserted: |
| 7112 | - After a line ending in '{'. |
| 7113 | - After a line starting with a keyword from 'cinwords'. |
| 7114 | - Before a line starting with '}' (only with the "O" command). |
| 7115 | When typing '}' as the first character in a new line, that line is |
| 7116 | given the same indent as the matching '{'. |
| 7117 | When typing '#' as the first character in a new line, the indent for |
| 7118 | 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] | 7119 | 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] | 7120 | mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 7121 | When using the ">>" command, lines starting with '#' are not shifted |
| 7122 | right. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 7123 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 7124 | This option is reset when 'paste' is set and restored when 'paste' is |
| 7125 | reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7126 | |
| 7127 | *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* |
| 7128 | 'smarttab' 'sta' boolean (default off) |
| 7129 | global |
| 7130 | {not in Vi} |
| 7131 | When on, a <Tab> in front of a line inserts blanks according to |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 7132 | 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
| 7133 | <BS> will delete a 'shiftwidth' worth of space at the start of the |
| 7134 | line. |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 7135 | When off, a <Tab> always inserts blanks according to 'tabstop' or |
Bram Moolenaar | 280f126 | 2006-01-30 00:14:18 +0000 | [diff] [blame] | 7136 | 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
| 7137 | right |shift-left-right|. |
Bram Moolenaar | ebcbd02 | 2007-05-12 14:28:25 +0000 | [diff] [blame] | 7138 | What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7139 | option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 7140 | number of spaces is minimized by using <Tab>s. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 7141 | This option is reset when 'paste' is set and restored when 'paste' is |
| 7142 | reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7143 | NOTE: This option is reset when 'compatible' is set. |
| 7144 | |
| 7145 | *'softtabstop'* *'sts'* |
| 7146 | 'softtabstop' 'sts' number (default 0) |
| 7147 | local to buffer |
| 7148 | {not in Vi} |
| 7149 | Number of spaces that a <Tab> counts for while performing editing |
| 7150 | operations, like inserting a <Tab> or using <BS>. It "feels" like |
| 7151 | <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is |
| 7152 | used. This is useful to keep the 'ts' setting at its standard value |
| 7153 | of 8, while being able to edit like it is set to 'sts'. However, |
| 7154 | commands like "x" still work on the actual characters. |
| 7155 | When 'sts' is zero, this feature is off. |
Bram Moolenaar | 3a0d809 | 2012-10-21 03:02:54 +0200 | [diff] [blame] | 7156 | When 'sts' is negative, the value of 'shiftwidth' is used. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 7157 | 'softtabstop' is set to 0 when the 'paste' option is set and restored |
| 7158 | when 'paste' is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7159 | See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 7160 | spaces is minimized by using <Tab>s. |
| 7161 | The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is |
| 7162 | set. |
| 7163 | NOTE: This option is set to 0 when 'compatible' is set. |
| 7164 | |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 7165 | *'spell'* *'nospell'* |
| 7166 | 'spell' boolean (default off) |
| 7167 | local to window |
| 7168 | {not in Vi} |
| 7169 | {not available when compiled without the |+syntax| |
| 7170 | feature} |
| 7171 | When on spell checking will be done. See |spell|. |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 7172 | The languages are specified with 'spelllang'. |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 7173 | |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 7174 | *'spellcapcheck'* *'spc'* |
Bram Moolenaar | 0dc065e | 2005-07-04 22:49:24 +0000 | [diff] [blame] | 7175 | 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 7176 | local to buffer |
| 7177 | {not in Vi} |
| 7178 | {not available when compiled without the |+syntax| |
| 7179 | feature} |
| 7180 | Pattern to locate the end of a sentence. The following word will be |
| 7181 | 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] | 7182 | with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 7183 | When this check is not wanted make this option empty. |
| 7184 | Only used when 'spell' is set. |
Bram Moolenaar | 0dc065e | 2005-07-04 22:49:24 +0000 | [diff] [blame] | 7185 | Be careful with special characters, see |option-backslash| about |
| 7186 | including spaces and backslashes. |
Bram Moolenaar | 90cfdbe | 2005-08-12 19:59:19 +0000 | [diff] [blame] | 7187 | To set this option automatically depending on the language, see |
| 7188 | |set-spc-auto|. |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 7189 | |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 7190 | *'spellfile'* *'spf'* |
| 7191 | 'spellfile' 'spf' string (default empty) |
| 7192 | local to buffer |
| 7193 | {not in Vi} |
| 7194 | {not available when compiled without the |+syntax| |
| 7195 | feature} |
| 7196 | 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] | 7197 | commands. It must end in ".{encoding}.add". You need to include the |
| 7198 | path, otherwise the file is placed in the current directory. |
Bram Moolenaar | 0d9c26d | 2005-07-02 23:19:16 +0000 | [diff] [blame] | 7199 | *E765* |
| 7200 | It may also be a comma separated list of names. A count before the |
| 7201 | |zg| and |zw| commands can be used to access each. This allows using |
| 7202 | a personal word list file and a project word list file. |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 7203 | When a word is added while this option is empty Vim will set it for |
Bram Moolenaar | 910f66f | 2006-04-05 20:41:53 +0000 | [diff] [blame] | 7204 | you: Using the first directory in 'runtimepath' that is writable. If |
| 7205 | there is no "spell" directory yet it will be created. For the file |
| 7206 | name the first language name that appears in 'spelllang' is used, |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 7207 | ignoring the region. |
| 7208 | The resulting ".spl" file will be used for spell checking, it does not |
| 7209 | have to appear in 'spelllang'. |
| 7210 | Normally one file is used for all regions, but you can add the region |
| 7211 | name if you want to. However, it will then only be used when |
| 7212 | 'spellfile' is set to it, for entries in 'spelllang' only files |
| 7213 | without region name will be found. |
Bram Moolenaar | e756604 | 2005-06-17 22:00:15 +0000 | [diff] [blame] | 7214 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7215 | security reasons. |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 7216 | |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 7217 | *'spelllang'* *'spl'* |
Bram Moolenaar | 82cf9b6 | 2005-06-07 21:09:25 +0000 | [diff] [blame] | 7218 | 'spelllang' 'spl' string (default "en") |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 7219 | local to buffer |
| 7220 | {not in Vi} |
| 7221 | {not available when compiled without the |+syntax| |
| 7222 | feature} |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 7223 | A comma separated list of word list names. When the 'spell' option is |
| 7224 | on spellchecking will be done for these languages. Example: > |
| 7225 | set spelllang=en_us,nl,medical |
| 7226 | < This means US English, Dutch and medical words are recognized. Words |
| 7227 | that are not recognized will be highlighted. |
| 7228 | The word list name must not include a comma or dot. Using a dash is |
| 7229 | recommended to separate the two letter language name from a |
| 7230 | specification. Thus "en-rare" is used for rare English words. |
| 7231 | A region name must come last and have the form "_xx", where "xx" is |
| 7232 | the two-letter, lower case region name. You can use more than one |
| 7233 | region by listing them: "en_us,en_ca" supports both US and Canadian |
| 7234 | English, but not words specific for Australia, New Zealand or Great |
Bram Moolenaar | fa73534 | 2016-01-03 22:14:44 +0100 | [diff] [blame] | 7235 | Britain. (Note: currently en_au and en_nz dictionaries are older than |
| 7236 | en_ca, en_gb and en_us). |
Bram Moolenaar | cc63c64 | 2013-11-12 04:44:01 +0100 | [diff] [blame] | 7237 | If the name "cjk" is included East Asian characters are excluded from |
| 7238 | spell checking. This is useful when editing text that also has Asian |
| 7239 | words. |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 7240 | *E757* |
Bram Moolenaar | ce0842a | 2005-07-18 21:58:11 +0000 | [diff] [blame] | 7241 | As a special case the name of a .spl file can be given as-is. The |
| 7242 | first "_xx" in the name is removed and used as the region name |
| 7243 | (_xx is an underscore, two letters and followed by a non-letter). |
| 7244 | This is mainly for testing purposes. You must make sure the correct |
| 7245 | encoding is used, Vim doesn't check it. |
Bram Moolenaar | 402d2fe | 2005-04-15 21:00:38 +0000 | [diff] [blame] | 7246 | 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] | 7247 | idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 7248 | files twice. |
Bram Moolenaar | 3b50694 | 2005-06-23 22:36:45 +0000 | [diff] [blame] | 7249 | How the related spell files are found is explained here: |spell-load|. |
Bram Moolenaar | 217ad92 | 2005-03-20 22:37:15 +0000 | [diff] [blame] | 7250 | |
Bram Moolenaar | 9869207 | 2006-02-04 00:57:42 +0000 | [diff] [blame] | 7251 | If the |spellfile.vim| plugin is active and you use a language name |
| 7252 | for which Vim cannot find the .spl file in 'runtimepath' the plugin |
| 7253 | will ask you if you want to download the file. |
| 7254 | |
Bram Moolenaar | 90cfdbe | 2005-08-12 19:59:19 +0000 | [diff] [blame] | 7255 | After this option has been set successfully, Vim will source the files |
| 7256 | "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' |
Bram Moolenaar | afeb4fa | 2006-02-01 21:51:12 +0000 | [diff] [blame] | 7257 | up to the first comma, dot or underscore. |
| 7258 | Also see |set-spc-auto|. |
Bram Moolenaar | 90cfdbe | 2005-08-12 19:59:19 +0000 | [diff] [blame] | 7259 | |
| 7260 | |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 7261 | *'spellsuggest'* *'sps'* |
| 7262 | 'spellsuggest' 'sps' string (default "best") |
| 7263 | global |
| 7264 | {not in Vi} |
| 7265 | {not available when compiled without the |+syntax| |
| 7266 | feature} |
Bram Moolenaar | 2c7a29c | 2005-12-12 22:02:31 +0000 | [diff] [blame] | 7267 | Methods used for spelling suggestions. Both for the |z=| command and |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7268 | the |spellsuggest()| function. This is a comma-separated list of |
| 7269 | items: |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 7270 | |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7271 | best Internal method that works best for English. Finds |
| 7272 | changes like "fast" and uses a bit of sound-a-like |
| 7273 | scoring to improve the ordering. |
| 7274 | |
| 7275 | double Internal method that uses two methods and mixes the |
| 7276 | results. The first method is "fast", the other method |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 7277 | computes how much the suggestion sounds like the bad |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7278 | word. That only works when the language specifies |
| 7279 | sound folding. Can be slow and doesn't always give |
| 7280 | better results. |
| 7281 | |
| 7282 | fast Internal method that only checks for simple changes: |
| 7283 | character inserts/deletes/swaps. Works well for |
| 7284 | simple typing mistakes. |
| 7285 | |
Bram Moolenaar | 2c7a29c | 2005-12-12 22:02:31 +0000 | [diff] [blame] | 7286 | {number} The maximum number of suggestions listed for |z=|. |
Bram Moolenaar | 8aff23a | 2005-08-19 20:40:30 +0000 | [diff] [blame] | 7287 | Not used for |spellsuggest()|. The number of |
| 7288 | suggestions is never more than the value of 'lines' |
| 7289 | minus two. |
| 7290 | |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7291 | file:{filename} Read file {filename}, which must have two columns, |
| 7292 | separated by a slash. The first column contains the |
| 7293 | bad word, the second column the suggested good word. |
| 7294 | Example: |
| 7295 | theribal/terrible ~ |
| 7296 | Use this for common mistakes that do not appear at the |
| 7297 | top of the suggestion list with the internal methods. |
| 7298 | Lines without a slash are ignored, use this for |
| 7299 | comments. |
Bram Moolenaar | bcb9898 | 2014-05-01 14:08:19 +0200 | [diff] [blame] | 7300 | The word in the second column must be correct, |
| 7301 | otherwise it will not be used. Add the word to an |
| 7302 | ".add" file if it is currently flagged as a spelling |
| 7303 | mistake. |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7304 | The file is used for all languages. |
| 7305 | |
| 7306 | expr:{expr} Evaluate expression {expr}. Use a function to avoid |
| 7307 | trouble with spaces. |v:val| holds the badly spelled |
| 7308 | word. The expression must evaluate to a List of |
| 7309 | Lists, each with a suggestion and a score. |
| 7310 | Example: |
Bram Moolenaar | 214641f | 2017-03-05 17:04:09 +0100 | [diff] [blame] | 7311 | [['the', 33], ['that', 44]] ~ |
Bram Moolenaar | 2c7a29c | 2005-12-12 22:02:31 +0000 | [diff] [blame] | 7312 | Set 'verbose' and use |z=| to see the scores that the |
Bram Moolenaar | 24bbcfe | 2005-06-28 23:32:02 +0000 | [diff] [blame] | 7313 | internal methods use. A lower score is better. |
| 7314 | This may invoke |spellsuggest()| if you temporarily |
| 7315 | set 'spellsuggest' to exclude the "expr:" part. |
| 7316 | Errors are silently ignored, unless you set the |
| 7317 | 'verbose' option to a non-zero value. |
| 7318 | |
| 7319 | Only one of "best", "double" or "fast" may be used. The others may |
| 7320 | appear several times in any order. Example: > |
| 7321 | :set sps=file:~/.vim/sugg,best,expr:MySuggest() |
| 7322 | < |
| 7323 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7324 | security reasons. |
Bram Moolenaar | d857f0e | 2005-06-21 22:37:39 +0000 | [diff] [blame] | 7325 | |
| 7326 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7327 | *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 7328 | 'splitbelow' 'sb' boolean (default off) |
| 7329 | global |
| 7330 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 7331 | {not available when compiled without the |+windows| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7332 | feature} |
| 7333 | When on, splitting a window will put the new window below the current |
| 7334 | one. |:split| |
| 7335 | |
| 7336 | *'splitright'* *'spr'* *'nosplitright'* *'nospr'* |
| 7337 | 'splitright' 'spr' boolean (default off) |
| 7338 | global |
| 7339 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 7340 | {not available when compiled without the |+vertsplit| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7341 | feature} |
| 7342 | When on, splitting a window will put the new window right of the |
| 7343 | current one. |:vsplit| |
| 7344 | |
| 7345 | *'startofline'* *'sol'* *'nostartofline'* *'nosol'* |
| 7346 | 'startofline' 'sol' boolean (default on) |
| 7347 | global |
| 7348 | {not in Vi} |
| 7349 | When "on" the commands listed below move the cursor to the first |
Bram Moolenaar | 843ee41 | 2004-06-30 16:16:41 +0000 | [diff] [blame] | 7350 | 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] | 7351 | (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] | 7352 | 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] | 7353 | with a linewise operator, with "%" with a count and to buffer changing |
| 7354 | commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that |
| 7355 | only has a line number, e.g., ":25" or ":+". |
| 7356 | In case of buffer changing commands the cursor is placed at the column |
| 7357 | where it was the last time the buffer was edited. |
| 7358 | NOTE: This option is set when 'compatible' is set. |
| 7359 | |
Bram Moolenaar | 0065402 | 2011-02-25 14:42:19 +0100 | [diff] [blame] | 7360 | *'statusline'* *'stl'* *E540* *E542* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7361 | 'statusline' 'stl' string (default empty) |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 7362 | global or local to window |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7363 | {not in Vi} |
| 7364 | {not available when compiled without the |+statusline| |
| 7365 | feature} |
| 7366 | When nonempty, this option determines the content of the status line. |
| 7367 | Also see |status-line|. |
| 7368 | |
| 7369 | The option consists of printf style '%' items interspersed with |
| 7370 | normal text. Each status line item is of the form: |
| 7371 | %-0{minwid}.{maxwid}{item} |
Bram Moolenaar | 5e9b2fa | 2016-02-01 22:37:05 +0100 | [diff] [blame] | 7372 | All fields except the {item} are optional. A single percent sign can |
Bram Moolenaar | 0065402 | 2011-02-25 14:42:19 +0100 | [diff] [blame] | 7373 | be given as "%%". Up to 80 items can be specified. *E541* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7374 | |
Bram Moolenaar | 238a564 | 2006-02-21 22:12:05 +0000 | [diff] [blame] | 7375 | When the option starts with "%!" then it is used as an expression, |
| 7376 | evaluated and the result is used as the option value. Example: > |
| 7377 | :set statusline=%!MyStatusLine() |
| 7378 | < The result can contain %{} items that will be evaluated too. |
Bram Moolenaar | 61d35bd | 2012-03-28 20:51:51 +0200 | [diff] [blame] | 7379 | Note that the "%!" expression is evaluated in the context of the |
| 7380 | current window and buffer, while %{} items are evaluated in the |
| 7381 | context of the window that the statusline belongs to. |
Bram Moolenaar | 238a564 | 2006-02-21 22:12:05 +0000 | [diff] [blame] | 7382 | |
| 7383 | When there is error while evaluating the option then it will be made |
| 7384 | empty to avoid further errors. Otherwise screen updating would loop. |
| 7385 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7386 | Note that the only effect of 'ruler' when this option is set (and |
| 7387 | 'laststatus' is 2) is controlling the output of |CTRL-G|. |
| 7388 | |
| 7389 | field meaning ~ |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7390 | - Left justify the item. The default is right justified |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7391 | when minwid is larger than the length of the item. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7392 | 0 Leading zeroes in numeric items. Overridden by '-'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7393 | minwid Minimum width of the item, padding as set by '-' & '0'. |
| 7394 | Value must be 50 or less. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7395 | maxwid Maximum width of the item. Truncation occurs with a '<' |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7396 | on the left for text items. Numeric items will be |
| 7397 | shifted down to maxwid-2 digits followed by '>'number |
| 7398 | where number is the amount of missing digits, much like |
| 7399 | an exponential notation. |
| 7400 | item A one letter code as described below. |
| 7401 | |
| 7402 | Following is a description of the possible statusline items. The |
| 7403 | second character in "item" is the type: |
| 7404 | N for number |
| 7405 | S for string |
| 7406 | F for flags as described below |
| 7407 | - not applicable |
| 7408 | |
| 7409 | item meaning ~ |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 7410 | f S Path to the file in the buffer, as typed or relative to current |
| 7411 | directory. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7412 | F S Full path to the file in the buffer. |
| 7413 | t S File name (tail) of file in the buffer. |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7414 | m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7415 | M F Modified flag, text is ",+" or ",-". |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7416 | r F Readonly flag, text is "[RO]". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7417 | R F Readonly flag, text is ",RO". |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7418 | h F Help buffer flag, text is "[help]". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7419 | H F Help buffer flag, text is ",HLP". |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7420 | w F Preview window flag, text is "[Preview]". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7421 | W F Preview window flag, text is ",PRV". |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7422 | y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7423 | Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
Bram Moolenaar | 7fd7320 | 2010-07-25 16:58:46 +0200 | [diff] [blame] | 7424 | q S "[Quickfix List]", "[Location List]" or empty. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7425 | k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 7426 | being used: "<keymap>" |
| 7427 | n N Buffer number. |
Bram Moolenaar | 0065402 | 2011-02-25 14:42:19 +0100 | [diff] [blame] | 7428 | b N Value of character under cursor. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7429 | B N As above, in hexadecimal. |
| 7430 | o N Byte number in file of byte under cursor, first byte is 1. |
| 7431 | Mnemonic: Offset from start of file (with one added) |
| 7432 | {not available when compiled without |+byte_offset| feature} |
| 7433 | O N As above, in hexadecimal. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7434 | N N Printer page number. (Only works in the 'printheader' option.) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7435 | l N Line number. |
| 7436 | L N Number of lines in buffer. |
| 7437 | c N Column number. |
| 7438 | v N Virtual column number. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7439 | 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] | 7440 | p N Percentage through file in lines as in |CTRL-G|. |
| 7441 | P S Percentage through file of displayed window. This is like the |
Bram Moolenaar | 14b6945 | 2013-06-29 23:05:20 +0200 | [diff] [blame] | 7442 | percentage described for 'ruler'. Always 3 in length, unless |
| 7443 | translated. |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7444 | a S Argument list status as in default title. ({current} of {max}) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7445 | Empty if the argument file count is zero or one. |
Bram Moolenaar | 238a564 | 2006-02-21 22:12:05 +0000 | [diff] [blame] | 7446 | { NF Evaluate expression between '%{' and '}' and substitute result. |
Bram Moolenaar | 6d150f7 | 2018-04-21 20:03:20 +0200 | [diff] [blame] | 7447 | Note that there is no '%' before the closing '}'. The |
| 7448 | expression cannot contain a '}' character, call a function to |
| 7449 | work around that. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7450 | ( - Start of item group. Can be used for setting the width and |
| 7451 | alignment of a section. Must be followed by %) somewhere. |
| 7452 | ) - End of item group. No width fields allowed. |
Bram Moolenaar | d1f56e6 | 2006-02-22 21:25:37 +0000 | [diff] [blame] | 7453 | T N For 'tabline': start of tab page N label. Use %T after the last |
| 7454 | label. This information is used for mouse clicks. |
| 7455 | X N For 'tabline': start of close tab N label. Use %X after the |
| 7456 | label, e.g.: %3Xclose%X. Use %999X for a "close current tab" |
| 7457 | mark. This information is used for mouse clicks. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7458 | < - Where to truncate line if too long. Default is at the start. |
| 7459 | No width fields allowed. |
| 7460 | = - Separation point between left and right aligned items. |
| 7461 | No width fields allowed. |
Bram Moolenaar | 238a564 | 2006-02-21 22:12:05 +0000 | [diff] [blame] | 7462 | # - Set highlight group. The name must follow and then a # again. |
| 7463 | Thus use %#HLname# for highlight group HLname. The same |
| 7464 | highlighting is used, also for the statusline of non-current |
| 7465 | windows. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7466 | * - Set highlight group to User{N}, where {N} is taken from the |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7467 | minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7468 | The difference between User{N} and StatusLine will be applied |
| 7469 | to StatusLineNC for the statusline of non-current windows. |
| 7470 | The number N must be between 1 and 9. See |hl-User1..9| |
| 7471 | |
Bram Moolenaar | e37d50a | 2008-08-06 17:06:04 +0000 | [diff] [blame] | 7472 | When displaying a flag, Vim removes the leading comma, if any, when |
| 7473 | that flag comes right after plaintext. This will make a nice display |
| 7474 | when flags are used like in the examples below. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7475 | |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7476 | 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] | 7477 | not set) and a minwid is not set for the group, the whole group will |
| 7478 | become empty. This will make a group like the following disappear |
| 7479 | completely from the statusline when none of the flags are set. > |
| 7480 | :set statusline=...%(\ [%M%R%H]%)... |
Bram Moolenaar | e392eb4 | 2015-11-19 20:38:09 +0100 | [diff] [blame] | 7481 | < *g:actual_curbuf* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7482 | Beware that an expression is evaluated each and every time the status |
| 7483 | line is displayed. The current buffer and current window will be set |
| 7484 | temporarily to that of the window (and buffer) whose statusline is |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 7485 | currently being drawn. The expression will evaluate in this context. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7486 | The variable "actual_curbuf" is set to the 'bufnr()' number of the |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 7487 | real current buffer. |
| 7488 | |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 7489 | The 'statusline' option will be evaluated in the |sandbox| if set from |
| 7490 | a modeline, see |sandbox-option|. |
Bram Moolenaar | b71eaae | 2006-01-20 23:10:18 +0000 | [diff] [blame] | 7491 | |
| 7492 | It is not allowed to change text or jump to another window while |
| 7493 | evaluating 'statusline' |textlock|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7494 | |
| 7495 | If the statusline is not updated when you want it (e.g., after setting |
| 7496 | a variable that's used in an expression), you can force an update by |
| 7497 | setting an option without changing its value. Example: > |
| 7498 | :let &ro = &ro |
| 7499 | |
| 7500 | < A result of all digits is regarded a number for display purposes. |
| 7501 | Otherwise the result is taken as flag text and applied to the rules |
| 7502 | described above. |
| 7503 | |
Bram Moolenaar | cd71fa3 | 2005-03-11 22:46:48 +0000 | [diff] [blame] | 7504 | Watch out for errors in expressions. They may render Vim unusable! |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7505 | If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and |
Bram Moolenaar | c4da113 | 2017-07-15 19:39:43 +0200 | [diff] [blame] | 7506 | edit your .vimrc or whatever with "vim --clean" to get it right. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7507 | |
| 7508 | Examples: |
| 7509 | Emulate standard status line with 'ruler' set > |
| 7510 | :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P |
| 7511 | < Similar, but add ASCII value of char under the cursor (like "ga") > |
| 7512 | :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P |
| 7513 | < Display byte count and byte value, modified flag in red. > |
| 7514 | :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' |
| 7515 | :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red |
| 7516 | < Display a ,GZ flag if a compressed file is loaded > |
| 7517 | :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... |
| 7518 | < In the |:autocmd|'s: > |
| 7519 | :let b:gzflag = 1 |
| 7520 | < And: > |
| 7521 | :unlet b:gzflag |
| 7522 | < And define this function: > |
| 7523 | :function VarExists(var, val) |
| 7524 | : if exists(a:var) | return a:val | else | return '' | endif |
| 7525 | :endfunction |
| 7526 | < |
| 7527 | *'suffixes'* *'su'* |
| 7528 | 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") |
| 7529 | global |
| 7530 | {not in Vi} |
| 7531 | Files with these suffixes get a lower priority when multiple files |
| 7532 | match a wildcard. See |suffixes|. Commas can be used to separate the |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7533 | suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 7534 | 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] | 7535 | separator, precede it with a backslash (see |option-backslash| about |
| 7536 | including spaces and backslashes). |
| 7537 | See 'wildignore' for completely ignoring files. |
| 7538 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 7539 | suffixes from the list. This avoids problems when a future version |
| 7540 | uses another default. |
| 7541 | |
| 7542 | *'suffixesadd'* *'sua'* |
| 7543 | 'suffixesadd' 'sua' string (default "") |
| 7544 | local to buffer |
| 7545 | {not in Vi} |
| 7546 | {not available when compiled without the |
| 7547 | |+file_in_path| feature} |
| 7548 | Comma separated list of suffixes, which are used when searching for a |
| 7549 | file for the "gf", "[I", etc. commands. Example: > |
| 7550 | :set suffixesadd=.java |
| 7551 | < |
| 7552 | *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* |
| 7553 | 'swapfile' 'swf' boolean (default on) |
| 7554 | local to buffer |
| 7555 | {not in Vi} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7556 | 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] | 7557 | swapfile is not wanted for a specific buffer. For example, with |
| 7558 | confidential information that even root must not be able to access. |
| 7559 | Careful: All text will be in memory: |
| 7560 | - Don't use this for big files. |
| 7561 | - Recovery will be impossible! |
| 7562 | A swapfile will only be present when |'updatecount'| is non-zero and |
| 7563 | 'swapfile' is set. |
| 7564 | When 'swapfile' is reset, the swap file for the current buffer is |
| 7565 | immediately deleted. When 'swapfile' is set, and 'updatecount' is |
| 7566 | non-zero, a swap file is immediately created. |
| 7567 | Also see |swap-file| and |'swapsync'|. |
Bram Moolenaar | 76f3b1a | 2014-03-27 22:30:07 +0100 | [diff] [blame] | 7568 | If you want to open a new buffer without creating a swap file for it, |
| 7569 | use the |:noswapfile| modifier. |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 7570 | See 'directory' for where the swap file is created. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7571 | |
| 7572 | This option is used together with 'bufhidden' and 'buftype' to |
| 7573 | specify special kinds of buffers. See |special-buffers|. |
| 7574 | |
| 7575 | *'swapsync'* *'sws'* |
| 7576 | 'swapsync' 'sws' string (default "fsync") |
| 7577 | global |
| 7578 | {not in Vi} |
| 7579 | 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] | 7580 | writing to it. This takes some time, especially on busy unix systems. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7581 | When this option is empty parts of the swap file may be in memory and |
| 7582 | not written to disk. When the system crashes you may lose more work. |
| 7583 | On Unix the system does a sync now and then without Vim asking for it, |
| 7584 | so the disadvantage of setting this option off is small. On some |
| 7585 | systems the swap file will not be written at all. For a unix system |
| 7586 | setting it to "sync" will use the sync() call instead of the default |
| 7587 | fsync(), which may work better on some systems. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 7588 | The 'fsync' option is used for the actual file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7589 | |
| 7590 | *'switchbuf'* *'swb'* |
| 7591 | 'switchbuf' 'swb' string (default "") |
| 7592 | global |
| 7593 | {not in Vi} |
| 7594 | This option controls the behavior when switching between buffers. |
| 7595 | Possible values (comma separated list): |
| 7596 | useopen If included, jump to the first open window that |
| 7597 | contains the specified buffer (if there is one). |
| 7598 | Otherwise: Do not examine other windows. |
| 7599 | This setting is checked with |quickfix| commands, when |
| 7600 | jumping to errors (":cc", ":cn", "cp", etc.). It is |
| 7601 | also used in all buffer related split commands, for |
| 7602 | example ":sbuffer", ":sbnext", or ":sbrewind". |
Bram Moolenaar | 779b74b | 2006-04-10 14:55:34 +0000 | [diff] [blame] | 7603 | usetab Like "useopen", but also consider windows in other tab |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 7604 | pages. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7605 | split If included, split the current window before loading |
Bram Moolenaar | 1514667 | 2011-10-20 22:22:38 +0200 | [diff] [blame] | 7606 | a buffer for a |quickfix| command that display errors. |
| 7607 | Otherwise: do not split, use current window. |
Bram Moolenaar | a594d77 | 2015-06-19 14:41:49 +0200 | [diff] [blame] | 7608 | vsplit Just like "split" but split vertically. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 7609 | newtab Like "split", but open a new tab page. Overrules |
Bram Moolenaar | 0bc380a | 2010-07-10 13:52:13 +0200 | [diff] [blame] | 7610 | "split" when both are present. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7611 | |
Bram Moolenaar | 3b56eb3 | 2005-07-11 22:40:32 +0000 | [diff] [blame] | 7612 | *'synmaxcol'* *'smc'* |
| 7613 | 'synmaxcol' 'smc' number (default 3000) |
| 7614 | local to buffer |
| 7615 | {not in Vi} |
| 7616 | {not available when compiled without the |+syntax| |
| 7617 | feature} |
Bram Moolenaar | ce0842a | 2005-07-18 21:58:11 +0000 | [diff] [blame] | 7618 | Maximum column in which to search for syntax items. In long lines the |
| 7619 | text after this column is not highlighted and following lines may not |
| 7620 | be highlighted correctly, because the syntax state is cleared. |
Bram Moolenaar | 3b56eb3 | 2005-07-11 22:40:32 +0000 | [diff] [blame] | 7621 | This helps to avoid very slow redrawing for an XML file that is one |
| 7622 | long line. |
| 7623 | Set to zero to remove the limit. |
| 7624 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7625 | *'syntax'* *'syn'* |
| 7626 | 'syntax' 'syn' string (default empty) |
| 7627 | local to buffer |
| 7628 | {not in Vi} |
| 7629 | {not available when compiled without the |+syntax| |
| 7630 | feature} |
| 7631 | When this option is set, the syntax with this name is loaded, unless |
| 7632 | syntax highlighting has been switched off with ":syntax off". |
| 7633 | Otherwise this option does not always reflect the current syntax (the |
| 7634 | b:current_syntax variable does). |
| 7635 | This option is most useful in a modeline, for a file which syntax is |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 7636 | not automatically recognized. Example, in an IDL file: |
| 7637 | /* vim: set syntax=idl : */ ~ |
| 7638 | When a dot appears in the value then this separates two filetype |
| 7639 | names. Example: |
| 7640 | /* vim: set syntax=c.doxygen : */ ~ |
| 7641 | This will use the "c" syntax first, then the "doxygen" syntax. |
| 7642 | Note that the second one must be prepared to be loaded as an addition, |
| 7643 | otherwise it will be skipped. More than one dot may appear. |
| 7644 | To switch off syntax highlighting for the current file, use: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7645 | :set syntax=OFF |
| 7646 | < To switch syntax highlighting on according to the current value of the |
| 7647 | 'filetype' option: > |
| 7648 | :set syntax=ON |
| 7649 | < What actually happens when setting the 'syntax' option is that the |
| 7650 | Syntax autocommand event is triggered with the value as argument. |
| 7651 | This option is not copied to another buffer, independent of the 's' or |
| 7652 | 'S' flag in 'cpoptions'. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 7653 | Only normal file name characters can be used, "/\*?[|<>" are illegal. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7654 | |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 7655 | *'tabline'* *'tal'* |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7656 | 'tabline' 'tal' string (default empty) |
Bram Moolenaar | 7e8fd63 | 2006-02-18 22:14:51 +0000 | [diff] [blame] | 7657 | global |
| 7658 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 7659 | {not available when compiled without the |+windows| |
Bram Moolenaar | 7e8fd63 | 2006-02-18 22:14:51 +0000 | [diff] [blame] | 7660 | feature} |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7661 | When nonempty, this option determines the content of the tab pages |
| 7662 | line at the top of the Vim window. When empty Vim will use a default |
Bram Moolenaar | d1f56e6 | 2006-02-22 21:25:37 +0000 | [diff] [blame] | 7663 | tab pages line. See |setting-tabline| for more info. |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7664 | |
| 7665 | The tab pages line only appears as specified with the 'showtabline' |
Bram Moolenaar | 5c8837f | 2006-02-25 21:52:33 +0000 | [diff] [blame] | 7666 | option and only when there is no GUI tab line. When 'e' is in |
| 7667 | 'guioptions' and the GUI supports a tab line 'guitablabel' is used |
Bram Moolenaar | 7f03644 | 2010-08-15 15:24:20 +0200 | [diff] [blame] | 7668 | instead. Note that the two tab pages lines are very different. |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7669 | |
| 7670 | The value is evaluated like with 'statusline'. You can use |
| 7671 | |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out |
Bram Moolenaar | d1f56e6 | 2006-02-22 21:25:37 +0000 | [diff] [blame] | 7672 | the text to be displayed. Use "%1T" for the first label, "%2T" for |
| 7673 | the second one, etc. Use "%X" items for closing labels. |
Bram Moolenaar | faa959a | 2006-02-20 21:37:40 +0000 | [diff] [blame] | 7674 | |
| 7675 | Keep in mind that only one of the tab pages is the current one, others |
| 7676 | are invisible and you can't jump to their windows. |
| 7677 | |
Bram Moolenaar | 7e8fd63 | 2006-02-18 22:14:51 +0000 | [diff] [blame] | 7678 | |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 7679 | *'tabpagemax'* *'tpm'* |
| 7680 | 'tabpagemax' 'tpm' number (default 10) |
| 7681 | global |
| 7682 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 7683 | {not available when compiled without the |+windows| |
Bram Moolenaar | fd2ac76 | 2006-03-01 22:09:21 +0000 | [diff] [blame] | 7684 | feature} |
| 7685 | Maximum number of tab pages to be opened by the |-p| command line |
| 7686 | argument or the ":tab all" command. |tabpage| |
| 7687 | |
| 7688 | |
| 7689 | *'tabstop'* *'ts'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7690 | 'tabstop' 'ts' number (default 8) |
| 7691 | local to buffer |
| 7692 | Number of spaces that a <Tab> in the file counts for. Also see |
| 7693 | |:retab| command, and 'softtabstop' option. |
| 7694 | |
| 7695 | Note: Setting 'tabstop' to any other value than 8 can make your file |
| 7696 | appear wrong in many places (e.g., when printing it). |
| 7697 | |
| 7698 | There are four main ways to use tabs in Vim: |
| 7699 | 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 |
| 7700 | (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim |
Bram Moolenaar | ebcbd02 | 2007-05-12 14:28:25 +0000 | [diff] [blame] | 7701 | will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7702 | behave like a tab appears every 4 (or 3) characters. |
| 7703 | 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use |
| 7704 | 'expandtab'. This way you will always insert spaces. The |
| 7705 | formatting will never be messed up when 'tabstop' is changed. |
| 7706 | 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7707 | |modeline| to set these values when editing the file again. Only |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7708 | works when using Vim to edit the file. |
| 7709 | 4. Always set 'tabstop' and 'shiftwidth' to the same value, and |
| 7710 | 'noexpandtab'. This should then work (for initial indents only) |
| 7711 | for any tabstop setting that people use. It might be nice to have |
| 7712 | tabs after the first non-blank inserted as spaces if you do this |
| 7713 | though. Otherwise aligned comments will be wrong when 'tabstop' is |
| 7714 | changed. |
| 7715 | |
| 7716 | *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* |
| 7717 | 'tagbsearch' 'tbs' boolean (default on) |
| 7718 | global |
| 7719 | {not in Vi} |
| 7720 | 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] | 7721 | 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] | 7722 | searching makes searching for a tag a LOT faster, but a linear search |
| 7723 | will find more tags if the tags file wasn't properly sorted. |
| 7724 | Vim normally assumes that your tags files are sorted, or indicate that |
| 7725 | they are not sorted. Only when this is not the case does the |
| 7726 | 'tagbsearch' option need to be switched off. |
| 7727 | |
| 7728 | When 'tagbsearch' is on, binary searching is first used in the tags |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 7729 | files. In certain situations, Vim will do a linear search instead for |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7730 | certain files, or retry all files with a linear search. When |
| 7731 | 'tagbsearch' is off, only a linear search is done. |
| 7732 | |
| 7733 | Linear searching is done anyway, for one file, when Vim finds a line |
| 7734 | at the start of the file indicating that it's not sorted: > |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 7735 | !_TAG_FILE_SORTED 0 /some comment/ |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7736 | < [The whitespace before and after the '0' must be a single <Tab>] |
| 7737 | |
| 7738 | When a binary search was done and no match was found in any of the |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 7739 | files listed in 'tags', and case is ignored or a pattern is used |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7740 | instead of a normal tag name, a retry is done with a linear search. |
| 7741 | Tags in unsorted tags files, and matches with different case will only |
| 7742 | be found in the retry. |
| 7743 | |
Bram Moolenaar | d4755bb | 2004-09-02 19:12:26 +0000 | [diff] [blame] | 7744 | If a tag file indicates that it is case-fold sorted, the second, |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 7745 | linear search can be avoided when case is ignored. Use a value of '2' |
| 7746 | in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold |
| 7747 | sorted with the -f switch to "sort" in most unices, as in the command: |
| 7748 | "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher |
| 7749 | (at least 5.5) the --sort=foldcase switch can be used for this as |
| 7750 | well. Note that case must be folded to uppercase for this to work. |
| 7751 | |
| 7752 | By default, tag searches are case-sensitive. Case is ignored when |
| 7753 | 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is |
| 7754 | "ignore". |
Bram Moolenaar | 66e29d7 | 2016-08-20 16:57:02 +0200 | [diff] [blame] | 7755 | Also when 'tagcase' is "followscs" and 'smartcase' is set, or |
| 7756 | 'tagcase' is "smart", and the pattern contains only lowercase |
| 7757 | characters. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7758 | |
| 7759 | When 'tagbsearch' is off, tags searching is slower when a full match |
| 7760 | exists, but faster when no full match exists. Tags in unsorted tags |
| 7761 | files may only be found with 'tagbsearch' off. |
| 7762 | When the tags file is not sorted, or sorted in a wrong way (not on |
| 7763 | ASCII byte value), 'tagbsearch' should be off, or the line given above |
| 7764 | must be included in the tags file. |
| 7765 | This option doesn't affect commands that find all matching tags (e.g., |
| 7766 | command-line completion and ":help"). |
| 7767 | {Vi: always uses binary search in some versions} |
| 7768 | |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 7769 | *'tagcase'* *'tc'* |
| 7770 | 'tagcase' 'tc' string (default "followic") |
| 7771 | global or local to buffer |global-local| |
| 7772 | {not in Vi} |
| 7773 | This option specifies how case is handled when searching the tags |
| 7774 | file: |
| 7775 | followic Follow the 'ignorecase' option |
Bram Moolenaar | 66e29d7 | 2016-08-20 16:57:02 +0200 | [diff] [blame] | 7776 | followscs Follow the 'smartcase' and 'ignorecase' options |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 7777 | ignore Ignore case |
| 7778 | match Match case |
Bram Moolenaar | 66e29d7 | 2016-08-20 16:57:02 +0200 | [diff] [blame] | 7779 | smart Ignore case unless an upper case letter is used |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 7780 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 7781 | set and to the Vim default value when 'compatible' is reset. |
Bram Moolenaar | 0f6562e | 2015-11-24 18:48:14 +0100 | [diff] [blame] | 7782 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7783 | *'taglength'* *'tl'* |
| 7784 | 'taglength' 'tl' number (default 0) |
| 7785 | global |
| 7786 | If non-zero, tags are significant up to this number of characters. |
| 7787 | |
| 7788 | *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* |
| 7789 | 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) |
| 7790 | global |
| 7791 | {not in Vi} |
Bram Moolenaar | c6fe919 | 2006-04-09 21:54:49 +0000 | [diff] [blame] | 7792 | If on and using a tags file in another directory, file names in that |
| 7793 | tags file are relative to the directory where the tags file is. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7794 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 7795 | set and to the Vim default value when 'compatible' is reset. |
| 7796 | |
| 7797 | *'tags'* *'tag'* *E433* |
| 7798 | 'tags' 'tag' string (default "./tags,tags", when compiled with |
| 7799 | |+emacs_tags|: "./tags,./TAGS,tags,TAGS") |
| 7800 | global or local to buffer |global-local| |
| 7801 | Filenames for the tag command, separated by spaces or commas. To |
| 7802 | include a space or comma in a file name, precede it with a backslash |
| 7803 | (see |option-backslash| about including spaces and backslashes). |
| 7804 | When a file name starts with "./", the '.' is replaced with the path |
| 7805 | of the current file. But only when the 'd' flag is not included in |
| 7806 | 'cpoptions'. Environment variables are expanded |:set_env|. Also see |
| 7807 | |tags-option|. |
| 7808 | "*", "**" and other wildcards can be used to search for tags files in |
Bram Moolenaar | e2b590e | 2010-08-08 18:29:48 +0200 | [diff] [blame] | 7809 | a directory tree. See |file-searching|. E.g., "/lib/**/tags" will |
| 7810 | find all files named "tags" below "/lib". The filename itself cannot |
| 7811 | contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
| 7812 | files called "tags?". {not available when compiled without the |
| 7813 | |+path_extra| feature} |
Bram Moolenaar | e7eb9df | 2005-09-09 19:49:30 +0000 | [diff] [blame] | 7814 | The |tagfiles()| function can be used to get a list of the file names |
| 7815 | actually used. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7816 | If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 7817 | files are also supported. They are automatically recognized. The |
| 7818 | default value becomes "./tags,./TAGS,tags,TAGS", unless case |
| 7819 | differences are ignored (MS-Windows). |emacs-tags| |
| 7820 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 7821 | file names from the list. This avoids problems when a future version |
| 7822 | uses another default. |
| 7823 | {Vi: default is "tags /usr/lib/tags"} |
| 7824 | |
| 7825 | *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* |
| 7826 | 'tagstack' 'tgst' boolean (default on) |
| 7827 | global |
| 7828 | {not in all versions of Vi} |
| 7829 | When on, the |tagstack| is used normally. When off, a ":tag" or |
| 7830 | ":tselect" command with an argument will not push the tag onto the |
| 7831 | tagstack. A following ":tag" without an argument, a ":pop" command or |
| 7832 | any other command that uses the tagstack will use the unmodified |
| 7833 | tagstack, but does change the pointer to the active entry. |
| 7834 | Resetting this option is useful when using a ":tag" command in a |
| 7835 | mapping which should not change the tagstack. |
| 7836 | |
Bram Moolenaar | 8a5115c | 2016-01-09 19:41:11 +0100 | [diff] [blame] | 7837 | *'tcldll'* |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 7838 | 'tcldll' string (default depends on the build) |
Bram Moolenaar | 8a5115c | 2016-01-09 19:41:11 +0100 | [diff] [blame] | 7839 | global |
| 7840 | {not in Vi} |
| 7841 | {only available when compiled with the |+tcl/dyn| |
| 7842 | feature} |
| 7843 | Specifies the name of the Tcl shared library. The default is |
| 7844 | DYNAMIC_TCL_DLL, which was specified at compile time. |
Bram Moolenaar | aa3b15d | 2016-04-21 08:53:19 +0200 | [diff] [blame] | 7845 | Environment variables are expanded |:set_env|. |
Bram Moolenaar | 8a5115c | 2016-01-09 19:41:11 +0100 | [diff] [blame] | 7846 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7847 | security reasons. |
| 7848 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7849 | *'term'* *E529* *E530* *E531* |
| 7850 | 'term' string (default is $TERM, if that fails: |
| 7851 | in the GUI: "builtin_gui" |
| 7852 | on Amiga: "amiga" |
| 7853 | on BeOS: "beos-ansi" |
| 7854 | on Mac: "mac-ansi" |
| 7855 | on MiNT: "vt52" |
| 7856 | on MS-DOS: "pcterm" |
| 7857 | on OS/2: "os2ansi" |
| 7858 | on Unix: "ansi" |
| 7859 | on VMS: "ansi" |
| 7860 | on Win 32: "win32") |
| 7861 | global |
| 7862 | Name of the terminal. Used for choosing the terminal control |
| 7863 | characters. Environment variables are expanded |:set_env|. |
| 7864 | For example: > |
| 7865 | :set term=$TERM |
| 7866 | < See |termcap|. |
| 7867 | |
| 7868 | *'termbidi'* *'tbidi'* |
| 7869 | *'notermbidi'* *'notbidi'* |
| 7870 | 'termbidi' 'tbidi' boolean (default off, on for "mlterm") |
| 7871 | global |
| 7872 | {not in Vi} |
| 7873 | {only available when compiled with the |+arabic| |
| 7874 | feature} |
| 7875 | The terminal is in charge of Bi-directionality of text (as specified |
| 7876 | by Unicode). The terminal is also expected to do the required shaping |
| 7877 | that some languages (such as Arabic) require. |
| 7878 | Setting this option implies that 'rightleft' will not be set when |
| 7879 | 'arabic' is set and the value of 'arabicshape' will be ignored. |
| 7880 | Note that setting 'termbidi' has the immediate effect that |
| 7881 | 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. |
| 7882 | This option is reset when the GUI is started. |
| 7883 | For further details see |arabic.txt|. |
| 7884 | |
| 7885 | *'termencoding'* *'tenc'* |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 7886 | 'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7887 | Macintosh GUI: "macroman") |
| 7888 | global |
| 7889 | {only available when compiled with the |+multi_byte| |
| 7890 | feature} |
| 7891 | {not in Vi} |
| 7892 | Encoding used for the terminal. This specifies what character |
| 7893 | encoding the keyboard produces and the display will understand. For |
Bram Moolenaar | 3848e00 | 2016-03-19 18:42:29 +0100 | [diff] [blame] | 7894 | the GUI it only applies to the keyboard ('encoding' is used for the |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 7895 | display). Except for the Mac when 'macatsui' is off, then |
| 7896 | 'termencoding' should be "macroman". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7897 | *E617* |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 7898 | Note: This does not apply to the GTK+ GUI. After the GUI has been |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7899 | successfully initialized, 'termencoding' is forcibly set to "utf-8". |
| 7900 | Any attempts to set a different value will be rejected, and an error |
| 7901 | message is shown. |
Bram Moolenaar | ac360bf | 2015-09-01 20:31:20 +0200 | [diff] [blame] | 7902 | For the Win32 GUI and console versions 'termencoding' is not used, |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7903 | because the Win32 system always passes Unicode characters. |
| 7904 | When empty, the same encoding is used as for the 'encoding' option. |
| 7905 | This is the normal value. |
| 7906 | Not all combinations for 'termencoding' and 'encoding' are valid. See |
| 7907 | |encoding-table|. |
| 7908 | The value for this option must be supported by internal conversions or |
| 7909 | iconv(). When this is not possible no conversion will be done and you |
| 7910 | will probably experience problems with non-ASCII characters. |
| 7911 | Example: You are working with the locale set to euc-jp (Japanese) and |
| 7912 | want to edit a UTF-8 file: > |
| 7913 | :let &termencoding = &encoding |
| 7914 | :set encoding=utf-8 |
| 7915 | < You need to do this when your system has no locale support for UTF-8. |
| 7916 | |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 7917 | *'termguicolors'* *'tgc'* *E954* |
Bram Moolenaar | 61be73b | 2016-04-29 22:59:22 +0200 | [diff] [blame] | 7918 | 'termguicolors' 'tgc' boolean (default off) |
| 7919 | global |
| 7920 | {not in Vi} |
| 7921 | {not available when compiled without the |
| 7922 | |+termguicolors| feature} |
| 7923 | When on, uses |highlight-guifg| and |highlight-guibg| attributes in |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 7924 | the terminal (thus using 24-bit color). |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 7925 | |
Bram Moolenaar | cafafb3 | 2018-02-22 21:07:09 +0100 | [diff] [blame] | 7926 | Requires a ISO-8613-3 compatible terminal. If setting this option |
| 7927 | does not work (produces a colorless UI) reading |xterm-true-color| |
| 7928 | might help. |
| 7929 | |
| 7930 | For Win32 console, Windows 10 version 1703 (Creators Update) or later |
| 7931 | is required. Use this check to find out: > |
| 7932 | if has('vcon') |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 7933 | < This requires Vim to be built with the |+vtp| feature. |
| 7934 | |
Bram Moolenaar | 6aa8cea | 2017-06-05 14:44:35 +0200 | [diff] [blame] | 7935 | Note that the "cterm" attributes are still used, not the "gui" ones. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 7936 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 61be73b | 2016-04-29 22:59:22 +0200 | [diff] [blame] | 7937 | |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 7938 | *'termwinscroll'* *'twsl'* |
| 7939 | 'termwinscroll' 'twsl' number (default 10000) |
| 7940 | local to buffer |
Bram Moolenaar | 8c041b6 | 2018-04-14 18:14:06 +0200 | [diff] [blame] | 7941 | {not in Vi} |
| 7942 | {not available when compiled without the |
| 7943 | |+terminal| feature} |
| 7944 | Number of scrollback lines to keep. When going over this limit the |
| 7945 | first 10% of the scrollback lines are deleted. This is just to reduce |
| 7946 | the memory usage. See |Terminal-Normal|. |
| 7947 | |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 7948 | *'termwinkey'* *'twk'* |
| 7949 | 'termwinkey' 'twk' string (default "") |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7950 | local to window |
| 7951 | {not in Vi} |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 7952 | The key that starts a CTRL-W command in a terminal window. Other keys |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7953 | are sent to the job running in the window. |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 7954 | The <> notation can be used, e.g.: > |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 7955 | :set termwinkey=<C-L> |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 7956 | < The string must be one key stroke but can be multiple bytes. |
| 7957 | When not set CTRL-W is used, so that CTRL-W : gets you to the command |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 7958 | line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 7959 | command line. |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7960 | |
Bram Moolenaar | 7dda86f | 2018-04-20 22:36:41 +0200 | [diff] [blame] | 7961 | *'termwinsize'* *'tws'* |
| 7962 | 'termwinsize' 'tws' string (default "") |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7963 | local to window |
| 7964 | {not in Vi} |
Bram Moolenaar | 498c256 | 2018-04-15 23:45:15 +0200 | [diff] [blame] | 7965 | Size of the |terminal| window. Format: {rows}x{columns} or |
| 7966 | {rows}*{columns}. |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7967 | - When empty the terminal gets the size from the window. |
Bram Moolenaar | 498c256 | 2018-04-15 23:45:15 +0200 | [diff] [blame] | 7968 | - When set with a "x" (e.g., "24x80") the terminal size is not |
| 7969 | adjusted to the window size. If the window is smaller only the |
| 7970 | top-left part is displayed. |
| 7971 | - When set with a "*" (e.g., "10*50") the terminal size follows the |
| 7972 | window size, but will not be smaller than the specified rows and/or |
| 7973 | columns. |
| 7974 | - When rows is zero then use the height of the window. |
| 7975 | - When columns is zero then use the width of the window. |
| 7976 | - Using "0x0" or "0*0" is the same as empty. |
| 7977 | |
| 7978 | Examples: |
| 7979 | "30x0" uses 30 rows and the current window width. |
| 7980 | "20*0" uses at least 20 rows and the current window width. |
| 7981 | "0*40" uses the current window height and at least 40 columns. |
Bram Moolenaar | 1f2903c | 2017-07-23 19:51:01 +0200 | [diff] [blame] | 7982 | Note that the command running in the terminal window may still change |
| 7983 | the size of the terminal. In that case the Vim window will be |
| 7984 | adjusted to that size, if possible. |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 7985 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 7986 | *'terse'* *'noterse'* |
| 7987 | 'terse' boolean (default off) |
| 7988 | global |
| 7989 | When set: Add 's' flag to 'shortmess' option (this makes the message |
| 7990 | for a search that hits the start or end of the file not being |
| 7991 | displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi |
| 7992 | shortens a lot of messages} |
| 7993 | |
| 7994 | *'textauto'* *'ta'* *'notextauto'* *'nota'* |
| 7995 | 'textauto' 'ta' boolean (Vim default: on, Vi default: off) |
| 7996 | global |
| 7997 | {not in Vi} |
| 7998 | This option is obsolete. Use 'fileformats'. |
| 7999 | For backwards compatibility, when 'textauto' is set, 'fileformats' is |
| 8000 | set to the default value for the current system. When 'textauto' is |
| 8001 | reset, 'fileformats' is made empty. |
| 8002 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 8003 | set and to the Vim default value when 'compatible' is reset. |
| 8004 | |
| 8005 | *'textmode'* *'tx'* *'notextmode'* *'notx'* |
| 8006 | 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, |
| 8007 | others: default off) |
| 8008 | local to buffer |
| 8009 | {not in Vi} |
| 8010 | This option is obsolete. Use 'fileformat'. |
| 8011 | For backwards compatibility, when 'textmode' is set, 'fileformat' is |
| 8012 | set to "dos". When 'textmode' is reset, 'fileformat' is set to |
| 8013 | "unix". |
| 8014 | |
| 8015 | *'textwidth'* *'tw'* |
| 8016 | 'textwidth' 'tw' number (default 0) |
| 8017 | local to buffer |
| 8018 | {not in Vi} |
| 8019 | Maximum width of text that is being inserted. A longer line will be |
| 8020 | broken after white space to get this width. A zero value disables |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 8021 | this. |
| 8022 | 'textwidth' is set to 0 when the 'paste' option is set and restored |
| 8023 | when 'paste' is reset. |
| 8024 | When 'textwidth' is zero, 'wrapmargin' may be used. See also |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8025 | 'formatoptions' and |ins-textwidth|. |
Bram Moolenaar | fc1421e | 2006-04-20 22:17:20 +0000 | [diff] [blame] | 8026 | When 'formatexpr' is set it will be used to break the line. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8027 | NOTE: This option is set to 0 when 'compatible' is set. |
| 8028 | |
| 8029 | *'thesaurus'* *'tsr'* |
| 8030 | 'thesaurus' 'tsr' string (default "") |
| 8031 | global or local to buffer |global-local| |
| 8032 | {not in Vi} |
| 8033 | 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] | 8034 | for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8035 | the file should contain words with similar meaning, separated by |
| 8036 | non-keyword characters (white space is preferred). Maximum line |
| 8037 | length is 510 bytes. |
Bram Moolenaar | 9a7224b | 2012-04-30 15:56:52 +0200 | [diff] [blame] | 8038 | To obtain a file to be used here, check out this ftp site: |
Bram Moolenaar | 22f1d0e | 2018-02-27 14:53:30 +0100 | [diff] [blame] | 8039 | [Sorry this link doesn't work anymore, do you know the right one?] |
Bram Moolenaar | 9a7224b | 2012-04-30 15:56:52 +0200 | [diff] [blame] | 8040 | ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file. |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8041 | 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] | 8042 | after a comma are ignored, otherwise spaces are included in the file |
| 8043 | name. See |option-backslash| about using backslashes. |
| 8044 | The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 8045 | directories from the list. This avoids problems when a future version |
| 8046 | uses another default. |
| 8047 | Backticks cannot be used in this option for security reasons. |
| 8048 | |
| 8049 | *'tildeop'* *'top'* *'notildeop'* *'notop'* |
| 8050 | 'tildeop' 'top' boolean (default off) |
| 8051 | global |
| 8052 | {not in Vi} |
| 8053 | When on: The tilde command "~" behaves like an operator. |
| 8054 | NOTE: This option is reset when 'compatible' is set. |
| 8055 | |
| 8056 | *'timeout'* *'to'* *'notimeout'* *'noto'* |
| 8057 | 'timeout' 'to' boolean (default on) |
| 8058 | global |
| 8059 | *'ttimeout'* *'nottimeout'* |
Bram Moolenaar | 9423749 | 2017-04-23 18:40:21 +0200 | [diff] [blame] | 8060 | 'ttimeout' boolean (default off, set in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8061 | global |
| 8062 | {not in Vi} |
| 8063 | These two options together determine the behavior when part of a |
| 8064 | mapped key sequence or keyboard code has been received: |
| 8065 | |
| 8066 | 'timeout' 'ttimeout' action ~ |
| 8067 | off off do not time out |
| 8068 | on on or off time out on :mappings and key codes |
| 8069 | off on time out on key codes |
| 8070 | |
| 8071 | If both options are off, Vim will wait until either the complete |
| 8072 | mapping or key sequence has been received, or it is clear that there |
| 8073 | is no mapping or key sequence for the received characters. For |
| 8074 | example: if you have mapped "vl" and Vim has received 'v', the next |
| 8075 | character is needed to see if the 'v' is followed by an 'l'. |
| 8076 | When one of the options is on, Vim will wait for about 1 second for |
| 8077 | the next character to arrive. After that the already received |
| 8078 | characters are interpreted as single characters. The waiting time can |
| 8079 | be changed with the 'timeoutlen' option. |
| 8080 | On slow terminals or very busy systems timing out may cause |
| 8081 | malfunctioning cursor keys. If both options are off, Vim waits |
| 8082 | forever after an entered <Esc> if there are key codes that start |
| 8083 | with <Esc>. You will have to type <Esc> twice. If you do not have |
| 8084 | problems with key codes, but would like to have :mapped key |
| 8085 | sequences not timing out in 1 second, set the 'ttimeout' option and |
| 8086 | reset the 'timeout' option. |
| 8087 | |
| 8088 | NOTE: 'ttimeout' is reset when 'compatible' is set. |
| 8089 | |
| 8090 | *'timeoutlen'* *'tm'* |
| 8091 | 'timeoutlen' 'tm' number (default 1000) |
| 8092 | global |
| 8093 | {not in all versions of Vi} |
| 8094 | *'ttimeoutlen'* *'ttm'* |
Bram Moolenaar | 9423749 | 2017-04-23 18:40:21 +0200 | [diff] [blame] | 8095 | 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8096 | global |
| 8097 | {not in Vi} |
| 8098 | The time in milliseconds that is waited for a key code or mapped key |
| 8099 | sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G |
| 8100 | when part of a command has been typed. |
| 8101 | Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a |
| 8102 | different timeout value for key codes is desired set 'ttimeoutlen' to |
| 8103 | a non-negative number. |
| 8104 | |
| 8105 | ttimeoutlen mapping delay key code delay ~ |
| 8106 | < 0 'timeoutlen' 'timeoutlen' |
| 8107 | >= 0 'timeoutlen' 'ttimeoutlen' |
| 8108 | |
| 8109 | The timeout only happens when the 'timeout' and 'ttimeout' options |
| 8110 | tell so. A useful setting would be > |
| 8111 | :set timeout timeoutlen=3000 ttimeoutlen=100 |
| 8112 | < (time out on mapping after three seconds, time out on key codes after |
| 8113 | a tenth of a second). |
| 8114 | |
| 8115 | *'title'* *'notitle'* |
| 8116 | 'title' boolean (default off, on when title can be restored) |
| 8117 | global |
| 8118 | {not in Vi} |
| 8119 | {not available when compiled without the |+title| |
| 8120 | feature} |
| 8121 | When on, the title of the window will be set to the value of |
| 8122 | 'titlestring' (if it is not empty), or to: |
| 8123 | filename [+=-] (path) - VIM |
| 8124 | Where: |
| 8125 | filename the name of the file being edited |
| 8126 | - indicates the file cannot be modified, 'ma' off |
| 8127 | + indicates the file was modified |
| 8128 | = indicates the file is read-only |
| 8129 | =+ indicates the file is read-only and modified |
| 8130 | (path) is the path of the file being edited |
| 8131 | - VIM the server name |v:servername| or "VIM" |
| 8132 | Only works if the terminal supports setting window titles |
| 8133 | (currently Amiga console, Win32 console, all GUI versions and |
| 8134 | terminals with a non- empty 't_ts' option - these are Unix xterm and |
| 8135 | iris-ansi by default, where 't_ts' is taken from the builtin termcap). |
| 8136 | *X11* |
| 8137 | When Vim was compiled with HAVE_X11 defined, the original title will |
| 8138 | be restored if possible. The output of ":version" will include "+X11" |
| 8139 | when HAVE_X11 was defined, otherwise it will be "-X11". This also |
| 8140 | works for the icon name |'icon'|. |
| 8141 | But: When Vim was started with the |-X| argument, restoring the title |
| 8142 | will not work (except in the GUI). |
| 8143 | If the title cannot be restored, it is set to the value of 'titleold'. |
| 8144 | You might want to restore the title outside of Vim then. |
| 8145 | When using an xterm from a remote machine you can use this command: |
| 8146 | rsh machine_name xterm -display $DISPLAY & |
| 8147 | then the WINDOWID environment variable should be inherited and the |
| 8148 | title of the window should change back to what it should be after |
| 8149 | exiting Vim. |
| 8150 | |
| 8151 | *'titlelen'* |
| 8152 | 'titlelen' number (default 85) |
| 8153 | global |
| 8154 | {not in Vi} |
| 8155 | {not available when compiled without the |+title| |
| 8156 | feature} |
| 8157 | 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] | 8158 | title. When the title is longer, only the end of the path name is |
| 8159 | shown. A '<' character before the path name is used to indicate this. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8160 | Using a percentage makes this adapt to the width of the window. But |
| 8161 | it won't work perfectly, because the actual number of characters |
| 8162 | available also depends on the font used and other things in the title |
| 8163 | bar. When 'titlelen' is zero the full path is used. Otherwise, |
| 8164 | values from 1 to 30000 percent can be used. |
| 8165 | 'titlelen' is also used for the 'titlestring' option. |
| 8166 | |
| 8167 | *'titleold'* |
| 8168 | 'titleold' string (default "Thanks for flying Vim") |
| 8169 | global |
| 8170 | {not in Vi} |
| 8171 | {only available when compiled with the |+title| |
| 8172 | feature} |
| 8173 | This option will be used for the window title when exiting Vim if the |
| 8174 | original title cannot be restored. Only happens if 'title' is on or |
| 8175 | 'titlestring' is not empty. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 8176 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8177 | security reasons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8178 | *'titlestring'* |
| 8179 | 'titlestring' string (default "") |
| 8180 | global |
| 8181 | {not in Vi} |
| 8182 | {not available when compiled without the |+title| |
| 8183 | feature} |
| 8184 | When this option is not empty, it will be used for the title of the |
| 8185 | window. This happens only when the 'title' option is on. |
| 8186 | Only works if the terminal supports setting window titles (currently |
| 8187 | Amiga console, Win32 console, all GUI versions and terminals with a |
| 8188 | non-empty 't_ts' option). |
| 8189 | When Vim was compiled with HAVE_X11 defined, the original title will |
Bram Moolenaar | 5162822 | 2016-12-01 23:03:28 +0100 | [diff] [blame] | 8190 | be restored if possible, see |X11|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8191 | When this option contains printf-style '%' items, they will be |
| 8192 | expanded according to the rules used for 'statusline'. |
| 8193 | Example: > |
| 8194 | :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") |
| 8195 | :set title titlestring=%<%F%=%l/%L-%P titlelen=70 |
| 8196 | < The value of 'titlelen' is used to align items in the middle or right |
| 8197 | of the available space. |
| 8198 | Some people prefer to have the file name first: > |
| 8199 | :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) |
| 8200 | < 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] | 8201 | without the file name. The "%( %)" constructs are used to add a |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8202 | separating space only when needed. |
| 8203 | NOTE: Use of special characters in 'titlestring' may cause the display |
| 8204 | to be garbled (e.g., when it contains a CR or NL character). |
| 8205 | {not available when compiled without the |+statusline| feature} |
| 8206 | |
| 8207 | *'toolbar'* *'tb'* |
| 8208 | 'toolbar' 'tb' string (default "icons,tooltips") |
| 8209 | global |
| 8210 | {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and |
| 8211 | |+GUI_Photon|} |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8212 | The contents of this option controls various toolbar settings. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8213 | possible values are: |
| 8214 | icons Toolbar buttons are shown with icons. |
| 8215 | text Toolbar buttons shown with text. |
| 8216 | horiz Icon and text of a toolbar button are |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8217 | horizontally arranged. {only in GTK+ 2 GUI} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8218 | tooltips Tooltips are active for toolbar buttons. |
| 8219 | Tooltips refer to the popup help text which appears after the mouse |
| 8220 | cursor is placed over a toolbar button for a brief moment. |
| 8221 | |
| 8222 | If you want the toolbar to be shown with icons as well as text, do the |
| 8223 | following: > |
| 8224 | :set tb=icons,text |
| 8225 | < Motif and Athena cannot display icons and text at the same time. They |
| 8226 | will show icons if both are requested. |
| 8227 | |
| 8228 | If none of the strings specified in 'toolbar' are valid or if |
| 8229 | 'toolbar' is empty, this option is ignored. If you want to disable |
| 8230 | the toolbar, you need to set the 'guioptions' option. For example: > |
| 8231 | :set guioptions-=T |
| 8232 | < Also see |gui-toolbar|. |
| 8233 | |
| 8234 | *'toolbariconsize'* *'tbis'* |
| 8235 | 'toolbariconsize' 'tbis' string (default "small") |
| 8236 | global |
| 8237 | {not in Vi} |
Bram Moolenaar | 3df0173 | 2017-02-17 22:47:16 +0100 | [diff] [blame] | 8238 | {only in the GTK+ GUI} |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8239 | Controls the size of toolbar icons. The possible values are: |
Bram Moolenaar | 77cdfd1 | 2016-03-12 12:57:59 +0100 | [diff] [blame] | 8240 | tiny Use tiny icons. |
| 8241 | small Use small icons (default). |
| 8242 | medium Use medium-sized icons. |
| 8243 | large Use large icons. |
| 8244 | huge Use even larger icons. |
| 8245 | giant Use very big icons. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8246 | The exact dimensions in pixels of the various icon sizes depend on |
Bram Moolenaar | 77cdfd1 | 2016-03-12 12:57:59 +0100 | [diff] [blame] | 8247 | the current theme. Common dimensions are giant=48x48, huge=32x32, |
| 8248 | large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8249 | |
| 8250 | If 'toolbariconsize' is empty, the global default size as determined |
| 8251 | by user preferences or the current theme is used. |
| 8252 | |
| 8253 | *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* |
| 8254 | 'ttybuiltin' 'tbi' boolean (default on) |
| 8255 | global |
| 8256 | {not in Vi} |
| 8257 | When on, the builtin termcaps are searched before the external ones. |
| 8258 | When off the builtin termcaps are searched after the external ones. |
| 8259 | When this option is changed, you should set the 'term' option next for |
| 8260 | the change to take effect, for example: > |
| 8261 | :set notbi term=$TERM |
| 8262 | < See also |termcap|. |
| 8263 | Rationale: The default for this option is "on", because the builtin |
| 8264 | termcap entries are generally better (many systems contain faulty |
| 8265 | xterm entries...). |
| 8266 | |
| 8267 | *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* |
| 8268 | 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, |
| 8269 | sun-cmd, screen, rxvt, dtterm or |
| 8270 | iris-ansi; also on when running Vim in |
| 8271 | a DOS console) |
| 8272 | global |
| 8273 | {not in Vi} |
| 8274 | Indicates a fast terminal connection. More characters will be sent to |
| 8275 | the screen for redrawing, instead of using insert/delete line |
| 8276 | commands. Improves smoothness of redrawing when there are multiple |
| 8277 | windows and the terminal does not support a scrolling region. |
| 8278 | Also enables the extra writing of characters at the end of each screen |
| 8279 | line for lines that wrap. This helps when using copy/paste with the |
| 8280 | mouse in an xterm and other terminals. |
| 8281 | |
| 8282 | *'ttymouse'* *'ttym'* |
| 8283 | 'ttymouse' 'ttym' string (default depends on 'term') |
| 8284 | global |
| 8285 | {not in Vi} |
| 8286 | {only in Unix and VMS, doesn't work in the GUI; not |
| 8287 | available when compiled without |+mouse|} |
| 8288 | Name of the terminal type for which mouse codes are to be recognized. |
Bram Moolenaar | 2c7a763 | 2007-05-10 18:19:11 +0000 | [diff] [blame] | 8289 | Currently these strings are valid: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8290 | *xterm-mouse* |
| 8291 | xterm xterm-like mouse handling. The mouse generates |
| 8292 | "<Esc>[Mscr", where "scr" is three bytes: |
| 8293 | "s" = button state |
| 8294 | "c" = column plus 33 |
| 8295 | "r" = row plus 33 |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8296 | This only works up to 223 columns! See "dec", |
| 8297 | "urxvt", and "sgr" for solutions. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8298 | xterm2 Works like "xterm", but with the xterm reporting the |
| 8299 | mouse position while the mouse is dragged. This works |
| 8300 | much faster and more precise. Your xterm must at |
Bram Moolenaar | bc7aa85 | 2005-03-06 23:38:09 +0000 | [diff] [blame] | 8301 | least at patchlevel 88 / XFree 3.3.3 for this to |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8302 | work. See below for how Vim detects this |
| 8303 | automatically. |
| 8304 | *netterm-mouse* |
| 8305 | netterm NetTerm mouse handling. The mouse generates |
| 8306 | "<Esc>}r,c<CR>", where "r,c" are two decimal numbers |
| 8307 | for the row and column. |
| 8308 | *dec-mouse* |
| 8309 | dec DEC terminal mouse handling. The mouse generates a |
| 8310 | rather complex sequence, starting with "<Esc>[". |
Bram Moolenaar | e4efc3b | 2005-03-07 23:16:51 +0000 | [diff] [blame] | 8311 | This is also available for an Xterm, if it was |
| 8312 | configured with "--enable-dec-locator". |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8313 | *jsbterm-mouse* |
| 8314 | jsbterm JSB term mouse handling. |
| 8315 | *pterm-mouse* |
| 8316 | pterm QNX pterm mouse handling. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8317 | *urxvt-mouse* |
| 8318 | urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8319 | The mouse works only if the terminal supports this |
| 8320 | encoding style, but it does not have 223 columns limit |
| 8321 | unlike "xterm" or "xterm2". |
Bram Moolenaar | 9b45125 | 2012-08-15 17:43:31 +0200 | [diff] [blame] | 8322 | *sgr-mouse* |
| 8323 | sgr Mouse handling for the terminal that emits SGR-styled |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8324 | mouse reporting. The mouse works even in columns |
| 8325 | beyond 223. This option is backward compatible with |
| 8326 | "xterm2" because it can also decode "xterm2" style |
| 8327 | mouse codes. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8328 | |
| 8329 | The mouse handling must be enabled at compile time |+mouse_xterm| |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8330 | |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
| 8331 | |+mouse_sgr|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8332 | Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 8333 | recognized, if enabled at compile time. DEC terminal mouse codes |
| 8334 | are recognized if enabled at compile time, and 'ttymouse' is not |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8335 | "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
| 8336 | with them). |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8337 | This option is automatically set to "xterm", when the 'term' option is |
Bram Moolenaar | 4575876 | 2016-10-12 23:08:06 +0200 | [diff] [blame] | 8338 | set to a name that starts with "xterm", "mlterm", "screen", "tmux", |
| 8339 | "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set |
| 8340 | already. |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8341 | Additionally, if vim is compiled with the |+termresponse| feature and |
| 8342 | |t_RV| is set to the escape sequence to request the xterm version |
| 8343 | number, more intelligent detection process runs. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8344 | The "xterm2" value will be set if the xterm version is reported to be |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8345 | from 95 to 276. The "sgr" value will be set if the xterm version is |
Bram Moolenaar | 2f05849 | 2017-11-30 20:27:52 +0100 | [diff] [blame] | 8346 | 277 or higher and when Vim detects Mac Terminal.app or iTerm2. |
Bram Moolenaar | e968e36 | 2014-05-13 20:23:24 +0200 | [diff] [blame] | 8347 | If you do not want 'ttymouse' to be set to "xterm2" or "sgr" |
| 8348 | automatically, set t_RV to an empty string: > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8349 | :set t_RV= |
| 8350 | < |
| 8351 | *'ttyscroll'* *'tsl'* |
| 8352 | 'ttyscroll' 'tsl' number (default 999) |
| 8353 | global |
| 8354 | Maximum number of lines to scroll the screen. If there are more lines |
| 8355 | to scroll the window is redrawn. For terminals where scrolling is |
| 8356 | very slow and redrawing is not slow this can be set to a small number, |
| 8357 | e.g., 3, to speed up displaying. |
| 8358 | |
| 8359 | *'ttytype'* *'tty'* |
| 8360 | 'ttytype' 'tty' string (default from $TERM) |
| 8361 | global |
| 8362 | Alias for 'term', see above. |
| 8363 | |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8364 | *'undodir'* *'udir'* |
| 8365 | 'undodir' 'udir' string (default ".") |
| 8366 | global |
| 8367 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8368 | {only when compiled with the |+persistent_undo| feature} |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8369 | List of directory names for undo files, separated with commas. |
Bram Moolenaar | b230bd5 | 2010-05-25 21:02:00 +0200 | [diff] [blame] | 8370 | See |'backupdir'| for details of the format. |
Bram Moolenaar | 6a244fe | 2010-05-24 22:02:24 +0200 | [diff] [blame] | 8371 | "." means using the directory of the file. The undo file name for |
| 8372 | "file.txt" is ".file.txt.un~". |
| 8373 | For other directories the file name is the full path of the edited |
| 8374 | file, with path separators replaced with "%". |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8375 | When writing: The first directory that exists is used. "." always |
| 8376 | works, no directories after "." will be used for writing. |
| 8377 | When reading all entries are tried to find an undo file. The first |
| 8378 | undo file that exists is used. When it cannot be read an error is |
| 8379 | given, no further entry is used. |
| 8380 | See |undo-persistence|. |
| 8381 | |
Bram Moolenaar | 543b7ef | 2013-06-01 14:50:56 +0200 | [diff] [blame] | 8382 | *'undofile'* *'noundofile'* *'udf'* *'noudf'* |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8383 | 'undofile' 'udf' boolean (default off) |
| 8384 | local to buffer |
| 8385 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8386 | {only when compiled with the |+persistent_undo| feature} |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8387 | When on, Vim automatically saves undo history to an undo file when |
| 8388 | writing a buffer to a file, and restores undo history from the same |
| 8389 | file on buffer read. |
Bram Moolenaar | b230bd5 | 2010-05-25 21:02:00 +0200 | [diff] [blame] | 8390 | The directory where the undo file is stored is specified by 'undodir'. |
| 8391 | For more information about this feature see |undo-persistence|. |
Bram Moolenaar | 59f931e | 2010-07-24 20:27:03 +0200 | [diff] [blame] | 8392 | The undo file is not read when 'undoreload' causes the buffer from |
| 8393 | before a reload to be saved for undo. |
Bram Moolenaar | 97d6249 | 2012-11-15 21:28:22 +0100 | [diff] [blame] | 8394 | When 'undofile' is turned off the undo file is NOT deleted. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 8395 | NOTE: This option is reset when 'compatible' is set. |
Bram Moolenaar | 55debbe | 2010-05-23 23:34:36 +0200 | [diff] [blame] | 8396 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8397 | *'undolevels'* *'ul'* |
| 8398 | 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, |
| 8399 | Win32 and OS/2) |
Bram Moolenaar | f5a2fd8 | 2013-11-06 05:26:15 +0100 | [diff] [blame] | 8400 | global or local to buffer |global-local| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8401 | {not in Vi} |
| 8402 | Maximum number of changes that can be undone. Since undo information |
| 8403 | is kept in memory, higher numbers will cause more memory to be used |
| 8404 | (nevertheless, a single change can use an unlimited amount of memory). |
| 8405 | Set to 0 for Vi compatibility: One level of undo and "u" undoes |
| 8406 | itself: > |
| 8407 | set ul=0 |
| 8408 | < But you can also get Vi compatibility by including the 'u' flag in |
| 8409 | 'cpoptions', and still be able to use CTRL-R to repeat undo. |
Bram Moolenaar | 945e2db | 2010-06-05 17:43:32 +0200 | [diff] [blame] | 8410 | Also see |undo-two-ways|. |
Bram Moolenaar | f5a2fd8 | 2013-11-06 05:26:15 +0100 | [diff] [blame] | 8411 | Set to -1 for no undo at all. You might want to do this only for the |
| 8412 | current buffer: > |
| 8413 | setlocal ul=-1 |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8414 | < This helps when you run out of memory for a single change. |
Bram Moolenaar | 32efaf6 | 2014-11-05 17:02:17 +0100 | [diff] [blame] | 8415 | |
| 8416 | The local value is set to -123456 when the global value is to be used. |
| 8417 | |
Bram Moolenaar | 945e2db | 2010-06-05 17:43:32 +0200 | [diff] [blame] | 8418 | Also see |clear-undo|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8419 | |
Bram Moolenaar | 59f931e | 2010-07-24 20:27:03 +0200 | [diff] [blame] | 8420 | *'undoreload'* *'ur'* |
| 8421 | 'undoreload' 'ur' number (default 10000) |
| 8422 | global |
| 8423 | {not in Vi} |
| 8424 | Save the whole buffer for undo when reloading it. This applies to the |
| 8425 | ":e!" command and reloading for when the buffer changed outside of |
| 8426 | Vim. |FileChangedShell| |
Bram Moolenaar | 24a98a0 | 2017-09-27 22:23:55 +0200 | [diff] [blame] | 8427 | The save only happens when this option is negative or when the number |
Bram Moolenaar | 59f931e | 2010-07-24 20:27:03 +0200 | [diff] [blame] | 8428 | of lines is smaller than the value of this option. |
| 8429 | Set this option to zero to disable undo for a reload. |
| 8430 | |
| 8431 | When saving undo for a reload, any undo file is not read. |
| 8432 | |
| 8433 | Note that this causes the whole buffer to be stored in memory. Set |
| 8434 | this option to a lower value if you run out of memory. |
| 8435 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8436 | *'updatecount'* *'uc'* |
| 8437 | 'updatecount' 'uc' number (default: 200) |
| 8438 | global |
| 8439 | {not in Vi} |
| 8440 | After typing this many characters the swap file will be written to |
| 8441 | disk. When zero, no swap file will be created at all (see chapter on |
| 8442 | recovery |crash-recovery|). 'updatecount' is set to zero by starting |
| 8443 | Vim with the "-n" option, see |startup|. When editing in readonly |
| 8444 | mode this option will be initialized to 10000. |
| 8445 | The swapfile can be disabled per buffer with |'swapfile'|. |
| 8446 | When 'updatecount' is set from zero to non-zero, swap files are |
| 8447 | created for all buffers that have 'swapfile' set. When 'updatecount' |
| 8448 | is set to zero, existing swap files are not deleted. |
| 8449 | Also see |'swapsync'|. |
| 8450 | This option has no meaning in buffers where |'buftype'| is "nofile" |
| 8451 | or "nowrite". |
| 8452 | |
| 8453 | *'updatetime'* *'ut'* |
| 8454 | 'updatetime' 'ut' number (default 4000) |
| 8455 | global |
| 8456 | {not in Vi} |
| 8457 | If this many milliseconds nothing is typed the swap file will be |
| 8458 | written to disk (see |crash-recovery|). Also used for the |
| 8459 | |CursorHold| autocommand event. |
| 8460 | |
| 8461 | *'verbose'* *'vbs'* |
| 8462 | 'verbose' 'vbs' number (default 0) |
| 8463 | global |
| 8464 | {not in Vi, although some versions have a boolean |
| 8465 | verbose option} |
| 8466 | When bigger than zero, Vim will give messages about what it is doing. |
| 8467 | Currently, these messages are given: |
| 8468 | >= 1 When the viminfo file is read or written. |
| 8469 | >= 2 When a file is ":source"'ed. |
Bram Moolenaar | 87b5ca5 | 2006-03-04 21:55:31 +0000 | [diff] [blame] | 8470 | >= 5 Every searched tags file and include file. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8471 | >= 8 Files for which a group of autocommands is executed. |
| 8472 | >= 9 Every executed autocommand. |
| 8473 | >= 12 Every executed function. |
| 8474 | >= 13 When an exception is thrown, caught, finished, or discarded. |
| 8475 | >= 14 Anything pending in a ":finally" clause. |
| 8476 | >= 15 Every executed Ex command (truncated at 200 characters). |
| 8477 | |
| 8478 | This option can also be set with the "-V" argument. See |-V|. |
| 8479 | This option is also set by the |:verbose| command. |
| 8480 | |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 8481 | When the 'verbosefile' option is set then the verbose messages are not |
| 8482 | displayed. |
| 8483 | |
| 8484 | *'verbosefile'* *'vfile'* |
| 8485 | 'verbosefile' 'vfile' string (default empty) |
| 8486 | global |
| 8487 | {not in Vi} |
| 8488 | When not empty all messages are written in a file with this name. |
| 8489 | When the file exists messages are appended. |
| 8490 | Writing to the file ends when Vim exits or when 'verbosefile' is made |
Bram Moolenaar | 80794b1 | 2010-06-13 05:20:42 +0200 | [diff] [blame] | 8491 | empty. Writes are buffered, thus may not show up for some time. |
Bram Moolenaar | 5c06f8b | 2005-05-31 22:14:58 +0000 | [diff] [blame] | 8492 | Setting 'verbosefile' to a new value is like making it empty first. |
| 8493 | The difference with |:redir| is that verbose messages are not |
| 8494 | displayed when 'verbosefile' is set. |
| 8495 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8496 | *'viewdir'* *'vdir'* |
| 8497 | 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: |
| 8498 | "$VIM/vimfiles/view", |
| 8499 | for Unix: "~/.vim/view", |
| 8500 | for Macintosh: "$VIM:vimfiles:view" |
| 8501 | for VMS: "sys$login:vimfiles/view" |
| 8502 | for RiscOS: "Choices:vimfiles/view") |
| 8503 | global |
| 8504 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8505 | {not available when compiled without the |+mksession| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8506 | feature} |
| 8507 | Name of the directory where to store files for |:mkview|. |
| 8508 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8509 | security reasons. |
| 8510 | |
| 8511 | *'viewoptions'* *'vop'* |
Bram Moolenaar | 13e9041 | 2017-11-11 18:16:48 +0100 | [diff] [blame] | 8512 | 'viewoptions' 'vop' string (default: "folds,options,cursor,curdir") |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8513 | global |
| 8514 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8515 | {not available when compiled without the |+mksession| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8516 | feature} |
| 8517 | Changes the effect of the |:mkview| command. It is a comma separated |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8518 | list of words. Each word enables saving and restoring something: |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8519 | word save and restore ~ |
| 8520 | cursor cursor position in file and in window |
| 8521 | folds manually created folds, opened/closed folds and local |
| 8522 | fold options |
| 8523 | options options and mappings local to a window or buffer (not |
| 8524 | global values for local options) |
Bram Moolenaar | 6e93246 | 2014-09-09 18:48:09 +0200 | [diff] [blame] | 8525 | localoptions same as "options" |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8526 | slash backslashes in file names replaced with forward |
| 8527 | slashes |
| 8528 | unix with Unix end-of-line format (single <NL>), even when |
| 8529 | on Windows or DOS |
Bram Moolenaar | 13e9041 | 2017-11-11 18:16:48 +0100 | [diff] [blame] | 8530 | curdir the window-local directory, if set with `:lcd` |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8531 | |
| 8532 | "slash" and "unix" are useful on Windows when sharing view files |
| 8533 | with Unix. The Unix version of Vim cannot source dos format scripts, |
| 8534 | but the Windows version of Vim can source unix format scripts. |
| 8535 | |
| 8536 | *'viminfo'* *'vi'* *E526* *E527* *E528* |
| 8537 | 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 8538 | Windows and OS/2: '100,<50,s10,h,rA:,rB:, |
| 8539 | for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
| 8540 | for others: '100,<50,s10,h) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8541 | global |
| 8542 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8543 | {not available when compiled without the |+viminfo| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8544 | feature} |
| 8545 | When non-empty, the viminfo file is read upon startup and written |
Bram Moolenaar | c4da113 | 2017-07-15 19:39:43 +0200 | [diff] [blame] | 8546 | when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is |
| 8547 | "NONE". |
| 8548 | The string should be a comma separated list of parameters, each |
| 8549 | consisting of a single character identifying the particular parameter, |
| 8550 | followed by a number or string which specifies the value of that |
| 8551 | parameter. If a particular character is left out, then the default |
| 8552 | value is used for that parameter. The following is a list of the |
| 8553 | identifying characters and the effect of their value. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8554 | CHAR VALUE ~ |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8555 | *viminfo-!* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8556 | ! When included, save and restore global variables that start |
| 8557 | with an uppercase letter, and don't contain a lowercase |
| 8558 | letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" |
Bram Moolenaar | 680eeca | 2010-10-20 17:44:42 +0200 | [diff] [blame] | 8559 | and "_K_L_M" are not. Nested List and Dict items may not be |
Bram Moolenaar | 166af9b | 2010-11-16 20:34:40 +0100 | [diff] [blame] | 8560 | read back correctly, you end up with an empty item. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8561 | *viminfo-quote* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8562 | " Maximum number of lines saved for each register. Old name of |
| 8563 | the '<' item, with the disadvantage that you need to put a |
| 8564 | backslash before the ", otherwise it will be recognized as the |
| 8565 | start of a comment! |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8566 | *viminfo-%* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8567 | % When included, save and restore the buffer list. If Vim is |
| 8568 | started with a file name argument, the buffer list is not |
| 8569 | restored. If Vim is started without a file name argument, the |
Bram Moolenaar | d042dc8 | 2015-11-24 19:18:36 +0100 | [diff] [blame] | 8570 | buffer list is restored from the viminfo file. Quickfix |
| 8571 | ('buftype'), unlisted ('buflisted'), unnamed and buffers on |
| 8572 | removable media (|viminfo-r|) are not saved. |
Bram Moolenaar | 15d0a8c | 2004-09-06 17:44:46 +0000 | [diff] [blame] | 8573 | When followed by a number, the number specifies the maximum |
| 8574 | number of buffers that are stored. Without a number all |
| 8575 | buffers are stored. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8576 | *viminfo-'* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8577 | ' Maximum number of previously edited files for which the marks |
| 8578 | are remembered. This parameter must always be included when |
| 8579 | 'viminfo' is non-empty. |
| 8580 | Including this item also means that the |jumplist| and the |
| 8581 | |changelist| are stored in the viminfo file. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8582 | *viminfo-/* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8583 | / Maximum number of items in the search pattern history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8584 | saved. If non-zero, then the previous search and substitute |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8585 | patterns are also saved. When not included, the value of |
| 8586 | 'history' is used. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8587 | *viminfo-:* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8588 | : Maximum number of items in the command-line history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8589 | saved. When not included, the value of 'history' is used. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8590 | *viminfo-<* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8591 | < Maximum number of lines saved for each register. If zero then |
| 8592 | registers are not saved. When not included, all lines are |
| 8593 | saved. '"' is the old name for this item. |
| 8594 | Also see the 's' item below: limit specified in Kbyte. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8595 | *viminfo-@* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8596 | @ Maximum number of items in the input-line history to be |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8597 | saved. When not included, the value of 'history' is used. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8598 | *viminfo-c* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8599 | c When included, convert the text in the viminfo file from the |
| 8600 | 'encoding' used when writing the file to the current |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 8601 | 'encoding'. See |viminfo-encoding|. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8602 | *viminfo-f* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8603 | f Whether file marks need to be stored. If zero, file marks ('0 |
| 8604 | 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] | 8605 | non-zero, they are all stored. '0 is used for the current |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8606 | cursor position (when exiting or when doing ":wviminfo"). |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8607 | *viminfo-h* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8608 | h Disable the effect of 'hlsearch' when loading the viminfo |
| 8609 | file. When not included, it depends on whether ":nohlsearch" |
| 8610 | has been used since the last search command. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8611 | *viminfo-n* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8612 | n Name of the viminfo file. The name must immediately follow |
Bram Moolenaar | c4da113 | 2017-07-15 19:39:43 +0200 | [diff] [blame] | 8613 | the 'n'. Must be at the end of the option! If the |
| 8614 | 'viminfofile' option is set, that file name overrides the one |
| 8615 | given here with 'viminfo'. Environment variables are |
Bram Moolenaar | 063b9d1 | 2016-07-09 20:21:48 +0200 | [diff] [blame] | 8616 | expanded when opening the file, not when setting the option. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8617 | *viminfo-r* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8618 | r Removable media. The argument is a string (up to the next |
| 8619 | ','). This parameter can be given several times. Each |
| 8620 | specifies the start of a path for which no marks will be |
| 8621 | stored. This is to avoid removable media. For MS-DOS you |
| 8622 | could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can |
| 8623 | also use it for temp files, e.g., for Unix: "r/tmp". Case is |
| 8624 | ignored. Maximum length of each 'r' argument is 50 |
| 8625 | characters. |
Bram Moolenaar | f1568ec | 2011-12-14 21:17:39 +0100 | [diff] [blame] | 8626 | *viminfo-s* |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8627 | s Maximum size of an item in Kbyte. If zero then registers are |
| 8628 | not saved. Currently only applies to registers. The default |
| 8629 | "s10" will exclude registers with more than 10 Kbyte of text. |
| 8630 | Also see the '<' item above: line count limit. |
| 8631 | |
| 8632 | Example: > |
| 8633 | :set viminfo='50,<1000,s100,:0,n~/vim/viminfo |
| 8634 | < |
| 8635 | '50 Marks will be remembered for the last 50 files you |
| 8636 | edited. |
| 8637 | <1000 Contents of registers (up to 1000 lines each) will be |
| 8638 | remembered. |
| 8639 | s100 Registers with more than 100 Kbyte text are skipped. |
| 8640 | :0 Command-line history will not be saved. |
| 8641 | n~/vim/viminfo The name of the file to use is "~/vim/viminfo". |
| 8642 | no / Since '/' is not specified, the default will be used, |
| 8643 | that is, save all of the search history, and also the |
| 8644 | previous search and substitute patterns. |
| 8645 | no % The buffer list will not be saved nor read back. |
| 8646 | no h 'hlsearch' highlighting will be restored. |
| 8647 | |
| 8648 | When setting 'viminfo' from an empty value you can use |:rviminfo| to |
| 8649 | load the contents of the file, this is not done automatically. |
| 8650 | |
| 8651 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 8652 | security reasons. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 8653 | NOTE: This option is set to the Vim default value when 'compatible' |
| 8654 | is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8655 | |
Bram Moolenaar | c4da113 | 2017-07-15 19:39:43 +0200 | [diff] [blame] | 8656 | *'viminfofile'* *'vif'* |
| 8657 | 'viminfofile' 'vif' string (default: "") |
| 8658 | global |
| 8659 | {not in Vi} |
| 8660 | {not available when compiled without the |+viminfo| |
| 8661 | feature} |
| 8662 | When non-empty, overrides the file name used for viminfo. |
| 8663 | When equal to "NONE" no viminfo file will be read or written. |
| 8664 | This option can be set with the |-i| command line flag. The |--clean| |
| 8665 | command line flag sets it to "NONE". |
| 8666 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8667 | *'virtualedit'* *'ve'* |
| 8668 | 'virtualedit' 've' string (default "") |
| 8669 | global |
| 8670 | {not in Vi} |
| 8671 | {not available when compiled without the |
| 8672 | |+virtualedit| feature} |
| 8673 | A comma separated list of these words: |
| 8674 | block Allow virtual editing in Visual block mode. |
| 8675 | insert Allow virtual editing in Insert mode. |
| 8676 | all Allow virtual editing in all modes. |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 8677 | onemore Allow the cursor to move just past the end of the line |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 8678 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8679 | Virtual editing means that the cursor can be positioned where there is |
Bram Moolenaar | ebcbd02 | 2007-05-12 14:28:25 +0000 | [diff] [blame] | 8680 | no actual character. This can be halfway into a tab or beyond the end |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8681 | of the line. Useful for selecting a rectangle in Visual mode and |
| 8682 | editing a table. |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 8683 | "onemore" is not the same, it will only allow moving the cursor just |
| 8684 | after the last character of the line. This makes some commands more |
| 8685 | consistent. Previously the cursor was always past the end of the line |
| 8686 | if the line was empty. But it is far from Vi compatible. It may also |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 8687 | break some plugins or Vim scripts. For example because |l| can move |
| 8688 | the cursor after the last character. Use with care! |
Bram Moolenaar | 9ba7e17 | 2013-07-17 22:37:26 +0200 | [diff] [blame] | 8689 | Using the `$` command will move to the last character in the line, not |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 8690 | past it. This may actually move the cursor to the left! |
Bram Moolenaar | 9ba7e17 | 2013-07-17 22:37:26 +0200 | [diff] [blame] | 8691 | The `g$` command will move to the end of the screen line. |
Bram Moolenaar | efd2bf1 | 2006-03-16 21:41:35 +0000 | [diff] [blame] | 8692 | It doesn't make sense to combine "all" with "onemore", but you will |
| 8693 | not get a warning for it. |
Bram Moolenaar | 036986f | 2017-03-16 17:41:02 +0100 | [diff] [blame] | 8694 | NOTE: This option is set to "" when 'compatible' is set. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8695 | |
| 8696 | *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* |
| 8697 | 'visualbell' 'vb' boolean (default off) |
| 8698 | global |
| 8699 | {not in Vi} |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 8700 | Use a visual bell instead of beeping. The terminal code to display the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8701 | visual bell is given with 't_vb'. When no beep or flash is wanted, |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 8702 | use: > |
| 8703 | :set vb t_vb= |
| 8704 | < If you want a short flash, you can use this on many terminals: > |
| 8705 | :set vb t_vb=[?5h$<100>[?5l |
| 8706 | < Here $<100> specifies the time, you can use a smaller or bigger value |
| 8707 | to get a shorter or longer flash. |
| 8708 | |
| 8709 | Note: Vim will limit the bell to once per half a second. This avoids |
| 8710 | having to wait for the flashing to finish when there are lots of |
| 8711 | bells, e.g. on key repeat. This also happens without 'visualbell' |
| 8712 | set. |
| 8713 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8714 | In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display |
| 8715 | for 20 msec. If you want to use a different time, use "<Esc>|40f", |
| 8716 | where 40 is the time in msec. |
Bram Moolenaar | 74675a6 | 2017-07-15 13:53:23 +0200 | [diff] [blame] | 8717 | |
| 8718 | Note: When the GUI starts, 't_vb' is reset to its default value. You |
| 8719 | might want to set it again in your |gvimrc|. |
| 8720 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8721 | Does not work on the Amiga, you always get a screen flash. |
| 8722 | Also see 'errorbells'. |
| 8723 | |
| 8724 | *'warn'* *'nowarn'* |
| 8725 | 'warn' boolean (default on) |
| 8726 | global |
| 8727 | Give a warning message when a shell command is used while the buffer |
| 8728 | has been changed. |
| 8729 | |
| 8730 | *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* |
| 8731 | 'weirdinvert' 'wiv' boolean (default off) |
| 8732 | global |
| 8733 | {not in Vi} |
Bram Moolenaar | 1d2ba7f | 2006-02-14 22:29:30 +0000 | [diff] [blame] | 8734 | This option has the same effect as the 't_xs' terminal option. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8735 | It is provided for backwards compatibility with version 4.x. |
| 8736 | Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and |
| 8737 | vice versa. Has no effect when the GUI is running. |
| 8738 | |
| 8739 | *'whichwrap'* *'ww'* |
| 8740 | 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") |
| 8741 | global |
| 8742 | {not in Vi} |
| 8743 | Allow specified keys that move the cursor left/right to move to the |
| 8744 | previous/next line when the cursor is on the first/last character in |
| 8745 | the line. Concatenate characters to allow this for these keys: |
| 8746 | char key mode ~ |
| 8747 | b <BS> Normal and Visual |
| 8748 | s <Space> Normal and Visual |
Bram Moolenaar | 87b5ca5 | 2006-03-04 21:55:31 +0000 | [diff] [blame] | 8749 | h "h" Normal and Visual (not recommended) |
| 8750 | l "l" Normal and Visual (not recommended) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8751 | < <Left> Normal and Visual |
| 8752 | > <Right> Normal and Visual |
| 8753 | ~ "~" Normal |
| 8754 | [ <Left> Insert and Replace |
| 8755 | ] <Right> Insert and Replace |
| 8756 | For example: > |
| 8757 | :set ww=<,>,[,] |
| 8758 | < allows wrap only when cursor keys are used. |
| 8759 | When the movement keys are used in combination with a delete or change |
| 8760 | operator, the <EOL> also counts for a character. This makes "3h" |
| 8761 | different from "3dh" when the cursor crosses the end of a line. This |
| 8762 | is also true for "x" and "X", because they do the same as "dl" and |
| 8763 | "dh". If you use this, you may also want to use the mapping |
| 8764 | ":map <BS> X" to make backspace delete the character in front of the |
| 8765 | cursor. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 8766 | When 'l' is included and it is used after an operator at the end of a |
| 8767 | line then it will not move to the next line. This makes "dl", "cl", |
| 8768 | "yl" etc. work normally. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8769 | NOTE: This option is set to the Vi default value when 'compatible' is |
| 8770 | set and to the Vim default value when 'compatible' is reset. |
| 8771 | |
| 8772 | *'wildchar'* *'wc'* |
| 8773 | 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) |
| 8774 | global |
| 8775 | {not in Vi} |
| 8776 | Character you have to type to start wildcard expansion in the |
| 8777 | command-line, as specified with 'wildmode'. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 8778 | More info here: |cmdline-completion|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8779 | The character is not recognized when used inside a macro. See |
| 8780 | 'wildcharm' for that. |
| 8781 | Although 'wc' is a number option, you can set it to a special key: > |
| 8782 | :set wc=<Esc> |
| 8783 | < NOTE: This option is set to the Vi default value when 'compatible' is |
| 8784 | set and to the Vim default value when 'compatible' is reset. |
| 8785 | |
| 8786 | *'wildcharm'* *'wcm'* |
| 8787 | 'wildcharm' 'wcm' number (default: none (0)) |
| 8788 | global |
| 8789 | {not in Vi} |
| 8790 | 'wildcharm' works exactly like 'wildchar', except that it is |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 8791 | recognized when used inside a macro. You can find "spare" command-line |
| 8792 | keys suitable for this option by looking at |ex-edit-index|. Normally |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8793 | you'll never actually type 'wildcharm', just use it in mappings that |
| 8794 | automatically invoke completion mode, e.g.: > |
| 8795 | :set wcm=<C-Z> |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 8796 | :cnoremap ss so $vim/sessions/*.vim<C-Z> |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8797 | < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 8798 | |
| 8799 | *'wildignore'* *'wig'* |
| 8800 | 'wildignore' 'wig' string (default "") |
| 8801 | global |
| 8802 | {not in Vi} |
| 8803 | {not available when compiled without the |+wildignore| |
| 8804 | feature} |
| 8805 | A list of file patterns. A file that matches with one of these |
Bram Moolenaar | 30b6581 | 2012-07-12 22:01:11 +0200 | [diff] [blame] | 8806 | patterns is ignored when expanding |wildcards|, completing file or |
| 8807 | directory names, and influences the result of |expand()|, |glob()| and |
| 8808 | |globpath()| unless a flag is passed to disable this. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8809 | The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 8810 | Also see 'suffixes'. |
| 8811 | Example: > |
| 8812 | :set wildignore=*.o,*.obj |
| 8813 | < The use of |:set+=| and |:set-=| is preferred when adding or removing |
| 8814 | a pattern from the list. This avoids problems when a future version |
| 8815 | uses another default. |
| 8816 | |
Bram Moolenaar | 94950a9 | 2010-12-02 16:01:29 +0100 | [diff] [blame] | 8817 | |
Bram Moolenaar | 81af925 | 2010-12-10 20:35:50 +0100 | [diff] [blame] | 8818 | *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
Bram Moolenaar | 94950a9 | 2010-12-02 16:01:29 +0100 | [diff] [blame] | 8819 | 'wildignorecase' 'wic' boolean (default off) |
| 8820 | global |
| 8821 | {not in Vi} |
| 8822 | When set case is ignored when completing file names and directories. |
Bram Moolenaar | 71afbfe | 2013-03-19 16:49:16 +0100 | [diff] [blame] | 8823 | Has no effect when 'fileignorecase' is set. |
Bram Moolenaar | 94950a9 | 2010-12-02 16:01:29 +0100 | [diff] [blame] | 8824 | Does not apply when the shell is used to expand wildcards, which |
| 8825 | happens when there are special characters. |
| 8826 | |
| 8827 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8828 | *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
Bram Moolenaar | 8c08b5b | 2016-07-28 22:24:15 +0200 | [diff] [blame] | 8829 | 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8830 | global |
| 8831 | {not in Vi} |
| 8832 | {not available if compiled without the |+wildmenu| |
| 8833 | feature} |
| 8834 | When 'wildmenu' is on, command-line completion operates in an enhanced |
| 8835 | mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, |
| 8836 | the possible matches are shown just above the command line, with the |
| 8837 | first match highlighted (overwriting the status line, if there is |
| 8838 | one). Keys that show the previous/next match, such as <Tab> or |
| 8839 | CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. |
| 8840 | When 'wildmode' is used, "wildmenu" mode is used where "full" is |
| 8841 | specified. "longest" and "list" do not start "wildmenu" mode. |
Bram Moolenaar | 26402cb | 2013-02-20 21:26:00 +0100 | [diff] [blame] | 8842 | You can check the current mode with |wildmenumode()|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8843 | If there are more matches than can fit in the line, a ">" is shown on |
| 8844 | the right and/or a "<" is shown on the left. The status line scrolls |
| 8845 | as needed. |
| 8846 | The "wildmenu" mode is abandoned when a key is hit that is not used |
| 8847 | for selecting a completion. |
| 8848 | While the "wildmenu" is active the following keys have special |
| 8849 | meanings: |
| 8850 | |
| 8851 | <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) |
| 8852 | <Down> - in filename/menu name completion: move into a |
| 8853 | subdirectory or submenu. |
| 8854 | <CR> - in menu completion, when the cursor is just after a |
| 8855 | dot: move into a submenu. |
| 8856 | <Up> - in filename/menu name completion: move up into |
| 8857 | parent directory or parent menu. |
| 8858 | |
| 8859 | This makes the menus accessible from the console |console-menus|. |
| 8860 | |
| 8861 | If you prefer the <Left> and <Right> keys to move the cursor instead |
| 8862 | of selecting a different match, use this: > |
| 8863 | :cnoremap <Left> <Space><BS><Left> |
| 8864 | :cnoremap <Right> <Space><BS><Right> |
| 8865 | < |
| 8866 | The "WildMenu" highlighting is used for displaying the current match |
| 8867 | |hl-WildMenu|. |
| 8868 | |
| 8869 | *'wildmode'* *'wim'* |
| 8870 | 'wildmode' 'wim' string (Vim default: "full") |
| 8871 | global |
| 8872 | {not in Vi} |
| 8873 | Completion mode that is used for the character specified with |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8874 | 'wildchar'. It is a comma separated list of up to four parts. Each |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 8875 | part specifies what to do for each consecutive use of 'wildchar'. The |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8876 | first part specifies the behavior for the first use of 'wildchar', |
| 8877 | The second part for the second use, etc. |
| 8878 | These are the possible values for each part: |
| 8879 | "" Complete only the first match. |
| 8880 | "full" Complete the next full match. After the last match, |
| 8881 | the original string is used and then the first match |
| 8882 | again. |
| 8883 | "longest" Complete till longest common string. If this doesn't |
| 8884 | result in a longer string, use the next part. |
| 8885 | "longest:full" Like "longest", but also start 'wildmenu' if it is |
| 8886 | enabled. |
| 8887 | "list" When more than one match, list all matches. |
| 8888 | "list:full" When more than one match, list all matches and |
| 8889 | complete first match. |
| 8890 | "list:longest" When more than one match, list all matches and |
| 8891 | complete till longest common string. |
| 8892 | When there is only a single match, it is fully completed in all cases. |
| 8893 | |
| 8894 | Examples: > |
| 8895 | :set wildmode=full |
Bram Moolenaar | 582fd85 | 2005-03-28 20:58:01 +0000 | [diff] [blame] | 8896 | < Complete first full match, next match, etc. (the default) > |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8897 | :set wildmode=longest,full |
| 8898 | < Complete longest common string, then each full match > |
| 8899 | :set wildmode=list:full |
| 8900 | < List all matches and complete each full match > |
| 8901 | :set wildmode=list,full |
| 8902 | < List all matches without completing, then each full match > |
| 8903 | :set wildmode=longest,list |
| 8904 | < Complete longest common string, then list alternatives. |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 8905 | More info here: |cmdline-completion|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8906 | |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 8907 | *'wildoptions'* *'wop'* |
| 8908 | 'wildoptions' 'wop' string (default "") |
| 8909 | global |
| 8910 | {not in Vi} |
| 8911 | {not available when compiled without the |+wildignore| |
| 8912 | feature} |
| 8913 | A list of words that change how command line completion is done. |
| 8914 | Currently only one word is allowed: |
| 8915 | tagfile When using CTRL-D to list matching tags, the kind of |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 8916 | tag and the file of the tag is listed. Only one match |
Bram Moolenaar | b5bf5b8 | 2004-12-24 14:35:23 +0000 | [diff] [blame] | 8917 | is displayed per line. Often used tag kinds are: |
| 8918 | d #define |
| 8919 | f function |
| 8920 | Also see |cmdline-completion|. |
| 8921 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8922 | *'winaltkeys'* *'wak'* |
| 8923 | 'winaltkeys' 'wak' string (default "menu") |
| 8924 | global |
| 8925 | {not in Vi} |
| 8926 | {only used in Win32, Motif, GTK and Photon GUI} |
| 8927 | Some GUI versions allow the access to menu entries by using the ALT |
| 8928 | key in combination with a character that appears underlined in the |
| 8929 | menu. This conflicts with the use of the ALT key for mappings and |
| 8930 | entering special characters. This option tells what to do: |
| 8931 | no Don't use ALT keys for menus. ALT key combinations can be |
| 8932 | mapped, but there is no automatic handling. This can then be |
| 8933 | done with the |:simalt| command. |
| 8934 | yes ALT key handling is done by the windowing system. ALT key |
| 8935 | combinations cannot be mapped. |
| 8936 | menu Using ALT in combination with a character that is a menu |
Bram Moolenaar | f4b8e57 | 2004-06-24 15:53:16 +0000 | [diff] [blame] | 8937 | shortcut key, will be handled by the windowing system. Other |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8938 | keys can be mapped. |
| 8939 | If the menu is disabled by excluding 'm' from 'guioptions', the ALT |
| 8940 | key is never used for the menu. |
Bram Moolenaar | 293ee4d | 2004-12-09 21:34:53 +0000 | [diff] [blame] | 8941 | This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 8942 | select the menu, unless it has been mapped. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8943 | |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 8944 | *'window'* *'wi'* |
| 8945 | 'window' 'wi' number (default screen height - 1) |
| 8946 | global |
| 8947 | Window height. Do not confuse this with the height of the Vim window, |
| 8948 | use 'lines' for that. |
Bram Moolenaar | 19a09a1 | 2005-03-04 23:39:37 +0000 | [diff] [blame] | 8949 | Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
| 8950 | value is smaller than 'lines' minus one. The screen will scroll |
| 8951 | 'window' minus two lines, with a minimum of one. |
Bram Moolenaar | 4399ef4 | 2005-02-12 14:29:27 +0000 | [diff] [blame] | 8952 | When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 8953 | in a much smarter way, taking care of wrapping lines. |
| 8954 | When resizing the Vim window, the value is smaller than 1 or more than |
| 8955 | or equal to 'lines' it will be set to 'lines' minus 1. |
| 8956 | {Vi also uses the option to specify the number of displayed lines} |
| 8957 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8958 | *'winheight'* *'wh'* *E591* |
| 8959 | 'winheight' 'wh' number (default 1) |
| 8960 | global |
| 8961 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8962 | {not available when compiled without the |+windows| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8963 | feature} |
| 8964 | 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] | 8965 | minimum, Vim will use fewer lines if there is not enough room. If the |
Bram Moolenaar | 446cb83 | 2008-06-24 21:56:24 +0000 | [diff] [blame] | 8966 | focus goes to a window that is smaller, its size is increased, at the |
| 8967 | cost of the height of other windows. |
| 8968 | Set 'winheight' to a small number for normal editing. |
| 8969 | Set it to 999 to make the current window fill most of the screen. |
| 8970 | Other windows will be only 'winminheight' high. This has the drawback |
| 8971 | that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" |
| 8972 | to create only two windows, set the option after startup is done, |
| 8973 | using the |VimEnter| event: > |
| 8974 | au VimEnter * set winheight=999 |
| 8975 | < Minimum value is 1. |
| 8976 | The height is not adjusted after one of the commands that change the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8977 | height of the current window. |
| 8978 | 'winheight' applies to the current window. Use 'winminheight' to set |
| 8979 | the minimal height for other windows. |
| 8980 | |
| 8981 | *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* |
| 8982 | 'winfixheight' 'wfh' boolean (default off) |
| 8983 | local to window |
| 8984 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8985 | {not available when compiled without the |+windows| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8986 | feature} |
| 8987 | Keep the window height when windows are opened or closed and |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 8988 | 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
| 8989 | |preview-window| and |quickfix-window|. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 8990 | The height may be changed anyway when running out of room. |
| 8991 | |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 8992 | *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
| 8993 | 'winfixwidth' 'wfw' boolean (default off) |
| 8994 | local to window |
| 8995 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 8996 | {not available when compiled without the |+windows| |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 8997 | feature} |
| 8998 | Keep the window width when windows are opened or closed and |
Bram Moolenaar | 0246787 | 2007-05-06 13:22:01 +0000 | [diff] [blame] | 8999 | 'equalalways' is set. Also for |CTRL-W_=|. |
Bram Moolenaar | 97b2ad3 | 2006-03-18 21:40:56 +0000 | [diff] [blame] | 9000 | The width may be changed anyway when running out of room. |
| 9001 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9002 | *'winminheight'* *'wmh'* |
| 9003 | 'winminheight' 'wmh' number (default 1) |
| 9004 | global |
| 9005 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 9006 | {not available when compiled without the |+windows| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9007 | feature} |
| 9008 | The minimal height of a window, when it's not the current window. |
| 9009 | This is a hard minimum, windows will never become smaller. |
| 9010 | When set to zero, windows may be "squashed" to zero lines (i.e. just a |
| 9011 | status bar) if necessary. They will return to at least one line when |
| 9012 | they become active (since the cursor has to have somewhere to go.) |
| 9013 | Use 'winheight' to set the minimal height of the current window. |
| 9014 | This option is only checked when making a window smaller. Don't use a |
| 9015 | large number, it will cause errors when opening more than a few |
| 9016 | windows. A value of 0 to 3 is reasonable. |
| 9017 | |
| 9018 | *'winminwidth'* *'wmw'* |
| 9019 | 'winminwidth' 'wmw' number (default 1) |
| 9020 | global |
| 9021 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 9022 | {not available when compiled without the |+vertsplit| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9023 | feature} |
| 9024 | The minimal width of a window, when it's not the current window. |
| 9025 | This is a hard minimum, windows will never become smaller. |
| 9026 | When set to zero, windows may be "squashed" to zero columns (i.e. just |
| 9027 | a vertical separator) if necessary. They will return to at least one |
| 9028 | line when they become active (since the cursor has to have somewhere |
| 9029 | to go.) |
| 9030 | Use 'winwidth' to set the minimal width of the current window. |
| 9031 | This option is only checked when making a window smaller. Don't use a |
| 9032 | large number, it will cause errors when opening more than a few |
| 9033 | windows. A value of 0 to 12 is reasonable. |
| 9034 | |
Bram Moolenaar | 9e13aa7 | 2017-08-16 23:14:08 +0200 | [diff] [blame] | 9035 | *'winptydll'* |
| 9036 | 'winptydll' string (default "winpty32.dll" or "winpty64.dll") |
| 9037 | global |
| 9038 | {not in Vi} |
| 9039 | {only available when compiled with the |terminal| |
| 9040 | feature on MS-Windows} |
| 9041 | Specifies the name of the winpty shared library, used for the |
| 9042 | |:terminal| command. The default depends on whether was build as a |
Bram Moolenaar | c572da5 | 2017-08-27 16:52:01 +0200 | [diff] [blame] | 9043 | 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as |
Bram Moolenaar | 9e13aa7 | 2017-08-16 23:14:08 +0200 | [diff] [blame] | 9044 | a fallback. |
| 9045 | Environment variables are expanded |:set_env|. |
| 9046 | This option cannot be set from a |modeline| or in the |sandbox|, for |
| 9047 | security reasons. |
| 9048 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9049 | *'winwidth'* *'wiw'* *E592* |
| 9050 | 'winwidth' 'wiw' number (default 20) |
| 9051 | global |
| 9052 | {not in Vi} |
Bram Moolenaar | db84e45 | 2010-08-15 13:50:43 +0200 | [diff] [blame] | 9053 | {not available when compiled without the |+vertsplit| |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9054 | feature} |
| 9055 | Minimal number of columns for the current window. This is not a hard |
| 9056 | minimum, Vim will use fewer columns if there is not enough room. If |
| 9057 | the current window is smaller, its size is increased, at the cost of |
| 9058 | the width of other windows. Set it to 999 to make the current window |
| 9059 | always fill the screen. Set it to a small number for normal editing. |
| 9060 | The width is not adjusted after one of the commands to change the |
| 9061 | width of the current window. |
| 9062 | 'winwidth' applies to the current window. Use 'winminwidth' to set |
| 9063 | the minimal width for other windows. |
| 9064 | |
| 9065 | *'wrap'* *'nowrap'* |
| 9066 | 'wrap' boolean (default on) |
| 9067 | local to window |
| 9068 | {not in Vi} |
| 9069 | This option changes how text is displayed. It doesn't change the text |
| 9070 | in the buffer, see 'textwidth' for that. |
| 9071 | 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] | 9072 | displaying continues on the next line. When off lines will not wrap |
| 9073 | 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] | 9074 | moved to a part that is not shown, the screen will scroll |
| 9075 | horizontally. |
| 9076 | The line will be broken in the middle of a word if necessary. See |
| 9077 | 'linebreak' to get the break at a word boundary. |
| 9078 | To make scrolling horizontally a bit more useful, try this: > |
| 9079 | :set sidescroll=5 |
| 9080 | :set listchars+=precedes:<,extends:> |
| 9081 | < See 'sidescroll', 'listchars' and |wrap-off|. |
Bram Moolenaar | 8f3f58f | 2010-01-06 20:52:26 +0100 | [diff] [blame] | 9082 | This option can't be set from a |modeline| when the 'diff' option is |
| 9083 | on. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9084 | |
| 9085 | *'wrapmargin'* *'wm'* |
| 9086 | 'wrapmargin' 'wm' number (default 0) |
| 9087 | local to buffer |
| 9088 | Number of characters from the right window border where wrapping |
| 9089 | starts. When typing text beyond this limit, an <EOL> will be inserted |
| 9090 | and inserting continues on the next line. |
| 9091 | Options that add a margin, such as 'number' and 'foldcolumn', cause |
| 9092 | the text width to be further reduced. This is Vi compatible. |
| 9093 | When 'textwidth' is non-zero, this option is not used. |
Bram Moolenaar | ca63501 | 2015-09-25 20:34:21 +0200 | [diff] [blame] | 9094 | This option is set to 0 when 'paste' is set and restored when 'paste' |
| 9095 | is reset. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9096 | See also 'formatoptions' and |ins-textwidth|. {Vi: works differently |
| 9097 | and less usefully} |
| 9098 | |
| 9099 | *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* |
| 9100 | 'wrapscan' 'ws' boolean (default on) *E384* *E385* |
| 9101 | global |
Bram Moolenaar | ac6e65f | 2005-08-29 22:25:38 +0000 | [diff] [blame] | 9102 | Searches wrap around the end of the file. Also applies to |]s| and |
| 9103 | |[s|, searching for spelling mistakes. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9104 | |
| 9105 | *'write'* *'nowrite'* |
| 9106 | 'write' boolean (default on) |
| 9107 | global |
| 9108 | {not in Vi} |
| 9109 | Allows writing files. When not set, writing a file is not allowed. |
| 9110 | 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] | 9111 | still allowed. Can be reset with the |-m| or |-M| command line |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9112 | argument. Filtering text is still possible, even though this requires |
| 9113 | writing a temporary file. |
| 9114 | |
| 9115 | *'writeany'* *'wa'* *'nowriteany'* *'nowa'* |
| 9116 | 'writeany' 'wa' boolean (default off) |
| 9117 | global |
| 9118 | Allows writing to any file with no need for "!" override. |
| 9119 | |
| 9120 | *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* |
| 9121 | 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off |
| 9122 | otherwise) |
| 9123 | global |
| 9124 | {not in Vi} |
| 9125 | Make a backup before overwriting a file. The backup is removed after |
| 9126 | the file was successfully written, unless the 'backup' option is |
Bram Moolenaar | 1aeaf8c | 2012-05-18 13:46:39 +0200 | [diff] [blame] | 9127 | also on. |
| 9128 | WARNING: Switching this option off means that when Vim fails to write |
| 9129 | your buffer correctly and then, for whatever reason, Vim exits, you |
| 9130 | lose both the original file and what you were writing. Only reset |
| 9131 | this option if your file system is almost full and it makes the write |
| 9132 | fail (and make sure not to exit Vim until the write was successful). |
| 9133 | See |backup-table| for another explanation. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9134 | When the 'backupskip' pattern matches, a backup is not made anyway. |
| 9135 | NOTE: This option is set to the default value when 'compatible' is |
| 9136 | set. |
| 9137 | |
| 9138 | *'writedelay'* *'wd'* |
| 9139 | 'writedelay' 'wd' number (default 0) |
| 9140 | global |
| 9141 | {not in Vi} |
Bram Moolenaar | 802a0d9 | 2016-06-26 16:17:58 +0200 | [diff] [blame] | 9142 | The number of milliseconds to wait for each character sent to the |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9143 | screen. When non-zero, characters are sent to the terminal one by |
| 9144 | one. For MS-DOS pcterm this does not work. For debugging purposes. |
| 9145 | |
| 9146 | vim:tw=78:ts=8:ft=help:norl: |