Mercurial > vim
annotate runtime/doc/options.txt @ 10682:d564e73ff9ee v8.0.0231
patch 8.0.0231: bracketed paste mode is not tested
commit https://github.com/vim/vim/commit/076e502199b19e6141e4c1e659ff3f21b71934e1
Author: Bram Moolenaar <Bram@vim.org>
Date: Tue Jan 24 18:58:30 2017 +0100
patch 8.0.0231: bracketed paste mode is not tested
Problem: There are no tests for bracketed paste mode.
Solution: Add a test. Fix repeating with "normal .".
| author | Christian Brabandt <cb@256bit.org> |
|---|---|
| date | Tue, 24 Jan 2017 19:00:06 +0100 |
| parents | 9a75c8a1b8b1 |
| children | 7598ce51bf2a |
| rev | line source |
|---|---|
| 10617 | 1 *options.txt* For Vim version 8.0. Last change: 2017 Jan 15 |
| 7 | 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 | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
13 For an overview of options see quickref.txt |option-list|. |
| 7 | 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 ============================================================================== | |
| 523 | 22 1. Setting options *set-option* *E764* |
| 7 | 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 | |
| 2152 | 43 *:set-!* *:set-inv* |
| 7 | 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 | |
|
7051
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
53 :se[t] all& Set all options to their default value. The values of |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
54 these options are not changed: |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
55 all terminal options, starting with t_ |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
56 'columns' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
57 'cryptmethod' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
58 'encoding' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
59 'key' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
60 'lines' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
61 'term' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
62 'ttymouse' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
63 'ttytype' |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
64 Warning: This may have a lot of side effects. |
|
eff26a8620ce
commit https://github.com/vim/vim/commit/88774fdd23f08355297bb8cda78856859051d3c7
Christian Brabandt <cb@256bit.org>
parents:
6949
diff
changeset
|
65 {not in Vi} |
| 7 | 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, | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
72 hex (preceded with 0x) or octal (preceded with '0'). |
| 7 | 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 | |
| 557 | 88 are removed. When adding a flag that was already |
| 89 present the option value doesn't change. | |
| 809 | 90 Also see |:set-args| above. |
| 7 | 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? | |
| 1621 | 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. | |
| 7 | 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'. | |
| 1621 | 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 | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
148 {not available when compiled without the |+eval| feature} |
| 7 | 149 |
| 150 *:set-termcap* *E522* | |
| 667 | 151 For {option} the form "t_xx" may be used to set a terminal option. This will |
| 7 | 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 | |
| 2726 | 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 | |
| 36 | 173 The t_xx options cannot be set from a |modeline| or in the |sandbox|, for |
| 174 security reasons. | |
| 175 | |
| 7 | 176 The listing from ":set" looks different from Vi. Long string options are put |
| 10 | 177 at the end of the list. The number of options is quite large. The output of |
| 7 | 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 | |
| 10 | 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 | |
| 7 | 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 | |
| 642 | 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 | |
| 10 | 203 For MS-DOS and WIN32 backslashes in file names are mostly not removed. More |
| 7 | 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 | |
| 10 | 214 halved and when you expect the backslashes to be kept. The third gives a |
| 7 | 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'. | |
| 10 | 225 Note that you should add or remove one flag at a time. If 'guioptions' has |
| 7 | 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* | |
| 22 | 230 Environment variables in specific string options will be expanded. If the |
| 7 | 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 | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
245 has its own copy of this option, thus each can have its own value. This |
| 7 | 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 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
264 When editing a buffer that has been edited before, the options from the window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
265 that was last closed are used again. If this buffer has been edited in this |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
266 window, the values from back then are used. Otherwise the values from the |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
267 last closed window where the buffer was edited last are used. |
| 7 | 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 | |
| 4358 | 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|. | |
| 7 | 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. | |
| 2413 | 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. | |
| 7 | 302 When displaying a specific local option, show the |
| 1621 | 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 | |
| 7 | 307 shown (but that might change in the future). |
| 308 {not in Vi} | |
| 309 | |
| 809 | 310 :setl[ocal] {option}< Set the local value of {option} to its global value by |
| 311 copying the value. | |
| 312 {not in Vi} | |
| 313 | |
| 3281 | 314 :se[t] {option}< For |global-local| options: Remove the local value of |
| 315 {option}, so that the global value will be used. | |
| 7 | 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. | |
| 2413 | 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. | |
| 7 | 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 | |
| 40 | 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. | |
| 7 | 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 | |
| 1152 | 352 another 'makeprg' for it, without changing the value used for the C source |
| 10 | 353 files. You use this command: > |
| 7 | 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 | |
| 809 | 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= | |
| 7 | 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 | |
| 373 :setf[iletype] {filetype} *:setf* *:setfiletype* | |
| 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. | |
| 383 {not in Vi} | |
| 384 | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
385 *option-window* *optwin* |
| 7 | 386 :bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options* |
| 387 :opt[ions] Open a window for viewing and setting all options. | |
| 388 Options are grouped by function. | |
| 389 Offers short help for each option. Hit <CR> on the | |
| 390 short help to open a help window with more help for | |
| 391 the option. | |
| 392 Modify the value of the option and hit <CR> on the | |
| 393 "set" line to set the new value. For window and | |
| 394 buffer specific options, the last accessed window is | |
| 395 used to set the option value in, unless this is a help | |
| 396 window, in which case the window below help window is | |
| 397 used (skipping the option-window). | |
| 398 {not available when compiled without the |+eval| or | |
| 399 |+autocmd| features} | |
| 400 | |
| 401 *$HOME* | |
| 402 Using "~" is like using "$HOME", but it is only recognized at the start of an | |
| 403 option and after a space or comma. | |
| 404 | |
| 405 On Unix systems "~user" can be used too. It is replaced by the home directory | |
| 406 of user "user". Example: > | |
| 407 :set path=~mool/include,/usr/include,. | |
| 408 | |
| 409 On Unix systems the form "${HOME}" can be used too. The name between {} can | |
| 410 contain non-id characters then. Note that if you want to use this for the | |
| 411 "gf" command, you need to add the '{' and '}' characters to 'isfname'. | |
| 412 | |
| 3224 | 413 On MS-Windows, if $HOME is not defined as an environment variable, then |
| 414 at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH. | |
| 415 | |
| 7 | 416 NOTE: expanding environment variables and "~/" is only done with the ":set" |
| 417 command, not when assigning a value to an option with ":let". | |
| 418 | |
| 419 | |
| 420 Note the maximum length of an expanded option is limited. How much depends on | |
| 421 the system, mostly it is something like 256 or 1024 characters. | |
| 422 | |
| 423 *:fix* *:fixdel* | |
| 424 :fix[del] Set the value of 't_kD': | |
| 425 't_kb' is 't_kD' becomes ~ | |
| 426 CTRL-? CTRL-H | |
| 427 not CTRL-? CTRL-? | |
| 428 | |
| 429 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi} | |
| 430 | |
| 431 If your delete key terminal code is wrong, but the | |
| 432 code for backspace is alright, you can put this in | |
| 433 your .vimrc: > | |
| 434 :fixdel | |
| 435 < This works no matter what the actual code for | |
| 436 backspace is. | |
| 437 | |
| 438 If the backspace key terminal code is wrong you can | |
| 439 use this: > | |
| 440 :if &term == "termname" | |
| 441 : set t_kb=^V<BS> | |
| 442 : fixdel | |
| 443 :endif | |
| 444 < Where "^V" is CTRL-V and "<BS>" is the backspace key | |
| 10 | 445 (don't type four characters!). Replace "termname" |
| 7 | 446 with your terminal name. |
| 447 | |
| 448 If your <Delete> key sends a strange key sequence (not | |
| 449 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: > | |
| 450 :if &term == "termname" | |
| 451 : set t_kD=^V<Delete> | |
| 452 :endif | |
| 453 < Where "^V" is CTRL-V and "<Delete>" is the delete key | |
| 454 (don't type eight characters!). Replace "termname" | |
| 455 with your terminal name. | |
| 456 | |
| 457 *Linux-backspace* | |
| 458 Note about Linux: By default the backspace key | |
| 459 produces CTRL-?, which is wrong. You can fix it by | |
| 460 putting this line in your rc.local: > | |
| 461 echo "keycode 14 = BackSpace" | loadkeys | |
| 462 < | |
| 463 *NetBSD-backspace* | |
| 464 Note about NetBSD: If your backspace doesn't produce | |
| 465 the right code, try this: > | |
| 466 xmodmap -e "keycode 22 = BackSpace" | |
| 467 < If this works, add this in your .Xmodmap file: > | |
| 468 keysym 22 = BackSpace | |
| 469 < You need to restart for this to take effect. | |
| 470 | |
| 471 ============================================================================== | |
| 472 2. Automatically setting options *auto-setting* | |
| 473 | |
| 474 Besides changing options with the ":set" command, there are three alternatives | |
| 475 to set options automatically for one or more files: | |
| 476 | |
| 477 1. When starting Vim initializations are read from various places. See | |
| 478 |initialization|. Most of them are performed for all editing sessions, | |
| 479 and some of them depend on the directory where Vim is started. | |
| 480 You can create an initialization file with |:mkvimrc|, |:mkview| and | |
| 481 |:mksession|. | |
| 482 2. If you start editing a new file, the automatic commands are executed. | |
| 483 This can be used to set options for files matching a particular pattern and | |
| 484 many other things. See |autocommand|. | |
| 485 3. If you start editing a new file, and the 'modeline' option is on, a | |
| 486 number of lines at the beginning and end of the file are checked for | |
| 487 modelines. This is explained here. | |
| 488 | |
| 489 *modeline* *vim:* *vi:* *ex:* *E520* | |
| 490 There are two forms of modelines. The first form: | |
| 5055 | 491 [text]{white}{vi:|vim:|ex:}[white]{options} |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
492 |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
493 [text] any text or empty |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
494 {white} at least one blank character (<Space> or <Tab>) |
| 5055 | 495 {vi:|vim:|ex:} the string "vi:", "vim:" or "ex:" |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
496 [white] optional white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
497 {options} a list of option settings, separated with white space |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
498 or ':', where each part between ':' is the argument |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
499 for a ":set" command (can be empty) |
| 7 | 500 |
| 5055 | 501 Examples: |
| 782 | 502 vi:noai:sw=3 ts=6 ~ |
| 5055 | 503 vim: tw=77 ~ |
| 7 | 504 |
| 505 The second form (this is compatible with some versions of Vi): | |
| 506 | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
507 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text] |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
508 |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
509 [text] any text or empty |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
510 {white} at least one blank character (<Space> or <Tab>) |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
511 {vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:" |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
512 [white] optional white space |
| 5055 | 513 se[t] the string "set " or "se " (note the space); When |
| 514 "Vim" is used it must be "set". | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
515 {options} a list of options, separated with white space, which |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
516 is the argument for a ":set" command |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
517 : a colon |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
518 [text] any text or empty |
| 7 | 519 |
| 5055 | 520 Examples: |
| 782 | 521 /* vim: set ai tw=75: */ ~ |
| 5055 | 522 /* Vim: set ai tw=75: */ ~ |
| 7 | 523 |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
524 The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
525 chance that a normal word like "lex:" is caught. There is one exception: |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
526 "vi:" and "vim:" can also be at the start of the line (for compatibility with |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
527 version 3.0). Using "ex:" at the start of the line will be ignored (this |
|
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
528 could be short for "example:"). |
| 7 | 529 |
| 530 *modeline-local* | |
| 531 The options are set like with ":setlocal": The new value only applies to the | |
| 11 | 532 buffer and window that contain the file. Although it's possible to set global |
| 533 options from a modeline, this is unusual. If you have two windows open and | |
| 534 the files in it set the same global option to a different value, the result | |
| 535 depends on which one was opened last. | |
| 7 | 536 |
| 23 | 537 When editing a file that was already loaded, only the window-local options |
| 538 from the modeline are used. Thus if you manually changed a buffer-local | |
| 539 option after opening the file, it won't be changed if you edit the same buffer | |
| 540 in another window. But window-local options will be set. | |
| 541 | |
| 7 | 542 *modeline-version* |
| 543 If the modeline is only to be used for some versions of Vim, the version | |
|
5024
7a2ffd685c0e
Update runtime files. Remove duplicate tags in help.
Bram Moolenaar <bram@vim.org>
parents:
5008
diff
changeset
|
544 number can be specified where "vim:" or "Vim:" is used: |
| 7 | 545 vim{vers}: version {vers} or later |
| 546 vim<{vers}: version before {vers} | |
| 547 vim={vers}: version {vers} | |
| 548 vim>{vers}: version after {vers} | |
| 6647 | 549 {vers} is 700 for Vim 7.0 (hundred times the major version plus minor). |
| 550 For example, to use a modeline only for Vim 7.0: | |
| 551 /* vim700: set foldmethod=marker */ ~ | |
| 552 To use a modeline for Vim after version 7.2: | |
| 553 /* vim>702: set cole=2: */ ~ | |
| 7 | 554 There can be no blanks between "vim" and the ":". |
| 555 | |
| 556 | |
| 557 The number of lines that are checked can be set with the 'modelines' option. | |
| 558 If 'modeline' is off or 'modelines' is 0 no lines are checked. | |
| 559 | |
| 560 Note that for the first form all of the rest of the line is used, thus a line | |
| 782 | 561 like: |
| 562 /* vi:ts=4: */ ~ | |
| 563 will give an error message for the trailing "*/". This line is OK: | |
| 564 /* vi:set ts=4: */ ~ | |
| 7 | 565 |
| 566 If an error is detected the rest of the line is skipped. | |
| 567 | |
| 568 If you want to include a ':' in a set command precede it with a '\'. The | |
| 782 | 569 backslash in front of the ':' will be removed. Example: |
| 570 /* vi:set dir=c\:\tmp: */ ~ | |
| 7 | 571 This sets the 'dir' option to "c:\tmp". Only a single backslash before the |
| 572 ':' is removed. Thus to include "\:" you have to specify "\\:". | |
| 573 | |
| 574 No other commands than "set" are supported, for security reasons (somebody | |
| 1111 | 575 might create a Trojan horse text file with modelines). And not all options |
| 576 can be set. For some options a flag is set, so that when it's used the | |
| 1152 | 577 |sandbox| is effective. Still, there is always a small risk that a modeline |
| 1111 | 578 causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines |
| 579 are wrapped unexpectedly. So disable modelines before editing untrusted text. | |
| 580 The mail ftplugin does this, for example. | |
| 7 | 581 |
| 582 Hint: If you would like to do something else than setting an option, you could | |
| 583 define an autocommand that checks the file for a specific string. For | |
| 584 example: > | |
| 585 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif | |
| 586 And define a function SetVar() that does something with the line containing | |
| 587 "VAR". | |
| 588 | |
| 589 ============================================================================== | |
| 590 3. Options summary *option-summary* | |
| 591 | |
| 592 In the list below all the options are mentioned with their full name and with | |
| 593 an abbreviation if there is one. Both forms may be used. | |
| 594 | |
| 595 In this document when a boolean option is "set" that means that ":set option" | |
| 596 is entered. When an option is "reset", ":set nooption" is used. | |
| 597 | |
| 598 For some options there are two default values: The "Vim default", which is | |
| 599 used when 'compatible' is not set, and the "Vi default", which is used when | |
| 600 'compatible' is set. | |
| 601 | |
| 602 Most options are the same in all windows and buffers. There are a few that | |
| 10 | 603 are specific to how the text is presented in a window. These can be set to a |
| 7 | 604 different value in each window. For example the 'list' option can be set in |
| 605 one window and reset in another for the same text, giving both types of view | |
| 606 at the same time. There are a few options that are specific to a certain | |
| 607 file. These can have a different value for each file or buffer. For example | |
| 608 the 'textwidth' option can be 78 for a normal text file and 0 for a C | |
| 609 program. | |
| 610 | |
| 611 global one option for all buffers and windows | |
| 612 local to window each window has its own copy of this option | |
| 613 local to buffer each buffer has its own copy of this option | |
| 614 | |
| 615 When creating a new window the option values from the currently active window | |
| 616 are used as a default value for the window-specific options. For the | |
| 617 buffer-specific options this depends on the 's' and 'S' flags in the | |
| 618 'cpoptions' option. If 's' is included (which is the default) the values for | |
| 619 buffer options are copied from the currently active buffer when a buffer is | |
| 10 | 620 first entered. If 'S' is present the options are copied each time the buffer |
| 621 is entered, this is almost like having global options. If 's' and 'S' are not | |
| 7 | 622 present, the options are copied from the currently active buffer when the |
| 623 buffer is created. | |
| 624 | |
| 519 | 625 Hidden options *hidden-options* |
| 626 | |
| 627 Not all options are supported in all versions. This depends on the supported | |
| 628 features and sometimes on the system. A remark about this is in curly braces | |
| 629 below. When an option is not supported it may still be set without getting an | |
| 630 error, this is called a hidden option. You can't get the value of a hidden | |
| 631 option though, it is not stored. | |
| 632 | |
| 633 To test if option "foo" can be used with ":set" use something like this: > | |
| 634 if exists('&foo') | |
| 635 This also returns true for a hidden option. To test if option "foo" is really | |
| 636 supported use something like this: > | |
| 637 if exists('+foo') | |
| 638 < | |
| 7 | 639 *E355* |
| 640 A jump table for the options with a short description can be found at |Q_op|. | |
| 641 | |
| 642 *'aleph'* *'al'* *aleph* *Aleph* | |
| 643 'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise) | |
| 644 global | |
| 645 {not in Vi} | |
| 646 {only available when compiled with the |+rightleft| | |
| 647 feature} | |
| 648 The ASCII code for the first letter of the Hebrew alphabet. The | |
| 649 routine that maps the keyboard in Hebrew mode, both in Insert mode | |
| 650 (when hkmap is set) and on the command-line (when hitting CTRL-_) | |
| 651 outputs the Hebrew characters in the range [aleph..aleph+26]. | |
| 652 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8. | |
| 653 See |rileft.txt|. | |
| 654 | |
| 655 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'* | |
| 656 'allowrevins' 'ari' boolean (default off) | |
| 657 global | |
| 658 {not in Vi} | |
| 659 {only available when compiled with the |+rightleft| | |
| 660 feature} | |
| 661 Allow CTRL-_ in Insert and Command-line mode. This is default off, to | |
| 662 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get | |
| 663 into reverse Insert mode, and don't know how to get out. See | |
| 664 'revins'. | |
| 665 NOTE: This option is reset when 'compatible' is set. | |
| 666 | |
| 667 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'* | |
| 668 'altkeymap' 'akm' boolean (default off) | |
| 669 global | |
| 670 {not in Vi} | |
| 671 {only available when compiled with the |+farsi| | |
| 672 feature} | |
| 233 | 673 When on, the second language is Farsi. In editing mode CTRL-_ toggles |
| 7 | 674 the keyboard map between Farsi and English, when 'allowrevins' set. |
| 675 | |
| 233 | 676 When off, the keyboard map toggles between Hebrew and English. This |
| 7 | 677 is useful to start the Vim in native mode i.e. English (left-to-right |
| 678 mode) and have default second language Farsi or Hebrew (right-to-left | |
| 10 | 679 mode). See |farsi.txt|. |
| 7 | 680 |
| 681 *'ambiwidth'* *'ambw'* | |
| 682 'ambiwidth' 'ambw' string (default: "single") | |
| 683 global | |
| 684 {not in Vi} | |
| 685 {only available when compiled with the |+multi_byte| | |
| 686 feature} | |
| 687 Only effective when 'encoding' is "utf-8" or another Unicode encoding. | |
| 688 Tells Vim what to do with characters with East Asian Width Class | |
| 689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek | |
| 690 letters, Cyrillic letters). | |
| 691 | |
| 692 There are currently two possible values: | |
| 233 | 693 "single": Use the same width as characters in US-ASCII. This is |
| 7 | 694 expected by most users. |
| 695 "double": Use twice the width of ASCII characters. | |
|
2492
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
696 *E834* *E835* |
|
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
697 The value "double" cannot be used if 'listchars' or 'fillchars' |
|
c945fdb34ce3
Disallow setting 'ambiwidth' to "double" when 'listchars' or 'fillchars'
Bram Moolenaar <bram@vim.org>
parents:
2490
diff
changeset
|
698 contains a character that would be double width. |
| 7 | 699 |
| 700 There are a number of CJK fonts for which the width of glyphs for | |
| 701 those characters are solely based on how many octets they take in | |
| 702 legacy/traditional CJK encodings. In those encodings, Euro, | |
| 703 Registered sign, Greek/Cyrillic letters are represented by two octets, | |
| 233 | 704 therefore those fonts have "wide" glyphs for them. This is also |
| 7 | 705 true of some line drawing characters used to make tables in text |
| 233 | 706 file. Therefore, when a CJK font is used for GUI Vim or |
| 7 | 707 Vim is running inside a terminal (emulators) that uses a CJK font |
| 708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.), | |
| 709 this option should be set to "double" to match the width perceived | |
| 710 by Vim with the width of glyphs in the font. Perhaps it also has | |
| 711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP | |
| 712 when the system locale is set to one of CJK locales. See Unicode | |
| 713 Standard Annex #11 (http://www.unicode.org/reports/tr11). | |
| 714 | |
| 4229 | 715 Vim may set this option automatically at startup time when Vim is |
| 716 compiled with the |+termresponse| feature and if |t_u7| is set to the | |
| 4264 | 717 escape sequence to request cursor position report. |
| 4229 | 718 |
| 7 | 719 *'antialias'* *'anti'* *'noantialias'* *'noanti'* |
| 720 'antialias' 'anti' boolean (default: off) | |
| 721 global | |
| 722 {not in Vi} | |
| 723 {only available when compiled with GUI enabled | |
| 724 on Mac OS X} | |
| 725 This option only has an effect in the GUI version of Vim on Mac OS X | |
| 726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts, | |
| 727 which can be easier to read at certain sizes on certain displays. | |
| 728 Setting this option can sometimes cause problems if 'guifont' is set | |
| 729 to its default (empty string). | |
| 730 | |
| 731 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'* | |
| 732 'autochdir' 'acd' boolean (default off) | |
| 733 global | |
| 734 {not in Vi} | |
| 2152 | 735 {only available when compiled with it, use |
| 736 exists("+autochdir") to check} | |
| 438 | 737 When on, Vim will change the current working directory whenever you |
| 738 open a file, switch buffers, delete a buffer or open/close a window. | |
| 739 It will change to the directory containing the file which was opened | |
| 740 or selected. | |
| 819 | 741 Note: When this option is on some plugins may not work. |
| 7 | 742 |
| 743 *'arabic'* *'arab'* *'noarabic'* *'noarab'* | |
| 744 'arabic' 'arab' boolean (default off) | |
| 745 local to window | |
| 746 {not in Vi} | |
| 747 {only available when compiled with the |+arabic| | |
| 748 feature} | |
| 749 This option can be set to start editing Arabic text. | |
| 750 Setting this option will: | |
| 751 - Set the 'rightleft' option, unless 'termbidi' is set. | |
| 752 - Set the 'arabicshape' option, unless 'termbidi' is set. | |
| 753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles | |
| 754 between typing English and Arabic key mapping. | |
| 755 - Set the 'delcombine' option | |
| 756 Note that 'encoding' must be "utf-8" for working with Arabic text. | |
| 757 | |
| 758 Resetting this option will: | |
| 759 - Reset the 'rightleft' option. | |
| 760 - Disable the use of 'keymap' (without changing its value). | |
| 761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global | |
| 3557 | 762 option). |
| 7 | 763 Also see |arabic.txt|. |
| 764 | |
| 765 *'arabicshape'* *'arshape'* | |
| 766 *'noarabicshape'* *'noarshape'* | |
| 767 'arabicshape' 'arshape' boolean (default on) | |
| 768 global | |
| 769 {not in Vi} | |
| 770 {only available when compiled with the |+arabic| | |
| 771 feature} | |
| 772 When on and 'termbidi' is off, the required visual character | |
| 773 corrections that need to take place for displaying the Arabic language | |
| 3893 | 774 take effect. Shaping, in essence, gets enabled; the term is a broad |
| 7 | 775 one which encompasses: |
| 776 a) the changing/morphing of characters based on their location | |
| 777 within a word (initial, medial, final and stand-alone). | |
| 778 b) the enabling of the ability to compose characters | |
| 779 c) the enabling of the required combining of some characters | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
780 When disabled the display shows each character's true stand-alone |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
781 form. |
| 7 | 782 Arabic is a complex language which requires other settings, for |
| 783 further details see |arabic.txt|. | |
| 784 | |
| 785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'* | |
| 786 'autoindent' 'ai' boolean (default off) | |
| 787 local to buffer | |
| 788 Copy indent from current line when starting a new line (typing <CR> | |
| 789 in Insert mode or when using the "o" or "O" command). If you do not | |
| 790 type anything on the new line except <BS> or CTRL-D and then type | |
| 1152 | 791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor |
| 792 to another line has the same effect, unless the 'I' flag is included | |
| 793 in 'cpoptions'. | |
| 10 | 794 When autoindent is on, formatting (with the "gq" command or when you |
| 795 reach 'textwidth' in Insert mode) uses the indentation of the first | |
| 796 line. | |
| 7 | 797 When 'smartindent' or 'cindent' is on the indent is changed in |
| 798 a different way. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
799 The 'autoindent' option is reset when the 'paste' option is set and |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
800 restored when 'paste' is reset. |
| 7 | 801 {small difference from Vi: After the indent is deleted when typing |
| 802 <Esc> or <CR>, the cursor position when moving up or down is after the | |
| 803 deleted indent; Vi puts the cursor somewhere in the deleted indent}. | |
| 804 | |
| 805 *'autoread'* *'ar'* *'noautoread'* *'noar'* | |
| 806 'autoread' 'ar' boolean (default off) | |
| 807 global or local to buffer |global-local| | |
| 808 {not in Vi} | |
| 809 When a file has been detected to have been changed outside of Vim and | |
| 810 it has not been changed inside of Vim, automatically read it again. | |
| 811 When the file has been deleted this is not done. |timestamp| | |
| 812 If this option has a local value, use this command to switch back to | |
| 813 using the global value: > | |
| 814 :set autoread< | |
| 815 < | |
| 816 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'* | |
| 817 'autowrite' 'aw' boolean (default off) | |
| 818 global | |
| 819 Write the contents of the file, if it has been modified, on each | |
| 820 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!, | |
| 864 | 821 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I, |
| 7 | 822 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file. |
| 823 Note that for some commands the 'autowrite' option is not used, see | |
| 824 'autowriteall' for that. | |
| 825 | |
| 826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'* | |
| 827 'autowriteall' 'awa' boolean (default off) | |
| 828 global | |
| 829 {not in Vi} | |
| 830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit", | |
| 831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window. | |
| 832 Setting this option also implies that Vim behaves like 'autowrite' has | |
| 833 been set. | |
| 834 | |
| 835 *'background'* *'bg'* | |
| 2826 | 836 'background' 'bg' string (default "dark" or "light", see below) |
| 7 | 837 global |
| 838 {not in Vi} | |
| 839 When set to "dark", Vim will try to use colors that look good on a | |
| 840 dark background. When set to "light", Vim will try to use colors that | |
| 841 look good on a light background. Any other value is illegal. | |
| 842 Vim tries to set the default value according to the terminal used. | |
| 843 This will not always be correct. | |
| 844 Setting this option does not change the background color, it tells Vim | |
| 845 what the background color looks like. For changing the background | |
| 846 color, see |:hi-normal|. | |
| 847 | |
| 848 When 'background' is set Vim will adjust the default color groups for | |
| 10 | 849 the new value. But the colors used for syntax highlighting will not |
| 1621 | 850 change. *g:colors_name* |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
851 When a color scheme is loaded (the "g:colors_name" variable is set) |
| 7 | 852 setting 'background' will cause the color scheme to be reloaded. If |
| 853 the color scheme adjusts to the value of 'background' this will work. | |
| 854 However, if the color scheme sets 'background' itself the effect may | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
855 be undone. First delete the "g:colors_name" variable when needed. |
| 7 | 856 |
| 857 When setting 'background' to the default value with: > | |
| 858 :set background& | |
| 859 < Vim will guess the value. In the GUI this should work correctly, | |
| 860 in other cases Vim might not be able to guess the right value. | |
| 861 | |
| 862 When starting the GUI, the default value for 'background' will be | |
| 863 "light". When the value is not set in the .gvimrc, and Vim detects | |
| 864 that the background is actually quite dark, 'background' is set to | |
| 865 "dark". But this happens only AFTER the .gvimrc file has been read | |
| 866 (because the window needs to be opened to find the actual background | |
| 867 color). To get around this, force the GUI window to be opened by | |
| 868 putting a ":gui" command in the .gvimrc file, before where the value | |
| 869 of 'background' is used (e.g., before ":syntax on"). | |
| 2826 | 870 |
| 871 For MS-DOS, Windows and OS/2 the default is "dark". | |
| 872 For other systems "dark" is used when 'term' is "linux", | |
| 873 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark | |
| 874 background. Otherwise the default is "light". | |
| 875 | |
| 7 | 876 Normally this option would be set in the .vimrc file. Possibly |
| 877 depending on the terminal name. Example: > | |
| 878 :if &term == "pcterm" | |
| 879 : set background=dark | |
| 880 :endif | |
| 881 < When this option is set, the default settings for the highlight groups | |
| 882 will change. To use other settings, place ":highlight" commands AFTER | |
| 883 the setting of the 'background' option. | |
| 884 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file | |
| 885 to select the colors for syntax highlighting. After changing this | |
| 886 option, you must load syntax.vim again to see the result. This can be | |
| 887 done with ":syntax on". | |
| 888 | |
| 889 *'backspace'* *'bs'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
890 'backspace' 'bs' string (default "", set to "indent,eol,start" |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
891 in |defaults.vim|) |
| 7 | 892 global |
| 893 {not in Vi} | |
| 894 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert | |
| 895 mode. This is a list of items, separated by commas. Each item allows | |
| 896 a way to backspace over something: | |
| 897 value effect ~ | |
| 898 indent allow backspacing over autoindent | |
| 899 eol allow backspacing over line breaks (join lines) | |
| 900 start allow backspacing over the start of insert; CTRL-W and CTRL-U | |
| 901 stop once at the start of insert. | |
| 902 | |
| 903 When the value is empty, Vi compatible backspacing is used. | |
| 904 | |
| 905 For backwards compatibility with version 5.4 and earlier: | |
| 906 value effect ~ | |
| 907 0 same as ":set backspace=" (Vi compatible) | |
| 908 1 same as ":set backspace=indent,eol" | |
| 909 2 same as ":set backspace=indent,eol,start" | |
| 910 | |
| 911 See |:fixdel| if your <BS> or <Del> key does not do what you want. | |
| 912 NOTE: This option is set to "" when 'compatible' is set. | |
| 913 | |
| 914 *'backup'* *'bk'* *'nobackup'* *'nobk'* | |
| 915 'backup' 'bk' boolean (default off) | |
| 916 global | |
| 917 {not in Vi} | |
| 918 Make a backup before overwriting a file. Leave it around after the | |
| 919 file has been successfully written. If you do not want to keep the | |
| 920 backup file, but you do want a backup while the file is being | |
| 921 written, reset this option and set the 'writebackup' option (this is | |
| 922 the default). If you do not want a backup file at all reset both | |
| 10 | 923 options (use this if your file system is almost full). See the |
| 7 | 924 |backup-table| for more explanations. |
| 925 When the 'backupskip' pattern matches, a backup is not made anyway. | |
| 926 When 'patchmode' is set, the backup may be renamed to become the | |
| 927 oldest version of a file. | |
| 928 NOTE: This option is reset when 'compatible' is set. | |
| 929 | |
| 930 *'backupcopy'* *'bkc'* | |
| 931 'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto") | |
| 6243 | 932 global or local to buffer |global-local| |
| 7 | 933 {not in Vi} |
| 934 When writing a file and a backup is made, this option tells how it's | |
| 935 done. This is a comma separated list of words. | |
| 936 | |
| 937 The main values are: | |
| 938 "yes" make a copy of the file and overwrite the original one | |
| 939 "no" rename the file and write a new one | |
| 940 "auto" one of the previous, what works best | |
| 941 | |
| 942 Extra values that can be combined with the ones above are: | |
| 943 "breaksymlink" always break symlinks when writing | |
| 944 "breakhardlink" always break hardlinks when writing | |
| 945 | |
| 946 Making a copy and overwriting the original file: | |
| 947 - Takes extra time to copy the file. | |
| 948 + When the file has special attributes, is a (hard/symbolic) link or | |
| 949 has a resource fork, all this is preserved. | |
| 950 - When the file is a link the backup will have the name of the link, | |
| 951 not of the real file. | |
| 952 | |
| 953 Renaming the file and writing a new one: | |
| 954 + It's fast. | |
| 955 - Sometimes not all attributes of the file can be copied to the new | |
| 956 file. | |
| 957 - When the file is a link the new file will not be a link. | |
| 958 | |
| 959 The "auto" value is the middle way: When Vim sees that renaming file | |
| 960 is possible without side effects (the attributes can be passed on and | |
| 1152 | 961 the file is not a link) that is used. When problems are expected, a |
| 962 copy will be made. | |
| 7 | 963 |
| 964 The "breaksymlink" and "breakhardlink" values can be used in | |
| 965 combination with any of "yes", "no" and "auto". When included, they | |
| 966 force Vim to always break either symbolic or hard links by doing | |
| 967 exactly what the "no" option does, renaming the original file to | |
| 968 become the backup and writing a new file in its place. This can be | |
| 969 useful for example in source trees where all the files are symbolic or | |
| 970 hard links and any changes should stay in the local source tree, not | |
| 971 be propagated back to the original source. | |
| 972 *crontab* | |
| 973 One situation where "no" and "auto" will cause problems: A program | |
| 974 that opens a file, invokes Vim to edit that file, and then tests if | |
| 975 the open file was changed (through the file descriptor) will check the | |
| 10 | 976 backup file instead of the newly created file. "crontab -e" is an |
| 7 | 977 example. |
| 978 | |
| 979 When a copy is made, the original file is truncated and then filled | |
| 980 with the new text. This means that protection bits, owner and | |
| 981 symbolic links of the original file are unmodified. The backup file | |
| 10 | 982 however, is a new file, owned by the user who edited the file. The |
| 7 | 983 group of the backup is set to the group of the original file. If this |
| 984 fails, the protection bits for the group are made the same as for | |
| 985 others. | |
| 986 | |
| 987 When the file is renamed this is the other way around: The backup has | |
| 988 the same attributes of the original file, and the newly written file | |
| 989 is owned by the current user. When the file was a (hard/symbolic) | |
| 990 link, the new file will not! That's why the "auto" value doesn't | |
| 991 rename when the file is a link. The owner and group of the newly | |
| 992 written file will be set to the same ones as the original file, but | |
| 993 the system may refuse to do this. In that case the "auto" value will | |
| 994 again not rename the file. | |
| 995 | |
| 996 *'backupdir'* *'bdir'* | |
| 997 'backupdir' 'bdir' string (default for Amiga: ".,t:", | |
| 5555 | 998 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp" |
| 7 | 999 for Unix: ".,~/tmp,~/") |
| 1000 global | |
| 1001 {not in Vi} | |
| 1002 List of directories for the backup file, separated with commas. | |
| 1003 - The backup file will be created in the first directory in the list | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1004 where this is possible. The directory must exist, Vim will not |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1005 create it for you. |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1006 - Empty means that no backup file will be created ('patchmode' is |
| 7 | 1007 impossible!). Writing may fail because of this. |
| 1008 - A directory "." means to put the backup file in the same directory | |
| 1009 as the edited file. | |
| 33 | 1010 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
| 7 | 1011 put the backup file relative to where the edited file is. The |
| 1012 leading "." is replaced with the path name of the edited file. | |
| 1013 ("." inside a directory name has no special meaning). | |
| 1014 - Spaces after the comma are ignored, other spaces are considered part | |
| 1015 of the directory name. To have a space at the start of a directory | |
| 1016 name, precede it with a backslash. | |
| 1017 - To include a comma in a directory name precede it with a backslash. | |
| 1018 - A directory name may end in an '/'. | |
| 1019 - Environment variables are expanded |:set_env|. | |
| 1020 - Careful with '\' characters, type one before a space, type two to | |
| 1021 get one in the option (see |option-backslash|), for example: > | |
| 1022 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 1023 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 1024 of the option is removed. | |
| 1025 See also 'backup' and 'writebackup' options. | |
| 1026 If you want to hide your backup files on Unix, consider this value: > | |
| 1027 :set backupdir=./.backup,~/.backup,.,/tmp | |
| 1028 < You must create a ".backup" directory in each directory and in your | |
| 1029 home directory for this to work properly. | |
| 1030 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 1031 directories from the list. This avoids problems when a future version | |
| 1032 uses another default. | |
| 1033 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1034 security reasons. | |
| 1035 | |
| 1036 *'backupext'* *'bex'* *E589* | |
| 1037 'backupext' 'bex' string (default "~", for VMS: "_") | |
| 1038 global | |
| 1039 {not in Vi} | |
| 1040 String which is appended to a file name to make the name of the | |
| 1041 backup file. The default is quite unusual, because this avoids | |
| 1042 accidentally overwriting existing files with a backup file. You might | |
| 1043 prefer using ".bak", but make sure that you don't have files with | |
| 1044 ".bak" that you want to keep. | |
| 36 | 1045 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 1046 |
| 26 | 1047 If you like to keep a lot of backups, you could use a BufWritePre |
| 1048 autocommand to change 'backupext' just before writing the file to | |
| 1049 include a timestamp. > | |
| 1050 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~' | |
| 1051 < Use 'backupdir' to put the backup in a different directory. | |
| 1052 | |
| 7 | 1053 *'backupskip'* *'bsk'* |
| 1054 'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*") | |
| 1055 global | |
| 1056 {not in Vi} | |
| 1057 {not available when compiled without the |+wildignore| | |
| 1058 feature} | |
| 1059 A list of file patterns. When one of the patterns matches with the | |
| 1060 name of the file which is written, no backup file is created. Both | |
| 1061 the specified file name and the full path name of the file are used. | |
| 1062 The pattern is used like with |:autocmd|, see |autocmd-patterns|. | |
| 1063 Watch out for special characters, see |option-backslash|. | |
| 1064 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the | |
| 233 | 1065 default value. "/tmp/*" is only used for Unix. |
| 1152 | 1066 |
| 3513 | 1067 WARNING: Not having a backup file means that when Vim fails to write |
| 1068 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 1069 lose both the original file and what you were writing. Only disable | |
| 1070 backups if you don't care about losing the file. | |
| 1071 | |
| 1152 | 1072 Note that environment variables are not expanded. If you want to use |
| 1073 $HOME you must expand it explicitly, e.g.: > | |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1074 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*' |
| 1152 | 1075 |
| 1076 < Note that the default also makes sure that "crontab -e" works (when a | |
| 557 | 1077 backup would be made by renaming the original file crontab won't see |
| 1078 the newly created file). Also see 'backupcopy' and |crontab|. | |
| 7 | 1079 |
| 1080 *'balloondelay'* *'bdlay'* | |
| 1081 'balloondelay' 'bdlay' number (default: 600) | |
| 1082 global | |
| 1083 {not in Vi} | |
| 1084 {only available when compiled with the |+balloon_eval| | |
| 1085 feature} | |
| 1086 Delay in milliseconds before a balloon may pop up. See |balloon-eval|. | |
| 1087 | |
| 1088 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'* | |
| 1089 'ballooneval' 'beval' boolean (default off) | |
| 1090 global | |
| 1091 {not in Vi} | |
| 1092 {only available when compiled with the |+balloon_eval| | |
| 189 | 1093 feature} |
| 7 | 1094 Switch on the |balloon-eval| functionality. |
| 1095 | |
| 189 | 1096 *'balloonexpr'* *'bexpr'* |
| 1097 'balloonexpr' 'bexpr' string (default "") | |
| 790 | 1098 global or local to buffer |global-local| |
| 189 | 1099 {not in Vi} |
| 1100 {only available when compiled with the |+balloon_eval| | |
| 1101 feature} | |
| 782 | 1102 Expression for text to show in evaluation balloon. It is only used |
| 1103 when 'ballooneval' is on. These variables can be used: | |
| 189 | 1104 |
| 1105 v:beval_bufnr number of the buffer in which balloon is going to show | |
| 1106 v:beval_winnr number of the window | |
|
9227
ecb621205ed1
commit https://github.com/vim/vim/commit/82af8710bf8d1caeeceafb1370a052cb7d92f076
Christian Brabandt <cb@256bit.org>
parents:
9116
diff
changeset
|
1107 v:beval_winid ID of the window |
| 189 | 1108 v:beval_lnum line number |
| 1109 v:beval_col column number (byte index) | |
| 1110 v:beval_text word under or after the mouse pointer | |
| 1111 | |
| 1112 The evaluation of the expression must not have side effects! | |
| 1113 Example: > | |
| 1114 function! MyBalloonExpr() | |
| 435 | 1115 return 'Cursor is at line ' . v:beval_lnum . |
| 189 | 1116 \', column ' . v:beval_col . |
| 1117 \ ' of file ' . bufname(v:beval_bufnr) . | |
| 1118 \ ' on word "' . v:beval_text . '"' | |
| 1119 endfunction | |
| 1120 set bexpr=MyBalloonExpr() | |
| 1121 set ballooneval | |
| 1122 < | |
| 1123 NOTE: The balloon is displayed only if the cursor is on a text | |
| 1124 character. If the result of evaluating 'balloonexpr' is not empty, | |
| 1125 Vim does not try to send a message to an external debugger (Netbeans | |
| 1126 or Sun Workshop). | |
| 1127 | |
| 3682 | 1128 The expression will be evaluated in the |sandbox| when set from a |
| 1129 modeline, see |sandbox-option|. | |
| 634 | 1130 |
| 1131 It is not allowed to change text or jump to another window while | |
| 1132 evaluating 'balloonexpr' |textlock|. | |
| 1133 | |
| 446 | 1134 To check whether line breaks in the balloon text work use this check: > |
| 435 | 1135 if has("balloon_multiline") |
| 714 | 1136 < When they are supported "\n" characters will start a new line. If the |
| 1137 expression evaluates to a |List| this is equal to using each List item | |
| 1138 as a string and putting "\n" in between them. | |
| 1139 | |
| 6949 | 1140 *'belloff'* *'bo'* |
| 1141 'belloff' 'bo' string (default "") | |
| 1142 global | |
| 1143 {not in Vi} | |
| 1144 Specifies for which events the bell will not be rung. It is a comma | |
| 1145 separated list of items. For each item that is present, the bell | |
| 1146 will be silenced. This is most useful to specify specific events in | |
| 1147 insert mode to be silenced. | |
| 1148 | |
| 1149 item meaning when present ~ | |
| 1150 all All events. | |
| 1151 backspace When hitting <BS> or <Del> and deleting results in an | |
| 1152 error. | |
| 1153 cursor Fail to move around using the cursor keys or | |
| 1154 <PageUp>/<PageDown> in |Insert-mode|. | |
| 1155 complete Error occurred when using |i_CTRL-X_CTRL-K| or | |
| 1156 |i_CTRL-X_CTRL-T|. | |
| 1157 copy Cannot copy char from insert mode using |i_CTRL-Y| or | |
| 1158 |i_CTRL-E|. | |
| 1159 ctrlg Unknown Char after <C-G> in Insert mode. | |
| 1160 error Other Error occurred (e.g. try to join last line) | |
| 1161 (mostly used in |Normal-mode| or |Cmdline-mode|). | |
| 1162 esc hitting <Esc> in |Normal-mode|. | |
| 1163 ex In |Visual-mode|, hitting |Q| results in an error. | |
| 1164 hangul Error occurred when using hangul input. | |
| 1165 insertmode Pressing <Esc> in 'insertmode'. | |
| 1166 lang Calling the beep module for Lua/Mzscheme/TCL. | |
| 1167 mess No output available for |g<|. | |
| 1168 showmatch Error occurred for 'showmatch' function. | |
| 1169 operator Empty region error |cpo-E|. | |
| 1170 register Unknown register after <C-R> in |Insert-mode|. | |
| 1171 shell Bell from shell output |:!|. | |
| 1172 spell Error happened on spell suggest. | |
| 1173 wildmode More matches in |cmdline-completion| available | |
| 1174 (depends on the 'wildmode' setting). | |
| 1175 | |
| 1176 This is most useful, to fine tune when in insert mode the bell should | |
| 1177 be rung. For normal mode and ex commands, the bell is often rung to | |
| 1178 indicate that an error occurred. It can be silenced by adding the | |
| 1179 "error" keyword. | |
| 1180 | |
| 7 | 1181 *'binary'* *'bin'* *'nobinary'* *'nobin'* |
| 1182 'binary' 'bin' boolean (default off) | |
| 1183 local to buffer | |
| 1184 {not in Vi} | |
| 1185 This option should be set before editing a binary file. You can also | |
| 1186 use the |-b| Vim argument. When this option is switched on a few | |
| 1187 options will be changed (also when it already was on): | |
| 1188 'textwidth' will be set to 0 | |
| 1189 'wrapmargin' will be set to 0 | |
| 1190 'modeline' will be off | |
| 1191 'expandtab' will be off | |
| 1192 Also, 'fileformat' and 'fileformats' options will not be used, the | |
| 1193 file is read and written like 'fileformat' was "unix" (a single <NL> | |
| 1194 separates lines). | |
| 1195 The 'fileencoding' and 'fileencodings' options will not be used, the | |
| 1196 file is read without conversion. | |
| 1197 NOTE: When you start editing a(nother) file while the 'bin' option is | |
| 1198 on, settings from autocommands may change the settings again (e.g., | |
| 1199 'textwidth'), causing trouble when editing. You might want to set | |
| 1200 'bin' again when the file has been loaded. | |
| 1201 The previous values of these options are remembered and restored when | |
| 1202 'bin' is switched from on to off. Each buffer has its own set of | |
| 1203 saved option values. | |
| 1204 To edit a file with 'binary' set you can use the |++bin| argument. | |
| 1205 This avoids you have to do ":set bin", which would have effect for all | |
| 1206 files you edit. | |
| 1207 When writing a file the <EOL> for the last line is only written if | |
| 1208 there was one in the original file (normally Vim appends an <EOL> to | |
| 1209 the last line if there is none; this would make the file longer). See | |
| 1210 the 'endofline' option. | |
| 1211 | |
| 1212 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'* | |
| 1213 'bioskey' 'biosk' boolean (default on) | |
| 1214 global | |
| 1215 {not in Vi} {only for MS-DOS} | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1216 This was for MS-DOS and is no longer supported. |
| 7 | 1217 |
| 1218 *'bomb'* *'nobomb'* | |
| 1219 'bomb' boolean (default off) | |
| 1220 local to buffer | |
| 1221 {not in Vi} | |
| 1222 {only available when compiled with the |+multi_byte| | |
| 1223 feature} | |
| 1224 When writing a file and the following conditions are met, a BOM (Byte | |
| 1225 Order Mark) is prepended to the file: | |
| 1226 - this option is on | |
| 1227 - the 'binary' option is off | |
| 1228 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big | |
| 1229 endian variants. | |
| 1230 Some applications use the BOM to recognize the encoding of the file. | |
| 1231 Often used for UCS-2 files on MS-Windows. For other applications it | |
| 1232 causes trouble, for example: "cat file1 file2" makes the BOM of file2 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1233 appear halfway the resulting file. Gcc doesn't accept a BOM. |
| 7 | 1234 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a |
| 1235 check for the presence of the BOM is done and 'bomb' set accordingly. | |
| 1236 Unless 'binary' is set, it is removed from the first line, so that you | |
| 1237 don't see it when editing. When you don't change the options, the BOM | |
| 1238 will be restored when writing the file. | |
| 1239 | |
| 1240 *'breakat'* *'brk'* | |
| 1241 'breakat' 'brk' string (default " ^I!@*-+;:,./?") | |
| 1242 global | |
| 1243 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1244 {not available when compiled without the |+linebreak| |
| 7 | 1245 feature} |
| 1246 This option lets you choose which characters might cause a line | |
| 500 | 1247 break if 'linebreak' is on. Only works for ASCII and also for 8-bit |
| 1248 characters when 'encoding' is an 8-bit encoding. | |
| 7 | 1249 |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
1250 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'* |
| 6009 | 1251 'breakindent' 'bri' boolean (default off) |
| 1252 local to window | |
| 1253 {not in Vi} | |
| 1254 {not available when compiled without the |+linebreak| | |
| 1255 feature} | |
| 1256 Every wrapped line will continue visually indented (same amount of | |
| 1257 space as the beginning of that line), thus preserving horizontal blocks | |
| 1258 of text. | |
| 1259 | |
| 1260 *'breakindentopt'* *'briopt'* | |
| 1261 'breakindentopt' 'briopt' string (default empty) | |
| 1262 local to window | |
| 1263 {not in Vi} | |
| 1264 {not available when compiled without the |+linebreak| | |
| 1265 feature} | |
| 1266 Settings for 'breakindent'. It can consist of the following optional | |
| 6026 | 1267 items and must be separated by a comma: |
| 6009 | 1268 min:{n} Minimum text width that will be kept after |
| 1269 applying 'breakindent', even if the resulting | |
| 1270 text should normally be narrower. This prevents | |
| 1271 text indented almost to the right window border | |
| 1272 occupying lot of vertical space when broken. | |
| 6026 | 1273 shift:{n} After applying 'breakindent', the wrapped line's |
| 1274 beginning will be shifted by the given number of | |
| 1275 characters. It permits dynamic French paragraph | |
| 6009 | 1276 indentation (negative) or emphasizing the line |
| 1277 continuation (positive). | |
| 1278 sbr Display the 'showbreak' value before applying the | |
| 1279 additional indent. | |
| 1280 The default value for min is 20 and shift is 0. | |
| 1281 | |
| 7 | 1282 *'browsedir'* *'bsdir'* |
| 29 | 1283 'browsedir' 'bsdir' string (default: "last") |
| 7 | 1284 global |
| 1621 | 1285 {not in Vi} {only for Motif, Athena, GTK, Mac and |
| 1286 Win32 GUI} | |
| 7 | 1287 Which directory to use for the file browser: |
| 1621 | 1288 last Use same directory as with last file browser, where a |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
1289 file was opened or saved. |
| 7 | 1290 buffer Use the directory of the related buffer. |
| 1291 current Use the current directory. | |
| 1292 {path} Use the specified directory | |
| 1293 | |
| 1294 *'bufhidden'* *'bh'* | |
| 1295 'bufhidden' 'bh' string (default: "") | |
| 1296 local to buffer | |
| 1297 {not in Vi} | |
| 1298 {not available when compiled without the |+quickfix| | |
| 1299 feature} | |
| 1300 This option specifies what happens when a buffer is no longer | |
| 1301 displayed in a window: | |
| 1302 <empty> follow the global 'hidden' option | |
| 1303 hide hide the buffer (don't unload it), also when 'hidden' | |
| 1304 is not set | |
| 1305 unload unload the buffer, also when 'hidden' is set or using | |
| 1306 |:hide| | |
| 1307 delete delete the buffer from the buffer list, also when | |
| 1308 'hidden' is set or using |:hide|, like using | |
| 1309 |:bdelete| | |
| 1310 wipe wipe out the buffer from the buffer list, also when | |
| 1311 'hidden' is set or using |:hide|, like using | |
| 1312 |:bwipeout| | |
| 1313 | |
| 82 | 1314 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer |
| 3224 | 1315 are lost without a warning. Also, these values may break autocommands |
| 1316 that switch between buffers temporarily. | |
| 7 | 1317 This option is used together with 'buftype' and 'swapfile' to specify |
| 1318 special kinds of buffers. See |special-buffers|. | |
| 1319 | |
| 1320 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85* | |
| 1321 'buflisted' 'bl' boolean (default: on) | |
| 1322 local to buffer | |
| 1323 {not in Vi} | |
| 1324 When this option is set, the buffer shows up in the buffer list. If | |
| 1325 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc. | |
| 1326 This option is reset by Vim for buffers that are only used to remember | |
| 1327 a file name or marks. Vim sets it when starting to edit a buffer. | |
| 1328 But not when moving to a buffer with ":buffer". | |
| 1329 | |
| 1330 *'buftype'* *'bt'* *E382* | |
| 1331 'buftype' 'bt' string (default: "") | |
| 1332 local to buffer | |
| 1333 {not in Vi} | |
| 1334 {not available when compiled without the |+quickfix| | |
| 1335 feature} | |
| 1336 The value of this option specifies the type of a buffer: | |
| 1337 <empty> normal buffer | |
| 1338 nofile buffer which is not related to a file and will not be | |
| 1339 written | |
| 1340 nowrite buffer which will not be written | |
| 17 | 1341 acwrite buffer which will always be written with BufWriteCmd |
| 856 | 1342 autocommands. {not available when compiled without the |
| 17 | 1343 |+autocmd| feature} |
| 7 | 1344 quickfix quickfix buffer, contains list of errors |:cwindow| |
| 648 | 1345 or list of locations |:lwindow| |
| 7 | 1346 help help buffer (you are not supposed to set this |
| 1347 manually) | |
| 1348 | |
| 1349 This option is used together with 'bufhidden' and 'swapfile' to | |
| 1350 specify special kinds of buffers. See |special-buffers|. | |
| 1351 | |
| 1352 Be careful with changing this option, it can have many side effects! | |
| 1353 | |
| 648 | 1354 A "quickfix" buffer is only used for the error list and the location |
| 1355 list. This value is set by the |:cwindow| and |:lwindow| commands and | |
| 1356 you are not supposed to change it. | |
| 7 | 1357 |
| 1358 "nofile" and "nowrite" buffers are similar: | |
| 1359 both: The buffer is not to be written to disk, ":w" doesn't | |
| 1360 work (":w filename" does work though). | |
| 1361 both: The buffer is never considered to be |'modified'|. | |
| 1362 There is no warning when the changes will be lost, for | |
| 1363 example when you quit Vim. | |
| 1364 both: A swap file is only created when using too much memory | |
| 1365 (when 'swapfile' has been reset there is never a swap | |
| 1366 file). | |
| 1367 nofile only: The buffer name is fixed, it is not handled like a | |
| 1368 file name. It is not modified in response to a |:cd| | |
| 1369 command. | |
| 6647 | 1370 both: When using ":e bufname" and already editing "bufname" |
| 1371 the buffer is made empty and autocommands are | |
| 1372 triggered as usual for |:edit|. | |
| 17 | 1373 *E676* |
| 1374 "acwrite" implies that the buffer name is not related to a file, like | |
| 1375 "nofile", but it will be written. Thus, in contrast to "nofile" and | |
| 1376 "nowrite", ":w" does work and a modified buffer can't be abandoned | |
| 1377 without saving. For writing there must be matching |BufWriteCmd|, | |
| 1378 |FileWriteCmd| or |FileAppendCmd| autocommands. | |
| 7 | 1379 |
| 1380 *'casemap'* *'cmp'* | |
| 1381 'casemap' 'cmp' string (default: "internal,keepascii") | |
| 1382 global | |
| 1383 {not in Vi} | |
| 804 | 1384 {only available when compiled with the |+multi_byte| |
| 1385 feature} | |
| 7 | 1386 Specifies details about changing the case of letters. It may contain |
| 1387 these words, separated by a comma: | |
| 1388 internal Use internal case mapping functions, the current | |
| 1389 locale does not change the case mapping. This only | |
| 493 | 1390 matters when 'encoding' is a Unicode encoding, |
| 1391 "latin1" or "iso-8859-15". When "internal" is | |
| 1392 omitted, the towupper() and towlower() system library | |
| 1393 functions are used when available. | |
| 7 | 1394 keepascii For the ASCII characters (0x00 to 0x7f) use the US |
| 1395 case mapping, the current locale is not effective. | |
| 1396 This probably only matters for Turkish. | |
| 1397 | |
| 1398 *'cdpath'* *'cd'* *E344* *E346* | |
| 1399 'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,") | |
| 1400 global | |
| 1401 {not in Vi} | |
| 1402 {not available when compiled without the | |
| 1403 |+file_in_path| feature} | |
| 1404 This is a list of directories which will be searched when using the | |
| 1405 |:cd| and |:lcd| commands, provided that the directory being searched | |
| 1668 | 1406 for has a relative path, not an absolute part starting with "/", "./" |
| 1407 or "../", the 'cdpath' option is not used then. | |
| 7 | 1408 The 'cdpath' option's value has the same form and semantics as |
| 1409 |'path'|. Also see |file-searching|. | |
| 1410 The default value is taken from $CDPATH, with a "," prepended to look | |
| 1411 in the current directory first. | |
| 1412 If the default value taken from $CDPATH is not what you want, include | |
| 1413 a modified version of the following command in your vimrc file to | |
| 1414 override it: > | |
| 1415 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g') | |
| 1416 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1417 security reasons. | |
| 1418 (parts of 'cdpath' can be passed to the shell to expand file names). | |
| 1419 | |
| 1420 *'cedit'* | |
| 1421 'cedit' string (Vi default: "", Vim default: CTRL-F) | |
| 1422 global | |
| 1423 {not in Vi} | |
| 1424 {not available when compiled without the |+vertsplit| | |
| 1425 feature} | |
| 1426 The key used in Command-line Mode to open the command-line window. | |
| 1427 The default is CTRL-F when 'compatible' is off. | |
| 1428 Only non-printable keys are allowed. | |
| 1429 The key can be specified as a single character, but it is difficult to | |
| 1430 type. The preferred way is to use the <> notation. Examples: > | |
|
9407
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1431 :exe "set cedit=\<C-Y>" |
|
619a98a67f67
commit https://github.com/vim/vim/commit/e18dbe865d190e74fb5d43ac8bc6ac22507d0223
Christian Brabandt <cb@256bit.org>
parents:
9344
diff
changeset
|
1432 :exe "set cedit=\<Esc>" |
| 7 | 1433 < |Nvi| also has this option, but it only uses the first character. |
| 1434 See |cmdwin|. | |
| 1435 | |
| 1436 *'charconvert'* *'ccv'* *E202* *E214* *E513* | |
| 1437 'charconvert' 'ccv' string (default "") | |
| 1438 global | |
| 1439 {only available when compiled with the |+multi_byte| | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1440 and |+eval| features} |
| 7 | 1441 {not in Vi} |
| 1442 An expression that is used for character encoding conversion. It is | |
| 1443 evaluated when a file that is to be read or has been written has a | |
| 1444 different encoding from what is desired. | |
| 1445 'charconvert' is not used when the internal iconv() function is | |
| 1446 supported and is able to do the conversion. Using iconv() is | |
| 1447 preferred, because it is much faster. | |
| 1448 'charconvert' is not used when reading stdin |--|, because there is no | |
| 1449 file to convert from. You will have to save the text in a file first. | |
| 1450 The expression must return zero or an empty string for success, | |
| 1451 non-zero for failure. | |
| 1452 The possible encoding names encountered are in 'encoding'. | |
| 1453 Additionally, names given in 'fileencodings' and 'fileencoding' are | |
| 1454 used. | |
| 1455 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8" | |
| 1456 is done internally by Vim, 'charconvert' is not used for this. | |
| 1457 'charconvert' is also used to convert the viminfo file, if the 'c' | |
| 1458 flag is present in 'viminfo'. Also used for Unicode conversion. | |
| 1459 Example: > | |
| 1460 set charconvert=CharConvert() | |
| 1461 fun CharConvert() | |
| 1462 system("recode " | |
| 1463 \ . v:charconvert_from . ".." . v:charconvert_to | |
| 1464 \ . " <" . v:fname_in . " >" v:fname_out) | |
| 1465 return v:shell_error | |
| 1466 endfun | |
| 1467 < The related Vim variables are: | |
| 1468 v:charconvert_from name of the current encoding | |
| 1469 v:charconvert_to name of the desired encoding | |
| 1470 v:fname_in name of the input file | |
| 1471 v:fname_out name of the output file | |
| 1472 Note that v:fname_in and v:fname_out will never be the same. | |
| 1473 Note that v:charconvert_from and v:charconvert_to may be different | |
| 1474 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. | |
| 1475 Encryption is not done by Vim when using 'charconvert'. If you want | |
| 1476 to encrypt the file after conversion, 'charconvert' should take care | |
| 1477 of this. | |
| 1478 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 1479 security reasons. | |
| 1480 | |
| 1481 *'cindent'* *'cin'* *'nocindent'* *'nocin'* | |
| 1482 'cindent' 'cin' boolean (default off) | |
| 1483 local to buffer | |
| 1484 {not in Vi} | |
| 1485 {not available when compiled without the |+cindent| | |
| 1486 feature} | |
| 1621 | 1487 Enables automatic C program indenting. See 'cinkeys' to set the keys |
| 7 | 1488 that trigger reindenting in insert mode and 'cinoptions' to set your |
| 1489 preferred indent style. | |
| 1490 If 'indentexpr' is not empty, it overrules 'cindent'. | |
| 1491 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty, | |
| 1492 the "=" operator indents using this algorithm rather than calling an | |
| 1493 external program. | |
| 1494 See |C-indenting|. | |
| 1495 When you don't like the way 'cindent' works, try the 'smartindent' | |
| 1496 option or 'indentexpr'. | |
| 1497 This option is not used when 'paste' is set. | |
| 1498 NOTE: This option is reset when 'compatible' is set. | |
| 1499 | |
| 1500 *'cinkeys'* *'cink'* | |
| 1501 'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e") | |
| 1502 local to buffer | |
| 1503 {not in Vi} | |
| 1504 {not available when compiled without the |+cindent| | |
| 1505 feature} | |
| 1506 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 1507 the current line. Only used if 'cindent' is on and 'indentexpr' is | |
| 1508 empty. | |
| 1509 For the format of this option see |cinkeys-format|. | |
| 1510 See |C-indenting|. | |
| 1511 | |
| 1512 *'cinoptions'* *'cino'* | |
| 1513 'cinoptions' 'cino' string (default "") | |
| 1514 local to buffer | |
| 1515 {not in Vi} | |
| 1516 {not available when compiled without the |+cindent| | |
| 1517 feature} | |
| 1518 The 'cinoptions' affect the way 'cindent' reindents lines in a C | |
| 1519 program. See |cinoptions-values| for the values of this option, and | |
| 1520 |C-indenting| for info on C indenting in general. | |
| 1521 | |
| 1522 | |
| 1523 *'cinwords'* *'cinw'* | |
| 1524 'cinwords' 'cinw' string (default "if,else,while,do,for,switch") | |
| 1525 local to buffer | |
| 1526 {not in Vi} | |
| 1527 {not available when compiled without both the | |
| 1528 |+cindent| and the |+smartindent| features} | |
| 1529 These keywords start an extra indent in the next line when | |
| 1530 'smartindent' or 'cindent' is set. For 'cindent' this is only done at | |
| 1531 an appropriate place (inside {}). | |
| 1532 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't | |
| 1533 matter, include the keyword both the uppercase and lowercase: | |
| 1534 "if,If,IF". | |
| 1535 | |
| 1536 *'clipboard'* *'cb'* | |
| 1537 'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux" | |
| 1538 for X-windows, "" otherwise) | |
| 1539 global | |
| 1540 {not in Vi} | |
| 1541 {only in GUI versions or when the |+xterm_clipboard| | |
| 1542 feature is included} | |
| 1543 This option is a list of comma separated names. | |
| 1544 These names are recognized: | |
| 1545 | |
| 3674 | 1546 *clipboard-unnamed* |
| 7 | 1547 unnamed When included, Vim will use the clipboard register '*' |
| 1548 for all yank, delete, change and put operations which | |
| 1549 would normally go to the unnamed register. When a | |
| 1550 register is explicitly specified, it will always be | |
| 1551 used regardless of whether "unnamed" is in 'clipboard' | |
| 1552 or not. The clipboard register can always be | |
| 1553 explicitly accessed using the "* notation. Also see | |
| 1554 |gui-clipboard|. | |
| 1555 | |
| 3682 | 1556 *clipboard-unnamedplus* |
| 4119 | 1557 unnamedplus A variant of the "unnamed" flag which uses the |
| 1558 clipboard register '+' (|quoteplus|) instead of | |
| 1559 register '*' for all yank, delete, change and put | |
| 1560 operations which would normally go to the unnamed | |
| 1561 register. When "unnamed" is also included to the | |
| 1562 option, yank operations (but not delete, change or | |
| 1563 put) will additionally copy the text into register | |
| 1564 '*'. | |
| 2662 | 1565 Only available with the |+X11| feature. |
| 2654 | 1566 Availability can be checked with: > |
| 1567 if has('unnamedplus') | |
| 1568 < | |
| 3682 | 1569 *clipboard-autoselect* |
| 7 | 1570 autoselect Works like the 'a' flag in 'guioptions': If present, |
| 1571 then whenever Visual mode is started, or the Visual | |
| 1572 area extended, Vim tries to become the owner of the | |
| 1573 windowing system's global selection or put the | |
| 1574 selected text on the clipboard used by the selection | |
| 1575 register "*. See |guioptions_a| and |quotestar| for | |
| 1576 details. When the GUI is active, the 'a' flag in | |
| 1577 'guioptions' is used, when the GUI is not active, this | |
| 1578 "autoselect" flag is used. | |
| 1579 Also applies to the modeless selection. | |
| 1580 | |
| 3674 | 1581 *clipboard-autoselectplus* |
| 1582 autoselectplus Like "autoselect" but using the + register instead of | |
| 1583 the * register. Compare to the 'P' flag in | |
| 1584 'guioptions'. | |
| 1585 | |
| 1586 *clipboard-autoselectml* | |
| 7 | 1587 autoselectml Like "autoselect", but for the modeless selection |
| 1588 only. Compare to the 'A' flag in 'guioptions'. | |
| 1589 | |
| 3674 | 1590 *clipboard-html* |
| 1904 | 1591 html When the clipboard contains HTML, use this when |
| 1592 pasting. When putting text on the clipboard, mark it | |
| 1593 as HTML. This works to copy rendered HTML from | |
| 1594 Firefox, paste it as raw HTML in Vim, select the HTML | |
| 1595 in Vim and paste it in a rich edit box in Firefox. | |
|
2240
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1596 You probably want to add this only temporarily, |
|
6b4879aea261
Add test for gettabvar() and settabvar().
Bram Moolenaar <bram@vim.org>
parents:
2220
diff
changeset
|
1597 possibly use BufEnter autocommands. |
| 1904 | 1598 Only supported for GTK version 2 and later. |
| 1599 Only available with the |+multi_byte| feature. | |
| 1600 | |
| 3674 | 1601 *clipboard-exclude* |
| 7 | 1602 exclude:{pattern} |
| 1603 Defines a pattern that is matched against the name of | |
| 1604 the terminal 'term'. If there is a match, no | |
| 1605 connection will be made to the X server. This is | |
| 1606 useful in this situation: | |
| 1607 - Running Vim in a console. | |
| 1608 - $DISPLAY is set to start applications on another | |
| 1609 display. | |
| 1610 - You do not want to connect to the X server in the | |
| 1611 console, but do want this in a terminal emulator. | |
| 1612 To never connect to the X server use: > | |
| 1613 exclude:.* | |
| 1614 < This has the same effect as using the |-X| argument. | |
| 1615 Note that when there is no connection to the X server | |
| 1616 the window title won't be restored and the clipboard | |
| 1617 cannot be accessed. | |
| 1618 The value of 'magic' is ignored, {pattern} is | |
| 1619 interpreted as if 'magic' was on. | |
| 1620 The rest of the option value will be used for | |
| 1621 {pattern}, this must be the last entry. | |
| 1622 | |
| 1623 *'cmdheight'* *'ch'* | |
| 1624 'cmdheight' 'ch' number (default 1) | |
| 1625 global | |
| 1626 {not in Vi} | |
| 1627 Number of screen lines to use for the command-line. Helps avoiding | |
| 1628 |hit-enter| prompts. | |
| 824 | 1629 The value of this option is stored with the tab page, so that each tab |
| 1630 page can have a different value. | |
| 7 | 1631 |
| 1632 *'cmdwinheight'* *'cwh'* | |
| 1633 'cmdwinheight' 'cwh' number (default 7) | |
| 1634 global | |
| 1635 {not in Vi} | |
| 1636 {not available when compiled without the |+vertsplit| | |
| 1637 feature} | |
| 1638 Number of screen lines to use for the command-line window. |cmdwin| | |
| 1639 | |
|
2608
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1640 *'colorcolumn'* *'cc'* |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1641 'colorcolumn' 'cc' string (default "") |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1642 local to window |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1643 {not in Vi} |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1644 {not available when compiled without the |+syntax| |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1645 feature} |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1646 'colorcolumn' is a comma separated list of screen columns that are |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1647 highlighted with ColorColumn |hl-ColorColumn|. Useful to align |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1648 text. Will make screen redrawing slower. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1649 The screen column can be an absolute number, or a number preceded with |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1650 '+' or '-', which is added to or subtracted from 'textwidth'. > |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1651 |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1652 :set cc=+1 " highlight column after 'textwidth' |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1653 :set cc=+1,+2,+3 " highlight three columns after 'textwidth' |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1654 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1655 < |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1656 When 'textwidth' is zero then the items with '-' and '+' are not used. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1657 A maximum of 256 columns are highlighted. |
|
7d8af31066c8
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2607
diff
changeset
|
1658 |
| 7 | 1659 *'columns'* *'co'* *E594* |
| 1660 'columns' 'co' number (default 80 or terminal width) | |
| 1661 global | |
| 1662 {not in Vi} | |
| 1663 Number of columns of the screen. Normally this is set by the terminal | |
| 161 | 1664 initialization and does not have to be set by hand. Also see |
| 1665 |posix-screen-size|. | |
| 7 | 1666 When Vim is running in the GUI or in a resizable window, setting this |
| 1667 option will cause the window size to be changed. When you only want | |
| 1668 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 1669 When you set this option and Vim is unable to change the physical | |
| 1152 | 1670 number of columns of the display, the display may be messed up. For |
| 1671 the GUI it is always possible and Vim limits the number of columns to | |
| 1672 what fits on the screen. You can use this command to get the widest | |
| 1673 window possible: > | |
| 1674 :set columns=9999 | |
| 1675 < Minimum value is 12, maximum value is 10000. | |
| 7 | 1676 |
| 1677 *'comments'* *'com'* *E524* *E525* | |
| 1678 'comments' 'com' string (default | |
| 1679 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-") | |
| 1680 local to buffer | |
| 1681 {not in Vi} | |
| 1682 {not available when compiled without the |+comments| | |
| 1683 feature} | |
| 1684 A comma separated list of strings that can start a comment line. See | |
| 1685 |format-comments|. See |option-backslash| about using backslashes to | |
| 1686 insert a space. | |
| 1687 | |
| 1688 *'commentstring'* *'cms'* *E537* | |
| 1689 'commentstring' 'cms' string (default "/*%s*/") | |
| 1690 local to buffer | |
| 1691 {not in Vi} | |
| 1692 {not available when compiled without the |+folding| | |
| 1693 feature} | |
| 1694 A template for a comment. The "%s" in the value is replaced with the | |
| 1695 comment text. Currently only used to add markers for folding, see | |
| 1696 |fold-marker|. | |
| 1697 | |
| 1698 *'compatible'* *'cp'* *'nocompatible'* *'nocp'* | |
| 819 | 1699 'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc| |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
1700 file is found, reset in |defaults.vim|) |
| 7 | 1701 global |
| 1702 {not in Vi} | |
| 1703 This option has the effect of making Vim either more Vi-compatible, or | |
| 1704 make Vim behave in a more useful way. | |
| 1705 This is a special kind of option, because when it's set or reset, | |
| 1706 other options are also changed as a side effect. CAREFUL: Setting or | |
| 1707 resetting this option can have a lot of unexpected effects: Mappings | |
| 10 | 1708 are interpreted in another way, undo behaves differently, etc. If you |
| 7 | 1709 set this option in your vimrc file, you should probably put it at the |
| 1710 very start. | |
| 1711 By default this option is on and the Vi defaults are used for the | |
| 1712 options. This default was chosen for those people who want to use Vim | |
| 1713 just like Vi, and don't even (want to) know about the 'compatible' | |
| 1714 option. | |
| 819 | 1715 When a |vimrc| or |gvimrc| file is found while Vim is starting up, |
| 378 | 1716 this option is switched off, and all options that have not been |
| 1717 modified will be set to the Vim defaults. Effectively, this means | |
| 819 | 1718 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim |
| 378 | 1719 defaults, otherwise it will use the Vi defaults. (Note: This doesn't |
| 1152 | 1720 happen for the system-wide vimrc or gvimrc file, nor for a file given |
| 1721 with the |-u| argument). Also see |compatible-default| and | |
| 1722 |posix-compliance|. | |
| 7 | 1723 You can also set this option with the "-C" argument, and reset it with |
| 1724 "-N". See |-C| and |-N|. | |
| 1725 Switching this option off makes the Vim defaults be used for options | |
| 1726 that have a different Vi and Vim default value. See the options | |
| 1727 marked with a '+' below. Other options are not modified. | |
| 1728 At the moment this option is set, several other options will be set | |
| 1729 or reset to make Vim as Vi-compatible as possible. See the table | |
| 10 | 1730 below. This can be used if you want to revert to Vi compatible |
| 7 | 1731 editing. |
| 1732 See also 'cpoptions'. | |
| 1733 | |
| 1734 option + set value effect ~ | |
| 1735 | |
| 1736 'allowrevins' off no CTRL-_ command | |
| 1737 'backspace' "" normal backspace | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
1738 'backupcopy' Unix: "yes" backup file is a copy |
|
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
1739 else: "auto" copy or rename backup file |
| 7 | 1740 'backup' off no backup file |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
1741 'cedit' + "" no key to open the |cmdwin| |
| 7 | 1742 'cindent' off no C code indentation |
| 1743 'cpoptions' + (all flags) Vi-compatible flags | |
| 1744 'cscopetag' off don't use cscope for ":tag" | |
| 1745 'cscopetagorder' 0 see |cscopetagorder| | |
| 1746 'cscopeverbose' off see |cscopeverbose| | |
| 1747 'digraph' off no digraphs | |
| 1748 'esckeys' + off no <Esc>-keys in Insert mode | |
| 1749 'expandtab' off tabs not expanded to spaces | |
| 1750 'fileformats' + "" no automatic file format detection, | |
| 1751 "dos,unix" except for DOS, Windows and OS/2 | |
| 1752 'formatoptions' + "vt" Vi compatible formatting | |
| 1753 'gdefault' off no default 'g' flag for ":s" | |
| 1754 'history' + 0 no commandline history | |
| 1755 'hkmap' off no Hebrew keyboard mapping | |
| 1756 'hkmapp' off no phonetic Hebrew keyboard mapping | |
| 1757 'hlsearch' off no highlighting of search matches | |
| 1758 'incsearch' off no incremental searching | |
| 1759 'indentexpr' "" no indenting by expression | |
| 1760 'insertmode' off do not start in Insert mode | |
| 1761 'iskeyword' + "@,48-57,_" keywords contain alphanumeric | |
| 1762 characters and '_' | |
| 1763 'joinspaces' on insert 2 spaces after period | |
| 1764 'modeline' + off no modelines | |
| 1765 'more' + off no pauses in listings | |
| 1766 'revins' off no reverse insert | |
| 1767 'ruler' off no ruler | |
| 1768 'scrolljump' 1 no jump scroll | |
| 1769 'scrolloff' 0 no scroll offset | |
| 1770 'shiftround' off indent not rounded to shiftwidth | |
| 1771 'shortmess' + "" no shortening of messages | |
| 1772 'showcmd' + off command characters not shown | |
| 1773 'showmode' + off current mode not shown | |
| 1774 'smartcase' off no automatic ignore case switch | |
| 1775 'smartindent' off no smart indentation | |
| 1776 'smarttab' off no smart tab size | |
| 1777 'softtabstop' 0 tabs are always 'tabstop' positions | |
| 1778 'startofline' on goto startofline with some commands | |
| 1779 'tagrelative' + off tag file names are not relative | |
| 1780 'textauto' + off no automatic textmode detection | |
| 1781 'textwidth' 0 no automatic line wrap | |
| 1782 'tildeop' off tilde is not an operator | |
| 1783 'ttimeout' off no terminal timeout | |
|
10244
876fbdd84e52
commit https://github.com/vim/vim/commit/2ec618c9feac4573b154510236ad8121c77d0eca
Christian Brabandt <cb@256bit.org>
parents:
10218
diff
changeset
|
1784 'viminfo' + {unchanged} no viminfo file |
| 7 | 1785 'whichwrap' + "" left-right movements don't wrap |
| 1786 'wildchar' + CTRL-E only when the current value is <Tab> | |
| 1787 use CTRL-E for cmdline completion | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1788 'writebackup' on or off depends on the |+writebackup| feature |
| 7 | 1789 |
| 1790 *'complete'* *'cpt'* *E535* | |
| 1791 'complete' 'cpt' string (default: ".,w,b,u,t,i") | |
| 1792 local to buffer | |
| 1793 {not in Vi} | |
| 1794 This option specifies how keyword completion |ins-completion| works | |
| 1795 when CTRL-P or CTRL-N are used. It is also used for whole-line | |
| 1796 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion | |
| 1797 and the places to scan. It is a comma separated list of flags: | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
1798 . scan the current buffer ('wrapscan' is ignored) |
| 7 | 1799 w scan buffers from other windows |
| 1800 b scan other loaded buffers that are in the buffer list | |
| 1801 u scan the unloaded buffers that are in the buffer list | |
| 1802 U scan the buffers that are not in the buffer list | |
| 1803 k scan the files given with the 'dictionary' option | |
| 703 | 1804 kspell use the currently active spell checking |spell| |
| 7 | 1805 k{dict} scan the file {dict}. Several "k" flags can be given, |
| 1806 patterns are valid too. For example: > | |
| 1807 :set cpt=k/usr/dict/*,k~/spanish | |
| 1808 < s scan the files given with the 'thesaurus' option | |
| 1809 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns | |
| 1810 are valid too. | |
| 1811 i scan current and included files | |
| 1812 d scan current and included files for defined name or macro | |
| 1813 |i_CTRL-X_CTRL-D| | |
| 1814 ] tag completion | |
| 1815 t same as "]" | |
| 1816 | |
| 1817 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are | |
| 1818 not executed, this may lead to unexpected completions from some files | |
| 1819 (gzipped files for example). Unloaded buffers are not scanned for | |
| 1820 whole-line completion. | |
| 1821 | |
| 1822 The default is ".,w,b,u,t,i", which means to scan: | |
| 1823 1. the current buffer | |
| 1824 2. buffers in other windows | |
| 1825 3. other loaded buffers | |
| 1826 4. unloaded buffers | |
| 1827 5. tags | |
| 1828 6. included files | |
| 1829 | |
| 1830 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'- | |
| 233 | 1831 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns |
| 1832 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions). | |
| 7 | 1833 |
| 12 | 1834 *'completefunc'* *'cfu'* |
| 1835 'completefunc' 'cfu' string (default: empty) | |
| 1836 local to buffer | |
| 1837 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1838 {not available when compiled without the |+eval| |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1839 or |+insert_expand| features} |
| 623 | 1840 This option specifies a function to be used for Insert mode completion |
| 1841 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| | |
| 648 | 1842 See |complete-functions| for an explanation of how the function is |
| 1843 invoked and what it should return. | |
| 2642 | 1844 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 1845 security reasons. | |
| 14 | 1846 |
| 540 | 1847 *'completeopt'* *'cot'* |
| 730 | 1848 'completeopt' 'cot' string (default: "menu,preview") |
| 540 | 1849 global |
| 766 | 1850 {not available when compiled without the |
| 1851 |+insert_expand| feature} | |
| 540 | 1852 {not in Vi} |
| 665 | 1853 A comma separated list of options for Insert mode completion |
| 1854 |ins-completion|. The supported values are: | |
| 540 | 1855 |
| 1856 menu Use a popup menu to show the possible completions. The | |
| 1857 menu is only shown when there is more than one match and | |
| 1858 sufficient colors are available. |ins-completion-menu| | |
| 1859 | |
| 707 | 1860 menuone Use the popup menu also when there is only one match. |
| 856 | 1861 Useful when there is additional information about the |
| 707 | 1862 match, e.g., what file it comes from. |
| 1863 | |
| 836 | 1864 longest Only insert the longest common text of the matches. If |
| 1865 the menu is displayed you can use CTRL-L to add more | |
| 1866 characters. Whether case is ignored depends on the kind | |
| 1867 of completion. For buffer text the 'ignorecase' option is | |
| 1868 used. | |
| 665 | 1869 |
| 730 | 1870 preview Show extra information about the currently selected |
| 1152 | 1871 completion in the preview window. Only works in |
| 1872 combination with "menu" or "menuone". | |
| 1873 | |
| 6911 | 1874 noinsert Do not insert any text for a match until the user selects |
| 1875 a match from the menu. Only works in combination with | |
| 1876 "menu" or "menuone". No effect if "longest" is present. | |
| 1877 | |
| 1878 noselect Do not select a match in the menu, force the user to | |
| 1879 select one from the menu. Only works in combination with | |
| 1880 "menu" or "menuone". | |
| 1881 | |
| 730 | 1882 |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1883 *'concealcursor'* *'cocu'* |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1884 'concealcursor' 'cocu' string (default: "") |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1885 local to window |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1886 {not in Vi} |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1887 {not available when compiled without the |+conceal| |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1888 feature} |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1889 Sets the modes in which text in the cursor line can also be concealed. |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1890 When the current mode is listed then concealing happens just like in |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1891 other lines. |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1892 n Normal mode |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1893 v Visual mode |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1894 i Insert mode |
|
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1895 c Command line editing, for 'incsearch' |
|
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1896 |
|
2400
e6f1424dd66a
Let 'v' flag in 'concealcursor' apply to all lines in the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2394
diff
changeset
|
1897 'v' applies to all lines in the Visual area, not only the cursor. |
|
2382
3a5ededa240a
Add the 'c' flag to 'concealcursor'.
Bram Moolenaar <bram@vim.org>
parents:
2380
diff
changeset
|
1898 A useful value is "nc". This is used in help files. So long as you |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1899 are moving around text is concealed, but when starting to insert text |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1900 or selecting a Visual area the concealed text is displayed, so that |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1901 you can see what you are doing. |
|
2380
b47748aa3236
Don't conceal text in lines inside the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
1902 Keep in mind that the cursor position is not always where it's |
|
b47748aa3236
Don't conceal text in lines inside the Visual area.
Bram Moolenaar <bram@vim.org>
parents:
2378
diff
changeset
|
1903 displayed. E.g., when moving vertically it may change column. |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1904 |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1905 |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1906 'conceallevel' 'cole' *'conceallevel'* *'cole'* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1907 number (default 0) |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1908 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1909 {not in Vi} |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1910 {not available when compiled without the |+conceal| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1911 feature} |
|
2340
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1912 Determine how text with the "conceal" syntax attribute |:syn-conceal| |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1913 is shown: |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1914 |
|
99c1eba60b2d
Make automatic prototype generation work with more interfaces.
Bram Moolenaar <bram@vim.org>
parents:
2337
diff
changeset
|
1915 Value Effect ~ |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1916 0 Text is shown normally |
| 2426 | 1917 1 Each block of concealed text is replaced with one |
| 1918 character. If the syntax item does not have a custom | |
| 1919 replacement character defined (see |:syn-cchar|) the | |
| 1920 character defined in 'listchars' is used (default is a | |
| 1921 space). | |
| 1922 It is highlighted with the "Conceal" highlight group. | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1923 2 Concealed text is completely hidden unless it has a |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1924 custom replacement character defined (see |
| 2426 | 1925 |:syn-cchar|). |
|
2349
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1926 3 Concealed text is completely hidden. |
|
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1927 |
|
586a459f3980
Never hide text for conceal in cursor line. Do hide when there is
Bram Moolenaar <bram@vim.org>
parents:
2348
diff
changeset
|
1928 Note: in the cursor line concealed text is not hidden, so that you can |
|
2378
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1929 edit and copy the text. This can be changed with the 'concealcursor' |
|
85b7dc8da5eb
Add the 'concealcursor' option to decide when the cursor line is to be
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
1930 option. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
1931 |
| 7 | 1932 *'confirm'* *'cf'* *'noconfirm'* *'nocf'* |
| 1933 'confirm' 'cf' boolean (default off) | |
| 1934 global | |
| 1935 {not in Vi} | |
| 1936 When 'confirm' is on, certain operations that would normally | |
| 1937 fail because of unsaved changes to a buffer, e.g. ":q" and ":e", | |
| 1938 instead raise a |dialog| asking if you wish to save the current | |
| 1939 file(s). You can still use a ! to unconditionally |abandon| a buffer. | |
| 1940 If 'confirm' is off you can still activate confirmation for one | |
| 1941 command only (this is most useful in mappings) with the |:confirm| | |
| 1942 command. | |
| 1943 Also see the |confirm()| function and the 'v' flag in 'guioptions'. | |
| 1944 | |
| 1945 *'conskey'* *'consk'* *'noconskey'* *'noconsk'* | |
| 1946 'conskey' 'consk' boolean (default off) | |
| 1947 global | |
| 1948 {not in Vi} {only for MS-DOS} | |
|
8246
f16bfe02cef1
commit https://github.com/vim/vim/commit/f391327adbbffb11180cf6038a92af1ed144e907
Christian Brabandt <cb@256bit.org>
parents:
8182
diff
changeset
|
1949 This was for MS-DOS and is no longer supported. |
| 7 | 1950 |
| 1951 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'* | |
| 1952 'copyindent' 'ci' boolean (default off) | |
| 1953 local to buffer | |
| 1954 {not in Vi} | |
| 1955 Copy the structure of the existing lines indent when autoindenting a | |
| 1956 new line. Normally the new indent is reconstructed by a series of | |
| 1957 tabs followed by spaces as required (unless |'expandtab'| is enabled, | |
| 1958 in which case only spaces are used). Enabling this option makes the | |
| 1959 new line copy whatever characters were used for indenting on the | |
| 1621 | 1960 existing line. 'expandtab' has no effect on these characters, a Tab |
| 1961 remains a Tab. If the new indent is greater than on the existing | |
| 7 | 1962 line, the remaining space is filled in the normal manner. |
| 1963 NOTE: 'copyindent' is reset when 'compatible' is set. | |
| 1964 Also see 'preserveindent'. | |
| 1965 | |
|
8148
f5da459c5698
commit https://github.com/vim/vim/commit/e0fa3742ead676a3074a10edadbc955e1a89153d
Christian Brabandt <cb@256bit.org>
parents:
8061
diff
changeset
|
1966 *'cpoptions'* *'cpo'* *cpo* |
| 7 | 1967 'cpoptions' 'cpo' string (Vim default: "aABceFs", |
| 1968 Vi default: all flags) | |
| 1969 global | |
| 1970 {not in Vi} | |
| 1971 A sequence of single character flags. When a character is present | |
| 5340 | 1972 this indicates Vi-compatible behavior. This is used for things where |
| 1973 not being Vi-compatible is mostly or sometimes preferred. | |
| 7 | 1974 'cpoptions' stands for "compatible-options". |
| 1975 Commas can be added for readability. | |
| 1976 To avoid problems with flags that are added in the future, use the | |
| 1977 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 1978 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 1979 set and to the Vim default value when 'compatible' is reset. | |
| 164 | 1980 NOTE: This option is set to the POSIX default value at startup when |
| 1981 the Vi default value would be used and the $VIM_POSIX environment | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1982 variable exists |posix|. This means Vim tries to behave like the |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
1983 POSIX specification. |
| 7 | 1984 |
| 1985 contains behavior ~ | |
| 1986 *cpo-a* | |
| 1987 a When included, a ":read" command with a file name | |
| 1988 argument will set the alternate file name for the | |
| 1989 current window. | |
| 1990 *cpo-A* | |
| 1991 A When included, a ":write" command with a file name | |
| 1992 argument will set the alternate file name for the | |
| 1993 current window. | |
| 1994 *cpo-b* | |
| 1995 b "\|" in a ":map" command is recognized as the end of | |
| 1996 the map command. The '\' is included in the mapping, | |
| 1997 the text after the '|' is interpreted as the next | |
| 1998 command. Use a CTRL-V instead of a backslash to | |
| 1999 include the '|' in the mapping. Applies to all | |
| 2000 mapping, abbreviation, menu and autocmd commands. | |
| 2001 See also |map_bar|. | |
| 2002 *cpo-B* | |
| 2003 B A backslash has no special meaning in mappings, | |
| 2004 abbreviations and the "to" part of the menu commands. | |
| 2005 Remove this flag to be able to use a backslash like a | |
| 2006 CTRL-V. For example, the command ":map X \<Esc>" | |
| 2007 results in X being mapped to: | |
| 2008 'B' included: "\^[" (^[ is a real <Esc>) | |
| 2009 'B' excluded: "<Esc>" (5 characters) | |
| 2010 ('<' excluded in both cases) | |
| 2011 *cpo-c* | |
| 2012 c Searching continues at the end of any match at the | |
| 2013 cursor position, but not further than the start of the | |
| 2014 next line. When not present searching continues | |
| 2015 one character from the cursor position. With 'c' | |
| 2016 "abababababab" only gets three matches when repeating | |
| 2017 "/abab", without 'c' there are five matches. | |
| 2018 *cpo-C* | |
| 2019 C Do not concatenate sourced lines that start with a | |
| 2020 backslash. See |line-continuation|. | |
| 2021 *cpo-d* | |
| 2022 d Using "./" in the 'tags' option doesn't mean to use | |
| 2023 the tags file relative to the current file, but the | |
| 2024 tags file in the current directory. | |
| 2025 *cpo-D* | |
| 2026 D Can't use CTRL-K to enter a digraph after Normal mode | |
| 2027 commands with a character argument, like |r|, |f| and | |
| 2028 |t|. | |
| 2029 *cpo-e* | |
| 2030 e When executing a register with ":@r", always add a | |
| 2031 <CR> to the last line, also when the register is not | |
| 2032 linewise. If this flag is not present, the register | |
| 2033 is not linewise and the last line does not end in a | |
| 2034 <CR>, then the last line is put on the command-line | |
| 2035 and can be edited before hitting <CR>. | |
| 2036 *cpo-E* | |
| 2037 E It is an error when using "y", "d", "c", "g~", "gu" or | |
| 2038 "gU" on an Empty region. The operators only work when | |
| 2039 at least one character is to be operate on. Example: | |
| 2040 This makes "y0" fail in the first column. | |
| 2041 *cpo-f* | |
| 2042 f When included, a ":read" command with a file name | |
| 2043 argument will set the file name for the current buffer, | |
| 2044 if the current buffer doesn't have a file name yet. | |
| 2045 *cpo-F* | |
| 2046 F When included, a ":write" command with a file name | |
| 2047 argument will set the file name for the current | |
| 2048 buffer, if the current buffer doesn't have a file name | |
| 590 | 2049 yet. Also see |cpo-P|. |
| 7 | 2050 *cpo-g* |
| 2051 g Goto line 1 when using ":edit" without argument. | |
| 164 | 2052 *cpo-H* |
| 2053 H When using "I" on a line with only blanks, insert | |
| 2054 before the last blank. Without this flag insert after | |
| 2055 the last blank. | |
| 7 | 2056 *cpo-i* |
| 2057 i When included, interrupting the reading of a file will | |
| 2058 leave it modified. | |
| 10 | 2059 *cpo-I* |
| 2060 I When moving the cursor up or down just after inserting | |
| 2061 indent for 'autoindent', do not delete the indent. | |
| 7 | 2062 *cpo-j* |
| 2063 j When joining lines, only add two spaces after a '.', | |
| 2064 not after '!' or '?'. Also see 'joinspaces'. | |
| 2065 *cpo-J* | |
| 2066 J A |sentence| has to be followed by two spaces after | |
| 233 | 2067 the '.', '!' or '?'. A <Tab> is not recognized as |
| 7 | 2068 white space. |
| 2069 *cpo-k* | |
| 2070 k Disable the recognition of raw key codes in | |
| 2071 mappings, abbreviations, and the "to" part of menu | |
| 2072 commands. For example, if <Key> sends ^[OA (where ^[ | |
| 2073 is <Esc>), the command ":map X ^[OA" results in X | |
| 2074 being mapped to: | |
| 2075 'k' included: "^[OA" (3 characters) | |
| 2076 'k' excluded: "<Key>" (one key code) | |
| 2077 Also see the '<' flag below. | |
| 2078 *cpo-K* | |
| 2079 K Don't wait for a key code to complete when it is | |
| 2080 halfway a mapping. This breaks mapping <F1><F1> when | |
| 2081 only part of the second <F1> has been read. It | |
| 2082 enables cancelling the mapping by typing <F1><Esc>. | |
| 2083 *cpo-l* | |
| 2084 l Backslash in a [] range in a search pattern is taken | |
| 168 | 2085 literally, only "\]", "\^", "\-" and "\\" are special. |
| 2086 See |/[]| | |
| 7 | 2087 'l' included: "/[ \t]" finds <Space>, '\' and 't' |
| 2088 'l' excluded: "/[ \t]" finds <Space> and <Tab> | |
| 168 | 2089 Also see |cpo-\|. |
| 7 | 2090 *cpo-L* |
| 2091 L When the 'list' option is set, 'wrapmargin', | |
| 2092 'textwidth', 'softtabstop' and Virtual Replace mode | |
| 2093 (see |gR|) count a <Tab> as two characters, instead of | |
| 2094 the normal behavior of a <Tab>. | |
| 2095 *cpo-m* | |
| 2096 m When included, a showmatch will always wait half a | |
| 2097 second. When not included, a showmatch will wait half | |
| 2098 a second or until a character is typed. |'showmatch'| | |
| 2099 *cpo-M* | |
| 2100 M When excluded, "%" matching will take backslashes into | |
| 2101 account. Thus in "( \( )" and "\( ( \)" the outer | |
| 2102 parenthesis match. When included "%" ignores | |
| 2103 backslashes, which is Vi compatible. | |
| 2104 *cpo-n* | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2105 n When included, the column used for 'number' and |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2106 'relativenumber' will also be used for text of wrapped |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
2107 lines. |
| 7 | 2108 *cpo-o* |
| 2109 o Line offset to search command is not remembered for | |
| 2110 next search. | |
| 2111 *cpo-O* | |
| 2112 O Don't complain if a file is being overwritten, even | |
| 2113 when it didn't exist when editing it. This is a | |
| 2114 protection against a file unexpectedly created by | |
| 2115 someone else. Vi didn't complain about this. | |
| 2116 *cpo-p* | |
| 2117 p Vi compatible Lisp indenting. When not present, a | |
| 2118 slightly better algorithm is used. | |
| 590 | 2119 *cpo-P* |
| 2120 P When included, a ":write" command that appends to a | |
| 2121 file will set the file name for the current buffer, if | |
| 2122 the current buffer doesn't have a file name yet and | |
| 2123 the 'F' flag is also included |cpo-F|. | |
| 164 | 2124 *cpo-q* |
| 2125 q When joining multiple lines leave the cursor at the | |
| 2126 position where it would be when joining two lines. | |
| 7 | 2127 *cpo-r* |
| 2128 r Redo ("." command) uses "/" to repeat a search | |
| 2129 command, instead of the actually used search string. | |
| 2130 *cpo-R* | |
| 2131 R Remove marks from filtered lines. Without this flag | |
| 2132 marks are kept like |:keepmarks| was used. | |
| 2133 *cpo-s* | |
| 2134 s Set buffer options when entering the buffer for the | |
| 2135 first time. This is like it is in Vim version 3.0. | |
| 10 | 2136 And it is the default. If not present the options are |
| 7 | 2137 set when the buffer is created. |
| 2138 *cpo-S* | |
| 2139 S Set buffer options always when entering a buffer | |
| 2140 (except 'readonly', 'fileformat', 'filetype' and | |
| 2141 'syntax'). This is the (most) Vi compatible setting. | |
| 2142 The options are set to the values in the current | |
| 2143 buffer. When you change an option and go to another | |
| 2144 buffer, the value is copied. Effectively makes the | |
| 2145 buffer options global to all buffers. | |
| 2146 | |
| 2147 's' 'S' copy buffer options | |
| 2148 no no when buffer created | |
| 2149 yes no when buffer first entered (default) | |
| 2150 X yes each time when buffer entered (vi comp.) | |
| 2151 *cpo-t* | |
| 2152 t Search pattern for the tag command is remembered for | |
| 2153 "n" command. Otherwise Vim only puts the pattern in | |
| 2154 the history for search pattern, but doesn't change the | |
| 2155 last used search pattern. | |
| 2156 *cpo-u* | |
| 10 | 2157 u Undo is Vi compatible. See |undo-two-ways|. |
| 7 | 2158 *cpo-v* |
| 2159 v Backspaced characters remain visible on the screen in | |
| 2160 Insert mode. Without this flag the characters are | |
| 2161 erased from the screen right away. With this flag the | |
| 2162 screen newly typed text overwrites backspaced | |
| 2163 characters. | |
| 2164 *cpo-w* | |
| 2165 w When using "cw" on a blank character, only change one | |
| 2166 character and not all blanks until the start of the | |
| 2167 next word. | |
| 2168 *cpo-W* | |
| 2169 W Don't overwrite a readonly file. When omitted, ":w!" | |
| 2170 overwrites a readonly file, if possible. | |
| 2171 *cpo-x* | |
| 2172 x <Esc> on the command-line executes the command-line. | |
| 2173 The default in Vim is to abandon the command-line, | |
| 2174 because <Esc> normally aborts a command. |c_<Esc>| | |
| 164 | 2175 *cpo-X* |
| 2176 X When using a count with "R" the replaced text is | |
| 2177 deleted only once. Also when repeating "R" with "." | |
| 2178 and a count. | |
| 7 | 2179 *cpo-y* |
| 2180 y A yank command can be redone with ".". | |
| 164 | 2181 *cpo-Z* |
| 2182 Z When using "w!" while the 'readonly' option is set, | |
| 2183 don't reset 'readonly'. | |
| 7 | 2184 *cpo-!* |
| 2185 ! When redoing a filter command, use the last used | |
| 2186 external command, whatever it was. Otherwise the last | |
| 2187 used -filter- command is used. | |
| 2188 *cpo-$* | |
| 2189 $ When making a change to one line, don't redisplay the | |
| 2190 line, but put a '$' at the end of the changed text. | |
| 2191 The changed text will be overwritten when you type the | |
| 2192 new text. The line is redisplayed if you type any | |
| 2193 command that moves the cursor from the insertion | |
| 2194 point. | |
| 2195 *cpo-%* | |
| 2196 % Vi-compatible matching is done for the "%" command. | |
| 2197 Does not recognize "#if", "#endif", etc. | |
| 2198 Does not recognize "/*" and "*/". | |
| 2199 Parens inside single and double quotes are also | |
| 2200 counted, causing a string that contains a paren to | |
| 2201 disturb the matching. For example, in a line like | |
| 2202 "if (strcmp("foo(", s))" the first paren does not | |
| 2203 match the last one. When this flag is not included, | |
| 2204 parens inside single and double quotes are treated | |
| 2205 specially. When matching a paren outside of quotes, | |
| 2206 everything inside quotes is ignored. When matching a | |
| 2207 paren inside quotes, it will find the matching one (if | |
| 10 | 2208 there is one). This works very well for C programs. |
| 36 | 2209 This flag is also used for other features, such as |
| 2210 C-indenting. | |
| 161 | 2211 *cpo--* |
| 2212 - When included, a vertical movement command fails when | |
| 632 | 2213 it would go above the first line or below the last |
| 2214 line. Without it the cursor moves to the first or | |
| 2215 last line, unless it already was in that line. | |
| 161 | 2216 Applies to the commands "-", "k", CTRL-P, "+", "j", |
| 632 | 2217 CTRL-N, CTRL-J and ":1234". |
| 39 | 2218 *cpo-+* |
| 2219 + When included, a ":write file" command will reset the | |
| 2220 'modified' flag of the buffer, even though the buffer | |
| 2221 itself may still be different from its file. | |
| 856 | 2222 *cpo-star* |
| 7 | 2223 * Use ":*" in the same way as ":@". When not included, |
| 2224 ":*" is an alias for ":'<,'>", select the Visual area. | |
| 2225 *cpo-<* | |
| 2226 < Disable the recognition of special key codes in |<>| | |
| 2227 form in mappings, abbreviations, and the "to" part of | |
| 10 | 2228 menu commands. For example, the command |
| 7 | 2229 ":map X <Tab>" results in X being mapped to: |
| 2230 '<' included: "<Tab>" (5 characters) | |
| 2231 '<' excluded: "^I" (^I is a real <Tab>) | |
| 2232 Also see the 'k' flag above. | |
| 164 | 2233 *cpo->* |
| 2234 > When appending to a register, put a line break before | |
| 2235 the appended text. | |
| 2925 | 2236 *cpo-;* |
| 2237 ; When using |,| or |;| to repeat the last |t| search | |
| 2238 and the cursor is right in front of the searched | |
| 2239 character, the cursor won't move. When not included, | |
| 2240 the cursor would skip over it and jump to the | |
| 3557 | 2241 following occurrence. |
| 164 | 2242 |
| 2243 POSIX flags. These are not included in the Vi default value, except | |
| 2244 when $VIM_POSIX was set on startup. |posix| | |
| 2245 | |
| 2246 contains behavior ~ | |
| 856 | 2247 *cpo-#* |
| 164 | 2248 # A count before "D", "o" and "O" has no effect. |
| 168 | 2249 *cpo-&* |
| 2250 & When ":preserve" was used keep the swap file when | |
| 2251 exiting normally while this buffer is still loaded. | |
| 2252 This flag is tested when exiting. | |
| 2253 *cpo-\* | |
| 2254 \ Backslash in a [] range in a search pattern is taken | |
| 2255 literally, only "\]" is special See |/[]| | |
| 488 | 2256 '\' included: "/[ \-]" finds <Space>, '\' and '-' |
| 2257 '\' excluded: "/[ \-]" finds <Space> and '-' | |
| 2258 Also see |cpo-l|. | |
| 168 | 2259 *cpo-/* |
| 2260 / When "%" is used as the replacement string in a |:s| | |
| 2261 command, use the previous replacement string. |:s%| | |
| 164 | 2262 *cpo-{* |
| 2263 { The |{| and |}| commands also stop at a "{" character | |
| 2264 at the start of a line. | |
| 168 | 2265 *cpo-.* |
| 2266 . The ":chdir" and ":cd" commands fail if the current | |
| 2267 buffer is modified, unless ! is used. Vim doesn't | |
| 2268 need this, since it remembers the full path of an | |
| 2269 opened file. | |
| 164 | 2270 *cpo-bar* |
| 2271 | The value of the $LINES and $COLUMNS environment | |
| 2272 variables overrule the terminal size values obtained | |
| 2273 with system specific functions. | |
| 2274 | |
| 7 | 2275 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2276 *'cryptmethod'* *'cm'* |
| 6336 | 2277 'cryptmethod' 'cm' string (default "zip") |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2278 global or local to buffer |global-local| |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2279 {not in Vi} |
|
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2280 Method used for encryption when the buffer is written to a file: |
|
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
2281 *pkzip* |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2282 zip PkZip compatible method. A weak kind of encryption. |
|
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2283 Backwards compatible with Vim 7.2 and older. |
|
2184
5028c4d6d825
Fixed encryption big/little endian test.
Bram Moolenaar <bram@vim.org>
parents:
2180
diff
changeset
|
2284 *blowfish* |
| 6122 | 2285 blowfish Blowfish method. Medium strong encryption but it has |
| 2286 an implementation flaw. Requires Vim 7.3 or later, | |
| 2287 files can NOT be read by Vim 7.2 and older. This adds | |
| 2288 a "seed" to the file, every time you write the file | |
| 2289 the encrypted bytes will be different. | |
| 2290 *blowfish2* | |
| 2291 blowfish2 Blowfish method. Medium strong encryption. Requires | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
2292 Vim 7.4.401 or later, files can NOT be read by Vim 7.3 |
| 6122 | 2293 and older. This adds a "seed" to the file, every time |
| 2294 you write the file the encrypted bytes will be | |
| 2295 different. The whole undo file is encrypted, not just | |
| 2296 the pieces of text. | |
|
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2297 |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2298 You should use "blowfish2", also to re-encrypt older files. |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
2299 |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2300 When reading an encrypted file 'cryptmethod' will be set automatically |
|
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2301 to the detected method of the file being read. Thus if you write it |
|
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2302 without changing 'cryptmethod' the same method will be used. |
|
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2303 Changing 'cryptmethod' does not mark the file as modified, you have to |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2304 explicitly write it, you don't get a warning unless there are other |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2305 modifications. Also see |:X|. |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2306 |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2307 When setting the global value to an empty string, it will end up with |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2308 the value "zip". When setting the local value to an empty string the |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2309 buffer will use the global value. |
|
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2310 |
|
2204
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2311 When a new encryption method is added in a later version of Vim, and |
|
c493d6bfde09
A few more changes for encryption. Add test that encrypted file can be read.
Bram Moolenaar <bram@vim.org>
parents:
2184
diff
changeset
|
2312 the current version does not recognize it, you will get *E821* . |
|
2360
d8e4b27cef80
Change 'cryptmethod' from a number to a string option. Make it global-local.
Bram Moolenaar <bram@vim.org>
parents:
2350
diff
changeset
|
2313 You need to edit this file with the later version of Vim. |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2314 |
|
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
2315 |
| 7 | 2316 *'cscopepathcomp'* *'cspc'* |
| 2317 'cscopepathcomp' 'cspc' number (default 0) | |
| 2318 global | |
| 2319 {not available when compiled without the |+cscope| | |
| 2320 feature} | |
| 2321 {not in Vi} | |
| 2322 Determines how many components of the path to show in a list of tags. | |
| 2323 See |cscopepathcomp|. | |
| 2324 | |
| 2325 *'cscopeprg'* *'csprg'* | |
| 2326 'cscopeprg' 'csprg' string (default "cscope") | |
| 2327 global | |
| 2328 {not available when compiled without the |+cscope| | |
| 2329 feature} | |
| 2330 {not in Vi} | |
| 2331 Specifies the command to execute cscope. See |cscopeprg|. | |
| 2332 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2333 security reasons. | |
| 2334 | |
| 2335 *'cscopequickfix'* *'csqf'* | |
| 2336 'cscopequickfix' 'csqf' string (default "") | |
| 2337 global | |
| 2338 {not available when compiled without the |+cscope| | |
| 2339 or |+quickfix| features} | |
| 2340 {not in Vi} | |
| 2341 Specifies whether to use quickfix window to show cscope results. | |
| 2342 See |cscopequickfix|. | |
| 2343 | |
| 4869 | 2344 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'* |
| 2873 | 2345 'cscoperelative' 'csre' boolean (default off) |
| 2346 global | |
| 2347 {not available when compiled without the |+cscope| | |
| 2348 feature} | |
| 2349 {not in Vi} | |
| 2350 In the absence of a prefix (-P) for cscope. setting this option enables | |
| 2351 to use the basename of cscope.out path as the prefix. | |
| 2352 See |cscoperelative|. | |
| 2353 | |
| 7 | 2354 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'* |
| 2355 'cscopetag' 'cst' boolean (default off) | |
| 2356 global | |
| 2357 {not available when compiled without the |+cscope| | |
| 2358 feature} | |
| 2359 {not in Vi} | |
| 2360 Use cscope for tag commands. See |cscope-options|. | |
| 2361 NOTE: This option is reset when 'compatible' is set. | |
| 2362 | |
| 2363 *'cscopetagorder'* *'csto'* | |
| 2364 'cscopetagorder' 'csto' number (default 0) | |
| 2365 global | |
| 2366 {not available when compiled without the |+cscope| | |
| 2367 feature} | |
| 2368 {not in Vi} | |
| 2369 Determines the order in which ":cstag" performs a search. See | |
| 2370 |cscopetagorder|. | |
| 2371 NOTE: This option is set to 0 when 'compatible' is set. | |
| 2372 | |
| 2373 *'cscopeverbose'* *'csverb'* | |
| 2374 *'nocscopeverbose'* *'nocsverb'* | |
| 2375 'cscopeverbose' 'csverb' boolean (default off) | |
| 2376 global | |
| 2377 {not available when compiled without the |+cscope| | |
| 2378 feature} | |
| 2379 {not in Vi} | |
| 2380 Give messages when adding a cscope database. See |cscopeverbose|. | |
| 2381 NOTE: This option is reset when 'compatible' is set. | |
| 2382 | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2383 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'* |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2384 'cursorbind' 'crb' boolean (default off) |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2385 local to window |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2386 {not in Vi} |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2387 {not available when compiled without the |+cursorbind| |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2388 feature} |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2389 When this option is set, as the cursor in the current |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2390 window moves other cursorbound windows (windows that also have |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2391 this option set) move their cursors to the corresponding line and |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2392 column. This option is useful for viewing the |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2393 differences between two versions of a file (see 'diff'); in diff mode, |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2394 inserted and deleted lines (though not characters within a line) are |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
2395 taken into account. |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
2396 |
| 743 | 2397 |
| 2398 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'* | |
| 2399 'cursorcolumn' 'cuc' boolean (default off) | |
| 2400 local to window | |
| 2401 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2402 {not available when compiled without the |+syntax| |
| 743 | 2403 feature} |
| 2404 Highlight the screen column of the cursor with CursorColumn | |
| 2405 |hl-CursorColumn|. Useful to align text. Will make screen redrawing | |
| 2406 slower. | |
| 826 | 2407 If you only want the highlighting in the current window you can use |
| 2408 these autocommands: > | |
| 2409 au WinLeave * set nocursorline nocursorcolumn | |
| 2410 au WinEnter * set cursorline cursorcolumn | |
| 2411 < | |
| 743 | 2412 |
| 2413 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'* | |
| 2414 'cursorline' 'cul' boolean (default off) | |
| 2415 local to window | |
| 2416 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2417 {not available when compiled without the |+syntax| |
| 743 | 2418 feature} |
| 2419 Highlight the screen line of the cursor with CursorLine | |
| 2420 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen | |
| 2421 redrawing slower. | |
| 818 | 2422 When Visual mode is active the highlighting isn't used to make it |
| 825 | 2423 easier to see the selected text. |
| 743 | 2424 |
| 2425 | |
| 7 | 2426 *'debug'* |
| 2427 'debug' string (default "") | |
| 2428 global | |
| 2429 {not in Vi} | |
| 839 | 2430 These values can be used: |
| 2431 msg Error messages that would otherwise be omitted will be given | |
| 2432 anyway. | |
| 2433 throw Error messages that would otherwise be omitted will be given | |
| 2434 anyway and also throw an exception and set |v:errmsg|. | |
| 2435 beep A message will be given when otherwise only a beep would be | |
| 2436 produced. | |
| 168 | 2437 The values can be combined, separated by a comma. |
| 839 | 2438 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or |
| 2439 'indentexpr'. | |
| 7 | 2440 |
| 2441 *'define'* *'def'* | |
| 2442 'define' 'def' string (default "^\s*#\s*define") | |
| 2443 global or local to buffer |global-local| | |
| 2444 {not in Vi} | |
| 10 | 2445 Pattern to be used to find a macro definition. It is a search |
| 7 | 2446 pattern, just like for the "/" command. This option is used for the |
| 2447 commands like "[i" and "[d" |include-search|. The 'isident' option is | |
| 2448 used to recognize the defined name after the match: | |
| 2449 {match with 'define'}{non-ID chars}{defined name}{non-ID char} | |
| 2450 See |option-backslash| about inserting backslashes to include a space | |
| 2451 or backslash. | |
| 2452 The default value is for C programs. For C++ this value would be | |
| 2453 useful, to include const type declarations: > | |
| 2454 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\) | |
| 2455 < When using the ":set" command, you need to double the backslashes! | |
| 2456 | |
| 2457 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'* | |
| 2458 'delcombine' 'deco' boolean (default off) | |
| 2459 global | |
| 2460 {not in Vi} | |
| 2461 {only available when compiled with the |+multi_byte| | |
| 2462 feature} | |
| 2463 If editing Unicode and this option is set, backspace and Normal mode | |
| 2464 "x" delete each combining character on its own. When it is off (the | |
| 2465 default) the character along with its combining characters are | |
| 2466 deleted. | |
| 2467 Note: When 'delcombine' is set "xx" may work different from "2x"! | |
| 2468 | |
| 2469 This is useful for Arabic, Hebrew and many other languages where one | |
| 2470 may have combining characters overtop of base characters, and want | |
| 2471 to remove only the combining ones. | |
| 2472 | |
| 2473 *'dictionary'* *'dict'* | |
| 2474 'dictionary' 'dict' string (default "") | |
| 2475 global or local to buffer |global-local| | |
| 2476 {not in Vi} | |
| 2477 List of file names, separated by commas, that are used to lookup words | |
| 2478 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should | |
| 2479 contain a list of words. This can be one word per line, or several | |
| 2480 words per line, separated by non-keyword characters (white space is | |
| 2481 preferred). Maximum line length is 510 bytes. | |
| 703 | 2482 When this option is empty, or an entry "spell" is present, spell |
| 2483 checking is enabled the currently active spelling is used. |spell| | |
| 10 | 2484 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 2485 after a comma are ignored, otherwise spaces are included in the file |
| 2486 name. See |option-backslash| about using backslashes. | |
| 99 | 2487 This has nothing to do with the |Dictionary| variable type. |
| 7 | 2488 Where to find a list of words? |
| 2489 - On FreeBSD, there is the file "/usr/share/dict/words". | |
| 2490 - In the Simtel archive, look in the "msdos/linguist" directory. | |
| 2491 - In "miscfiles" of the GNU collection. | |
| 2492 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 2493 directories from the list. This avoids problems when a future version | |
| 2494 uses another default. | |
| 2495 Backticks cannot be used in this option for security reasons. | |
| 2496 | |
| 2497 *'diff'* *'nodiff'* | |
| 2498 'diff' boolean (default off) | |
| 2499 local to window | |
| 2500 {not in Vi} | |
| 2501 {not available when compiled without the |+diff| | |
| 2502 feature} | |
| 2503 Join the current window in the group of windows that shows differences | |
| 10 | 2504 between files. See |vimdiff|. |
| 7 | 2505 |
| 2506 *'dex'* *'diffexpr'* | |
| 2507 'diffexpr' 'dex' string (default "") | |
| 2508 global | |
| 2509 {not in Vi} | |
| 2510 {not available when compiled without the |+diff| | |
| 2511 feature} | |
| 2512 Expression which is evaluated to obtain an ed-style diff file from two | |
| 2513 versions of a file. See |diff-diffexpr|. | |
| 2514 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2515 security reasons. | |
| 2516 | |
| 2517 *'dip'* *'diffopt'* | |
| 2518 'diffopt' 'dip' string (default "filler") | |
| 2519 global | |
| 2520 {not in Vi} | |
| 2521 {not available when compiled without the |+diff| | |
| 2522 feature} | |
| 10 | 2523 Option settings for diff mode. It can consist of the following items. |
| 7 | 2524 All are optional. Items must be separated by a comma. |
| 2525 | |
| 2526 filler Show filler lines, to keep the text | |
| 2527 synchronized with a window that has inserted | |
| 2528 lines at the same position. Mostly useful | |
| 2529 when windows are side-by-side and 'scrollbind' | |
| 2530 is set. | |
| 2531 | |
| 2532 context:{n} Use a context of {n} lines between a change | |
| 2533 and a fold that contains unchanged lines. | |
| 2534 When omitted a context of six lines is used. | |
| 2535 See |fold-diff|. | |
| 2536 | |
| 2537 icase Ignore changes in case of text. "a" and "A" | |
| 2538 are considered the same. Adds the "-i" flag | |
| 2539 to the "diff" command if 'diffexpr' is empty. | |
| 2540 | |
| 2541 iwhite Ignore changes in amount of white space. Adds | |
| 2542 the "-b" flag to the "diff" command if | |
| 2543 'diffexpr' is empty. Check the documentation | |
| 2544 of the "diff" command for what this does | |
| 2545 exactly. It should ignore adding trailing | |
| 2546 white space, but not leading white space. | |
| 2547 | |
| 766 | 2548 horizontal Start diff mode with horizontal splits (unless |
| 2549 explicitly specified otherwise). | |
| 2550 | |
| 2551 vertical Start diff mode with vertical splits (unless | |
| 2552 explicitly specified otherwise). | |
| 2553 | |
| 2554 foldcolumn:{n} Set the 'foldcolumn' option to {n} when | |
| 2555 starting diff mode. Without this 2 is used. | |
| 2556 | |
| 7 | 2557 Examples: > |
| 2558 | |
| 2559 :set diffopt=filler,context:4 | |
| 2560 :set diffopt= | |
| 766 | 2561 :set diffopt=filler,foldcolumn:3 |
| 7 | 2562 < |
| 2563 *'digraph'* *'dg'* *'nodigraph'* *'nodg'* | |
| 2564 'digraph' 'dg' boolean (default off) | |
| 2565 global | |
| 2566 {not in Vi} | |
| 2567 {not available when compiled without the |+digraphs| | |
| 2568 feature} | |
| 2569 Enable the entering of digraphs in Insert mode with {char1} <BS> | |
| 2570 {char2}. See |digraphs|. | |
| 2571 NOTE: This option is reset when 'compatible' is set. | |
| 2572 | |
| 2573 *'directory'* *'dir'* | |
| 2574 'directory' 'dir' string (default for Amiga: ".,t:", | |
| 5555 | 2575 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp" |
| 7 | 2576 for Unix: ".,~/tmp,/var/tmp,/tmp") |
| 2577 global | |
| 2578 List of directory names for the swap file, separated with commas. | |
| 2579 - The swap file will be created in the first directory where this is | |
| 2580 possible. | |
| 2581 - Empty means that no swap file will be used (recovery is | |
| 2582 impossible!). | |
| 2583 - A directory "." means to put the swap file in the same directory as | |
| 2584 the edited file. On Unix, a dot is prepended to the file name, so | |
| 2585 it doesn't show in a directory listing. On MS-Windows the "hidden" | |
| 2586 attribute is set and a dot prepended if possible. | |
| 33 | 2587 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to |
| 7 | 2588 put the swap file relative to where the edited file is. The leading |
| 2589 "." is replaced with the path name of the edited file. | |
| 459 | 2590 - For Unix and Win32, if a directory ends in two path separators "//" |
| 2591 or "\\", the swap file name will be built from the complete path to | |
| 2592 the file with all path separators substituted to percent '%' signs. | |
| 2593 This will ensure file name uniqueness in the preserve directory. | |
| 1698 | 2594 On Win32, when a separating comma is following, you must use "//", |
| 2595 since "\\" will include the comma in the file name. | |
| 7 | 2596 - Spaces after the comma are ignored, other spaces are considered part |
| 2597 of the directory name. To have a space at the start of a directory | |
| 2598 name, precede it with a backslash. | |
| 2599 - To include a comma in a directory name precede it with a backslash. | |
| 2600 - A directory name may end in an ':' or '/'. | |
| 2601 - Environment variables are expanded |:set_env|. | |
| 2602 - Careful with '\' characters, type one before a space, type two to | |
| 2603 get one in the option (see |option-backslash|), for example: > | |
| 2604 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces | |
| 2605 < - For backwards compatibility with Vim version 3.0 a '>' at the start | |
| 2606 of the option is removed. | |
| 2607 Using "." first in the list is recommended. This means that editing | |
| 2608 the same file twice will result in a warning. Using "/tmp" on Unix is | |
| 2609 discouraged: When the system crashes you lose the swap file. | |
| 2610 "/var/tmp" is often not cleared when rebooting, thus is a better | |
| 2611 choice than "/tmp". But it can contain a lot of files, your swap | |
| 2612 files get lost in the crowd. That is why a "tmp" directory in your | |
| 2613 home directory is tried first. | |
| 2614 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 2615 directories from the list. This avoids problems when a future version | |
| 2616 uses another default. | |
| 2617 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2618 security reasons. | |
| 2619 {Vi: directory to put temp file in, defaults to "/tmp"} | |
| 2620 | |
| 2621 *'display'* *'dy'* | |
|
9737
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2622 'display' 'dy' string (default "", set to "truncate" in |
|
35ce559b8553
commit https://github.com/vim/vim/commit/bc8801c9317eb721a2ee91322669f2dd5d136380
Christian Brabandt <cb@256bit.org>
parents:
9669
diff
changeset
|
2623 |defaults.vim|) |
| 7 | 2624 global |
| 2625 {not in Vi} | |
| 2626 Change the way text is displayed. This is comma separated list of | |
| 2627 flags: | |
| 2628 lastline When included, as much as possible of the last line | |
|
9665
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2629 in a window will be displayed. "@@@" is put in the |
|
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2630 last columns of the last screen line to indicate the |
|
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2631 rest of the line is not displayed. |
|
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2632 truncate Like "lastline", but "@@@" is displayed in the first |
|
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2633 column of the last screen line. Overrules "lastline". |
| 7 | 2634 uhex Show unprintable characters hexadecimal as <xx> |
| 2635 instead of using ^C and ~C. | |
| 2636 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
2637 When neither "lastline" nor "truncate" is included, a last line that |
|
9665
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2638 doesn't fit is replaced with "@" lines. |
|
b193bdb6ea25
commit https://github.com/vim/vim/commit/ad9c2a08f0509294269a2f11a59a438b944bdd5a
Christian Brabandt <cb@256bit.org>
parents:
9533
diff
changeset
|
2639 |
| 7 | 2640 *'eadirection'* *'ead'* |
| 2641 'eadirection' 'ead' string (default "both") | |
| 2642 global | |
| 2643 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
2644 {not available when compiled without the |+vertsplit| |
| 7 | 2645 feature} |
| 2646 Tells when the 'equalalways' option applies: | |
| 2647 ver vertically, width of windows is not affected | |
| 2648 hor horizontally, height of windows is not affected | |
| 2649 both width and height of windows is affected | |
| 2650 | |
| 2651 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'* | |
| 2652 'edcompatible' 'ed' boolean (default off) | |
| 2653 global | |
| 2654 Makes the 'g' and 'c' flags of the ":substitute" command to be | |
| 2655 toggled each time the flag is given. See |complex-change|. See | |
| 2656 also 'gdefault' option. | |
| 2657 Switching this option on is discouraged! | |
| 2658 | |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
2659 *'emoji'* *'emo'* *'noemoji'* *'noemo'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2660 'emoji' 'emo' boolean (default: on) |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2661 global |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2662 {not in Vi} |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2663 {only available when compiled with the |+multi_byte| |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2664 feature} |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2665 When on all Unicode emoji characters are considered to be full width. |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2666 |
|
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
2667 |
| 7 | 2668 *'encoding'* *'enc'* *E543* |
| 2669 'encoding' 'enc' string (default: "latin1" or value from $LANG) | |
| 2670 global | |
| 2671 {only available when compiled with the |+multi_byte| | |
| 2672 feature} | |
| 2673 {not in Vi} | |
| 2674 Sets the character encoding used inside Vim. It applies to text in | |
| 2675 the buffers, registers, Strings in expressions, text stored in the | |
| 2676 viminfo file, etc. It sets the kind of characters which Vim can work | |
| 2677 with. See |encoding-names| for the possible values. | |
| 2678 | |
| 2679 NOTE: Changing this option will not change the encoding of the | |
| 39 | 2680 existing text in Vim. It may cause non-ASCII text to become invalid. |
| 7 | 2681 It should normally be kept at its default value, or set when Vim |
| 1152 | 2682 starts up. See |multibyte|. To reload the menus see |:menutrans|. |
| 7 | 2683 |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2684 This option cannot be set from a |modeline|. It would most likely |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2685 corrupt the text. |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2686 |
| 7 | 2687 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to |
| 2688 "utf-8". Although care has been taken to allow different values of | |
| 2689 'encoding', "utf-8" is the natural choice for the environment and | |
| 2690 avoids unnecessary conversion overhead. "utf-8" has not been made | |
| 10 | 2691 the default to prevent different behavior of the GUI and terminal |
| 7 | 2692 versions, and to avoid changing the encoding of newly created files |
| 2693 without your knowledge (in case 'fileencodings' is empty). | |
| 2694 | |
| 2695 The character encoding of files can be different from 'encoding'. | |
| 10 | 2696 This is specified with 'fileencoding'. The conversion is done with |
| 7 | 2697 iconv() or as specified with 'charconvert'. |
| 2698 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2699 If you need to know whether 'encoding' is a multi-byte encoding, you |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2700 can use: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2701 if has("multi_byte_encoding") |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2702 < |
| 7 | 2703 Normally 'encoding' will be equal to your current locale. This will |
| 2704 be the default if Vim recognizes your environment settings. If | |
| 2705 'encoding' is not set to the current locale, 'termencoding' must be | |
| 2706 set to convert typed and displayed text. See |encoding-table|. | |
| 2707 | |
| 2708 When you set this option, it fires the |EncodingChanged| autocommand | |
| 2709 event so that you can set up fonts if necessary. | |
| 2710 | |
| 2711 When the option is set, the value is converted to lowercase. Thus | |
| 2712 you can set it with uppercase values too. Underscores are translated | |
| 2713 to '-' signs. | |
| 2714 When the encoding is recognized, it is changed to the standard name. | |
| 2715 For example "Latin-1" becomes "latin1", "ISO_88592" becomes | |
| 2716 "iso-8859-2" and "utf8" becomes "utf-8". | |
| 2717 | |
| 2718 Note: "latin1" is also used when the encoding could not be detected. | |
| 2719 This only works when editing files in the same encoding! When the | |
| 2720 actual character set is not latin1, make sure 'fileencoding' and | |
| 2721 'fileencodings' are empty. When conversion is needed, switch to using | |
| 2722 utf-8. | |
| 2723 | |
| 2724 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8. | |
| 2725 You don't notice this while editing, but it does matter for the | |
| 2726 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus | |
| 2727 setting 'encoding' to one of these values instead of utf-8 only has | |
| 2728 effect for encoding used for files when 'fileencoding' is empty. | |
| 448 | 2729 |
| 2730 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was | |
| 2731 not set yet, the default for 'fileencodings' is changed. | |
| 7 | 2732 |
| 2733 *'endofline'* *'eol'* *'noendofline'* *'noeol'* | |
| 2734 'endofline' 'eol' boolean (default on) | |
| 2735 local to buffer | |
| 2736 {not in Vi} | |
| 2737 When writing a file and this option is off and the 'binary' option | |
| 6933 | 2738 is on, or 'fixeol' option is off, no <EOL> will be written for the |
| 2739 last line in the file. This option is automatically set or reset when | |
| 2740 starting to edit a new file, depending on whether file has an <EOL> | |
| 2741 for the last line in the file. Normally you don't have to set or | |
| 2742 reset this option. | |
| 2743 When 'binary' is off and 'fixeol' is on the value is not used when | |
| 2744 writing the file. When 'binary' is on or 'fixeol' is off it is used | |
| 2745 to remember the presence of a <EOL> for the last line in the file, so | |
| 2746 that when you write the file the situation from the original file can | |
| 2747 be kept. But you can change it if you want to. | |
| 7 | 2748 |
| 2749 *'equalalways'* *'ea'* *'noequalalways'* *'noea'* | |
| 2750 'equalalways' 'ea' boolean (default on) | |
| 2751 global | |
| 2752 {not in Vi} | |
| 2753 When on, all the windows are automatically made the same size after | |
| 33 | 2754 splitting or closing a window. This also happens the moment the |
| 2755 option is switched on. When off, splitting a window will reduce the | |
| 2756 size of the current window and leave the other windows the same. When | |
| 2757 closing a window the extra lines are given to the window next to it | |
| 2758 (depending on 'splitbelow' and 'splitright'). | |
| 7 | 2759 When mixing vertically and horizontally split windows, a minimal size |
| 2760 is computed and some windows may be larger if there is room. The | |
| 2761 'eadirection' option tells in which direction the size is affected. | |
| 1354 | 2762 Changing the height and width of a window can be avoided by setting |
| 2763 'winfixheight' and 'winfixwidth', respectively. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2764 If a window size is specified when creating a new window sizes are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2765 currently not equalized (it's complicated, but may be implemented in |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2766 the future). |
| 7 | 2767 |
| 2768 *'equalprg'* *'ep'* | |
| 2769 'equalprg' 'ep' string (default "") | |
| 2770 global or local to buffer |global-local| | |
| 2771 {not in Vi} | |
| 2772 External program to use for "=" command. When this option is empty | |
| 1621 | 2773 the internal formatting functions are used; either 'lisp', 'cindent' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2774 or 'indentexpr'. When Vim was compiled without internal formatting, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2775 the "indent" program is used. |
| 10 | 2776 Environment variables are expanded |:set_env|. See |option-backslash| |
| 7 | 2777 about including spaces and backslashes. |
| 2778 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2779 security reasons. | |
| 2780 | |
| 2781 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'* | |
| 2782 'errorbells' 'eb' boolean (default off) | |
| 2783 global | |
| 2784 Ring the bell (beep or screen flash) for error messages. This only | |
| 2785 makes a difference for error messages, the bell will be used always | |
| 2786 for a lot of errors without a message (e.g., hitting <Esc> in Normal | |
| 10 | 2787 mode). See 'visualbell' on how to make the bell behave like a beep, |
| 6949 | 2788 screen flash or do nothing. See 'belloff' to finetune when to ring the |
| 2789 bell. | |
| 7 | 2790 |
| 2791 *'errorfile'* *'ef'* | |
| 2792 'errorfile' 'ef' string (Amiga default: "AztecC.Err", | |
| 2793 others: "errors.err") | |
| 2794 global | |
| 2795 {not in Vi} | |
| 2796 {not available when compiled without the |+quickfix| | |
| 2797 feature} | |
| 2798 Name of the errorfile for the QuickFix mode (see |:cf|). | |
| 2799 When the "-q" command-line argument is used, 'errorfile' is set to the | |
| 2800 following argument. See |-q|. | |
| 2801 NOT used for the ":make" command. See 'makeef' for that. | |
| 2802 Environment variables are expanded |:set_env|. | |
| 2803 See |option-backslash| about including spaces and backslashes. | |
| 2804 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 2805 security reasons. | |
| 2806 | |
| 2807 *'errorformat'* *'efm'* | |
| 2808 'errorformat' 'efm' string (default is very long) | |
| 2809 global or local to buffer |global-local| | |
| 2810 {not in Vi} | |
| 2811 {not available when compiled without the |+quickfix| | |
| 2812 feature} | |
| 2813 Scanf-like description of the format for the lines in the error file | |
| 2814 (see |errorformat|). | |
| 2815 | |
| 2816 *'esckeys'* *'ek'* *'noesckeys'* *'noek'* | |
| 2817 'esckeys' 'ek' boolean (Vim default: on, Vi default: off) | |
| 2818 global | |
| 2819 {not in Vi} | |
| 2820 Function keys that start with an <Esc> are recognized in Insert | |
| 2821 mode. When this option is off, the cursor and function keys cannot be | |
| 2822 used in Insert mode if they start with an <Esc>. The advantage of | |
| 2823 this is that the single <Esc> is recognized immediately, instead of | |
| 2824 after one second. Instead of resetting this option, you might want to | |
| 2825 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that | |
| 2826 when 'esckeys' is off, you can still map anything, but the cursor keys | |
| 2827 won't work by default. | |
| 2828 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 2829 set and to the Vim default value when 'compatible' is reset. | |
| 2830 | |
| 2831 *'eventignore'* *'ei'* | |
| 2832 'eventignore' 'ei' string (default "") | |
| 2833 global | |
| 2834 {not in Vi} | |
| 2835 {not available when compiled without the |+autocmd| | |
| 2836 feature} | |
| 2837 A list of autocommand event names, which are to be ignored. | |
| 844 | 2838 When set to "all" or when "all" is one of the items, all autocommand |
| 2839 events are ignored, autocommands will not be executed. | |
| 7 | 2840 Otherwise this is a comma separated list of event names. Example: > |
| 2841 :set ei=WinEnter,WinLeave | |
| 2842 < | |
| 2843 *'expandtab'* *'et'* *'noexpandtab'* *'noet'* | |
| 2844 'expandtab' 'et' boolean (default off) | |
| 2845 local to buffer | |
| 2846 {not in Vi} | |
| 2847 In Insert mode: Use the appropriate number of spaces to insert a | |
| 10 | 2848 <Tab>. Spaces are used in indents with the '>' and '<' commands and |
| 7 | 2849 when 'autoindent' is on. To insert a real tab when 'expandtab' is |
| 2850 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
2851 This option is reset when the 'paste' option is set and restored when |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
2852 the 'paste' option is reset. |
| 7 | 2853 NOTE: This option is reset when 'compatible' is set. |
| 2854 | |
| 2855 *'exrc'* *'ex'* *'noexrc'* *'noex'* | |
| 2856 'exrc' 'ex' boolean (default off) | |
| 2857 global | |
| 2858 {not in Vi} | |
| 2859 Enables the reading of .vimrc, .exrc and .gvimrc in the current | |
|
10027
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2860 directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2861 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2862 Setting this option is a potential security leak. E.g., consider |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2863 unpacking a package or fetching files from github, a .vimrc in there |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2864 might be a trojan horse. BETTER NOT SET THIS OPTION! |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2865 Instead, define an autocommand in your .vimrc to set options for a |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2866 matching directory. |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2867 |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2868 If you do switch this option on you should also consider setting the |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2869 'secure' option (see |initialization|). |
|
018fead968c1
commit https://github.com/vim/vim/commit/36f44c21da2e912c008683a0c4447fca2a071e9a
Christian Brabandt <cb@256bit.org>
parents:
9975
diff
changeset
|
2870 Also see |.vimrc| and |gui-init|. |
| 7 | 2871 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 2872 security reasons. | |
| 2873 | |
| 2874 *'fileencoding'* *'fenc'* *E213* | |
| 2875 'fileencoding' 'fenc' string (default: "") | |
| 2876 local to buffer | |
| 2877 {only available when compiled with the |+multi_byte| | |
| 2878 feature} | |
| 2879 {not in Vi} | |
| 2880 Sets the character encoding for the file of this buffer. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2881 |
| 7 | 2882 When 'fileencoding' is different from 'encoding', conversion will be |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2883 done when writing the file. For reading see below. |
| 7 | 2884 When 'fileencoding' is empty, the same value as 'encoding' will be |
| 2885 used (no conversion when reading or writing a file). | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2886 Conversion will also be done when 'encoding' and 'fileencoding' are |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2887 both a Unicode encoding and 'fileencoding' is not utf-8. That's |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2888 because internally Unicode is always stored as utf-8. |
| 7 | 2889 WARNING: Conversion can cause loss of information! When |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2890 'encoding' is "utf-8" or another Unicode encoding, conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2891 is most likely done in a way that the reverse conversion |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2892 results in the same text. When 'encoding' is not "utf-8" some |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
2893 characters may be lost! |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2894 |
| 7 | 2895 See 'encoding' for the possible values. Additionally, values may be |
| 2896 specified that can be handled by the converter, see | |
| 2897 |mbyte-conversion|. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2898 |
| 7 | 2899 When reading a file 'fileencoding' will be set from 'fileencodings'. |
| 2900 To read a file in a certain encoding it won't work by setting | |
| 1152 | 2901 'fileencoding', use the |++enc| argument. One exception: when |
| 2902 'fileencodings' is empty the value of 'fileencoding' is used. | |
| 692 | 2903 For a new file the global value of 'fileencoding' is used. |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2904 |
| 7 | 2905 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored. |
| 2906 When the option is set, the value is converted to lowercase. Thus | |
| 2907 you can set it with uppercase values too. '_' characters are | |
| 2908 replaced with '-'. If a name is recognized from the list for | |
| 2909 'encoding', it is replaced by the standard name. For example | |
| 2910 "ISO8859-2" becomes "iso-8859-2". | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2911 |
| 7 | 2912 When this option is set, after starting to edit a file, the 'modified' |
| 2913 option is set, because the file would be different when written. | |
|
2317
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2914 |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2915 Keep in mind that changing 'fenc' from a modeline happens |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2916 AFTER the text has been read, thus it applies to when the file will be |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2917 written. If you do set 'fenc' in a modeline, you might want to set |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2918 'nomodified' to avoid not being able to ":q". |
|
2b2cd34569eb
Disallow setting 'enc' in a modeline. (Patrick Texier)
Bram Moolenaar <bram@vim.org>
parents:
2314
diff
changeset
|
2919 |
| 7 | 2920 This option can not be changed when 'modifiable' is off. |
| 2921 | |
| 2922 *'fe'* | |
| 2923 NOTE: Before version 6.0 this option specified the encoding for the | |
| 10 | 2924 whole of Vim, this was a mistake. Now use 'encoding' instead. The |
| 7 | 2925 old short name was 'fe', which is no longer used. |
| 2926 | |
| 2927 *'fileencodings'* *'fencs'* | |
| 39 | 2928 'fileencodings' 'fencs' string (default: "ucs-bom", |
| 2929 "ucs-bom,utf-8,default,latin1" when | |
| 2930 'encoding' is set to a Unicode value) | |
| 7 | 2931 global |
| 2932 {only available when compiled with the |+multi_byte| | |
| 2933 feature} | |
| 2934 {not in Vi} | |
| 2935 This is a list of character encodings considered when starting to edit | |
| 2936 an existing file. When a file is read, Vim tries to use the first | |
| 2937 mentioned character encoding. If an error is detected, the next one | |
| 2938 in the list is tried. When an encoding is found that works, | |
| 10 | 2939 'fileencoding' is set to it. If all fail, 'fileencoding' is set to |
| 7 | 2940 an empty string, which means the value of 'encoding' is used. |
| 2941 WARNING: Conversion can cause loss of information! When | |
| 2942 'encoding' is "utf-8" (or one of the other Unicode variants) | |
| 2943 conversion is most likely done in a way that the reverse | |
| 2944 conversion results in the same text. When 'encoding' is not | |
| 596 | 2945 "utf-8" some non-ASCII characters may be lost! You can use |
| 2946 the |++bad| argument to specify what is done with characters | |
| 2947 that can't be converted. | |
| 7 | 2948 For an empty file or a file with only ASCII characters most encodings |
| 2949 will work and the first entry of 'fileencodings' will be used (except | |
| 2950 "ucs-bom", which requires the BOM to be present). If you prefer | |
| 2951 another encoding use an BufReadPost autocommand event to test if your | |
| 2952 preferred encoding is to be used. Example: > | |
| 2953 au BufReadPost * if search('\S', 'w') == 0 | | |
| 2954 \ set fenc=iso-2022-jp | endif | |
| 2955 < This sets 'fileencoding' to "iso-2022-jp" if the file does not contain | |
| 2956 non-blank characters. | |
| 596 | 2957 When the |++enc| argument is used then the value of 'fileencodings' is |
| 2958 not used. | |
| 692 | 2959 Note that 'fileencodings' is not used for a new file, the global value |
| 2960 of 'fileencoding' is used instead. You can set it with: > | |
| 2961 :setglobal fenc=iso-8859-2 | |
| 2962 < This means that a non-existing file may get a different encoding than | |
| 2963 an empty file. | |
| 7 | 2964 The special value "ucs-bom" can be used to check for a Unicode BOM |
| 2965 (Byte Order Mark) at the start of the file. It must not be preceded | |
| 2966 by "utf-8" or another Unicode encoding for this to work properly. | |
| 2967 An entry for an 8-bit encoding (e.g., "latin1") should be the last, | |
| 2968 because Vim cannot detect an error, thus the encoding is always | |
| 2969 accepted. | |
| 39 | 2970 The special value "default" can be used for the encoding from the |
| 2971 environment. This is the default value for 'encoding'. It is useful | |
| 2972 when 'encoding' is set to "utf-8" and your environment uses a | |
| 2973 non-latin1 encoding, such as Russian. | |
| 777 | 2974 When 'encoding' is "utf-8" and a file contains an illegal byte |
| 2975 sequence it won't be recognized as UTF-8. You can use the |8g8| | |
| 2976 command to find the illegal byte sequence. | |
| 7 | 2977 WRONG VALUES: WHAT'S WRONG: |
| 2978 latin1,utf-8 "latin1" will always be used | |
| 2979 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8 | |
| 2980 file | |
| 2981 cp1250,latin1 "cp1250" will always be used | |
| 2982 If 'fileencodings' is empty, 'fileencoding' is not modified. | |
| 2983 See 'fileencoding' for the possible values. | |
| 2984 Setting this option does not have an effect until the next time a file | |
| 2985 is read. | |
| 2986 | |
| 2987 *'fileformat'* *'ff'* | |
| 2988 'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos", | |
| 2989 Unix default: "unix", | |
| 2990 Macintosh default: "mac") | |
| 2991 local to buffer | |
| 2992 {not in Vi} | |
| 2993 This gives the <EOL> of the current buffer, which is used for | |
| 2994 reading/writing the buffer from/to a file: | |
| 2995 dos <CR> <NL> | |
| 2996 unix <NL> | |
| 2997 mac <CR> | |
| 2998 When "dos" is used, CTRL-Z at the end of a file is ignored. | |
| 2999 See |file-formats| and |file-read|. | |
| 3000 For the character encoding of the file see 'fileencoding'. | |
| 3001 When 'binary' is set, the value of 'fileformat' is ignored, file I/O | |
| 4264 | 3002 works like it was set to "unix". |
| 7 | 3003 This option is set automatically when starting to edit a file and |
| 3004 'fileformats' is not empty and 'binary' is off. | |
| 3005 When this option is set, after starting to edit a file, the 'modified' | |
| 3006 option is set, because the file would be different when written. | |
| 3007 This option can not be changed when 'modifiable' is off. | |
| 3008 For backwards compatibility: When this option is set to "dos", | |
| 3009 'textmode' is set, otherwise 'textmode' is reset. | |
| 3010 | |
| 3011 *'fileformats'* *'ffs'* | |
| 3012 'fileformats' 'ffs' string (default: | |
| 3013 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix", | |
| 3014 Vim Unix: "unix,dos", | |
| 3015 Vim Mac: "mac,unix,dos", | |
| 3016 Vi Cygwin: "unix,dos", | |
| 3017 Vi others: "") | |
| 3018 global | |
| 3019 {not in Vi} | |
| 3020 This gives the end-of-line (<EOL>) formats that will be tried when | |
| 3021 starting to edit a new buffer and when reading a file into an existing | |
| 3022 buffer: | |
| 3023 - When empty, the format defined with 'fileformat' will be used | |
| 3024 always. It is not set automatically. | |
| 3025 - When set to one name, that format will be used whenever a new buffer | |
| 10 | 3026 is opened. 'fileformat' is set accordingly for that buffer. The |
| 7 | 3027 'fileformats' name will be used when a file is read into an existing |
| 3028 buffer, no matter what 'fileformat' for that buffer is set to. | |
| 3029 - When more than one name is present, separated by commas, automatic | |
| 3030 <EOL> detection will be done when reading a file. When starting to | |
| 3031 edit a file, a check is done for the <EOL>: | |
| 3032 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos", | |
| 3033 'fileformat' is set to "dos". | |
| 3034 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat' | |
| 10 | 3035 is set to "unix". Note that when a <NL> is found without a |
| 7 | 3036 preceding <CR>, "unix" is preferred over "dos". |
| 6647 | 3037 3. If 'fileformat' has not yet been set, and if a <CR> is found, and |
| 3038 if 'fileformats' includes "mac", 'fileformat' is set to "mac". | |
| 2587 | 3039 This means that "mac" is only chosen when: |
| 3040 "unix" is not present or no <NL> is found in the file, and | |
| 3041 "dos" is not present or no <CR><NL> is found in the file. | |
| 3042 Except: if "unix" was chosen, but there is a <CR> before | |
| 3043 the first <NL>, and there appear to be more <CR>s than <NL>s in | |
| 2642 | 3044 the first few lines, "mac" is used. |
| 7 | 3045 4. If 'fileformat' is still not set, the first name from |
| 3046 'fileformats' is used. | |
| 3047 When reading a file into an existing buffer, the same is done, but | |
| 3048 this happens like 'fileformat' has been set appropriately for that | |
| 3049 file only, the option is not changed. | |
| 3050 When 'binary' is set, the value of 'fileformats' is not used. | |
| 3051 | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3052 When Vim starts up with an empty buffer the first item is used. You |
|
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
3053 can overrule this by setting 'fileformat' in your .vimrc. |
| 2662 | 3054 |
| 7 | 3055 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that |
| 3056 are ":source"ed and for vimrc files, automatic <EOL> detection may be | |
| 3057 done: | |
| 3058 - When 'fileformats' is empty, there is no automatic detection. Dos | |
| 3059 format will be used. | |
| 3060 - When 'fileformats' is set to one or more names, automatic detection | |
| 3061 is done. This is based on the first <NL> in the file: If there is a | |
| 3062 <CR> in front of it, Dos format is used, otherwise Unix format is | |
| 3063 used. | |
| 3064 Also see |file-formats|. | |
| 3065 For backwards compatibility: When this option is set to an empty | |
| 3066 string or one format (no comma is included), 'textauto' is reset, | |
| 3067 otherwise 'textauto' is set. | |
| 3068 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3069 set and to the Vim default value when 'compatible' is reset. | |
| 3070 | |
| 4264 | 3071 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'* |
| 3072 'fileignorecase' 'fic' boolean (default on for systems where case in file | |
| 3073 names is normally ignored) | |
| 4242 | 3074 global |
| 3075 {not in Vi} | |
| 3076 When set case is ignored when using file names and directories. | |
| 3077 See 'wildignorecase' for only ignoring case when doing completion. | |
| 3078 | |
| 7 | 3079 *'filetype'* *'ft'* |
| 3080 'filetype' 'ft' string (default: "") | |
| 3081 local to buffer | |
| 3082 {not in Vi} | |
| 3083 {not available when compiled without the |+autocmd| | |
| 3084 feature} | |
| 3085 When this option is set, the FileType autocommand event is triggered. | |
| 3086 All autocommands that match with the value of this option will be | |
| 3087 executed. Thus the value of 'filetype' is used in place of the file | |
| 3088 name. | |
| 3089 Otherwise this option does not always reflect the current file type. | |
| 3090 This option is normally set when the file type is detected. To enable | |
| 3091 this use the ":filetype on" command. |:filetype| | |
| 3092 Setting this option to a different value is most useful in a modeline, | |
| 3093 for a file for which the file type is not automatically recognized. | |
| 782 | 3094 Example, for in an IDL file: |
| 3095 /* vim: set filetype=idl : */ ~ | |
| 3096 |FileType| |filetypes| | |
| 3097 When a dot appears in the value then this separates two filetype | |
| 3098 names. Example: | |
| 3099 /* vim: set filetype=c.doxygen : */ ~ | |
| 3100 This will use the "c" filetype first, then the "doxygen" filetype. | |
| 3101 This works both for filetype plugins and for syntax files. More than | |
| 3102 one dot may appear. | |
| 7 | 3103 This option is not copied to another buffer, independent of the 's' or |
| 3104 'S' flag in 'cpoptions'. | |
| 36 | 3105 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 3106 |
| 3107 *'fillchars'* *'fcs'* | |
| 3108 'fillchars' 'fcs' string (default "vert:|,fold:-") | |
| 3109 global | |
| 3110 {not in Vi} | |
| 3111 {not available when compiled without the |+windows| | |
| 3112 and |+folding| features} | |
| 3113 Characters to fill the statuslines and vertical separators. | |
| 3114 It is a comma separated list of items: | |
| 3115 | |
| 3116 item default Used for ~ | |
| 3117 stl:c ' ' or '^' statusline of the current window | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3118 stlnc:c ' ' or '=' statusline of the non-current windows |
| 7 | 3119 vert:c '|' vertical separators |:vsplit| |
| 3120 fold:c '-' filling 'foldtext' | |
| 3121 diff:c '-' deleted lines of the 'diff' option | |
| 3122 | |
| 10 | 3123 Any one that is omitted will fall back to the default. For "stl" and |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3124 "stlnc" the space will be used when there is highlighting, '^' or '=' |
| 7 | 3125 otherwise. |
| 3126 | |
| 3127 Example: > | |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
3128 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:- |
| 7 | 3129 < This is similar to the default, except that these characters will also |
| 3130 be used when there is highlighting. | |
| 3131 | |
| 819 | 3132 for "stl" and "stlnc" only single-byte values are supported. |
| 3133 | |
| 7 | 3134 The highlighting used for these items: |
| 3135 item highlight group ~ | |
| 3136 stl:c StatusLine |hl-StatusLine| | |
| 3137 stlnc:c StatusLineNC |hl-StatusLineNC| | |
| 3138 vert:c VertSplit |hl-VertSplit| | |
| 3139 fold:c Folded |hl-Folded| | |
| 3140 diff:c DiffDelete |hl-DiffDelete| | |
| 3141 | |
| 6933 | 3142 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* |
| 3143 'fixendofline' 'fixeol' boolean (default on) | |
| 3144 local to buffer | |
| 3145 {not in Vi} | |
| 3146 When writing a file and this option is on, <EOL> at the end of file | |
| 3147 will be restored if missing. Turn this option off if you want to | |
| 3148 preserve the situation from the original file. | |
| 3149 When the 'binary' option is set the value of this option doesn't | |
| 3150 matter. | |
| 3151 See the 'endofline' option. | |
| 3152 | |
| 7 | 3153 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'* |
| 3154 'fkmap' 'fk' boolean (default off) *E198* | |
| 3155 global | |
| 3156 {not in Vi} | |
| 3157 {only available when compiled with the |+rightleft| | |
| 3158 feature} | |
| 3159 When on, the keyboard is mapped for the Farsi character set. | |
| 3160 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
| 10 | 3161 toggle this option |i_CTRL-_|. See |farsi.txt|. |
| 7 | 3162 |
| 3163 *'foldclose'* *'fcl'* | |
| 3164 'foldclose' 'fcl' string (default "") | |
| 3165 global | |
| 3166 {not in Vi} | |
| 3167 {not available when compiled without the |+folding| | |
| 3168 feature} | |
| 3169 When set to "all", a fold is closed when the cursor isn't in it and | |
| 3170 its level is higher than 'foldlevel'. Useful if you want folds to | |
| 3171 automatically close when moving out of them. | |
| 3172 | |
| 3173 *'foldcolumn'* *'fdc'* | |
| 3174 'foldcolumn' 'fdc' number (default 0) | |
| 3175 local to window | |
| 3176 {not in Vi} | |
| 3177 {not available when compiled without the |+folding| | |
| 3178 feature} | |
| 3179 When non-zero, a column with the specified width is shown at the side | |
| 3180 of the window which indicates open and closed folds. The maximum | |
| 3181 value is 12. | |
| 3182 See |folding|. | |
| 3183 | |
| 3184 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'* | |
| 3185 'foldenable' 'fen' boolean (default on) | |
| 3186 local to window | |
| 3187 {not in Vi} | |
| 3188 {not available when compiled without the |+folding| | |
| 3189 feature} | |
| 3190 When off, all folds are open. This option can be used to quickly | |
| 3191 switch between showing all text unfolded and viewing the text with | |
| 3192 folds (including manually opened or closed folds). It can be toggled | |
| 10 | 3193 with the |zi| command. The 'foldcolumn' will remain blank when |
| 7 | 3194 'foldenable' is off. |
| 3195 This option is set by commands that create a new fold or close a fold. | |
| 3196 See |folding|. | |
| 3197 | |
| 3198 *'foldexpr'* *'fde'* | |
| 3199 'foldexpr' 'fde' string (default: "0") | |
| 3200 local to window | |
| 3201 {not in Vi} | |
| 3202 {not available when compiled without the |+folding| | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3203 or |+eval| features} |
| 7 | 3204 The expression used for when 'foldmethod' is "expr". It is evaluated |
| 634 | 3205 for each line to obtain its fold level. See |fold-expr|. |
| 782 | 3206 |
| 3682 | 3207 The expression will be evaluated in the |sandbox| if set from a |
| 3208 modeline, see |sandbox-option|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3209 This option can't be set from a |modeline| when the 'diff' option is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3210 on. |
| 634 | 3211 |
| 3212 It is not allowed to change text or jump to another window while | |
| 3213 evaluating 'foldexpr' |textlock|. | |
| 7 | 3214 |
| 3215 *'foldignore'* *'fdi'* | |
| 3216 'foldignore' 'fdi' string (default: "#") | |
| 3217 local to window | |
| 3218 {not in Vi} | |
| 3219 {not available when compiled without the |+folding| | |
| 3220 feature} | |
| 3221 Used only when 'foldmethod' is "indent". Lines starting with | |
| 3222 characters in 'foldignore' will get their fold level from surrounding | |
| 10 | 3223 lines. White space is skipped before checking for this character. |
| 7 | 3224 The default "#" works well for C programs. See |fold-indent|. |
| 3225 | |
| 3226 *'foldlevel'* *'fdl'* | |
| 3227 'foldlevel' 'fdl' number (default: 0) | |
| 3228 local to window | |
| 3229 {not in Vi} | |
| 3230 {not available when compiled without the |+folding| | |
| 3231 feature} | |
| 3232 Sets the fold level: Folds with a higher level will be closed. | |
| 3233 Setting this option to zero will close all folds. Higher numbers will | |
| 3234 close fewer folds. | |
| 3235 This option is set by commands like |zm|, |zM| and |zR|. | |
| 3236 See |fold-foldlevel|. | |
| 3237 | |
| 3238 *'foldlevelstart'* *'fdls'* | |
| 3239 'foldlevelstart' 'fdls' number (default: -1) | |
| 3240 global | |
| 3241 {not in Vi} | |
| 3242 {not available when compiled without the |+folding| | |
| 3243 feature} | |
| 3244 Sets 'foldlevel' when starting to edit another buffer in a window. | |
| 3245 Useful to always start editing with all folds closed (value zero), | |
| 3246 some folds closed (one) or no folds closed (99). | |
| 3247 This is done before reading any modeline, thus a setting in a modeline | |
| 10 | 3248 overrules this option. Starting to edit a file for |diff-mode| also |
| 7 | 3249 ignores this option and closes all folds. |
| 3250 It is also done before BufReadPre autocommands, to allow an autocmd to | |
| 3251 overrule the 'foldlevel' value for specific files. | |
| 3252 When the value is negative, it is not used. | |
| 3253 | |
| 3254 *'foldmarker'* *'fmr'* *E536* | |
| 3255 'foldmarker' 'fmr' string (default: "{{{,}}}") | |
| 3256 local to window | |
| 3257 {not in Vi} | |
| 3258 {not available when compiled without the |+folding| | |
| 3259 feature} | |
| 3260 The start and end marker used when 'foldmethod' is "marker". There | |
| 3261 must be one comma, which separates the start and end marker. The | |
| 3262 marker is a literal string (a regular expression would be too slow). | |
| 3263 See |fold-marker|. | |
| 3264 | |
| 3265 *'foldmethod'* *'fdm'* | |
| 3266 'foldmethod' 'fdm' string (default: "manual") | |
| 3267 local to window | |
| 3268 {not in Vi} | |
| 3269 {not available when compiled without the |+folding| | |
| 3270 feature} | |
| 3271 The kind of folding used for the current window. Possible values: | |
| 3272 |fold-manual| manual Folds are created manually. | |
| 3273 |fold-indent| indent Lines with equal indent form a fold. | |
| 3274 |fold-expr| expr 'foldexpr' gives the fold level of a line. | |
| 3275 |fold-marker| marker Markers are used to specify folds. | |
| 3276 |fold-syntax| syntax Syntax highlighting items specify folds. | |
| 3277 |fold-diff| diff Fold text that is not changed. | |
| 3278 | |
| 3279 *'foldminlines'* *'fml'* | |
| 3280 'foldminlines' 'fml' number (default: 1) | |
| 3281 local to window | |
| 3282 {not in Vi} | |
| 3283 {not available when compiled without the |+folding| | |
| 3284 feature} | |
| 2709 | 3285 Sets the number of screen lines above which a fold can be displayed |
| 3286 closed. Also for manually closed folds. With the default value of | |
| 3287 one a fold can only be closed if it takes up two or more screen lines. | |
| 3288 Set to zero to be able to close folds of just one screen line. | |
| 2826 | 3289 Note that this only has an effect on what is displayed. After using |
| 7 | 3290 "zc" to close a fold, which is displayed open because it's smaller |
| 3291 than 'foldminlines', a following "zc" may close a containing fold. | |
| 3292 | |
| 3293 *'foldnestmax'* *'fdn'* | |
| 3294 'foldnestmax' 'fdn' number (default: 20) | |
| 3295 local to window | |
| 3296 {not in Vi} | |
| 3297 {not available when compiled without the |+folding| | |
| 3298 feature} | |
| 3299 Sets the maximum nesting of folds for the "indent" and "syntax" | |
| 3300 methods. This avoids that too many folds will be created. Using more | |
| 3301 than 20 doesn't work, because the internal limit is 20. | |
| 3302 | |
| 3303 *'foldopen'* *'fdo'* | |
| 3304 'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix, | |
| 3305 search,tag,undo") | |
| 3306 global | |
| 3307 {not in Vi} | |
| 3308 {not available when compiled without the |+folding| | |
| 3309 feature} | |
| 3310 Specifies for which type of commands folds will be opened, if the | |
| 3311 command moves the cursor into a closed fold. It is a comma separated | |
| 3312 list of items. | |
| 2625 | 3313 NOTE: When the command is part of a mapping this option is not used. |
| 3314 Add the |zv| command to the mapping to get the same effect. | |
| 3315 (rationale: the mapping may want to control opening folds itself) | |
| 3316 | |
| 7 | 3317 item commands ~ |
| 3318 all any | |
| 3319 block "(", "{", "[[", "[{", etc. | |
| 3320 hor horizontal movements: "l", "w", "fx", etc. | |
| 3321 insert any command in Insert mode | |
| 3322 jump far jumps: "G", "gg", etc. | |
| 3323 mark jumping to a mark: "'m", CTRL-O, etc. | |
| 3324 percent "%" | |
| 3325 quickfix ":cn", ":crew", ":make", etc. | |
| 3326 search search for a pattern: "/", "n", "*", "gd", etc. | |
| 3327 (not for a search pattern in a ":" command) | |
| 819 | 3328 Also for |[s| and |]s|. |
| 7 | 3329 tag jumping to a tag: ":ta", CTRL-T, etc. |
| 3330 undo undo or redo: "u" and CTRL-R | |
| 3331 When a movement command is used for an operator (e.g., "dl" or "y%") | |
| 3332 this option is not used. This means the operator will include the | |
| 3333 whole closed fold. | |
| 3334 Note that vertical movements are not here, because it would make it | |
| 3335 very difficult to move onto a closed fold. | |
| 3336 In insert mode the folds containing the cursor will always be open | |
| 3337 when text is inserted. | |
| 3338 To close folds you can re-apply 'foldlevel' with the |zx| command or | |
| 3339 set the 'foldclose' option to "all". | |
| 3340 | |
| 3341 *'foldtext'* *'fdt'* | |
| 3342 'foldtext' 'fdt' string (default: "foldtext()") | |
| 3343 local to window | |
| 3344 {not in Vi} | |
| 3345 {not available when compiled without the |+folding| | |
| 3346 feature} | |
| 3347 An expression which is used to specify the text displayed for a closed | |
| 3348 fold. See |fold-foldtext|. | |
| 3349 | |
| 3682 | 3350 The expression will be evaluated in the |sandbox| if set from a |
| 3351 modeline, see |sandbox-option|. | |
| 634 | 3352 |
| 3353 It is not allowed to change text or jump to another window while | |
| 3354 evaluating 'foldtext' |textlock|. | |
| 3355 | |
|
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3356 *'formatexpr'* *'fex'* |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3357 'formatexpr' 'fex' string (default "") |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3358 local to buffer |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3359 {not in Vi} |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3360 {not available when compiled without the |+eval| |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3361 feature} |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3362 Expression which is evaluated to format a range of lines for the |gq| |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3363 operator or automatic formatting (see 'formatoptions'). When this |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3364 option is empty 'formatprg' is used. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3365 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3366 The |v:lnum| variable holds the first line to be formatted. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3367 The |v:count| variable holds the number of lines to be formatted. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3368 The |v:char| variable holds the character that is going to be |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3369 inserted if the expression is being evaluated due to |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3370 automatic formatting. This can be empty. Don't insert |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3371 it yet! |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3372 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3373 Example: > |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3374 :set formatexpr=mylang#Format() |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3375 < This will invoke the mylang#Format() function in the |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3376 autoload/mylang.vim file in 'runtimepath'. |autoload| |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3377 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3378 The expression is also evaluated when 'textwidth' is set and adding |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3379 text beyond that limit. This happens under the same conditions as |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3380 when internal formatting is used. Make sure the cursor is kept in the |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3381 same spot relative to the text then! The |mode()| function will |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3382 return "i" or "R" in this situation. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3383 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3384 When the expression evaluates to non-zero Vim will fall back to using |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3385 the internal format mechanism. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3386 |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3387 The expression will be evaluated in the |sandbox| when set from a |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3388 modeline, see |sandbox-option|. That stops the option from working, |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3389 since changing the buffer text is not allowed. |
|
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9227
diff
changeset
|
3390 |
| 7 | 3391 *'formatoptions'* *'fo'* |
| 3392 'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt") | |
| 3393 local to buffer | |
| 3394 {not in Vi} | |
| 3395 This is a sequence of letters which describes how automatic | |
| 3396 formatting is to be done. See |fo-table|. When the 'paste' option is | |
| 3397 on, no formatting is done (like 'formatoptions' is empty). Commas can | |
| 3398 be inserted for readability. | |
| 3399 To avoid problems with flags that are added in the future, use the | |
| 3400 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 3401 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 3402 set and to the Vim default value when 'compatible' is reset. | |
| 3403 | |
| 41 | 3404 *'formatlistpat'* *'flp'* |
| 3405 'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*") | |
| 3406 local to buffer | |
| 3407 {not in Vi} | |
| 3408 A pattern that is used to recognize a list header. This is used for | |
| 3409 the "n" flag in 'formatoptions'. | |
| 3410 The pattern must match exactly the text that will be the indent for | |
| 140 | 3411 the line below it. You can use |/\ze| to mark the end of the match |
| 41 | 3412 while still checking more characters. There must be a character |
| 3413 following the pattern, when it matches the whole line it is handled | |
| 3414 like there is no match. | |
| 3415 The default recognizes a number, followed by an optional punctuation | |
| 3416 character and white space. | |
| 3417 | |
| 7 | 3418 *'formatprg'* *'fp'* |
| 3419 'formatprg' 'fp' string (default "") | |
|
10579
688b97124d23
patch 8.0.0179: cannot have a local value for 'formatprg'
Christian Brabandt <cb@256bit.org>
parents:
10498
diff
changeset
|
3420 global or local to buffer |global-local| |
| 7 | 3421 {not in Vi} |
| 3422 The name of an external program that will be used to format the lines | |
| 667 | 3423 selected with the |gq| operator. The program must take the input on |
| 7 | 3424 stdin and produce the output on stdout. The Unix program "fmt" is |
| 557 | 3425 such a program. |
| 667 | 3426 If the 'formatexpr' option is not empty it will be used instead. |
| 3427 Otherwise, if 'formatprg' option is an empty string, the internal | |
| 3428 format function will be used |C-indenting|. | |
| 557 | 3429 Environment variables are expanded |:set_env|. See |option-backslash| |
| 3430 about including spaces and backslashes. | |
| 3682 | 3431 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 3432 security reasons. | |
| 667 | 3433 |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
3434 *'fsync'* *'fs'* *'nofsync'* *'nofs'* |
| 36 | 3435 'fsync' 'fs' boolean (default on) |
| 3436 global | |
| 3437 {not in Vi} | |
| 3438 When on, the library function fsync() will be called after writing a | |
| 3439 file. This will flush a file to disk, ensuring that it is safely | |
| 3440 written even on filesystems which do metadata-only journaling. This | |
| 3441 will force the harddrive to spin up on Linux systems running in laptop | |
| 3442 mode, so it may be undesirable in some situations. Be warned that | |
| 3443 turning this off increases the chances of data loss after a crash. On | |
| 3444 systems without an fsync() implementation, this variable is always | |
| 3445 off. | |
| 3446 Also see 'swapsync' for controlling fsync() on swap files. | |
| 3447 | |
| 7 | 3448 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'* |
| 3449 'gdefault' 'gd' boolean (default off) | |
| 3450 global | |
| 3451 {not in Vi} | |
| 3452 When on, the ":substitute" flag 'g' is default on. This means that | |
| 3453 all matches in a line are substituted instead of one. When a 'g' flag | |
| 3454 is given to a ":substitute" command, this will toggle the substitution | |
| 3455 of all or one match. See |complex-change|. | |
| 3456 | |
| 3457 command 'gdefault' on 'gdefault' off ~ | |
| 3458 :s/// subst. all subst. one | |
| 3459 :s///g subst. one subst. all | |
| 3460 :s///gg subst. all subst. one | |
| 3461 | |
| 3462 NOTE: This option is reset when 'compatible' is set. | |
| 3463 | |
| 3464 *'grepformat'* *'gfm'* | |
| 6213 | 3465 'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m") |
| 7 | 3466 global |
| 3467 {not in Vi} | |
| 3468 Format to recognize for the ":grep" command output. | |
| 3469 This is a scanf-like string that uses the same format as the | |
| 3470 'errorformat' option: see |errorformat|. | |
| 3471 | |
| 3472 *'grepprg'* *'gp'* | |
| 3473 'grepprg' 'gp' string (default "grep -n ", | |
| 3474 Unix: "grep -n $* /dev/null", | |
| 3475 Win32: "findstr /n" or "grep -n", | |
| 3476 VMS: "SEARCH/NUMBERS ") | |
| 3477 global or local to buffer |global-local| | |
| 3478 {not in Vi} | |
| 233 | 3479 Program to use for the |:grep| command. This option may contain '%' |
| 7 | 3480 and '#' characters, which are expanded like when used in a command- |
| 3481 line. The placeholder "$*" is allowed to specify where the arguments | |
| 3482 will be included. Environment variables are expanded |:set_env|. See | |
| 3483 |option-backslash| about including spaces and backslashes. | |
| 3484 When your "grep" accepts the "-H" argument, use this to make ":grep" | |
| 3485 also work well with a single file: > | |
| 3486 :set grepprg=grep\ -nH | |
| 161 | 3487 < Special value: When 'grepprg' is set to "internal" the |:grep| command |
| 657 | 3488 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like |
| 3489 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|. | |
| 41 | 3490 See also the section |:make_makeprg|, since most of the comments there |
| 7 | 3491 apply equally to 'grepprg'. |
| 3492 For Win32, the default is "findstr /n" if "findstr.exe" can be found, | |
| 3493 otherwise it's "grep -n". | |
| 3494 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3495 security reasons. | |
| 3496 | |
| 3497 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549* | |
| 3498 'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor, | |
| 3499 ve:ver35-Cursor, | |
| 3500 o:hor50-Cursor, | |
| 3501 i-ci:ver25-Cursor/lCursor, | |
| 3502 r-cr:hor20-Cursor/lCursor, | |
| 3503 sm:block-Cursor | |
| 3504 -blinkwait175-blinkoff150-blinkon175", | |
| 3505 for MS-DOS and Win32 console: | |
| 3506 "n-v-c:block,o:hor50,i-ci:hor15, | |
| 3507 r-cr:hor30,sm:block") | |
| 3508 global | |
| 3509 {not in Vi} | |
| 3510 {only available when compiled with GUI enabled, and | |
| 3511 for MS-DOS and Win32 console} | |
| 3512 This option tells Vim what the cursor should look like in different | |
| 10 | 3513 modes. It fully works in the GUI. In an MSDOS or Win32 console, only |
| 7 | 3514 the height of the cursor can be changed. This can be done by |
| 3515 specifying a block cursor, or a percentage for a vertical or | |
| 3516 horizontal cursor. | |
| 6727 | 3517 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are |
| 3518 used. | |
| 7 | 3519 |
| 10 | 3520 The option is a comma separated list of parts. Each part consist of a |
| 7 | 3521 mode-list and an argument-list: |
| 3522 mode-list:argument-list,mode-list:argument-list,.. | |
| 3523 The mode-list is a dash separated list of these modes: | |
| 3524 n Normal mode | |
| 3525 v Visual mode | |
| 3526 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 3527 if not specified) | |
| 3528 o Operator-pending mode | |
| 3529 i Insert mode | |
| 3530 r Replace mode | |
| 3531 c Command-line Normal (append) mode | |
| 3532 ci Command-line Insert mode | |
| 3533 cr Command-line Replace mode | |
| 3534 sm showmatch in Insert mode | |
| 3535 a all modes | |
| 3536 The argument-list is a dash separated list of these arguments: | |
| 3537 hor{N} horizontal bar, {N} percent of the character height | |
| 3538 ver{N} vertical bar, {N} percent of the character width | |
| 3539 block block cursor, fills the whole character | |
| 3540 [only one of the above three should be present] | |
| 3541 blinkwait{N} *cursor-blinking* | |
| 3542 blinkon{N} | |
| 3543 blinkoff{N} | |
| 3544 blink times for cursor: blinkwait is the delay before | |
| 3545 the cursor starts blinking, blinkon is the time that | |
| 3546 the cursor is shown and blinkoff is the time that the | |
| 3547 cursor is not shown. The times are in msec. When one | |
| 3548 of the numbers is zero, there is no blinking. The | |
| 3549 default is: "blinkwait700-blinkon400-blinkoff250". | |
| 3550 These numbers are used for a missing entry. This | |
| 3551 means that blinking is enabled by default. To switch | |
| 3552 blinking off you can use "blinkon0". The cursor only | |
| 3553 blinks when Vim is waiting for input, not while | |
| 3554 executing a command. | |
| 3555 To make the cursor blink in an xterm, see | |
| 3556 |xterm-blink|. | |
| 3557 {group-name} | |
| 3558 a highlight group name, that sets the color and font | |
| 3559 for the cursor | |
| 3560 {group-name}/{group-name} | |
| 3561 Two highlight group names, the first is used when | |
| 3562 no language mappings are used, the other when they | |
| 3563 are. |language-mapping| | |
| 3564 | |
| 3565 Examples of parts: | |
| 3566 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a | |
| 3567 block cursor with colors from the "nCursor" | |
| 3568 highlight group | |
| 3569 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150 | |
| 3570 In Insert and Command-line Insert mode, use a | |
| 3571 30% vertical bar cursor with colors from the | |
| 3572 "iCursor" highlight group. Blink a bit | |
| 3573 faster. | |
| 3574 | |
| 3575 The 'a' mode is different. It will set the given argument-list for | |
| 3576 all modes. It does not reset anything to defaults. This can be used | |
| 3577 to do a common setting for all modes. For example, to switch off | |
| 3578 blinking: "a:blinkon0" | |
| 3579 | |
| 3580 Examples of cursor highlighting: > | |
| 3581 :highlight Cursor gui=reverse guifg=NONE guibg=NONE | |
| 3582 :highlight Cursor gui=NONE guifg=bg guibg=fg | |
| 3583 < | |
| 3584 *'guifont'* *'gfn'* | |
| 2908 | 3585 *E235* *E596* |
| 7 | 3586 'guifont' 'gfn' string (default "") |
| 3587 global | |
| 3588 {not in Vi} | |
| 3589 {only available when compiled with GUI enabled} | |
| 3590 This is a list of fonts which will be used for the GUI version of Vim. | |
| 3591 In its simplest form the value is just one font name. When | |
| 3592 the font cannot be found you will get an error message. To try other | |
| 3593 font names a list can be specified, font names separated with commas. | |
| 3594 The first valid font is used. | |
| 8 | 3595 |
| 170 | 3596 On systems where 'guifontset' is supported (X11) and 'guifontset' is |
| 3597 not empty, then 'guifont' is not used. | |
| 8 | 3598 |
| 7 | 3599 Spaces after a comma are ignored. To include a comma in a font name |
| 3600 precede it with a backslash. Setting an option requires an extra | |
| 3601 backslash before a space and a backslash. See also | |
| 3602 |option-backslash|. For example: > | |
| 3603 :set guifont=Screen15,\ 7x13,font\\,with\\,commas | |
| 8 | 3604 < will make Vim try to use the font "Screen15" first, and if it fails it |
| 7 | 3605 will try to use "7x13" and then "font,with,commas" instead. |
| 8 | 3606 |
| 3607 If none of the fonts can be loaded, Vim will keep the current setting. | |
| 3608 If an empty font list is given, Vim will try using other resource | |
| 3609 settings (for X, it will use the Vim.font resource), and finally it | |
| 3610 will try some builtin default which should always be there ("7x13" in | |
| 3611 the case of X). The font names given should be "normal" fonts. Vim | |
| 3612 will try to find the related bold and italic fonts. | |
| 3613 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3614 For Win32, GTK, Motif, Mac OS and Photon: > |
| 8 | 3615 :set guifont=* |
| 3616 < will bring up a font requester, where you can pick the font you want. | |
| 3617 | |
| 3618 The font name depends on the GUI used. See |setting-guifont| for a | |
| 3619 way to set 'guifont' for various systems. | |
| 3620 | |
| 7 | 3621 For the GTK+ 2 GUI the font name looks like this: > |
| 3622 :set guifont=Andale\ Mono\ 11 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3623 < That's all. XLFDs are not used. For Chinese this is reported to work |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3624 well: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3625 if has("gui_gtk2") |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3626 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3627 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3628 endif |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3629 < |
| 170 | 3630 For Mac OSX you can use something like this: > |
| 3631 :set guifont=Monaco:h10 | |
| 853 | 3632 < Also see 'macatsui', it can help fix display problems. |
| 3633 *E236* | |
| 7 | 3634 Note that the fonts must be mono-spaced (all characters have the same |
| 8 | 3635 width). An exception is GTK 2: all fonts are accepted, but |
| 3636 mono-spaced fonts look best. | |
| 3637 | |
| 7 | 3638 To preview a font on X11, you might be able to use the "xfontsel" |
| 3639 program. The "xlsfonts" program gives a list of all available fonts. | |
| 8 | 3640 |
| 7 | 3641 For the Win32 GUI *E244* *E245* |
| 3642 - takes these options in the font name: | |
| 3643 hXX - height is XX (points, can be floating-point) | |
| 3644 wXX - width is XX (points, can be floating-point) | |
| 3645 b - bold | |
| 3646 i - italic | |
| 3647 u - underline | |
| 3648 s - strikeout | |
| 233 | 3649 cXX - character set XX. Valid charsets are: ANSI, ARABIC, |
| 7 | 3650 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK, |
| 3651 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS, | |
| 3652 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC. | |
| 22 | 3653 Normally you would use "cDEFAULT". |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8835
diff
changeset
|
3654 qXX - quality XX. Valid quality names are: PROOF, DRAFT, |
|
9097
071f9da012fb
commit https://github.com/vim/vim/commit/06d2d38ab7564e1f784b1058a4ef4580cd6d1810
Christian Brabandt <cb@256bit.org>
parents:
9027
diff
changeset
|
3655 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT. |
|
8835
c1a5623cfc86
commit https://github.com/vim/vim/commit/7c1c6dbb6817640fd3956a0d5417da23fde336d8
Christian Brabandt <cb@256bit.org>
parents:
8748
diff
changeset
|
3656 Normally you would use "qDEFAULT". |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
3657 Some quality values are not supported in legacy OSs. |
| 7 | 3658 |
| 3659 Use a ':' to separate the options. | |
| 3660 - A '_' can be used in the place of a space, so you don't need to use | |
| 3661 backslashes to escape the spaces. | |
| 3662 - Examples: > | |
| 3663 :set guifont=courier_new:h12:w5:b:cRUSSIAN | |
| 3664 :set guifont=Andale_Mono:h7.5:w4.5 | |
| 3665 < See also |font-sizes|. | |
| 3666 | |
| 3667 *'guifontset'* *'gfs'* | |
| 3668 *E250* *E252* *E234* *E597* *E598* | |
| 3669 'guifontset' 'gfs' string (default "") | |
| 3670 global | |
| 3671 {not in Vi} | |
| 3672 {only available when compiled with GUI enabled and | |
| 3673 with the |+xfontset| feature} | |
| 3674 {not available in the GTK+ 2 GUI} | |
| 3675 When not empty, specifies two (or more) fonts to be used. The first | |
| 3676 one for normal English, the second one for your special language. See | |
| 3677 |xfontset|. | |
| 3678 Setting this option also means that all font names will be handled as | |
| 3679 a fontset name. Also the ones used for the "font" argument of the | |
| 3680 |:highlight| command. | |
| 3681 The fonts must match with the current locale. If fonts for the | |
| 3682 character sets that the current locale uses are not included, setting | |
| 3683 'guifontset' will fail. | |
| 3684 Note the difference between 'guifont' and 'guifontset': In 'guifont' | |
| 3685 the comma-separated names are alternative names, one of which will be | |
| 3686 used. In 'guifontset' the whole string is one fontset name, | |
| 3687 including the commas. It is not possible to specify alternative | |
| 3688 fontset names. | |
| 3689 This example works on many X11 systems: > | |
| 3690 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-* | |
| 3691 < | |
| 3692 *'guifontwide'* *'gfw'* *E231* *E533* *E534* | |
| 3693 'guifontwide' 'gfw' string (default "") | |
| 3694 global | |
| 3695 {not in Vi} | |
| 3696 {only available when compiled with GUI enabled} | |
| 3697 When not empty, specifies a comma-separated list of fonts to be used | |
| 3698 for double-width characters. The first font that can be loaded is | |
| 3699 used. | |
| 3700 Note: The size of these fonts must be exactly twice as wide as the one | |
| 3701 specified with 'guifont' and the same height. | |
| 3702 | |
| 3703 All GUI versions but GTK+ 2: | |
| 3704 | |
| 3705 'guifontwide' is only used when 'encoding' is set to "utf-8" and | |
| 3706 'guifontset' is empty or invalid. | |
| 3707 When 'guifont' is set and a valid font is found in it and | |
| 3708 'guifontwide' is empty Vim will attempt to find a matching | |
| 3709 double-width font and set 'guifontwide' to it. | |
| 3710 | |
| 3711 GTK+ 2 GUI only: *guifontwide_gtk2* | |
| 3712 | |
| 3713 If set and valid, 'guifontwide' is always used for double width | |
| 3714 characters, even if 'encoding' is not set to "utf-8". | |
| 3715 Vim does not attempt to find an appropriate value for 'guifontwide' | |
| 10 | 3716 automatically. If 'guifontwide' is empty Pango/Xft will choose the |
| 7 | 3717 font for characters not available in 'guifont'. Thus you do not need |
| 3718 to set 'guifontwide' at all unless you want to override the choice | |
| 3719 made by Pango/Xft. | |
| 3720 | |
| 4055 | 3721 Windows +multibyte only: *guifontwide_win_mbyte* |
| 3722 | |
| 4073 | 3723 If set and valid, 'guifontwide' is used for IME instead of 'guifont'. |
| 4055 | 3724 |
| 7 | 3725 *'guiheadroom'* *'ghr'* |
| 3726 'guiheadroom' 'ghr' number (default 50) | |
| 3727 global | |
| 3728 {not in Vi} {only for GTK and X11 GUI} | |
| 3729 The number of pixels subtracted from the screen height when fitting | |
| 3730 the GUI window on the screen. Set this before the GUI is started, | |
| 3731 e.g., in your |gvimrc| file. When zero, the whole screen height will | |
| 10 | 3732 be used by the window. When positive, the specified number of pixel |
| 7 | 3733 lines will be left for window decorations and other items on the |
| 3734 screen. Set it to a negative value to allow windows taller than the | |
| 3735 screen. | |
| 3736 | |
| 3737 *'guioptions'* *'go'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3738 'guioptions' 'go' string (default "egmrLtT" (MS-Windows, "t" is |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3739 removed in |defaults.vim|), |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3740 "aegimrLtT" (GTK, Motif and Athena), |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
3741 ) |
| 7 | 3742 global |
| 3743 {not in Vi} | |
| 3744 {only available when compiled with GUI enabled} | |
| 8 | 3745 This option only has an effect in the GUI version of Vim. It is a |
| 7 | 3746 sequence of letters which describes what components and options of the |
| 3747 GUI should be used. | |
| 3748 To avoid problems with flags that are added in the future, use the | |
| 3749 "+=" and "-=" feature of ":set" |add-option-flags|. | |
| 3750 | |
| 3751 Valid letters are as follows: | |
| 1152 | 3752 *guioptions_a* *'go-a'* |
| 7 | 3753 'a' Autoselect: If present, then whenever VISUAL mode is started, |
| 3754 or the Visual area extended, Vim tries to become the owner of | |
| 3755 the windowing system's global selection. This means that the | |
| 3756 Visually highlighted text is available for pasting into other | |
| 3757 applications as well as into Vim itself. When the Visual mode | |
| 3758 ends, possibly due to an operation on the text, or when an | |
| 3759 application wants to paste the selection, the highlighted text | |
| 3760 is automatically yanked into the "* selection register. | |
| 3761 Thus the selection is still available for pasting into other | |
| 3762 applications after the VISUAL mode has ended. | |
| 3763 If not present, then Vim won't become the owner of the | |
| 3764 windowing system's global selection unless explicitly told to | |
| 3765 by a yank or delete operation for the "* register. | |
| 3766 The same applies to the modeless selection. | |
| 3674 | 3767 *'go-P'* |
| 3768 'P' Like autoselect but using the "+ register instead of the "* | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
3769 register. |
| 1152 | 3770 *'go-A'* |
| 10 | 3771 'A' Autoselect for the modeless selection. Like 'a', but only |
| 7 | 3772 applies to the modeless selection. |
| 3773 | |
| 3774 'guioptions' autoselect Visual autoselect modeless ~ | |
| 3775 "" - - | |
| 3776 "a" yes yes | |
| 3777 "A" - yes | |
| 3778 "aA" yes yes | |
| 3779 | |
| 1152 | 3780 *'go-c'* |
| 7 | 3781 'c' Use console dialogs instead of popup dialogs for simple |
| 3782 choices. | |
| 1152 | 3783 *'go-e'* |
| 697 | 3784 'e' Add tab pages when indicated with 'showtabline'. |
| 688 | 3785 'guitablabel' can be used to change the text in the labels. |
| 3786 When 'e' is missing a non-GUI tab pages line may be used. | |
| 857 | 3787 The GUI tabs are only supported on some systems, currently |
| 1621 | 3788 GTK, Motif, Mac OS/X and MS-Windows. |
| 1152 | 3789 *'go-f'* |
| 7 | 3790 'f' Foreground: Don't use fork() to detach the GUI from the shell |
| 3791 where it was started. Use this for programs that wait for the | |
| 3792 editor to finish (e.g., an e-mail program). Alternatively you | |
| 3793 can use "gvim -f" or ":gui -f" to start the GUI in the | |
| 3794 foreground. |gui-fork| | |
| 3795 Note: Set this option in the vimrc file. The forking may have | |
| 819 | 3796 happened already when the |gvimrc| file is read. |
| 1152 | 3797 *'go-i'* |
| 7 | 3798 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper |
| 3799 corner of the window. It's black&white on non-GTK, because of | |
| 3800 limitations of X11. For a color icon, see |X11-icon|. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3801 *'go-m'* |
| 7 | 3802 'm' Menu bar is present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3803 *'go-M'* |
| 10 | 3804 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note |
| 7 | 3805 that this flag must be added in the .vimrc file, before |
| 819 | 3806 switching on syntax or filetype recognition (when the |gvimrc| |
| 7 | 3807 file is sourced the system menu has already been loaded; the |
| 3808 ":syntax on" and ":filetype on" commands load the menu too). | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3809 *'go-g'* |
| 7 | 3810 'g' Grey menu items: Make menu items that are not active grey. If |
| 3811 'g' is not included inactive menu items are not shown at all. | |
| 3812 Exception: Athena will always use grey menu items. | |
| 1152 | 3813 *'go-t'* |
| 7 | 3814 't' Include tearoff menu items. Currently only works for Win32, |
| 3815 GTK+, and Motif 1.2 GUI. | |
| 1152 | 3816 *'go-T'* |
| 236 | 3817 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon |
| 856 | 3818 and Athena GUIs. |
| 1152 | 3819 *'go-r'* |
| 7 | 3820 'r' Right-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3821 *'go-R'* |
| 7 | 3822 'R' Right-hand scrollbar is present when there is a vertically |
| 3823 split window. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3824 *'go-l'* |
| 7 | 3825 'l' Left-hand scrollbar is always present. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3826 *'go-L'* |
| 7 | 3827 'L' Left-hand scrollbar is present when there is a vertically |
| 3828 split window. | |
| 1152 | 3829 *'go-b'* |
| 7 | 3830 'b' Bottom (horizontal) scrollbar is present. Its size depends on |
| 3831 the longest visible line, or on the cursor line if the 'h' | |
| 3832 flag is included. |gui-horiz-scroll| | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3833 *'go-h'* |
| 7 | 3834 'h' Limit horizontal scrollbar size to the length of the cursor |
| 3835 line. Reduces computations. |gui-horiz-scroll| | |
| 3836 | |
| 3837 And yes, you may even have scrollbars on the left AND the right if | |
| 3838 you really want to :-). See |gui-scrollbars| for more information. | |
| 3839 | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3840 *'go-v'* |
| 7 | 3841 'v' Use a vertical button layout for dialogs. When not included, |
| 3842 a horizontal layout is preferred, but when it doesn't fit a | |
| 3843 vertical layout is used anyway. | |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3844 *'go-p'* |
| 7 | 3845 'p' Use Pointer callbacks for X11 GUI. This is required for some |
| 3846 window managers. If the cursor is not blinking or hollow at | |
| 3847 the right moment, try adding this flag. This must be done | |
| 819 | 3848 before starting the GUI. Set it in your |gvimrc|. Adding or |
| 7 | 3849 removing it after the GUI has started has no effect. |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
3850 *'go-F'* |
| 10 | 3851 'F' Add a footer. Only for Motif. See |gui-footer|. |
| 7 | 3852 |
| 1152 | 3853 |
| 7 | 3854 *'guipty'* *'noguipty'* |
| 3855 'guipty' boolean (default on) | |
| 3856 global | |
| 3857 {not in Vi} | |
| 3858 {only available when compiled with GUI enabled} | |
| 3859 Only in the GUI: If on, an attempt is made to open a pseudo-tty for | |
| 3860 I/O to/from shell commands. See |gui-pty|. | |
| 3861 | |
| 688 | 3862 *'guitablabel'* *'gtl'* |
| 3863 'guitablabel' 'gtl' string (default empty) | |
| 3864 global | |
| 3865 {not in Vi} | |
| 692 | 3866 {only available when compiled with GUI enabled and |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3867 with the |+windows| feature} |
| 688 | 3868 When nonempty describes the text to use in a label of the GUI tab |
| 857 | 3869 pages line. When empty and when the result is empty Vim will use a |
| 3870 default label. See |setting-guitablabel| for more info. | |
| 688 | 3871 |
| 692 | 3872 The format of this option is like that of 'statusline'. |
| 839 | 3873 'guitabtooltip' is used for the tooltip, see below. |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
3874 The expression will be evaluated in the |sandbox| when set from a |
|
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
3875 modeline, see |sandbox-option|. |
| 692 | 3876 |
| 688 | 3877 Only used when the GUI tab pages line is displayed. 'e' must be |
| 3878 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is | |
| 3879 used. | |
| 3880 | |
| 839 | 3881 *'guitabtooltip'* *'gtt'* |
| 3882 'guitabtooltip' 'gtt' string (default empty) | |
| 3883 global | |
| 3884 {not in Vi} | |
| 3885 {only available when compiled with GUI enabled and | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3886 with the |+windows| feature} |
| 839 | 3887 When nonempty describes the text to use in a tooltip for the GUI tab |
| 3888 pages line. When empty Vim will use a default tooltip. | |
| 3889 This option is otherwise just like 'guitablabel' above. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3890 You can include a line break. Simplest method is to use |:let|: > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3891 :let &guitabtooltip = "line one\nline two" |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
3892 < |
| 839 | 3893 |
| 7 | 3894 *'helpfile'* *'hf'* |
| 3895 'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt" | |
| 3896 (others) "$VIMRUNTIME/doc/help.txt") | |
| 3897 global | |
| 3898 {not in Vi} | |
| 3899 Name of the main help file. All distributed help files should be | |
| 3900 placed together in one directory. Additionally, all "doc" directories | |
| 3901 in 'runtimepath' will be used. | |
| 3902 Environment variables are expanded |:set_env|. For example: | |
| 3903 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also | |
| 10 | 3904 tried. Also see |$VIMRUNTIME| and |option-backslash| about including |
| 7 | 3905 spaces and backslashes. |
| 3906 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 3907 security reasons. | |
| 3908 | |
| 3909 *'helpheight'* *'hh'* | |
| 3910 'helpheight' 'hh' number (default 20) | |
| 3911 global | |
| 3912 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
3913 {not available when compiled without the |+windows| |
| 7 | 3914 feature} |
| 3915 Minimal initial height of the help window when it is opened with the | |
| 3916 ":help" command. The initial height of the help window is half of the | |
| 3917 current window, or (when the 'ea' option is on) the same as other | |
| 3918 windows. When the height is less than 'helpheight', the height is | |
| 3919 set to 'helpheight'. Set to zero to disable. | |
| 3920 | |
| 3921 *'helplang'* *'hlg'* | |
| 3922 'helplang' 'hlg' string (default: messages language or empty) | |
| 3923 global | |
| 3924 {only available when compiled with the |+multi_lang| | |
| 3925 feature} | |
| 3926 {not in Vi} | |
| 3927 Comma separated list of languages. Vim will use the first language | |
| 3928 for which the desired help can be found. The English help will always | |
| 3929 be used as a last resort. You can add "en" to prefer English over | |
| 3930 another language, but that will only find tags that exist in that | |
| 3931 language and not in the English help. | |
| 3932 Example: > | |
| 3933 :set helplang=de,it | |
| 3934 < This will first search German, then Italian and finally English help | |
| 3935 files. | |
| 3936 When using |CTRL-]| and ":help!" in a non-English help file Vim will | |
| 3937 try to find the tag in the current language before using this option. | |
| 3938 See |help-translated|. | |
| 3939 | |
| 3940 *'hidden'* *'hid'* *'nohidden'* *'nohid'* | |
| 3941 'hidden' 'hid' boolean (default off) | |
| 3942 global | |
| 3943 {not in Vi} | |
| 3944 When off a buffer is unloaded when it is |abandon|ed. When on a | |
| 3945 buffer becomes hidden when it is |abandon|ed. If the buffer is still | |
| 3946 displayed in another window, it does not become hidden, of course. | |
| 3947 The commands that move through the buffer list sometimes make a buffer | |
| 3948 hidden although the 'hidden' option is off: When the buffer is | |
| 3949 modified, 'autowrite' is off or writing is not possible, and the '!' | |
| 10 | 3950 flag was used. See also |windows.txt|. |
| 12 | 3951 To only make one buffer hidden use the 'bufhidden' option. |
| 7 | 3952 This option is set for one command with ":hide {command}" |:hide|. |
| 3953 WARNING: It's easy to forget that you have changes in hidden buffers. | |
| 3954 Think twice when using ":q!" or ":qa!". | |
| 3955 | |
| 3956 *'highlight'* *'hl'* | |
| 3957 'highlight' 'hl' string (default (as a single string): | |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3958 "8:SpecialKey,~:EndOfBuffer,@:NonText, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3959 d:Directory,e:ErrorMsg,i:IncSearch, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3960 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3961 N:CursorLineNr,r:Question,s:StatusLine, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3962 S:StatusLineNC,c:VertSplit,t:Title, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3963 v:Visual,w:WarningMsg,W:WildMenu,f:Folded, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3964 F:FoldColumn,A:DiffAdd,C:DiffChange, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3965 D:DiffDelete,T:DiffText,>:SignColumn, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3966 B:SpellBad,P:SpellCap,R:SpellRare, |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3967 L:SpellLocal,-:Conceal,+:Pmenu,=:PmenuSel, |
| 540 | 3968 x:PmenuSbar,X:PmenuThumb") |
| 7 | 3969 global |
| 3970 {not in Vi} | |
| 3971 This option can be used to set highlighting mode for various | |
| 3972 occasions. It is a comma separated list of character pairs. The | |
| 3973 first character in a pair gives the occasion, the second the mode to | |
| 10 | 3974 use for that occasion. The occasions are: |
| 7 | 3975 |hl-SpecialKey| 8 Meta and special keys listed with ":map" |
|
9877
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3976 |hl-EndOfBuffer| ~ lines after the last line in the buffer |
|
7da89d9c744b
commit https://github.com/vim/vim/commit/58b853460add42098ab08017df9e030fb14fd34b
Christian Brabandt <cb@256bit.org>
parents:
9860
diff
changeset
|
3977 |hl-NonText| @ '@' at the end of the window and |
| 7 | 3978 characters from 'showbreak' |
| 3979 |hl-Directory| d directories in CTRL-D listing and other special | |
| 3980 things in listings | |
| 3981 |hl-ErrorMsg| e error messages | |
| 3982 h (obsolete, ignored) | |
| 3983 |hl-IncSearch| i 'incsearch' highlighting | |
| 3984 |hl-Search| l last search pattern highlighting (see 'hlsearch') | |
| 3985 |hl-MoreMsg| m |more-prompt| | |
| 3986 |hl-ModeMsg| M Mode (e.g., "-- INSERT --") | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3987 |hl-LineNr| n line number for ":number" and ":#" commands, and |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
3988 when 'number' or 'relativenumber' option is set. |
| 4073 | 3989 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is |
| 3990 set. | |
| 7 | 3991 |hl-Question| r |hit-enter| prompt and yes/no questions |
| 3992 |hl-StatusLine| s status line of current window |status-line| | |
| 3993 |hl-StatusLineNC| S status lines of not-current windows | |
| 3994 |hl-Title| t Titles for output from ":set all", ":autocmd" etc. | |
| 3995 |hl-VertSplit| c column used to separate vertically split windows | |
| 3996 |hl-Visual| v Visual mode | |
| 3997 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the | |
| 3998 Selection" Only X11 Gui's |gui-x11| and | |
| 3999 |xterm-clipboard|. | |
| 4000 |hl-WarningMsg| w warning messages | |
| 4001 |hl-WildMenu| W wildcard matches displayed for 'wildmenu' | |
| 4002 |hl-Folded| f line used for closed folds | |
| 4003 |hl-FoldColumn| F 'foldcolumn' | |
| 386 | 4004 |hl-DiffAdd| A added line in diff mode |
| 4005 |hl-DiffChange| C changed line in diff mode | |
| 4006 |hl-DiffDelete| D deleted line in diff mode | |
| 4007 |hl-DiffText| T inserted text in diff mode | |
| 7 | 4008 |hl-SignColumn| > column used for |signs| |
| 221 | 4009 |hl-SpellBad| B misspelled word |spell| |
|
2337
a0f87fc19d1d
Better conceal in help. (partly by Dominique Pelle)
Bram Moolenaar <bram@vim.org>
parents:
2324
diff
changeset
|
4010 |hl-SpellCap| P word that should start with capital |spell| |
| 221 | 4011 |hl-SpellRare| R rare word |spell| |
| 4012 |hl-SpellLocal| L word from other region |spell| | |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4013 |hl-Conceal| - the placeholders used for concealed characters |
|
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4014 (see 'conceallevel') |
| 540 | 4015 |hl-Pmenu| + popup menu normal line |
| 4016 |hl-PmenuSel| = popup menu normal line | |
| 4017 |hl-PmenuSbar| x popup menu scrollbar | |
| 4018 |hl-PmenuThumb| X popup menu scrollbar thumb | |
| 7 | 4019 |
| 4020 The display modes are: | |
| 4021 r reverse (termcap entry "mr" and "me") | |
| 4022 i italic (termcap entry "ZH" and "ZR") | |
| 4023 b bold (termcap entry "md" and "me") | |
| 4024 s standout (termcap entry "so" and "se") | |
| 4025 u underline (termcap entry "us" and "ue") | |
| 205 | 4026 c undercurl (termcap entry "Cs" and "Ce") |
| 7 | 4027 n no highlighting |
| 4028 - no highlighting | |
| 4029 : use a highlight group | |
| 4030 The default is used for occasions that are not included. | |
| 4031 If you want to change what the display modes do, see |dos-colors| | |
| 4032 for an example. | |
| 4033 When using the ':' display mode, this must be followed by the name of | |
| 4034 a highlight group. A highlight group can be used to define any type | |
| 4035 of highlighting, including using color. See |:highlight| on how to | |
| 4036 define one. The default uses a different group for each occasion. | |
| 4037 See |highlight-default| for the default highlight groups. | |
| 4038 | |
| 4039 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'* | |
| 4040 'hlsearch' 'hls' boolean (default off) | |
| 4041 global | |
| 4042 {not in Vi} | |
| 4043 {not available when compiled without the | |
| 4044 |+extra_search| feature} | |
| 4045 When there is a previous search pattern, highlight all its matches. | |
| 4046 The type of highlighting used can be set with the 'l' occasion in the | |
| 4047 'highlight' option. This uses the "Search" highlight group by | |
| 4048 default. Note that only the matching text is highlighted, any offsets | |
| 4049 are not applied. | |
| 4050 See also: 'incsearch' and |:match|. | |
| 4051 When you get bored looking at the highlighted matches, you can turn it | |
| 3224 | 4052 off with |:nohlsearch|. This does not change the option value, as |
| 4053 soon as you use a search command, the highlighting comes back. | |
| 1621 | 4054 'redrawtime' specifies the maximum time spent on finding matches. |
| 7 | 4055 When the search pattern can match an end-of-line, Vim will try to |
| 4056 highlight all of the matched text. However, this depends on where the | |
| 10 | 4057 search starts. This will be the first line in the window or the first |
| 7 | 4058 line below a closed fold. A match in a previous line which is not |
| 819 | 4059 drawn may not continue in a newly drawn line. |
| 3224 | 4060 You can specify whether the highlight status is restored on startup |
| 4061 with the 'h' flag in 'viminfo' |viminfo-h|. | |
| 7 | 4062 NOTE: This option is reset when 'compatible' is set. |
| 4063 | |
| 4064 *'history'* *'hi'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4065 'history' 'hi' number (Vim default: 50, Vi default: 0, |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4066 set to 200 in |defaults.vim|) |
| 7 | 4067 global |
| 4068 {not in Vi} | |
| 4069 A history of ":" commands, and a history of previous search patterns | |
| 5991 | 4070 is remembered. This option decides how many entries may be stored in |
| 7 | 4071 each of these histories (see |cmdline-editing|). |
| 5991 | 4072 The maximum value is 10000. |
| 7 | 4073 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4074 set and to the Vim default value when 'compatible' is reset. | |
| 4075 | |
| 4076 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'* | |
| 4077 'hkmap' 'hk' boolean (default off) | |
| 4078 global | |
| 4079 {not in Vi} | |
| 4080 {only available when compiled with the |+rightleft| | |
| 4081 feature} | |
| 4082 When on, the keyboard is mapped for the Hebrew character set. | |
| 4083 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to | |
| 4084 toggle this option. See |rileft.txt|. | |
| 4085 NOTE: This option is reset when 'compatible' is set. | |
| 4086 | |
| 4087 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'* | |
| 4088 'hkmapp' 'hkp' boolean (default off) | |
| 4089 global | |
| 4090 {not in Vi} | |
| 4091 {only available when compiled with the |+rightleft| | |
| 4092 feature} | |
| 4093 When on, phonetic keyboard mapping is used. 'hkmap' must also be on. | |
| 4094 This is useful if you have a non-Hebrew keyboard. | |
| 4095 See |rileft.txt|. | |
| 4096 NOTE: This option is reset when 'compatible' is set. | |
| 4097 | |
| 4098 *'icon'* *'noicon'* | |
| 4099 'icon' boolean (default off, on when title can be restored) | |
| 4100 global | |
| 4101 {not in Vi} | |
| 4102 {not available when compiled without the |+title| | |
| 4103 feature} | |
| 4104 When on, the icon text of the window will be set to the value of | |
| 4105 'iconstring' (if it is not empty), or to the name of the file | |
| 4106 currently being edited. Only the last part of the name is used. | |
| 4107 Overridden by the 'iconstring' option. | |
| 4108 Only works if the terminal supports setting window icons (currently | |
| 4109 only X11 GUI and terminals with a non-empty 't_IS' option - these are | |
| 4110 Unix xterm and iris-ansi by default, where 't_IS' is taken from the | |
| 4111 builtin termcap). | |
| 4112 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
| 233 | 4113 restored if possible |X11|. See |X11-icon| for changing the icon on |
| 7 | 4114 X11. |
| 6259 | 4115 For MS-Windows the icon can be changed, see |windows-icon|. |
| 7 | 4116 |
| 4117 *'iconstring'* | |
| 4118 'iconstring' string (default "") | |
| 4119 global | |
| 4120 {not in Vi} | |
| 4121 {not available when compiled without the |+title| | |
| 4122 feature} | |
| 4123 When this option is not empty, it will be used for the icon text of | |
| 4124 the window. This happens only when the 'icon' option is on. | |
| 4125 Only works if the terminal supports setting window icon text | |
| 4126 (currently only X11 GUI and terminals with a non-empty 't_IS' option). | |
| 4127 Does not work for MS Windows. | |
| 4128 When Vim was compiled with HAVE_X11 defined, the original icon will be | |
| 4129 restored if possible |X11|. | |
| 4130 When this option contains printf-style '%' items, they will be | |
| 10 | 4131 expanded according to the rules used for 'statusline'. See |
| 7 | 4132 'titlestring' for example settings. |
| 4133 {not available when compiled without the |+statusline| feature} | |
| 4134 | |
| 4135 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'* | |
| 4136 'ignorecase' 'ic' boolean (default off) | |
| 4137 global | |
| 4138 Ignore case in search patterns. Also used when searching in the tags | |
| 4139 file. | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
4140 Also see 'smartcase' and 'tagcase'. |
| 7 | 4141 Can be overruled by using "\c" or "\C" in the pattern, see |
| 4142 |/ignorecase|. | |
| 4143 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4144 *'imactivatefunc'* *'imaf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4145 'imactivatefunc' 'imaf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4146 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4147 {not in Vi} |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4148 {only available when compiled with |+xim| and |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4149 |+GUI_GTK|} |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4150 This option specifies a function that will be called to |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4151 activate/inactivate Input Method. |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4152 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4153 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4154 function ImActivateFunc(active) |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4155 if a:active |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4156 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4157 else |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4158 ... do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4159 endif |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4160 " return value is not used |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4161 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4162 set imactivatefunc=ImActivateFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4163 < |
| 7 | 4164 *'imactivatekey'* *'imak'* |
| 4165 'imactivatekey' 'imak' string (default "") | |
| 4166 global | |
| 4167 {not in Vi} | |
| 4168 {only available when compiled with |+xim| and | |
|
2209
d0ddf7ba1630
Included the patch to support netbeans in a terminal.
Bram Moolenaar <bram@vim.org>
parents:
2207
diff
changeset
|
4169 |+GUI_GTK|} *E599* |
| 7 | 4170 Specifies the key that your Input Method in X-Windows uses for |
| 4171 activation. When this is specified correctly, vim can fully control | |
| 4172 IM with 'imcmdline', 'iminsert' and 'imsearch'. | |
| 4173 You can't use this option to change the activation key, the option | |
| 4174 tells Vim what the key is. | |
| 4175 Format: | |
| 4176 [MODIFIER_FLAG-]KEY_STRING | |
| 4177 | |
| 4178 These characters can be used for MODIFIER_FLAG (case is ignored): | |
| 4179 S Shift key | |
| 4180 L Lock key | |
| 4181 C Control key | |
| 4182 1 Mod1 key | |
| 4183 2 Mod2 key | |
| 4184 3 Mod3 key | |
| 4185 4 Mod4 key | |
| 4186 5 Mod5 key | |
| 4187 Combinations are allowed, for example "S-C-space" or "SC-space" are | |
| 4188 both shift+ctrl+space. | |
| 4189 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING. | |
| 4190 | |
| 4191 Example: > | |
| 4192 :set imactivatekey=S-space | |
| 4193 < "S-space" means shift+space. This is the activation key for kinput2 + | |
| 4194 canna (Japanese), and ami (Korean). | |
| 4195 | |
| 4196 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'* | |
| 4197 'imcmdline' 'imc' boolean (default off) | |
| 4198 global | |
| 4199 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4200 {only available when compiled with the |+xim|, |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4201 |+multi_byte_ime| or |global-ime| features} |
| 7 | 4202 When set the Input Method is always on when starting to edit a command |
| 4203 line, unless entering a search pattern (see 'imsearch' for that). | |
| 4204 Setting this option is useful when your input method allows entering | |
| 4205 English characters directly, e.g., when it's used to type accented | |
| 4206 characters with dead keys. | |
| 4207 | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4208 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'* |
| 7 | 4209 'imdisable' 'imd' boolean (default off, on for some systems (SGI)) |
| 4210 global | |
| 4211 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4212 {only available when compiled with the |+xim|, |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4213 |+multi_byte_ime| or |global-ime| features} |
| 7 | 4214 When set the Input Method is never used. This is useful to disable |
| 4215 the IM when it doesn't work properly. | |
| 4216 Currently this option is on by default for SGI/IRIX machines. This | |
| 4217 may change in later releases. | |
| 4218 | |
| 4219 *'iminsert'* *'imi'* | |
| 4220 'iminsert' 'imi' number (default 0, 2 when an input method is supported) | |
| 4221 local to buffer | |
| 4222 {not in Vi} | |
| 4223 Specifies whether :lmap or an Input Method (IM) is to be used in | |
| 4224 Insert mode. Valid values: | |
| 4225 0 :lmap is off and IM is off | |
| 4226 1 :lmap is ON and IM is off | |
| 4227 2 :lmap is off and IM is ON | |
| 4228 2 is available only when compiled with the |+multi_byte_ime|, |+xim| | |
| 4229 or |global-ime|. | |
| 4230 To always reset the option to zero when leaving Insert mode with <Esc> | |
| 4231 this can be used: > | |
| 4232 :inoremap <ESC> <ESC>:set iminsert=0<CR> | |
| 4233 < This makes :lmap and IM turn off automatically when leaving Insert | |
| 4234 mode. | |
| 4235 Note that this option changes when using CTRL-^ in Insert mode | |
| 4236 |i_CTRL-^|. | |
| 4237 The value is set to 1 when setting 'keymap' to a valid keymap name. | |
| 4238 It is also used for the argument of commands like "r" and "f". | |
| 4239 The value 0 may not work correctly with Athena and Motif with some XIM | |
| 4240 methods. Use 'imdisable' to disable XIM then. | |
| 4241 | |
| 4242 *'imsearch'* *'ims'* | |
| 4243 'imsearch' 'ims' number (default 0, 2 when an input method is supported) | |
| 4244 local to buffer | |
| 4245 {not in Vi} | |
| 4246 Specifies whether :lmap or an Input Method (IM) is to be used when | |
| 4247 entering a search pattern. Valid values: | |
| 4248 -1 the value of 'iminsert' is used, makes it look like | |
| 4249 'iminsert' is also used when typing a search pattern | |
| 4250 0 :lmap is off and IM is off | |
| 4251 1 :lmap is ON and IM is off | |
| 4252 2 :lmap is off and IM is ON | |
| 4253 Note that this option changes when using CTRL-^ in Command-line mode | |
| 4254 |c_CTRL-^|. | |
| 4255 The value is set to 1 when it is not -1 and setting the 'keymap' | |
| 4256 option to a valid keymap name. | |
| 4257 The value 0 may not work correctly with Athena and Motif with some XIM | |
| 4258 methods. Use 'imdisable' to disable XIM then. | |
| 4259 | |
|
5008
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4260 *'imstatusfunc'* *'imsf'* |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4261 'imstatusfunc' 'imsf' string (default "") |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4262 global |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4263 {not in Vi} |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4264 {only available when compiled with |+xim| and |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4265 |+GUI_GTK|} |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4266 This option specifies a function that is called to obtain the status |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4267 of Input Method. It must return a positive number when IME is active. |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4268 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4269 Example: > |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4270 function ImStatusFunc() |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4271 let is_active = ...do something |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4272 return is_active ? 1 : 0 |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4273 endfunction |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4274 set imstatusfunc=ImStatusFunc |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4275 < |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4276 NOTE: This function is invoked very often. Keep it fast. |
|
3717d569027d
updated for version 7.3.1248
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
4277 |
| 7 | 4278 *'include'* *'inc'* |
| 4279 'include' 'inc' string (default "^\s*#\s*include") | |
| 4280 global or local to buffer |global-local| | |
| 4281 {not in Vi} | |
| 4282 {not available when compiled without the | |
| 4283 |+find_in_path| feature} | |
| 10 | 4284 Pattern to be used to find an include command. It is a search |
| 7 | 4285 pattern, just like for the "/" command (See |pattern|). The default |
| 4286 value is for C programs. This option is used for the commands "[i", | |
| 532 | 4287 "]I", "[d", etc. |
| 4288 Normally the 'isfname' option is used to recognize the file name that | |
| 534 | 4289 comes after the matched pattern. But if "\zs" appears in the pattern |
| 4290 then the text matched from "\zs" to the end, or until "\ze" if it | |
| 4291 appears, is used as the file name. Use this to include characters | |
| 4292 that are not in 'isfname', such as a space. You can then use | |
| 4293 'includeexpr' to process the matched text. | |
| 532 | 4294 See |option-backslash| about including spaces and backslashes. |
| 7 | 4295 |
| 4296 *'includeexpr'* *'inex'* | |
| 4297 'includeexpr' 'inex' string (default "") | |
| 4298 local to buffer | |
| 4299 {not in Vi} | |
| 4300 {not available when compiled without the | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4301 |+find_in_path| or |+eval| features} |
| 7 | 4302 Expression to be used to transform the string found with the 'include' |
| 10 | 4303 option to a file name. Mostly useful to change "." to "/" for Java: > |
| 7 | 4304 :set includeexpr=substitute(v:fname,'\\.','/','g') |
| 4305 < The "v:fname" variable will be set to the file name that was detected. | |
| 634 | 4306 |
| 7 | 4307 Also used for the |gf| command if an unmodified file name can't be |
| 10 | 4308 found. Allows doing "gf" on the name after an 'include' statement. |
| 7 | 4309 Also used for |<cfile>|. |
| 4310 | |
| 3682 | 4311 The expression will be evaluated in the |sandbox| when set from a |
| 4312 modeline, see |sandbox-option|. | |
| 634 | 4313 |
| 4314 It is not allowed to change text or jump to another window while | |
| 4315 evaluating 'includeexpr' |textlock|. | |
| 4316 | |
| 7 | 4317 *'incsearch'* *'is'* *'noincsearch'* *'nois'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4318 'incsearch' 'is' boolean (default off, set in |defaults.vim| if the |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4319 +reltime feature is supported) |
| 7 | 4320 global |
| 4321 {not in Vi} | |
| 4322 {not available when compiled without the | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4323 |+extra_search| features} |
| 17 | 4324 While typing a search command, show where the pattern, as it was typed |
| 4325 so far, matches. The matched string is highlighted. If the pattern | |
| 4326 is invalid or not found, nothing is shown. The screen will be updated | |
| 4327 often, this is only useful on fast terminals. | |
| 4328 Note that the match will be shown, but the cursor will return to its | |
| 4329 original position when no match is found and when pressing <Esc>. You | |
| 4330 still need to finish the search command with <Enter> to move the | |
| 4331 cursor to the match. | |
|
10261
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4332 You can use the CTRL-G and CTRL-T keys to move to the next and |
|
bdd7fc1a38c0
commit https://github.com/vim/vim/commit/dc08328821a2c11e33dfb1980332e4923ec64fca
Christian Brabandt <cb@256bit.org>
parents:
10244
diff
changeset
|
4333 previous match. |c_CTRL-G| |c_CTRL-T| |
| 1521 | 4334 When compiled with the |+reltime| feature Vim only searches for about |
| 4335 half a second. With a complicated pattern and/or a lot of text the | |
| 4336 match may not be found. This is to avoid that Vim hangs while you | |
| 4337 are typing the pattern. | |
| 17 | 4338 The highlighting can be set with the 'i' flag in 'highlight'. |
| 4339 See also: 'hlsearch'. | |
| 772 | 4340 CTRL-L can be used to add one character from after the current match |
|
2302
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4341 to the command line. If 'ignorecase' and 'smartcase' are set and the |
|
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4342 command line has no uppercase characters, the added character is |
|
488be8cbe19c
Make CTRL-L in command line mode respect 'ignorecase' and 'smartcase'. (Martin
Bram Moolenaar <bram@vim.org>
parents:
2301
diff
changeset
|
4343 converted to lowercase. |
| 772 | 4344 CTRL-R CTRL-W can be used to add the word at the end of the current |
| 4345 match, excluding the characters that were already typed. | |
| 7 | 4346 NOTE: This option is reset when 'compatible' is set. |
| 4347 | |
| 4348 *'indentexpr'* *'inde'* | |
| 4349 'indentexpr' 'inde' string (default "") | |
| 4350 local to buffer | |
| 4351 {not in Vi} | |
| 4352 {not available when compiled without the |+cindent| | |
| 4353 or |+eval| features} | |
| 4354 Expression which is evaluated to obtain the proper indent for a line. | |
| 4355 It is used when a new line is created, for the |=| operator and | |
| 4356 in Insert mode as specified with the 'indentkeys' option. | |
| 4357 When this option is not empty, it overrules the 'cindent' and | |
| 2833 | 4358 'smartindent' indenting. When 'lisp' is set, this option is |
| 4359 overridden by the Lisp indentation algorithm. | |
| 7 | 4360 When 'paste' is set this option is not used for indenting. |
| 4361 The expression is evaluated with |v:lnum| set to the line number for | |
| 534 | 4362 which the indent is to be computed. The cursor is also in this line |
| 7 | 4363 when the expression is evaluated (but it may be moved around). |
| 4364 The expression must return the number of spaces worth of indent. It | |
| 4365 can return "-1" to keep the current indent (this means 'autoindent' is | |
| 4366 used for the indent). | |
| 4367 Functions useful for computing the indent are |indent()|, |cindent()| | |
| 4368 and |lispindent()|. | |
| 4369 The evaluation of the expression must not have side effects! It must | |
| 4370 not change the text, jump to another window, etc. Afterwards the | |
| 4371 cursor position is always restored, thus the cursor may be moved. | |
| 4372 Normally this option would be set to call a function: > | |
| 4373 :set indentexpr=GetMyIndent() | |
| 4374 < Error messages will be suppressed, unless the 'debug' option contains | |
| 4375 "msg". | |
| 634 | 4376 See |indent-expression|. |
| 7 | 4377 NOTE: This option is made empty when 'compatible' is set. |
| 4378 | |
| 3682 | 4379 The expression will be evaluated in the |sandbox| when set from a |
| 4380 modeline, see |sandbox-option|. | |
| 634 | 4381 |
| 4382 It is not allowed to change text or jump to another window while | |
| 4383 evaluating 'indentexpr' |textlock|. | |
| 4384 | |
| 4385 | |
| 7 | 4386 *'indentkeys'* *'indk'* |
| 4387 'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e") | |
| 4388 local to buffer | |
| 4389 {not in Vi} | |
| 4390 {not available when compiled without the |+cindent| | |
| 4391 feature} | |
| 4392 A list of keys that, when typed in Insert mode, cause reindenting of | |
| 4393 the current line. Only happens if 'indentexpr' isn't empty. | |
| 4394 The format is identical to 'cinkeys', see |indentkeys-format|. | |
| 4395 See |C-indenting| and |indent-expression|. | |
| 4396 | |
| 4397 *'infercase'* *'inf'* *'noinfercase'* *'noinf'* | |
| 4398 'infercase' 'inf' boolean (default off) | |
| 4399 local to buffer | |
| 4400 {not in Vi} | |
| 4401 When doing keyword completion in insert mode |ins-completion|, and | |
| 1621 | 4402 'ignorecase' is also on, the case of the match is adjusted depending |
| 4403 on the typed text. If the typed text contains a lowercase letter | |
| 4404 where the match has an upper case letter, the completed part is made | |
| 4405 lowercase. If the typed text has no lowercase letters and the match | |
| 4406 has a lowercase letter where the typed text has an uppercase letter, | |
| 4407 and there is a letter before it, the completed part is made uppercase. | |
| 4408 With 'noinfercase' the match is used as-is. | |
| 7 | 4409 |
| 4410 *'insertmode'* *'im'* *'noinsertmode'* *'noim'* | |
| 4411 'insertmode' 'im' boolean (default off) | |
| 4412 global | |
| 4413 {not in Vi} | |
| 4414 Makes Vim work in a way that Insert mode is the default mode. Useful | |
| 4415 if you want to use Vim as a modeless editor. Used for |evim|. | |
| 4416 These Insert mode commands will be useful: | |
| 4417 - Use the cursor keys to move around. | |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4418 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When |
| 7 | 4419 this is a mapping, it is executed as if 'insertmode' was off. |
| 4420 Normal mode remains active until the mapping is finished. | |
| 4421 - Use CTRL-L to execute a number of Normal mode commands, then use | |
| 477 | 4422 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor |
| 4423 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L| | |
| 7 | 4424 |
| 4425 These items change when 'insertmode' is set: | |
| 4426 - when starting to edit of a file, Vim goes to Insert mode. | |
| 4427 - <Esc> in Insert mode is a no-op and beeps. | |
| 4428 - <Esc> in Normal mode makes Vim go to Insert mode. | |
| 4429 - CTRL-L in Insert mode is a command, it is not inserted. | |
| 4430 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z* | |
| 4431 However, when <Esc> is used inside a mapping, it behaves like | |
| 4432 'insertmode' was not set. This was done to be able to use the same | |
| 4433 mappings with 'insertmode' set or not set. | |
| 4434 When executing commands with |:normal| 'insertmode' is not used. | |
| 4435 | |
| 4436 NOTE: This option is reset when 'compatible' is set. | |
| 4437 | |
| 4438 *'isfname'* *'isf'* | |
| 4439 'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2: | |
| 4440 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" | |
| 4441 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" | |
| 4442 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" | |
| 4443 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" | |
| 4444 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") | |
| 4445 global | |
| 4446 {not in Vi} | |
| 4447 The characters specified by this option are included in file names and | |
| 4448 path names. Filenames are used for commands like "gf", "[i" and in | |
| 10 | 4449 the tags file. It is also used for "\f" in a |pattern|. |
| 7 | 4450 Multi-byte characters 256 and above are always included, only the |
| 4451 characters up to 255 are specified with this option. | |
| 4452 For UTF-8 the characters 0xa0 to 0xff are included as well. | |
| 1621 | 4453 Think twice before adding white space to this option. Although a |
| 4454 space may appear inside a file name, the effect will be that Vim | |
| 4455 doesn't know where a file name starts or ends when doing completion. | |
| 4456 It most likely works better without a space in 'isfname'. | |
| 7 | 4457 |
| 4458 Note that on systems using a backslash as path separator, Vim tries to | |
| 4459 do its best to make it work as you would expect. That is a bit | |
| 4460 tricky, since Vi originally used the backslash to escape special | |
| 4461 characters. Vim will not remove a backslash in front of a normal file | |
| 4462 name character on these systems, but it will on Unix and alikes. The | |
| 4463 '&' and '^' are not included by default, because these are special for | |
| 4464 cmd.exe. | |
| 4465 | |
| 4466 The format of this option is a list of parts, separated with commas. | |
| 10 | 4467 Each part can be a single character number or a range. A range is two |
| 4468 character numbers with '-' in between. A character number can be a | |
| 7 | 4469 decimal number between 0 and 255 or the ASCII character itself (does |
| 4470 not work for digits). Example: | |
| 4471 "_,-,128-140,#-43" (include '_' and '-' and the range | |
| 4472 128 to 140 and '#' to 43) | |
| 4473 If a part starts with '^', the following character number or range | |
| 4474 will be excluded from the option. The option is interpreted from left | |
| 4475 to right. Put the excluded character after the range where it is | |
| 4476 included. To include '^' itself use it as the last character of the | |
| 4477 option or the end of a range. Example: | |
| 4478 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^') | |
| 4479 If the character is '@', all characters where isalpha() returns TRUE | |
| 4480 are included. Normally these are the characters a to z and A to Z, | |
| 4481 plus accented characters. To include '@' itself use "@-@". Examples: | |
| 4482 "@,^a-z" All alphabetic characters, excluding lower | |
| 1621 | 4483 case ASCII letters. |
| 7 | 4484 "a-z,A-Z,@-@" All letters plus the '@' character. |
| 4485 A comma can be included by using it where a character number is | |
| 4486 expected. Example: | |
| 4487 "48-57,,,_" Digits, comma and underscore. | |
| 4488 A comma can be excluded by prepending a '^'. Example: | |
| 4489 " -~,^,,9" All characters from space to '~', excluding | |
| 4490 comma, plus <Tab>. | |
| 4491 See |option-backslash| about including spaces and backslashes. | |
| 4492 | |
| 4493 *'isident'* *'isi'* | |
| 4494 'isident' 'isi' string (default for MS-DOS, Win32 and OS/2: | |
| 4495 "@,48-57,_,128-167,224-235" | |
| 4496 otherwise: "@,48-57,_,192-255") | |
| 4497 global | |
| 4498 {not in Vi} | |
| 4499 The characters given by this option are included in identifiers. | |
| 4500 Identifiers are used in recognizing environment variables and after a | |
| 4501 match of the 'define' option. It is also used for "\i" in a | |
| 233 | 4502 |pattern|. See 'isfname' for a description of the format of this |
| 7 | 4503 option. |
| 4504 Careful: If you change this option, it might break expanding | |
| 10 | 4505 environment variables. E.g., when '/' is included and Vim tries to |
| 7 | 4506 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead. |
| 4507 | |
| 4508 *'iskeyword'* *'isk'* | |
| 4509 'iskeyword' 'isk' string (Vim default for MS-DOS and Win32: | |
| 4510 "@,48-57,_,128-167,224-235" | |
| 4511 otherwise: "@,48-57,_,192-255" | |
| 4512 Vi default: "@,48-57,_") | |
| 4513 local to buffer | |
| 4514 {not in Vi} | |
| 4515 Keywords are used in searching and recognizing with many commands: | |
| 10 | 4516 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See |
| 7 | 4517 'isfname' for a description of the format of this option. For C |
| 4518 programs you could use "a-z,A-Z,48-57,_,.,-,>". | |
| 4519 For a help file it is set to all non-blank printable characters except | |
| 4520 '*', '"' and '|' (so that CTRL-] on a command finds the help for that | |
| 4521 command). | |
| 4522 When the 'lisp' option is on the '-' character is always included. | |
|
7687
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7538
diff
changeset
|
4523 This option also influences syntax highlighting, unless the syntax |
|
61354fabf8a2
commit https://github.com/vim/vim/commit/b8060fe862f684b591f9ac679eac5b2594d6c5a0
Christian Brabandt <cb@256bit.org>
parents:
7538
diff
changeset
|
4524 uses |:syn-iskeyword|. |
| 7 | 4525 NOTE: This option is set to the Vi default value when 'compatible' is |
| 4526 set and to the Vim default value when 'compatible' is reset. | |
| 4527 | |
| 4528 *'isprint'* *'isp'* | |
| 4529 'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh: | |
| 4530 "@,~-255"; otherwise: "@,161-255") | |
| 4531 global | |
| 4532 {not in Vi} | |
| 4533 The characters given by this option are displayed directly on the | |
| 4534 screen. It is also used for "\p" in a |pattern|. The characters from | |
| 4535 space (ASCII 32) to '~' (ASCII 126) are always displayed directly, | |
| 4536 even when they are not included in 'isprint' or excluded. See | |
| 4537 'isfname' for a description of the format of this option. | |
| 4538 | |
| 4539 Non-printable characters are displayed with two characters: | |
| 4540 0 - 31 "^@" - "^_" | |
| 4541 32 - 126 always single characters | |
| 4542 127 "^?" | |
| 4543 128 - 159 "~@" - "~_" | |
| 4544 160 - 254 "| " - "|~" | |
| 4545 255 "~?" | |
| 4546 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are | |
| 4547 displayed as <xx>, with the hexadecimal value of the byte. | |
| 4548 When 'display' contains "uhex" all unprintable characters are | |
| 4549 displayed as <xx>. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4550 The SpecialKey highlighting will be used for unprintable characters. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4551 |hl-SpecialKey| |
| 7 | 4552 |
| 4553 Multi-byte characters 256 and above are always included, only the | |
| 4554 characters up to 255 are specified with this option. When a character | |
| 4555 is printable but it is not available in the current font, a | |
| 4556 replacement character will be shown. | |
| 4557 Unprintable and zero-width Unicode characters are displayed as <xxxx>. | |
| 4558 There is no option to specify these characters. | |
| 4559 | |
| 4560 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'* | |
| 4561 'joinspaces' 'js' boolean (default on) | |
| 4562 global | |
| 4563 {not in Vi} | |
| 4564 Insert two spaces after a '.', '?' and '!' with a join command. | |
| 4565 When 'cpoptions' includes the 'j' flag, only do this after a '.'. | |
| 4566 Otherwise only one space is inserted. | |
| 4567 NOTE: This option is set when 'compatible' is set. | |
| 4568 | |
| 4569 *'key'* | |
| 4570 'key' string (default "") | |
| 4571 local to buffer | |
| 4572 {not in Vi} | |
|
2283
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4573 {only available when compiled with the |+cryptv| |
|
7e1bd501306d
Mainly documentation updates.
Bram Moolenaar <bram@vim.org>
parents:
2265
diff
changeset
|
4574 feature} |
| 7 | 4575 The key that is used for encrypting and decrypting the current buffer. |
|
2180
f60a0c9cbe6c
Add the blowfish encryption patch from Mohsin Ahmed. Needs more work.
Bram Moolenaar <bram@vim.org>
parents:
2178
diff
changeset
|
4576 See |encryption| and 'cryptmethod'. |
| 7 | 4577 Careful: Do not set the key value by hand, someone might see the typed |
| 4578 key. Use the |:X| command. But you can make 'key' empty: > | |
| 4579 :set key= | |
| 4580 < It is not possible to get the value of this option with ":set key" or | |
| 4581 "echo &key". This is to avoid showing it to someone who shouldn't | |
| 4582 know. It also means you cannot see it yourself once you have set it, | |
| 4583 be careful not to make a typing error! | |
|
2698
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4584 You can use "&key" in an expression to detect whether encryption is |
|
b6471224d2af
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
2681
diff
changeset
|
4585 enabled. When 'key' is set it returns "*****" (five stars). |
| 7 | 4586 |
| 4587 *'keymap'* *'kmp'* *E544* | |
| 4588 'keymap' 'kmp' string (default "") | |
| 4589 local to buffer | |
| 4590 {not in Vi} | |
| 4591 {only available when compiled with the |+keymap| | |
| 4592 feature} | |
| 4593 Name of a keyboard mapping. See |mbyte-keymap|. | |
| 4594 Setting this option to a valid keymap name has the side effect of | |
| 4595 setting 'iminsert' to one, so that the keymap becomes effective. | |
| 4596 'imsearch' is also set to one, unless it was -1 | |
| 36 | 4597 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4598 |
| 4599 *'keymodel'* *'km'* | |
| 4600 'keymodel' 'km' string (default "") | |
| 4601 global | |
| 4602 {not in Vi} | |
| 4603 List of comma separated words, which enable special things that keys | |
| 4604 can do. These values can be used: | |
| 4605 startsel Using a shifted special key starts selection (either | |
| 4606 Select mode or Visual mode, depending on "key" being | |
| 4607 present in 'selectmode'). | |
| 4608 stopsel Using a not-shifted special key stops selection. | |
| 4609 Special keys in this context are the cursor keys, <End>, <Home>, | |
| 4610 <PageUp> and <PageDown>. | |
| 4611 The 'keymodel' option is set by the |:behave| command. | |
| 4612 | |
| 4613 *'keywordprg'* *'kp'* | |
| 4614 'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help", | |
|
9098
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4615 VMS: "help") |
| 7 | 4616 global or local to buffer |global-local| |
| 4617 {not in Vi} | |
| 4618 Program to use for the |K| command. Environment variables are | |
| 4619 expanded |:set_env|. ":help" may be used to access the Vim internal | |
| 4620 help. (Note that previously setting the global option to the empty | |
| 4621 value did this, which is now deprecated.) | |
|
9098
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4622 When the first character is ":", the command is invoked as a Vim |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4623 Ex command prefixed with [count]. |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4624 When "man", "man -s" or an Ex command is used, Vim will automatically |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4625 translate a count for the "K" command and pass it as the first |
|
0d52ddff8db4
commit https://github.com/vim/vim/commit/2ff8b64679242e73248774a388d54931c9ce49bd
Christian Brabandt <cb@256bit.org>
parents:
9097
diff
changeset
|
4626 argument. For "man -s" the "-s" is removed when there is no count. |
| 7 | 4627 See |option-backslash| about including spaces and backslashes. |
| 4628 Example: > | |
| 4629 :set keywordprg=man\ -s | |
| 4630 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4631 security reasons. | |
| 4632 | |
| 4633 *'langmap'* *'lmap'* *E357* *E358* | |
| 4634 'langmap' 'lmap' string (default "") | |
| 4635 global | |
| 4636 {not in Vi} | |
| 4637 {only available when compiled with the |+langmap| | |
| 4638 feature} | |
| 4639 This option allows switching your keyboard into a special language | |
| 10 | 4640 mode. When you are typing text in Insert mode the characters are |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
4641 inserted directly. When in Normal mode the 'langmap' option takes |
| 7 | 4642 care of translating these special characters to the original meaning |
| 4643 of the key. This means you don't have to change the keyboard mode to | |
| 4644 be able to execute Normal mode commands. | |
| 4645 This is the opposite of the 'keymap' option, where characters are | |
| 4646 mapped in Insert mode. | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4647 Also consider resetting 'langremap' to avoid 'langmap' applies to |
| 6369 | 4648 characters resulting from a mapping. |
| 5908 | 4649 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 4650 security reasons. | |
| 7 | 4651 |
| 699 | 4652 Example (for Greek, in UTF-8): *greek* > |
| 4653 :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 | |
| 7 | 4654 < Example (exchanges meaning of z and y for commands): > |
| 4655 :set langmap=zy,yz,ZY,YZ | |
| 4656 < | |
| 4657 The 'langmap' option is a list of parts, separated with commas. Each | |
| 4658 part can be in one of two forms: | |
| 4659 1. A list of pairs. Each pair is a "from" character immediately | |
| 4660 followed by the "to" character. Examples: "aA", "aAbBcC". | |
| 4661 2. A list of "from" characters, a semi-colon and a list of "to" | |
| 4662 characters. Example: "abc;ABC" | |
| 4663 Example: "aA,fgh;FGH,cCdDeE" | |
| 4664 Special characters need to be preceded with a backslash. These are | |
| 4665 ";", ',' and backslash itself. | |
| 4666 | |
| 4667 This will allow you to activate vim actions without having to switch | |
| 4668 back and forth between the languages. Your language characters will | |
| 4669 be understood as normal vim English characters (according to the | |
| 4670 langmap mappings) in the following cases: | |
| 4671 o Normal/Visual mode (commands, buffer/register names, user mappings) | |
| 4672 o Insert/Replace Mode: Register names after CTRL-R | |
| 4673 o Insert/Replace Mode: Mappings | |
| 4674 Characters entered in Command-line mode will NOT be affected by | |
| 4675 this option. Note that this option can be changed at any time | |
| 4676 allowing to switch between mappings for different languages/encodings. | |
| 4677 Use a mapping to avoid having to type it each time! | |
| 4678 | |
| 4679 *'langmenu'* *'lm'* | |
| 4680 'langmenu' 'lm' string (default "") | |
| 4681 global | |
| 4682 {not in Vi} | |
| 4683 {only available when compiled with the |+menu| and | |
| 4684 |+multi_lang| features} | |
| 4685 Language to use for menu translation. Tells which file is loaded | |
| 4686 from the "lang" directory in 'runtimepath': > | |
| 4687 "lang/menu_" . &langmenu . ".vim" | |
| 4688 < (without the spaces). For example, to always use the Dutch menus, no | |
| 4689 matter what $LANG is set to: > | |
| 4690 :set langmenu=nl_NL.ISO_8859-1 | |
| 4691 < When 'langmenu' is empty, |v:lang| is used. | |
| 36 | 4692 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 4693 If your $LANG is set to a non-English language but you do want to use |
| 4694 the English menus: > | |
| 4695 :set langmenu=none | |
| 4696 < This option must be set before loading menus, switching on filetype | |
| 4697 detection or syntax highlighting. Once the menus are defined setting | |
| 4698 this option has no effect. But you could do this: > | |
| 4699 :source $VIMRUNTIME/delmenu.vim | |
| 4700 :set langmenu=de_DE.ISO_8859-1 | |
| 4701 :source $VIMRUNTIME/menu.vim | |
| 4702 < Warning: This deletes all menus that you defined yourself! | |
| 4703 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4704 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
4705 'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|) |
| 6339 | 4706 global |
| 4707 {not in Vi} | |
| 4708 {only available when compiled with the |+langmap| | |
| 4709 feature} | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4710 This is just like 'langremap' but with the value inverted. It only |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4711 exists for backwards compatibility. When setting 'langremap' then |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4712 'langnoremap' is set to the inverted value, and the other way around. |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4713 |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4714 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'* |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4715 'langremap' 'lrm' boolean (default on, reset in |defaults.vim|) |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4716 global |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4717 {not in Vi} |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4718 {only available when compiled with the |+langmap| |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4719 feature} |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4720 When off, setting 'langmap' does not apply to characters resulting from |
| 6339 | 4721 a mapping. This basically means, if you noticed that setting |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4722 'langmap' disables some of your mappings, try resetting this option. |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
4723 This option defaults to on for backwards compatibility. Set it off if |
| 6339 | 4724 that works for you to avoid mappings to break. |
| 4725 | |
| 7 | 4726 *'laststatus'* *'ls'* |
| 4727 'laststatus' 'ls' number (default 1) | |
| 4728 global | |
| 4729 {not in Vi} | |
| 4730 The value of this option influences when the last window will have a | |
| 4731 status line: | |
| 4732 0: never | |
| 4733 1: only if there are at least two windows | |
| 4734 2: always | |
| 4735 The screen looks nicer with a status line if you have several | |
| 4736 windows, but it takes another screen line. |status-line| | |
| 4737 | |
| 4738 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'* | |
| 4739 'lazyredraw' 'lz' boolean (default off) | |
| 4740 global | |
| 4741 {not in Vi} | |
| 4742 When this option is set, the screen will not be redrawn while | |
| 4743 executing macros, registers and other commands that have not been | |
| 10 | 4744 typed. Also, updating the window title is postponed. To force an |
| 7 | 4745 update use |:redraw|. |
| 4746 | |
| 4747 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'* | |
| 4748 'linebreak' 'lbr' boolean (default off) | |
| 4749 local to window | |
| 4750 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
4751 {not available when compiled without the |+linebreak| |
| 7 | 4752 feature} |
| 6009 | 4753 If on, Vim will wrap long lines at a character in 'breakat' rather |
| 7 | 4754 than at the last character that fits on the screen. Unlike |
| 4755 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file, | |
| 6009 | 4756 it only affects the way the file is displayed, not its contents. |
| 4757 If 'breakindent' is set, line is visually indented. Then, the value | |
| 4758 of 'showbreak' is used to put in front of wrapped lines. This option | |
| 6026 | 4759 is not used when the 'wrap' option is off. |
| 7 | 4760 Note that <Tab> characters after an <EOL> are mostly not displayed |
| 4761 with the right amount of white space. | |
| 4762 | |
| 4763 *'lines'* *E593* | |
| 4764 'lines' number (default 24 or terminal height) | |
| 4765 global | |
| 4766 Number of lines of the Vim window. | |
| 4767 Normally you don't need to set this. It is done automatically by the | |
| 161 | 4768 terminal initialization code. Also see |posix-screen-size|. |
| 7 | 4769 When Vim is running in the GUI or in a resizable window, setting this |
| 4770 option will cause the window size to be changed. When you only want | |
| 4771 to use the size for the GUI, put the command in your |gvimrc| file. | |
| 4772 Vim limits the number of lines to what fits on the screen. You can | |
| 4773 use this command to get the tallest window possible: > | |
| 4774 :set lines=999 | |
| 571 | 4775 < Minimum value is 2, maximum value is 1000. |
|
9887
b4da19b7539f
commit https://github.com/vim/vim/commit/dc1f1645cb495fa6bfbe216d7359f23539a0e25d
Christian Brabandt <cb@256bit.org>
parents:
9877
diff
changeset
|
4776 If you get fewer lines than expected, check the 'guiheadroom' option. |
| 7 | 4777 When you set this option and Vim is unable to change the physical |
| 4778 number of lines of the display, the display may be messed up. | |
| 4779 | |
| 4780 *'linespace'* *'lsp'* | |
| 4781 'linespace' 'lsp' number (default 0, 1 for Win32 GUI) | |
| 4782 global | |
| 4783 {not in Vi} | |
| 4784 {only in the GUI} | |
| 4785 Number of pixel lines inserted between characters. Useful if the font | |
| 4786 uses the full character cell height, making lines touch each other. | |
| 4787 When non-zero there is room for underlining. | |
| 180 | 4788 With some fonts there can be too much room between lines (to have |
| 4789 space for ascents and descents). Then it makes sense to set | |
| 4790 'linespace' to a negative value. This may cause display problems | |
| 4791 though! | |
| 7 | 4792 |
| 4793 *'lisp'* *'nolisp'* | |
| 4794 'lisp' boolean (default off) | |
| 4795 local to buffer | |
| 4796 {not available when compiled without the |+lispindent| | |
| 4797 feature} | |
| 4798 Lisp mode: When <Enter> is typed in insert mode set the indent for | |
| 4799 the next line to Lisp standards (well, sort of). Also happens with | |
| 4800 "cc" or "S". 'autoindent' must also be on for this to work. The 'p' | |
| 4801 flag in 'cpoptions' changes the method of indenting: Vi compatible or | |
| 4802 better. Also see 'lispwords'. | |
| 4803 The '-' character is included in keyword characters. Redefines the | |
| 4804 "=" operator to use this same indentation algorithm rather than | |
| 4805 calling an external program if 'equalprg' is empty. | |
| 4806 This option is not used when 'paste' is set. | |
| 4807 {Vi: Does it a little bit differently} | |
| 4808 | |
| 4809 *'lispwords'* *'lw'* | |
| 4810 'lispwords' 'lw' string (default is very long) | |
| 5712 | 4811 global or local to buffer |global-local| |
| 7 | 4812 {not in Vi} |
| 4813 {not available when compiled without the |+lispindent| | |
| 4814 feature} | |
| 4815 Comma separated list of words that influence the Lisp indenting. | |
| 4816 |'lisp'| | |
| 4817 | |
| 4818 *'list'* *'nolist'* | |
| 4819 'list' boolean (default off) | |
| 4820 local to window | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4821 List mode: Show tabs as CTRL-I is displayed, display $ after end of |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4822 line. Useful to see the difference between tabs and spaces and for |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4823 trailing blanks. Further changed by the 'listchars' option. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4824 |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4825 The cursor is displayed at the start of the space a Tab character |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4826 occupies, not at the end as usual in Normal mode. To get this cursor |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4827 position while displaying Tabs with spaces, use: > |
|
5161
f7add3891e95
Updated runtime files. Fix NL translations.
Bram Moolenaar <bram@vim.org>
parents:
5146
diff
changeset
|
4828 :set list lcs=tab:\ \ |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4829 < |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4830 Note that list mode will also affect formatting (set with 'textwidth' |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
4831 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for |
| 7 | 4832 changing the way tabs are displayed. |
| 4833 | |
| 4834 *'listchars'* *'lcs'* | |
| 4835 'listchars' 'lcs' string (default "eol:$") | |
| 4836 global | |
| 4837 {not in Vi} | |
| 2458 | 4838 Strings to use in 'list' mode and for the |:list| command. It is a |
| 4839 comma separated list of string settings. | |
| 6777 | 4840 *lcs-eol* |
| 7 | 4841 eol:c Character to show at the end of each line. When |
| 4842 omitted, there is no extra character at the end of the | |
| 4843 line. | |
| 6777 | 4844 *lcs-tab* |
| 1263 | 4845 tab:xy Two characters to be used to show a tab. The first |
| 7 | 4846 char is used once. The second char is repeated to |
| 1263 | 4847 fill the space that the tab normally occupies. |
| 4848 "tab:>-" will show a tab that takes four spaces as | |
| 4849 ">---". When omitted, a tab is show as ^I. | |
| 6777 | 4850 *lcs-space* |
| 4851 space:c Character to show for a space. When omitted, spaces | |
| 4852 are left blank. | |
| 4853 *lcs-trail* | |
| 10 | 4854 trail:c Character to show for trailing spaces. When omitted, |
| 6777 | 4855 trailing spaces are blank. Overrides the "space" |
| 4856 setting for trailing spaces. | |
| 4857 *lcs-extends* | |
| 7 | 4858 extends:c Character to show in the last column, when 'wrap' is |
| 4859 off and the line continues beyond the right of the | |
| 4860 screen. | |
| 6777 | 4861 *lcs-precedes* |
| 7 | 4862 precedes:c Character to show in the first column, when 'wrap' |
| 4863 is off and there is text preceding the character | |
| 4864 visible in the first column. | |
| 6777 | 4865 *lcs-conceal* |
|
2250
1bac28a53fae
Add the conceal patch from Vince Negri.
Bram Moolenaar <bram@vim.org>
parents:
2249
diff
changeset
|
4866 conceal:c Character to show in place of concealed text, when |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
4867 'conceallevel' is set to 1. |
| 6777 | 4868 *lcs-nbsp* |
| 6801 | 4869 nbsp:c Character to show for a non-breakable space character |
| 4870 (0xA0 (160 decimal) and U+202F). Left blank when | |
| 4871 omitted. | |
| 7 | 4872 |
| 10 | 4873 The characters ':' and ',' should not be used. UTF-8 characters can |
| 7 | 4874 be used when 'encoding' is "utf-8", otherwise only printable |
| 819 | 4875 characters are allowed. All characters must be single width. |
| 7 | 4876 |
| 4877 Examples: > | |
| 4878 :set lcs=tab:>-,trail:- | |
| 12 | 4879 :set lcs=tab:>-,eol:<,nbsp:% |
| 7 | 4880 :set lcs=extends:>,precedes:< |
| 4881 < The "NonText" highlighting will be used for "eol", "extends" and | |
| 6777 | 4882 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail". |
| 1152 | 4883 |hl-NonText| |hl-SpecialKey| |
| 7 | 4884 |
| 4885 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'* | |
| 4886 'loadplugins' 'lpl' boolean (default on) | |
| 4887 global | |
| 4888 {not in Vi} | |
| 4889 When on the plugin scripts are loaded when starting up |load-plugins|. | |
| 4890 This option can be reset in your |vimrc| file to disable the loading | |
| 4891 of plugins. | |
| 4892 Note that using the "-u NONE" and "--noplugin" command line arguments | |
| 4893 reset this option. |-u| |--noplugin| | |
| 4894 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4895 *'luadll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
4896 'luadll' string (default depends on the build) |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4897 global |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4898 {not in Vi} |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4899 {only available when compiled with the |+lua/dyn| |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4900 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4901 Specifies the name of the Lua shared library. The default is |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
4902 DYNAMIC_LUA_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
4903 Environment variables are expanded |:set_env|. |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4904 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4905 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
4906 |
| 842 | 4907 *'macatsui'* *'nomacatsui'* |
| 4908 'macatsui' boolean (default on) | |
| 4909 global | |
| 4910 {only available in Mac GUI version} | |
| 4911 This is a workaround for when drawing doesn't work properly. When set | |
| 4912 and compiled with multi-byte support ATSUI text drawing is used. When | |
| 4913 not set ATSUI text drawing is not used. Switch this option off when | |
| 4914 you experience drawing problems. In a future version the problems may | |
| 4915 be solved and this option becomes obsolete. Therefore use this method | |
| 4916 to unset it: > | |
| 4917 if exists('&macatsui') | |
| 4918 set nomacatsui | |
| 4919 endif | |
| 1152 | 4920 < Another option to check if you have drawing problems is |
| 4921 'termencoding'. | |
| 4922 | |
| 7 | 4923 *'magic'* *'nomagic'* |
| 4924 'magic' boolean (default on) | |
| 4925 global | |
| 4926 Changes the special characters that can be used in search patterns. | |
| 4927 See |pattern|. | |
|
10140
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4928 WARNING: Switching this option off most likely breaks plugins! That |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4929 is because many patterns assume it's on and will fail when it's off. |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4930 Only switch it off when working with old Vi scripts. In any other |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4931 situation write patterns that work when 'magic' is on. Include "\M" |
|
b11ceef7116e
commit https://github.com/vim/vim/commit/64d8e25bf6efe5f18b032563521c3ce278c316ab
Christian Brabandt <cb@256bit.org>
parents:
10027
diff
changeset
|
4932 when you want to |/\M|. |
| 7 | 4933 |
| 4934 *'makeef'* *'mef'* | |
| 4935 'makeef' 'mef' string (default: "") | |
| 4936 global | |
| 4937 {not in Vi} | |
| 4938 {not available when compiled without the |+quickfix| | |
| 4939 feature} | |
| 4940 Name of the errorfile for the |:make| command (see |:make_makeprg|) | |
| 4941 and the |:grep| command. | |
| 4942 When it is empty, an internally generated temp file will be used. | |
| 4943 When "##" is included, it is replaced by a number to make the name | |
| 4944 unique. This makes sure that the ":make" command doesn't overwrite an | |
| 4945 existing file. | |
| 4946 NOT used for the ":cf" command. See 'errorfile' for that. | |
| 4947 Environment variables are expanded |:set_env|. | |
| 4948 See |option-backslash| about including spaces and backslashes. | |
| 4949 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4950 security reasons. | |
| 4951 | |
| 4952 *'makeprg'* *'mp'* | |
| 4953 'makeprg' 'mp' string (default "make", VMS: "MMS") | |
| 4954 global or local to buffer |global-local| | |
| 4955 {not in Vi} | |
| 1152 | 4956 Program to use for the ":make" command. See |:make_makeprg|. |
| 5690 | 4957 This option may contain '%' and '#' characters (see |:_%| and |:_#|), |
| 4958 which are expanded to the current and alternate file name. Use |::S| | |
| 4959 to escape file names in case they contain special characters. | |
| 1152 | 4960 Environment variables are expanded |:set_env|. See |option-backslash| |
| 4961 about including spaces and backslashes. | |
| 4962 Note that a '|' must be escaped twice: once for ":set" and once for | |
| 4963 the interpretation of a command. When you use a filter called | |
| 4964 "myfilter" do it like this: > | |
| 7 | 4965 :set makeprg=gmake\ \\\|\ myfilter |
| 4966 < The placeholder "$*" can be given (even multiple times) to specify | |
| 4967 where the arguments will be included, for example: > | |
| 4968 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*} | |
| 4969 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 4970 security reasons. | |
| 4971 | |
| 4972 *'matchpairs'* *'mps'* | |
| 4973 'matchpairs' 'mps' string (default "(:),{:},[:]") | |
| 4974 local to buffer | |
| 4975 {not in Vi} | |
| 4976 Characters that form pairs. The |%| command jumps from one to the | |
| 4073 | 4977 other. |
| 4978 Only character pairs are allowed that are different, thus you cannot | |
| 4979 jump between two double quotes. | |
| 4980 The characters must be separated by a colon. | |
| 1152 | 4981 The pairs must be separated by a comma. Example for including '<' and |
| 4982 '>' (HTML): > | |
| 7 | 4983 :set mps+=<:> |
| 4984 | |
| 4985 < A more exotic example, to jump between the '=' and ';' in an | |
| 4986 assignment, useful for languages like C and Java: > | |
| 4987 :au FileType c,cpp,java set mps+==:; | |
| 4988 | |
| 4989 < For a more advanced way of using "%", see the matchit.vim plugin in | |
| 4990 the $VIMRUNTIME/macros directory. |add-local-help| | |
| 4991 | |
| 4992 *'matchtime'* *'mat'* | |
| 4993 'matchtime' 'mat' number (default 5) | |
| 4994 global | |
| 4995 {not in Vi}{in Nvi} | |
| 4996 Tenths of a second to show the matching paren, when 'showmatch' is | |
| 4997 set. Note that this is not in milliseconds, like other options that | |
| 4998 set a time. This is to be compatible with Nvi. | |
| 4999 | |
| 714 | 5000 *'maxcombine'* *'mco'* |
| 5001 'maxcombine' 'mco' number (default 2) | |
| 5002 global | |
| 5003 {not in Vi} | |
| 5004 {only available when compiled with the |+multi_byte| | |
| 5005 feature} | |
| 5006 The maximum number of combining characters supported for displaying. | |
| 5007 Only used when 'encoding' is "utf-8". | |
| 5008 The default is OK for most languages. Hebrew may require 4. | |
| 5009 Maximum value is 6. | |
| 5010 Even when this option is set to 2 you can still edit text with more | |
| 5011 combining characters, you just can't see them. Use |g8| or |ga|. | |
| 5012 See |mbyte-combining|. | |
| 5013 | |
| 7 | 5014 *'maxfuncdepth'* *'mfd'* |
| 5015 'maxfuncdepth' 'mfd' number (default 100) | |
| 5016 global | |
| 5017 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5018 {not available when compiled without the |+eval| |
| 1152 | 5019 feature} |
| 7 | 5020 Maximum depth of function calls for user functions. This normally |
| 5021 catches endless recursion. When using a recursive function with | |
| 5022 more depth, set 'maxfuncdepth' to a bigger number. But this will use | |
| 5023 more memory, there is the danger of failing when memory is exhausted. | |
|
10498
883396809b45
commit https://github.com/vim/vim/commit/bc2eada5424bff06f7eb77c032ecc067da52b846
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
5024 Increasing this limit above 200 also changes the maximum for Ex |
|
883396809b45
commit https://github.com/vim/vim/commit/bc2eada5424bff06f7eb77c032ecc067da52b846
Christian Brabandt <cb@256bit.org>
parents:
10449
diff
changeset
|
5025 command resursion, see |E169|. |
| 7 | 5026 See also |:function|. |
| 5027 | |
| 5028 *'maxmapdepth'* *'mmd'* *E223* | |
| 5029 'maxmapdepth' 'mmd' number (default 1000) | |
| 5030 global | |
| 5031 {not in Vi} | |
| 5032 Maximum number of times a mapping is done without resulting in a | |
| 5033 character to be used. This normally catches endless mappings, like | |
| 5034 ":map x y" with ":map y x". It still does not catch ":map g wg", | |
| 5035 because the 'w' is used before the next mapping is done. See also | |
| 5036 |key-mapping|. | |
| 5037 | |
| 5038 *'maxmem'* *'mm'* | |
| 5039 'maxmem' 'mm' number (default between 256 to 5120 (system | |
| 5040 dependent) or half the amount of memory | |
| 5041 available) | |
| 5042 global | |
| 5043 {not in Vi} | |
| 5044 Maximum amount of memory (in Kbyte) to use for one buffer. When this | |
| 5045 limit is reached allocating extra memory for a buffer will cause | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5046 other memory to be freed. The maximum usable value is about 2000000. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5047 Use this to work without a limit. Also see 'maxmemtot'. |
| 7 | 5048 |
| 189 | 5049 *'maxmempattern'* *'mmp'* |
| 5050 'maxmempattern' 'mmp' number (default 1000) | |
| 5051 global | |
| 5052 {not in Vi} | |
| 5053 Maximum amount of memory (in Kbyte) to use for pattern matching. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5054 The maximum value is about 2000000. Use this to work without a limit. |
| 189 | 5055 *E363* |
| 1152 | 5056 When Vim runs into the limit it gives an error message and mostly |
| 5057 behaves like CTRL-C was typed. | |
| 189 | 5058 Running into the limit often means that the pattern is very |
| 5059 inefficient or too complex. This may already happen with the pattern | |
| 5060 "\(.\)*" on a very long line. ".*" works much better. | |
| 5061 Vim may run out of memory before hitting the 'maxmempattern' limit. | |
| 5062 | |
| 7 | 5063 *'maxmemtot'* *'mmt'* |
| 5064 'maxmemtot' 'mmt' number (default between 2048 and 10240 (system | |
| 5065 dependent) or half the amount of memory | |
| 5066 available) | |
| 5067 global | |
| 5068 {not in Vi} | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5069 Maximum amount of memory in Kbyte to use for all buffers together. |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5070 The maximum usable value is about 2000000 (2 Gbyte). Use this to work |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5071 without a limit. |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5072 On 64 bit machines higher values might work. But hey, do you really |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5073 need more than 2 Gbyte for text editing? Keep in mind that text is |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5074 stored in the swap file, one can edit files > 2 Gbyte anyway. We do |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
5075 need the memory to store undo info. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
5076 Also see 'maxmem'. |
| 7 | 5077 |
| 5078 *'menuitems'* *'mis'* | |
| 5079 'menuitems' 'mis' number (default 25) | |
| 5080 global | |
| 5081 {not in Vi} | |
| 5082 {not available when compiled without the |+menu| | |
| 5083 feature} | |
| 5084 Maximum number of items to use in a menu. Used for menus that are | |
| 5085 generated from a list of items, e.g., the Buffers menu. Changing this | |
| 5086 option has no direct effect, the menu must be refreshed first. | |
| 5087 | |
| 484 | 5088 *'mkspellmem'* *'msm'* |
| 5089 'mkspellmem' 'msm' string (default "460000,2000,500") | |
| 5090 global | |
| 5091 {not in Vi} | |
| 5092 {not available when compiled without the |+syntax| | |
| 5093 feature} | |
| 5094 Parameters for |:mkspell|. This tunes when to start compressing the | |
| 5095 word tree. Compression can be slow when there are many words, but | |
| 5096 it's needed to avoid running out of memory. The amount of memory used | |
| 5097 per word depends very much on how similar the words are, that's why | |
| 5098 this tuning is complicated. | |
| 5099 | |
| 5100 There are three numbers, separated by commas: | |
| 5101 {start},{inc},{added} | |
| 5102 | |
| 5103 For most languages the uncompressed word tree fits in memory. {start} | |
| 5104 gives the amount of memory in Kbyte that can be used before any | |
| 5105 compression is done. It should be a bit smaller than the amount of | |
| 5106 memory that is available to Vim. | |
| 5107 | |
| 5108 When going over the {start} limit the {inc} number specifies the | |
| 5109 amount of memory in Kbyte that can be allocated before another | |
| 5110 compression is done. A low number means compression is done after | |
| 5111 less words are added, which is slow. A high number means more memory | |
| 5112 will be allocated. | |
| 5113 | |
| 5114 After doing compression, {added} times 1024 words can be added before | |
| 5115 the {inc} limit is ignored and compression is done when any extra | |
| 5116 amount of memory is needed. A low number means there is a smaller | |
| 5117 chance of hitting the {inc} limit, less memory is used but it's | |
| 5118 slower. | |
| 5119 | |
| 5120 The languages for which these numbers are important are Italian and | |
| 5121 Hungarian. The default works for when you have about 512 Mbyte. If | |
| 5122 you have 1 Gbyte you could use: > | |
| 5123 :set mkspellmem=900000,3000,800 | |
| 5124 < If you have less than 512 Mbyte |:mkspell| may fail for some | |
| 5125 languages, no matter what you set 'mkspellmem' to. | |
| 5126 | |
| 7 | 5127 *'modeline'* *'ml'* *'nomodeline'* *'noml'* |
| 1111 | 5128 'modeline' 'ml' boolean (Vim default: on (off for root), |
| 5129 Vi default: off) | |
| 7 | 5130 local to buffer |
| 5131 *'modelines'* *'mls'* | |
| 5132 'modelines' 'mls' number (default 5) | |
| 5133 global | |
| 5134 {not in Vi} | |
| 5135 If 'modeline' is on 'modelines' gives the number of lines that is | |
| 5136 checked for set commands. If 'modeline' is off or 'modelines' is zero | |
| 5137 no lines are checked. See |modeline|. | |
| 5138 NOTE: 'modeline' is set to the Vi default value when 'compatible' is | |
| 5139 set and to the Vim default value when 'compatible' is reset. | |
| 5140 | |
| 5141 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'* | |
| 5142 'modifiable' 'ma' boolean (default on) | |
| 5143 local to buffer | |
| 5144 {not in Vi} *E21* | |
| 5145 When off the buffer contents cannot be changed. The 'fileformat' and | |
| 5146 'fileencoding' options also can't be changed. | |
| 10617 | 5147 Can be reset on startup with the |-M| command line argument. |
| 7 | 5148 |
| 5149 *'modified'* *'mod'* *'nomodified'* *'nomod'* | |
| 5150 'modified' 'mod' boolean (default off) | |
| 5151 local to buffer | |
| 5152 {not in Vi} | |
| 5153 When on, the buffer is considered to be modified. This option is set | |
| 5154 when: | |
| 5155 1. A change was made to the text since it was last written. Using the | |
| 5156 |undo| command to go back to the original text will reset the | |
| 5157 option. But undoing changes that were made before writing the | |
| 5158 buffer will set the option again, since the text is different from | |
| 5159 when it was written. | |
| 5160 2. 'fileformat' or 'fileencoding' is different from its original | |
| 5161 value. The original value is set when the buffer is read or | |
| 5162 written. A ":set nomodified" command also resets the original | |
| 5163 values to the current values and the 'modified' option will be | |
| 5164 reset. | |
|
8748
b1a19a2f73f0
commit https://github.com/vim/vim/commit/4f3f668c8486444e53163c29d2fc79bf47eb3c82
Christian Brabandt <cb@256bit.org>
parents:
8629
diff
changeset
|
5165 Similarly for 'eol' and 'bomb'. |
| 3082 | 5166 This option is not set when a change is made to the buffer as the |
| 5167 result of a BufNewFile, BufRead/BufReadPost, BufWritePost, | |
| 5168 FileAppendPost or VimLeave autocommand event. See |gzip-example| for | |
| 5169 an explanation. | |
| 7 | 5170 When 'buftype' is "nowrite" or "nofile" this option may be set, but |
| 5171 will be ignored. | |
| 5172 | |
| 5173 *'more'* *'nomore'* | |
| 5174 'more' boolean (Vim default: on, Vi default: off) | |
| 5175 global | |
| 5176 {not in Vi} | |
| 5177 When on, listings pause when the whole screen is filled. You will get | |
| 5178 the |more-prompt|. When this option is off there are no pauses, the | |
| 5179 listing continues until finished. | |
| 5180 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 5181 set and to the Vim default value when 'compatible' is reset. | |
| 5182 | |
| 5183 *'mouse'* *E538* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5184 'mouse' string (default "", "a" for GUI, MS-DOS and Win32, |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5185 set to "a" in |defaults.vim|) |
| 7 | 5186 global |
| 5187 {not in Vi} | |
| 5188 Enable the use of the mouse. Only works for certain terminals | |
| 1621 | 5189 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with |
| 5190 sysmouse and Linux console with gpm). For using the mouse in the | |
| 5191 GUI, see |gui-mouse|. | |
| 7 | 5192 The mouse can be enabled for different modes: |
| 5193 n Normal mode | |
| 5194 v Visual mode | |
| 5195 i Insert mode | |
| 5196 c Command-line mode | |
| 5197 h all previous modes when editing a help file | |
| 5198 a all previous modes | |
| 5199 r for |hit-enter| and |more-prompt| prompt | |
| 5200 Normally you would enable the mouse in all four modes with: > | |
| 5201 :set mouse=a | |
| 5202 < When the mouse is not enabled, the GUI will still use the mouse for | |
| 5203 modeless selection. This doesn't move the text cursor. | |
| 5204 | |
| 5205 See |mouse-using|. Also see |'clipboard'|. | |
| 5206 | |
| 5207 Note: When enabling the mouse in a terminal, copy/paste will use the | |
| 10 | 5208 "* register if there is access to an X-server. The xterm handling of |
| 7 | 5209 the mouse buttons can still be used by keeping the shift key pressed. |
| 5210 Also see the 'clipboard' option. | |
| 5211 | |
| 5212 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'* | |
| 5213 'mousefocus' 'mousef' boolean (default off) | |
| 5214 global | |
| 5215 {not in Vi} | |
| 5216 {only works in the GUI} | |
| 5217 The window that the mouse pointer is on is automatically activated. | |
| 5218 When changing the window layout or window focus in another way, the | |
| 5219 mouse pointer is moved to the window with keyboard focus. Off is the | |
| 5220 default because it makes using the pull down menus a little goofy, as | |
| 5221 a pointer transit may activate a window unintentionally. | |
| 5222 | |
| 5223 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'* | |
| 5224 'mousehide' 'mh' boolean (default on) | |
| 5225 global | |
| 5226 {not in Vi} | |
| 5227 {only works in the GUI} | |
| 5228 When on, the mouse pointer is hidden when characters are typed. | |
| 5229 The mouse pointer is restored when the mouse is moved. | |
| 5230 | |
| 5231 *'mousemodel'* *'mousem'* | |
| 5232 'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32) | |
| 5233 global | |
| 5234 {not in Vi} | |
| 5235 Sets the model to use for the mouse. The name mostly specifies what | |
| 5236 the right mouse button is used for: | |
| 5237 extend Right mouse button extends a selection. This works | |
| 5238 like in an xterm. | |
| 5239 popup Right mouse button pops up a menu. The shifted left | |
| 5240 mouse button extends a selection. This works like | |
| 233 | 5241 with Microsoft Windows. |
| 7 | 5242 popup_setpos Like "popup", but the cursor will be moved to the |
| 5243 position where the mouse was clicked, and thus the | |
| 5244 selected operation will act upon the clicked object. | |
| 5245 If clicking inside a selection, that selection will | |
| 233 | 5246 be acted upon, i.e. no cursor move. This implies of |
| 7 | 5247 course, that right clicking outside a selection will |
| 5248 end Visual mode. | |
| 5249 Overview of what button does what for each model: | |
| 5250 mouse extend popup(_setpos) ~ | |
| 5251 left click place cursor place cursor | |
| 5252 left drag start selection start selection | |
| 5253 shift-left search word extend selection | |
| 5254 right click extend selection popup menu (place cursor) | |
| 5255 right drag extend selection - | |
| 5256 middle click paste paste | |
| 5257 | |
| 5258 In the "popup" model the right mouse button produces a pop-up menu. | |
| 5259 You need to define this first, see |popup-menu|. | |
| 5260 | |
| 5261 Note that you can further refine the meaning of buttons with mappings. | |
| 5262 See |gui-mouse-mapping|. But mappings are NOT used for modeless | |
| 5263 selection (because that's handled in the GUI code directly). | |
| 5264 | |
| 5265 The 'mousemodel' option is set by the |:behave| command. | |
| 5266 | |
| 5267 *'mouseshape'* *'mouses'* *E547* | |
| 5268 'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross, | |
| 233 | 5269 m:no,ml:up-arrow,v:rightup-arrow") |
| 7 | 5270 global |
| 5271 {not in Vi} | |
| 5272 {only available when compiled with the |+mouseshape| | |
| 5273 feature} | |
| 5274 This option tells Vim what the mouse pointer should look like in | |
| 5275 different modes. The option is a comma separated list of parts, much | |
| 5276 like used for 'guicursor'. Each part consist of a mode/location-list | |
| 5277 and an argument-list: | |
| 5278 mode-list:shape,mode-list:shape,.. | |
| 5279 The mode-list is a dash separated list of these modes/locations: | |
| 5280 In a normal window: ~ | |
| 5281 n Normal mode | |
| 5282 v Visual mode | |
| 5283 ve Visual mode with 'selection' "exclusive" (same as 'v', | |
| 5284 if not specified) | |
| 5285 o Operator-pending mode | |
| 5286 i Insert mode | |
| 5287 r Replace mode | |
| 5288 | |
| 5289 Others: ~ | |
| 5290 c appending to the command-line | |
| 5291 ci inserting in the command-line | |
| 5292 cr replacing in the command-line | |
| 5293 m at the 'Hit ENTER' or 'More' prompts | |
| 5294 ml idem, but cursor in the last line | |
| 5295 e any mode, pointer below last window | |
| 5296 s any mode, pointer on a status line | |
| 5297 sd any mode, while dragging a status line | |
| 5298 vs any mode, pointer on a vertical separator line | |
| 5299 vd any mode, while dragging a vertical separator line | |
| 5300 a everywhere | |
| 5301 | |
| 5302 The shape is one of the following: | |
| 5303 avail name looks like ~ | |
| 5304 w x arrow Normal mouse pointer | |
| 5305 w x blank no pointer at all (use with care!) | |
| 5306 w x beam I-beam | |
| 5307 w x updown up-down sizing arrows | |
| 5308 w x leftright left-right sizing arrows | |
| 5309 w x busy The system's usual busy pointer | |
| 5310 w x no The system's usual 'no input' pointer | |
| 5311 x udsizing indicates up-down resizing | |
| 5312 x lrsizing indicates left-right resizing | |
| 5313 x crosshair like a big thin + | |
| 5314 x hand1 black hand | |
| 5315 x hand2 white hand | |
| 5316 x pencil what you write with | |
| 5317 x question big ? | |
| 5318 x rightup-arrow arrow pointing right-up | |
| 5319 w x up-arrow arrow pointing up | |
| 5320 x <number> any X11 pointer number (see X11/cursorfont.h) | |
| 5321 | |
| 5322 The "avail" column contains a 'w' if the shape is available for Win32, | |
| 5323 x for X11. | |
| 5324 Any modes not specified or shapes not available use the normal mouse | |
| 5325 pointer. | |
| 5326 | |
| 5327 Example: > | |
| 5328 :set mouseshape=s:udsizing,m:no | |
| 5329 < will make the mouse turn to a sizing arrow over the status lines and | |
| 5330 indicate no input when the hit-enter prompt is displayed (since | |
| 5331 clicking the mouse has no effect in this state.) | |
| 5332 | |
| 5333 *'mousetime'* *'mouset'* | |
| 5334 'mousetime' 'mouset' number (default 500) | |
| 5335 global | |
| 5336 {not in Vi} | |
| 5337 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum | |
| 5338 time in msec between two mouse clicks for the second click to be | |
| 5339 recognized as a multi click. | |
| 5340 | |
| 14 | 5341 *'mzquantum'* *'mzq'* |
| 5342 'mzquantum' 'mzq' number (default 100) | |
| 5343 global | |
| 5344 {not in Vi} | |
| 5345 {not available when compiled without the |+mzscheme| | |
| 5346 feature} | |
| 5347 The number of milliseconds between polls for MzScheme threads. | |
| 5348 Negative or zero value means no thread scheduling. | |
| 5349 | |
| 7 | 5350 *'nrformats'* *'nf'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5351 'nrformats' 'nf' string (default "bin,octal,hex", |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
5352 set to "bin,hex" in |defaults.vim|) |
| 7 | 5353 local to buffer |
| 5354 {not in Vi} | |
| 5355 This defines what bases Vim will consider for numbers when using the | |
| 5356 CTRL-A and CTRL-X commands for adding to and subtracting from a number | |
| 5357 respectively; see |CTRL-A| for more info on these commands. | |
| 625 | 5358 alpha If included, single alphabetical characters will be |
| 7 | 5359 incremented or decremented. This is useful for a list with a |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5360 letter index a), b), etc. *octal-nrformats* |
| 625 | 5361 octal If included, numbers that start with a zero will be considered |
| 7 | 5362 to be octal. Example: Using CTRL-A on "007" results in "010". |
| 625 | 5363 hex If included, numbers starting with "0x" or "0X" will be |
| 7 | 5364 considered to be hexadecimal. Example: Using CTRL-X on |
| 5365 "0x100" results in "0x0ff". | |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5366 bin If included, numbers starting with "0b" or "0B" will be |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5367 considered to be binary. Example: Using CTRL-X on |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5368 "0b1000" subtracts one, resulting in "0b0111". |
| 7 | 5369 Numbers which simply begin with a digit in the range 1-9 are always |
| 5370 considered decimal. This also happens for numbers that are not | |
| 5371 recognized as octal or hex. | |
| 5372 | |
| 5373 *'number'* *'nu'* *'nonumber'* *'nonu'* | |
| 5374 'number' 'nu' boolean (default off) | |
| 5375 local to window | |
| 5376 Print the line number in front of each line. When the 'n' option is | |
| 5377 excluded from 'cpoptions' a wrapped line will not use the column of | |
| 5378 line numbers (this is the default when 'compatible' isn't set). | |
| 13 | 5379 The 'numberwidth' option can be used to set the room used for the line |
| 5380 number. | |
| 7 | 5381 When a long, wrapped line doesn't start with the first character, '-' |
| 5382 characters are put before the number. | |
| 3445 | 5383 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 5384 the number. | |
| 4780 | 5385 *number_relativenumber* |
| 5386 The 'relativenumber' option changes the displayed number to be | |
| 5387 relative to the cursor. Together with 'number' there are these | |
| 5388 four combinations (cursor in line 3): | |
| 5389 | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5390 'nonu' 'nu' 'nonu' 'nu' |
| 4780 | 5391 'nornu' 'nornu' 'rnu' 'rnu' |
| 5392 | |
| 5393 |apple | 1 apple | 2 apple | 2 apple | |
| 5394 |pear | 2 pear | 1 pear | 1 pear | |
| 5395 |nobody | 3 nobody | 0 nobody |3 nobody | |
| 5396 |there | 4 there | 1 there | 1 there | |
| 7 | 5397 |
| 13 | 5398 *'numberwidth'* *'nuw'* |
| 5399 'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8) | |
| 5400 local to window | |
| 14 | 5401 {not in Vi} |
| 5402 {only available when compiled with the |+linebreak| | |
| 5403 feature} | |
| 13 | 5404 Minimal number of columns to use for the line number. Only relevant |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5405 when the 'number' or 'relativenumber' option is set or printing lines |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5406 with a line number. Since one space is always between the number and |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5407 the text, there is one less character for the number itself. |
| 13 | 5408 The value is the minimum width. A bigger width is used when needed to |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5409 fit the highest line number in the buffer respectively the number of |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5410 rows in the window, depending on whether 'number' or 'relativenumber' |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5411 is set. Thus with the Vim default of 4 there is room for a line number |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5412 up to 999. When the buffer has 1000 lines five columns will be used. |
| 13 | 5413 The minimum value is 1, the maximum value is 10. |
| 5414 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set. | |
| 5415 | |
| 523 | 5416 *'omnifunc'* *'ofu'* |
| 5417 'omnifunc' 'ofu' string (default: empty) | |
| 502 | 5418 local to buffer |
| 5419 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5420 {not available when compiled without the |+eval| |
|
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5421 or |+insert_expand| features} |
| 623 | 5422 This option specifies a function to be used for Insert mode omni |
| 5423 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| | |
| 648 | 5424 See |complete-functions| for an explanation of how the function is |
| 5425 invoked and what it should return. | |
| 1004 | 5426 This option is usually set by a filetype plugin: |
| 859 | 5427 |:filetype-plugin-on| |
| 3682 | 5428 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5429 security reasons. | |
| 502 | 5430 |
| 5431 | |
| 1152 | 5432 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'* |
| 1004 | 5433 'opendevice' 'odev' boolean (default off) |
| 5434 global | |
| 5435 {not in Vi} | |
| 5436 {only for MS-DOS, MS-Windows and OS/2} | |
| 5437 Enable reading and writing from devices. This may get Vim stuck on a | |
| 5438 device that can be opened but doesn't actually do the I/O. Therefore | |
| 5439 it is off by default. | |
| 5440 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also | |
| 5441 result in editing a device. | |
| 5442 | |
| 5443 | |
| 593 | 5444 *'operatorfunc'* *'opfunc'* |
| 5445 'operatorfunc' 'opfunc' string (default: empty) | |
| 5446 global | |
| 5447 {not in Vi} | |
| 5448 This option specifies a function to be called by the |g@| operator. | |
| 5449 See |:map-operator| for more info and an example. | |
| 5450 | |
| 5451 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 5452 security reasons. | |
| 5453 | |
| 5454 | |
| 2908 | 5455 *'osfiletype'* *'oft'* |
| 5456 'osfiletype' 'oft' string (default: "") | |
| 7 | 5457 local to buffer |
| 5458 {not in Vi} | |
| 2908 | 5459 This option was supported on RISC OS, which has been removed. |
| 5460 | |
| 7 | 5461 |
|
8182
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5462 *'packpath'* *'pp'* |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5463 'packpath' 'pp' string (default: see 'runtimepath') |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5464 {not in Vi} |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5465 Directories used to find packages. See |packages|. |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5466 |
|
95d59081580f
commit https://github.com/vim/vim/commit/f6fee0e2d4341c0c2f5339c1268e5877fafd07cf
Christian Brabandt <cb@256bit.org>
parents:
8148
diff
changeset
|
5467 |
| 7 | 5468 *'paragraphs'* *'para'* |
| 1564 | 5469 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") |
| 7 | 5470 global |
| 5471 Specifies the nroff macros that separate paragraphs. These are pairs | |
| 5472 of two letters (see |object-motions|). | |
| 5473 | |
| 5474 *'paste'* *'nopaste'* | |
| 5475 'paste' boolean (default off) | |
| 5476 global | |
| 5477 {not in Vi} | |
| 10 | 5478 Put Vim in Paste mode. This is useful if you want to cut or copy |
| 5479 some text from one window and paste it in Vim. This will avoid | |
| 7 | 5480 unexpected effects. |
| 5481 Setting this option is useful when using Vim in a terminal, where Vim | |
| 10 | 5482 cannot distinguish between typed text and pasted text. In the GUI, Vim |
| 7 | 5483 knows about pasting and will mostly do the right thing without 'paste' |
| 5484 being set. The same is true for a terminal where Vim handles the | |
| 5485 mouse clicks itself. | |
| 148 | 5486 This option is reset when starting the GUI. Thus if you set it in |
| 5487 your .vimrc it will work in a terminal, but not in the GUI. Setting | |
| 5488 'paste' in the GUI has side effects: e.g., the Paste toolbar button | |
| 5489 will no longer work in Insert mode, because it uses a mapping. | |
| 7 | 5490 When the 'paste' option is switched on (also when it was already on): |
| 5491 - mapping in Insert mode and Command-line mode is disabled | |
| 5492 - abbreviations are disabled | |
| 5493 - 'autoindent' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5494 - 'expandtab' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5495 - 'formatoptions' is used like it is empty |
| 7 | 5496 - 'revins' is reset |
| 5497 - 'ruler' is reset | |
| 5498 - 'showmatch' is reset | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5499 - 'smartindent' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5500 - 'smarttab' is reset |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5501 - 'softtabstop' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5502 - 'textwidth' is set to 0 |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5503 - 'wrapmargin' is set to 0 |
| 7 | 5504 These options keep their value, but their effect is disabled: |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5505 - 'cindent' |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5506 - 'indentexpr' |
| 7 | 5507 - 'lisp' |
| 5508 NOTE: When you start editing another file while the 'paste' option is | |
| 5509 on, settings from the modelines or autocommands may change the | |
| 5510 settings again, causing trouble when pasting text. You might want to | |
| 5511 set the 'paste' option again. | |
| 5512 When the 'paste' option is reset the mentioned options are restored to | |
| 5513 the value before the moment 'paste' was switched from off to on. | |
| 5514 Resetting 'paste' before ever setting it does not have any effect. | |
| 5515 Since mapping doesn't work while 'paste' is active, you need to use | |
| 5516 the 'pastetoggle' option to toggle the 'paste' option with some key. | |
| 5517 | |
| 5518 *'pastetoggle'* *'pt'* | |
| 5519 'pastetoggle' 'pt' string (default "") | |
| 5520 global | |
| 5521 {not in Vi} | |
| 5522 When non-empty, specifies the key sequence that toggles the 'paste' | |
| 5523 option. This is like specifying a mapping: > | |
| 5524 :map {keys} :set invpaste<CR> | |
| 5525 < Where {keys} is the value of 'pastetoggle'. | |
| 5526 The difference is that it will work even when 'paste' is set. | |
| 5527 'pastetoggle' works in Insert mode and Normal mode, but not in | |
| 5528 Command-line mode. | |
| 5529 Mappings are checked first, thus overrule 'pastetoggle'. However, | |
| 5530 when 'paste' is on mappings are ignored in Insert mode, thus you can do | |
| 5531 this: > | |
| 5532 :map <F10> :set paste<CR> | |
| 5533 :map <F11> :set nopaste<CR> | |
| 5534 :imap <F10> <C-O>:set paste<CR> | |
| 5535 :imap <F11> <nop> | |
| 5536 :set pastetoggle=<F11> | |
| 5537 < This will make <F10> start paste mode and <F11> stop paste mode. | |
| 5538 Note that typing <F10> in paste mode inserts "<F10>", since in paste | |
| 5539 mode everything is inserted literally, except the 'pastetoggle' key | |
| 5540 sequence. | |
| 1621 | 5541 When the value has several bytes 'ttimeoutlen' applies. |
| 7 | 5542 |
| 5543 *'pex'* *'patchexpr'* | |
| 5544 'patchexpr' 'pex' string (default "") | |
| 5545 global | |
| 5546 {not in Vi} | |
| 5547 {not available when compiled without the |+diff| | |
| 5548 feature} | |
| 5549 Expression which is evaluated to apply a patch to a file and generate | |
| 10 | 5550 the resulting new version of the file. See |diff-patchexpr|. |
| 7 | 5551 |
|
6091
7090d7f160f7
Update runtime files. Add vroom file support.
Bram Moolenaar <bram@vim.org>
parents:
6032
diff
changeset
|
5552 *'patchmode'* *'pm'* *E205* *E206* |
| 7 | 5553 'patchmode' 'pm' string (default "") |
| 5554 global | |
| 5555 {not in Vi} | |
| 5556 When non-empty the oldest version of a file is kept. This can be used | |
| 5557 to keep the original version of a file if you are changing files in a | |
| 5558 source distribution. Only the first time that a file is written a | |
| 5559 copy of the original file will be kept. The name of the copy is the | |
| 5560 name of the original file with the string in the 'patchmode' option | |
| 5561 appended. This option should start with a dot. Use a string like | |
| 5562 ".org". 'backupdir' must not be empty for this to work (Detail: The | |
| 5563 backup file is renamed to the patchmode file after the new file has | |
| 5564 been successfully written, that's why it must be possible to write a | |
| 5565 backup file). If there was no file to be backed up, an empty file is | |
| 5566 created. | |
| 5567 When the 'backupskip' pattern matches, a patchmode file is not made. | |
| 5568 Using 'patchmode' for compressed files appends the extension at the | |
| 5569 end (e.g., "file.gz.orig"), thus the resulting name isn't always | |
| 5570 recognized as a compressed file. | |
| 36 | 5571 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 5572 |
| 3224 | 5573 *'path'* *'pa'* *E343* *E345* *E347* *E854* |
| 7 | 5574 'path' 'pa' string (default on Unix: ".,/usr/include,," |
| 5575 on OS/2: ".,/emx/include,," | |
| 5576 other systems: ".,,") | |
| 5577 global or local to buffer |global-local| | |
| 5578 {not in Vi} | |
| 5579 This is a list of directories which will be searched when using the | |
| 1668 | 5580 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands, |
| 5581 provided that the file being searched for has a relative path (not | |
| 5582 starting with "/", "./" or "../"). The directories in the 'path' | |
| 5583 option may be relative or absolute. | |
| 7 | 5584 - Use commas to separate directory names: > |
| 5585 :set path=.,/usr/local/include,/usr/include | |
| 5586 < - Spaces can also be used to separate directory names (for backwards | |
| 5587 compatibility with version 3.0). To have a space in a directory | |
| 5588 name, precede it with an extra backslash, and escape the space: > | |
| 5589 :set path=.,/dir/with\\\ space | |
| 5590 < - To include a comma in a directory name precede it with an extra | |
| 5591 backslash: > | |
| 5592 :set path=.,/dir/with\\,comma | |
| 5593 < - To search relative to the directory of the current file, use: > | |
| 5594 :set path=. | |
| 5595 < - To search in the current directory use an empty string between two | |
| 5596 commas: > | |
| 5597 :set path=,, | |
| 5598 < - A directory name may end in a ':' or '/'. | |
| 5599 - Environment variables are expanded |:set_env|. | |
| 5600 - When using |netrw.vim| URLs can be used. For example, adding | |
| 5601 "http://www.vim.org" will make ":find index.html" work. | |
| 1668 | 5602 - Search upwards and downwards in a directory tree using "*", "**" and |
| 5603 ";". See |file-searching| for info and syntax. | |
| 7 | 5604 {not available when compiled without the |+path_extra| feature} |
| 5605 - Careful with '\' characters, type two to get one in the option: > | |
| 5606 :set path=.,c:\\include | |
| 5607 < Or just use '/' instead: > | |
| 5608 :set path=.,c:/include | |
| 5609 < Don't forget "." or files won't even be found in the same directory as | |
| 5610 the file! | |
| 10 | 5611 The maximum length is limited. How much depends on the system, mostly |
| 7 | 5612 it is something like 256 or 1024 characters. |
| 5613 You can check if all the include files are found, using the value of | |
| 5614 'path', see |:checkpath|. | |
| 5615 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 5616 directories from the list. This avoids problems when a future version | |
| 5617 uses another default. To remove the current directory use: > | |
| 5618 :set path-= | |
| 5619 < To add the current directory use: > | |
| 5620 :set path+= | |
| 5621 < To use an environment variable, you probably need to replace the | |
| 5622 separator. Here is an example to append $INCL, in which directory | |
| 5623 names are separated with a semi-colon: > | |
| 5624 :let &path = &path . "," . substitute($INCL, ';', ',', 'g') | |
| 5625 < Replace the ';' with a ':' or whatever separator is used. Note that | |
| 5626 this doesn't work when $INCL contains a comma or white space. | |
| 5627 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5628 *'perldll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5629 'perldll' string (default depends on the build) |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5630 global |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5631 {not in Vi} |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5632 {only available when compiled with the |+perl/dyn| |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5633 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5634 Specifies the name of the Perl shared library. The default is |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5635 DYNAMIC_PERL_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5636 Environment variables are expanded |:set_env|. |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5637 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5638 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5639 |
| 7 | 5640 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'* |
| 5641 'preserveindent' 'pi' boolean (default off) | |
| 5642 local to buffer | |
| 5643 {not in Vi} | |
| 5644 When changing the indent of the current line, preserve as much of the | |
| 5645 indent structure as possible. Normally the indent is replaced by a | |
| 5646 series of tabs followed by spaces as required (unless |'expandtab'| is | |
| 5647 enabled, in which case only spaces are used). Enabling this option | |
| 5648 means the indent will preserve as many existing characters as possible | |
| 5649 for indenting, and only add additional tabs or spaces as required. | |
| 1621 | 5650 'expandtab' does not apply to the preserved white space, a Tab remains |
| 5651 a Tab. | |
| 7 | 5652 NOTE: When using ">>" multiple times the resulting indent is a mix of |
| 5653 tabs and spaces. You might not like this. | |
| 5654 NOTE: 'preserveindent' is reset when 'compatible' is set. | |
| 5655 Also see 'copyindent'. | |
| 5656 Use |:retab| to clean up white space. | |
| 5657 | |
| 5658 *'previewheight'* *'pvh'* | |
| 5659 'previewheight' 'pvh' number (default 12) | |
| 5660 global | |
| 5661 {not in Vi} | |
| 5662 {not available when compiled without the |+windows| or | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5663 |+quickfix| features} |
| 7 | 5664 Default height for a preview window. Used for |:ptag| and associated |
| 5665 commands. Used for |CTRL-W_}| when no count is given. | |
| 5666 | |
| 5667 *'previewwindow'* *'nopreviewwindow'* | |
| 5668 *'pvw'* *'nopvw'* *E590* | |
| 5669 'previewwindow' 'pvw' boolean (default off) | |
| 5670 local to window | |
| 5671 {not in Vi} | |
| 5672 {not available when compiled without the |+windows| or | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
5673 |+quickfix| features} |
| 10 | 5674 Identifies the preview window. Only one window can have this option |
| 7 | 5675 set. It's normally not set directly, but by using one of the commands |
| 5676 |:ptag|, |:pedit|, etc. | |
| 5677 | |
| 5678 *'printdevice'* *'pdev'* | |
| 5679 'printdevice' 'pdev' string (default empty) | |
| 5680 global | |
| 5681 {not in Vi} | |
| 5682 {only available when compiled with the |+printer| | |
| 5683 feature} | |
| 15 | 5684 The name of the printer to be used for |:hardcopy|. |
| 5685 See |pdev-option|. | |
| 36 | 5686 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 5687 security reasons. | |
| 15 | 5688 |
| 5689 *'printencoding'* *'penc'* | |
| 5690 'printencoding' 'penc' String (default empty, except for some systems) | |
| 7 | 5691 global |
| 5692 {not in Vi} | |
| 5693 {only available when compiled with the |+printer| | |
| 5694 and |+postscript| features} | |
| 15 | 5695 Sets the character encoding used when printing. |
| 5696 See |penc-option|. | |
| 7 | 5697 |
| 5698 *'printexpr'* *'pexpr'* | |
| 5699 'printexpr' 'pexpr' String (default: see below) | |
| 5700 global | |
| 5701 {not in Vi} | |
| 5702 {only available when compiled with the |+printer| | |
| 5703 and |+postscript| features} | |
| 15 | 5704 Expression used to print the PostScript produced with |:hardcopy|. |
| 5705 See |pexpr-option|. | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
5706 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
5707 security reasons. |
| 15 | 5708 |
| 5709 *'printfont'* *'pfn'* | |
| 7 | 5710 'printfont' 'pfn' string (default "courier") |
| 5711 global | |
| 5712 {not in Vi} | |
| 5713 {only available when compiled with the |+printer| | |
| 5714 feature} | |
| 15 | 5715 The name of the font that will be used for |:hardcopy|. |
| 5716 See |pfn-option|. | |
| 7 | 5717 |
| 5718 *'printheader'* *'pheader'* | |
| 5719 'printheader' 'pheader' string (default "%<%f%h%m%=Page %N") | |
| 5720 global | |
| 5721 {not in Vi} | |
| 5722 {only available when compiled with the |+printer| | |
| 5723 feature} | |
| 15 | 5724 The format of the header produced in |:hardcopy| output. |
| 5725 See |pheader-option|. | |
| 5726 | |
| 5727 *'printmbcharset'* *'pmbcs'* | |
| 5728 'printmbcharset' 'pmbcs' string (default "") | |
| 5729 global | |
| 5730 {not in Vi} | |
| 180 | 5731 {only available when compiled with the |+printer|, |
| 5732 |+postscript| and |+multi_byte| features} | |
| 15 | 5733 The CJK character set to be used for CJK output from |:hardcopy|. |
| 5734 See |pmbcs-option|. | |
| 5735 | |
| 5736 *'printmbfont'* *'pmbfn'* | |
| 5737 'printmbfont' 'pmbfn' string (default "") | |
| 5738 global | |
| 5739 {not in Vi} | |
| 180 | 5740 {only available when compiled with the |+printer|, |
| 5741 |+postscript| and |+multi_byte| features} | |
| 15 | 5742 List of font names to be used for CJK output from |:hardcopy|. |
| 5743 See |pmbfn-option|. | |
| 7 | 5744 |
| 5745 *'printoptions'* *'popt'* | |
| 5746 'printoptions' 'popt' string (default "") | |
| 5747 global | |
| 5748 {not in Vi} | |
| 5749 {only available when compiled with |+printer| feature} | |
| 15 | 5750 List of items that control the format of the output of |:hardcopy|. |
| 5751 See |popt-option|. | |
| 5752 | |
| 168 | 5753 *'prompt'* *'noprompt'* |
| 5754 'prompt' boolean (default on) | |
| 5755 global | |
| 5756 When on a ":" prompt is used in Ex mode. | |
| 5757 | |
| 766 | 5758 *'pumheight'* *'ph'* |
| 5759 'pumheight' 'ph' number (default 0) | |
| 5760 global | |
| 5761 {not available when compiled without the | |
| 5762 |+insert_expand| feature} | |
| 5763 {not in Vi} | |
| 853 | 5764 Determines the maximum number of items to show in the popup menu for |
| 5765 Insert mode completion. When zero as much space as available is used. | |
| 766 | 5766 |ins-completion-menu|. |
| 5767 | |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5768 *'pythondll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
5769 'pythondll' string (default depends on the build) |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5770 global |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5771 {not in Vi} |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5772 {only available when compiled with the |+python/dyn| |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5773 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5774 Specifies the name of the Python 2.x shared library. The default is |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5775 DYNAMIC_PYTHON_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5776 Environment variables are expanded |:set_env|. |
|
7228
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5777 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5778 security reasons. |
|
873eae260c97
commit https://github.com/vim/vim/commit/b4ff518d95aa57c2f8c0568c915035bef849581b
Christian Brabandt <cb@256bit.org>
parents:
7218
diff
changeset
|
5779 |
|
7218
36dc8df8560f
commit https://github.com/vim/vim/commit/0796c0625fa4b9eb2f47fe8c976b78523924e1fb
Christian Brabandt <cb@256bit.org>
parents:
7196
diff
changeset
|
5780 *'pythonthreedll'* |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5781 'pythonthreedll' string (default depends on the build) |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5782 global |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5783 {not in Vi} |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5784 {only available when compiled with the |+python3/dyn| |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5785 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5786 Specifies the name of the Python 3 shared library. The default is |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
5787 DYNAMIC_PYTHON3_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
5788 Environment variables are expanded |:set_env|. |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5789 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5790 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
5791 |
| 140 | 5792 *'quoteescape'* *'qe'* |
| 12 | 5793 'quoteescape' 'qe' string (default "\") |
| 5794 local to buffer | |
| 5795 {not in Vi} | |
| 5796 The characters that are used to escape quotes in a string. Used for | |
| 5797 objects like a', a" and a` |a'|. | |
| 5798 When one of the characters in this option is found inside a string, | |
| 5799 the following character will be skipped. The default value makes the | |
| 5800 text "foo\"bar\\" considered to be one string. | |
| 5801 | |
| 7 | 5802 *'readonly'* *'ro'* *'noreadonly'* *'noro'* |
| 5803 'readonly' 'ro' boolean (default off) | |
| 5804 local to buffer | |
| 5805 If on, writes fail unless you use a '!'. Protects you from | |
| 5806 accidentally overwriting a file. Default on when Vim is started | |
| 5807 in read-only mode ("vim -R") or when the executable is called "view". | |
| 164 | 5808 When using ":w!" the 'readonly' option is reset for the current |
| 5809 buffer, unless the 'Z' flag is in 'cpoptions'. | |
| 7 | 5810 {not in Vi:} When using the ":view" command the 'readonly' option is |
| 164 | 5811 set for the newly edited buffer. |
| 10617 | 5812 See 'modifiable' for disallowing changes to the buffer. |
| 7 | 5813 |
| 1521 | 5814 *'redrawtime'* *'rdt'* |
| 5815 'redrawtime' 'rdt' number (default 2000) | |
| 5816 global | |
| 5817 {not in Vi} | |
| 5818 {only available when compiled with the |+reltime| | |
| 5819 feature} | |
| 5820 The time in milliseconds for redrawing the display. This applies to | |
| 5821 searching for patterns for 'hlsearch' and |:match| highlighting. | |
| 5822 When redrawing takes more than this many milliseconds no further | |
| 5823 matches will be highlighted. This is used to avoid that Vim hangs | |
| 5824 when using a very complicated pattern. | |
| 5825 | |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
5826 *'regexpengine'* *'re'* |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5827 'regexpengine' 're' number (default 0) |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5828 global |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5829 {not in Vi} |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5830 This selects the default regexp engine. |two-engines| |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5831 The possible values are: |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5832 0 automatic selection |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5833 1 old engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5834 2 NFA engine |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5835 Note that when using the NFA engine and the pattern contains something |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5836 that is not supported the pattern will not match. This is only useful |
|
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5837 for debugging the regexp engine. |
| 6328 | 5838 Using automatic selection enables Vim to switch the engine, if the |
| 5839 default engine becomes too costly. E.g., when the NFA engine uses too | |
| 5840 many states. This should prevent Vim from hanging on a combination of | |
| 5841 a complex pattern with long text. | |
|
4502
605c9ce57ec3
Updated runtime files, language files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4358
diff
changeset
|
5842 |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5843 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'* |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5844 'relativenumber' 'rnu' boolean (default off) |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5845 local to window |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5846 {not in Vi} |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5847 Show the line number relative to the line with the cursor in front of |
|
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2204
diff
changeset
|
5848 each line. Relative line numbers help you use the |count| you can |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5849 precede some vertical motion commands (e.g. j k + -) with, without |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5850 having to calculate it yourself. Especially useful in combination with |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5851 other commands (e.g. y d c < > gq gw =). |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5852 When the 'n' option is excluded from 'cpoptions' a wrapped |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5853 line will not use the column of line numbers (this is the default when |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5854 'compatible' isn't set). |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5855 The 'numberwidth' option can be used to set the room used for the line |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5856 number. |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5857 When a long, wrapped line doesn't start with the first character, '-' |
|
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5858 characters are put before the number. |
| 3445 | 5859 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for |
| 5860 the number. | |
| 4780 | 5861 |
| 5862 The number in front of the cursor line also depends on the value of | |
| 5863 'number', see |number_relativenumber| for all combinations of the two | |
| 5864 options. | |
|
2178
c6f1aa1e9f32
Add 'relativenumber' patch from Markus Heidelberg.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
5865 |
| 7 | 5866 *'remap'* *'noremap'* |
| 5867 'remap' boolean (default on) | |
| 5868 global | |
| 5869 Allows for mappings to work recursively. If you do not want this for | |
| 5870 a single entry, use the :noremap[!] command. | |
| 717 | 5871 NOTE: To avoid portability problems with Vim scripts, always keep |
| 5872 this option at the default "on". Only switch it off when working with | |
| 5873 old Vi scripts. | |
| 7 | 5874 |
| 6110 | 5875 *'renderoptions'* *'rop'* |
| 5876 'renderoptions' 'rop' string (default: empty) | |
| 5877 global | |
| 5878 {not in Vi} | |
| 5879 {only available when compiled with GUI and DIRECTX on | |
| 5880 MS-Windows} | |
| 5881 Select a text renderer and set its options. The options depend on the | |
| 5882 renderer. | |
| 5883 | |
| 5884 Syntax: > | |
| 5885 set rop=type:{renderer}(,{name}:{value})* | |
| 5886 < | |
| 5887 Currently, only one optional renderer is available. | |
| 5888 | |
| 5889 render behavior ~ | |
| 5890 directx Vim will draw text using DirectX (DirectWrite). It makes | |
| 5891 drawn glyphs more beautiful than default GDI. | |
| 5892 It requires 'encoding' is "utf-8", and only works on | |
| 5893 MS-Windows Vista or newer version. | |
| 5894 | |
| 5895 Options: | |
| 5896 name meaning type value ~ | |
| 5897 gamma gamma float 1.0 - 2.2 (maybe) | |
| 5898 contrast enhancedContrast float (unknown) | |
| 5899 level clearTypeLevel float (unknown) | |
| 5900 geom pixelGeometry int 0 - 2 (see below) | |
| 5901 renmode renderingMode int 0 - 6 (see below) | |
| 5902 taamode textAntialiasMode int 0 - 3 (see below) | |
| 5903 | |
| 5904 See this URL for detail: | |
| 5905 http://msdn.microsoft.com/en-us/library/dd368190.aspx | |
| 5906 | |
| 5907 For geom: structure of a device pixel. | |
| 5908 0 - DWRITE_PIXEL_GEOMETRY_FLAT | |
| 5909 1 - DWRITE_PIXEL_GEOMETRY_RGB | |
| 5910 2 - DWRITE_PIXEL_GEOMETRY_BGR | |
| 5911 | |
| 5912 See this URL for detail: | |
| 5913 http://msdn.microsoft.com/en-us/library/dd368114.aspx | |
| 5914 | |
| 5915 For renmode: method of rendering glyphs. | |
| 5916 0 - DWRITE_RENDERING_MODE_DEFAULT | |
| 5917 1 - DWRITE_RENDERING_MODE_ALIASED | |
| 5918 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC | |
| 5919 3 - DWRITE_RENDERING_MODE_GDI_NATURAL | |
| 5920 4 - DWRITE_RENDERING_MODE_NATURAL | |
| 5921 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC | |
| 5922 6 - DWRITE_RENDERING_MODE_OUTLINE | |
| 5923 | |
| 5924 See this URL for detail: | |
| 5925 http://msdn.microsoft.com/en-us/library/dd368118.aspx | |
| 5926 | |
| 5927 For taamode: antialiasing mode used for drawing text. | |
| 5928 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT | |
| 5929 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE | |
| 5930 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE | |
| 5931 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED | |
| 5932 | |
| 5933 See this URL for detail: | |
| 5934 http://msdn.microsoft.com/en-us/library/dd368170.aspx | |
| 5935 | |
| 5936 Example: > | |
| 5937 set encoding=utf-8 | |
| 5938 set gfn=Ricty_Diminished:h12:cSHIFTJIS | |
| 5939 set rop=type:directx | |
| 5940 < | |
| 5941 If select a raster font (Courier, Terminal or FixedSys) to | |
| 5942 'guifont', it fallbacks to be drawn by GDI automatically. | |
| 5943 | |
| 5944 Other render types are currently not supported. | |
| 5945 | |
| 7 | 5946 *'report'* |
| 5947 'report' number (default 2) | |
| 5948 global | |
| 5949 Threshold for reporting number of lines changed. When the number of | |
| 5950 changed lines is more than 'report' a message will be given for most | |
| 5951 ":" commands. If you want it always, set 'report' to 0. | |
| 5952 For the ":substitute" command the number of substitutions is used | |
| 5953 instead of the number of lines. | |
| 5954 | |
| 5955 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* | |
| 5956 'restorescreen' 'rs' boolean (default on) | |
| 5957 global | |
| 5958 {not in Vi} {only in Windows 95/NT console version} | |
| 5959 When set, the screen contents is restored when exiting Vim. This also | |
| 5960 happens when executing external commands. | |
| 5961 | |
| 5962 For non-Windows Vim: You can set or reset the 't_ti' and 't_te' | |
| 5963 options in your .vimrc. To disable restoring: | |
| 5964 set t_ti= t_te= | |
| 5965 To enable restoring (for an xterm): | |
| 5966 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8 | |
| 5967 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it) | |
| 5968 | |
| 5969 *'revins'* *'ri'* *'norevins'* *'nori'* | |
| 5970 'revins' 'ri' boolean (default off) | |
| 5971 global | |
| 5972 {not in Vi} | |
| 5973 {only available when compiled with the |+rightleft| | |
| 5974 feature} | |
| 5975 Inserting characters in Insert mode will work backwards. See "typing | |
| 5976 backwards" |ins-reverse|. This option can be toggled with the CTRL-_ | |
| 5977 command in Insert mode, when 'allowrevins' is set. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5978 NOTE: This option is reset when 'compatible' is set. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5979 This option is reset when 'paste' is set and restored when 'paste' is |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
5980 reset. |
| 7 | 5981 |
| 5982 *'rightleft'* *'rl'* *'norightleft'* *'norl'* | |
| 5983 'rightleft' 'rl' boolean (default off) | |
| 5984 local to window | |
| 5985 {not in Vi} | |
| 5986 {only available when compiled with the |+rightleft| | |
| 5987 feature} | |
| 5988 When on, display orientation becomes right-to-left, i.e., characters | |
| 5989 that are stored in the file appear from the right to the left. | |
| 5990 Using this option, it is possible to edit files for languages that | |
| 5991 are written from the right to the left such as Hebrew and Arabic. | |
| 5992 This option is per window, so it is possible to edit mixed files | |
| 5993 simultaneously, or to view the same file in both ways (this is | |
| 5994 useful whenever you have a mixed text file with both right-to-left | |
| 5995 and left-to-right strings so that both sets are displayed properly | |
| 5996 in different windows). Also see |rileft.txt|. | |
| 5997 | |
| 2341 | 5998 *'rightleftcmd'* *'rlc'* |
| 7 | 5999 'rightleftcmd' 'rlc' string (default "search") |
| 6000 local to window | |
| 6001 {not in Vi} | |
| 6002 {only available when compiled with the |+rightleft| | |
| 6003 feature} | |
| 6004 Each word in this option enables the command line editing to work in | |
| 6005 right-to-left mode for a group of commands: | |
| 6006 | |
| 6007 search "/" and "?" commands | |
| 6008 | |
| 6009 This is useful for languages such as Hebrew, Arabic and Farsi. | |
| 6010 The 'rightleft' option must be set for 'rightleftcmd' to take effect. | |
| 6011 | |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6012 *'rubydll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
6013 'rubydll' string (default: depends on the build) |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6014 global |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6015 {not in Vi} |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6016 {only available when compiled with the |+ruby/dyn| |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6017 feature} |
|
7528
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6018 Specifies the name of the Ruby shared library. The default is |
|
53163e4d9e4f
commit https://github.com/vim/vim/commit/25e4fcde767084d1a79e0926bc301c92987c0cce
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
6019 DYNAMIC_RUBY_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
6020 Environment variables are expanded |:set_env|. |
|
7196
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6021 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6022 security reasons. |
|
42717d048817
commit https://github.com/vim/vim/commit/d94464ee294a351ce7b6ba18e8bd3f24f1bef920
Christian Brabandt <cb@256bit.org>
parents:
7147
diff
changeset
|
6023 |
| 7 | 6024 *'ruler'* *'ru'* *'noruler'* *'noru'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6025 'ruler' 'ru' boolean (default off, set in |defaults.vim|) |
| 7 | 6026 global |
| 6027 {not in Vi} | |
| 6028 {not available when compiled without the | |
| 6029 |+cmdline_info| feature} | |
| 6030 Show the line and column number of the cursor position, separated by a | |
| 10 | 6031 comma. When there is room, the relative position of the displayed |
| 7 | 6032 text in the file is shown on the far right: |
| 6033 Top first line is visible | |
| 6034 Bot last line is visible | |
| 6035 All first and last line are visible | |
| 6036 45% relative position in the file | |
| 6037 If 'rulerformat' is set, it will determine the contents of the ruler. | |
| 10 | 6038 Each window has its own ruler. If a window has a status line, the |
| 7 | 6039 ruler is shown there. Otherwise it is shown in the last line of the |
| 233 | 6040 screen. If the statusline is given by 'statusline' (i.e. not empty), |
| 7 | 6041 this option takes precedence over 'ruler' and 'rulerformat' |
| 6042 If the number of characters displayed is different from the number of | |
| 6043 bytes in the text (e.g., for a TAB or a multi-byte character), both | |
| 6044 the text column (byte number) and the screen column are shown, | |
| 6045 separated with a dash. | |
| 6046 For an empty line "0-1" is shown. | |
| 6047 For an empty buffer the line number will also be zero: "0,0-1". | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6048 This option is reset when 'paste' is set and restored when 'paste' is |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6049 reset. |
| 7 | 6050 If you don't want to see the ruler all the time but want to know where |
| 6051 you are, use "g CTRL-G" |g_CTRL-G|. | |
| 6052 NOTE: This option is reset when 'compatible' is set. | |
| 6053 | |
| 6054 *'rulerformat'* *'ruf'* | |
| 6055 'rulerformat' 'ruf' string (default empty) | |
| 6056 global | |
| 6057 {not in Vi} | |
| 6058 {not available when compiled without the |+statusline| | |
| 6059 feature} | |
| 6060 When this option is not empty, it determines the content of the ruler | |
| 6061 string, as displayed for the 'ruler' option. | |
| 692 | 6062 The format of this option is like that of 'statusline'. |
| 7 | 6063 The default ruler width is 17 characters. To make the ruler 15 |
| 6064 characters wide, put "%15(" at the start and "%)" at the end. | |
| 6065 Example: > | |
| 6066 :set rulerformat=%15(%c%V\ %p%%%) | |
| 6067 < | |
| 6068 *'runtimepath'* *'rtp'* *vimfiles* | |
| 6069 'runtimepath' 'rtp' string (default: | |
| 6070 Unix: "$HOME/.vim, | |
| 6071 $VIM/vimfiles, | |
| 6072 $VIMRUNTIME, | |
| 6073 $VIM/vimfiles/after, | |
| 6074 $HOME/.vim/after" | |
| 6075 Amiga: "home:vimfiles, | |
| 6076 $VIM/vimfiles, | |
| 6077 $VIMRUNTIME, | |
| 6078 $VIM/vimfiles/after, | |
| 6079 home:vimfiles/after" | |
| 6080 PC, OS/2: "$HOME/vimfiles, | |
| 6081 $VIM/vimfiles, | |
| 6082 $VIMRUNTIME, | |
| 6083 $VIM/vimfiles/after, | |
| 6084 $HOME/vimfiles/after" | |
| 6085 Macintosh: "$VIM:vimfiles, | |
| 6086 $VIMRUNTIME, | |
| 6087 $VIM:vimfiles:after" | |
| 6088 RISC-OS: "Choices:vimfiles, | |
| 6089 $VIMRUNTIME, | |
| 6090 Choices:vimfiles/after" | |
| 6091 VMS: "sys$login:vimfiles, | |
| 6092 $VIM/vimfiles, | |
| 6093 $VIMRUNTIME, | |
| 6094 $VIM/vimfiles/after, | |
| 233 | 6095 sys$login:vimfiles/after") |
| 7 | 6096 global |
| 6097 {not in Vi} | |
| 6098 This is a list of directories which will be searched for runtime | |
| 6099 files: | |
| 6100 filetype.vim filetypes by file name |new-filetype| | |
| 6101 scripts.vim filetypes by file contents |new-filetype-scripts| | |
| 164 | 6102 autoload/ automatically loaded scripts |autoload-functions| |
| 7 | 6103 colors/ color scheme files |:colorscheme| |
| 6104 compiler/ compiler files |:compiler| | |
| 6105 doc/ documentation |write-local-help| | |
| 6106 ftplugin/ filetype plugins |write-filetype-plugin| | |
| 6107 indent/ indent scripts |indent-expression| | |
| 6108 keymap/ key mapping files |mbyte-keymap| | |
| 6109 lang/ menu translations |:menutrans| | |
| 6110 menu.vim GUI menus |menu.vim| | |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6111 pack/ packages |:packadd| |
| 7 | 6112 plugin/ plugin scripts |write-plugin| |
| 6113 print/ files for printing |postscript-print-encoding| | |
| 650 | 6114 spell/ spell checking files |spell| |
| 7 | 6115 syntax/ syntax files |mysyntaxfile| |
| 6116 tutor/ files for vimtutor |tutor| | |
| 6117 | |
| 6118 And any other file searched for with the |:runtime| command. | |
| 6119 | |
| 6120 The defaults for most systems are setup to search five locations: | |
| 6121 1. In your home directory, for your personal preferences. | |
| 6122 2. In a system-wide Vim directory, for preferences from the system | |
| 6123 administrator. | |
| 6124 3. In $VIMRUNTIME, for files distributed with Vim. | |
| 6125 *after-directory* | |
| 6126 4. In the "after" directory in the system-wide Vim directory. This is | |
| 6127 for the system administrator to overrule or add to the distributed | |
| 6128 defaults (rarely needed) | |
| 6129 5. In the "after" directory in your home directory. This is for | |
| 6130 personal preferences to overrule or add to the distributed defaults | |
| 6131 or system-wide settings (rarely needed). | |
| 6132 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6133 More entries are added when using |packages|. If it gets very long |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6134 then `:set rtp` will be truncated, use `:echo &rtp` to see the full |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
6135 string. |
|
9116
bc38030aec7d
commit https://github.com/vim/vim/commit/26852128a2b713ef49341a0c18daba928444e7eb
Christian Brabandt <cb@256bit.org>
parents:
9098
diff
changeset
|
6136 |
| 7 | 6137 Note that, unlike 'path', no wildcards like "**" are allowed. Normal |
| 6138 wildcards are allowed, but can significantly slow down searching for | |
| 10 | 6139 runtime files. For speed, use as few items as possible and avoid |
| 7 | 6140 wildcards. |
| 6141 See |:runtime|. | |
| 6142 Example: > | |
| 6143 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME | |
| 6144 < This will use the directory "~/vimruntime" first (containing your | |
| 6145 personal Vim runtime files), then "/mygroup/vim" (shared between a | |
| 6146 group of people) and finally "$VIMRUNTIME" (the distributed runtime | |
| 6147 files). | |
| 6148 You probably should always include $VIMRUNTIME somewhere, to use the | |
| 6149 distributed runtime files. You can put a directory before $VIMRUNTIME | |
| 6150 to find files which replace a distributed runtime files. You can put | |
| 6151 a directory after $VIMRUNTIME to find files which add to distributed | |
| 6152 runtime files. | |
| 6153 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6154 security reasons. | |
| 6155 | |
| 6156 *'scroll'* *'scr'* | |
| 6157 'scroll' 'scr' number (default: half the window height) | |
| 6158 local to window | |
| 6159 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be | |
| 6160 set to half the number of lines in the window when the window size | |
| 6161 changes. If you give a count to the CTRL-U or CTRL-D command it will | |
| 10 | 6162 be used as the new value for 'scroll'. Reset to half the window |
| 7 | 6163 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives |
| 6164 the number of screen lines instead of file lines, makes a difference | |
| 6165 when lines wrap} | |
| 6166 | |
| 6167 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'* | |
| 6168 'scrollbind' 'scb' boolean (default off) | |
| 6169 local to window | |
| 6170 {not in Vi} | |
| 6171 {not available when compiled without the |+scrollbind| | |
| 6172 feature} | |
| 6173 See also |scroll-binding|. When this option is set, the current | |
| 6174 window scrolls as other scrollbind windows (windows that also have | |
| 6175 this option set) scroll. This option is useful for viewing the | |
| 6176 differences between two versions of a file, see 'diff'. | |
| 6177 See |'scrollopt'| for options that determine how this option should be | |
| 6178 interpreted. | |
| 6179 This option is mostly reset when splitting a window to edit another | |
| 6180 file. This means that ":split | edit file" results in two windows | |
| 6181 with scroll-binding, but ":split file" does not. | |
| 6182 | |
| 6183 *'scrolljump'* *'sj'* | |
| 6184 'scrolljump' 'sj' number (default 1) | |
| 6185 global | |
| 6186 {not in Vi} | |
| 6187 Minimal number of lines to scroll when the cursor gets off the | |
| 6188 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E, | |
| 6189 CTRL-D). Useful if your terminal scrolls very slowly. | |
| 532 | 6190 When set to a negative number from -1 to -100 this is used as the |
| 6191 percentage of the window height. Thus -50 scrolls half the window | |
| 6192 height. | |
| 7 | 6193 NOTE: This option is set to 1 when 'compatible' is set. |
| 6194 | |
| 6195 *'scrolloff'* *'so'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
6196 'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|) |
| 7 | 6197 global |
| 6198 {not in Vi} | |
| 6199 Minimal number of screen lines to keep above and below the cursor. | |
| 6200 This will make some context visible around where you are working. If | |
| 6201 you set it to a very large value (999) the cursor line will always be | |
| 6202 in the middle of the window (except at the start or end of the file or | |
| 6203 when long lines wrap). | |
| 6204 For scrolling horizontally see 'sidescrolloff'. | |
| 6205 NOTE: This option is set to 0 when 'compatible' is set. | |
| 6206 | |
| 6207 *'scrollopt'* *'sbo'* | |
| 6208 'scrollopt' 'sbo' string (default "ver,jump") | |
| 6209 global | |
| 6210 {not available when compiled without the |+scrollbind| | |
| 6211 feature} | |
| 6212 {not in Vi} | |
| 6213 This is a comma-separated list of words that specifies how | |
| 236 | 6214 'scrollbind' windows should behave. 'sbo' stands for ScrollBind |
| 6215 Options. | |
| 7 | 6216 The following words are available: |
| 6217 ver Bind vertical scrolling for 'scrollbind' windows | |
| 6218 hor Bind horizontal scrolling for 'scrollbind' windows | |
| 6219 jump Applies to the offset between two windows for vertical | |
| 6220 scrolling. This offset is the difference in the first | |
| 6221 displayed line of the bound windows. When moving | |
| 6222 around in a window, another 'scrollbind' window may | |
| 6223 reach a position before the start or after the end of | |
| 6224 the buffer. The offset is not changed though, when | |
| 6225 moving back the 'scrollbind' window will try to scroll | |
| 6226 to the desired position when possible. | |
| 6227 When now making that window the current one, two | |
| 6228 things can be done with the relative offset: | |
| 6229 1. When "jump" is not included, the relative offset is | |
| 6230 adjusted for the scroll position in the new current | |
| 6231 window. When going back to the other window, the | |
| 1152 | 6232 new relative offset will be used. |
| 7 | 6233 2. When "jump" is included, the other windows are |
| 6234 scrolled to keep the same relative offset. When | |
| 6235 going back to the other window, it still uses the | |
| 6236 same relative offset. | |
| 6237 Also see |scroll-binding|. | |
| 819 | 6238 When 'diff' mode is active there always is vertical scroll binding, |
| 6239 even when "ver" isn't there. | |
| 7 | 6240 |
| 6241 *'sections'* *'sect'* | |
| 6242 'sections' 'sect' string (default "SHNHH HUnhsh") | |
| 6243 global | |
| 6244 Specifies the nroff macros that separate sections. These are pairs of | |
| 6245 two letters (See |object-motions|). The default makes a section start | |
| 6246 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh". | |
| 6247 | |
| 6248 *'secure'* *'nosecure'* *E523* | |
| 6249 'secure' boolean (default off) | |
| 6250 global | |
| 6251 {not in Vi} | |
| 6252 When on, ":autocmd", shell and write commands are not allowed in | |
| 6253 ".vimrc" and ".exrc" in the current directory and map commands are | |
| 6254 displayed. Switch it off only if you know that you will not run into | |
| 6255 problems, or when the 'exrc' option is off. On Unix this option is | |
| 6256 only used if the ".vimrc" or ".exrc" is not owned by you. This can be | |
| 10 | 6257 dangerous if the systems allows users to do a "chown". You better set |
| 7 | 6258 'secure' at the end of your ~/.vimrc then. |
| 6259 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6260 security reasons. | |
| 6261 | |
| 6262 *'selection'* *'sel'* | |
| 6263 'selection' 'sel' string (default "inclusive") | |
| 6264 global | |
| 6265 {not in Vi} | |
| 6266 This option defines the behavior of the selection. It is only used | |
| 6267 in Visual and Select mode. | |
| 6268 Possible values: | |
| 6269 value past line inclusive ~ | |
| 6270 old no yes | |
| 6271 inclusive yes yes | |
| 6272 exclusive yes no | |
| 6273 "past line" means that the cursor is allowed to be positioned one | |
| 6274 character past the line. | |
| 6275 "inclusive" means that the last character of the selection is included | |
| 6276 in an operation. For example, when "x" is used to delete the | |
| 6277 selection. | |
|
9975
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6278 When "old" is used and 'virtualedit' allows the cursor to move past |
|
03fa8a51e9dc
commit https://github.com/vim/vim/commit/e4a3bcf28d92d0bde9ca227ccb40d401038185e5
Christian Brabandt <cb@256bit.org>
parents:
9913
diff
changeset
|
6279 the end of line the line break still isn't included. |
| 7 | 6280 Note that when "exclusive" is used and selecting from the end |
| 6281 backwards, you cannot include the last character of a line, when | |
| 6282 starting in Normal mode and 'virtualedit' empty. | |
| 6283 | |
| 6284 The 'selection' option is set by the |:behave| command. | |
| 6285 | |
| 6286 *'selectmode'* *'slm'* | |
| 6287 'selectmode' 'slm' string (default "") | |
| 6288 global | |
| 6289 {not in Vi} | |
| 6290 This is a comma separated list of words, which specifies when to start | |
| 6291 Select mode instead of Visual mode, when a selection is started. | |
| 6292 Possible values: | |
| 6293 mouse when using the mouse | |
| 6294 key when using shifted special keys | |
| 6295 cmd when using "v", "V" or CTRL-V | |
| 6296 See |Select-mode|. | |
| 6297 The 'selectmode' option is set by the |:behave| command. | |
| 6298 | |
| 6299 *'sessionoptions'* *'ssop'* | |
| 6300 'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds, | |
| 827 | 6301 help,options,tabpages,winsize") |
| 7 | 6302 global |
| 6303 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6304 {not available when compiled without the |+mksession| |
| 7 | 6305 feature} |
| 6306 Changes the effect of the |:mksession| command. It is a comma | |
| 6307 separated list of words. Each word enables saving and restoring | |
| 6308 something: | |
| 6309 word save and restore ~ | |
| 6310 blank empty windows | |
| 6311 buffers hidden and unloaded buffers, not just those in windows | |
| 6312 curdir the current directory | |
| 6313 folds manually created folds, opened/closed folds and local | |
| 6314 fold options | |
| 6315 globals global variables that start with an uppercase letter | |
| 75 | 6316 and contain at least one lowercase letter. Only |
| 6317 String and Number types are stored. | |
| 7 | 6318 help the help window |
| 6319 localoptions options and mappings local to a window or buffer (not | |
| 6320 global values for local options) | |
| 6321 options all options and mappings (also global values for local | |
| 6322 options) | |
| 6323 resize size of the Vim window: 'lines' and 'columns' | |
| 6324 sesdir the directory in which the session file is located | |
| 6325 will become the current directory (useful with | |
| 6326 projects accessed over a network from different | |
| 6327 systems) | |
| 6328 slash backslashes in file names replaced with forward | |
| 6329 slashes | |
| 827 | 6330 tabpages all tab pages; without this only the current tab page |
| 6331 is restored, so that you can make a session for each | |
| 6332 tab page separately | |
| 7 | 6333 unix with Unix end-of-line format (single <NL>), even when |
| 6334 on Windows or DOS | |
| 6335 winpos position of the whole Vim window | |
| 6336 winsize window sizes | |
| 6337 | |
| 6338 Don't include both "curdir" and "sesdir". | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6339 When neither "curdir" nor "sesdir" is included, file names are stored |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6340 with absolute paths. |
| 7 | 6341 "slash" and "unix" are useful on Windows when sharing session files |
| 6342 with Unix. The Unix version of Vim cannot source dos format scripts, | |
| 6343 but the Windows version of Vim can source unix format scripts. | |
| 6344 | |
| 6345 *'shell'* *'sh'* *E91* | |
| 6346 'shell' 'sh' string (default $SHELL or "sh", | |
| 6347 MS-DOS and Win32: "command.com" or | |
| 6348 "cmd.exe", OS/2: "cmd") | |
| 6349 global | |
| 6350 Name of the shell to use for ! and :! commands. When changing the | |
| 6351 value also check these options: 'shelltype', 'shellpipe', 'shellslash' | |
| 6352 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'. | |
| 10 | 6353 It is allowed to give an argument to the command, e.g. "csh -f". |
| 7 | 6354 See |option-backslash| about including spaces and backslashes. |
| 6355 Environment variables are expanded |:set_env|. | |
| 6356 If the name of the shell contains a space, you might need to enclose | |
| 6357 it in quotes. Example: > | |
| 6358 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f | |
| 6359 < Note the backslash before each quote (to avoid starting a comment) and | |
| 10 | 6360 each space (to avoid ending the option value). Also note that the |
| 7 | 6361 "-f" is not inside the quotes, because it is not part of the command |
| 6362 name. And Vim automagically recognizes the backslashes that are path | |
| 6363 separators. | |
| 6364 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment | |
| 6365 variable to change the way external commands are executed. See the | |
| 6366 libc.inf file of DJGPP. | |
| 6367 Under MS-Windows, when the executable ends in ".com" it must be | |
| 6368 included. Thus setting the shell to "command.com" or "4dos.com" | |
| 6369 works, but "command" and "4dos" do not work for all commands (e.g., | |
| 6370 filtering). | |
| 6371 For unknown reasons, when using "4dos.com" the current directory is | |
| 6372 changed to "C:\". To avoid this set 'shell' like this: > | |
| 6373 :set shell=command.com\ /c\ 4dos | |
| 6374 < This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6375 security reasons. | |
| 6376 | |
| 6377 *'shellcmdflag'* *'shcf'* | |
| 3356 | 6378 'shellcmdflag' 'shcf' string (default: "-c"; |
| 3371 | 6379 MS-DOS and Win32, when 'shell' does not |
| 6380 contain "sh" somewhere: "/c") | |
| 7 | 6381 global |
| 6382 {not in Vi} | |
| 6383 Flag passed to the shell to execute "!" and ":!" commands; e.g., | |
| 6384 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like | |
| 6385 systems, the default is set according to the value of 'shell', to | |
| 6386 reduce the need to set this option by the user. It's not used for | |
| 3082 | 6387 OS/2 (EMX figures this out itself). |
| 6388 On Unix it can have more than one flag. Each white space separated | |
| 6389 part is passed as an argument to the shell command. | |
| 6390 See |option-backslash| about including spaces and backslashes. | |
| 6391 Also see |dos-shell| for MS-DOS and MS-Windows. | |
| 7 | 6392 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6393 security reasons. | |
| 6394 | |
| 6395 *'shellpipe'* *'sp'* | |
| 6396 'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee") | |
| 6397 global | |
| 6398 {not in Vi} | |
| 6399 {not available when compiled without the |+quickfix| | |
| 6400 feature} | |
| 6401 String to be used to put the output of the ":make" command in the | |
| 10 | 6402 error file. See also |:make_makeprg|. See |option-backslash| about |
| 7 | 6403 including spaces and backslashes. |
| 6404 The name of the temporary file can be represented by "%s" if necessary | |
| 6405 (the file name is appended automatically if no %s appears in the value | |
| 6406 of this option). | |
| 6407 For the Amiga and MS-DOS the default is ">". The output is directly | |
| 6408 saved in a file and not echoed to the screen. | |
| 6409 For Unix the default it "| tee". The stdout of the compiler is saved | |
| 6410 in a file and echoed to the screen. If the 'shell' option is "csh" or | |
| 6411 "tcsh" after initializations, the default becomes "|& tee". If the | |
| 2788 | 6412 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the |
| 6413 default becomes "2>&1| tee". This means that stderr is also included. | |
| 6414 Before using the 'shell' option a path is removed, thus "/bin/sh" uses | |
| 6415 "sh". | |
| 7 | 6416 The initialization of this option is done after reading the ".vimrc" |
| 6417 and the other initializations, so that when the 'shell' option is set | |
| 6418 there, the 'shellpipe' option changes automatically, unless it was | |
| 6419 explicitly set before. | |
| 6420 When 'shellpipe' is set to an empty string, no redirection of the | |
| 6421 ":make" output will be done. This is useful if you use a 'makeprg' | |
| 6422 that writes to 'makeef' by itself. If you want no piping, but do | |
| 6423 want to include the 'makeef', set 'shellpipe' to a single space. | |
| 6424 Don't forget to precede the space with a backslash: ":set sp=\ ". | |
| 6425 In the future pipes may be used for filtering and this option will | |
| 6426 become obsolete (at least for Unix). | |
| 6427 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6428 security reasons. | |
| 6429 | |
| 6430 *'shellquote'* *'shq'* | |
| 6431 'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell' | |
| 6432 contains "sh" somewhere: "\"") | |
| 6433 global | |
| 6434 {not in Vi} | |
| 6435 Quoting character(s), put around the command passed to the shell, for | |
| 6436 the "!" and ":!" commands. The redirection is kept outside of the | |
| 6437 quoting. See 'shellxquote' to include the redirection. It's | |
| 6438 probably not useful to set both options. | |
| 6439 This is an empty string by default. Only known to be useful for | |
| 6440 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell | |
| 6441 or bash, where it should be "\"". The default is adjusted according | |
| 6442 the value of 'shell', to reduce the need to set this option by the | |
| 6443 user. See |dos-shell|. | |
| 6444 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6445 security reasons. | |
| 6446 | |
| 6447 *'shellredir'* *'srr'* | |
| 6448 'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1") | |
| 6449 global | |
| 6450 {not in Vi} | |
| 6451 String to be used to put the output of a filter command in a temporary | |
| 6452 file. See also |:!|. See |option-backslash| about including spaces | |
| 6453 and backslashes. | |
| 6454 The name of the temporary file can be represented by "%s" if necessary | |
| 6455 (the file name is appended automatically if no %s appears in the value | |
| 6456 of this option). | |
| 6457 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh" | |
| 6458 or "zsh" during initializations, the default becomes ">&". If the | |
| 6459 'shell' option is "sh", "ksh" or "bash" the default becomes | |
| 6460 ">%s 2>&1". This means that stderr is also included. | |
| 6461 For Win32, the Unix checks are done and additionally "cmd" is checked | |
| 6462 for, which makes the default ">%s 2>&1". Also, the same names with | |
| 6463 ".exe" appended are checked for. | |
| 6464 The initialization of this option is done after reading the ".vimrc" | |
| 6465 and the other initializations, so that when the 'shell' option is set | |
| 6466 there, the 'shellredir' option changes automatically unless it was | |
| 6467 explicitly set before. | |
| 6468 In the future pipes may be used for filtering and this option will | |
| 6469 become obsolete (at least for Unix). | |
| 6470 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 6471 security reasons. | |
| 6472 | |
| 6473 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'* | |
| 6474 'shellslash' 'ssl' boolean (default off) | |
| 6475 global | |
| 6476 {not in Vi} {only for MSDOS, MS-Windows and OS/2} | |
| 6477 When set, a forward slash is used when expanding file names. This is | |
| 6478 useful when a Unix-like shell is used instead of command.com or | |
| 6479 cmd.exe. Backward slashes can still be typed, but they are changed to | |
| 6480 forward slashes by Vim. | |
| 6481 Note that setting or resetting this option has no effect for some | |
| 6482 existing file names, thus this option needs to be set before opening | |
| 6483 any file for best results. This might change in the future. | |
| 6484 'shellslash' only works when a backslash can be used as a path | |
| 6485 separator. To test if this is so use: > | |
| 6486 if exists('+shellslash') | |
| 6487 < | |
| 168 | 6488 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'* |
| 6489 'shelltemp' 'stmp' boolean (Vi default off, Vim default on) | |
| 6490 global | |
| 6491 {not in Vi} | |
| 6492 When on, use temp files for shell commands. When off use a pipe. | |
| 6493 When using a pipe is not possible temp files are used anyway. | |
| 2965 | 6494 Currently a pipe is only supported on Unix and MS-Windows 2K and |
| 6495 later. You can check it with: > | |
| 168 | 6496 :if has("filterpipe") |
| 6497 < The advantage of using a pipe is that nobody can read the temp file | |
| 6498 and the 'shell' command does not need to support redirection. | |
| 6499 The advantage of using a temp file is that the file type and encoding | |
| 6500 can be detected. | |
| 6501 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|, | |
| 6502 |FilterWritePost| autocommands event are not triggered when | |
| 6503 'shelltemp' is off. | |
|
9533
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6504 The `system()` function does not respect this option and always uses |
|
9f921133ee90
commit https://github.com/vim/vim/commit/269f595f9eef584937e7eae70fde68cdd7da5bcf
Christian Brabandt <cb@256bit.org>
parents:
9464
diff
changeset
|
6505 temp files. |
| 168 | 6506 |
| 7 | 6507 *'shelltype'* *'st'* |
| 6508 'shelltype' 'st' number (default 0) | |
| 6509 global | |
| 6510 {not in Vi} {only for the Amiga} | |
| 6511 On the Amiga this option influences the way how the commands work | |
| 6512 which use a shell. | |
| 6513 0 and 1: always use the shell | |
| 6514 2 and 3: use the shell only to filter lines | |
| 6515 4 and 5: use shell only for ':sh' command | |
| 6516 When not using the shell, the command is executed directly. | |
| 6517 | |
| 6518 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands | |
| 6519 1 and 3: use "shell cmd" to start external commands | |
| 6520 | |
| 3371 | 6521 *'shellxescape'* *'sxe'* |
| 6522 'shellxescape' 'sxe' string (default: ""; | |
| 6523 for MS-DOS and MS-Windows: "\"&|<>()@^") | |
| 6524 global | |
| 6525 {not in Vi} | |
| 6526 When 'shellxquote' is set to "(" then the characters listed in this | |
| 6527 option will be escaped with a '^' character. This makes it possible | |
| 6528 to execute most external commands with cmd.exe. | |
| 6529 | |
| 7 | 6530 *'shellxquote'* *'sxq'* |
| 6531 'shellxquote' 'sxq' string (default: ""; | |
| 3359 | 6532 for Win32, when 'shell' is cmd.exe: "(" |
| 6533 for Win32, when 'shell' contains "sh" | |
| 6534 somewhere: "\"" | |
| 7 | 6535 for Unix, when using system(): "\"") |
| 6536 global | |
| 6537 {not in Vi} | |
| 6538 Quoting character(s), put around the command passed to the shell, for | |
| 6539 the "!" and ":!" commands. Includes the redirection. See | |
| 6540 'shellquote' to exclude the redirection. It's probably not useful | |
| 6541 to set both options. | |
| 3359 | 6542 When the value is '(' then ')' is appended. When the value is '"(' |
| 6543 then ')"' is appended. | |
| 6544 When the value is '(' then also see 'shellxescape'. | |
| 3352 | 6545 This is an empty string by default on most systems, but is known to be |
| 6546 useful for on Win32 version, either for cmd.exe which automatically | |
| 6547 strips off the first and last quote on a command, or 3rd-party shells | |
| 6548 such as the MKS Korn Shell or bash, where it should be "\"". The | |
| 6549 default is adjusted according the value of 'shell', to reduce the need | |
| 6550 to set this option by the user. See |dos-shell|. | |
| 7 | 6551 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6552 security reasons. | |
| 6553 | |
| 6554 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'* | |
| 6555 'shiftround' 'sr' boolean (default off) | |
| 6556 global | |
| 6557 {not in Vi} | |
| 6558 Round indent to multiple of 'shiftwidth'. Applies to > and < | |
| 6559 commands. CTRL-T and CTRL-D in Insert mode always round the indent to | |
| 6560 a multiple of 'shiftwidth' (this is Vi compatible). | |
| 6561 NOTE: This option is reset when 'compatible' is set. | |
| 6562 | |
| 6563 *'shiftwidth'* *'sw'* | |
| 6564 'shiftwidth' 'sw' number (default 8) | |
| 6565 local to buffer | |
| 10 | 6566 Number of spaces to use for each step of (auto)indent. Used for |
| 7 | 6567 |'cindent'|, |>>|, |<<|, etc. |
| 3893 | 6568 When zero the 'ts' value will be used. Use the |shiftwidth()| |
| 6569 function to get the effective shiftwidth value. | |
| 7 | 6570 |
| 6571 *'shortmess'* *'shm'* | |
| 168 | 6572 'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "", |
| 6573 POSIX default: "A") | |
| 7 | 6574 global |
| 6575 {not in Vi} | |
| 6576 This option helps to avoid all the |hit-enter| prompts caused by file | |
| 6577 messages, for example with CTRL-G, and to avoid some other messages. | |
| 6578 It is a list of flags: | |
| 6579 flag meaning when present ~ | |
| 6580 f use "(3 of 5)" instead of "(file 3 of 5)" | |
| 6581 i use "[noeol]" instead of "[Incomplete last line]" | |
| 6582 l use "999L, 888C" instead of "999 lines, 888 characters" | |
| 6583 m use "[+]" instead of "[Modified]" | |
| 6584 n use "[New]" instead of "[New File]" | |
| 6585 r use "[RO]" instead of "[readonly]" | |
| 6586 w use "[w]" instead of "written" for file write message | |
| 6587 and "[a]" instead of "appended" for ':w >> file' command | |
| 6588 x use "[dos]" instead of "[dos format]", "[unix]" instead of | |
| 6589 "[unix format]" and "[mac]" instead of "[mac format]". | |
| 6590 a all of the above abbreviations | |
| 6591 | |
| 6592 o overwrite message for writing a file with subsequent message | |
| 6593 for reading a file (useful for ":wn" or when 'autowrite' on) | |
| 6594 O message for reading a file overwrites any previous message. | |
| 6595 Also for quickfix message (e.g., ":cn"). | |
| 6596 s don't give "search hit BOTTOM, continuing at TOP" or "search | |
| 6597 hit TOP, continuing at BOTTOM" messages | |
| 6598 t truncate file message at the start if it is too long to fit | |
| 6599 on the command-line, "<" will appear in the left most column. | |
| 6600 Ignored in Ex mode. | |
| 6601 T truncate other messages in the middle if they are too long to | |
| 233 | 6602 fit on the command line. "..." will appear in the middle. |
| 7 | 6603 Ignored in Ex mode. |
| 6604 W don't give "written" or "[w]" when writing a file | |
| 6605 A don't give the "ATTENTION" message when an existing swap file | |
| 6606 is found. | |
| 6607 I don't give the intro message when starting Vim |:intro|. | |
| 5946 | 6608 c don't give |ins-completion-menu| messages. For example, |
| 6609 "-- XXX completion (YYY)", "match 1 of 2", "The only match", | |
| 6610 "Pattern not found", "Back at original", etc. | |
|
8560
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
6611 q use "recording" instead of "recording @a" |
|
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
6612 F don't give the file info when editing a file, like `:silent` |
|
f3c636c673f7
commit https://github.com/vim/vim/commit/426dd0219512af5f4abeb0901b533159253ffba3
Christian Brabandt <cb@256bit.org>
parents:
8497
diff
changeset
|
6613 was used for the command |
| 7 | 6614 |
| 6615 This gives you the opportunity to avoid that a change between buffers | |
| 6616 requires you to hit <Enter>, but still gives as useful a message as | |
| 6617 possible for the space available. To get the whole message that you | |
| 6618 would have got with 'shm' empty, use ":file!" | |
| 6619 Useful values: | |
| 6620 shm= No abbreviation of message. | |
| 6621 shm=a Abbreviation, but no loss of information. | |
| 6622 shm=at Abbreviation, and truncate message when necessary. | |
| 6623 | |
| 6624 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 6625 set and to the Vim default value when 'compatible' is reset. | |
| 6626 | |
| 6627 *'shortname'* *'sn'* *'noshortname'* *'nosn'* | |
| 6628 'shortname' 'sn' boolean (default off) | |
| 6629 local to buffer | |
| 6630 {not in Vi, not in MS-DOS versions} | |
| 6631 Filenames are assumed to be 8 characters plus one extension of 3 | |
| 6632 characters. Multiple dots in file names are not allowed. When this | |
| 6633 option is on, dots in file names are replaced with underscores when | |
| 6634 adding an extension (".~" or ".swp"). This option is not available | |
| 6635 for MS-DOS, because then it would always be on. This option is useful | |
| 6636 when editing files on an MS-DOS compatible filesystem, e.g., messydos | |
| 6637 or crossdos. When running the Win32 GUI version under Win32s, this | |
| 6638 option is always on by default. | |
| 6639 | |
| 6640 *'showbreak'* *'sbr'* *E595* | |
| 6641 'showbreak' 'sbr' string (default "") | |
| 6642 global | |
| 6643 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6644 {not available when compiled without the |+linebreak| |
| 7 | 6645 feature} |
| 6646 String to put at the start of lines that have been wrapped. Useful | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6647 values are "> " or "+++ ": > |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6648 :set showbreak=>\ |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6649 < Note the backslash to escape the trailing space. It's easier like |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6650 this: > |
|
2314
233eb4412f5d
Added 'colorcolumn' option. Partly by Gregor Uhlenheuer.
Bram Moolenaar <bram@vim.org>
parents:
2302
diff
changeset
|
6651 :let &showbreak = '+++ ' |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6652 < Only printable single-cell characters are allowed, excluding <Tab> and |
| 7 | 6653 comma (in a future version the comma might be used to separate the |
| 6654 part that is shown at the end and at the start of a line). | |
| 6655 The characters are highlighted according to the '@' flag in | |
| 6656 'highlight'. | |
| 6657 Note that tabs after the showbreak will be displayed differently. | |
| 6658 If you want the 'showbreak' to appear in between line numbers, add the | |
| 6659 "n" flag to 'cpoptions'. | |
| 6660 | |
| 6661 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'* | |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6662 'showcmd' 'sc' boolean (Vim default: on, off for Unix, |
|
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
6663 Vi default: off, set in |defaults.vim|) |
| 7 | 6664 global |
| 6665 {not in Vi} | |
| 6666 {not available when compiled without the | |
| 6667 |+cmdline_info| feature} | |
| 1152 | 6668 Show (partial) command in the last line of the screen. Set this |
| 6669 option off if your terminal is slow. | |
| 7 | 6670 In Visual mode the size of the selected area is shown: |
| 6671 - When selecting characters within a line, the number of characters. | |
|
2324
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2317
diff
changeset
|
6672 If the number of bytes is different it is also displayed: "2-6" |
|
0a258a67051d
In Visual mode with 'showcmd' display the number of bytes and characters.
Bram Moolenaar <bram@vim.org>
parents:
2317
diff
changeset
|
6673 means two characters and six bytes. |
| 7 | 6674 - When selecting more than one line, the number of lines. |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6675 - When selecting a block, the size in screen characters: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
6676 {lines}x{columns}. |
| 7 | 6677 NOTE: This option is set to the Vi default value when 'compatible' is |
| 6678 set and to the Vim default value when 'compatible' is reset. | |
| 6679 | |
| 6680 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'* | |
| 6681 'showfulltag' 'sft' boolean (default off) | |
| 6682 global | |
| 6683 {not in Vi} | |
| 6684 When completing a word in insert mode (see |ins-completion|) from the | |
| 6685 tags file, show both the tag name and a tidied-up form of the search | |
| 10 | 6686 pattern (if there is one) as possible matches. Thus, if you have |
| 7 | 6687 matched a C function, you can see a template for what arguments are |
| 6688 required (coding style permitting). | |
| 1621 | 6689 Note that this doesn't work well together with having "longest" in |
| 6690 'completeopt', because the completion from the search pattern may not | |
| 6691 match the typed text. | |
| 7 | 6692 |
| 6693 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'* | |
| 6694 'showmatch' 'sm' boolean (default off) | |
| 6695 global | |
| 6696 When a bracket is inserted, briefly jump to the matching one. The | |
| 6697 jump is only done if the match can be seen on the screen. The time to | |
| 6698 show the match can be set with 'matchtime'. | |
| 6699 A Beep is given if there is no match (no matter if the match can be | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6700 seen or not). |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6701 This option is reset when 'paste' is set and restored when 'paste' is |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6702 reset. |
| 7 | 6703 When the 'm' flag is not included in 'cpoptions', typing a character |
| 6704 will immediately move the cursor back to where it belongs. | |
| 6705 See the "sm" field in 'guicursor' for setting the cursor shape and | |
| 6706 blinking when showing the match. | |
| 6707 The 'matchpairs' option can be used to specify the characters to show | |
| 6708 matches for. 'rightleft' and 'revins' are used to look for opposite | |
| 6709 matches. | |
| 699 | 6710 Also see the matchparen plugin for highlighting the match when moving |
| 6711 around |pi_paren.txt|. | |
| 6712 Note: Use of the short form is rated PG. | |
| 7 | 6713 |
| 6714 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'* | |
| 6715 'showmode' 'smd' boolean (Vim default: on, Vi default: off) | |
| 6716 global | |
| 6717 If in Insert, Replace or Visual mode put a message on the last line. | |
| 6718 Use the 'M' flag in 'highlight' to set the type of highlighting for | |
| 6719 this message. | |
| 10 | 6720 When |XIM| may be used the message will include "XIM". But this |
| 7 | 6721 doesn't mean XIM is really active, especially when 'imactivatekey' is |
| 6722 not set. | |
| 6723 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 6724 set and to the Vim default value when 'compatible' is reset. | |
| 6725 | |
| 677 | 6726 *'showtabline'* *'stal'* |
| 6727 'showtabline' 'stal' number (default 1) | |
| 6728 global | |
| 6729 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
6730 {not available when compiled without the |+windows| |
| 677 | 6731 feature} |
| 6732 The value of this option specifies when the line with tab page labels | |
| 6733 will be displayed: | |
| 6734 0: never | |
| 6735 1: only if there are at least two tab pages | |
| 6736 2: always | |
| 6737 This is both for the GUI and non-GUI implementation of the tab pages | |
| 6738 line. | |
| 6739 See |tab-page| for more information about tab pages. | |
| 6740 | |
| 7 | 6741 *'sidescroll'* *'ss'* |
| 6742 'sidescroll' 'ss' number (default 0) | |
| 6743 global | |
| 6744 {not in Vi} | |
| 6745 The minimal number of columns to scroll horizontally. Used only when | |
| 6746 the 'wrap' option is off and the cursor is moved off of the screen. | |
| 6747 When it is zero the cursor will be put in the middle of the screen. | |
| 6748 When using a slow terminal set it to a large number or 0. When using | |
| 6749 a fast terminal use a small number or 1. Not used for "zh" and "zl" | |
| 6750 commands. | |
| 6751 | |
| 6752 *'sidescrolloff'* *'siso'* | |
| 6753 'sidescrolloff' 'siso' number (default 0) | |
| 6754 global | |
| 6755 {not in Vi} | |
| 6756 The minimal number of screen columns to keep to the left and to the | |
| 534 | 6757 right of the cursor if 'nowrap' is set. Setting this option to a |
| 6758 value greater than 0 while having |'sidescroll'| also at a non-zero | |
| 6759 value makes some context visible in the line you are scrolling in | |
| 6760 horizontally (except at beginning of the line). Setting this option | |
| 6761 to a large value (like 999) has the effect of keeping the cursor | |
| 6762 horizontally centered in the window, as long as one does not come too | |
| 6763 close to the beginning of the line. | |
| 7 | 6764 NOTE: This option is set to 0 when 'compatible' is set. |
| 6765 | |
| 6766 Example: Try this together with 'sidescroll' and 'listchars' as | |
| 6767 in the following example to never allow the cursor to move | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6768 onto the "extends" character: > |
| 7 | 6769 |
| 6770 :set nowrap sidescroll=1 listchars=extends:>,precedes:< | |
| 6771 :set sidescrolloff=1 | |
|
9852
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6772 < |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6773 *'signcolumn'* *'scl'* |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6774 'signcolumn' 'scl' string (default "auto") |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6775 local to window |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6776 {not in Vi} |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6777 {not available when compiled without the |+signs| |
|
4eea48b76d03
commit https://github.com/vim/vim/commit/95ec9d6a6ab3117d60ff638670a803d43974ba51
Christian Brabandt <cb@256bit.org>
parents:
9737
diff
changeset
|
6778 feature} |
|
9860
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6779 Whether or not to draw the signcolumn. Valid values are: |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6780 "auto" only when there is a sign to display |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6781 "no" never |
|
9eaf8ef656e9
commit https://github.com/vim/vim/commit/0952131376a517fc12dc5ae908a97018b4ee23f0
Christian Brabandt <cb@256bit.org>
parents:
9852
diff
changeset
|
6782 "yes" always |
| 7 | 6783 |
| 6784 | |
| 6785 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'* | |
| 6786 'smartcase' 'scs' boolean (default off) | |
| 6787 global | |
| 6788 {not in Vi} | |
| 6789 Override the 'ignorecase' option if the search pattern contains upper | |
| 6790 case characters. Only used when the search pattern is typed and | |
| 6791 'ignorecase' option is on. Used for the commands "/", "?", "n", "N", | |
| 3557 | 6792 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After |
| 7 | 6793 "*" and "#" you can make 'smartcase' used by doing a "/" command, |
| 6794 recalling the search pattern from history and hitting <Enter>. | |
| 6795 NOTE: This option is reset when 'compatible' is set. | |
| 6796 | |
| 6797 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'* | |
| 6798 'smartindent' 'si' boolean (default off) | |
| 6799 local to buffer | |
| 6800 {not in Vi} | |
| 6801 {not available when compiled without the | |
| 6802 |+smartindent| feature} | |
| 6803 Do smart autoindenting when starting a new line. Works for C-like | |
| 6804 programs, but can also be used for other languages. 'cindent' does | |
| 6805 something like this, works better in most cases, but is more strict, | |
| 2662 | 6806 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set, |
| 2642 | 6807 setting 'si' has no effect. 'indentexpr' is a more advanced |
| 6808 alternative. | |
| 7 | 6809 Normally 'autoindent' should also be on when using 'smartindent'. |
| 6810 An indent is automatically inserted: | |
| 6811 - After a line ending in '{'. | |
| 6812 - After a line starting with a keyword from 'cinwords'. | |
| 6813 - Before a line starting with '}' (only with the "O" command). | |
| 6814 When typing '}' as the first character in a new line, that line is | |
| 6815 given the same indent as the matching '{'. | |
| 6816 When typing '#' as the first character in a new line, the indent for | |
| 6817 that line is removed, the '#' is put in the first column. The indent | |
| 10 | 6818 is restored for the next line. If you don't want this, use this |
| 7 | 6819 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H. |
| 6820 When using the ">>" command, lines starting with '#' are not shifted | |
| 6821 right. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6822 NOTE: 'smartindent' is reset when 'compatible' is set. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6823 This option is reset when 'paste' is set and restored when 'paste' is |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6824 reset. |
| 7 | 6825 |
| 6826 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'* | |
| 6827 'smarttab' 'sta' boolean (default off) | |
| 6828 global | |
| 6829 {not in Vi} | |
| 6830 When on, a <Tab> in front of a line inserts blanks according to | |
| 648 | 6831 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A |
| 6832 <BS> will delete a 'shiftwidth' worth of space at the start of the | |
| 6833 line. | |
| 650 | 6834 When off, a <Tab> always inserts blanks according to 'tabstop' or |
| 648 | 6835 'softtabstop'. 'shiftwidth' is only used for shifting text left or |
| 6836 right |shift-left-right|. | |
| 1263 | 6837 What gets inserted (a <Tab> or spaces) depends on the 'expandtab' |
| 7 | 6838 option. Also see |ins-expandtab|. When 'expandtab' is not set, the |
| 11 | 6839 number of spaces is minimized by using <Tab>s. |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6840 This option is reset when 'paste' is set and restored when 'paste' is |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6841 reset. |
| 7 | 6842 NOTE: This option is reset when 'compatible' is set. |
| 6843 | |
| 6844 *'softtabstop'* *'sts'* | |
| 6845 'softtabstop' 'sts' number (default 0) | |
| 6846 local to buffer | |
| 6847 {not in Vi} | |
| 6848 Number of spaces that a <Tab> counts for while performing editing | |
| 6849 operations, like inserting a <Tab> or using <BS>. It "feels" like | |
| 6850 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is | |
| 6851 used. This is useful to keep the 'ts' setting at its standard value | |
| 6852 of 8, while being able to edit like it is set to 'sts'. However, | |
| 6853 commands like "x" still work on the actual characters. | |
| 6854 When 'sts' is zero, this feature is off. | |
| 3893 | 6855 When 'sts' is negative, the value of 'shiftwidth' is used. |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6856 'softtabstop' is set to 0 when the 'paste' option is set and restored |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
6857 when 'paste' is reset. |
| 7 | 6858 See also |ins-expandtab|. When 'expandtab' is not set, the number of |
| 6859 spaces is minimized by using <Tab>s. | |
| 6860 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is | |
| 6861 set. | |
| 6862 NOTE: This option is set to 0 when 'compatible' is set. | |
| 6863 | |
| 221 | 6864 *'spell'* *'nospell'* |
| 6865 'spell' boolean (default off) | |
| 6866 local to window | |
| 6867 {not in Vi} | |
| 6868 {not available when compiled without the |+syntax| | |
| 6869 feature} | |
| 6870 When on spell checking will be done. See |spell|. | |
| 236 | 6871 The languages are specified with 'spelllang'. |
| 221 | 6872 |
| 386 | 6873 *'spellcapcheck'* *'spc'* |
| 389 | 6874 'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+") |
| 386 | 6875 local to buffer |
| 6876 {not in Vi} | |
| 6877 {not available when compiled without the |+syntax| | |
| 6878 feature} | |
| 6879 Pattern to locate the end of a sentence. The following word will be | |
| 6880 checked to start with a capital letter. If not then it is highlighted | |
| 484 | 6881 with SpellCap |hl-SpellCap| (unless the word is also badly spelled). |
| 386 | 6882 When this check is not wanted make this option empty. |
| 6883 Only used when 'spell' is set. | |
| 389 | 6884 Be careful with special characters, see |option-backslash| about |
| 6885 including spaces and backslashes. | |
| 480 | 6886 To set this option automatically depending on the language, see |
| 6887 |set-spc-auto|. | |
| 386 | 6888 |
| 314 | 6889 *'spellfile'* *'spf'* |
| 6890 'spellfile' 'spf' string (default empty) | |
| 6891 local to buffer | |
| 6892 {not in Vi} | |
| 6893 {not available when compiled without the |+syntax| | |
| 6894 feature} | |
| 6895 Name of the word list file where words are added for the |zg| and |zw| | |
| 401 | 6896 commands. It must end in ".{encoding}.add". You need to include the |
| 6897 path, otherwise the file is placed in the current directory. | |
| 386 | 6898 *E765* |
| 6899 It may also be a comma separated list of names. A count before the | |
| 6900 |zg| and |zw| commands can be used to access each. This allows using | |
| 6901 a personal word list file and a project word list file. | |
| 314 | 6902 When a word is added while this option is empty Vim will set it for |
| 819 | 6903 you: Using the first directory in 'runtimepath' that is writable. If |
| 6904 there is no "spell" directory yet it will be created. For the file | |
| 6905 name the first language name that appears in 'spelllang' is used, | |
| 353 | 6906 ignoring the region. |
| 6907 The resulting ".spl" file will be used for spell checking, it does not | |
| 6908 have to appear in 'spelllang'. | |
| 6909 Normally one file is used for all regions, but you can add the region | |
| 6910 name if you want to. However, it will then only be used when | |
| 6911 'spellfile' is set to it, for entries in 'spelllang' only files | |
| 6912 without region name will be found. | |
| 336 | 6913 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 6914 security reasons. | |
| 314 | 6915 |
| 221 | 6916 *'spelllang'* *'spl'* |
| 314 | 6917 'spelllang' 'spl' string (default "en") |
| 221 | 6918 local to buffer |
| 6919 {not in Vi} | |
| 6920 {not available when compiled without the |+syntax| | |
| 6921 feature} | |
| 353 | 6922 A comma separated list of word list names. When the 'spell' option is |
| 6923 on spellchecking will be done for these languages. Example: > | |
| 6924 set spelllang=en_us,nl,medical | |
| 6925 < This means US English, Dutch and medical words are recognized. Words | |
| 6926 that are not recognized will be highlighted. | |
| 6927 The word list name must not include a comma or dot. Using a dash is | |
| 6928 recommended to separate the two letter language name from a | |
| 6929 specification. Thus "en-rare" is used for rare English words. | |
| 6930 A region name must come last and have the form "_xx", where "xx" is | |
| 6931 the two-letter, lower case region name. You can use more than one | |
| 6932 region by listing them: "en_us,en_ca" supports both US and Canadian | |
| 6933 English, but not words specific for Australia, New Zealand or Great | |
|
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
6934 Britain. (Note: currently en_au and en_nz dictionaries are older than |
|
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7272
diff
changeset
|
6935 en_ca, en_gb and en_us). |
| 5477 | 6936 If the name "cjk" is included East Asian characters are excluded from |
| 6937 spell checking. This is useful when editing text that also has Asian | |
| 6938 words. | |
| 484 | 6939 *E757* |
| 419 | 6940 As a special case the name of a .spl file can be given as-is. The |
| 6941 first "_xx" in the name is removed and used as the region name | |
| 6942 (_xx is an underscore, two letters and followed by a non-letter). | |
| 6943 This is mainly for testing purposes. You must make sure the correct | |
| 6944 encoding is used, Vim doesn't check it. | |
| 236 | 6945 When 'encoding' is set the word lists are reloaded. Thus it's a good |
| 419 | 6946 idea to set 'spelllang' after setting 'encoding' to avoid loading the |
| 6947 files twice. | |
| 353 | 6948 How the related spell files are found is explained here: |spell-load|. |
| 221 | 6949 |
| 653 | 6950 If the |spellfile.vim| plugin is active and you use a language name |
| 6951 for which Vim cannot find the .spl file in 'runtimepath' the plugin | |
| 6952 will ask you if you want to download the file. | |
| 6953 | |
| 480 | 6954 After this option has been set successfully, Vim will source the files |
| 6955 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang' | |
| 650 | 6956 up to the first comma, dot or underscore. |
| 6957 Also see |set-spc-auto|. | |
| 480 | 6958 |
| 6959 | |
| 344 | 6960 *'spellsuggest'* *'sps'* |
| 6961 'spellsuggest' 'sps' string (default "best") | |
| 6962 global | |
| 6963 {not in Vi} | |
| 6964 {not available when compiled without the |+syntax| | |
| 6965 feature} | |
| 593 | 6966 Methods used for spelling suggestions. Both for the |z=| command and |
| 374 | 6967 the |spellsuggest()| function. This is a comma-separated list of |
| 6968 items: | |
| 6969 | |
| 6970 best Internal method that works best for English. Finds | |
| 6971 changes like "fast" and uses a bit of sound-a-like | |
| 6972 scoring to improve the ordering. | |
| 6973 | |
| 6974 double Internal method that uses two methods and mixes the | |
| 6975 results. The first method is "fast", the other method | |
| 344 | 6976 computes how much the suggestion sounds like the bad |
| 374 | 6977 word. That only works when the language specifies |
| 6978 sound folding. Can be slow and doesn't always give | |
| 6979 better results. | |
| 6980 | |
| 6981 fast Internal method that only checks for simple changes: | |
| 6982 character inserts/deletes/swaps. Works well for | |
| 6983 simple typing mistakes. | |
| 6984 | |
| 593 | 6985 {number} The maximum number of suggestions listed for |z=|. |
| 484 | 6986 Not used for |spellsuggest()|. The number of |
| 6987 suggestions is never more than the value of 'lines' | |
| 6988 minus two. | |
| 6989 | |
| 374 | 6990 file:{filename} Read file {filename}, which must have two columns, |
| 6991 separated by a slash. The first column contains the | |
| 6992 bad word, the second column the suggested good word. | |
| 6993 Example: | |
| 6994 theribal/terrible ~ | |
| 6995 Use this for common mistakes that do not appear at the | |
| 6996 top of the suggestion list with the internal methods. | |
| 6997 Lines without a slash are ignored, use this for | |
| 6998 comments. | |
| 5862 | 6999 The word in the second column must be correct, |
| 7000 otherwise it will not be used. Add the word to an | |
| 7001 ".add" file if it is currently flagged as a spelling | |
| 7002 mistake. | |
| 374 | 7003 The file is used for all languages. |
| 7004 | |
| 7005 expr:{expr} Evaluate expression {expr}. Use a function to avoid | |
| 7006 trouble with spaces. |v:val| holds the badly spelled | |
| 7007 word. The expression must evaluate to a List of | |
| 7008 Lists, each with a suggestion and a score. | |
| 7009 Example: | |
| 7010 [['the', 33], ['that', 44]] | |
| 593 | 7011 Set 'verbose' and use |z=| to see the scores that the |
| 374 | 7012 internal methods use. A lower score is better. |
| 7013 This may invoke |spellsuggest()| if you temporarily | |
| 7014 set 'spellsuggest' to exclude the "expr:" part. | |
| 7015 Errors are silently ignored, unless you set the | |
| 7016 'verbose' option to a non-zero value. | |
| 7017 | |
| 7018 Only one of "best", "double" or "fast" may be used. The others may | |
| 7019 appear several times in any order. Example: > | |
| 7020 :set sps=file:~/.vim/sugg,best,expr:MySuggest() | |
| 7021 < | |
| 7022 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 7023 security reasons. | |
| 344 | 7024 |
| 7025 | |
| 7 | 7026 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'* |
| 7027 'splitbelow' 'sb' boolean (default off) | |
| 7028 global | |
| 7029 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7030 {not available when compiled without the |+windows| |
| 7 | 7031 feature} |
| 7032 When on, splitting a window will put the new window below the current | |
| 7033 one. |:split| | |
| 7034 | |
| 7035 *'splitright'* *'spr'* *'nosplitright'* *'nospr'* | |
| 7036 'splitright' 'spr' boolean (default off) | |
| 7037 global | |
| 7038 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7039 {not available when compiled without the |+vertsplit| |
| 7 | 7040 feature} |
| 7041 When on, splitting a window will put the new window right of the | |
| 7042 current one. |:vsplit| | |
| 7043 | |
| 7044 *'startofline'* *'sol'* *'nostartofline'* *'nosol'* | |
| 7045 'startofline' 'sol' boolean (default on) | |
| 7046 global | |
| 7047 {not in Vi} | |
| 7048 When "on" the commands listed below move the cursor to the first | |
| 11 | 7049 non-blank of the line. When off the cursor is kept in the same column |
| 10 | 7050 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B, |
| 11 | 7051 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>" |
| 7 | 7052 with a linewise operator, with "%" with a count and to buffer changing |
| 7053 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that | |
| 7054 only has a line number, e.g., ":25" or ":+". | |
| 7055 In case of buffer changing commands the cursor is placed at the column | |
| 7056 where it was the last time the buffer was edited. | |
| 7057 NOTE: This option is set when 'compatible' is set. | |
| 7058 | |
| 2709 | 7059 *'statusline'* *'stl'* *E540* *E542* |
| 7 | 7060 'statusline' 'stl' string (default empty) |
| 40 | 7061 global or local to window |global-local| |
| 7 | 7062 {not in Vi} |
| 7063 {not available when compiled without the |+statusline| | |
| 7064 feature} | |
| 7065 When nonempty, this option determines the content of the status line. | |
| 7066 Also see |status-line|. | |
| 7067 | |
| 7068 The option consists of printf style '%' items interspersed with | |
| 7069 normal text. Each status line item is of the form: | |
| 7070 %-0{minwid}.{maxwid}{item} | |
|
7876
93f747af7b58
commit https://github.com/vim/vim/commit/5e9b2fa9bb0e6061cf18457c173cd141a5dc9c92
Christian Brabandt <cb@256bit.org>
parents:
7687
diff
changeset
|
7071 All fields except the {item} are optional. A single percent sign can |
| 2709 | 7072 be given as "%%". Up to 80 items can be specified. *E541* |
| 7 | 7073 |
| 680 | 7074 When the option starts with "%!" then it is used as an expression, |
| 7075 evaluated and the result is used as the option value. Example: > | |
| 7076 :set statusline=%!MyStatusLine() | |
| 7077 < The result can contain %{} items that will be evaluated too. | |
| 3445 | 7078 Note that the "%!" expression is evaluated in the context of the |
| 7079 current window and buffer, while %{} items are evaluated in the | |
| 7080 context of the window that the statusline belongs to. | |
| 680 | 7081 |
| 7082 When there is error while evaluating the option then it will be made | |
| 7083 empty to avoid further errors. Otherwise screen updating would loop. | |
| 7084 | |
| 7 | 7085 Note that the only effect of 'ruler' when this option is set (and |
| 7086 'laststatus' is 2) is controlling the output of |CTRL-G|. | |
| 7087 | |
| 7088 field meaning ~ | |
| 233 | 7089 - Left justify the item. The default is right justified |
| 7 | 7090 when minwid is larger than the length of the item. |
| 233 | 7091 0 Leading zeroes in numeric items. Overridden by '-'. |
| 7 | 7092 minwid Minimum width of the item, padding as set by '-' & '0'. |
| 7093 Value must be 50 or less. | |
| 10 | 7094 maxwid Maximum width of the item. Truncation occurs with a '<' |
| 7 | 7095 on the left for text items. Numeric items will be |
| 7096 shifted down to maxwid-2 digits followed by '>'number | |
| 7097 where number is the amount of missing digits, much like | |
| 7098 an exponential notation. | |
| 7099 item A one letter code as described below. | |
| 7100 | |
| 7101 Following is a description of the possible statusline items. The | |
| 7102 second character in "item" is the type: | |
| 7103 N for number | |
| 7104 S for string | |
| 7105 F for flags as described below | |
| 7106 - not applicable | |
| 7107 | |
| 7108 item meaning ~ | |
| 1152 | 7109 f S Path to the file in the buffer, as typed or relative to current |
| 7110 directory. | |
| 7 | 7111 F S Full path to the file in the buffer. |
| 7112 t S File name (tail) of file in the buffer. | |
| 1698 | 7113 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off. |
| 7 | 7114 M F Modified flag, text is ",+" or ",-". |
| 1698 | 7115 r F Readonly flag, text is "[RO]". |
| 7 | 7116 R F Readonly flag, text is ",RO". |
| 1698 | 7117 h F Help buffer flag, text is "[help]". |
| 7 | 7118 H F Help buffer flag, text is ",HLP". |
| 1698 | 7119 w F Preview window flag, text is "[Preview]". |
| 7 | 7120 W F Preview window flag, text is ",PRV". |
| 1698 | 7121 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'. |
| 7 | 7122 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'. |
| 7123 {not available when compiled without |+autocmd| feature} | |
|
2411
68e394361ca3
Add "q" item for 'statusline'. Add w:quickfix_title. (Lech Lorens)
Bram Moolenaar <bram@vim.org>
parents:
2400
diff
changeset
|
7124 q S "[Quickfix List]", "[Location List]" or empty. |
| 7 | 7125 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are |
| 7126 being used: "<keymap>" | |
| 7127 n N Buffer number. | |
| 2709 | 7128 b N Value of character under cursor. |
| 7 | 7129 B N As above, in hexadecimal. |
| 7130 o N Byte number in file of byte under cursor, first byte is 1. | |
| 7131 Mnemonic: Offset from start of file (with one added) | |
| 7132 {not available when compiled without |+byte_offset| feature} | |
| 7133 O N As above, in hexadecimal. | |
| 233 | 7134 N N Printer page number. (Only works in the 'printheader' option.) |
| 7 | 7135 l N Line number. |
| 7136 L N Number of lines in buffer. | |
| 7137 c N Column number. | |
| 7138 v N Virtual column number. | |
| 10 | 7139 V N Virtual column number as -{num}. Not displayed if equal to 'c'. |
| 7 | 7140 p N Percentage through file in lines as in |CTRL-G|. |
| 7141 P S Percentage through file of displayed window. This is like the | |
| 5055 | 7142 percentage described for 'ruler'. Always 3 in length, unless |
| 7143 translated. | |
| 233 | 7144 a S Argument list status as in default title. ({current} of {max}) |
| 7 | 7145 Empty if the argument file count is zero or one. |
| 680 | 7146 { NF Evaluate expression between '%{' and '}' and substitute result. |
| 625 | 7147 Note that there is no '%' before the closing '}'. |
| 7 | 7148 ( - Start of item group. Can be used for setting the width and |
| 7149 alignment of a section. Must be followed by %) somewhere. | |
| 7150 ) - End of item group. No width fields allowed. | |
| 681 | 7151 T N For 'tabline': start of tab page N label. Use %T after the last |
| 7152 label. This information is used for mouse clicks. | |
| 7153 X N For 'tabline': start of close tab N label. Use %X after the | |
| 7154 label, e.g.: %3Xclose%X. Use %999X for a "close current tab" | |
| 7155 mark. This information is used for mouse clicks. | |
| 7 | 7156 < - Where to truncate line if too long. Default is at the start. |
| 7157 No width fields allowed. | |
| 7158 = - Separation point between left and right aligned items. | |
| 7159 No width fields allowed. | |
| 680 | 7160 # - Set highlight group. The name must follow and then a # again. |
| 7161 Thus use %#HLname# for highlight group HLname. The same | |
| 7162 highlighting is used, also for the statusline of non-current | |
| 7163 windows. | |
| 7 | 7164 * - Set highlight group to User{N}, where {N} is taken from the |
| 233 | 7165 minwid field, e.g. %1*. Restore normal highlight with %* or %0*. |
| 7 | 7166 The difference between User{N} and StatusLine will be applied |
| 7167 to StatusLineNC for the statusline of non-current windows. | |
| 7168 The number N must be between 1 and 9. See |hl-User1..9| | |
| 7169 | |
| 1698 | 7170 When displaying a flag, Vim removes the leading comma, if any, when |
| 7171 that flag comes right after plaintext. This will make a nice display | |
| 7172 when flags are used like in the examples below. | |
| 7 | 7173 |
| 233 | 7174 When all items in a group becomes an empty string (i.e. flags that are |
| 7 | 7175 not set) and a minwid is not set for the group, the whole group will |
| 7176 become empty. This will make a group like the following disappear | |
| 7177 completely from the statusline when none of the flags are set. > | |
| 7178 :set statusline=...%(\ [%M%R%H]%)... | |
|
7245
8896150aba23
commit https://github.com/vim/vim/commit/e392eb41f8dfc01bd13634e534ac6b4d505326f4
Christian Brabandt <cb@256bit.org>
parents:
7233
diff
changeset
|
7179 < *g:actual_curbuf* |
| 7 | 7180 Beware that an expression is evaluated each and every time the status |
| 7181 line is displayed. The current buffer and current window will be set | |
| 7182 temporarily to that of the window (and buffer) whose statusline is | |
| 233 | 7183 currently being drawn. The expression will evaluate in this context. |
| 7 | 7184 The variable "actual_curbuf" is set to the 'bufnr()' number of the |
| 634 | 7185 real current buffer. |
| 7186 | |
| 3682 | 7187 The 'statusline' option will be evaluated in the |sandbox| if set from |
| 7188 a modeline, see |sandbox-option|. | |
| 634 | 7189 |
| 7190 It is not allowed to change text or jump to another window while | |
| 7191 evaluating 'statusline' |textlock|. | |
| 7 | 7192 |
| 7193 If the statusline is not updated when you want it (e.g., after setting | |
| 7194 a variable that's used in an expression), you can force an update by | |
| 7195 setting an option without changing its value. Example: > | |
| 7196 :let &ro = &ro | |
| 7197 | |
| 7198 < A result of all digits is regarded a number for display purposes. | |
| 7199 Otherwise the result is taken as flag text and applied to the rules | |
| 7200 described above. | |
| 7201 | |
| 199 | 7202 Watch out for errors in expressions. They may render Vim unusable! |
| 7 | 7203 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and |
| 7204 edit your .vimrc or whatever with "vim -u NONE" to get it right. | |
| 7205 | |
| 7206 Examples: | |
| 7207 Emulate standard status line with 'ruler' set > | |
| 7208 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P | |
| 7209 < Similar, but add ASCII value of char under the cursor (like "ga") > | |
| 7210 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P | |
| 7211 < Display byte count and byte value, modified flag in red. > | |
| 7212 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b' | |
| 7213 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red | |
| 7214 < Display a ,GZ flag if a compressed file is loaded > | |
| 7215 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h... | |
| 7216 < In the |:autocmd|'s: > | |
| 7217 :let b:gzflag = 1 | |
| 7218 < And: > | |
| 7219 :unlet b:gzflag | |
| 7220 < And define this function: > | |
| 7221 :function VarExists(var, val) | |
| 7222 : if exists(a:var) | return a:val | else | return '' | endif | |
| 7223 :endfunction | |
| 7224 < | |
| 7225 *'suffixes'* *'su'* | |
| 7226 'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj") | |
| 7227 global | |
| 7228 {not in Vi} | |
| 7229 Files with these suffixes get a lower priority when multiple files | |
| 7230 match a wildcard. See |suffixes|. Commas can be used to separate the | |
| 10 | 7231 suffixes. Spaces after the comma are ignored. A dot is also seen as |
| 7232 the start of a suffix. To avoid a dot or comma being recognized as a | |
| 7 | 7233 separator, precede it with a backslash (see |option-backslash| about |
| 7234 including spaces and backslashes). | |
| 7235 See 'wildignore' for completely ignoring files. | |
| 7236 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7237 suffixes from the list. This avoids problems when a future version | |
| 7238 uses another default. | |
| 7239 | |
| 7240 *'suffixesadd'* *'sua'* | |
| 7241 'suffixesadd' 'sua' string (default "") | |
| 7242 local to buffer | |
| 7243 {not in Vi} | |
| 7244 {not available when compiled without the | |
| 7245 |+file_in_path| feature} | |
| 7246 Comma separated list of suffixes, which are used when searching for a | |
| 7247 file for the "gf", "[I", etc. commands. Example: > | |
| 7248 :set suffixesadd=.java | |
| 7249 < | |
| 7250 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'* | |
| 7251 'swapfile' 'swf' boolean (default on) | |
| 7252 local to buffer | |
| 7253 {not in Vi} | |
| 10 | 7254 Use a swapfile for the buffer. This option can be reset when a |
| 7 | 7255 swapfile is not wanted for a specific buffer. For example, with |
| 7256 confidential information that even root must not be able to access. | |
| 7257 Careful: All text will be in memory: | |
| 7258 - Don't use this for big files. | |
| 7259 - Recovery will be impossible! | |
| 7260 A swapfile will only be present when |'updatecount'| is non-zero and | |
| 7261 'swapfile' is set. | |
| 7262 When 'swapfile' is reset, the swap file for the current buffer is | |
| 7263 immediately deleted. When 'swapfile' is set, and 'updatecount' is | |
| 7264 non-zero, a swap file is immediately created. | |
| 7265 Also see |swap-file| and |'swapsync'|. | |
| 5763 | 7266 If you want to open a new buffer without creating a swap file for it, |
| 7267 use the |:noswapfile| modifier. | |
| 7 | 7268 |
| 7269 This option is used together with 'bufhidden' and 'buftype' to | |
| 7270 specify special kinds of buffers. See |special-buffers|. | |
| 7271 | |
| 7272 *'swapsync'* *'sws'* | |
| 7273 'swapsync' 'sws' string (default "fsync") | |
| 7274 global | |
| 7275 {not in Vi} | |
| 7276 When this option is not empty a swap file is synced to disk after | |
| 10 | 7277 writing to it. This takes some time, especially on busy unix systems. |
| 7 | 7278 When this option is empty parts of the swap file may be in memory and |
| 7279 not written to disk. When the system crashes you may lose more work. | |
| 7280 On Unix the system does a sync now and then without Vim asking for it, | |
| 7281 so the disadvantage of setting this option off is small. On some | |
| 7282 systems the swap file will not be written at all. For a unix system | |
| 7283 setting it to "sync" will use the sync() call instead of the default | |
| 7284 fsync(), which may work better on some systems. | |
| 36 | 7285 The 'fsync' option is used for the actual file. |
| 7 | 7286 |
| 7287 *'switchbuf'* *'swb'* | |
| 7288 'switchbuf' 'swb' string (default "") | |
| 7289 global | |
| 7290 {not in Vi} | |
| 7291 This option controls the behavior when switching between buffers. | |
| 7292 Possible values (comma separated list): | |
| 7293 useopen If included, jump to the first open window that | |
| 7294 contains the specified buffer (if there is one). | |
| 7295 Otherwise: Do not examine other windows. | |
| 7296 This setting is checked with |quickfix| commands, when | |
| 7297 jumping to errors (":cc", ":cn", "cp", etc.). It is | |
| 7298 also used in all buffer related split commands, for | |
| 7299 example ":sbuffer", ":sbnext", or ":sbrewind". | |
| 825 | 7300 usetab Like "useopen", but also consider windows in other tab |
| 856 | 7301 pages. |
| 7 | 7302 split If included, split the current window before loading |
| 3153 | 7303 a buffer for a |quickfix| command that display errors. |
| 7304 Otherwise: do not split, use current window. | |
| 6843 | 7305 vsplit Just like "split" but split vertically. |
| 1621 | 7306 newtab Like "split", but open a new tab page. Overrules |
|
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2283
diff
changeset
|
7307 "split" when both are present. |
| 7 | 7308 |
| 410 | 7309 *'synmaxcol'* *'smc'* |
| 7310 'synmaxcol' 'smc' number (default 3000) | |
| 7311 local to buffer | |
| 7312 {not in Vi} | |
| 7313 {not available when compiled without the |+syntax| | |
| 7314 feature} | |
| 419 | 7315 Maximum column in which to search for syntax items. In long lines the |
| 7316 text after this column is not highlighted and following lines may not | |
| 7317 be highlighted correctly, because the syntax state is cleared. | |
| 410 | 7318 This helps to avoid very slow redrawing for an XML file that is one |
| 7319 long line. | |
| 7320 Set to zero to remove the limit. | |
| 7321 | |
| 7 | 7322 *'syntax'* *'syn'* |
| 7323 'syntax' 'syn' string (default empty) | |
| 7324 local to buffer | |
| 7325 {not in Vi} | |
| 7326 {not available when compiled without the |+syntax| | |
| 7327 feature} | |
| 7328 When this option is set, the syntax with this name is loaded, unless | |
| 7329 syntax highlighting has been switched off with ":syntax off". | |
| 7330 Otherwise this option does not always reflect the current syntax (the | |
| 7331 b:current_syntax variable does). | |
| 7332 This option is most useful in a modeline, for a file which syntax is | |
| 782 | 7333 not automatically recognized. Example, in an IDL file: |
| 7334 /* vim: set syntax=idl : */ ~ | |
| 7335 When a dot appears in the value then this separates two filetype | |
| 7336 names. Example: | |
| 7337 /* vim: set syntax=c.doxygen : */ ~ | |
| 7338 This will use the "c" syntax first, then the "doxygen" syntax. | |
| 7339 Note that the second one must be prepared to be loaded as an addition, | |
| 7340 otherwise it will be skipped. More than one dot may appear. | |
| 7341 To switch off syntax highlighting for the current file, use: > | |
| 7 | 7342 :set syntax=OFF |
| 7343 < To switch syntax highlighting on according to the current value of the | |
| 7344 'filetype' option: > | |
| 7345 :set syntax=ON | |
| 7346 < What actually happens when setting the 'syntax' option is that the | |
| 7347 Syntax autocommand event is triggered with the value as argument. | |
| 7348 This option is not copied to another buffer, independent of the 's' or | |
| 7349 'S' flag in 'cpoptions'. | |
| 36 | 7350 Only normal file name characters can be used, "/\*?[|<>" are illegal. |
| 7 | 7351 |
| 699 | 7352 *'tabline'* *'tal'* |
| 677 | 7353 'tabline' 'tal' string (default empty) |
| 674 | 7354 global |
| 7355 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7356 {not available when compiled without the |+windows| |
| 674 | 7357 feature} |
| 677 | 7358 When nonempty, this option determines the content of the tab pages |
| 7359 line at the top of the Vim window. When empty Vim will use a default | |
| 681 | 7360 tab pages line. See |setting-tabline| for more info. |
| 677 | 7361 |
| 7362 The tab pages line only appears as specified with the 'showtabline' | |
| 688 | 7363 option and only when there is no GUI tab line. When 'e' is in |
| 7364 'guioptions' and the GUI supports a tab line 'guitablabel' is used | |
|
2572
ee53a39d5896
Last changes for the 7.3 release!
Bram Moolenaar <bram@vim.org>
parents:
2570
diff
changeset
|
7365 instead. Note that the two tab pages lines are very different. |
| 677 | 7366 |
| 7367 The value is evaluated like with 'statusline'. You can use | |
| 7368 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out | |
| 681 | 7369 the text to be displayed. Use "%1T" for the first label, "%2T" for |
| 7370 the second one, etc. Use "%X" items for closing labels. | |
| 677 | 7371 |
| 7372 Keep in mind that only one of the tab pages is the current one, others | |
| 7373 are invisible and you can't jump to their windows. | |
| 7374 | |
| 674 | 7375 |
| 699 | 7376 *'tabpagemax'* *'tpm'* |
| 7377 'tabpagemax' 'tpm' number (default 10) | |
| 7378 global | |
| 7379 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
7380 {not available when compiled without the |+windows| |
| 699 | 7381 feature} |
| 7382 Maximum number of tab pages to be opened by the |-p| command line | |
| 7383 argument or the ":tab all" command. |tabpage| | |
| 7384 | |
| 7385 | |
| 7386 *'tabstop'* *'ts'* | |
| 7 | 7387 'tabstop' 'ts' number (default 8) |
| 7388 local to buffer | |
| 7389 Number of spaces that a <Tab> in the file counts for. Also see | |
| 7390 |:retab| command, and 'softtabstop' option. | |
| 7391 | |
| 7392 Note: Setting 'tabstop' to any other value than 8 can make your file | |
| 7393 appear wrong in many places (e.g., when printing it). | |
| 7394 | |
| 7395 There are four main ways to use tabs in Vim: | |
| 7396 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4 | |
| 7397 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim | |
| 1263 | 7398 will use a mix of tabs and spaces, but typing <Tab> and <BS> will |
| 7 | 7399 behave like a tab appears every 4 (or 3) characters. |
| 7400 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use | |
| 7401 'expandtab'. This way you will always insert spaces. The | |
| 7402 formatting will never be messed up when 'tabstop' is changed. | |
| 7403 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a | |
| 10 | 7404 |modeline| to set these values when editing the file again. Only |
| 7 | 7405 works when using Vim to edit the file. |
| 7406 4. Always set 'tabstop' and 'shiftwidth' to the same value, and | |
| 7407 'noexpandtab'. This should then work (for initial indents only) | |
| 7408 for any tabstop setting that people use. It might be nice to have | |
| 7409 tabs after the first non-blank inserted as spaces if you do this | |
| 7410 though. Otherwise aligned comments will be wrong when 'tabstop' is | |
| 7411 changed. | |
| 7412 | |
| 7413 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'* | |
| 7414 'tagbsearch' 'tbs' boolean (default on) | |
| 7415 global | |
| 7416 {not in Vi} | |
| 7417 When searching for a tag (e.g., for the |:ta| command), Vim can either | |
| 10 | 7418 use a binary search or a linear search in a tags file. Binary |
| 7 | 7419 searching makes searching for a tag a LOT faster, but a linear search |
| 7420 will find more tags if the tags file wasn't properly sorted. | |
| 7421 Vim normally assumes that your tags files are sorted, or indicate that | |
| 7422 they are not sorted. Only when this is not the case does the | |
| 7423 'tagbsearch' option need to be switched off. | |
| 7424 | |
| 7425 When 'tagbsearch' is on, binary searching is first used in the tags | |
| 10 | 7426 files. In certain situations, Vim will do a linear search instead for |
| 7 | 7427 certain files, or retry all files with a linear search. When |
| 7428 'tagbsearch' is off, only a linear search is done. | |
| 7429 | |
| 7430 Linear searching is done anyway, for one file, when Vim finds a line | |
| 7431 at the start of the file indicating that it's not sorted: > | |
| 1621 | 7432 !_TAG_FILE_SORTED 0 /some comment/ |
| 7 | 7433 < [The whitespace before and after the '0' must be a single <Tab>] |
| 7434 | |
| 7435 When a binary search was done and no match was found in any of the | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7436 files listed in 'tags', and case is ignored or a pattern is used |
| 7 | 7437 instead of a normal tag name, a retry is done with a linear search. |
| 7438 Tags in unsorted tags files, and matches with different case will only | |
| 7439 be found in the retry. | |
| 7440 | |
| 22 | 7441 If a tag file indicates that it is case-fold sorted, the second, |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7442 linear search can be avoided when case is ignored. Use a value of '2' |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7443 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7444 sorted with the -f switch to "sort" in most unices, as in the command: |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7445 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7446 (at least 5.5) the --sort=foldcase switch can be used for this as |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7447 well. Note that case must be folded to uppercase for this to work. |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7448 |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7449 By default, tag searches are case-sensitive. Case is ignored when |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7450 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7451 "ignore". |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7452 Also when 'tagcase' is "followscs" and 'smartcase' is set, or |
|
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7453 'tagcase' is "smart", and the pattern contains only lowercase |
|
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7454 characters. |
| 7 | 7455 |
| 7456 When 'tagbsearch' is off, tags searching is slower when a full match | |
| 7457 exists, but faster when no full match exists. Tags in unsorted tags | |
| 7458 files may only be found with 'tagbsearch' off. | |
| 7459 When the tags file is not sorted, or sorted in a wrong way (not on | |
| 7460 ASCII byte value), 'tagbsearch' should be off, or the line given above | |
| 7461 must be included in the tags file. | |
| 7462 This option doesn't affect commands that find all matching tags (e.g., | |
| 7463 command-line completion and ":help"). | |
| 7464 {Vi: always uses binary search in some versions} | |
| 7465 | |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7466 *'tagcase'* *'tc'* |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7467 'tagcase' 'tc' string (default "followic") |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7468 global or local to buffer |global-local| |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7469 {not in Vi} |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7470 This option specifies how case is handled when searching the tags |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7471 file: |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7472 followic Follow the 'ignorecase' option |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7473 followscs Follow the 'smartcase' and 'ignorecase' options |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7474 ignore Ignore case |
|
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7475 match Match case |
|
9913
bb00c661b3a4
commit https://github.com/vim/vim/commit/66e29d7112e437b2b50efe1f82c7e892736d23e4
Christian Brabandt <cb@256bit.org>
parents:
9887
diff
changeset
|
7476 smart Ignore case unless an upper case letter is used |
|
7266
6ba7182fb7bd
commit https://github.com/vim/vim/commit/0f6562e9036f889185dff49a75c7fc5ffb28b307
Christian Brabandt <cb@256bit.org>
parents:
7245
diff
changeset
|
7477 |
| 7 | 7478 *'taglength'* *'tl'* |
| 7479 'taglength' 'tl' number (default 0) | |
| 7480 global | |
| 7481 If non-zero, tags are significant up to this number of characters. | |
| 7482 | |
| 7483 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'* | |
| 7484 'tagrelative' 'tr' boolean (Vim default: on, Vi default: off) | |
| 7485 global | |
| 7486 {not in Vi} | |
| 824 | 7487 If on and using a tags file in another directory, file names in that |
| 7488 tags file are relative to the directory where the tags file is. | |
| 7 | 7489 NOTE: This option is set to the Vi default value when 'compatible' is |
| 7490 set and to the Vim default value when 'compatible' is reset. | |
| 7491 | |
| 7492 *'tags'* *'tag'* *E433* | |
| 7493 'tags' 'tag' string (default "./tags,tags", when compiled with | |
| 7494 |+emacs_tags|: "./tags,./TAGS,tags,TAGS") | |
| 7495 global or local to buffer |global-local| | |
| 7496 Filenames for the tag command, separated by spaces or commas. To | |
| 7497 include a space or comma in a file name, precede it with a backslash | |
| 7498 (see |option-backslash| about including spaces and backslashes). | |
| 7499 When a file name starts with "./", the '.' is replaced with the path | |
| 7500 of the current file. But only when the 'd' flag is not included in | |
| 7501 'cpoptions'. Environment variables are expanded |:set_env|. Also see | |
| 7502 |tags-option|. | |
| 7503 "*", "**" and other wildcards can be used to search for tags files in | |
|
2522
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7504 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7505 find all files named "tags" below "/lib". The filename itself cannot |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7506 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7507 files called "tags?". {not available when compiled without the |
|
d7ecfc8b784c
Update help about wildcards in 'tags' option.
Bram Moolenaar <bram@vim.org>
parents:
2492
diff
changeset
|
7508 |+path_extra| feature} |
| 515 | 7509 The |tagfiles()| function can be used to get a list of the file names |
| 7510 actually used. | |
| 7 | 7511 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag |
| 7512 files are also supported. They are automatically recognized. The | |
| 7513 default value becomes "./tags,./TAGS,tags,TAGS", unless case | |
| 7514 differences are ignored (MS-Windows). |emacs-tags| | |
| 7515 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7516 file names from the list. This avoids problems when a future version | |
| 7517 uses another default. | |
| 7518 {Vi: default is "tags /usr/lib/tags"} | |
| 7519 | |
| 7520 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'* | |
| 7521 'tagstack' 'tgst' boolean (default on) | |
| 7522 global | |
| 7523 {not in all versions of Vi} | |
| 7524 When on, the |tagstack| is used normally. When off, a ":tag" or | |
| 7525 ":tselect" command with an argument will not push the tag onto the | |
| 7526 tagstack. A following ":tag" without an argument, a ":pop" command or | |
| 7527 any other command that uses the tagstack will use the unmodified | |
| 7528 tagstack, but does change the pointer to the active entry. | |
| 7529 Resetting this option is useful when using a ":tag" command in a | |
| 7530 mapping which should not change the tagstack. | |
| 7531 | |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7532 *'tcldll'* |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7533 'tcldll' string (default depends on the build) |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7534 global |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7535 {not in Vi} |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7536 {only available when compiled with the |+tcl/dyn| |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7537 feature} |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7538 Specifies the name of the Tcl shared library. The default is |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7539 DYNAMIC_TCL_DLL, which was specified at compile time. |
|
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
7540 Environment variables are expanded |:set_env|. |
|
7538
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7541 This option cannot be set from a |modeline| or in the |sandbox|, for |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7542 security reasons. |
|
c9fc24b76293
commit https://github.com/vim/vim/commit/8a5115cf18751022387af2085f374d38c60dde83
Christian Brabandt <cb@256bit.org>
parents:
7528
diff
changeset
|
7543 |
| 7 | 7544 *'term'* *E529* *E530* *E531* |
| 7545 'term' string (default is $TERM, if that fails: | |
| 7546 in the GUI: "builtin_gui" | |
| 7547 on Amiga: "amiga" | |
| 7548 on BeOS: "beos-ansi" | |
| 7549 on Mac: "mac-ansi" | |
| 7550 on MiNT: "vt52" | |
| 7551 on MS-DOS: "pcterm" | |
| 7552 on OS/2: "os2ansi" | |
| 7553 on Unix: "ansi" | |
| 7554 on VMS: "ansi" | |
| 7555 on Win 32: "win32") | |
| 7556 global | |
| 7557 Name of the terminal. Used for choosing the terminal control | |
| 7558 characters. Environment variables are expanded |:set_env|. | |
| 7559 For example: > | |
| 7560 :set term=$TERM | |
| 7561 < See |termcap|. | |
| 7562 | |
| 7563 *'termbidi'* *'tbidi'* | |
| 7564 *'notermbidi'* *'notbidi'* | |
| 7565 'termbidi' 'tbidi' boolean (default off, on for "mlterm") | |
| 7566 global | |
| 7567 {not in Vi} | |
| 7568 {only available when compiled with the |+arabic| | |
| 7569 feature} | |
| 7570 The terminal is in charge of Bi-directionality of text (as specified | |
| 7571 by Unicode). The terminal is also expected to do the required shaping | |
| 7572 that some languages (such as Arabic) require. | |
| 7573 Setting this option implies that 'rightleft' will not be set when | |
| 7574 'arabic' is set and the value of 'arabicshape' will be ignored. | |
| 7575 Note that setting 'termbidi' has the immediate effect that | |
| 7576 'arabicshape' is ignored, but 'rightleft' isn't changed automatically. | |
| 7577 This option is reset when the GUI is started. | |
| 7578 For further details see |arabic.txt|. | |
| 7579 | |
| 7580 *'termencoding'* *'tenc'* | |
| 7581 'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with | |
| 7582 Macintosh GUI: "macroman") | |
| 7583 global | |
| 7584 {only available when compiled with the |+multi_byte| | |
| 7585 feature} | |
| 7586 {not in Vi} | |
| 7587 Encoding used for the terminal. This specifies what character | |
| 7588 encoding the keyboard produces and the display will understand. For | |
|
8629
54ac275e3fc4
commit https://github.com/vim/vim/commit/3848e00e0177abdb31bc600234967863ec487233
Christian Brabandt <cb@256bit.org>
parents:
8560
diff
changeset
|
7589 the GUI it only applies to the keyboard ('encoding' is used for the |
| 1152 | 7590 display). Except for the Mac when 'macatsui' is off, then |
| 7591 'termencoding' should be "macroman". | |
| 7 | 7592 *E617* |
| 7593 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been | |
| 7594 successfully initialized, 'termencoding' is forcibly set to "utf-8". | |
| 7595 Any attempts to set a different value will be rejected, and an error | |
| 7596 message is shown. | |
|
7080
1a34f5272977
commit https://github.com/vim/vim/commit/ac360bf2ca293735fc7c6654dc2b3066f4c62488
Christian Brabandt <cb@256bit.org>
parents:
7051
diff
changeset
|
7597 For the Win32 GUI and console versions 'termencoding' is not used, |
| 7 | 7598 because the Win32 system always passes Unicode characters. |
| 7599 When empty, the same encoding is used as for the 'encoding' option. | |
| 7600 This is the normal value. | |
| 7601 Not all combinations for 'termencoding' and 'encoding' are valid. See | |
| 7602 |encoding-table|. | |
| 7603 The value for this option must be supported by internal conversions or | |
| 7604 iconv(). When this is not possible no conversion will be done and you | |
| 7605 will probably experience problems with non-ASCII characters. | |
| 7606 Example: You are working with the locale set to euc-jp (Japanese) and | |
| 7607 want to edit a UTF-8 file: > | |
| 7608 :let &termencoding = &encoding | |
| 7609 :set encoding=utf-8 | |
| 7610 < You need to do this when your system has no locale support for UTF-8. | |
| 7611 | |
|
9027
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7612 *'termguicolors'* *'tgc'* |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7613 'termguicolors' 'tgc' boolean (default off) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7614 global |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7615 {not in Vi} |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7616 {not available when compiled without the |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7617 |+termguicolors| feature} |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7618 When on, uses |highlight-guifg| and |highlight-guibg| attributes in |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7619 the terminal (thus using 24-bit color). Requires a ISO-8613-3 |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7620 compatible terminal. |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7621 If setting this option does not work (produces a colorless UI) |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7622 reading |xterm-true-color| might help. |
|
773d627cac0b
commit https://github.com/vim/vim/commit/61be73bb0f965a895bfb064ea3e55476ac175162
Christian Brabandt <cb@256bit.org>
parents:
8969
diff
changeset
|
7623 |
| 7 | 7624 *'terse'* *'noterse'* |
| 7625 'terse' boolean (default off) | |
| 7626 global | |
| 7627 When set: Add 's' flag to 'shortmess' option (this makes the message | |
| 7628 for a search that hits the start or end of the file not being | |
| 7629 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi | |
| 7630 shortens a lot of messages} | |
| 7631 | |
| 7632 *'textauto'* *'ta'* *'notextauto'* *'nota'* | |
| 7633 'textauto' 'ta' boolean (Vim default: on, Vi default: off) | |
| 7634 global | |
| 7635 {not in Vi} | |
| 7636 This option is obsolete. Use 'fileformats'. | |
| 7637 For backwards compatibility, when 'textauto' is set, 'fileformats' is | |
| 7638 set to the default value for the current system. When 'textauto' is | |
| 7639 reset, 'fileformats' is made empty. | |
| 7640 NOTE: This option is set to the Vi default value when 'compatible' is | |
| 7641 set and to the Vim default value when 'compatible' is reset. | |
| 7642 | |
| 7643 *'textmode'* *'tx'* *'notextmode'* *'notx'* | |
| 7644 'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on, | |
| 7645 others: default off) | |
| 7646 local to buffer | |
| 7647 {not in Vi} | |
| 7648 This option is obsolete. Use 'fileformat'. | |
| 7649 For backwards compatibility, when 'textmode' is set, 'fileformat' is | |
| 7650 set to "dos". When 'textmode' is reset, 'fileformat' is set to | |
| 7651 "unix". | |
| 7652 | |
| 7653 *'textwidth'* *'tw'* | |
| 7654 'textwidth' 'tw' number (default 0) | |
| 7655 local to buffer | |
| 7656 {not in Vi} | |
| 7657 Maximum width of text that is being inserted. A longer line will be | |
| 7658 broken after white space to get this width. A zero value disables | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7659 this. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7660 'textwidth' is set to 0 when the 'paste' option is set and restored |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7661 when 'paste' is reset. |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
7662 When 'textwidth' is zero, 'wrapmargin' may be used. See also |
| 7 | 7663 'formatoptions' and |ins-textwidth|. |
| 838 | 7664 When 'formatexpr' is set it will be used to break the line. |
| 7 | 7665 NOTE: This option is set to 0 when 'compatible' is set. |
| 7666 | |
| 7667 *'thesaurus'* *'tsr'* | |
| 7668 'thesaurus' 'tsr' string (default "") | |
| 7669 global or local to buffer |global-local| | |
| 7670 {not in Vi} | |
| 7671 List of file names, separated by commas, that are used to lookup words | |
| 10 | 7672 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in |
| 7 | 7673 the file should contain words with similar meaning, separated by |
| 7674 non-keyword characters (white space is preferred). Maximum line | |
| 7675 length is 510 bytes. | |
|
3496
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7676 To obtain a file to be used here, check out this ftp site: |
|
8061
abd64cf67bcf
commit https://github.com/vim/vim/commit/38a55639d603823efcf2d2fdf542dbffdeb60b75
Christian Brabandt <cb@256bit.org>
parents:
7876
diff
changeset
|
7677 [Sorry this link doesn't work anymore, do you know the right one?] |
|
3496
d1e4abe8342c
Fixed compatible mode in most runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3493
diff
changeset
|
7678 ftp://ftp.ox.ac.uk/pub/wordlists/ First get the README file. |
| 10 | 7679 To include a comma in a file name precede it with a backslash. Spaces |
| 7 | 7680 after a comma are ignored, otherwise spaces are included in the file |
| 7681 name. See |option-backslash| about using backslashes. | |
| 7682 The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 7683 directories from the list. This avoids problems when a future version | |
| 7684 uses another default. | |
| 7685 Backticks cannot be used in this option for security reasons. | |
| 7686 | |
| 7687 *'tildeop'* *'top'* *'notildeop'* *'notop'* | |
| 7688 'tildeop' 'top' boolean (default off) | |
| 7689 global | |
| 7690 {not in Vi} | |
| 7691 When on: The tilde command "~" behaves like an operator. | |
| 7692 NOTE: This option is reset when 'compatible' is set. | |
| 7693 | |
| 7694 *'timeout'* *'to'* *'notimeout'* *'noto'* | |
| 7695 'timeout' 'to' boolean (default on) | |
| 7696 global | |
| 7697 *'ttimeout'* *'nottimeout'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
7698 'ttimeout' boolean (default off, set in |defaults.vim|)) |
| 7 | 7699 global |
| 7700 {not in Vi} | |
| 7701 These two options together determine the behavior when part of a | |
| 7702 mapped key sequence or keyboard code has been received: | |
| 7703 | |
| 7704 'timeout' 'ttimeout' action ~ | |
| 7705 off off do not time out | |
| 7706 on on or off time out on :mappings and key codes | |
| 7707 off on time out on key codes | |
| 7708 | |
| 7709 If both options are off, Vim will wait until either the complete | |
| 7710 mapping or key sequence has been received, or it is clear that there | |
| 7711 is no mapping or key sequence for the received characters. For | |
| 7712 example: if you have mapped "vl" and Vim has received 'v', the next | |
| 7713 character is needed to see if the 'v' is followed by an 'l'. | |
| 7714 When one of the options is on, Vim will wait for about 1 second for | |
| 7715 the next character to arrive. After that the already received | |
| 7716 characters are interpreted as single characters. The waiting time can | |
| 7717 be changed with the 'timeoutlen' option. | |
| 7718 On slow terminals or very busy systems timing out may cause | |
| 7719 malfunctioning cursor keys. If both options are off, Vim waits | |
| 7720 forever after an entered <Esc> if there are key codes that start | |
| 7721 with <Esc>. You will have to type <Esc> twice. If you do not have | |
| 7722 problems with key codes, but would like to have :mapped key | |
| 7723 sequences not timing out in 1 second, set the 'ttimeout' option and | |
| 7724 reset the 'timeout' option. | |
| 7725 | |
| 7726 NOTE: 'ttimeout' is reset when 'compatible' is set. | |
| 7727 | |
| 7728 *'timeoutlen'* *'tm'* | |
| 7729 'timeoutlen' 'tm' number (default 1000) | |
| 7730 global | |
| 7731 {not in all versions of Vi} | |
| 7732 *'ttimeoutlen'* *'ttm'* | |
|
10218
584c835a2de1
commit https://github.com/vim/vim/commit/50ba526fbf3e9e5e0e6b0b3086a4d5df581ebc7e
Christian Brabandt <cb@256bit.org>
parents:
10211
diff
changeset
|
7733 'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)) |
| 7 | 7734 global |
| 7735 {not in Vi} | |
| 7736 The time in milliseconds that is waited for a key code or mapped key | |
| 7737 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G | |
| 7738 when part of a command has been typed. | |
| 7739 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a | |
| 7740 different timeout value for key codes is desired set 'ttimeoutlen' to | |
| 7741 a non-negative number. | |
| 7742 | |
| 7743 ttimeoutlen mapping delay key code delay ~ | |
| 7744 < 0 'timeoutlen' 'timeoutlen' | |
| 7745 >= 0 'timeoutlen' 'ttimeoutlen' | |
| 7746 | |
| 7747 The timeout only happens when the 'timeout' and 'ttimeout' options | |
| 7748 tell so. A useful setting would be > | |
| 7749 :set timeout timeoutlen=3000 ttimeoutlen=100 | |
| 7750 < (time out on mapping after three seconds, time out on key codes after | |
| 7751 a tenth of a second). | |
| 7752 | |
| 7753 *'title'* *'notitle'* | |
| 7754 'title' boolean (default off, on when title can be restored) | |
| 7755 global | |
| 7756 {not in Vi} | |
| 7757 {not available when compiled without the |+title| | |
| 7758 feature} | |
| 7759 When on, the title of the window will be set to the value of | |
| 7760 'titlestring' (if it is not empty), or to: | |
| 7761 filename [+=-] (path) - VIM | |
| 7762 Where: | |
| 7763 filename the name of the file being edited | |
| 7764 - indicates the file cannot be modified, 'ma' off | |
| 7765 + indicates the file was modified | |
| 7766 = indicates the file is read-only | |
| 7767 =+ indicates the file is read-only and modified | |
| 7768 (path) is the path of the file being edited | |
| 7769 - VIM the server name |v:servername| or "VIM" | |
| 7770 Only works if the terminal supports setting window titles | |
| 7771 (currently Amiga console, Win32 console, all GUI versions and | |
| 7772 terminals with a non- empty 't_ts' option - these are Unix xterm and | |
| 7773 iris-ansi by default, where 't_ts' is taken from the builtin termcap). | |
| 7774 *X11* | |
| 7775 When Vim was compiled with HAVE_X11 defined, the original title will | |
| 7776 be restored if possible. The output of ":version" will include "+X11" | |
| 7777 when HAVE_X11 was defined, otherwise it will be "-X11". This also | |
| 7778 works for the icon name |'icon'|. | |
| 7779 But: When Vim was started with the |-X| argument, restoring the title | |
| 7780 will not work (except in the GUI). | |
| 7781 If the title cannot be restored, it is set to the value of 'titleold'. | |
| 7782 You might want to restore the title outside of Vim then. | |
| 7783 When using an xterm from a remote machine you can use this command: | |
| 7784 rsh machine_name xterm -display $DISPLAY & | |
| 7785 then the WINDOWID environment variable should be inherited and the | |
| 7786 title of the window should change back to what it should be after | |
| 7787 exiting Vim. | |
| 7788 | |
| 7789 *'titlelen'* | |
| 7790 'titlelen' number (default 85) | |
| 7791 global | |
| 7792 {not in Vi} | |
| 7793 {not available when compiled without the |+title| | |
| 7794 feature} | |
| 7795 Gives the percentage of 'columns' to use for the length of the window | |
| 10 | 7796 title. When the title is longer, only the end of the path name is |
| 7797 shown. A '<' character before the path name is used to indicate this. | |
| 7 | 7798 Using a percentage makes this adapt to the width of the window. But |
| 7799 it won't work perfectly, because the actual number of characters | |
| 7800 available also depends on the font used and other things in the title | |
| 7801 bar. When 'titlelen' is zero the full path is used. Otherwise, | |
| 7802 values from 1 to 30000 percent can be used. | |
| 7803 'titlelen' is also used for the 'titlestring' option. | |
| 7804 | |
| 7805 *'titleold'* | |
| 7806 'titleold' string (default "Thanks for flying Vim") | |
| 7807 global | |
| 7808 {not in Vi} | |
| 7809 {only available when compiled with the |+title| | |
| 7810 feature} | |
| 7811 This option will be used for the window title when exiting Vim if the | |
| 7812 original title cannot be restored. Only happens if 'title' is on or | |
| 7813 'titlestring' is not empty. | |
| 36 | 7814 This option cannot be set from a |modeline| or in the |sandbox|, for |
| 7815 security reasons. | |
| 7 | 7816 *'titlestring'* |
| 7817 'titlestring' string (default "") | |
| 7818 global | |
| 7819 {not in Vi} | |
| 7820 {not available when compiled without the |+title| | |
| 7821 feature} | |
| 7822 When this option is not empty, it will be used for the title of the | |
| 7823 window. This happens only when the 'title' option is on. | |
| 7824 Only works if the terminal supports setting window titles (currently | |
| 7825 Amiga console, Win32 console, all GUI versions and terminals with a | |
| 7826 non-empty 't_ts' option). | |
| 7827 When Vim was compiled with HAVE_X11 defined, the original title will | |
|
10449
222b1432814e
commit https://github.com/vim/vim/commit/5162822914372fc916a93f85848c0c82209e7cec
Christian Brabandt <cb@256bit.org>
parents:
10272
diff
changeset
|
7828 be restored if possible, see |X11|. |
| 7 | 7829 When this option contains printf-style '%' items, they will be |
| 7830 expanded according to the rules used for 'statusline'. | |
| 7831 Example: > | |
| 7832 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p") | |
| 7833 :set title titlestring=%<%F%=%l/%L-%P titlelen=70 | |
| 7834 < The value of 'titlelen' is used to align items in the middle or right | |
| 7835 of the available space. | |
| 7836 Some people prefer to have the file name first: > | |
| 7837 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%) | |
| 7838 < Note the use of "%{ }" and an expression to get the path of the file, | |
| 10 | 7839 without the file name. The "%( %)" constructs are used to add a |
| 7 | 7840 separating space only when needed. |
| 7841 NOTE: Use of special characters in 'titlestring' may cause the display | |
| 7842 to be garbled (e.g., when it contains a CR or NL character). | |
| 7843 {not available when compiled without the |+statusline| feature} | |
| 7844 | |
| 7845 *'toolbar'* *'tb'* | |
| 7846 'toolbar' 'tb' string (default "icons,tooltips") | |
| 7847 global | |
| 7848 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and | |
| 7849 |+GUI_Photon|} | |
| 10 | 7850 The contents of this option controls various toolbar settings. The |
| 7 | 7851 possible values are: |
| 7852 icons Toolbar buttons are shown with icons. | |
| 7853 text Toolbar buttons shown with text. | |
| 7854 horiz Icon and text of a toolbar button are | |
| 10 | 7855 horizontally arranged. {only in GTK+ 2 GUI} |
| 7 | 7856 tooltips Tooltips are active for toolbar buttons. |
| 7857 Tooltips refer to the popup help text which appears after the mouse | |
| 7858 cursor is placed over a toolbar button for a brief moment. | |
| 7859 | |
| 7860 If you want the toolbar to be shown with icons as well as text, do the | |
| 7861 following: > | |
| 7862 :set tb=icons,text | |
| 7863 < Motif and Athena cannot display icons and text at the same time. They | |
| 7864 will show icons if both are requested. | |
| 7865 | |
| 7866 If none of the strings specified in 'toolbar' are valid or if | |
| 7867 'toolbar' is empty, this option is ignored. If you want to disable | |
| 7868 the toolbar, you need to set the 'guioptions' option. For example: > | |
| 7869 :set guioptions-=T | |
| 7870 < Also see |gui-toolbar|. | |
| 7871 | |
| 7872 *'toolbariconsize'* *'tbis'* | |
| 7873 'toolbariconsize' 'tbis' string (default "small") | |
| 7874 global | |
| 7875 {not in Vi} | |
| 7876 {only in the GTK+ 2 GUI} | |
| 7877 Controls the size of toolbar icons. The possible values are: | |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7878 tiny Use tiny icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7879 small Use small icons (default). |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7880 medium Use medium-sized icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7881 large Use large icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7882 huge Use even larger icons. |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7883 giant Use very big icons. |
| 7 | 7884 The exact dimensions in pixels of the various icon sizes depend on |
|
8497
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7885 the current theme. Common dimensions are giant=48x48, huge=32x32, |
|
da01d5da2cfa
commit https://github.com/vim/vim/commit/77cdfd10382e01cc51f4ba1a9177032351843151
Christian Brabandt <cb@256bit.org>
parents:
8246
diff
changeset
|
7886 large=24x24, medium=24x24, small=20x20 and tiny=16x16. |
| 7 | 7887 |
| 7888 If 'toolbariconsize' is empty, the global default size as determined | |
| 7889 by user preferences or the current theme is used. | |
| 7890 | |
| 7891 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'* | |
| 7892 'ttybuiltin' 'tbi' boolean (default on) | |
| 7893 global | |
| 7894 {not in Vi} | |
| 7895 When on, the builtin termcaps are searched before the external ones. | |
| 7896 When off the builtin termcaps are searched after the external ones. | |
| 7897 When this option is changed, you should set the 'term' option next for | |
| 7898 the change to take effect, for example: > | |
| 7899 :set notbi term=$TERM | |
| 7900 < See also |termcap|. | |
| 7901 Rationale: The default for this option is "on", because the builtin | |
| 7902 termcap entries are generally better (many systems contain faulty | |
| 7903 xterm entries...). | |
| 7904 | |
| 7905 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'* | |
| 7906 'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm, | |
| 7907 sun-cmd, screen, rxvt, dtterm or | |
| 7908 iris-ansi; also on when running Vim in | |
| 7909 a DOS console) | |
| 7910 global | |
| 7911 {not in Vi} | |
| 7912 Indicates a fast terminal connection. More characters will be sent to | |
| 7913 the screen for redrawing, instead of using insert/delete line | |
| 7914 commands. Improves smoothness of redrawing when there are multiple | |
| 7915 windows and the terminal does not support a scrolling region. | |
| 7916 Also enables the extra writing of characters at the end of each screen | |
| 7917 line for lines that wrap. This helps when using copy/paste with the | |
| 7918 mouse in an xterm and other terminals. | |
| 7919 | |
| 7920 *'ttymouse'* *'ttym'* | |
| 7921 'ttymouse' 'ttym' string (default depends on 'term') | |
| 7922 global | |
| 7923 {not in Vi} | |
| 7924 {only in Unix and VMS, doesn't work in the GUI; not | |
| 7925 available when compiled without |+mouse|} | |
| 7926 Name of the terminal type for which mouse codes are to be recognized. | |
| 1213 | 7927 Currently these strings are valid: |
| 7 | 7928 *xterm-mouse* |
| 7929 xterm xterm-like mouse handling. The mouse generates | |
| 7930 "<Esc>[Mscr", where "scr" is three bytes: | |
| 7931 "s" = button state | |
| 7932 "c" = column plus 33 | |
| 7933 "r" = row plus 33 | |
| 5908 | 7934 This only works up to 223 columns! See "dec", |
| 7935 "urxvt", and "sgr" for solutions. | |
| 7 | 7936 xterm2 Works like "xterm", but with the xterm reporting the |
| 7937 mouse position while the mouse is dragged. This works | |
| 7938 much faster and more precise. Your xterm must at | |
| 180 | 7939 least at patchlevel 88 / XFree 3.3.3 for this to |
| 7 | 7940 work. See below for how Vim detects this |
| 7941 automatically. | |
| 7942 *netterm-mouse* | |
| 7943 netterm NetTerm mouse handling. The mouse generates | |
| 7944 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers | |
| 7945 for the row and column. | |
| 7946 *dec-mouse* | |
| 7947 dec DEC terminal mouse handling. The mouse generates a | |
| 7948 rather complex sequence, starting with "<Esc>[". | |
| 189 | 7949 This is also available for an Xterm, if it was |
| 7950 configured with "--enable-dec-locator". | |
| 7 | 7951 *jsbterm-mouse* |
| 7952 jsbterm JSB term mouse handling. | |
| 7953 *pterm-mouse* | |
| 7954 pterm QNX pterm mouse handling. | |
| 3224 | 7955 *urxvt-mouse* |
| 7956 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal. | |
| 5908 | 7957 The mouse works only if the terminal supports this |
| 7958 encoding style, but it does not have 223 columns limit | |
| 7959 unlike "xterm" or "xterm2". | |
| 3750 | 7960 *sgr-mouse* |
| 7961 sgr Mouse handling for the terminal that emits SGR-styled | |
| 5908 | 7962 mouse reporting. The mouse works even in columns |
| 7963 beyond 223. This option is backward compatible with | |
| 7964 "xterm2" because it can also decode "xterm2" style | |
| 7965 mouse codes. | |
| 7 | 7966 |
| 7967 The mouse handling must be enabled at compile time |+mouse_xterm| | |
| 5908 | 7968 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt| |
| 7969 |+mouse_sgr|. | |
| 7 | 7970 Only "xterm"(2) is really recognized. NetTerm mouse codes are always |
| 7971 recognized, if enabled at compile time. DEC terminal mouse codes | |
| 7972 are recognized if enabled at compile time, and 'ttymouse' is not | |
| 5908 | 7973 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict |
| 7974 with them). | |
| 7 | 7975 This option is automatically set to "xterm", when the 'term' option is |
|
10272
57b2b8268d3a
commit https://github.com/vim/vim/commit/4575876dc865d4160f20d61bd822fbe7cafbec41
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
7976 set to a name that starts with "xterm", "mlterm", "screen", "tmux", |
|
57b2b8268d3a
commit https://github.com/vim/vim/commit/4575876dc865d4160f20d61bd822fbe7cafbec41
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
7977 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set |
|
57b2b8268d3a
commit https://github.com/vim/vim/commit/4575876dc865d4160f20d61bd822fbe7cafbec41
Christian Brabandt <cb@256bit.org>
parents:
10261
diff
changeset
|
7978 already. |
| 5908 | 7979 Additionally, if vim is compiled with the |+termresponse| feature and |
| 7980 |t_RV| is set to the escape sequence to request the xterm version | |
| 7981 number, more intelligent detection process runs. | |
| 7 | 7982 The "xterm2" value will be set if the xterm version is reported to be |
| 5908 | 7983 from 95 to 276. The "sgr" value will be set if the xterm version is |
| 7984 277 or highter. | |
| 7985 If you do not want 'ttymouse' to be set to "xterm2" or "sgr" | |
| 7986 automatically, set t_RV to an empty string: > | |
| 7 | 7987 :set t_RV= |
| 7988 < | |
| 7989 *'ttyscroll'* *'tsl'* | |
| 7990 'ttyscroll' 'tsl' number (default 999) | |
| 7991 global | |
| 7992 Maximum number of lines to scroll the screen. If there are more lines | |
| 7993 to scroll the window is redrawn. For terminals where scrolling is | |
| 7994 very slow and redrawing is not slow this can be set to a small number, | |
| 7995 e.g., 3, to speed up displaying. | |
| 7996 | |
| 7997 *'ttytype'* *'tty'* | |
| 7998 'ttytype' 'tty' string (default from $TERM) | |
| 7999 global | |
| 8000 Alias for 'term', see above. | |
| 8001 | |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8002 *'undodir'* *'udir'* |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8003 'undodir' 'udir' string (default ".") |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8004 global |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8005 {not in Vi} |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8006 {only when compiled with the |+persistent_undo| feature} |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8007 List of directory names for undo files, separated with commas. |
|
2220
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
8008 See |'backupdir'| for details of the format. |
|
2218
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
8009 "." means using the directory of the file. The undo file name for |
|
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
8010 "file.txt" is ".file.txt.un~". |
|
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
8011 For other directories the file name is the full path of the edited |
|
695ceebf17ca
Fix: :wundo didn't work in a buffer without a name.
Bram Moolenaar <bram@vim.org>
parents:
2214
diff
changeset
|
8012 file, with path separators replaced with "%". |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8013 When writing: The first directory that exists is used. "." always |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8014 works, no directories after "." will be used for writing. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8015 When reading all entries are tried to find an undo file. The first |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8016 undo file that exists is used. When it cannot be read an error is |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8017 given, no further entry is used. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8018 See |undo-persistence|. |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8019 |
|
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4502
diff
changeset
|
8020 *'undofile'* *'noundofile'* *'udf'* *'noudf'* |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8021 'undofile' 'udf' boolean (default off) |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8022 local to buffer |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8023 {not in Vi} |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8024 {only when compiled with the |+persistent_undo| feature} |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8025 When on, Vim automatically saves undo history to an undo file when |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8026 writing a buffer to a file, and restores undo history from the same |
|
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8027 file on buffer read. |
|
2220
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
8028 The directory where the undo file is stored is specified by 'undodir'. |
|
b1c70c500de4
Found a way to make the MS-Windows installer wait for the uninstaller to
Bram Moolenaar <bram@vim.org>
parents:
2218
diff
changeset
|
8029 For more information about this feature see |undo-persistence|. |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8030 The undo file is not read when 'undoreload' causes the buffer from |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8031 before a reload to be saved for undo. |
| 3920 | 8032 When 'undofile' is turned off the undo file is NOT deleted. |
|
2214
f8222d1f9a73
Included patch for persistent undo. Lots of changes and added test.
Bram Moolenaar <bram@vim.org>
parents:
2209
diff
changeset
|
8033 |
| 7 | 8034 *'undolevels'* *'ul'* |
| 8035 'undolevels' 'ul' number (default 100, 1000 for Unix, VMS, | |
| 8036 Win32 and OS/2) | |
| 5446 | 8037 global or local to buffer |global-local| |
| 7 | 8038 {not in Vi} |
| 8039 Maximum number of changes that can be undone. Since undo information | |
| 8040 is kept in memory, higher numbers will cause more memory to be used | |
| 8041 (nevertheless, a single change can use an unlimited amount of memory). | |
| 8042 Set to 0 for Vi compatibility: One level of undo and "u" undoes | |
| 8043 itself: > | |
| 8044 set ul=0 | |
| 8045 < But you can also get Vi compatibility by including the 'u' flag in | |
| 8046 'cpoptions', and still be able to use CTRL-R to repeat undo. | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8047 Also see |undo-two-ways|. |
| 5446 | 8048 Set to -1 for no undo at all. You might want to do this only for the |
| 8049 current buffer: > | |
| 8050 setlocal ul=-1 | |
| 7 | 8051 < This helps when you run out of memory for a single change. |
| 6336 | 8052 |
| 8053 The local value is set to -123456 when the global value is to be used. | |
| 8054 | |
|
2249
6d3d35ff2c2b
Use full path in undofile(). Updated docs.
Bram Moolenaar <bram@vim.org>
parents:
2240
diff
changeset
|
8055 Also see |clear-undo|. |
| 7 | 8056 |
|
2394
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8057 *'undoreload'* *'ur'* |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8058 'undoreload' 'ur' number (default 10000) |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8059 global |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8060 {not in Vi} |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8061 Save the whole buffer for undo when reloading it. This applies to the |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8062 ":e!" command and reloading for when the buffer changed outside of |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8063 Vim. |FileChangedShell| |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8064 The save only happens when this options is negative or when the number |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8065 of lines is smaller than the value of this option. |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8066 Set this option to zero to disable undo for a reload. |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8067 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8068 When saving undo for a reload, any undo file is not read. |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8069 |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8070 Note that this causes the whole buffer to be stored in memory. Set |
|
a3aca345aafa
Add the 'undoreload' option to be able to undo a file reload.
Bram Moolenaar <bram@vim.org>
parents:
2382
diff
changeset
|
8071 this option to a lower value if you run out of memory. |
| 7 | 8072 |
| 8073 *'updatecount'* *'uc'* | |
| 8074 'updatecount' 'uc' number (default: 200) | |
| 8075 global | |
| 8076 {not in Vi} | |
| 8077 After typing this many characters the swap file will be written to | |
| 8078 disk. When zero, no swap file will be created at all (see chapter on | |
| 8079 recovery |crash-recovery|). 'updatecount' is set to zero by starting | |
| 8080 Vim with the "-n" option, see |startup|. When editing in readonly | |
| 8081 mode this option will be initialized to 10000. | |
| 8082 The swapfile can be disabled per buffer with |'swapfile'|. | |
| 8083 When 'updatecount' is set from zero to non-zero, swap files are | |
| 8084 created for all buffers that have 'swapfile' set. When 'updatecount' | |
| 8085 is set to zero, existing swap files are not deleted. | |
| 8086 Also see |'swapsync'|. | |
| 8087 This option has no meaning in buffers where |'buftype'| is "nofile" | |
| 8088 or "nowrite". | |
| 8089 | |
| 8090 *'updatetime'* *'ut'* | |
| 8091 'updatetime' 'ut' number (default 4000) | |
| 8092 global | |
| 8093 {not in Vi} | |
| 8094 If this many milliseconds nothing is typed the swap file will be | |
| 8095 written to disk (see |crash-recovery|). Also used for the | |
| 8096 |CursorHold| autocommand event. | |
| 8097 | |
| 8098 *'verbose'* *'vbs'* | |
| 8099 'verbose' 'vbs' number (default 0) | |
| 8100 global | |
| 8101 {not in Vi, although some versions have a boolean | |
| 8102 verbose option} | |
| 8103 When bigger than zero, Vim will give messages about what it is doing. | |
| 8104 Currently, these messages are given: | |
| 8105 >= 1 When the viminfo file is read or written. | |
| 8106 >= 2 When a file is ":source"'ed. | |
| 712 | 8107 >= 5 Every searched tags file and include file. |
| 7 | 8108 >= 8 Files for which a group of autocommands is executed. |
| 8109 >= 9 Every executed autocommand. | |
| 8110 >= 12 Every executed function. | |
| 8111 >= 13 When an exception is thrown, caught, finished, or discarded. | |
| 8112 >= 14 Anything pending in a ":finally" clause. | |
| 8113 >= 15 Every executed Ex command (truncated at 200 characters). | |
| 8114 | |
| 8115 This option can also be set with the "-V" argument. See |-V|. | |
| 8116 This option is also set by the |:verbose| command. | |
| 8117 | |
| 293 | 8118 When the 'verbosefile' option is set then the verbose messages are not |
| 8119 displayed. | |
| 8120 | |
| 8121 *'verbosefile'* *'vfile'* | |
| 8122 'verbosefile' 'vfile' string (default empty) | |
| 8123 global | |
| 8124 {not in Vi} | |
| 8125 When not empty all messages are written in a file with this name. | |
| 8126 When the file exists messages are appended. | |
| 8127 Writing to the file ends when Vim exits or when 'verbosefile' is made | |
|
2265
b7cb69ab616d
Added salt to blowfish encryption.
Bram Moolenaar <bram@vim.org>
parents:
2250
diff
changeset
|
8128 empty. Writes are buffered, thus may not show up for some time. |
| 293 | 8129 Setting 'verbosefile' to a new value is like making it empty first. |
| 8130 The difference with |:redir| is that verbose messages are not | |
| 8131 displayed when 'verbosefile' is set. | |
| 8132 | |
| 7 | 8133 *'viewdir'* *'vdir'* |
| 8134 'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32: | |
| 8135 "$VIM/vimfiles/view", | |
| 8136 for Unix: "~/.vim/view", | |
| 8137 for Macintosh: "$VIM:vimfiles:view" | |
| 8138 for VMS: "sys$login:vimfiles/view" | |
| 8139 for RiscOS: "Choices:vimfiles/view") | |
| 8140 global | |
| 8141 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8142 {not available when compiled without the |+mksession| |
| 7 | 8143 feature} |
| 8144 Name of the directory where to store files for |:mkview|. | |
| 8145 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8146 security reasons. | |
| 8147 | |
| 8148 *'viewoptions'* *'vop'* | |
| 8149 'viewoptions' 'vop' string (default: "folds,options,cursor") | |
| 8150 global | |
| 8151 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8152 {not available when compiled without the |+mksession| |
| 7 | 8153 feature} |
| 8154 Changes the effect of the |:mkview| command. It is a comma separated | |
| 10 | 8155 list of words. Each word enables saving and restoring something: |
| 7 | 8156 word save and restore ~ |
| 8157 cursor cursor position in file and in window | |
| 8158 folds manually created folds, opened/closed folds and local | |
| 8159 fold options | |
| 8160 options options and mappings local to a window or buffer (not | |
| 8161 global values for local options) | |
| 6213 | 8162 localoptions same as "options" |
| 7 | 8163 slash backslashes in file names replaced with forward |
| 8164 slashes | |
| 8165 unix with Unix end-of-line format (single <NL>), even when | |
| 8166 on Windows or DOS | |
| 8167 | |
| 8168 "slash" and "unix" are useful on Windows when sharing view files | |
| 8169 with Unix. The Unix version of Vim cannot source dos format scripts, | |
| 8170 but the Windows version of Vim can source unix format scripts. | |
| 8171 | |
| 8172 *'viminfo'* *'vi'* *E526* *E527* *E528* | |
| 8173 'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS, | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8174 Windows and OS/2: '100,<50,s10,h,rA:,rB:, |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8175 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2: |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8176 for others: '100,<50,s10,h) |
| 7 | 8177 global |
| 8178 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8179 {not available when compiled without the |+viminfo| |
| 7 | 8180 feature} |
| 8181 When non-empty, the viminfo file is read upon startup and written | |
| 10 | 8182 when exiting Vim (see |viminfo-file|). The string should be a comma |
| 7 | 8183 separated list of parameters, each consisting of a single character |
| 8184 identifying the particular parameter, followed by a number or string | |
| 8185 which specifies the value of that parameter. If a particular | |
| 8186 character is left out, then the default value is used for that | |
| 8187 parameter. The following is a list of the identifying characters and | |
| 8188 the effect of their value. | |
| 8189 CHAR VALUE ~ | |
| 3224 | 8190 *viminfo-!* |
| 7 | 8191 ! When included, save and restore global variables that start |
| 8192 with an uppercase letter, and don't contain a lowercase | |
| 8193 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis" | |
| 2607 | 8194 and "_K_L_M" are not. Nested List and Dict items may not be |
| 2642 | 8195 read back correctly, you end up with an empty item. |
| 3224 | 8196 *viminfo-quote* |
| 7 | 8197 " Maximum number of lines saved for each register. Old name of |
| 8198 the '<' item, with the disadvantage that you need to put a | |
| 8199 backslash before the ", otherwise it will be recognized as the | |
| 8200 start of a comment! | |
| 3224 | 8201 *viminfo-%* |
| 7 | 8202 % When included, save and restore the buffer list. If Vim is |
| 8203 started with a file name argument, the buffer list is not | |
| 8204 restored. If Vim is started without a file name argument, the | |
|
7272
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
7266
diff
changeset
|
8205 buffer list is restored from the viminfo file. Quickfix |
|
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
7266
diff
changeset
|
8206 ('buftype'), unlisted ('buflisted'), unnamed and buffers on |
|
17333ebd2bbd
commit https://github.com/vim/vim/commit/d042dc825c9b97dacd84d4728f88300da4d5b6b9
Christian Brabandt <cb@256bit.org>
parents:
7266
diff
changeset
|
8207 removable media (|viminfo-r|) are not saved. |
| 23 | 8208 When followed by a number, the number specifies the maximum |
| 8209 number of buffers that are stored. Without a number all | |
| 8210 buffers are stored. | |
| 3224 | 8211 *viminfo-'* |
| 7 | 8212 ' Maximum number of previously edited files for which the marks |
| 8213 are remembered. This parameter must always be included when | |
| 8214 'viminfo' is non-empty. | |
| 8215 Including this item also means that the |jumplist| and the | |
| 8216 |changelist| are stored in the viminfo file. | |
| 3224 | 8217 *viminfo-/* |
| 7 | 8218 / Maximum number of items in the search pattern history to be |
| 10 | 8219 saved. If non-zero, then the previous search and substitute |
| 7 | 8220 patterns are also saved. When not included, the value of |
| 8221 'history' is used. | |
| 3224 | 8222 *viminfo-:* |
| 7 | 8223 : Maximum number of items in the command-line history to be |
| 10 | 8224 saved. When not included, the value of 'history' is used. |
| 3224 | 8225 *viminfo-<* |
| 7 | 8226 < Maximum number of lines saved for each register. If zero then |
| 8227 registers are not saved. When not included, all lines are | |
| 8228 saved. '"' is the old name for this item. | |
| 8229 Also see the 's' item below: limit specified in Kbyte. | |
| 3224 | 8230 *viminfo-@* |
| 7 | 8231 @ Maximum number of items in the input-line history to be |
| 10 | 8232 saved. When not included, the value of 'history' is used. |
| 3224 | 8233 *viminfo-c* |
| 7 | 8234 c When included, convert the text in the viminfo file from the |
| 8235 'encoding' used when writing the file to the current | |
| 233 | 8236 'encoding'. See |viminfo-encoding|. |
| 3224 | 8237 *viminfo-f* |
| 7 | 8238 f Whether file marks need to be stored. If zero, file marks ('0 |
| 8239 to '9, 'A to 'Z) are not stored. When not present or when | |
| 10 | 8240 non-zero, they are all stored. '0 is used for the current |
| 7 | 8241 cursor position (when exiting or when doing ":wviminfo"). |
| 3224 | 8242 *viminfo-h* |
| 7 | 8243 h Disable the effect of 'hlsearch' when loading the viminfo |
| 8244 file. When not included, it depends on whether ":nohlsearch" | |
| 8245 has been used since the last search command. | |
| 3224 | 8246 *viminfo-n* |
| 7 | 8247 n Name of the viminfo file. The name must immediately follow |
|
9464
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
8248 the 'n'. Must be at the end of the option! If the "-i" |
|
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
8249 argument was given when starting Vim, that file name overrides |
|
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
8250 the one given here with 'viminfo'. Environment variables are |
|
be72f4201a1d
commit https://github.com/vim/vim/commit/063b9d15abea041a5bfff3ffc4e219e26fd1d4fa
Christian Brabandt <cb@256bit.org>
parents:
9407
diff
changeset
|
8251 expanded when opening the file, not when setting the option. |
| 3224 | 8252 *viminfo-r* |
| 7 | 8253 r Removable media. The argument is a string (up to the next |
| 8254 ','). This parameter can be given several times. Each | |
| 8255 specifies the start of a path for which no marks will be | |
| 8256 stored. This is to avoid removable media. For MS-DOS you | |
| 8257 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can | |
| 8258 also use it for temp files, e.g., for Unix: "r/tmp". Case is | |
| 8259 ignored. Maximum length of each 'r' argument is 50 | |
| 8260 characters. | |
| 3224 | 8261 *viminfo-s* |
| 7 | 8262 s Maximum size of an item in Kbyte. If zero then registers are |
| 8263 not saved. Currently only applies to registers. The default | |
| 8264 "s10" will exclude registers with more than 10 Kbyte of text. | |
| 8265 Also see the '<' item above: line count limit. | |
| 8266 | |
| 8267 Example: > | |
| 8268 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo | |
| 8269 < | |
| 8270 '50 Marks will be remembered for the last 50 files you | |
| 8271 edited. | |
| 8272 <1000 Contents of registers (up to 1000 lines each) will be | |
| 8273 remembered. | |
| 8274 s100 Registers with more than 100 Kbyte text are skipped. | |
| 8275 :0 Command-line history will not be saved. | |
| 8276 n~/vim/viminfo The name of the file to use is "~/vim/viminfo". | |
| 8277 no / Since '/' is not specified, the default will be used, | |
| 8278 that is, save all of the search history, and also the | |
| 8279 previous search and substitute patterns. | |
| 8280 no % The buffer list will not be saved nor read back. | |
| 8281 no h 'hlsearch' highlighting will be restored. | |
| 8282 | |
| 8283 When setting 'viminfo' from an empty value you can use |:rviminfo| to | |
| 8284 load the contents of the file, this is not done automatically. | |
| 8285 | |
| 8286 This option cannot be set from a |modeline| or in the |sandbox|, for | |
| 8287 security reasons. | |
| 8288 | |
| 8289 *'virtualedit'* *'ve'* | |
| 8290 'virtualedit' 've' string (default "") | |
| 8291 global | |
| 8292 {not in Vi} | |
| 8293 {not available when compiled without the | |
| 8294 |+virtualedit| feature} | |
| 8295 A comma separated list of these words: | |
| 8296 block Allow virtual editing in Visual block mode. | |
| 8297 insert Allow virtual editing in Insert mode. | |
| 8298 all Allow virtual editing in all modes. | |
| 772 | 8299 onemore Allow the cursor to move just past the end of the line |
| 782 | 8300 |
| 7 | 8301 Virtual editing means that the cursor can be positioned where there is |
| 1263 | 8302 no actual character. This can be halfway into a tab or beyond the end |
| 7 | 8303 of the line. Useful for selecting a rectangle in Visual mode and |
| 8304 editing a table. | |
| 772 | 8305 "onemore" is not the same, it will only allow moving the cursor just |
| 8306 after the last character of the line. This makes some commands more | |
| 8307 consistent. Previously the cursor was always past the end of the line | |
| 8308 if the line was empty. But it is far from Vi compatible. It may also | |
| 782 | 8309 break some plugins or Vim scripts. For example because |l| can move |
| 8310 the cursor after the last character. Use with care! | |
| 5220 | 8311 Using the `$` command will move to the last character in the line, not |
| 782 | 8312 past it. This may actually move the cursor to the left! |
| 5220 | 8313 The `g$` command will move to the end of the screen line. |
| 772 | 8314 It doesn't make sense to combine "all" with "onemore", but you will |
| 8315 not get a warning for it. | |
| 7 | 8316 |
| 8317 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep* | |
| 8318 'visualbell' 'vb' boolean (default off) | |
| 8319 global | |
| 8320 {not in Vi} | |
| 8321 Use visual bell instead of beeping. The terminal code to display the | |
| 8322 visual bell is given with 't_vb'. When no beep or flash is wanted, | |
| 8323 use ":set vb t_vb=". | |
| 8324 Note: When the GUI starts, 't_vb' is reset to its default value. You | |
| 8325 might want to set it again in your |gvimrc|. | |
| 8326 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display | |
| 8327 for 20 msec. If you want to use a different time, use "<Esc>|40f", | |
| 8328 where 40 is the time in msec. | |
| 8329 Does not work on the Amiga, you always get a screen flash. | |
| 8330 Also see 'errorbells'. | |
| 8331 | |
| 8332 *'warn'* *'nowarn'* | |
| 8333 'warn' boolean (default on) | |
| 8334 global | |
| 8335 Give a warning message when a shell command is used while the buffer | |
| 8336 has been changed. | |
| 8337 | |
| 8338 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'* | |
| 8339 'weirdinvert' 'wiv' boolean (default off) | |
| 8340 global | |
| 8341 {not in Vi} | |
| 667 | 8342 This option has the same effect as the 't_xs' terminal option. |
| 7 | 8343 It is provided for backwards compatibility with version 4.x. |
| 8344 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and | |
| 8345 vice versa. Has no effect when the GUI is running. | |
| 8346 | |
| 8347 *'whichwrap'* *'ww'* | |
| 8348 'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "") | |
| 8349 global | |
| 8350 {not in Vi} | |
| 8351 Allow specified keys that move the cursor left/right to move to the | |
| 8352 previous/next line when the cursor is on the first/last character in | |
| 8353 the line. Concatenate characters to allow this for these keys: | |
| 8354 char key mode ~ | |
| 8355 b <BS> Normal and Visual | |
| 8356 s <Space> Normal and Visual | |
| 712 | 8357 h "h" Normal and Visual (not recommended) |
| 8358 l "l" Normal and Visual (not recommended) | |
| 7 | 8359 < <Left> Normal and Visual |
| 8360 > <Right> Normal and Visual | |
| 8361 ~ "~" Normal | |
| 8362 [ <Left> Insert and Replace | |
| 8363 ] <Right> Insert and Replace | |
| 8364 For example: > | |
| 8365 :set ww=<,>,[,] | |
| 8366 < allows wrap only when cursor keys are used. | |
| 8367 When the movement keys are used in combination with a delete or change | |
| 8368 operator, the <EOL> also counts for a character. This makes "3h" | |
| 8369 different from "3dh" when the cursor crosses the end of a line. This | |
| 8370 is also true for "x" and "X", because they do the same as "dl" and | |
| 8371 "dh". If you use this, you may also want to use the mapping | |
| 8372 ":map <BS> X" to make backspace delete the character in front of the | |
| 8373 cursor. | |
| 714 | 8374 When 'l' is included and it is used after an operator at the end of a |
| 8375 line then it will not move to the next line. This makes "dl", "cl", | |
| 8376 "yl" etc. work normally. | |
| 7 | 8377 NOTE: This option is set to the Vi default value when 'compatible' is |
| 8378 set and to the Vim default value when 'compatible' is reset. | |
| 8379 | |
| 8380 *'wildchar'* *'wc'* | |
| 8381 'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E) | |
| 8382 global | |
| 8383 {not in Vi} | |
| 8384 Character you have to type to start wildcard expansion in the | |
| 8385 command-line, as specified with 'wildmode'. | |
| 1621 | 8386 More info here: |cmdline-completion|. |
| 7 | 8387 The character is not recognized when used inside a macro. See |
| 8388 'wildcharm' for that. | |
| 8389 Although 'wc' is a number option, you can set it to a special key: > | |
| 8390 :set wc=<Esc> | |
| 8391 < NOTE: This option is set to the Vi default value when 'compatible' is | |
| 8392 set and to the Vim default value when 'compatible' is reset. | |
| 8393 | |
| 8394 *'wildcharm'* *'wcm'* | |
| 8395 'wildcharm' 'wcm' number (default: none (0)) | |
| 8396 global | |
| 8397 {not in Vi} | |
| 8398 'wildcharm' works exactly like 'wildchar', except that it is | |
| 233 | 8399 recognized when used inside a macro. You can find "spare" command-line |
| 8400 keys suitable for this option by looking at |ex-edit-index|. Normally | |
| 7 | 8401 you'll never actually type 'wildcharm', just use it in mappings that |
| 8402 automatically invoke completion mode, e.g.: > | |
| 8403 :set wcm=<C-Z> | |
| 1621 | 8404 :cnoremap ss so $vim/sessions/*.vim<C-Z> |
| 7 | 8405 < Then after typing :ss you can use CTRL-P & CTRL-N. |
| 8406 | |
| 8407 *'wildignore'* *'wig'* | |
| 8408 'wildignore' 'wig' string (default "") | |
| 8409 global | |
| 8410 {not in Vi} | |
| 8411 {not available when compiled without the |+wildignore| | |
| 8412 feature} | |
| 8413 A list of file patterns. A file that matches with one of these | |
| 3682 | 8414 patterns is ignored when expanding |wildcards|, completing file or |
| 8415 directory names, and influences the result of |expand()|, |glob()| and | |
| 8416 |globpath()| unless a flag is passed to disable this. | |
| 7 | 8417 The pattern is used like with |:autocmd|, see |autocmd-patterns|. |
| 8418 Also see 'suffixes'. | |
| 8419 Example: > | |
| 8420 :set wildignore=*.o,*.obj | |
| 8421 < The use of |:set+=| and |:set-=| is preferred when adding or removing | |
| 8422 a pattern from the list. This avoids problems when a future version | |
| 8423 uses another default. | |
| 8424 | |
| 2652 | 8425 |
| 2662 | 8426 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'* |
| 2652 | 8427 'wildignorecase' 'wic' boolean (default off) |
| 8428 global | |
| 8429 {not in Vi} | |
| 8430 When set case is ignored when completing file names and directories. | |
| 4242 | 8431 Has no effect when 'fileignorecase' is set. |
| 2652 | 8432 Does not apply when the shell is used to expand wildcards, which |
| 8433 happens when there are special characters. | |
| 8434 | |
| 8435 | |
| 7 | 8436 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'* |
|
9669
284b4eb307fc
commit https://github.com/vim/vim/commit/8c08b5b569e2a9e9f63dea514591ecfa2d3bb392
Christian Brabandt <cb@256bit.org>
parents:
9665
diff
changeset
|
8437 'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|) |
| 7 | 8438 global |
| 8439 {not in Vi} | |
| 8440 {not available if compiled without the |+wildmenu| | |
| 8441 feature} | |
| 8442 When 'wildmenu' is on, command-line completion operates in an enhanced | |
| 8443 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion, | |
| 8444 the possible matches are shown just above the command line, with the | |
| 8445 first match highlighted (overwriting the status line, if there is | |
| 8446 one). Keys that show the previous/next match, such as <Tab> or | |
| 8447 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match. | |
| 8448 When 'wildmode' is used, "wildmenu" mode is used where "full" is | |
| 8449 specified. "longest" and "list" do not start "wildmenu" mode. | |
| 4159 | 8450 You can check the current mode with |wildmenumode()|. |
| 7 | 8451 If there are more matches than can fit in the line, a ">" is shown on |
| 8452 the right and/or a "<" is shown on the left. The status line scrolls | |
| 8453 as needed. | |
| 8454 The "wildmenu" mode is abandoned when a key is hit that is not used | |
| 8455 for selecting a completion. | |
| 8456 While the "wildmenu" is active the following keys have special | |
| 8457 meanings: | |
| 8458 | |
| 8459 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N) | |
| 8460 <Down> - in filename/menu name completion: move into a | |
| 8461 subdirectory or submenu. | |
| 8462 <CR> - in menu completion, when the cursor is just after a | |
| 8463 dot: move into a submenu. | |
| 8464 <Up> - in filename/menu name completion: move up into | |
| 8465 parent directory or parent menu. | |
| 8466 | |
| 8467 This makes the menus accessible from the console |console-menus|. | |
| 8468 | |
| 8469 If you prefer the <Left> and <Right> keys to move the cursor instead | |
| 8470 of selecting a different match, use this: > | |
| 8471 :cnoremap <Left> <Space><BS><Left> | |
| 8472 :cnoremap <Right> <Space><BS><Right> | |
| 8473 < | |
| 8474 The "WildMenu" highlighting is used for displaying the current match | |
| 8475 |hl-WildMenu|. | |
| 8476 | |
| 8477 *'wildmode'* *'wim'* | |
| 8478 'wildmode' 'wim' string (Vim default: "full") | |
| 8479 global | |
| 8480 {not in Vi} | |
| 8481 Completion mode that is used for the character specified with | |
| 10 | 8482 'wildchar'. It is a comma separated list of up to four parts. Each |
| 1152 | 8483 part specifies what to do for each consecutive use of 'wildchar'. The |
| 7 | 8484 first part specifies the behavior for the first use of 'wildchar', |
| 8485 The second part for the second use, etc. | |
| 8486 These are the possible values for each part: | |
| 8487 "" Complete only the first match. | |
| 8488 "full" Complete the next full match. After the last match, | |
| 8489 the original string is used and then the first match | |
| 8490 again. | |
| 8491 "longest" Complete till longest common string. If this doesn't | |
| 8492 result in a longer string, use the next part. | |
| 8493 "longest:full" Like "longest", but also start 'wildmenu' if it is | |
| 8494 enabled. | |
| 8495 "list" When more than one match, list all matches. | |
| 8496 "list:full" When more than one match, list all matches and | |
| 8497 complete first match. | |
| 8498 "list:longest" When more than one match, list all matches and | |
| 8499 complete till longest common string. | |
| 8500 When there is only a single match, it is fully completed in all cases. | |
| 8501 | |
| 8502 Examples: > | |
| 8503 :set wildmode=full | |
| 233 | 8504 < Complete first full match, next match, etc. (the default) > |
| 7 | 8505 :set wildmode=longest,full |
| 8506 < Complete longest common string, then each full match > | |
| 8507 :set wildmode=list:full | |
| 8508 < List all matches and complete each full match > | |
| 8509 :set wildmode=list,full | |
| 8510 < List all matches without completing, then each full match > | |
| 8511 :set wildmode=longest,list | |
| 8512 < Complete longest common string, then list alternatives. | |
| 1621 | 8513 More info here: |cmdline-completion|. |
| 7 | 8514 |
| 40 | 8515 *'wildoptions'* *'wop'* |
| 8516 'wildoptions' 'wop' string (default "") | |
| 8517 global | |
| 8518 {not in Vi} | |
| 8519 {not available when compiled without the |+wildignore| | |
| 8520 feature} | |
| 8521 A list of words that change how command line completion is done. | |
| 8522 Currently only one word is allowed: | |
| 8523 tagfile When using CTRL-D to list matching tags, the kind of | |
| 856 | 8524 tag and the file of the tag is listed. Only one match |
| 40 | 8525 is displayed per line. Often used tag kinds are: |
| 8526 d #define | |
| 8527 f function | |
| 8528 Also see |cmdline-completion|. | |
| 8529 | |
| 7 | 8530 *'winaltkeys'* *'wak'* |
| 8531 'winaltkeys' 'wak' string (default "menu") | |
| 8532 global | |
| 8533 {not in Vi} | |
| 8534 {only used in Win32, Motif, GTK and Photon GUI} | |
| 8535 Some GUI versions allow the access to menu entries by using the ALT | |
| 8536 key in combination with a character that appears underlined in the | |
| 8537 menu. This conflicts with the use of the ALT key for mappings and | |
| 8538 entering special characters. This option tells what to do: | |
| 8539 no Don't use ALT keys for menus. ALT key combinations can be | |
| 8540 mapped, but there is no automatic handling. This can then be | |
| 8541 done with the |:simalt| command. | |
| 8542 yes ALT key handling is done by the windowing system. ALT key | |
| 8543 combinations cannot be mapped. | |
| 8544 menu Using ALT in combination with a character that is a menu | |
| 10 | 8545 shortcut key, will be handled by the windowing system. Other |
| 7 | 8546 keys can be mapped. |
| 8547 If the menu is disabled by excluding 'm' from 'guioptions', the ALT | |
| 8548 key is never used for the menu. | |
| 36 | 8549 This option is not used for <F10>; on Win32 and with GTK <F10> will |
| 8550 select the menu, unless it has been mapped. | |
| 7 | 8551 |
| 164 | 8552 *'window'* *'wi'* |
| 8553 'window' 'wi' number (default screen height - 1) | |
| 8554 global | |
| 8555 Window height. Do not confuse this with the height of the Vim window, | |
| 8556 use 'lines' for that. | |
| 179 | 8557 Used for |CTRL-F| and |CTRL-B| when there is only one window and the |
| 8558 value is smaller than 'lines' minus one. The screen will scroll | |
| 8559 'window' minus two lines, with a minimum of one. | |
| 164 | 8560 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll |
| 8561 in a much smarter way, taking care of wrapping lines. | |
| 8562 When resizing the Vim window, the value is smaller than 1 or more than | |
| 8563 or equal to 'lines' it will be set to 'lines' minus 1. | |
| 8564 {Vi also uses the option to specify the number of displayed lines} | |
| 8565 | |
| 7 | 8566 *'winheight'* *'wh'* *E591* |
| 8567 'winheight' 'wh' number (default 1) | |
| 8568 global | |
| 8569 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8570 {not available when compiled without the |+windows| |
| 7 | 8571 feature} |
| 8572 Minimal number of lines for the current window. This is not a hard | |
| 10 | 8573 minimum, Vim will use fewer lines if there is not enough room. If the |
| 1621 | 8574 focus goes to a window that is smaller, its size is increased, at the |
| 8575 cost of the height of other windows. | |
| 8576 Set 'winheight' to a small number for normal editing. | |
| 8577 Set it to 999 to make the current window fill most of the screen. | |
| 8578 Other windows will be only 'winminheight' high. This has the drawback | |
| 8579 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4" | |
| 8580 to create only two windows, set the option after startup is done, | |
| 8581 using the |VimEnter| event: > | |
| 8582 au VimEnter * set winheight=999 | |
| 8583 < Minimum value is 1. | |
| 8584 The height is not adjusted after one of the commands that change the | |
| 7 | 8585 height of the current window. |
| 8586 'winheight' applies to the current window. Use 'winminheight' to set | |
| 8587 the minimal height for other windows. | |
| 8588 | |
| 8589 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* | |
| 8590 'winfixheight' 'wfh' boolean (default off) | |
| 8591 local to window | |
| 8592 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8593 {not available when compiled without the |+windows| |
| 7 | 8594 feature} |
| 8595 Keep the window height when windows are opened or closed and | |
| 1152 | 8596 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the |
| 8597 |preview-window| and |quickfix-window|. | |
| 7 | 8598 The height may be changed anyway when running out of room. |
| 8599 | |
| 782 | 8600 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'* |
| 8601 'winfixwidth' 'wfw' boolean (default off) | |
| 8602 local to window | |
| 8603 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8604 {not available when compiled without the |+windows| |
| 782 | 8605 feature} |
| 8606 Keep the window width when windows are opened or closed and | |
| 1152 | 8607 'equalalways' is set. Also for |CTRL-W_=|. |
| 782 | 8608 The width may be changed anyway when running out of room. |
| 8609 | |
| 7 | 8610 *'winminheight'* *'wmh'* |
| 8611 'winminheight' 'wmh' number (default 1) | |
| 8612 global | |
| 8613 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8614 {not available when compiled without the |+windows| |
| 7 | 8615 feature} |
| 8616 The minimal height of a window, when it's not the current window. | |
| 8617 This is a hard minimum, windows will never become smaller. | |
| 8618 When set to zero, windows may be "squashed" to zero lines (i.e. just a | |
| 8619 status bar) if necessary. They will return to at least one line when | |
| 8620 they become active (since the cursor has to have somewhere to go.) | |
| 8621 Use 'winheight' to set the minimal height of the current window. | |
| 8622 This option is only checked when making a window smaller. Don't use a | |
| 8623 large number, it will cause errors when opening more than a few | |
| 8624 windows. A value of 0 to 3 is reasonable. | |
| 8625 | |
| 8626 *'winminwidth'* *'wmw'* | |
| 8627 'winminwidth' 'wmw' number (default 1) | |
| 8628 global | |
| 8629 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8630 {not available when compiled without the |+vertsplit| |
| 7 | 8631 feature} |
| 8632 The minimal width of a window, when it's not the current window. | |
| 8633 This is a hard minimum, windows will never become smaller. | |
| 8634 When set to zero, windows may be "squashed" to zero columns (i.e. just | |
| 8635 a vertical separator) if necessary. They will return to at least one | |
| 8636 line when they become active (since the cursor has to have somewhere | |
| 8637 to go.) | |
| 8638 Use 'winwidth' to set the minimal width of the current window. | |
| 8639 This option is only checked when making a window smaller. Don't use a | |
| 8640 large number, it will cause errors when opening more than a few | |
| 8641 windows. A value of 0 to 12 is reasonable. | |
| 8642 | |
| 8643 *'winwidth'* *'wiw'* *E592* | |
| 8644 'winwidth' 'wiw' number (default 20) | |
| 8645 global | |
| 8646 {not in Vi} | |
|
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
8647 {not available when compiled without the |+vertsplit| |
| 7 | 8648 feature} |
| 8649 Minimal number of columns for the current window. This is not a hard | |
| 8650 minimum, Vim will use fewer columns if there is not enough room. If | |
| 8651 the current window is smaller, its size is increased, at the cost of | |
| 8652 the width of other windows. Set it to 999 to make the current window | |
| 8653 always fill the screen. Set it to a small number for normal editing. | |
| 8654 The width is not adjusted after one of the commands to change the | |
| 8655 width of the current window. | |
| 8656 'winwidth' applies to the current window. Use 'winminwidth' to set | |
| 8657 the minimal width for other windows. | |
| 8658 | |
| 8659 *'wrap'* *'nowrap'* | |
| 8660 'wrap' boolean (default on) | |
| 8661 local to window | |
| 8662 {not in Vi} | |
| 8663 This option changes how text is displayed. It doesn't change the text | |
| 8664 in the buffer, see 'textwidth' for that. | |
| 8665 When on, lines longer than the width of the window will wrap and | |
| 10 | 8666 displaying continues on the next line. When off lines will not wrap |
| 8667 and only part of long lines will be displayed. When the cursor is | |
| 7 | 8668 moved to a part that is not shown, the screen will scroll |
| 8669 horizontally. | |
| 8670 The line will be broken in the middle of a word if necessary. See | |
| 8671 'linebreak' to get the break at a word boundary. | |
| 8672 To make scrolling horizontally a bit more useful, try this: > | |
| 8673 :set sidescroll=5 | |
| 8674 :set listchars+=precedes:<,extends:> | |
| 8675 < See 'sidescroll', 'listchars' and |wrap-off|. | |
|
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8676 This option can't be set from a |modeline| when the 'diff' option is |
|
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1904
diff
changeset
|
8677 on. |
| 7 | 8678 |
| 8679 *'wrapmargin'* *'wm'* | |
| 8680 'wrapmargin' 'wm' number (default 0) | |
| 8681 local to buffer | |
| 8682 Number of characters from the right window border where wrapping | |
| 8683 starts. When typing text beyond this limit, an <EOL> will be inserted | |
| 8684 and inserting continues on the next line. | |
| 8685 Options that add a margin, such as 'number' and 'foldcolumn', cause | |
| 8686 the text width to be further reduced. This is Vi compatible. | |
| 8687 When 'textwidth' is non-zero, this option is not used. | |
|
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8688 This option is set to 0 when 'paste' is set and restored when 'paste' |
|
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7080
diff
changeset
|
8689 is reset. |
| 7 | 8690 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently |
| 8691 and less usefully} | |
| 8692 | |
| 8693 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'* | |
| 8694 'wrapscan' 'ws' boolean (default on) *E384* *E385* | |
| 8695 global | |
| 500 | 8696 Searches wrap around the end of the file. Also applies to |]s| and |
| 8697 |[s|, searching for spelling mistakes. | |
| 7 | 8698 |
| 8699 *'write'* *'nowrite'* | |
| 8700 'write' boolean (default on) | |
| 8701 global | |
| 8702 {not in Vi} | |
| 8703 Allows writing files. When not set, writing a file is not allowed. | |
| 8704 Can be used for a view-only mode, where modifications to the text are | |
| 10 | 8705 still allowed. Can be reset with the |-m| or |-M| command line |
| 7 | 8706 argument. Filtering text is still possible, even though this requires |
| 8707 writing a temporary file. | |
| 8708 | |
| 8709 *'writeany'* *'wa'* *'nowriteany'* *'nowa'* | |
| 8710 'writeany' 'wa' boolean (default off) | |
| 8711 global | |
| 8712 Allows writing to any file with no need for "!" override. | |
| 8713 | |
| 8714 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'* | |
| 8715 'writebackup' 'wb' boolean (default on with |+writebackup| feature, off | |
| 8716 otherwise) | |
| 8717 global | |
| 8718 {not in Vi} | |
| 8719 Make a backup before overwriting a file. The backup is removed after | |
| 8720 the file was successfully written, unless the 'backup' option is | |
| 3513 | 8721 also on. |
| 8722 WARNING: Switching this option off means that when Vim fails to write | |
| 8723 your buffer correctly and then, for whatever reason, Vim exits, you | |
| 8724 lose both the original file and what you were writing. Only reset | |
| 8725 this option if your file system is almost full and it makes the write | |
| 8726 fail (and make sure not to exit Vim until the write was successful). | |
| 8727 See |backup-table| for another explanation. | |
| 7 | 8728 When the 'backupskip' pattern matches, a backup is not made anyway. |
| 8729 NOTE: This option is set to the default value when 'compatible' is | |
| 8730 set. | |
| 8731 | |
| 8732 *'writedelay'* *'wd'* | |
| 8733 'writedelay' 'wd' number (default 0) | |
| 8734 global | |
| 8735 {not in Vi} | |
|
9344
33c1b85d408c
commit https://github.com/vim/vim/commit/802a0d902fca423acb15f835d7b09183883d79a0
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
8736 The number of milliseconds to wait for each character sent to the |
| 7 | 8737 screen. When non-zero, characters are sent to the terminal one by |
| 8738 one. For MS-DOS pcterm this does not work. For debugging purposes. | |
| 8739 | |
| 8740 vim:tw=78:ts=8:ft=help:norl: |